middleman-data_source 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f007a9a894f8c5fc6d56b47a8e238939b96fbf12
-  data.tar.gz: 03abe96ea5700bb92236b4f00fc0681b279d33f9
+  metadata.gz: 8149a40f5de297992c3027d32d35a35592781065
+  data.tar.gz: 14b91bba9a92160b4c2d696df4698eefc48266ec
 SHA512:
-  metadata.gz: 0f38a7aade0e3d9f051c37fe2095aacf13a8bc070d66072e9ed95051b09087ff01a1900052baf8aa9aefcc47f201fd93441bcd8477c71e924c145c539a6958b5
-  data.tar.gz: a01f2c2bc6beacfb1a8e606241ff3a2fb5a4b66c159706f32145be7e57d820fe6f707ed584bea12c1449d3d14b91e1ae84c7dd52deb7f7635fb23f78c697c586
+  metadata.gz: 218bd22fd6a2875f9015641d9f87ccaaa865a24e4022304a1ed2a89b0094276e3197b0bf651b4a1cfff6300d097918e726e764087671dc1149ee7ee230ea52ea
+  data.tar.gz: 6589a1e6dd03534bf4121ff797058f91776ca6b90ce34b141b1bdb3171c4203a3e51b144a5184b75147b66f133f3e68d77f7b9f9563b475719bd5832b4bd54ce

data/changelog.md

@@ -1,3 +1,7 @@
+# 0.6.0
+- add definable decoders & allow override of default json & yaml decoders
+- allow for defining sources with arbitrary data types
+
 # 0.5.0
 - include support for resources that include query params after their file extension [@jordanandree]
 

data/lib/middleman/data_source/extension.rb

@@ -7,6 +7,10 @@ module Middleman
       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'
+      option :sources,    [], 'array of sources to mount as data'
+      option :decoders,   {}, 'callable functions to decode data sources'
+
+      attr_reader :decoders, :sources
 
       def rack_app
         @_rack_app ||= ::Rack::Test::Session.new( ::Rack::MockSession.new( options.rack_app ) )
@@ -15,30 +19,32 @@ module Middleman
       def initialize app, options_hash={}, &block
         super app, options_hash, &block
 
-        app_inst     = app.respond_to?(:inst) ? app.inst : app
-        remote_datas = if options.files.respond_to? :keys
-          options.files
-        else
-          Hash[options.files.map do |remote_file|
-            [remote_file, remote_file]
-          end]
+        app_inst  = app.respond_to?(:inst) ? app.inst : app
+        @sources  = options.sources.dup
+        @decoders = default_decoders.merge(options.decoders)
+
+        options.files.flat_map do |remote_path, local|
+          @sources.push({
+            :alias => (local || remote_path),
+            :path =>  remote_path
+          })
         end
 
-        remote_datas.each do |remote_file, local_representation|
-          raw_extension = File.extname(remote_file)
+        @sources.each do |source|
+          raw_extension = File.extname(source[:path])
           extension     = raw_extension.split('?').first
-          parts         = local_representation.split(File::SEPARATOR)
+          parts         = source[:alias].split(File::SEPARATOR)
           basename      = File.basename(parts.pop, raw_extension)
 
           if parts.empty?
             original_callback = app_inst.data.callbacks[basename]
             app_inst.data.callbacks[basename] = Proc.new do
-              attempt_merge_then_enhance decode_data(remote_file, extension), original_callback
+              attempt_merge_then_enhance decode_data(source, extension), original_callback
             end
           else
             original_callback = app_inst.data.callbacks[parts.first]
             app_inst.data.callbacks[parts.first] = Proc.new do
-              built_data = { basename => decode_data(remote_file, extension) }
+              built_data = { basename => decode_data(source, extension) }
               parts[1..-1].reverse.each do |part|
                 built_data = { part => built_data }
               end
@@ -51,6 +57,19 @@ module Middleman
 
       private
 
