middleman-data_source 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c171a11ee4a3c842ff19e9da42ef88fa4db97efe
-  data.tar.gz: c68e86e0c5b7bd274cd4fb1bf94bd6dd7668b88b
+  metadata.gz: 44c1b70621ff4a70696742d721daea2dffee76ac
+  data.tar.gz: 22cf1ed7c44ba3d5aa5c2c0626b236f05e19a8dc
 SHA512:
-  metadata.gz: f781063b434454cbe0051dc59e60a49ba52f4e6cabc77dcced2c06c6dde231e9652f0b539fd5e648052880391c483c1d6b657cb5fcdeca5567b81ca1424f17c8
-  data.tar.gz: 4067143433e37ed48fefeb716b44ace151b7ba8efbfb7b82dbde3c605c41421aa15b735db6ecf185398289784a75a69fc523bdc4564432deaec6519f7bb7dfc4
+  metadata.gz: e6c6aa484e291c1bba697dedd88410f3289df2a0c7d4194caf34e0cd5f28965ace6b37dbc15ab4fa00f3127963a5b260f3a28c4b2f9d29b49166fbc99a442040
+  data.tar.gz: a61eccd9fe52b00cc0eeecaa63a7656b2340b623c37f571965304c95cbdec7fc33153157a76d0b35fbdfb318bc69f495611c7b725f6247b71a80ced39ffb3dad

data/changelog.md

@@ -1,3 +1,7 @@
+# 0.8.0
+- add feature for passing `middleware:` option with sources to alter incoming data
+- allow passing `index:` option to collections to define custom index (or `false` for no index)
+
 # 0.7.1
 - allow passing data type to collection
 - fix access to data object in middleman 3.x code branches

data/lib/middleman/data_source/extension.rb

@@ -11,8 +11,7 @@ module Middleman
       option :decoders,   {}, 'callable functions to decode data sources'
       option :collection, {}, 'group of recursive resources'
 
-      attr_reader :decoders, :sources, :collection,
-                  :app_inst
+      attr_reader :decoders, :sources, :app_inst
 
       def rack_app
         @_rack_app ||= ::Rack::Test::Session.new( ::Rack::MockSession.new( options.rack_app ) )
@@ -20,24 +19,26 @@ module Middleman
 
       def initialize app, options_hash={}, &block
         super app, options_hash, &block
-        @app_inst = app.respond_to?(:inst) ? app.inst : app
-
-        @sources    = options.sources.dup + convert_files_to_sources(options.files)
-        @decoders   = default_decoders.merge(options.decoders)
 
-        if options.collection.empty?
-          @collection = false
-        else
-          @collection = options.collection
-          sources.push options.collection.merge alias: File.join( options.collection[:alias], 'all' )
-        end
+        @app_inst = app.respond_to?(:inst) ? app.inst : app
+        @sources  = options.sources.dup + convert_files_to_sources(options.files)
+        @decoders = default_decoders.merge(options.decoders)
 
         sources.each do |source|
-          add_data_callback_for_source(source)
+          add_data_callback_for_source source
         end
 
-        if collection
-          collection[:items].call( app_inst.data[collection[:alias]]['all'] ).map do |source|
+        if !options.collection.empty?
+          collection = { index: 'all' }.merge options.collection
+
+          if collection[:index]
+            add_data_callback_for_source collection.merge alias: File.join( collection[:alias], collection[:index] )
+            collection_data_callback = lambda { app_inst.data[collection[:alias]][collection[:index]] }
+          else
+            collection_data_callback = lambda { get_data(collection) }
+          end
+
+          collection[:items].call( collection_data_callback.call() ).map do |source|
             source[:alias] = File.join(collection[:alias], source[:alias])
             source
           end.each do |source|
@@ -49,21 +50,18 @@ module Middleman
       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)
-          basename      = File.basename(parts.pop, raw_extension)
+          basename, parts, extension = extract_basename_parts_and_extension source
 
           if parts.empty?
             original_callback = app_inst.data.callbacks[basename]
             app_inst.data.callbacks[basename] = Proc.new do
-              attempt_merge_then_enhance decode_data(source, extension), original_callback
+              attempt_merge_then_enhance get_data(source, extension), original_callback
             end
           else
             original_callback = app_inst.data.callbacks[parts.first]
             app_inst.data.callbacks[parts.first] = Proc.new do
               begin
-                built_data = { basename => decode_data(source, extension) }
+                built_data = { basename => get_data(source, extension) }
                 parts[1..-1].reverse.each do |part|
                   built_data = { part => built_data }
                 end
@@ -111,10 +109,20 @@ module Middleman
           return ::Middleman::Util.recursively_enhance new_data
         end
 
-        def decode_data source, extension
+        def extract_basename_parts_and_extension source
+          raw_extension = File.extname(source[:path])
+          extension     = raw_extension.split('?').first
+          parts         = source[:alias].split(File::SEPARATOR)
+          basename      = File.basename(parts.pop, raw_extension)
+
+          [basename, parts, extension]
+        end
+
+        def get_data source, extension=nil
           if source.has_key? :type
             decoder = decoders[source[:type]]
           else
+            _, _, extension = extract_basename_parts_and_extension(source) unless extension
             decoder = decoders.find do |candidate|
               candidate[1][:extensions].include? extension
             end
@@ -123,7 +131,13 @@ module Middleman
 
           raise UnsupportedDataExtension unless decoder
 
