jekyll_pages_api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4485de15e66a09dedf59a42575b00ae341f442e9
-  data.tar.gz: f1063959c1529374a696d1be62521fa451de8b71
+  metadata.gz: 811fc43f57f4e801222cf78914842d6809c5b1d0
+  data.tar.gz: 9dacb9aa3c7a60a1ecc07f6ab7b0f381003929e9
 SHA512:
-  metadata.gz: a589f6459b68d956a086a1c81a0cc6736115d6e403c38733626d6e90cc5ff601a42fb751031d3d017b62b9dad17038fced9ce7c1bcf46113510e03baff01f3b7
-  data.tar.gz: 0f791a9cfe8bf63305e66d0248fba0372ce911425edbbc35ab357497b7143413807ece67b91ebb1821dfc46ac39090b9d95102e0d1a322dce7fd074d021a9f5c
+  metadata.gz: b7d6f06549f8ae61acef268bceadfc80b632ec1d6d63d5b3f1df4d20e04a6724745ccaf72eccf58cfa429d0b3eaa30949e0051100f71a97e3c244d67f7e108af
+  data.tar.gz: af0004b3e2a43dedc840eb2d5c687d3355c914008cdf64f3b45cf49042b59e8f82422825431fd37b353fefd80287fb5ffa08f4586ad304f2a0cdc5d979eb6997

data/.gitignore

@@ -1,5 +1,6 @@
 /.bundle/
 /.yardoc
