jekyll-fridge 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 939432cda4f1442fdbfd37072c04c7bbba0b1a25
+  data.tar.gz: 39ad6c1cd25514568c639b94ab878aff51e8ec43
+SHA512:
+  metadata.gz: d92843a7b035d6a9fdc06c1fe1f50b41b41251c1aae6f66fee96c4984e720aa90b60aa62ac11d9b96dbee4e383d605e509e38f1baab7c221fbc663cbaebcb0ed
+  data.tar.gz: 7474db8469eb952ef6ba91adb97fc79506c6a2fd06ae9d26be5fc8466fe52aae6e3321a1a67a82425cb73e7e300aa8487b5f47661c5b63aa97e7c61c69b0407b

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Ripeworks
+
+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,94 @@
+jekyll-fridge
+=============
+
+Jekyll helper for adding Fridge content to your Jekyll site.
+
+Installation
+----
+
+* Add `jekyll-fridge` to your `Gemfile`:
+
+```Gemfile
+group :jekyll_plugins do
+  gem "jekyll-fridge"
+end
+```
+
+* Read on to configure the plugin.
+
+_[Not using Bundler? There are other ways..](http://jekyllrb.com/docs/plugins/)_
+
+Usage
+----
+
+In `_config.yml`
+
+```yaml
+fridge:
+  client_id: sk_xxxxxxxxxx
+  client_secret: xxxxxxxxxxxx
+```
+
+In your templates
+
+```liquid
+<h1>{{site.fridge.settings.home.title}}</h1>
+
+<nav>
+  {% for item in site.fridge.navigation.content %}
+    <li>{{item.title}}</li>
+  {% endfor %}
+</nav>
+
+{{site.fridge.content.15.body | markdownify }}
+
+{% for posts in site.fridge.content.blog_post %}
+  <li>Post: {{post.title}}</li>
+{% endfor %}
+```
+
+Using Jekyll filters
+
+```liquid
+{% assign firefoxes = site.fridge.browser.content | where:"title", "Firefox" %}
+{% for browser in firefoxes %}
+  <li>{{browser.title}}</li>
+{% endfor %}
+
+{% assign pages = site.fridge.content.page | sort:"title" %}
+{% for page in pages %}
+  <li>{{page.title}}</li>
+{% endfor %}
+```
+
+~~`where` filter currently depends on https://github.com/jekyll/jekyll/pull/2986~~
+
+Filters
+------
+
+`fridge_asset`
+
+Finds Fridge asset based on file name. Downloads asset to `asset_dir` _(configurable. defaults to `assets`)_ and
+returns a url for the file.
+
+```liquid
+{% for image in site.fridge.content.photo %}
+  <img src="{{ image.name | fridge_asset }}" />
+{% endfor %}
+```
+
+`fridge_choices`
+
+Parses choices from a select/radio/checkbox content type.
+
+```liquid
+{% assign choices = site.fridge.types.blog.categories.choices %}
+{% for category in choices %}
+  {{category}}
+{% endfor %}
+```
+
+Reference
+----
+
+* [Liquid](https://github.com/Shopify/liquid/wiki/Liquid-for-Designers)

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/jekyll-fridge.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll-fridge/version'
+
+Gem::Specification.new do |spec|
+  spec.add_development_dependency 'bundler', '~> 1.0'
+  spec.add_dependency 'jekyll', '~> 2.0'
+  spec.add_dependency 'fridge_api', '~> 0.1.3'
+  spec.authors = ["Mike Kruk"]
+  spec.email = ['mike@ripeworks.com']
+  spec.summary = %q{Jekyll plugin for building sites using Fridge content}
+  spec.description = %q{Jekyll plugin for building sites using Fridge content}
+  spec.files = %w(Rakefile LICENSE README.md jekyll-fridge.gemspec)
+  spec.files += Dir.glob("lib/**/*.rb")
+  spec.homepage = 'https://github.com/fridge-cms/jekyll-fridge'
+  spec.licenses = ['MIT']
+  spec.name = 'jekyll-fridge'
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 1.9.2'
+  spec.required_rubygems_version = '>= 1.3.5'
+  spec.version = Jekyll::Fridge::VERSION.dup
+end

data/lib/jekyll-fridge.rb

@@ -0,0 +1,183 @@
+require 'fridge_api'
+require 'ostruct'
+
+module Jekyll
+
+  # Recursively convert hash keys to strings
+  def self.stringify_keys_deep(h)
+    case h
+    when Hash
+      Hash[
+        h.map do |k, v|
+          [ k.respond_to?(:to_s) ? k.to_s : k, self.stringify_keys_deep(v) ]
+        end
+      ]
+    when Sawyer::Resource
+      self.stringify_keys_deep(h.to_h)
+    when Enumerable
+      h.map { |v| self.stringify_keys_deep(v) }
+    else
+      h
+    end
+  end
+
+  class Fridge < Generator
+    safe true
+    priority :low
+
+    def generate(site)
+      # get api configuration from _config.yml
+      #
+      # fridge:
+      #   client_id: sk_xxxx
+      #   client_secret: xxxx
+      api_config = site.config['fridge']
+      api_config['asset_dir'] ||= 'assets'
+
+      # set site.fridge as plugin entry
+      site.config['fridge'] = Client.new api_config
+    end
+  end
+
+  class Client < Liquid::Drop
+
+    attr_reader :client, :config
+
+    def initialize(config)
+      @client = FridgeApi.client({
+        :client_id => config['client_id'],
+        :client_secret => config['client_secret']
+      })
+      @config = config.delete_if { |k, v| k.to_s.match(/client/) }
+    end
+
+    def before_method(method)
+      # try content type
+      type = @client.get("types/#{method}")
+      if type && type.kind_of?(FridgeApi::Model)
+        return Jekyll.stringify_keys_deep(type.attrs.merge({
+          'content' => ContentDrop.new(@client, "content", "type=#{type.slug}")
+        }))
+      end
+
+      # try user role
+      role = @client.get("roles/#{method}")
+      if role && role.kind_of?(FridgeApi::Model)
+        return Jekyll.stringify_keys_deep(role.attrs.merge({
+          'users' => ContentDrop.new(@client, "users", "role=#{role.slug}")
+        }))
+      end
+
+      nil
+    end
+
+    def content
+      ContentDrop.new(@client, "content")
+    end
+
+    def collections
+      ContentDrop.new(@client, "collections")
+    end
+
+    def settings
+      ContentDrop.new(@client, "settings")
+    end
+
+    def types
+      ContentDrop.new(@client, "types")
+    end
+
+    def users
+      ContentDrop.new(@client, "users")
+    end
+
+  end
+
+  class ContentDrop < Liquid::Drop
+    include Enumerable
+
+    def initialize(client, base, query = "", data = nil)
+      @client = client
+      @base = base
+      @query = query
+      @data = data
+    end
+
+    def before_method(method)
+      # check for single content item
+      item = @client.get("#{@base}/#{method}?#{@query}")
+      return Model.new(item) if item && item.kind_of?(FridgeApi::Model)
+
+      # filter by content type
+      if @base == "content" && @query.empty?
+        types = @client.get("#{@base}?type=#{method}")
+        return ContentDrop.new(@client, @base, "type=#{method}", types) if types
+      end
+
+      # filter by user role
+      if @base == "users" && @query.empty?
+        roles = @client.get("#{@base}?role=#{method}")
+        return ContentDrop.new(@client, @base, "role=#{method}", roles) if roles
+      end
+
+      nil
+    end
+
+    def each &block
+      @data ||= @client.get(@base)
+      @data.each do |v|
+        m = Model.new v
+        if block_given?
+          block.call m
+        else
+          yield m
+        end
+      end
+    end
+
+  end
+
+  class Model
+    def initialize(model)
+      @model = model
+    end
+
+    def inspect
+      @data
+    end
+
+    def to_liquid
+      @data ||= Jekyll.stringify_keys_deep(@model.attrs)
+    end
+  end
+
+  module FridgeFilters
+    # Filter for fetching assets
+    # Writes static file to asset_dir and returns absolute file path
+    def fridge_asset(input)
+      site = @context.registers[:site]
+      asset_dir = site.config['fridge'].config['asset_dir']
+      dest_path = File.join(site.dest, asset_dir, input)
+
+      asset = site.config['fridge'].client.get("content/upload/#{input}")
+      return input unless asset
+
+      path = File.join(asset_dir, input)
+      # play for keeps
+      # this is so jekyll won't clean up the file
+      site.keep_files << path
+
+      # write file to destination
+      FileUtils.mkdir_p(File.dirname(dest_path))
+      File.write(dest_path, asset)
+      "/#{path}"
+    end
+  end
+
+  def fridge_choices(input)
+    input.lines
+  end
+
+end
+
+Liquid::Template.register_filter(Jekyll::FridgeFilters)

data/lib/jekyll-fridge/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module Fridge
+    VERSION = "0.0.1".freeze
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-fridge
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mike Kruk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: fridge_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+description: Jekyll plugin for building sites using Fridge content
+email:
+- mike@ripeworks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- jekyll-fridge.gemspec
+- lib/jekyll-fridge.rb
+- lib/jekyll-fridge/version.rb
+homepage: https://github.com/fridge-cms/jekyll-fridge
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.5
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Jekyll plugin for building sites using Fridge content
+test_files: []