File: site_github_munger_spec.rb

package info (click to toggle)
ruby-jekyll-github-metadata 2.15.0-2
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 712 kB
  • sloc: ruby: 2,355; javascript: 107; sh: 41; makefile: 6
file content (234 lines) | stat: -rw-r--r-- 7,156 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
require "spec_helper"
require "jekyll"
require "jekyll-github-metadata/site_github_munger"

RSpec.describe(Jekyll::GitHubMetadata::SiteGitHubMunger) do
  let(:source) { File.expand_path("test-site", __dir__) }
  let(:dest) { File.expand_path("../tmp/test-site-build", __dir__) }
  let(:github_namespace) { nil }
  let(:user_config) { { "github" => github_namespace } }
  let(:site) { Jekyll::Site.new(Jekyll::Configuration.from(user_config)) }
  subject { described_class.new(site) }
  let!(:stubs) { stub_all_api_requests }
  let(:unified_payload) { site.site_payload }

  context "generating" do
    before(:each) do
      ENV["JEKYLL_ENV"] = "production"
      subject.munge!
      subject.inject_metadata!(unified_payload)
    end

    context "with site.github as nil" do
      it "sets site.github to the drop" do
        expect(unified_payload.site["github"]).to be_a(Liquid::Drop)
      end
    end

    context "without site.github" do
      let(:user_config) { {} }

      it "replaces site.github with the drop" do
        expect(unified_payload.site["github"]).to be_a(Liquid::Drop)
      end
    end

    context "with site.github as a non-hash" do
      let(:github_namespace) { "foo" }

      it "doesn't munge" do
        expect(unified_payload.site["github"]).to eql("foo")
      end
    end

    context "with site.github as a hash" do
      let(:github_namespace) { { "source" => { "branch" => "foo" } } }

      it "lets user-specified values override the drop" do
        expect(unified_payload.site["github"].invoke_drop("source")["branch"]).to eql("foo")
      end

      it "still sets other values" do
        expect(unified_payload.site["github"].invoke_drop("source")["path"]).to eql("/")
      end
    end

    context "with site.url set" do
      let(:user_config) { { "url" => "http://example.com" } }

      it "doesn't mangle site.url" do
        expect(site.config["url"]).to eql("http://example.com")
      end
    end

    context "with site.baseurl set" do
      let(:user_config) { { "baseurl" => "/foo" } }

      it "doesn't mangle site.url" do
        expect(site.config["baseurl"]).to eql("/foo")
      end
    end

    context "with site.baseurl set to ''" do
      let(:user_config) { { "baseurl" => "" } }

      it "doesn't mangle site.baseurl" do
        expect(site.config["baseurl"]).to eql("")
      end
    end

    context "with site.baseurl set to '/'" do
      let(:user_config) { { "baseurl" => "/" } }

      it "mangles site.url" do
        expect(site.config["baseurl"]).to eql("/github-metadata")
      end
    end

    context "without site.url set" do
      it "sets site.url" do
        expect(site.config["url"]).to eql("http://jekyll.github.io")
      end
    end

    context "without site.baseurl set" do
      it "sets site.baseurl" do
        expect(site.config["baseurl"]).to eql("/github-metadata")
      end
    end

    context "title and description" do
      context "with title and description set" do
        let(:user_config) do
          { "title" => "My title", "description" => "My description" }
        end

        it "respects the title and tagline" do
          expect(site.config["title"]).to eql("My title")
          expect(site.config["description"]).to eql("My description")
        end
      end

      it "sets the title and description" do
        expect(site.config["title"]).to eql("github-metadata")
        expect(site.config["description"]).to eql(":octocat: `site.github`")
      end
    end

    context "with name set, but no title" do
      let(:user_config) { { "name" => "My site name" } }

      it "respects the site name" do
        expect(site.config["name"]).to eql("My site name")
        expect(site.config["title"]).to be_nil
      end
    end

    context "with site name and title" do
      let(:user_config) { { "name" => "Name", "title" => "Title" } }

      it "respects the user's settings" do
        expect(site.config["name"]).to eql("Name")
        expect(site.config["title"]).to eql("Title")
      end
    end
  end

  context "generating repo for user with displayname" do
    before(:each) do
      ENV["JEKYLL_ENV"] = "production"
      ENV["PAGES_REPO_NWO"] = "jekyllbot/jekyllbot.github.io"
      stub_api("/repos/jekyllbot/jekyllbot.github.io", "user_site")
      stub_api_404("/orgs/jekyllbot")
      stub_api("/users/jekyllbot", "user_with_displayname")
      subject.munge!
    end

    it "sets title to user's displayname" do
      expect(site.config["title"]).to eql("Jekyll Bot")
    end
  end

  context "generating repo for user without displayname" do
    before(:each) do
      ENV["JEKYLL_ENV"] = "production"
      ENV["PAGES_REPO_NWO"] = "jekyllbot/jekyllbot.github.io"
      stub_api("/repos/jekyllbot/jekyllbot.github.io", "user_site")
      stub_api_404("/orgs/jekyllbot")
      stub_api("/users/jekyllbot", "user_without_displayname")
      subject.munge!
    end

    it "sets title to user's login" do
      expect(site.config["title"]).to eql("jekyllbot")
    end
  end

  context "generating repo for org with displayname" do
    before(:each) do
      ENV["JEKYLL_ENV"] = "production"
      ENV["PAGES_REPO_NWO"] = "jekyll/jekyll.github.io"
      stub_api("/repos/jekyll/jekyll.github.io", "repo")
      stub_api("/orgs/jekyll", "org")
      subject.munge!
    end

    it "sets title to org's displayname" do
      expect(site.config["title"]).to eql("Jekyll")
    end
  end

  context "generating repo for org without displayname" do
    before(:each) do
      ENV["JEKYLL_ENV"] = "production"
      ENV["PAGES_REPO_NWO"] = "jekyll/jekyll.github.io"
      stub_api("/repos/jekyll/jekyll.github.io", "repo")
      stub_api("/orgs/jekyll", "org_without_displayname")
      subject.munge!
    end

    it "sets title to org's login" do
      expect(site.config["title"]).to eql("jekyll")
    end
  end

  context "with a client with no credentials" do
    before(:each) do
      Jekyll::GitHubMetadata.client = Jekyll::GitHubMetadata::Client.new(:access_token => "")
    end

    it "does not fail upon call to #munge" do
      expect do
        subject.munge!
      end.not_to raise_error
    end

    it "sets the site.github config" do
      subject.inject_metadata!(unified_payload)
      expect(unified_payload.site["github"]).to be_instance_of(Jekyll::GitHubMetadata::MetadataDrop)
    end
  end

  context "with a client with bad credentials" do
    before(:each) do
      Jekyll::GitHubMetadata.client = Jekyll::GitHubMetadata::Client.new(:access_token => "1234abc")
      stub_request(:get, url("/repos/jekyll/github-metadata/pages"))
        .with(:headers => request_headers.merge(
          "Authorization" => "token 1234abc"
        ))
        .to_return(
          :status  => 401,
          :headers => WebMockHelper::RESPONSE_HEADERS,
          :body    => webmock_data("bad_credentials")
        )
    end

    it "fails loudly upon call to any drop method" do
      subject.munge!
      subject.inject_metadata!(unified_payload)
      expect do
        unified_payload.site["github"]["url"]
      end.to raise_error(Jekyll::GitHubMetadata::Client::BadCredentialsError)
    end
  end
end