jekyll_pages_api 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a53015b9d831067e9881896ba4337a0afe277b31
-  data.tar.gz: fc905c1a196698fc249a52f306111952ec9eac32
+  metadata.gz: 165870f35595456ebb5c185976419aa41650dcc3
+  data.tar.gz: 8665a9c9c4e2d0c3caaf33d264f29eee1b9d75cf
 SHA512:
-  metadata.gz: 67ffc1e1e878040b166ba902879a11f994d91beb11a9f13fbb882277bd76ce996c617c06567da2c0edee8a6b313724d483fe92a8b97feee72ff5260798e3c401
-  data.tar.gz: 02d73adbe830e228176cf8dd89e14b096f51a0334fdd9a8951cc0fa4a4c39d4b8346225658a9e9201634288022cd9873525551c3d8397e3d875ed60e2ba1986b
+  metadata.gz: ae0bf9b1c790a930caddb014292fdfd635e2df275e46fb5e7d60c7982475ef0dae327268db27a8a1be4e029175d2b1d90507ae0a5662bb545e4e3e746821ac9a
+  data.tar.gz: 82ff7e227cba6611f48acb6dd6ee5dc27a43bc4522060f0b7ee3cedfcb14efafd27af8b4ca5b4041187dce2d7601adf9aae12340c13a63c1242d29a15dd38636

data/README.md

@@ -40,6 +40,10 @@ You can then see the generated JSON file at http://localhost:4000/api/v1/pages.j
 
 This endpoint will be re-generated any time your site is rebuilt.
 
+### Skipping the index
+
+The [Jekyll Pages API Search plugin](https://github.com/18F/jekyll_pages_api_search) uses this plugin to build a search index. Add `skip_index: true` to the front matter of any documents you wish to exclude from this index.
+
 ## Developing
 
 * Run `bundle` to install any necessary gems.

data/lib/jekyll_pages_api/page.rb

@@ -52,13 +52,19 @@ module JekyllPagesApi
       (self.page.data['tags'] if self.page.respond_to?(:data)) || []
     end
 
+    def skip_index?
+      (self.page.data['skip_index'] if self.page.respond_to?(:data)) || false
+    end
+
     def to_json
-      {
+      optional = {}
+      optional['skip_index'] = true if self.skip_index?
+      optional.merge({
         title: self.title,
         url: self.url,
         tags: self.tags,
         body: self.body_text
-      }
+      })
     end
   end
 end

data/lib/jekyll_pages_api/version.rb

@@ -1,3 +1,3 @@
 module JekyllPagesApi
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

data/spec/integration_spec.rb

@@ -95,4 +95,11 @@ describe "integration" do
     page = page_data('/about/')
     expect(page['tags']).to eq(["Jekyll", "test page", "convenient"])
   end
+
+  it "sets skip_index only if it is true" do
+    page = page_data('/about/')
+    expect(page['skip_index']).to eq(true)
+    page = page_data('/unicode.html')
+    expect(page['skip_index']).to eq(nil)
+  end
 end

data/spec/page_spec.rb

@@ -99,4 +99,19 @@ describe JekyllPagesApi::Page do
       expect(page.body_text).to eq("foo bar baz")
     end
   end
+
+  describe "#skip_index?" do
+    it "defaults to false if the 'data' member isn't present" do
+      expect(create_static_file(BASEURL, '/foo/').skip_index?).to eq(false)
+    end
+
+    it "defaults to false if the 'skip_index' field isn't present" do
+      expect(create_page(BASEURL, '/foo/').skip_index?).to eq(false)
+    end
+
+    it "returns true if data['skip_index'] is true" do
+      page = create_page(BASEURL, '/foo/', data:{'skip_index' => true})
+      expect(page.skip_index?).to eq(true)
+    end
+  end
 end

data/spec/site/about.md

@@ -6,6 +6,7 @@ tags:
 - Jekyll
 - test page
 - convenient
+skip_index: true
 ---
 
 This is the base Jekyll theme. You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at [jekyllrb.com](http://jekyllrb.com/)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_pages_api
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Aidan Feldman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-31 00:00:00.000000000 Z
+date: 2015-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlentities