named-routes 0.1.2 → 0.2.1

data/Gemfile

@@ -0,0 +1,7 @@
+source :gemcutter
+
+gem "extlib", "0.9.15"
+gem "diff-lcs", "1.1.2"
+gem "jeweler", "1.5.2"
+gem "rr", "1.0.2"
+gem "rspec", "2.3.0"

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    extlib (0.9.15)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rr (1.0.2)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  diff-lcs (= 1.1.2)
+  extlib (= 0.9.15)
+  jeweler (= 1.5.2)
+  rr (= 1.0.2)
+  rspec (= 2.3.0)

data/README.md

@@ -58,7 +58,7 @@ You can access the routes by doing the following.
     path(:user, "/users/:user_id")
     paths.user(:user_id => 42) # => "/users/42"
     paths.http.user(:user_id => 42) # => "http://example.com/users/42"
-    paths.https.user(:user_id => 42) # => "http://example.com/users/42"
+    paths.https.user(:user_id => 42) # => "https://example.com/users/42"
 
 It also works with prefixes:
 
@@ -68,7 +68,7 @@ It also works with prefixes:
     path(:user, "/users/:user_id")
     paths.user(:user_id => 42) # => "/users/42"
     paths.http.user(:user_id => 42) # => "http://example.com/admin/users/42"
-    paths.https.user(:user_id => 42) # => "http://example.com/admin/users/42"
+    paths.https.user(:user_id => 42) # => "https://example.com/admin/users/42"
 
 And with query params:
 

data/Rakefile

@@ -22,7 +22,7 @@ begin
     s.has_rdoc = true
     s.extra_rdoc_files = [ "README.md", "CHANGES" ]
     s.rdoc_options = ["--main", "README.md", "--inline-source", "--line-numbers"]
-    s.add_dependency "activesupport", ">= 2.3"
+    s.add_dependency "extlib", ">= 0.9.15"
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.1

data/lib/named-routes/routes.rb

@@ -1,32 +1,46 @@
 module NamedRoutes
   class Routes
     class_inheritable_accessor :host, :prefix
-
+    
     extend(Module.new do
       def instance
         @instance ||= new
       end
 
       def http
-        Uri.new(self, "http")
+        SchemedUri.new(self, "http")
       end
 
       def https
-        Uri.new(self, "https")
+        SchemedUri.new(self, "https")
       end
 
-      def path(name, definition, include_prefix=true)
+      def route(name, definition, include_prefix=true)
         full_definition = (include_prefix && prefix) ? File.join("", prefix, definition) : definition
+        _defined_routes[name.to_s] = full_definition
         define_method name do |*args|
           self.class.eval(full_definition, [args.first].compact.first || {})
         end
         yield full_definition if block_given?
         full_definition
       end
+      alias_method :path, :route
+      alias_method :uri, :route
+
+      def defined_routes
+        (ancestors.reverse + [self]).inject({}) do |memo, klass|
+          memo.merge!(klass._defined_routes) if klass.respond_to?(:_defined_routes)
+          memo
+        end
+      end
+
+      def _defined_routes
+        @_defined_routes ||= {}
+      end
 
       def eval(definition, params_arg={})
         params = Mash.new(params_arg)
-        path_string = if params.empty?
+        uri_string = if params.empty?
           definition
         else
           definition.split("/").map do |segment|
@@ -42,28 +56,29 @@ module NamedRoutes
           end.join("/")
         end
         unless params.empty?
-          path_string << "?#{escape_params(params).to_params.gsub("%20", "+")}"
+          uri_string << "?#{escape_params(params).to_params.gsub("%20", "+")}"
         end
-        path_string
+        uri_string
       end
 
       # TODO: Create eval_without_prefix
 
       def escape_params(params={})
         params.inject({}) do |memo, kv|
-          memo[URI.escape(kv[0])] = if kv[1].is_a?(Hash)
-            escape_params(kv[1])
-          elsif kv[1].is_a?(Array)
-            kv[1].map { |v| URI.escape(v.to_s) }
+          key, value = kv
+          memo[URI.escape(key)] = if value.is_a?(Hash)
+            escape_params(value)
+          elsif value.is_a?(Array)
+            value.map { |v| URI.escape(v.to_s) }
           else
-            URI.escape(kv[1].to_s)
+            URI.escape(value.to_s)
           end
           memo
         end
       end
 
-      def normalize(path)
-        path.gsub(Regexp.new("^#{File.join("", prefix.to_s)}"), "/").gsub("//", "/")
+      def normalize(uri)
+        uri.gsub(Regexp.new("^#{File.join("", prefix.to_s)}"), "/").gsub("//", "/")
       end
 
       def method_missing(method_name, *args, &block)
@@ -74,5 +89,9 @@ module NamedRoutes
         end
       end
     end)