+/gemfiles/*.lock
 /Gemfile.lock
 /_yardoc/
 /coverage/

data/.travis.yml

@@ -1,4 +1,7 @@
 language: ruby
 rvm:
 - 2.0.0
+gemfile:
+- gemfiles/jekyll_2.gemfile
+- gemfiles/jekyll_3.gemfile
 script: bundle exec rspec

data/CONTRIBUTING.md

@@ -11,6 +11,12 @@ bundle
 bundle exec rspec
 ```
 
+### Running against Jekyll 3
+
+```bash
+BUNDLE_GEMFILE=gemfiles/jekyll_3.gemfile bundle exec rspec
+```
+
 ## Public domain
 
 This project is in the public domain within the United States, and

data/README.md

@@ -1,4 +1,4 @@
-# Jekyll Pages API [![Build Status](https://travis-ci.org/18F/jekyll_pages_api.svg?branch=master)](https://travis-ci.org/18F/jekyll_pages_api)
+# Jekyll Pages API [![Build Status](https://travis-ci.org/18F/jekyll_pages_api.svg?branch=master)](https://travis-ci.org/18F/jekyll_pages_api) [![Code Climate](https://codeclimate.com/github/18F/jekyll_pages_api/badges/gpa.svg)](https://codeclimate.com/github/18F/jekyll_pages_api)
 
 Jekyll Pages API is a [Jekyll Plugin](http://jekyllrb.com/docs/plugins/) gem that generates a JSON file with data for all the Pages in your Site. [Jekyll](http://jekyllrb.com), if you're not familiar, is a static website generator written in Ruby.
 
@@ -19,19 +19,32 @@ bundle
 bundle exec jekyll serve
 ```
 
-You can then see the generated JSON file at http://localhost:4000/api/v1/pages.json, which will look something like this:
+You can then see the generated JSON file at http://localhost:4000/api/v1/pages.json, which will look like this:
 
-```json
+```javascript
 {
   "entries": [
     {
       "title": "18F Hub",
+      // the page path
       "url": "/",
+      // the content of the page, with the HTML tags stripped and the whitespace condensed
       "body": "18F is a digital services team within GSA..."
     },
-    ...
+    // ...
   ]
 }
 ```
 
-This endpoint will be re-generated any time your site it rebuilt.
+This endpoint will be re-generated any time your site is rebuilt.
+
+## See also
+
+Additional means of turning your site content into data:
+
+* [Jekyll's `jsonify` filter](http://jekyllrb.com/docs/templates/)
+* [jekyll-git_metadata](https://github.com/ivantsepp/jekyll-git_metadata)
+* [jekyll-rss](https://github.com/agelber/jekyll-rss)
+* [jekyll-sitemap](https://github.com/jekyll/jekyll-sitemap)
+* Reading the YAML frontmatter of the source files
+* Scraping the HTML pages themselves

data/gemfiles/jekyll_2.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'jekyll', '~> 2.0'
+
+gemspec path: '../'

data/gemfiles/jekyll_3.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'jekyll', '3.0.0.beta2'
+
+gemspec path: '../'

data/jekyll_pages_api.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "htmlentities", "~> 4.3"
-  spec.add_dependency "jekyll", "~> 2.0"
+  spec.add_dependency "jekyll", [">= 2.0", "< 4.0"]
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/jekyll_pages_api/version.rb

@@ -1,3 +1,3 @@
 module JekyllPagesApi
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/spec/integration_spec.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 require 'json'
 require_relative 'support/shell'
 
@@ -15,16 +17,20 @@ describe "integration" do
     json['entries']
   end
 
+  def page_data(url)
+    entries_data.find{|page| page['url'] == url }
+  end
+
   def homepage_data
-    entries_data.find{|page| page['url'] == '/' }
+    page_data('/')
   end
 
   before(:context) do
     # http://bundler.io/man/bundle-exec.1.html#Shelling-out
     Bundler.with_clean_env do
       Dir.chdir(BUILD_DIR) do
-        run_cmd('bundle')
-        run_cmd('bundle exec jekyll build')
+        run_cmd("JEKYLL_VERSION=#{Jekyll::VERSION} bundle update")
+        run_cmd("JEKYLL_VERSION=#{Jekyll::VERSION} bundle exec jekyll build")
       end
     end
   end
@@ -35,10 +41,21 @@ describe "integration" do
 
   it "includes an entry for every page" do
     urls = entries_data.map{|page| page['url'] }
-    expect(urls).to eq(%w(
-      /about/
-      /index.html
-    ))
+
+    # not sure why this discrepancy exists...
+    if Jekyll::VERSION.start_with?('3.')
+      expect(urls).to eq(%w(
+        /about/
+        /
+        /unicode.html
+      ))
+    else
+      expect(urls).to eq(%w(
+        /about/
+        /index.html
+        /unicode.html
+      ))
+    end
   end
 
   it "removes liquid tags" do
@@ -59,4 +76,9 @@ describe "integration" do
       expect(page['body']).to_not match(/\s{2,}/m)
     end
   end
+
+  it "handles unicode" do
+    page = page_data('/unicode.html')
+    expect(page['body']).to eq("”Handle the curly quotes!” they said.")
+  end
 end

data/spec/site/.gitignore

@@ -1,3 +1,4 @@
 _site
 .sass-cache
 Gemfile.lock
+.jekyll-metadata

data/spec/site/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'jekyll'
+gem 'jekyll', ENV['JEKYLL_VERSION']
 
 group :jekyll_plugins do
   gem 'jekyll_pages_api', path: '../..'

data/spec/site/unicode.html

@@ -0,0 +1,5 @@
+---
+layout: default
+---
+
+”Handle the curly quotes!” they said.

data/spec/spec_helper.rb

@@ -17,6 +17,8 @@
 
 require_relative '../lib/jekyll_pages_api'
 
+puts "Using Jekyll v#{Jekyll::VERSION}"
+
 RSpec.configure do |config|
   # rspec-expectations config goes here. You can use an alternate
   # assertion/expectation library such as wrong or the stdlib/minitest

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_pages_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Aidan Feldman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-31 00:00:00.000000000 Z
+date: 2015-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlentities
@@ -28,16 +28,22 @@ dependencies:
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -95,6 +101,8 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- gemfiles/jekyll_2.gemfile
+- gemfiles/jekyll_3.gemfile
 - jekyll_pages_api.gemspec
 - lib/jekyll/site.rb
 - lib/jekyll_pages_api.rb
@@ -123,6 +131,7 @@ files:
 - spec/site/css/main.scss
 - spec/site/feed.xml
 - spec/site/index.html
+- spec/site/unicode.html
 - spec/spec_helper.rb
 - spec/support/shell.rb
 homepage: https://github.com/18F/jekyll_pages_api
@@ -145,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: A Jekyll Plugin that generates a JSON file with data for all the Pages in
@@ -171,5 +180,6 @@ test_files:
 - spec/site/css/main.scss
 - spec/site/feed.xml
 - spec/site/index.html
+- spec/site/unicode.html
 - spec/spec_helper.rb
 - spec/support/shell.rb