middleman-data_source 0.6.1 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8644a9a460f377c8c69f395ad49f85e08c600fcc
-  data.tar.gz: 2dc0d7139e818f655f7ad6a3bbd7eb8612d38693
+  metadata.gz: c171a11ee4a3c842ff19e9da42ef88fa4db97efe
+  data.tar.gz: c68e86e0c5b7bd274cd4fb1bf94bd6dd7668b88b
 SHA512:
-  metadata.gz: 031b02e3c88069f6232345bf159f007b9d0b14fa22e87e74c461beaf5abef13d47e7a85bff1d4cf210247ed695c1b37fba8128964c7e286d78af391d748fda0e
-  data.tar.gz: 1699caaa0cdfad8f4ba4cf5d311ca0ff0fe44ea101cfe2bd0d2f7a9e68027763a9e5e0b647e8480dd655126e08ec217afa61f68d4ca16ea5ef38aaa9775a7edf
+  metadata.gz: f781063b434454cbe0051dc59e60a49ba52f4e6cabc77dcced2c06c6dde231e9652f0b539fd5e648052880391c483c1d6b657cb5fcdeca5567b81ca1424f17c8
+  data.tar.gz: 4067143433e37ed48fefeb716b44ace151b7ba8efbfb7b82dbde3c605c41421aa15b735db6ecf185398289784a75a69fc523bdc4564432deaec6519f7bb7dfc4

data/changelog.md

