jekyll-prep 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b9e910451c643dec5a83d1f4f898ce6e9ecce92
+  data.tar.gz: 976d2ab8a82db6575ad518400ef43229a210b7ca
+SHA512:
+  metadata.gz: ffe8268dcb135a8035fea7979077071e84c3c09624853f0eb8d642729112bcde7887e254f21f0a43ba71c8df4eb524360c092f8069046028805a3a21bf99ab52
+  data.tar.gz: 05f0c2d1a5271124cb316b79cd85e3e2873b29e788ce674ad675b18bc0d9872bc126410e2256675b1225cf1cae46eb309d85b3e5db662ba67afe545f5a56ad1c

data/.gitignore

@@ -0,0 +1,4 @@
+/_site/
+/.bundle/
+/Gemfile.lock
+/pkg/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Greg Scott
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,38 @@
+# Jekyll::Prep
+
+Prepare Jekyll page data using Ruby.
+
+## Installation
+
+See [Jekyll's documentation for installing Jekyll plugins](http://jekyllrb.com/docs/plugins/#installing-a-plugin).
+
+## Usage
+
+1. Create a `_prep` directory in your Jekyll project.
+2. Inside the `_prep` directory, create `.rb` files that correspond to your `.md` Jekyll pages. For example, if you have a `/people/jill.md` Jekyll page then create a `_prep/people/jill.rb` file.
+3. Inside the `.rb` files, define subclasses of `Jekyll::Prep::Script` that define a `prepare` method that will receive an instance of Jekyll::Page. The subclass namespaces must align with the `.rb` file paths minus the leading underscore. For example, the file `_prep/people/jill.rb` should contain `Prep::People::Jill`.
+4. Inside the prepare methods, do whatever you want to `page.data`.
+
+```ruby
+# _prep/people/jill.rb
+
+module Prep
+  module People
+    class Jill < Jekyll::Prep::Script
+
+      def prepare(page)
+        page.data['something new'] = 'was added during prep'
+      end
+
+    end
+  end
+end
+```
+
+## Contributing
+
+1. Fork it (https://github.com/gregoryjscott/jekyll-prep/fork).
+2. Create your feature branch (`git checkout -b my-new-feature`).
+3. Commit your changes (`git commit -am 'Add some feature'`).
+4. Push to the branch (`git push origin my-new-feature`).
+5. Create a new Pull Request.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+
+desc 'Run tests'
+task :test do
+  system 'ruby -Ilib test/jekyll/prep_test.rb'
+end
+
+task :default => :test

data/jekyll-prep.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll/prep/version'
+
+Gem::Specification.new do |spec|
+
+  spec.name          = 'jekyll-prep'
+  spec.version       = Jekyll::Prep::VERSION
+  spec.authors       = ['Greg Scott']
+  spec.email         = ['i@gregoryjscott.com']
+  spec.summary       = %q{Prepare Jekyll page data using Ruby.}
+  spec.homepage      = 'https://github.com/gregoryjscott/jekyll-prep'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'jekyll', '~> 2.5'
+
+end

data/lib/jekyll/prep.rb

@@ -0,0 +1,3 @@
+require 'jekyll/prep/version'
+require 'jekyll/prep/script'
+require 'jekyll/prep/runner'

data/lib/jekyll/prep/runner.rb

@@ -0,0 +1,48 @@
+require 'jekyll'
+
+module Jekyll
+  module Prep
+    class Runner < Jekyll::Generator
+
+      def generate(site)
+        @site = site
+        Dir.chdir(@site.source) { prepare_pages }
+      end
+
+      def prepare_pages
+        require_files
+        scripts = instantiate_scripts
+
+        @site.pages.each do |page|
+          script = find_script(page, scripts)
+          script.prepare(page) unless script.nil?
+        end
+      end
+
+      def require_files
+        files = Dir[File.join('_prep', '**', '*.rb')]
+        files.each do |file|
+          path = File.expand_path(file)
+          require path
+        end
+      end
+
+      def instantiate_scripts
+        @site.instantiate_subclasses(Jekyll::Prep::Script)
+      end
+
+      def find_script(page, scripts)
+        namespace = 'prep'
+
+        path = File.dirname(page.path).gsub(File::SEPARATOR, '::')
+        namespace << "::#{path}" unless path == '.'
+
+        class_name = File.basename(page.path, '.*')
+        namespace << "::#{class_name}"
+
+        scripts.detect { |script| script.class.to_s.downcase == namespace }
+      end
+
+    end
+  end
+end

data/lib/jekyll/prep/script.rb

@@ -0,0 +1,8 @@
+require 'jekyll'
+
+module Jekyll
+  module Prep
+    class Script < Jekyll::Plugin
+    end
+  end
+end

data/lib/jekyll/prep/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module Prep
+    VERSION = "0.0.1"
+  end
+end

data/test/fixtures/_prep/index.rb

@@ -0,0 +1,9 @@
+module Prep
+  class Index < Jekyll::Prep::Script
+
+    def prepare(page)
+      page.data['prepared'] = true
+    end
+
+  end
+end

data/test/fixtures/_prep/people/jill.rb

@@ -0,0 +1,11 @@
+module Prep
+  module People
+    class Jill < Jekyll::Prep::Script
+
+      def prepare(page)
+        page.data['prepared'] = true
+      end
+
+    end
+  end
+end

data/test/fixtures/about.md

@@ -0,0 +1,2 @@
+---
+---

data/test/fixtures/index.md

@@ -0,0 +1,2 @@
+---
+---

data/test/fixtures/people/index.md

@@ -0,0 +1,2 @@
+---
+---

data/test/fixtures/people/jack.md

@@ -0,0 +1,2 @@
+---
+---

data/test/fixtures/people/jill.md

@@ -0,0 +1,2 @@
+---
+---

data/test/jekyll/prep_test.rb

@@ -0,0 +1,34 @@
+require 'jekyll/prep'
+require 'minitest/autorun'
+
+describe 'Prep' do
+
+  let(:config) do
+    Jekyll.configuration({
+      'source' => 'test/fixtures',
+      'quiet' => true
+    })
+  end
+
+  let(:site) { Jekyll::Site.new(config) }
+
+  before(:each) do
+    site.process
+  end
+
+  it 'prepares pages' do
+    page = site.pages.detect { |page| page.path == 'index.md' }
+    assert page.data['prepared']
+  end
+
+  it 'prepares nested pages' do
+    page = site.pages.detect { |page| page.path == 'people/jill.md' }
+    assert page.data['prepared']
+  end
+
+  it 'leaves other pages alone' do
+    page = site.pages.detect { |page| page.path == 'people/jack.md' }
+    assert_nil page.data['prepared']
+  end
+
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-prep
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Greg Scott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+description: 
+email:
+- i@gregoryjscott.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- jekyll-prep.gemspec
+- lib/jekyll/prep.rb
+- lib/jekyll/prep/runner.rb
+- lib/jekyll/prep/script.rb
+- lib/jekyll/prep/version.rb
+- test/fixtures/_prep/index.rb
+- test/fixtures/_prep/people/jill.rb
+- test/fixtures/about.md
+- test/fixtures/index.md
+- test/fixtures/people/index.md
+- test/fixtures/people/jack.md
+- test/fixtures/people/jill.md
+- test/jekyll/prep_test.rb
+homepage: https://github.com/gregoryjscott/jekyll-prep
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Prepare Jekyll page data using Ruby.
+test_files:
+- test/fixtures/_prep/index.rb
+- test/fixtures/_prep/people/jill.rb
+- test/fixtures/about.md
+- test/fixtures/index.md
+- test/fixtures/people/index.md
+- test/fixtures/people/jack.md
+- test/fixtures/people/jill.md
+- test/jekyll/prep_test.rb