sinatra_more 0.3.13 → 0.3.14

data/README.rdoc

@@ -49,6 +49,7 @@ Here is a small list of what sinatra_more contains:
 * Generic view and tag helpers (<tt>tag</tt>, <tt>content_tag</tt>, <tt>input_tag</tt>, ...)
 * Asset tag helpers (<tt>link_to</tt>, <tt>image_tag</tt>, <tt>javascript_include_tag</tt>, ...)
 * Full form helpers and builders support (<tt>form_tag</tt>, <tt>form_for</tt>, <tt>field_set_tag</tt>, <tt>text_field</tt>, ...)
+* Full url named route support to avoid hardcoding url paths in sinatra (<tt>map</tt>, <tt>url_for</tt>)
 * Generally useful formatting extensions (<tt>relative_time_ago</tt>, <tt>js_escape_html</tt>, <tt>sanitize_html</tt>)
 * Simple 'mailer' support for sinatra (akin to <tt>ActionMailer</tt> but simpler and powered by <tt>pony</tt>)
 * Plug and play setup for the excellent Warden authentication system
@@ -81,6 +82,7 @@ different components based on which pieces are useful for your particular applic
     register SinatraMore::RenderPlugin
     register SinatraMore::WardenPlugin
     register SinatraMore::MailerPlugin
+    register SinatraMore::RoutingPlugin
   end
 
 This will then allow you to use the components that have been registered. A breakdown of components is below:
@@ -577,6 +579,84 @@ or perhaps we want to have a short body without the need for a template file:
   end
 
 See the wiki article for additional information: <http://wiki.github.com/nesquena/sinatra_more/mailerplugin>
+
+== RoutingPlugin
+
+This component provides Sinatra with an enhanced url routing system which enables named route aliases to be defined
+and used throughout your application to refer to urls. The benefits of this is that instead of having to hard-code route urls
+into every area of your application, now we can just define the urls in a single spot and then attach an alias
+which can be used to refer to the url throughout the rest. 
+
+Let's take a look at how to define named route mappings:
+
+  # /app/routes/example.rb
+  require 'sinatra_more'
+  
+  class RoutingDemo < Sinatra::Application
+    register SinatraMore::RoutingPlugin  
+    
+    # Define the named route mappings
+    map(:account).to("/the/accounts/:name/and/:id")
+    map(:accounts).to("/the/accounts/index")
+    
+    # Configure the routes using the named alias
+    get(:account)  { "name: params[:name] - id: params[:id]" }    
+    get(:accounts) { "I am the body for the url /the/accounts/index" }
+  end
+
+Notice we simply create a route alias using the <tt>map</tt> function and then pass in the corresponding url into the <tt>to</tt> method.
+You can then define the routes using the named symbol representing the url. The route aliases can be accessed using <tt>url_for</tt>
+
+  url_for(:accounts)
+  url_for(:account, :id => 1, :name => 'first')
+
+You can also refer to the url in views using <tt>url_for</tt>
+
+  # /app/views/index.erb
+  <p>Go to the <%= link_to 'accounts dashboard', url_for(:accounts) %> to view your accounts</p>
+  <p>Go to account for <%= link_to 'first account', url_for(:account, :id => 1, :name => 'first') %>
+
+Simply invoking <tt>url_for(name, *parameters)</tt> will return the full mapped url for use in links or anywhere else
+that the url might be required.
+
+The routing system also supports url route configuration namespaces:
+
+  # /app/routes/example.rb
+  map(:admin, :show).to("/admin/:id/show")
+  
+  namespace :admin do
+    get :show do
+      "admin show for #{params[:id]}"
+    end
+  end
+  
+You could also define the route aliases themselves using a namespace for convenience:
+
+  # /app/routes/example.rb
+  map :admin do |namespace|
+    namespace.map(:show).to("/admin/:id/show")
+    namespace.map(:destroy).to("/admin/:id/destroy")
+  end
+  
+  namespace :admin do
+    get :show do
+      "admin show for #{params[:id]}"
+    end
+    
+    get :destroy do
+      "admin destroy for #{params[:id]}"
+    end
+  end
+
+You can then reference the urls using the same <tt>url_for</tt> method:
+
+  <%= link_to 'admin page', url_for(:admin, :show, :id => 25) %>
+  <%= link_to 'admin page', url_for(:admin, :update, :id => 25) %>
+  <%= link_to 'admin page', url_for(:admin, :show, :id => 25) %>
+  
+You can freely use both named route aliases and traditional Sinatra routes in the same application without conflict.
+
+See the wiki article for additional information: <http://wiki.github.com/nesquena/sinatra_more/routingplugin>
   
 == Sinatra Generators
 