@@ -1,3 +1,11 @@
+# 0.7.1
+- allow passing data type to collection
+- fix access to data object in middleman 3.x code branches
+
+# 0.7.0 [YANKED]
+- feat(collection): create a collection type that can generate a collection of resources based off of an index endpoint. [more info](readme.md#creating-a-collection)
+- stop using `ActiveSupport::JSON` to parse json, this causes dates to no longer be decoded. To restore the original behavior, add a custom decoder for json.
+
 # 0.6.1
 - fixes for newer versions of middleman 4 compatability
 

data/lib/middleman/data_source/extension.rb

@@ -5,12 +5,14 @@ module Middleman
       self.supports_multiple_instances = true
 
       option :rack_app,  nil, 'rack app to use'
-      option :root,      nil, 'http(s) host to use'
+      option :root,      nil, 'http(s) host or file path to use'
       option :files,      [], 'routes to mount as remote data files'
       option :sources,    [], 'array of sources to mount as data'
       option :decoders,   {}, 'callable functions to decode data sources'
+      option :collection, {}, 'group of recursive resources'
 
-      attr_reader :decoders, :sources
+      attr_reader :decoders, :sources, :collection,
+                  :app_inst
 
       def rack_app
         @_rack_app ||= ::Rack::Test::Session.new( ::Rack::MockSession.new( options.rack_app ) )
@@ -18,19 +20,35 @@ module Middleman
 
       def initialize app, options_hash={}, &block
         super app, options_hash, &block
+        @app_inst = app.respond_to?(:inst) ? app.inst : app
 
-        app_inst  = app.respond_to?(:inst) ? app.inst : app
-        @sources  = options.sources.dup
-        @decoders = default_decoders.merge(options.decoders)
+        @sources    = options.sources.dup + convert_files_to_sources(options.files)
+        @decoders   = default_decoders.merge(options.decoders)
 
-        options.files.flat_map do |remote_path, local|
-          @sources.push({
-            :alias => (local || remote_path),
-            :path =>  remote_path
-          })
+        if options.collection.empty?
+          @collection = false
+        else
+          @collection = options.collection
+          sources.push options.collection.merge alias: File.join( options.collection[:alias], 'all' )
         end
 
-        @sources.each do |source|
+        sources.each do |source|
+          add_data_callback_for_source(source)
+        end
+
+        if collection
+          collection[:items].call( app_inst.data[collection[:alias]]['all'] ).map do |source|
+            source[:alias] = File.join(collection[:alias], source[:alias])
+            source
+          end.each do |source|
+            add_data_callback_for_source(source)
+          end
+        end
+      end
+
+      private
+
+        def add_data_callback_for_source source
           raw_extension = File.extname(source[:path])
           extension     = raw_extension.split('?').first
           parts         = source[:alias].split(File::SEPARATOR)
@@ -44,24 +62,34 @@ module Middleman
           else
             original_callback = app_inst.data.callbacks[parts.first]
             app_inst.data.callbacks[parts.first] = Proc.new do
-              built_data = { basename => decode_data(source, extension) }
-              parts[1..-1].reverse.each do |part|
-                built_data = { part => built_data }
+              begin
+                built_data = { basename => decode_data(source, extension) }
+                parts[1..-1].reverse.each do |part|
+                  built_data = { part => built_data }
+                end
+
+                attempt_merge_then_enhance built_data, original_callback
+              rescue => e
+                binding.pry
               end
-
-              attempt_merge_then_enhance built_data, original_callback
             end
           end
         end
-      end
 
-      private
+        def convert_files_to_sources files={}
+          files.flat_map do |remote_path, local|
+            {
+              alias: (local || remote_path),
+              path: remote_path
+            }
+          end
+        end
 
         def default_decoders
           {
             json: {
               extensions: ['.json'],
-              decoder:    ->(source) { ActiveSupport::JSON.decode(source) },
+              decoder:    ->(source) { JSON.parse(source) },
             },
             yaml: {
               extensions: ['.yaml', '.yml'],

data/lib/middleman/data_source/version.rb

@@ -1,7 +1,7 @@
 module Middleman
   module DataSource
 
-    VERSION = "0.6.1"
+    VERSION = "0.7.1"
 
   end
 end

data/readme.md

@@ -128,6 +128,64 @@ activate :data_source do |c|
 
 In the above example, I can access `app.data.by_extension` w/ the file contents decoded by `CustomType`, because it's extension `.ctype` matches the one defined by the `:my_type` decoder. Similarly, `app.data.foo_bar` is also run through `CustomType` because it's `:type` attribute is set to `:my_type`.
 
+
+### Creating a collection
+
+Collections allow you to collection sources that have belong together in an array and have distinct urls. This would loosely follow the Rails index/show convension. For example, lets say we have an endpoint that tells us about some Game of Thrones characters, and then includes a single endpoint for each with expanded information:
+
+```json
+# /got/index.json
+[
+  { "name": "Eddard Stark", "url": "/got/eddard-stark.json" },
+  { "name": "Hodor", "url": "/got/hodor.json" }
+]
+```
+
+```json
+# /got/eddard-stark.json
+{
+  "name": "Eddard Stark",
+  "quote": "Winter is coming"
+}
+
+#/got/hodor.json
+{
+  "name": "Hodor",
+  "quote": "Hodor!"
+}
+```
+
+Then set up a collection to access them through Middleman. A collection requires 3 keys, an `alias`, `path`, and `items`. The alias & path act just like a source, except that data will be available at `#{all}.all`. Items should be an object that responds to `#call` and returns an array of sources when given the data from the collection index. A collection for our example API:
+
+```ruby
+activate :data_source do |c|
+  c.root = 'http://winteriscoming.com'
+  c.collection = {
+    alias: 'got_chars',
+    path: '/got/index.json',
+    items: Proc.new { |data|
+      data.map do |char|
+        {
+          alias: char['name'].to_slug,
+          path: char['url']
+        }
+      end
+    }
+  }
+end
+```
+
+You'll see I've used a proc to map our index into sources. The information is then accessible via the data object:
+
+```ruby
+data.got_chars.all.map(&:name)
+# => ['Eddard Stark', 'Hodor']
+
+data.got_chars['eddard-stark'].quote
+# => Winter is coming
+```
+
+
 # Testing
 
 ```bash
@@ -135,6 +193,7 @@ $ rspec
 ```
 
 
+
 # Contributing
 
 If there is any thing you'd like to contribute or fix, please:

data/spec/fixtures/collection/config.rb

@@ -0,0 +1,37 @@
+set :environment,     :test
+set :show_exceptions, false
+
+
+activate :data_source do |c|
+
+  c.root = File.join( Dir.pwd, 'remote_data' )
+
+  c.collection = {
+    alias: 'root',
+    path: 'root.json',
+    items: Proc.new { |data|
+      data.map do |d|
+        {
+          alias: d['slug'],
+          path: File.join('root', "#{d['slug']}.json")
+        }
+      end
+    }
+  }
+
+end
+
+
+activate :data_source do |c|
+
+  c.root = File.join( Dir.pwd, 'remote_data' )
+
+  c.collection = {
+    alias: 'extensionless',
+    path: 'extensionless/foo',
+    type: :json,
+    items: Proc.new { |d| [] }
+  }
+
+end
+

data/spec/fixtures/nested_alias/config.rb

@@ -0,0 +1,19 @@
+set :environment,     :test
+set :show_exceptions, false
+
+activate :data_source do |c|
+
+  c.root = File.join( Dir.pwd, 'remote_data' )
+
+  c.files = {
+    'nested.json' => 'mounted/remote'
+  }
+
+  c.sources = [
+    {
+      alias: 'mounted',
+      path: 'nested.json'
+    }
+  ]
+
+end

data/spec/lib/middleman-data_source_spec.rb

@@ -1,4 +1,2 @@
-require 'spec_helper'
-
-describe Middleman::DataSource do
+RSpec.describe Middleman::DataSource do
 end

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

@@ -1,6 +1,4 @@
-require 'spec_helper'
-
-describe Middleman::DataSource::Extension do
+RSpec.describe Middleman::DataSource::Extension do
 
   it "is registered as an extension" do
     expect( Middleman::Extensions.registered[:data_source] ).to eq Middleman::DataSource::Extension
@@ -130,4 +128,52 @@ describe Middleman::DataSource::Extension do
     expect( remote_data ).to match_array [{"item"=>"one"},{"item"=>"two"}]
   end
 
+  context "with nested alias locations" do
+    before :each do
+      Given.fixture 'nested_alias'
+      @mm = Middleman::Fixture.app
+    end
+
+    after :each do
+      Given.cleanup!
+    end
+
+    it "puts data into the nested data location as though alias was a path" do
+      expect( @mm.data.mounted.remote.data ).to eq 'remote'
+    end
+
+    it "allows for overlapping paths" do
+      expect( @mm.data.mounted.data ).to eq 'remote'
+    end
+
+  end
+
+
+  context "with collection app" do
+    before :each do
+      Given.fixture 'collection'
+      @mm = Middleman::Fixture.app
+    end
+
+    after :each do
+      Given.cleanup!
+    end
+
+    it "makes collection items available at aliases" do
+      expect( @mm.data.root.john.title ).to eq "John"
+      expect( @mm.data.root.hodor.title ).to eq "Hodor"
+    end
+
+    it "makes collection index available at #all" do
+      expect( @mm.data.root.all.map(&:to_h) ).to match_array [{ "extra" => "info",
+                                                                "slug" => "hodor" },
+                                                              { "extra" => "info",
+                                                                "slug" => "john" }]
+    end
+
+    it "allows passing an extension type" do
+      expect( @mm.data.extensionless.all.foo ).to eq "bar"
+    end
+  end
+
 end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-data_source
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.1
 platform: ruby
 authors:
 - Steven Sloan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-15 00:00:00.000000000 Z
+date: 2016-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman
@@ -67,9 +67,11 @@ files:
 - readme.md
 - spec/fixtures/base/config.rb
 - spec/fixtures/borrower/config.rb
+- spec/fixtures/collection/config.rb
 - spec/fixtures/files_as_hash/config.rb
 - spec/fixtures/imediate_use/config.rb
 - spec/fixtures/multiple_instances/config.rb
+- spec/fixtures/nested_alias/config.rb
 - spec/fixtures/unsupported_extension/config.rb
 - spec/lib/middleman-data_source_spec.rb
 - spec/lib/middleman/data_source/extension_spec.rb
@@ -98,16 +100,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 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/collection/config.rb
 - spec/fixtures/files_as_hash/config.rb
 - spec/fixtures/imediate_use/config.rb
 - spec/fixtures/multiple_instances/config.rb
+- spec/fixtures/nested_alias/config.rb
 - spec/fixtures/unsupported_extension/config.rb
 - spec/lib/middleman/data_source/extension_spec.rb
 - spec/lib/middleman/data_source/version_spec.rb