+
+    def as_json(*args)
+      self.class.defined_routes
+    end
   end
 end

data/lib/named-routes/{uri.rb → schemed_uri.rb}

@@ -1,5 +1,5 @@
 module NamedRoutes
-  class Uri
+  class SchemedUri
     attr_reader :routes, :scheme
 
     def initialize(routes, scheme)

data/lib/named-routes.rb

@@ -2,18 +2,23 @@ require "extlib"
 require "uri"
 
 module NamedRoutes
-  def path(*args, &block)
-    routes.path(*args, &block)
+  def named_route(*args, &block)
+    named_routes.uri(*args, &block)
   end
+  alias_method :path, :named_route
+  alias_method :route, :named_route
+  alias_method :uri, :named_route
 
-  def paths
+  def named_routes
     ::NamedRoutes::Routes
   end
-  alias_method :routes, :paths
+  alias_method :paths, :named_routes
+  alias_method :routes, :named_routes
+  alias_method :uris, :named_routes
 
   extend self
 end
 
 dir = File.dirname(__FILE__)
 require "#{dir}/named-routes/routes"
-require "#{dir}/named-routes/uri"
+require "#{dir}/named-routes/schemed_uri"

data/spec/named-routes/routes_spec.rb

@@ -8,17 +8,17 @@ module NamedRoutes
 
     def routes
       @routes ||= begin
-        paths_class = Class.new(NamedRoutes::Routes)
-        paths_class.path(:root, "/")
-        paths_class.path(:current_user_category_top_choices, "/current-user/:category/top-choices")
-        paths_class.path(:decision_stream, "/decision-streams/:stream_id")
-        paths_class
+        routes_class = Class.new(NamedRoutes::Routes)
+        routes_class.route(:root, "/")
+        routes_class.route(:current_user_category_top_choices, "/current-user/:category/top-choices")
+        routes_class.route(:decision_stream, "/decision-streams/:stream_id")
+        routes_class
       end
     end
 
-    describe "path definition" do
+    describe "uri definition" do
       context "when params hash is not given" do
-        it "returns the definition", :focus => true do
+        it "returns the definition" do
           routes.root.should == "/"
           routes.current_user_category_top_choices.should == "/current-user/:category/top-choices"
           routes.decision_stream.should == "/decision-streams/:stream_id"
@@ -26,10 +26,10 @@ module NamedRoutes
       end
 
       context "when params hash is given" do
-        it "returns the path with the param replaced with the given param value with additional params added as url params" do
-          uri_1 = routes.current_user_category_top_choices(:category => "cars", :foo => "bar", :baz => {"one" => "two three"})
+        it "returns the uri with the param replaced with the given param value with additional params added as url params" do
+          schemed_uri_1 = routes.current_user_category_top_choices(:category => "cars", :foo => "bar", :baz => {"one" => "two three"})
 
-          path, query = uri_1.split("?")
+          path, query = schemed_uri_1.split("?")
           path.should == "/current-user/cars/top-choices"
           query.should include("foo=bar")
           query.should include("baz[one]=two+three")
@@ -40,17 +40,17 @@ module NamedRoutes
       context "when a prefix is given" do
         def routes
           @routes ||= begin
-            paths_class = Class.new(NamedRoutes::Routes)
-            paths_class.prefix = "general"
-            paths_class.path(:root, "/")
-            paths_class.path(:current_user_category_top_choices, "/current-user/:category/top-choices")
-            paths_class.path(:decision_stream, "/decision-streams/:stream_id")
-            paths_class
+            routes_class = Class.new(NamedRoutes::Routes)
+            routes_class.prefix = "general"
+            routes_class.route(:root, "/")
+            routes_class.route(:current_user_category_top_choices, "/current-user/:category/top-choices")
+            routes_class.route(:decision_stream, "/decision-streams/:stream_id")
+            routes_class
           end
         end
 
         context "when default and include_prefix argument is true" do
-          it "appends the prefix to the returned paths" do
+          it "appends the prefix to the returned uris" do
             routes.root.should == "/general/"
             routes.current_user_category_top_choices.should == "/general/current-user/:category/top-choices"
             routes.decision_stream.should == "/general/decision-streams/:stream_id"
@@ -59,9 +59,9 @@ module NamedRoutes
           end
         end
 
