middleman-data_source 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85df268b12b267b0188e48c25197f71e010d8fb1
+  data.tar.gz: ff9ba310306744a80915886e1e49ac64c0e24e9b
+SHA512:
+  metadata.gz: 13f802e2a98a282a811b285d6c1333feb82a1cd49661e38d72210dbb0d79754e484d8c28a31d6bd9c8c979fd20d1265a328b5c3e04dfbfe9ac7d38126aaab8dc
+  data.tar.gz: 332500e03df8e1c0a1e9e28edbc29106554f5f8a3e493a91f35bbaa522b38890df0bb4217c6dd2368e33b7491697a5ecd85b5bd37362e6bd3e909d29d04aed5b

data/changelog.md

@@ -0,0 +1,2 @@
+# 0.1.0
+- initial release supporting rack or borrower discovered assets parsed with YAML or JSON.

data/lib/middleman-data_source.rb

@@ -0,0 +1,2 @@
+require 'borrower'
+require_relative 'middleman/data_source'

data/lib/middleman/data_source.rb

@@ -0,0 +1,7 @@
+require_relative 'data_source/version' unless defined?(Middleman::DataSource::VERSION)
+require_relative 'data_source/extension'
+
+module Middleman
+  module DataSource
+  end
+end

data/lib/middleman/data_source/extension.rb

@@ -0,0 +1,78 @@
+module Middleman
+  module DataSource
+
+    class Extension < ::Middleman::Extension
+      self.supports_multiple_instances = true
+
+      option :rack_app,  nil, 'rack app to use'
+      option :root,      nil, 'http(s) host to use'
+      option :files,      [], 'routes to mount as remote data files'
+
+      def rack_app
+        @_rack_app ||= ::Rack::Test::Session.new( ::Rack::MockSession.new( options.rack_app ) )
+      end
+
+      def after_configuration
+        options.files.each do |remote_file|
+          extension = File.extname  remote_file
+          basename  = File.basename remote_file, extension
+          parts     = remote_file.split(File::SEPARATOR)[0..-2]
+
+          if parts.empty?
+            original_callback = app.data.callbacks[basename]
+            app.data.callbacks[basename] = Proc.new do
+              attempt_merge_then_enhance decode_data(remote_file, extension), original_callback
+            end
+          else
+            original_callback = app.data.callbacks[parts.first]
+            app.data.callbacks[parts.first] = Proc.new do
+              built_data = { basename => decode_data(remote_file, extension) }
+              parts[1..-1].reverse.each do |part|
+                built_data = { part => built_data }
+              end
+
+              attempt_merge_then_enhance built_data, original_callback
+            end
+          end
+        end
+      end
+
+      private
+
+        def attempt_merge_then_enhance new_data, original_callback
+          if original_callback
+            original_data = original_callback.call
+            if original_data.respond_to? :merge
+              return ::Middleman::Util.recursively_enhance original_data.deep_merge(new_data)
+            end
+          end
+
+          return ::Middleman::Util.recursively_enhance new_data
+        end
+
+        def decode_data file_path, extension
+          if ['.yaml', '.yml'].include? extension
+            YAML.load get_file_contents file_path
+          elsif extension == '.json'
+            ActiveSupport::JSON.decode get_file_contents file_path
+          else
+            raise UnsupportedDataExtension
+          end
+        end
+
+        def get_file_contents file_path
+          if options.rack_app
+            rack_app.get( URI.escape(file_path) ).body
+          else
+            Borrower::Content.get File.join( options.root, file_path )
+          end
+        end
+
+      class UnsupportedDataExtension < ArgumentError
+      end
+
+    end
+    ::Middleman::Extensions.register(:data_source, Middleman::DataSource::Extension)
+
+  end
+end

data/lib/middleman/data_source/version.rb

@@ -0,0 +1,7 @@
+module Middleman
+  module DataSource
+
+    VERSION = "0.1.0"
+
+  end
+end

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require 'middleman-data_source'

data/readme.md