+        def default_decoders
+          {
+            json: {
+              extensions: ['.json'],
+              decoder:    ->(source) { ActiveSupport::JSON.decode(source) },
+            },
+            yaml: {
+              extensions: ['.yaml', '.yml'],
+              decoder:    ->(source) { YAML.load(source) }
+            }
+          }
+        end
+
         def attempt_merge_then_enhance new_data, original_callback
           if original_callback
             original_data = original_callback.call
@@ -62,21 +81,27 @@ module Middleman
           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
+        def decode_data source, extension
+          if source.has_key? :type
+            decoder = decoders[source[:type]]
           else
-            raise UnsupportedDataExtension
+            decoder = decoders.find do |candidate|
+              candidate[1][:extensions].include? extension
+            end
+            decoder = decoder.last if decoder
           end
+
+          raise UnsupportedDataExtension unless decoder
+
+          decoder[:decoder].call get_file_contents source[:path]
         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 )
+            file_path = File.join( options.root, file_path ) if options.root
+            Borrower::Content.get file_path
           end
         end
 

data/lib/middleman/data_source/version.rb

@@ -1,7 +1,7 @@
 module Middleman
   module DataSource
 
-    VERSION = "0.5.0"
+    VERSION = "0.6.0"
 
   end
 end

data/readme.md

@@ -98,6 +98,35 @@ activate :data_source do |c|
 end
 ```
 
+### Custom data types
+
+By default we just look at the extension of a file to determine which decoder to use. By setting a source directly you can give it any data type you need. Each source is a hash with an `alias`, `path`, and `type` key. The `alias` and `path` would be the same as if you defined the source using files as `{ path => alias }`, while type corresponds to the decoder you'd like to use.
+
+There are default decoders for `:yaml` and `:json`, however you are free to override them or create your own types.
+
+```ruby
+# config.rb
+activate :data_source do |c|
+
+  c.files = ['by_extension.ctype']
+
+  c.sources = [
+    {
+      alias: "foo_bar",
+      path: "/foo/bar.ctype",
+      type: :my_type
+    }
+  ]
+
+  c.decoders = {
+    my_type: {
+      extensions: ['.ctype'],
+      decoder: ->(src) { CustomType.parse(src) }
+    }
+  }
+```
+
+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`.
 
 # Testing
 

data/spec/fixtures/base/config.rb

@@ -9,13 +9,34 @@ activate :data_source do |c|
                  run lambda {|env| [404, {'Content-type' => 'text/plain'}, ['Not found']] }
               end
 
+  c.sources = [
+    {
+      alias: "foo",
+      path: "foo.bar",
+      type: :yaml
+    },
+    {
+      alias: "my_decoder",
+      path: "w/e",
+      type: :my_decoder
+    }
+  ]
+
+  c.decoders = {
+    my_decoder: {
+      extensions: ['.ctype'],
+      decoder: ->(data) { ["grass","is","greener"] }
+    }
+  }
+
   c.files = [
     'remote.json',
     'deeply/nested.json',
     'deeply/nested/routes.json',
     'in_yaml.yml',
     'in_json.json',
-    'query_param.json?token=foo'
+    'query_param.json?token=foo',
+    'run_through_my_decoder.ctype'
   ]
 
 end

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

@@ -42,6 +42,18 @@ describe Middleman::DataSource::Extension do
     end
 
     it_behaves_like "data import"
+
+    it "allows assignment of sources w/ given type" do
+      expect( @mm.data.foo ).to eq ["one","two","three"]
+    end
+
+    it "allows assignment of custom data decoders" do
+      expect( @mm.data.my_decoder ).to eq ["grass","is","greener"]
+    end
+
+    it "sets custom decoders based on file extensions" do
+      expect( @mm.data.run_through_my_decoder ).to eq ["grass","is","greener"]
+    end
   end
 
   context "with unsupported_extension" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-data_source
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Steven Sloan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-29 00:00:00.000000000 Z
+date: 2015-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman