sinatra-mapping 1.1.0 → 1.2.0

data/CHANGES

@@ -1,7 +1,9 @@
 = Changes
 
-[1.1.1 - not released]
+[1.2.0 - 2009-09-22]
   * The mapping methods works in classic application.
+  * Updates in documentation.
+  * All tests have been fixed.
 
 [1.1.0 - 2009-08-25]
   * Added suffix "/?" in all paths when no arguments.

data/INFO

@@ -9,6 +9,5 @@
 :email: email@hallisonbatista.com
 :homepage: http://sinatra-mapping.rubyforge.org/
 :dependencies:
-  rack: >= 0.9.1
   sinatra: >= 0.9.1.1
 

data/LICENSE

@@ -17,3 +17,4 @@ 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.rdoc

@@ -2,7 +2,7 @@
 
 Map easily URLs in your Web applications.
 
-* {Homepage}[:link:/]
+* {Homepage}[http://sinatra-mapping.rubyforge.org/]
 * {Repository}[http://github.com/hallison/sinatra-mapping]
 * {Project}[http://rubyforge.org/projects/sinatra-mapping]
 * {Issues}[http://github.com/hallison/sinatra-mapping/issues]
@@ -43,113 +43,109 @@ Sinatra implements REST routes:
 
 For improve this routes use extension by registered method in the main
 source of application. To better understand, copy and paste the following
-example in {Ruby}[http://www.ruby-lang.org] source file +webfoo.rb+:
+example in {Ruby}[http://www.ruby-lang.org] source file +weblog.rb+:
 
   #!/usr/bin/env ruby
   require 'rubygems'
   require 'sinatra'
   require 'sinatra/mapping' # only this line for use mapping!
 
-  class Sinatra::Application
-
-    map :root,    "blog"    # /blog/
-    map :entries, "posts"   # /blog/posts
-    map :tags,    "labels"  # /blog/labels
-
-    mapping :entry          => "posts/:entry_id",           # /blog/posts/id-for-post
-            :entry_comments => "posts/:entry_id/comments",  # /blog/posts/id-for-post/comments
-            :tagged_entries => "labels/:tag_id/entries"     # /blog/labels/id-for-tag/entries
-
-    # /blog/
-    get root_path do
-      <<-end_content
-        <h1>Welcome to Foo Web Application</h1>
-        <ul>
-          <li>#{link_to title_path(:entries), :entries, :title => title_path(:entries)}</li>
-          <li>#{link_to title_path(:tags),    :tags,    :title => title_path(:tags)}</li>
-        </ul>
-      end_content
-    end
-
-    # /blog/entries
-    get entries_path do
-      <<-end_content
-        <h1>Welcome to Foo Web Application</h1>
-        <h2>#{title_path(:entries)}</h2>
-        <ul>
-          <li>#{link_to "Testing new entry ...", :entries, "testing-new-entry"}</li>
-          <li>#{link_to "Testing old entry ...", :entries, "testing-old-entry"}</li>
-        </ul>
-        <p>
-          #{link_to "Back", :root}
-        </p>
-      end_content
-    end
-
-    # /blog/labels/tag-id-for-show-content
-    get tags_path do
-      <<-end_content
-        <h1>Welcome to Foo Web Application</h1>
-        <h2>#{title_path(:tags)}</h2>
-        <ul>
-          <li>#{link_to "Ruby",    :tags, "ruby",    "entries"}</li>
-          <li>#{link_to "Sinatra", :tags, "sinatra", "entries"}</li>
-          <li>#{link_to "Mapping", :tags, "mapping", "entries"}</li>
-        </ul>
-        <p>
-          #{link_to "Back", :root}
-        </p>
-      end_content
-    end
-
-    # /blog/entries/entry-id-for-show-content
-    get entry_path do |entry_id|
-      title = entry_id.gsub('-',' ').capitalize
-      <<-end_content
-        <h1>Welcome to Foo Web Application</h1>
-        <h2>#{title}</h2>
-        <p>
-          It works!
-        </p>
-        <p>
-          #{link_to "Back", :root} | #{link_to "Comments", :entries, entry_id, 'comments'}
-        </p>
-      end_content
-    end
-
-    # /blog/entries/entry-id-for-show-content/comments
-    get entry_comments_path do |entry_id|
-      title = entry_id.gsub('-',' ').capitalize
-      <<-end_content
-        <h1>Welcome to Foo Web Application</h1>
-        <h2>#{title}</h2>
-        <p>
-          It works and show comments for "#{title}".
-        </p>
-        <p>
-          #{link_to "Back", :root}
-        </p>
-      end_content
-    end
-
-    get tagged_entries_path do |tag_id|
-      <<-end_content
-        <h1>Welcome to Foo Web Application</h1>
-        <h2>#{tag_id.capitalize}</h2>
-        <p>
-          It works and show all entries tagged with "#{tag_id}".
-        </p>
-        <p>
-          #{link_to "Back", :root}
-        </p>
-      end_content
-    end
+  map :root,    "blog"    # /blog/
+  map :entries, "posts"   # /blog/posts
+  map :tags,    "labels"  # /blog/labels
+
+  mapping :entry          => "posts/:entry_id",           # /blog/posts/id-for-post
+          :entry_comments => "posts/:entry_id/comments",  # /blog/posts/id-for-post/comments
+          :tagged_entries => "labels/:tag_id/entries"     # /blog/labels/id-for-tag/entries
+
+  # /blog/
+  get root_path do
+    <<-end_content
+      <h1>Welcome to Foo Web Application</h1>
+      <ul>
+        <li>#{link_to title_path(:entries), :entries, :title => title_path(:entries)}</li>
+        <li>#{link_to title_path(:tags),    :tags,    :title => title_path(:tags)}</li>
+      </ul>
+    end_content
+  end
+
+  # /blog/entries
+  get entries_path do
+    <<-end_content
+      <h1>Welcome to Foo Web Application</h1>
+      <h2>#{title_path(:entries)}</h2>
+      <ul>
+        <li>#{link_to "Testing new entry ...", :entries, "testing-new-entry"}</li>
+        <li>#{link_to "Testing old entry ...", :entries, "testing-old-entry"}</li>
+      </ul>
+      <p>
+        #{link_to "Back", :root}
+      </p>
+    end_content
+  end
+
+  # /blog/labels/tag-id-for-show-content
+  get tags_path do
+    <<-end_content
+      <h1>Welcome to Foo Web Application</h1>
+      <h2>#{title_path(:tags)}</h2>
+      <ul>
+        <li>#{link_to "Ruby",    :tags, "ruby",    "entries"}</li>
+        <li>#{link_to "Sinatra", :tags, "sinatra", "entries"}</li>
+        <li>#{link_to "Mapping", :tags, "mapping", "entries"}</li>
+      </ul>
+      <p>
+        #{link_to "Back", :root}
+      </p>
+    end_content
+  end
+
+  # /blog/entries/entry-id-for-show-content
+  get entry_path do |entry_id|
+    title = entry_id.gsub('-',' ').capitalize
+    <<-end_content
+      <h1>Welcome to Foo Web Application</h1>
+      <h2>#{title}</h2>
+      <p>
+        It works!
+      </p>
+      <p>
+        #{link_to "Back", :root} | #{link_to "Comments", :entries, entry_id, 'comments'}
+      </p>
+    end_content
+  end
+
+  # /blog/entries/entry-id-for-show-content/comments
+  get entry_comments_path do |entry_id|
+    title = entry_id.gsub('-',' ').capitalize
+    <<-end_content
+      <h1>Welcome to Foo Web Application</h1>
+      <h2>#{title}</h2>
+      <p>
+        It works and show comments for "#{title}".
+      </p>
+      <p>
+        #{link_to "Back", :root}
+      </p>
+    end_content
+  end
 
+  get tagged_entries_path do |tag_id|
+    <<-end_content
+      <h1>Welcome to Foo Web Application</h1>
+      <h2>#{tag_id.capitalize}</h2>
+      <p>
+        It works and show all entries tagged with "#{tag_id}".
+      </p>
+      <p>
+        #{link_to "Back", :root}
+      </p>
+    end_content
   end
 
 Run:
 
-  $ ruby webfoo.rb -p 3000
+  $ ruby weblog.rb -p 3000
 
 Open Web browser http://localhost:3000/blog/ and look ... it works!
 

data/VERSION

@@ -1,7 +1,7 @@
 --- 
 :release: 
-:date: 2009-08-25
 :cycle: Stable release
 :major: 1
-:minor: 1
+:minor: 2
+:date: 2009-09-22
 :patch: 0

data/lib/sinatra/mapping.rb

@@ -22,8 +22,8 @@ module Mapping
   #
   # If name is equal :root, then returns path ended by slash "/".
   #
-  #   map :root,    "tasks"       # => /tasks/
-  #   map :changes, "last-changes # => /tasks/last-changes
+  #   map :root,    "tasks"       #=> /tasks/
+  #   map :changes, "last-changes #=> /tasks/last-changes
   def map(name, path = nil)
     @locations ||= {}
     if name.to_sym == :root
@@ -37,12 +37,14 @@ module Mapping
         map_path_to(@locations[name.to_sym], *paths << "/?")
       end
     end
+    Delegator.delegate "#{name}_path"
   end
 
   # Auto mapping from a hash. This method is very useful.
   # Example:
   #
-  #   # In Web application.
+  # In Web application:
+  #
   #   class WebApp << Sinatra::Base
   #     mapping :root   => "tasks",   # /tasks
   #             :status => "changes"  # /tasks/changes
@@ -50,21 +52,28 @@ module Mapping
   #
   # Or, it's possible use from configuration file.
   #
-  #   # YAML file "settings.yml".
-  #   mapping:
-  #     root: tasks
-  #     status: changes
+  #   # YAML file "mapping.yml".
+  #   root: tasks
+  #   status: changes
   #
   #   # In Sinatra application.
-  #   mapping YAML.load_file("settings.yml")[:mapping]
-  #   # root_path   # /tasks
-  #   # status_path # /tasks/changes
+  #
+  #   mapping YAML.load_file("mapping.yml")
+  #   #=> root_path   # /tasks
+  #   #=> status_path # /tasks/changes
   def mapping(hash)
     hash.each do |name, path|
       map name, path
     end
   end
 
+  # Register automatically all helpers in base application.
+  def self.registered(app)
+    app.helpers Mapping::Helpers
+  end
+
+private
+
   # Returns URL path with query instructions.
   # This method has been extracted from
   # http://wiki.github.com/sinatra/sinatra/howto-generate-links.
@@ -76,13 +85,6 @@ module Mapping
     path
   end
 
-  # Register automatically all helpers in base application.
-  def self.registered(app)
-    app.helpers Mapping::Helpers
-  end
-
-private
-
   # Check arguments. If argument is a symbol and exist map path before
   # setted, then return path mapped by symbol name.
   def map_path_to(*args)
@@ -111,29 +113,31 @@ private
     paths.join('/').gsub(/[\/]{2,}/,'/')
   end
 
+  # Copyright (c) 2009 Hallison Batista
+  #
   # This module contains several helper methods for paths written using 
-  # {map}[:link:./Sinatra/Mapping.html#map] method.
+  # +map+ method.
   module Helpers
 
     # Creates a title using a path mapped. Otherwise, returns just arguments
     # joined by spaces and capitalised.
     #
-    #   # In Sinatra application
+    # In Sinatra application:
     #
     #   map :posts,   "articles"
     #   map :tags,    "labels"
     #   map :archive, "archive/articles"
     #
-    #   # In views
+    # In views:
     #
     #   <%=title_path :posts%>
-    #   # => "Articles"
+    #   #=> "Articles"
     #
     #   <%=title_path :tags%>
-    #   # => "Labels"
+    #   #=> "Labels"
     #
     #   <%=title_path :archive%>
-    #   # => "Archive articles"
+    #   #=> "Archive articles"
     def title_path(path, *args)
       title = (options.locations[path] || path).to_s.gsub('/',' ').strip
       title.gsub!(/\W/,' ') # Cleanup
@@ -143,7 +147,7 @@ private
     # Creates anchor links for name and extract path and HTML options from
     # arguments. Example:
     #
-    #   # In Sinatra application, add a map.
+    # In Sinatra application, add a map.
     #
     #   map :tasks,  "tasks"
     #   map :status, "tasks/status"
@@ -156,13 +160,13 @@ private
     #     erb :status, :locals => { :status => "finished" }
     #   end
     #
-    #   # In status view, add a link to status map.
+    # In status view, add a link to status map.
     #
     #   <%= link_to "All finished", :status, status %>
-    #   # => <a href="/tasks/status/finished">All finished</a>
+    #   #=> <a href="/tasks/status/finished">All finished</a>
     #
     #   <%= link_to "All finished", :status, :name => status %>
-    #   # => <a href="/tasks/status?name=finished">All finished</a>
+    #   #=> <a href="/tasks/status?name=finished">All finished</a>
     def link_to(name = nil, *args)
       options = args.last.kind_of?(Hash) ? args.pop : {}
       url     = args.shift if args.first.to_s =~ /^\w.*?:/
@@ -172,17 +176,17 @@ private
 
     # Returns all paths with query parameters. Example:
     #
-    #   # In Sinatra application:
+    # In Sinatra application:
     #
     #   map :post, "articles"
     #   map :tags, "labels"
     #
-    #   # Use the following instructions:
+    # Use the following instructions:
     #
     #   path_to :tags, "ruby", :posts
-    #   # => "/labels/ruby/articles"
+    #   #=> "/labels/ruby/articles"
     def path_to(*args)
-      options.build_path_to(env['SCRIPT_NAME'], *args)
+      self.class.send(:build_path_to, env['SCRIPT_NAME'], *args)
     end
 
   private

data/test/classic_mapping_test.rb

@@ -3,11 +3,10 @@ $LOAD_PATH.unshift("#{File.dirname(__FILE__)}/..")
 require 'rubygems'
 require 'test/unit'
 require 'rack/test'
-require 'ruby-debug'
 
 require 'test/fixtures/classic_application'
 
-class ModularTestMapping < Test::Unit::TestCase
+class ClassicMappingTest < Test::Unit::TestCase
 
   include Rack::Test::Methods
 
@@ -32,7 +31,7 @@ class ModularTestMapping < Test::Unit::TestCase
   end
 
   def app
-    @app = ::ModularApplication
+    @app = Sinatra::Application
     @app.set :environment, :test
     @app
   end

data/test/fixtures/classic_application.rb

@@ -3,13 +3,12 @@ $LOAD_PATH.unshift("#{File.dirname(__FILE__)}/../../lib/")
 
 require 'sinatra'
 require 'sinatra/mapping'
-require 'ruby-debug'
 
-#class Sinatra::Application
-#  def env
-#    @env.update('SCRIPT_NAME' => '/test')
-#  end
-#end
+class Sinatra::Application
+  def env
+    @env.update('SCRIPT_NAME' => '/test')
+  end
+end
 
 map :root,  "blog"   # root_path    => /blog/
 map :about           # about_path   => /blog/about
@@ -48,7 +47,7 @@ get about_path do
 end
 
 get search_path do
-  <<-end_content.gsub(/^      /,'')
+  <<-end_content.gsub(/^    /,'')
     #{title_path :search}:#{path_to :search, :keywords => 'ruby'}
     #{link_to "Search", :search, :title => 'Search'}
     #{link_to "Search", :search, :title => 'Search', :keywords => 'ruby'}
@@ -56,7 +55,7 @@ get search_path do
 end
 
 get drafts_path do
-  <<-end_content.gsub(/^      /,'')
+  <<-end_content.gsub(/^    /,'')
     #{title_path :drafts}:#{path_to [:drafts, :posts]}
     #{link_to "Unpublished", :drafts, :posts, :title => 'Unpublished'}
   end_content

data/test/modular_mapping_test.rb

@@ -3,11 +3,10 @@ $LOAD_PATH.unshift("#{File.dirname(__FILE__)}/..")
 require 'rubygems'
 require 'test/unit'
 require 'rack/test'
-require 'ruby-debug'
 
 require 'test/fixtures/modular_application'
 
-class ModularTestMapping < Test::Unit::TestCase
+class ModularMappingTest < Test::Unit::TestCase
 
   include Rack::Test::Methods
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra-mapping
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Hallison Batista
@@ -9,19 +9,9 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-25 00:00:00 -04:00
+date: 2009-09-22 00:00:00 -04:00
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rack
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.9.1
-    version: 
 - !ruby/object:Gem::Dependency 
   name: sinatra
   type: :runtime