named-routes 0.1.0

data/MIT.LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Brian Takita
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,111 @@
+# NamedRoutes
+
+A simple and generic named routes api. It works really well with Sinatra.
+
+## Installation/Usage
+
+    gem install named-routes
+
+## Route Definitions
+
+You can define a named route by providing the name of the method and the definition.
+
+    NamedRoutes.path(:user, "/users/:user_id") # => "/users/:user_id"
+
+You can use this in conjunction with Sinatra routes like so:
+
+    include NamedRoutes
+    get path(:user, "/users/:user_id") do
+      # ...
+    end
+
+If you have multiple handlers for the same route, you can use the block syntax:
+
+    include NamedRoutes
+    path(:user, "/users/:user_id") do |_|
+      get _ do
+        # ...
+      end
+
+      post _ do
+        # ...
+      end
+    end
+
+You can also define prefixes on the route definitions:
+
+    include NamedRoutes
+    routes.prefix = "admin"
+
+    path(:user, "/users/:user_id") do |_| # => /admin/users/:user_id
+      get _ do
+        # ...
+      end
+
+      post _ do
+        # ...
+      end
+    end
+
+## Route Helpers
+
+You can access the routes by doing the following.
+
+    include NamedRoutes
+    routes.host = "example.com"
+    path(:user, "/users/:user_id")
+    routes.user(:user_id => 42) # => "/users/42"
+    routes.http.user(:user_id => 42) # => "http://example.com/users/42"
+    routes.https.user(:user_id => 42) # => "http://example.com/users/42"
+
+It also works with prefixes:
+
+    include NamedRoutes
+    routes.host = "example.com"
+    routes.prefix = "admin"
+    path(:user, "/users/:user_id")
+    routes.user(:user_id => 42) # => "/users/42"
+    routes.http.user(:user_id => 42) # => "http://example.com/admin/users/42"
+    routes.https.user(:user_id => 42) # => "http://example.com/admin/users/42"
+
+And with query params:
+
+    include NamedRoutes
+    routes.host = "example.com"
+    routes.prefix = "admin"
+    path(:user, "/users/:user_id")
+    routes.user(:user_id => 42, :foo => "bar of soap") # => "/users/42&foo=bar+of+soap"
+
+## Advanced Usages
+
+You can also inherit Routes to have different sets of Routes. This is useful if you want route sets with different prefixes.
+
+    class AdminRoutes < NamedRoutes::Routes
+      self.prefix = "admin"
+    end
+
+    class PartayRoutes < NamedRoutes::Routes
+      self.prefix = "partay"
+    end
+
+    def admin_routes
+      AdminRoutes
+    end
+
+    def partay_routes
+      PartayRoutes
+    end
+
+    get admin_routes.path(:user, "/users/:user_id") do # => /admin/users/:user_id
+      # ...
+    end
+
+    admin_routes.user(:user_id => 42) # => "/admin/users/42"
+
+    get partay_routes.path(:user, "/users/:user_id") do # => /partay/users/:user_id
+      # ...
+    end
+
+    partay_routes.user(:user_id => 42, :beer => "pabst") # => "/partay/users/42&beer=pabst"
+
+Copyright (c) 2010 Brian Takita. This software is licensed under the MIT License.

data/Rakefile

@@ -0,0 +1,28 @@
+require "rake"
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "named-routes"
+    s.summary = "A simple and generic named routes api. It works really well with Sinatra."
+    s.email = "brian.takita@gmail.com"
+    s.homepage = "http://github.com/btakita/named-routes"
+    s.summary = "A simple and generic named routes api. It works really well with Sinatra."
+    s.authors = ["Brian Takita"]
+    s.files = FileList[
+      '[A-Z]*',
+      '*.rb',
+      'lib/**/*.rb',
+      'spec/**/*.rb'
+    ].to_a
+    s.test_files = Dir.glob('spec/*_spec.rb')
+    s.has_rdoc = true
+    s.extra_rdoc_files = [ "README.md", "CHANGES" ]
+    s.rdoc_options = ["--main", "README.md", "--inline-source", "--line-numbers"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/named-routes/routes.rb

@@ -0,0 +1,78 @@
+module NamedRoutes
+  class Routes
+    class_inheritable_accessor :host, :prefix
+
+    extend(Module.new do
+      def instance
+        @instance ||= new
+      end
+
+      def http
+        Uri.new(self, "http")
+      end
+
+      def https
+        Uri.new(self, "https")
+      end
+
+      def path(name, definition, include_prefix=true)
+        full_definition = (include_prefix && prefix) ? File.join("", prefix, definition) : 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
+
+      def eval(definition, params_arg={})
+        params = ActiveSupport::HashWithIndifferentAccess.new(params_arg)
+        path_string = if params.empty?
+          definition
+        else
+          definition.split("/").map do |segment|
+            segment_value = segment[/^:(.*)/, 1]
+            segment_value_parts = segment_value.to_s.split(".")
+            segment_name = segment_value_parts[0]
+            if segment_name
+              param_name = params.delete(File.basename(segment_name, '.*').to_s)
+              URI.escape([param_name, *segment_value_parts[1..-1]].join("."))
+            else
+              segment
+            end
+          end.join("/")
+        end
+        unless params.empty?
+          path_string << "?#{params.to_param}"
+        end
+        path_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) }
+          else
+            URI.escape(kv[1].to_s)
+          end
+          memo
+        end
+      end
+
+      def normalize(path)
+        path.gsub(Regexp.new("^#{File.join("", prefix.to_s)}"), "/").gsub("//", "/")
+      end
+
+      def method_missing(method_name, *args, &block)
+        if instance.respond_to?(method_name)
+          instance.send(method_name, *args, &block)
+        else
+          super
+        end
+      end
+    end)
+  end
+end