-          decoder[:decoder].call get_file_contents source[:path]
+          data = decoder[:decoder].call get_file_contents source[:path]
+
+          if source[:middleware]
+            data = source[:middleware].call data
+          end
+
+          return data
         end
 
         def get_file_contents file_path

data/lib/middleman/data_source/version.rb

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

data/readme.md

@@ -155,7 +155,7 @@ Collections allow you to collection sources that have belong together in an arra
 }
 ```
 
-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:
+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 `#{alias}.#{index}`. 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|
@@ -163,6 +163,7 @@ activate :data_source do |c|
   c.collection = {
     alias: 'got_chars',
     path: '/got/index.json',
+    index: 'all',
     items: Proc.new { |data|
       data.map do |char|
         {
@@ -185,6 +186,35 @@ data.got_chars['eddard-stark'].quote
 # => Winter is coming
 ```
 
+For index_name, you can also pass `false` to not generate the index data.
+
+
+### Adding Middleware
+
+You may wish to alter the incoming data before it gets added to Middleman's data object, to do so you'll add middleware. Middleware should respond to `#call` and return your altered data. Here's an example where we add "1" to each item in an array:
+
+```yaml
+# count.yaml
+- 1
+- 2
+- 3
+```
+
+```ruby
+# config.rb
+activate :data_source do |c|
+  c.root = "http://example.com"
+  c.sources = [{
+    alias: 'altered',
+    path: 'count.yaml',
+    middleware: Proc.new { |data| data.map { |i| i + 1 } }
+  }]
+end
+
+data.altered
+# => [2, 3, 4]
+```
+
 
 # Testing
 

data/spec/fixtures/collection/config.rb

@@ -1,7 +1,7 @@
 set :environment,     :test
 set :show_exceptions, false
 
-
+# base collection spec
 activate :data_source do |c|
 
   c.root = File.join( Dir.pwd, 'remote_data' )
@@ -21,7 +21,7 @@ activate :data_source do |c|
 
 end
 
-
+# extensionless
 activate :data_source do |c|
 
   c.root = File.join( Dir.pwd, 'remote_data' )
@@ -35,3 +35,31 @@ activate :data_source do |c|
 
 end
 
+# custom index key
+activate :data_source do |c|
+
+  c.root = File.join( Dir.pwd, 'remote_data' )
+
+  c.collection = {
+    alias: 'custom_index',
+    index: 'dem_things',
+    path: 'custom_index/index.yaml',
+    items: Proc.new { |d| [] }
+  }
+
+end
+
+# no index key
+activate :data_source do |c|
+
+  c.root = File.join( Dir.pwd, 'remote_data' )
+
+  c.collection = {
+    alias: 'no_index',
+    index: false,
+    path: 'no_index/index.yaml',
+    items: Proc.new { |d| [{ alias: 'data',
+                             path: 'no_index/index.yaml' }] }
+  }
+
+end

data/spec/fixtures/middleware/config.rb

@@ -0,0 +1,18 @@
+set :environment,     :test
+set :show_exceptions, false
+
+activate :data_source do |c|
+
+  c.root = File.join( Dir.pwd, 'remote_data' )
+
+  c.sources = [
+    {
+      alias: 'altered',
+      path: 'zero_index_array.yaml',
+      middleware: Proc.new { |data|
+        data.map { |i| i + 1 }
+      }
+    }
+  ]
+
+end

data/spec/lib/middleman/data_source/extension/collection_spec.rb

@@ -0,0 +1,37 @@
+RSpec.describe "Middleman::DataSource::Extension (feat) collection" 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
+
+    it "sets custom index key if given one" do
+      expect( @mm.data.custom_index.dem_things.map(&:to_h) ).to match_array [{"dem" => "things"}]
+    end
+
+    it "removes index if given index false" do
+      expect( @mm.data.no_index.all ).to be_nil
+      expect( @mm.data.no_index.data.missing ).to eq "index"
+    end
+
+end

data/spec/lib/middleman/data_source/extension/middleware_spec.rb

@@ -0,0 +1,16 @@
+RSpec.describe "Middleman::DataSource::Extension (feat) middleware" do
+
+    before :each do
+      Given.fixture 'middleware'
+      @mm = Middleman::Fixture.app
+    end
+
+    after :each do
+      Given.cleanup!
+    end
+
+    it "sets data after being passed through middleware" do
+      expect( @mm.data.altered ).to match_array [1, 2, 3, 4]
+    end
+
+end

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

@@ -148,32 +148,4 @@ RSpec.describe Middleman::DataSource::Extension do
 
   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-data_source
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Steven Sloan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-05 00:00:00.000000000 Z
+date: 2016-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman
@@ -70,10 +70,13 @@ files:
 - spec/fixtures/collection/config.rb
 - spec/fixtures/files_as_hash/config.rb
 - spec/fixtures/imediate_use/config.rb
+- spec/fixtures/middleware/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/collection_spec.rb
+- spec/lib/middleman/data_source/extension/middleware_spec.rb
 - spec/lib/middleman/data_source/extension_spec.rb
 - spec/lib/middleman/data_source/version_spec.rb
 - spec/spec_helper.rb
@@ -110,9 +113,12 @@ test_files:
 - spec/fixtures/collection/config.rb
 - spec/fixtures/files_as_hash/config.rb
 - spec/fixtures/imediate_use/config.rb
+- spec/fixtures/middleware/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/collection_spec.rb
+- spec/lib/middleman/data_source/extension/middleware_spec.rb
 - spec/lib/middleman/data_source/extension_spec.rb
 - spec/lib/middleman/data_source/version_spec.rb
 - spec/lib/middleman-data_source_spec.rb