@@ -642,6 +722,7 @@ See the wiki article for additional information: <http://wiki.github.com/nesquen
 * Thanks to sbfaulkner for the <tt>sinatra-helpers</tt> code that I browsed through many times while starting this library.
 * Thanks to vestel for the excellent modified <tt>pony</tt> fork which in part powers the mailer_plugin (http://github.com/vestel/pony)
 * Thanks to focat and sinatra-content-for library (http://github.com/focat/sinatra-content-for) for a good content_for starting point
+* Thanks to bcarlso for the snap sinatra library (http://github.com/bcarlso/snap) which was a starting point for named routes
 * Thanks to wycats and others for the awesome Thor gem which made creating the sinatra generator relatively painless
 * Thanks to wycats and others for the bundler gem which made bundling the required gems for an application easy
 

data/ROADMAP

@@ -18,37 +18,9 @@ Framework structure:
  * sinatra-mailer  (mail handling for sinatra applications)  <= from MailerPlugin
  * sinatra-gen     (easy generation of and for sinatra apps) <= from Generator
  * sinatra-admin   (admin management dashboard for content)  <= from Lipsiadmin (ported)
+ * sinatra-routing (sinatra route mapping system)            <= from RoutingPlugin
  * sinatra-cache   (page and fragment caching support)       
- * sinatra-mapping (sinatra route mapping system)
 
-'sinatra-mapping' Routing Concept:
-
-    namespace :admin do
-      get :show do
-        ...
-      end
-    end
- 
-    get :accounts do
-     ...
-    end
- 
-    map(:admin, :show).to("/my-admin/:id/show")
-    map(:accounts).to("/show-me-my/accounts")
- 
-    # or
- 
-    map :admin do |namespace|
-     namespace.map(:show).to("/my-admin/:id/show")
-    end
- 
-    # and to use
-    link_to "Show Admin", admin_show_path(:id => 5)
-    link_to "Accounts", accounts_path
-    # or maybe
-    link_to "Show Admin", url_for(:admin, :show, :id => 5)
-    link_to "Accounts", url_for(:accounts)
-  
 'sinatra-cache' Caching concept:
 
     # in models
@@ -75,4 +47,29 @@ Framework structure:
     # page
     get '/example', :cache => true do
       haml_template 'accounts/index'
-    end
+    end
+
+'sinatra-routing' Routing Concept:
+
+    namespace :admin do
+      get :show do
+        ...
+      end
+    end
+ 
+    get :accounts do
+     ...
+    end
+ 
+    map(:admin, :show).to("/my-admin/:id/show")
+    map(:accounts).to("/show-me-my/accounts")
+ 
+    # or
+ 
+    map :admin do |namespace|
+     namespace.map(:show).to("/my-admin/:id/show")
+    end
+ 
+    # and to use
+    link_to "Show Admin", url_for(:admin, :show, :id => 5)
+    link_to "Accounts",   url_for(:accounts)

data/VERSION

@@ -1 +1 @@
-0.3.13
+0.3.14

data/generators/base_app/config/dependencies.rb.tt

@@ -6,6 +6,12 @@ class <%= @class_name %> < Sinatra::Application
   # Required middleware
   use Rack::Session::Cookie
   use Rack::Flash
+  
+  # Includes all necessary sinatra_more helpers
+  register SinatraMore::MarkupPlugin
+  register SinatraMore::RenderPlugin
+  register SinatraMore::MailerPlugin
+  register SinatraMore::RoutingPlugin
 
   # Requires the initializer modules which configure specific components
   Dir[File.dirname(__FILE__) + '/initializers/*.rb'].each do |file|
@@ -23,10 +29,7 @@ class <%= @class_name %> < Sinatra::Application
   # Require all the folders and files necessary to run the application
   file_loading_paths.each { |load_path| Dir[root_path(load_path)].each { |file| require file } }
   
-  # Includes all necessary sinatra_more helpers
-  register SinatraMore::MarkupPlugin
-  register SinatraMore::RenderPlugin
-  register SinatraMore::MailerPlugin
+  # Require Warden plugin below to allow User to be loaded
   register SinatraMore::WardenPlugin
     
   # Required helpers

data/lib/sinatra_more/routing_plugin/named_route.rb

@@ -0,0 +1,25 @@
+module SinatraMore
+  class NamedRoute
+    # Constructs the NamedRoute which accepts the application and
+    # the route alias names to register (i.e [:account] or [:admin, :show])
+    # NamedRoute.new(@app, :admin, :show)
+    def initialize(app, *names)
+      @app   = app
+      @names = names.flatten
+    end
+
+    # Used to define the url mapping to the supplied alias
+    # NamedRoute.new(@app, :account).to('/account/path')
+    def to(path)
+      @app.named_paths[@names] = path
+    end
+
+    # Used to define the url mappings for child aliases within a namespace
+    # Invokes map on the application itself, appending the namespace to the route
+    # NamedRoute.new(@app, :admin).map(:show).to('/admin/show')
+    # is equivalent to NamedRoute.new(@app, :admin, :show).to('/admin/show')
+    def map(*args, &block)
+      @app.map(*args.unshift(@names), &block)
+    end
+  end
+end

data/lib/sinatra_more/routing_plugin/routing_helpers.rb

@@ -0,0 +1,19 @@
+module SinatraMore
+  module RoutingHelpers
+    # Used to retrieve the full url for a given named route alias from the named_paths data
+    # Accepts parameters which will be substituted into the url if necessary
+    # url_for(:accounts) => '/accounts'
+    # url_for(:account, :id => 5) => '/account/5'
+    # url_for(:admin, show, :id => 5, :name => "demo") => '/admin/path/5/demo'
+    def url_for(*names)
+      values = names.extract_options!
+      mapped_url = self.class.named_paths[names]
+      result_url = String.new(mapped_url)
+      result_url.scan(%r{/?(:\S+?)(?:/|$)}).each do |placeholder|
+        value_key = placeholder[0][1..-1].to_sym
+        result_url.gsub!(Regexp.new(placeholder[0]), values[value_key].to_s)
+      end
+      result_url
+    end
+  end
+end

data/lib/sinatra_more/routing_plugin.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/support_lite'
+Dir[File.dirname(__FILE__) + '/routing_plugin/**/*.rb'].each {|file| load file }
+
+module SinatraMore
+  module RoutingPlugin
+    def self.registered(app)
+      # Named paths stores the named route aliases mapping to the url
+      # i.e { [:account] => '/account/path', [:admin, :show] => '/admin/show/:id' }
+      app.set :named_paths, {}
+      app.helpers SinatraMore::RoutingHelpers
+
+      # map constructs a mapping between a named route and a specified alias
+      # the mapping url can contain url query parameters
+      # map(:accounts).to('/accounts/url')
+      # map(:admin, :show).to('/admin/show/:id')
+      # map(:admin) { |namespace| namespace.map(:show).to('/admin/show/:id') }
+      def map(*args, &block)
+        named_router = SinatraMore::NamedRoute.new(self, *args)
+        block_given? ? block.call(named_router) : named_router
+      end
+
+      # Used to define namespaced route configurations in order to group similar routes
+      # Class evals the routes but with the namespace assigned which will append to each route
+      # namespace(:admin) { get(:show) { "..." } }
+      def namespace(name, &block)
+        original, @_namespace = @_namespace, name
+        self.class_eval(&block)
+        @_namespace = original
+      end
+
+      # Hijacking route method in sinatra to replace a route alias (i.e :account) with the full url string mapping
+      # Supports namespaces by accessing the instance variable and appending this to the route alias name
+      # If the path is not a symbol, nothing is changed and the original route method is invoked
+      def route(verb, path, options={}, &block)
+        route_name = [@_namespace, path].flatten.compact
+        path = named_paths[route_name] if path.kind_of? Symbol
+        super verb, path, options, &block
+      end
+    end
+  end
+end

data/lib/sinatra_more.rb

@@ -3,4 +3,5 @@ require 'sinatra/base'
 require File.join(File.dirname(__FILE__) + '/sinatra_more/markup_plugin')
 require File.join(File.dirname(__FILE__) + '/sinatra_more/render_plugin')
 require File.join(File.dirname(__FILE__) + '/sinatra_more/warden_plugin')
-require File.join(File.dirname(__FILE__) + '/sinatra_more/mailer_plugin')
+require File.join(File.dirname(__FILE__) + '/sinatra_more/mailer_plugin')
+require File.join(File.dirname(__FILE__) + '/sinatra_more/routing_plugin')

data/sinatra_more.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sinatra_more}
-  s.version = "0.3.13"
+  s.version = "0.3.14"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nathan Esquenazi"]
-  s.date = %q{2009-11-12}
+  s.date = %q{2009-11-13}
   s.default_executable = %q{sinatra_gen}
   s.description = %q{Expands sinatra with standard helpers and tools to allow for complex applications}
   s.email = %q{nesquena@gmail.com}
@@ -84,6 +84,9 @@ Gem::Specification.new do |s|
      "lib/sinatra_more/markup_plugin/tag_helpers.rb",
      "lib/sinatra_more/render_plugin.rb",
      "lib/sinatra_more/render_plugin/render_helpers.rb",
+     "lib/sinatra_more/routing_plugin.rb",
+     "lib/sinatra_more/routing_plugin/named_route.rb",
+     "lib/sinatra_more/routing_plugin/routing_helpers.rb",
      "lib/sinatra_more/support_lite.rb",
      "lib/sinatra_more/warden_plugin.rb",
      "lib/sinatra_more/warden_plugin/warden_helpers.rb",
@@ -116,6 +119,8 @@ Gem::Specification.new do |s|
      "test/fixtures/render_app/views/template/_user.haml",
      "test/fixtures/render_app/views/template/haml_template.haml",
      "test/fixtures/render_app/views/template/some_template.haml",
+     "test/fixtures/routing_app/app.rb",
+     "test/fixtures/routing_app/views/index.haml",
      "test/fixtures/warden_app/app.rb",
      "test/fixtures/warden_app/views/dashboard.haml",
      "test/generators/test_skeleton_generator.rb",
@@ -130,6 +135,7 @@ Gem::Specification.new do |s|
      "test/markup_plugin/test_tag_helpers.rb",
      "test/test_mailer_plugin.rb",
      "test/test_render_plugin.rb",
+     "test/test_routing_plugin.rb",
      "test/test_warden_plugin.rb",
      "vendor/pony/lib/pony.rb",
      "vendor/pony/spec/base.rb",
@@ -145,6 +151,7 @@ Gem::Specification.new do |s|
      "test/fixtures/mailer_app/app.rb",
      "test/fixtures/markup_app/app.rb",
      "test/fixtures/render_app/app.rb",
+     "test/fixtures/routing_app/app.rb",
      "test/fixtures/warden_app/app.rb",
      "test/generators/test_skeleton_generator.rb",
      "test/helper.rb",
@@ -158,6 +165,7 @@ Gem::Specification.new do |s|
      "test/markup_plugin/test_tag_helpers.rb",
      "test/test_mailer_plugin.rb",
      "test/test_render_plugin.rb",
+     "test/test_routing_plugin.rb",
      "test/test_warden_plugin.rb"
   ]
 

data/test/fixtures/routing_app/app.rb

@@ -0,0 +1,44 @@
+require 'sinatra/base'
+require 'sinatra_more'
+require 'haml'
+
+class RoutingDemo < Sinatra::Base
+  register SinatraMore::RoutingPlugin
+  
+  configure do
+    set :root, File.dirname(__FILE__)
+  end
+  
+  map(:admin, :show).to("/admin/:id/show")
+  map :admin do |namespace|
+    namespace.map(:update).to("/admin/:id/update/:name")
+    namespace.map(:destroy).to("/admin/:id/destroy")
+  end
+  map(:account).to("/the/accounts/:name/path/:id/end")
+  map(:accounts).to("/the/accounts/index/?")
+  
+  namespace :admin do
+    get :show do
+      "<p>admin show for id #{params[:id]}</p>"
+    end
+    
+    get :update do
+      "<p>updated admin with id #{params[:id]} and name #{params[:name]}</p>"
+    end
+    
+    get :destroy do
+      "<p>destroy admin with id #{params[:id]}</p>"
+    end
+  end
+  get :account do
+    "<h1>the account url for #{params[:name]} and id #{params[:id]}</h1>"
+  end
+  
+  get :accounts do
+    "<h1>the accounts index</h1>"
+  end
+  
+  get '/links' do
+    haml :index
+  end
+end

data/test/fixtures/routing_app/views/index.haml

@@ -0,0 +1,5 @@
+%p.admin_url= url_for(:admin, :show, :id => 25)
+%p.admin_url2= url_for(:admin, :update, :id => 10, :name => "test")
+%p.admin_url3= url_for(:admin, :destroy, :id => 12)
+%p.account_url= url_for(:account, :name => 'foobar', :id => 10)
+%p.accounts_index=url_for(:accounts)

data/test/test_routing_plugin.rb

@@ -0,0 +1,56 @@
+require 'helper'
+require 'fixtures/routing_app/app'
+
+class TestRoutingPlugin < Test::Unit::TestCase
+  def app
+    RoutingDemo.tap { |app| app.set :environment, :test }
+  end
+
+  context 'for links list displaying routes' do
+    setup { visit '/links' }
+    should 'display account route links' do
+      assert_have_selector :p, :class => 'account_url', :content => '/the/accounts/foobar/path/10/end'
+      assert_have_selector :p, :class => 'accounts_index', :content => '/the/accounts/index'
+    end
+    should "display admin route links" do
+      assert_have_selector :p, :class => 'admin_url', :content => '/admin/25/show'
+      assert_have_selector :p, :class => 'admin_url2', :content => '/admin/10/update/test'
+      assert_have_selector :p, :class => 'admin_url3', :content => '/admin/12/destroy'
+    end
+  end
+
+  context 'for no namespaced account route' do
+    setup { visit '/the/accounts/demo/path/5/end'}
+    should "return proper account text" do
+      assert_have_selector :h1, :content => "the account url for demo and id 5"
+    end
+  end
+
+  context 'for no namespaced accounts index route' do
+    setup { visit '/the/accounts/index/'}
+    should "return proper account text" do
+      assert_have_selector :h1, :content => "the accounts index"
+    end
+  end
+
+  context 'for admin show url' do
+    setup { visit '/admin/50/show' }
+    should "return proper admin test" do
+      assert_have_selector :p, :content => "admin show for id 50"
+    end
+  end
+  
+  context 'for admin update url' do
+    setup { visit '/admin/15/update/demo' }
+    should "return proper update text" do
+      assert_have_selector :p, :content => "updated admin with id 15 and name demo"
+    end
+  end
+  
+  context 'for admin destroy url' do
+    setup { visit '/admin/60/destroy' }
+    should "return proper destroy text" do
+      assert_have_selector :p, :content => "destroy admin with id 60"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra_more
 version: !ruby/object:Gem::Version 
-  version: 0.3.13
+  version: 0.3.14
 platform: ruby
 authors: 
 - Nathan Esquenazi
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-12 00:00:00 -08:00
+date: 2009-11-13 00:00:00 -08:00
 default_executable: sinatra_gen
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -187,6 +187,9 @@ files:
 - lib/sinatra_more/markup_plugin/tag_helpers.rb
 - lib/sinatra_more/render_plugin.rb
 - lib/sinatra_more/render_plugin/render_helpers.rb
+- lib/sinatra_more/routing_plugin.rb
+- lib/sinatra_more/routing_plugin/named_route.rb
+- lib/sinatra_more/routing_plugin/routing_helpers.rb
 - lib/sinatra_more/support_lite.rb
 - lib/sinatra_more/warden_plugin.rb
 - lib/sinatra_more/warden_plugin/warden_helpers.rb
@@ -219,6 +222,8 @@ files:
 - test/fixtures/render_app/views/template/_user.haml
 - test/fixtures/render_app/views/template/haml_template.haml
 - test/fixtures/render_app/views/template/some_template.haml
+- test/fixtures/routing_app/app.rb
+- test/fixtures/routing_app/views/index.haml
 - test/fixtures/warden_app/app.rb
 - test/fixtures/warden_app/views/dashboard.haml
 - test/generators/test_skeleton_generator.rb
@@ -233,6 +238,7 @@ files:
 - test/markup_plugin/test_tag_helpers.rb
 - test/test_mailer_plugin.rb
 - test/test_render_plugin.rb
+- test/test_routing_plugin.rb
 - test/test_warden_plugin.rb
 - vendor/pony/lib/pony.rb
 - vendor/pony/spec/base.rb
@@ -270,6 +276,7 @@ test_files:
 - test/fixtures/mailer_app/app.rb
 - test/fixtures/markup_app/app.rb
 - test/fixtures/render_app/app.rb
+- test/fixtures/routing_app/app.rb
 - test/fixtures/warden_app/app.rb
 - test/generators/test_skeleton_generator.rb
 - test/helper.rb
@@ -283,4 +290,5 @@ test_files:
 - test/markup_plugin/test_tag_helpers.rb
 - test/test_mailer_plugin.rb
 - test/test_render_plugin.rb
+- test/test_routing_plugin.rb
 - test/test_warden_plugin.rb