path-to 0.0.4 → 0.0.5

data/Manifest.txt

@@ -6,13 +6,16 @@ README.rdoc
 Rakefile
 lib/path-to.rb
 lib/path-to/application.rb
+lib/path-to/described_routes.rb
 lib/path-to/http_client.rb
 lib/path-to/path.rb
 lib/path-to/with_params.rb
 script/console
 script/destroy
 script/generate
+test/path-to/fixtures/described_routes_test.json
 test/path-to/test_application.rb
+test/path-to/test_described_routes.rb
 test/path-to/test_path.rb
 test/path-to/test_with_params.rb
 test/test_helper.rb

data/lib/path-to/described_routes.rb

@@ -0,0 +1,107 @@
+require "path-to"
+require "described_routes"
+
+module PathTo
+  module DescribedRoutes
+    class TemplatedPath < WithParams
+      attr_reader :resource_template
+      
+      def initialize(parent, service, params, resource_template)
+        super(parent, service, params)
+        @resource_template = resource_template
+        
+        missing_params = resource_template.params - params.keys
+        unless missing_params.empty?
+          raise ArgumentError.new(
+                  "Missing params #{missing_params.join(', ')} " + 
+                  "(template #{resource_template.name.inspect}," +
+                  " path_template #{resource_template.path_template.inspect}," +
+                  " params #{params.inspect})")
+          end
+      end
+      
+      def uri_template
+        @uri_template ||= application.base + resource_template.path_template
+      end
+      
+      def uri
+        @uri ||= begin
+          string_keyed_params = params.keys.inject({}){|hash, key| hash[key.to_s] = params[key]; hash}
+          Addressable::URI.expand_template(uri_template, string_keyed_params).to_s
+        end
+      end
+      
+      #
+      # Finds (once) the application in the parent hierarchy.
+      #
+      def application
+        @application ||= parent.application if parent
+      end
+    end
+    
+    class Application < WithParams
+      # An Array of DescribedRoutes::Resource objects
+      attr_reader :resources
+
+      # A Class (or at least something with a #new method) from which child objects will be created
+      attr_reader :default_type
+
+      # An HTTParty or similar
+      attr_reader :http_client
+      
+      attr_reader :base
+      
+      def initialize(resources, base, params = {}, default_type = TemplatedPath, http_client = HTTPClient)
+        @base, @resources, @default_type, @http_client = base, resources, default_type, http_client
+        super(nil, nil, params)
+      end
+      
+      #
+      # Tries to respond to a missing method.  We can do so if
+      #
+      # 1. we have a resource template matching the method name
+      # 2. #child_class_for returns a class or other factory object capable of creating a new child instance
+      #
+      # Otherwise we invoke super in the hope of avoiding any hard-to-debug behaviour!
+      #
+      def method_missing(method, *args)
+        resource_template = resource_templates_by_name[method.to_s]
+        if resource_template && (child_class = child_class_for(self, method, params, resource_template))
+          params = args.inject(Hash.new){|h, arg| h.merge(arg)}
+          child(child_class, method, params, resource_template)
+        else
+          super
+        end
+      end
+
+      #
+      # Determines whether this application &/or its child objects should respond to the given method, and if so returns a class from
+      # which a new child instance (typically Path or a subclass thereof) will be created.  This implementation (easily overridden)
+      # returns #default_type if there is a URI template defined for the method.
+      #
+      # Parameters:
+      #
+      # [instance] This application or (presumably) one of its child objects
+      # [method]   The method invoked on the instance that has (presumably) been intercepted by instance#method_missing
+      # [params]   The instance's params
+      # 
+      def child_class_for(instance, method, params, template)
+        default_type
+      end
+      
+      #
+      # Returns a hash of all ResourceTemplates (the tree flattened) keyed by name
+      #
+      def resource_templates_by_name
+        @resource_templates_by_name ||= ::DescribedRoutes.all_by_name(resources)
+      end
+
+      #
+      # Returns self.  See TemplatedPath#application.
+      #
+      def application
+        self
+      end
+    end
+  end
+end

data/lib/path-to.rb

@@ -1,5 +1,5 @@
 module PathTo
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end
 
 $:.push File.dirname(__FILE__)

data/test/path-to/fixtures/described_routes_test.json