@@ -0,0 +1,110 @@
+Allows mounting of remote JSON & YAML to the [Middleman](http://middlemanapp.com) `data` object.
+
+# Use
+
+With Rubygems
+
+```bash
+$ gem install middleman-data_source
+```
+
+With Bundler
+
+```ruby
+gem 'middleman-data_source'
+```
+
+Then in your [Middleman](http://middlemanapp.com)'s `config.rb`
+
+```ruby
+activate :data_source do |c|
+  c.root  = "http://yourdatahost.com"
+  c.files = [
+    "some.yaml",
+    "paths/js.json"
+  ]
+end
+```
+
+And access them like any other data:
+
+```ruby
+# source/index.html
+
+= data.some.title
+```
+
+You can fetch your data in two ways:
+1. from the file system or web with [Borrower](http://github.com/stevenosloan/borrower)
+2. with a rack app
+
+Multiple instances of the extension are supported, so activate once for each data source you require.
+
+
+### With Borrower
+
+Borrower provides a common interface for fetching files from the filesystem or through http, so it's configured the same either way. You'll specify your `root`, then the files you want loaded (with paths relative to root).
+
+```ruby
+# config.rb
+
+activate :data_source do |c|
+  c.root = '/var/data'
+  c.files = [
+    'middleman.json' # will look for this file at /var/data/middleman.json
+                     # and be accessible through data.middleman
+  ]
+end
+
+activate :data_source do |c|
+  c.root = "http://yourhost.com"
+  c.files = [
+    'middleman.json' # will look for the file at http://yourhost.com/middleman.json
+                     # and be accessible through data.middleman
+  ]
+```
+
+### With a Rack App
+
+We can also fetch data through a local rack app, so if you want to manipulate a database and mount the data you can. A simple example that just uses Rack::Static would look like this:
+
+```ruby
+# config.rb
+
+activate :data_source do |c|
+
+  c.rack_app = Rack::Builder.new do
+                 use Rack::Static, urls: ["/"],
+                                   root: "remote_data"
+                 run lambda {|env| [404, {'Content-type' => 'text/plain'}, ['Not found']] }
+              end
+
+  c.files = [
+    'rack.json' # passes /rack.json to your rack app
+                # and mounts the data to data.rack
+  ]
+end
+```
+
+
+# Testing
+
+```bash
+$ rspec
+```
+
+
+# Contributing
+
+If there is any thing you'd like to contribute or fix, please:
+
+- Fork the repo
+- Add tests for any new functionality
+- Make your changes
+- Verify all existing tests work properly
+- Make a pull request
+
+
+# License
+
+The `middleman-data_source` gem is distributed under the [MIT License](/LICENSE).

data/spec/fixtures/base/config.rb

@@ -0,0 +1,20 @@
+set :environment,     :test
+set :show_exceptions, false
+
+activate :data_source do |c|
+
+  c.rack_app = Rack::Builder.new do
+                 use Rack::Static, urls: ["/"],
+                                   root: "remote_data"
+                 run lambda {|env| [404, {'Content-type' => 'text/plain'}, ['Not found']] }
+              end
+
+  c.files = [
+    'remote.json',
+    'deeply/nested.json',
+    'deeply/nested/routes.json',
+    'in_yaml.yml',
+    'in_json.json'
+  ]
+
+end

data/spec/fixtures/borrower/config.rb

@@ -0,0 +1,16 @@
+set :environment,     :test
+set :show_exceptions, false
+
+activate :data_source do |c|
+
+  c.root = File.join( Dir.pwd, 'remote_data' )
+
+  c.files = [
+    'remote.json',
+    'deeply/nested.json',
+    'deeply/nested/routes.json',
+    'in_yaml.yml',
+    'in_json.json'
+  ]
+
+end

data/spec/fixtures/multiple_instances/config.rb

@@ -0,0 +1,22 @@
+set :environment,     :test
+set :show_exceptions, false
+
+activate :data_source do |c|
+
+  c.root = File.join( Dir.pwd, 'remote_data1' )
+
+  c.files = [
+    'remote.json'
+  ]
+
+end
+
+activate :data_source do |c|
+
+  c.root = File.join( Dir.pwd, 'remote_data2' )
+
+  c.files = [
+    'in_yaml.yml'
+  ]
+
+end

data/spec/fixtures/unsupported_extension/config.rb

@@ -0,0 +1,3 @@
+activate :data_source do |c|
+  c.files = [ 'unsupported.jpg' ]
+end

data/spec/lib/middleman-data_source_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Middleman::DataSource do
+end

data/spec/lib/middleman/data_source/extension_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+describe Middleman::DataSource::Extension do
+
+  it "is registered as an extension" do
+    expect( Middleman::Extensions.registered[:data_source] ).to eq Middleman::DataSource::Extension
+  end
+
+  shared_examples "data import" do
+    it "adds data to application" do
+      expect( @mm.data.remote ).to eq [{"item" => "one"}, {"item" => "two"}]
+    end
+
+    it "supports nested routes" do
+      expect( @mm.data.deeply.nested.routes ).to eq [{"item" => "one"}, {"item" => "two"}]
+    end
+
+    it "attempts to not clobber data of overlapping nested routes (if it's hashes)" do
+      expect( @mm.data.deeply.nested.has_key? "nestable" ).to eq true
+      expect( @mm.data.deeply.nested["nestable"] ).to eq "data"
+    end
+
+    it "support yaml or json" do
+      expect( @mm.data.in_yaml ).to eq ["data","in","yaml"]
+      expect( @mm.data.in_json ).to eq ["data","in","json"]
+    end
+  end
+
+  context "with the base fixture app" do
+    before :each do
+      Given.fixture 'base'
+      @mm = Middleman::Fixture.app
+      @extension = @mm.extensions[:data_source]
+    end
+
+    after :each do
+      Given.cleanup!
+    end
+
+    it_behaves_like "data import"
+  end
+
+  context "with unsupported_extension" do
+    before :each do
+      Given.fixture 'unsupported_extension'
+      @app = Middleman::Fixture.app
+    end
+
+    after :each do
+      Given.cleanup!
+    end
+
+    it "raises UnsupportedDataExtension" do
+      expect{ @app.data.unsupported }.to raise_error Middleman::DataSource::Extension::UnsupportedDataExtension
+    end
+  end
+
+  context "with root set to http source" do
+    before :each do
+      Given.fixture 'borrower'
+      @mm = Middleman::Fixture.app
+      @extension = @mm.extensions[:data_source]
+    end
+
+    after :each do
+      Given.cleanup!
+    end
+
+    it_behaves_like "data import"
+  end
+
+
+  context "with multiple instances" do
+    before :each do
+      Given.fixture 'multiple_instances'
+      @mm = Middleman::Fixture.app
+      @extension = @mm.extensions[:data_source]
+    end
+
+    after :each do
+      Given.cleanup!
+    end
+
+    it "returns data from both instances" do
+      expect( @mm.data.remote ).to eq [{"item" => "one"}, {"item" => "two"}]
+      expect( @mm.data.in_yaml ).to eq ["data","in","yaml"]
+    end
+  end
+
+end

data/spec/lib/middleman/data_source/version_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Middleman::DataSource::VERSION do
+  it "has a version" do
+    expect( Middleman::DataSource::VERSION >= '0.0.0' ).to eq true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'rspec'
+require 'rack/test'
+require 'middleman'
+
+require_relative 'support/given'
+require_relative 'support/fixture'
+require_relative 'support/browser'
+
+if ENV['DEBUG']
+  require 'pry'
+end
+
+RSpec.configure do |c|
+
+  c.mock_with :rspec do |mocks|
+    mocks.verify_doubled_constant_names = true
+    mocks.verify_partial_doubles        = true
+  end
+
+end
+
+def tracer msg
+  STDOUT.puts "\n\n==========================\n\n#{msg}\n\n==========================\n"
+end
+
+require 'middleman-data_source'

data/spec/support/browser.rb

@@ -0,0 +1,20 @@
+module Middleman
+  class Browser
+
+    attr_reader :browser
+
+    def initialize app
+      app_on_rack = app.class.to_rack_app
+      @browser    = ::Rack::Test::Session.new( ::Rack::MockSession.new(app_on_rack) )
+    end
+
+    def get path
+      browser.get( URI.escape(path) ).body
+    end
+
+    def get_response path
+      browser.get( URI.escape(path) )
+    end
+
+  end
+end

data/spec/support/fixture.rb

@@ -0,0 +1,22 @@
+module Middleman
+  module Fixture
+
+    class << self
+
+      def default env=:test
+        Middleman::Application.server.inst do
+          set :environment, env
+        end
+      end
+
+      def app &block
+        ENV['MM_ROOT'] = Given::TMP
+        Middleman::Application.server.inst do
+          instance_eval(&block) if block
+        end
+      end
+
+    end
+
+  end
+end

data/spec/support/given.rb

@@ -0,0 +1,28 @@
+module Given
+  ROOT = File.expand_path( '../..', __dir__ )
+  TMP  = File.join( ROOT, 'tmp' )
+
+  class << self
+
+    def fixture fixture
+      cleanup!
+
+      `rsync -av ./spec/fixtures/#{fixture}/ #{TMP}/`
+      Dir.chdir TMP
+    end
+
+    def file name, content
+      file_path = File.join( TMP, name )
+      FileUtils.mkdir_p( File.dirname(file_path) )
+      File.open( file_path, 'w' ) do |file|
+        file.write content
+      end
+    end
+
+    def cleanup!
+      Dir.chdir ROOT
+      `rm -rf #{TMP}`
+    end
+
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: middleman-data_source
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steven Sloan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: borrower
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: " Allow for loading data in middleman from remote sources "
+email: stevenosloan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- changelog.md
+- lib/middleman-data_source.rb
+- lib/middleman/data_source.rb
+- lib/middleman/data_source/extension.rb
+- lib/middleman/data_source/version.rb
+- lib/middleman_extension.rb
+- readme.md
+- spec/fixtures/base/config.rb
+- spec/fixtures/borrower/config.rb
+- spec/fixtures/multiple_instances/config.rb
+- spec/fixtures/unsupported_extension/config.rb
+- spec/lib/middleman-data_source_spec.rb
+- spec/lib/middleman/data_source/extension_spec.rb
+- spec/lib/middleman/data_source/version_spec.rb
+- spec/spec_helper.rb
+- spec/support/browser.rb
+- spec/support/fixture.rb
+- spec/support/given.rb
+homepage: http://github.com/stevenosloan/middleman-data_source
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Allow for loading data in middleman from remote sources
+test_files:
+- spec/fixtures/base/config.rb
+- spec/fixtures/borrower/config.rb
+- spec/fixtures/multiple_instances/config.rb
+- spec/fixtures/unsupported_extension/config.rb
+- spec/lib/middleman/data_source/extension_spec.rb
+- spec/lib/middleman/data_source/version_spec.rb
+- spec/lib/middleman-data_source_spec.rb
+- spec/spec_helper.rb
+- spec/support/browser.rb
+- spec/support/fixture.rb
+- spec/support/given.rb