jekyll-embed 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3570efa12f8e10276e3b2140358f20a82820b75f
+  data.tar.gz: a1770e1332ca513221bc81696d806847eb9b34ea
+SHA512:
+  metadata.gz: 6f9a4c99ebf9ddc029add33225dcc1449fa5ddeb8e3f9bf9c88ac4ccaa663cac54cb6bf86dde7ba7e6fe9ebe0bd378bc9ecc8b0e9736b0f1f58848a596cde36d
+  data.tar.gz: f7110bb883a8ec8f72843c33927a1bbbc621846badc255a1864ba161359bb89c023c1e589e5a5212a194d5cb5ba5ca1be098ccd86662bf25579600a31bed8386

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,21 @@
+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,79 @@
+# Jekyll::Embed
+
+Use links to build Jekyll page data.
+
+## Installation
+
+Follow [Jekyll's instructions for installing Jekyll plugins](http://jekyllrb.com/docs/plugins/#installing-a-plugin). The **Jekyll::Embed** plugin is available from the `jekyll-embed` gem.
+
+## Usage
+
+**Jekyll::Embed** relies on two special fields in the Jekyll page front matter to do its thing - `_links` and `_embedded`. These concepts come from the [Hypermedia Application Language (HAL)](http://stateless.co/hal_specification.html) media type specification.
+
+* `_links` is a container of links to other resources
+* `_embedded` is a container of other resources
+
+**Jekyll::Embed** finds resources using `_links` and puts them in `_embedded`.
+
+> For the purposes of this plugin, a resource and Jekyll page (specifically its front matter, aka data) can be considered the same thing.
+
+### Steps
+
+1. Define link objects to other resources in a `_links` field as part of the Jekyll page's front matter (aka data). Every link object should have `title` and `href` fields, but this plugin only needs `href` to work.
+2. Use the embedded resources in the Jekyll page.
+
+In the following example, Jill has links to her friends Bob and Jack inside of `_links` defined in the `people/jill.md` page.
+
+```yaml
+# people/jill.md (front matter only)
+
+title: Jill
+age: 6
+_links:
+  friends:
+    - title: Bob
+      href: /people/bob
+
+    - title: Jack
+      href: /people/jack
+```
+
+Below is the data that will be available to the `people/jill.md` page during the Jekyll build process. Notice that Jill's friends Bob and Jack are now included in their entirety in `_embedded` and are available to be displayed on the Jill's page.
+
+```yaml
+# people/jill.md (front matter only)
+
+title: Jill
+age: 6
+_links:
+  friends:
+    - title: Bob
+      href: /people/bob
+
+    - title: Jack
+      href: /people/jack
+
+_embedded:
+  friends:
+    - title: Bob
+      age: 5
+      _links:
+        friends:
+          - title: Jill
+            href: /people/jill
+
+    - title: Jack
+      age: 7
+      _links:
+        friends:
+          - title: Jill
+            href: /people/jill
+```
+
+## Contributing
+
+1. Fork it (https://github.com/gregoryjscott/jekyll-embed/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/embed_test.rb'
+end
+
+task :default => :test

data/jekyll-embed.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/embed/version'
+
+Gem::Specification.new do |spec|
+
+  spec.name          = 'jekyll-embed'
+  spec.version       = Jekyll::Embed::VERSION
+  spec.authors       = ['Greg Scott']
+  spec.email         = ['i@gregoryjscott.com']
+  spec.summary       = %q{Uses links to build Jekyll page data.}
+  spec.homepage      = 'https://github.com/gregoryjscott/jekyll-embed'
+  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.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'jekyll', '~> 2.5'
+
+end

data/lib/jekyll/embed.rb

@@ -0,0 +1,3 @@
+require 'jekyll'
+require 'jekyll/embed/version'
+require 'jekyll/embed/loader'

data/lib/jekyll/embed/loader.rb

@@ -0,0 +1,74 @@
+module Jekyll
+  module Embed
+    class Loader < Jekyll::Generator
+
+      def generate(site)
+        @site = site
+        Dir.chdir(@site.source) { embed }
+      end
+
+      def embed
+        capture_resources
+
+        @site.pages.each do |page|
+          embed_resources(page)
+        end
+      end
+
+      def embed_resources(page)
+        links = page.data['_links']
+        return if links.nil?
+
+        embedded = get_embedded(page)
+
+        links.keys.each do |key|
+          link_object = links[key]
+          if link_object.kind_of?(Array)
+            embed_many(embedded, key, link_object)
+          else
+            embed_single(embedded, key, link_object)
+          end
+        end
+      end
+
+      def embed_many(embedded, key, link_objects)
+        embedded[key] = [] if embedded[key].nil?
+
+        link_objects.each do |link_object|
+          resource = find_resource(link_object['href'])
+          embedded[key] << resource['data'] unless resource.nil?
+        end
+      end
+
+      def embed_single(embedded, key, link_object)
+        resource = find_resource(link_object['href'])
+        embedded[key] = resource['data'] unless resource.nil?
+      end
+
+      def get_embedded(page)
+        page.data['_embedded'] = { } if page.data['_embedded'].nil?
+        page.data['_embedded']
+      end
+
+      def capture_resources
+        @resources = []
+        @site.pages.each do |page|
+          @resources << {
+            'href' => page.url,
+            'data' => clone(page.data)
+          }
+        end
+      end
+
+      def find_resource(url)
+        @resources.detect { |resource| url == resource['href'] }
+      end
+
+      def clone(resource)
+        json = JSON.dump(resource)
+        JSON.parse(json)
+      end
+
+    end
+  end
+end

data/lib/jekyll/embed/version.rb

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

data/test/fixtures/people/bob.md

@@ -0,0 +1,13 @@
+---
+title: Bob
+age: 5
+
+_links:
+  brother:
+    title: Jack
+    href: /people/jack/
+
+  friends:
+    - title: Jill
+      href: /people/jill/
+---

data/test/fixtures/people/jack.md

@@ -0,0 +1,13 @@
+---
+title: Jack
+age: 7
+
+_links:
+  brother:
+    title: Bob
+    href: /people/bob/
+
+  friends:
+    - title: Jill
+      href: /people/jill/
+---

data/test/fixtures/people/jill.md

@@ -0,0 +1,15 @@
+---
+title: Jill
+age: 6
+
+_links:
+  friends:
+    - title: Bob
+      href: /people/bob/
+
+    - title: Jack
+      href: /people/jack/
+
+    - title: Fake
+      href: /people/fake/
+---

data/test/jekyll/embed_test.rb

@@ -0,0 +1,86 @@
+require 'jekyll/embed'
+require 'minitest/autorun'
+
+describe 'Jekyll::Embed' do
+
+  let(:config) do
+    Jekyll.configuration({
+      'source' => 'test/fixtures',
+      'permalink' => 'pretty',
+      'quiet' => true
+    })
+  end
+
+  let(:site) { Jekyll::Site.new(config) }
+
+  before(:each) do
+    site.process
+  end
+
+  it 'embeds local linked resource' do
+    assert_has_brother('Bob', 'Jack')
+    assert_has_brother('Jack', 'Bob')
+  end
+
+  it 'embeds local linked resource array' do
+    assert_has_friends('Bob', ['Jill'])
+    assert_has_friends('Jill', ['Bob', 'Jack'])
+    assert_has_friends('Jack', ['Jill'])
+  end
+
+  it 'does not embed previously embedded resources' do
+    check_embedded_for_embedded('Bob')
+    check_embedded_for_embedded('Jill')
+    check_embedded_for_embedded('Jack')
+  end
+
+  def assert_has_brother(name, expected_brother)
+    embedded_brother = get_embedded(name)['brother']
+
+    failure = "#{name} has wrong brother. Expected #{expected_brother}."
+    assert brother?(embedded_brother, expected_brother), failure
+  end
+
+  def assert_has_friends(name, expected_friends)
+    friends = get_embedded(name)['friends']
+
+    failure = "#{name} should have #{expected_friends.count} friends."
+    assert_equal expected_friends.count, friends.count, failure
+
+    expected_friends.each do |expected|
+      failure = "#{name} has the wrong friends. Expected #{expected}."
+      assert friend?(friends, expected), failure
+    end
+  end
+
+  def check_embedded_for_embedded(name)
+    embedded = get_embedded(name)
+
+    brother = embedded['brother']
+    failure = 'Embedded resources should not contain other embedded resources.'
+    assert_nil brother['_embedded'], failure unless brother.nil?
+
+    embedded['friends'].each do |friend|
+      assert_nil friend['_embedded'], failure
+    end
+  end
+
+  def get_embedded(name)
+    path = File.join('people', "#{name.downcase}.md")
+    page = site.pages.detect { |page| page.path == path }
+    page.data['_embedded']
+  end
+
+  def brother?(brother, name)
+    brother['title'] == name
+  end
+
+  def friend?(friends, name)
+    !find_friend(friends, name).nil?
+  end
+
+  def find_friend(friends, name)
+    friends.detect { |friend| friend['title'] == name }
+  end
+
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-embed
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Greg Scott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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-embed.gemspec
+- lib/jekyll/embed.rb
+- lib/jekyll/embed/loader.rb
+- lib/jekyll/embed/version.rb
+- test/fixtures/people/bob.md
+- test/fixtures/people/jack.md
+- test/fixtures/people/jill.md
+- test/jekyll/embed_test.rb
+homepage: https://github.com/gregoryjscott/jekyll-embed
+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: Uses links to build Jekyll page data.
+test_files:
+- test/fixtures/people/bob.md
+- test/fixtures/people/jack.md
+- test/fixtures/people/jill.md
+- test/jekyll/embed_test.rb