data/lib/named-routes/uri.rb

@@ -0,0 +1,13 @@
+module NamedRoutes
+  class Uri
+    attr_reader :routes, :scheme
+
+    def initialize(routes, scheme)
+      @routes, @scheme = routes, scheme
+    end
+
+    def method_missing(method_name, *args, &block)
+      "#{scheme}://#{routes.host}#{routes.send(method_name, *args, &block)}"
+    end
+  end
+end

data/lib/named-routes.rb

@@ -0,0 +1,20 @@
+require "active_support"
+require "active_support/hash_with_indifferent_access"
+require "active_support/core_ext"
+require "active_support/core_ext"
+require "uri"
+
+module NamedRoutes
+  def path(*args, &block)
+    routes.path(*args, &block)
+  end
+
+  def routes
+    ::NamedRoutes::Routes
+  end
+  extend self
+end
+
+dir = File.dirname(__FILE__)
+require "#{dir}/named-routes/routes"
+require "#{dir}/named-routes/uri"

data/spec/named-routes/routes_spec.rb

@@ -0,0 +1,146 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../spec_helper")
+
+module NamedRoutes
+  describe Routes do
+    before do
+      NamedRoutes.routes.host = "example.com"
+    end
+
+    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
+      end
+    end
+
+    describe "path definition" do
+      context "when params hash is not given" do
+        it "returns the definition", :focus => true do
+          routes.root.should == "/"
+          routes.current_user_category_top_choices.should == "/current-user/:category/top-choices"
+          routes.decision_stream.should == "/decision-streams/:stream_id"
+        end
+      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"})
+
+          path, query = uri_1.split("?")
+          path.should == "/current-user/cars/top-choices"
+          query.should include("foo=bar")
+          query.should include("baz[one]=two+three")
+          routes.decision_stream(:stream_id => 99).should == "/decision-streams/99"
+        end
+      end
+
+      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
+          end
+        end
+
+        context "when default and include_prefix argument is true" do
+          it "appends the prefix to the returned paths" 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"
+            routes.current_user_category_top_choices(:category => "cars").should == "/general/current-user/cars/top-choices"
+            routes.decision_stream(:stream_id => 99).should == "/general/decision-streams/99"
+          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"
+            routes.raw_path.should == "/raw/path"
+          end
+        end
+      end
+    end
+
+    describe ".eval" do
+      context "when params hash is not given" do
+        it "returns the definition" do
+          routes.eval("/current-user/:category/top-choices").should == "/current-user/:category/top-choices"
+        end
+      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"})
+
+          path, query = uri_1.split("?")
+          path.should == "/current-user/cars/top-choices"
+          query.should include("foo=bar")
+          query.should include("baz[one]=two+three")
+          routes.eval("/decision-streams/:stream_id", :stream_id => 99).should == "/decision-streams/99"
+        end
+      end
+    end
+
+    describe "#normalize" do
+      def routes
+        @routes ||= begin
+          path_class = Class.new(NamedRoutes::Routes)
+          path_class
+        end
+      end
+
+      context "when there is no prefix" do
+        before do
+          routes.prefix.should_not be_present
+        end
+
+        it "returns the given path" do
+          routes.normalize("/prefix/foo/bar").should == "/prefix/foo/bar"
+        end
+      end
+
+      context "when there is a prefix" do
+        context "when the prefix begins with a /" do
+          before do
+            routes.prefix = "/prefix"
+          end
+
+          it "strips out the prefix from the beginning" do
+            routes.normalize("/prefix/foo/bar").should == "/foo/bar"
+            routes.normalize("/prefix/foo/prefix/bar").should == "/foo/prefix/bar"
+          end
+        end
+
+        context "when the prefix does not begin with a /" do
+          before do
+            routes.prefix = "prefix"
+          end
+
+          it "strips out the prefix from the beginning" do
+            routes.normalize("/prefix/foo/bar").should == "/foo/bar"
+            routes.normalize("/prefix/foo/prefix/bar").should == "/foo/prefix/bar"
+          end
+        end
+      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"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require "rubygems"
+
+$LOAD_PATH.unshift(File.expand_path("#{File.dirname(__FILE__)}/../lib"))
+require "named-routes"
+require "rspec"
+
+ARGV.push("-b")
+unless ARGV.include?("--format") || ARGV.include?("-f")
+  ARGV.push("--format", "nested")
+end
+
+require 'rr'
+
+RSpec.configure do |c|
+  c.mock_with :rr
+#  c.filter_run :focus => true
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: named-routes
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Brian Takita
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-20 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: brian.takita@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGES
+- README.md
+files: 
+- CHANGES
+- MIT.LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/named-routes.rb
+- lib/named-routes/routes.rb
+- lib/named-routes/uri.rb
+- spec/named-routes/routes_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/btakita/named-routes
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.md
+- --inline-source
+- --line-numbers
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A simple and generic named routes api. It works really well with Sinatra.
+test_files: []
+