-        context "when include_prefix argument is false in the path definition" do
-          it "does not append the prefix to the returned paths" do
-            routes.path(:raw_path, "/raw/path", false).should == "/raw/path"
+        context "when include_prefix argument is false in the uri definition" do
+          it "does not append the prefix to the returned uris" do
+            routes.uri(:raw_path, "/raw/path", false).should == "/raw/path"
             routes.raw_path.should == "/raw/path"
           end
         end
@@ -76,10 +76,10 @@ module NamedRoutes
       end
 
       context "when params hash is given" do
-        it "returns the path with the param replaced with the given param value with additional params added as url params" do
-          uri_1 = routes.current_user_category_top_choices(:category => "cars", :foo => "bar", :baz => {"one" => "two three"})
+        it "returns the uri with the param replaced with the given param value with additional params added as url params" do
+          schemed_uri_1 = routes.current_user_category_top_choices(:category => "cars", :foo => "bar", :baz => {"one" => "two three"})
 
-          path, query = uri_1.split("?")
+          path, query = schemed_uri_1.split("?")
           path.should == "/current-user/cars/top-choices"
           query.should include("foo=bar")
           query.should include("baz[one]=two+three")
@@ -88,11 +88,23 @@ module NamedRoutes
       end
     end
 
+    describe ".http" do
+      it "returns a full http schemed_uri (with ::NamedRoutes.host) for the given named route" do
+        routes.http.decision_stream(:stream_id => "11").should == "http://example.com/decision-streams/11"
+      end
+    end
+
+    describe ".https" do
+      it "returns a full https schemed_uri (with ::NamedRoutes.host) for the given named route" do
+        routes.https.decision_stream(:stream_id => "11").should == "https://example.com/decision-streams/11"
+      end
+    end
+
     describe "#normalize" do
       def routes
         @routes ||= begin
-          path_class = Class.new(NamedRoutes::Routes)
-          path_class
+          route_class = Class.new(NamedRoutes::Routes)
+          route_class
         end
       end
 
@@ -101,7 +113,7 @@ module NamedRoutes
           routes.prefix.should == nil
         end
 
-        it "returns the given path" do
+        it "returns the given uri" do
           routes.normalize("/prefix/foo/bar").should == "/prefix/foo/bar"
         end
       end
@@ -131,15 +143,13 @@ module NamedRoutes
       end
     end
 
-    describe ".http" do
-      it "returns a full http uri (with ::NamedRoutes.host) for the given named route" do
-        routes.http.decision_stream(:stream_id => "11").should == "http://example.com/decision-streams/11"
-      end
-    end
-
-    describe ".https" do
-      it "returns a full https uri (with ::NamedRoutes.host) for the given named route" do
-        routes.https.decision_stream(:stream_id => "11").should == "https://example.com/decision-streams/11"
+    describe "#as_json" do
+      it "returns a hash of all of the route methods as keys and the definions as values" do
+        routes.as_json.should == {
+          "root" => "/",
+          "current_user_category_top_choices" => "/current-user/:category/top-choices",
+          "decision_stream" => "/decision-streams/:stream_id"
+        }
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,4 +1,6 @@
 require "rubygems"
+require "bundler"
+Bundler.setup
 
 $LOAD_PATH.unshift(File.expand_path("#{File.dirname(__FILE__)}/../lib"))
 require "named-routes"
@@ -13,5 +15,6 @@ require 'rr'
 
 RSpec.configure do |c|
   c.mock_with :rr
-#  c.filter_run :focus => true
+  c.filter_run :focus => true
+  c.run_all_when_everything_filtered = true
 end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: named-routes
 version: !ruby/object:Gem::Version 
-  hash: 31
   prerelease: false
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Brian Takita
@@ -15,24 +14,99 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-20 00:00:00 -07:00
+date: 2010-12-28 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activesupport
+  name: extlib
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 15
+        version: 0.9.15
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: diff-lcs
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 2
+        version: 1.1.2
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 2
+        version: 1.0.2
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 5
         segments: 
         - 2
         - 3
-        version: "2.3"
+        - 0
+        version: 2.3.0
   type: :runtime
-  version_requirements: *id001
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: extlib
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 15
+        version: 0.9.15
+  type: :runtime
+  version_requirements: *id006
 description: 
 email: brian.takita@gmail.com
 executables: []
@@ -44,13 +118,15 @@ extra_rdoc_files:
 - README.md
 files: 
 - CHANGES
+- Gemfile
+- Gemfile.lock
 - MIT.LICENSE
 - README.md
 - Rakefile
 - VERSION
 - lib/named-routes.rb
 - lib/named-routes/routes.rb
-- lib/named-routes/uri.rb
+- lib/named-routes/schemed_uri.rb
 - spec/named-routes/routes_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -70,7 +146,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -79,7 +154,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"