@@ -0,0 +1 @@
+[{"name":"root","path_template":"\/"},{"name":"admin_products","resource_templates":[{"name":"admin_product","resource_templates":[{"name":"edit_admin_product","options":["GET"],"path_template":"\/admin\/products\/{product_id}\/edit{-prefix|.|format}","rel":"edit","optional_params":["format"],"params":["product_id"]}],"options":["GET","PUT","DELETE"],"path_template":"\/admin\/products\/{product_id}{-prefix|.|format}","optional_params":["format"],"params":["product_id"]},{"name":"new_admin_product","options":["GET"],"path_template":"\/admin\/products\/new{-prefix|.|format}","optional_params":["format"]}],"options":["GET","POST"],"path_template":"\/admin\/products{-prefix|.|format}","optional_params":["format"]},{"name":"pages","resource_templates":[{"name":"page","resource_templates":[{"name":"edit_page","options":["GET"],"path_template":"\/pages\/{page_id}\/edit{-prefix|.|format}","rel":"edit","optional_params":["format"],"params":["page_id"]},{"name":"summary_page","options":["GET"],"path_template":"\/pages\/{page_id}\/summary{-prefix|.|format}","rel":"summary","optional_params":["format"],"params":["page_id"]},{"name":"toggle_visibility_page","options":["POST"],"path_template":"\/pages\/{page_id}\/toggle_visibility{-prefix|.|format}","rel":"toggle_visibility","optional_params":["format"],"params":["page_id"]}],"options":["GET","PUT","DELETE"],"path_template":"\/pages\/{page_id}{-prefix|.|format}","optional_params":["format"],"params":["page_id"]},{"name":"new_page","options":["GET"],"path_template":"\/pages\/new{-prefix|.|format}","optional_params":["format"]}],"options":["GET","POST"],"path_template":"\/pages{-prefix|.|format}","optional_params":["format"]},{"name":"users","resource_templates":[{"name":"user","resource_templates":[{"name":"user_articles","resource_templates":[{"name":"user_article","resource_templates":[{"name":"edit_user_article","options":["GET"],"path_template":"\/users\/{user_id}\/articles\/{article_id}\/edit{-prefix|.|format}","rel":"edit","optional_params":["format"],"params":["user_id","article_id"]}],"options":["GET","PUT","DELETE"],"path_template":"\/users\/{user_id}\/articles\/{article_id}{-prefix|.|format}","optional_params":["format"],"params":["user_id","article_id"]},{"name":"new_user_article","options":["GET"],"path_template":"\/users\/{user_id}\/articles\/new{-prefix|.|format}","optional_params":["format"],"params":["user_id"]},{"name":"recent_user_articles","options":["GET"],"path_template":"\/users\/{user_id}\/articles\/recent{-prefix|.|format}","rel":"recent","optional_params":["format"],"params":["user_id"]}],"options":["GET","POST"],"path_template":"\/users\/{user_id}\/articles{-prefix|.|format}","rel":"articles","optional_params":["format"],"params":["user_id"]},{"name":"edit_user","options":["GET"],"path_template":"\/users\/{user_id}\/edit{-prefix|.|format}","rel":"edit","optional_params":["format"],"params":["user_id"]},{"name":"user_profile","resource_templates":[{"name":"edit_user_profile","options":["GET"],"path_template":"\/users\/{user_id}\/profile\/edit{-prefix|.|format}","rel":"edit","optional_params":["format"],"params":["user_id"]},{"name":"new_user_profile","options":["GET"],"path_template":"\/users\/{user_id}\/profile\/new{-prefix|.|format}","rel":"new","optional_params":["format"],"params":["user_id"]}],"options":["GET","PUT","DELETE","POST"],"path_template":"\/users\/{user_id}\/profile{-prefix|.|format}","rel":"profile","optional_params":["format"],"params":["user_id"]}],"options":["GET","PUT","DELETE"],"path_template":"\/users\/{user_id}{-prefix|.|format}","optional_params":["format"],"params":["user_id"]},{"name":"new_user","options":["GET"],"path_template":"\/users\/new{-prefix|.|format}","optional_params":["format"]}],"options":["GET","POST"],"path_template":"\/users{-prefix|.|format}","optional_params":["format"]}]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: path-to
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Mike Burrows (asplake)
@@ -73,13 +73,16 @@ files:
 - Rakefile
 - lib/path-to.rb
 - lib/path-to/application.rb
+- lib/path-to/described_routes.rb
 - lib/path-to/http_client.rb
 - lib/path-to/path.rb
 - lib/path-to/with_params.rb
 - script/console
 - script/destroy
 - script/generate
+- test/path-to/fixtures/described_routes_test.json
 - test/path-to/test_application.rb
+- test/path-to/test_described_routes.rb
 - test/path-to/test_path.rb
 - test/path-to/test_with_params.rb
 - test/test_helper.rb