sinatra-mapping 1.0.6 → 1.0.7

data/CHANGES

@@ -2,6 +2,8 @@
 
 [1.0.6 - 2009-08-21]
   * Fixes in the method for build path mapped.
+  * Updates in documentation.
+  * Tests have been fixed.
 
 [1.0.5 - 2009-07-30]
   * Fixes in the HTML attributes into helper method for link attributes.

data/LICENSE

@@ -1,5 +1,3 @@
-= The MIT License
-
 Copyright (c) 2009 Hallison Batista
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

data/README.rdoc

@@ -1,16 +1,17 @@
 = Sinatra::Mapping
 
-Map easily URLs paths in your Web applications.
+Map easily URLs in your Web applications.
 
 * {Repository}[http://github.com/hallison/sinatra-mapping]
 * {Project}[http://rubyforge.org/projects/sinatra-mapping]
 * {Documentation}[:link:Sinatra/Mapping.html]
 * {Issues}[http://github.com/hallison/sinatra-mapping/issues]
 
-The extention Sinatra::Mapping is a minimal module that is useful for
+The extension Sinatra::Mapping is a minimal module that is useful for
 create map names for {Ruby}[http://www.ruby-lang.org]
 {Sinatra}[http://www.sinatrarb.com] web applications.
 
+== Getting start
 Install stable version gem from {RubyForge.org}[http://www.rubyforge.org/]:
 
   gem install sinatra-mapping
@@ -19,7 +20,7 @@ Or, install development version gem from {GitHub.com}[http://github.com/]:
 
   gem install hallison-sinatra-mapping --source http://gems.github.com
 
-:session: Getting start
+== How to use
 
 Sinatra implements REST routes:
 
@@ -39,54 +40,122 @@ Sinatra implements REST routes:
     .. annihilate something ..
   end
 
-Use extension by registered method in the main source of application.
-Example:
+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+:
 
+  #!/usr/bin/env ruby
+
+  require 'rubygems'
   require 'sinatra'
   require 'sinatra/mapping'
+  require 'sinatra/mapping_helpers'
 
-  class BlogAppication < Sinatra::Application
+  class Sinatra::Application
 
     register Sinatra::Mapping
+    helpers  Sinatra::MappingHelpers
 
-    map :root,    "blog"              # => /blog/
-    map :posts,   "articles"          # => /blog/articles
+    map :root,    "blog"    # /blog/
+    map :entries, "posts"   # /blog/posts
+    map :tags,    "labels"  # /blog/labels
 
-    mapping :tags    => "labels"            # => /blog/labels
-            :archive => "archived-articles" # => /blog/archived-articles
+    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
-      # /blog/
-      # do something for root path.
+      <<-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
 
-    get posts_path do
-      # /blog/articles
-      # do something for posts path.
+    # /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
 
-    get posts_path(":year/:month/:day/:permalink") do |year, month, day, permalink|
-      # /blog/articles/2009/10/08/permalink-for-your-article
-      # do something for posts path using parameters for find a post.
+    # /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
 
-    get tags_path do
-      # /blog/labels
-      # do something for tags path.
+    # /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
 
-    get archive_path do
-      # do something for archive path.
+    # /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 archive_path(":year/:month/:day/:permalink") do |year, month, day, permalink|
-      # /blog/archived-articles/1978/10/08/permalink-for-your-article
-      # do something for archive path using parameters for find a post.
+    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
 
   end
 
-Easy!!!
+Run:
+
+  $ ruby webfoo.rb -p 3000
+
+Open Web browser http://localhost:3000/blog/ and look ... it works!
 
 == More informations
 
@@ -96,5 +165,4 @@ Easy!!!
 
 == Copyright
 
-Copyright (c) 2009 Hallison Batista
-
+:include:LICENSE

data/VERSION

@@ -1,7 +1,7 @@
 --- 
 :release: 
-:date: 2009-08-21
+:date: 2009-08-25
 :cycle: Stable release
 :major: 1
 :minor: 0
-:patch: 6
+:patch: 7

data/lib/sinatra/mapping.rb

@@ -27,12 +27,12 @@ module Sinatra
       if name.to_sym == :root
         @locations[:root] = cleanup_paths("/#{path}/")
         metadef "#{name}_path" do |*paths|
-          @locations[:root]
+          cleanup_paths("/#{@locations[:root]}/?")
         end
       else
-        @locations[name.to_sym] = path || name.to_s
+        @locations[name.to_sym] = cleanup_paths(path || name.to_s)
         metadef "#{name}_path" do |*paths|
-          map_path_to(@locations[name.to_sym], *paths)
+          map_path_to(@locations[name.to_sym], *paths << "/?")
         end
       end
     end
@@ -79,7 +79,7 @@ module Sinatra
     # 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)
-      script_name = args.shift if args.first.to_s =~ /^\/\w.*/
+      script_name = args.shift if args.first.to_s =~ %r{^/\w.*}
       path_mapped(script_name, *locations_get_from(*args))
     end
 

data/test/fixtures/modular_application.rb

@@ -0,0 +1,71 @@
+$LOAD_PATH.unshift("#{File.dirname(__FILE__)}/../../lib/")
+
+require 'rubygems'
+require 'sinatra/base'
+require 'sinatra/mapping'
+require 'sinatra/mapping_helpers'
+
+class Sinatra::Base
+  def env
+    @env.update('SCRIPT_NAME' => '/test')
+  end
+end
+
+class ModularApplication < Sinatra::Base
+
+  register Sinatra::Mapping
+  helpers  Sinatra::MappingHelpers
+
+  map :root,  "blog"   # root_path    => /blog/
+  map :about           # about_path   => /blog/about
+
+  mapping :posts   => "articles",         # posts_path   => /blog/articles
+          :archive => "archive/articles", # archive_path => /blog/archive/articles
+          :search  => "find-articles",    # search_path  => /blog/find-articles
+          :drafts  => "unpublished"       # drafts_path  => /blog/unpublished
+
+  before do
+    @date = Date.today
+  end
+
+  get root_path do
+    "#{title_path :root, :path}:#{path_to :root}"
+  end
+
+  get posts_path do
+    "#{title_path :posts, :published}:#{path_to :posts}"
+  end
+
+  get posts_path "/:year/:month/:day/:permalink" do |year, month, day, permalink|
+    "#{title_path :posts}:" + path_to(:posts, "#{@date.to_s.gsub('-','/')}/#{permalink}")
+  end
+
+  get archive_path do
+    "#{title_path :archive}:#{path_to :archive}"
+  end
+
+  get archive_path "/:year/:month/:day/:permalink" do |year, month, day, permalink|
+    "#{title_path :archive}:" + path_to(:archive, "#{@date.to_s.gsub('-','/')}/#{permalink}")
+  end
+
+  get about_path do
+    "#{title_path :about}:#{path_to :about}"
+  end
+
+  get search_path do
+    <<-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'}
+    end_content
+  end
+
+  get drafts_path do
+    <<-end_content.gsub(/^      /,'')
+      #{title_path :drafts}:#{path_to [:drafts, :posts]}
+      #{link_to "Unpublished", :drafts, :posts, :title => 'Unpublished'}
+    end_content
+  end
+
+end
+

data/test/helper.rb

@@ -0,0 +1,6 @@
+class Sinatra::Application
+  def env
+    @env.update('SCRIPT_NAME' => '/test')
+  end
+end
+

data/test/modular_mapping_test.rb

@@ -0,0 +1,112 @@
+$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
+
+  include Rack::Test::Methods
+
+  def setup
+    @date = Date.today
+    @link_paths = {
+      :root_path    => "/test/blog",
+      :posts_path   => "/test/blog/articles",
+      :archive_path => "/test/blog/archive/articles",
+      :about_path   => "/test/blog/about",
+      :search_path  => "/test/blog/find-articles",
+      :drafts_path  => "/test/blog/unpublished"
+    }
+    @root_paths = @link_paths.inject({}) do |hash, (name, path)|
+      hash[name] = "#{path}/"
+      hash
+    end
+    @paths = @root_paths.inject({}) do |hash, (name, path)|
+      hash[name] = "#{path}?"
+      hash
+    end
+  end
+
+  def app
+    @app = ::ModularApplication
+    @app.set :environment, :test
+    @app
+  end
+
+  def test_check_map_locations
+    @paths.each do |name, location|
+      path = location.gsub(/\/test/,'')
+      assert_equal path, app.send(name)
+    end
+  end
+
+  def test_should_return_ok_in_root_path
+    get app.root_path do |response|
+      assert response.ok?
+      assert_equal "http://example.org#{@paths[:root_path]}", last_request.url
+      assert_equal "Blog path:#{@link_paths[:root_path]}", response.body
+    end
+  end
+
+  def test_should_return_ok_in_posts_path
+    get app.posts_path do |response|
+      assert response.ok?
+      assert_equal "http://example.org#{@paths[:posts_path]}", last_request.url
+      assert_equal "Articles published:#{@link_paths[:posts_path]}", response.body
+    end
+
+    path = app.posts_path "/#{@date.to_s.gsub('-','/')}/post-permalink"
+    get path do |response|
+      assert response.ok?
+      assert_equal "http://example.org/test#{path}", last_request.url
+      assert_equal "Articles:/test#{path}", response.body
+    end
+  end
+
+  def test_should_return_ok_in_archive_path
+    get app.archive_path do |response|
+      assert response.ok?
+      assert_equal "http://example.org#{@root_paths[:archive_path]}", last_request.url
+      assert_equal "Archive articles:#{@link_paths[:archive_path]}", response.body
+    end
+
+    path = app.archive_path "/#{@date.to_s.gsub('-','/')}/post-permalink"
+    get path do |response|
+      assert response.ok?
+      assert_equal "http://example.org/test#{path}", last_request.url
+      assert_equal "Archive articles:/test#{path}", response.body
+    end
+  end
+
+  def test_should_return_ok_in_about_path
+    get app.about_path do |response|
+      assert response.ok?
+      assert_equal "http://example.org#{@root_paths[:about_path]}", last_request.url
+      assert_equal "About:#{@link_paths[:about_path]}", response.body
+    end
+  end
+
+  def test_should_return_ok_in_search_path
+    get "#{app.search_path}?keywords=ruby" do |response|
+      assert response.ok?
+      assert_equal "http://example.org#{@paths[:search_path]}?keywords=ruby", last_request.url
+      assert_equal "Find articles:#{@paths[:search_path]}?keywords=ruby", response.body.split("\n")[0]
+      assert_equal "<a href=\"#{@paths[:search_path]}\" title=\"Search\">Search</a>", response.body.split("\n")[1]
+      assert_equal "<a href=\"#{@paths[:search_path]}?keywords=ruby\" title=\"Search\">Search</a>", response.body.split("\n")[2]
+    end
+  end
+
+  def test_should_check_path_method_with_array_params
+    get app.drafts_path do |response|
+      assert response.ok?
+      assert_equal "Unpublished:#{@link_paths[:drafts_path]}/articles".squeeze('/'), response.body.split("\n")[0]
+      body_link = "<a href=\"#{@link_paths[:drafts_path]}/articles\" title=\"Unpublished\">Unpublished</a>"
+      assert_equal body_link, response.body.split("\n")[1]
+    end
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra-mapping
 version: !ruby/object:Gem::Version 
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors: 
 - Hallison Batista
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-21 00:00:00 -04:00
+date: 2009-08-25 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -51,7 +51,9 @@ files:
 - lib/sinatra/mapping.rb
 - lib/sinatra/mapping_helpers.rb
 - sinatra-mapping.gemspec
-- test/mapping_test.rb
+- test/fixtures/modular_application.rb
+- test/helper.rb
+- test/modular_mapping_test.rb
 has_rdoc: true
 homepage: http://sinatra-mapping.rubyforge.org/
 licenses: []

data/test/mapping_test.rb

@@ -1,218 +0,0 @@
-$LOAD_PATH.unshift("#{File.dirname(__FILE__)}/..")
-
-require 'rubygems'
-require 'lib/sinatra/mapping'
-require 'lib/sinatra/mapping_helpers'
-require 'test/unit'
-require 'rack/test'
-require 'ruby-debug'
-
-class Sinatra::Base
-  def env
-    @env ||= { 'SCRIPT_NAME' => '/blog' }
-  end
-end
-
-class AppForTest < Sinatra::Base
-
-  register Sinatra::Mapping
-  helpers  Sinatra::MappingHelpers
-
-  map :root,  "blog"   # root_path    => /blog/
-  map :about           # about_path   => /blog/about
-
-  mapping :posts   => "articles",         # posts_path   => /blog/articles
-          :archive => "archive/articles", # archive_path => /blog/archive/articles
-          :search  => "find-articles",    # search_path  => /blog/find-articles
-          :drafts  => "unpublished"       # drafts_path  => /blog/unpublished
-
-  before do
-    @date = Date.today
-  end
-
-  get root_path do
-    "#{title_path :root, :path}:#{path_to :root}"
-  end
-
-  get posts_path do
-    "#{title_path :posts, :published}:#{path_to :posts}"
-  end
-
-  get posts_path "/" do
-    redirect path_to(:posts), 301
-  end
-
-  get posts_path "/:year/:month/:day/:permalink" do |year, month, day, permalink|
-    "#{title_path :posts}:" + path_to(:posts, "#{@date.to_s.gsub('-','/')}/#{permalink}")
-  end
-
-  get posts_path "/:year/:month/:day/:permalink/" do |year, month, day, permalink|
-    redirect path_to(:posts, year, month, day, permalink), 301
-  end
-
-  get archive_path do
-    "#{title_path :archive}:#{path_to :archive}"
-  end
-
-  get archive_path "/" do
-    redirect path_to(:archive), 301
-  end
-
-  get archive_path "/:year/:month/:day/:permalink" do |year, month, day, permalink|
-    "#{title_path :archive}:" + path_to(:archive, "#{@date.to_s.gsub('-','/')}/#{permalink}")
-  end
-
-  get archive_path "/:year/:month/:day/:permalink/" do |year, month, day, permalink|
-    redirect path_to(:archive, year, month, day, permalink), 301
-  end
-
-  get about_path do
-    "#{title_path :about}:#{path_to :about}"
-  end
-
-  get about_path "/" do
-    redirect path_to(:about), 301
-  end
-
-  get search_path do
-    <<-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'}
-    end_content
-  end
-
-  get drafts_path do
-    <<-end_content.gsub(/^      /,'')
-      #{title_path :drafts}:#{path_to [:drafts, :posts]}
-      #{link_to "Unpublished", :drafts, :posts, :title => 'Unpublished'}
-    end_content
-  end
-
-end
-
-class TestMapping < Test::Unit::TestCase
-
-  include Rack::Test::Methods
-
-  def setup
-    @date      = Date.today
-    @locations = {
-      :root_path    => "/",
-      :posts_path   => "/articles",
-      :archive_path => "/archive/articles",
-      :about_path   => "/about",
-      :search_path  => "/find-articles",
-      :drafts_path  => "/unpublished"
-    }
-  end
-
-  def app
-    @app = ::AppForTest
-    @app.set :environment, :test
-    @app
-  end
-
-  def test_check_map_locations
-    @locations.each do |name, location|
-      assert_equal "#{location}", app.send(name)
-    end
-  end
-
-  def test_should_return_ok_in_root_path
-    get app.root_path do |response|
-      assert response.ok?
-      assert_equal "http://example.org#{@locations[:root_path]}", last_request.url
-      assert_equal "Path:#{@locations[:root_path]}", response.body
-    end
-  end
-
-  def test_should_return_ok_in_posts_path
-    get app.posts_path do |response|
-      assert response.ok?
-      assert_equal "http://example.org#{@locations[:posts_path]}", last_request.url
-      assert_equal "Articles published:#{@locations[:posts_path]}", response.body
-    end
-
-    get app.posts_path "/" do
-      follow_redirect!
-      assert last_response.ok?
-      assert_equal "http://example.org#{@locations[:posts_path]}", last_request.url
-    end
-
-    path = app.posts_path "/#{@date.to_s.gsub('-','/')}/post-permalink"
-    get path do |response|
-      assert response.ok?
-      assert_equal "http://example.org#{path}", last_request.url
-      assert_equal "Articles:#{path}", response.body
-    end
-
-    get "#{path}/" do
-      follow_redirect!
-      assert last_response.ok?
-      assert_equal "http://example.org#{path}", last_request.url
-      assert_equal "Articles:#{path}", last_response.body
-    end
-  end
-
-  def test_should_return_ok_in_archive_path
-    get app.archive_path do |response|
-      assert response.ok?
-      assert_equal "http://example.org#{@locations[:archive_path]}", last_request.url
-      assert_equal "Archive articles:#{@locations[:archive_path]}", response.body
-    end
-
-    get app.archive_path "/" do
-      follow_redirect!
-      assert last_response.ok?
-      assert_equal "http://example.org#{@locations[:archive_path]}", last_request.url
-    end
-
-    path = app.archive_path "/#{@date.to_s.gsub('-','/')}/post-permalink"
-    get path do |response|
-      assert response.ok?
-      assert_equal "http://example.org#{path}", last_request.url
-      assert_equal "Archive articles:#{path}", response.body
-    end
-
-    get "#{path}/" do
-      follow_redirect!
-      assert last_response.ok?
-      assert_equal "http://example.org#{path}", last_request.url
-      assert_equal "Archive articles:#{path}", last_response.body
-    end
-  end
-
-  def test_should_return_ok_in_about_path
-    get app.about_path do |response|
-      assert response.ok?
-      assert_equal "http://example.org#{@locations[:about_path]}", last_request.url
-      assert_equal "About:#{@locations[:about_path]}", response.body
-    end
-
-    get app.about_path "/" do
-      follow_redirect!
-      assert last_response.ok?
-      assert_equal "http://example.org#{@locations[:about_path]}", last_request.url
-    end
-  end
-
-  def test_should_return_ok_in_search_path
-    get "#{app.search_path}?keywords=ruby" do |response|
-      assert response.ok?
-      assert_equal "http://example.org#{@locations[:search_path]}?keywords=ruby", last_request.url
-      assert_equal "Find articles:#{@locations[:search_path]}?keywords=ruby", response.body.split("\n")[0]
-      assert_equal "<a href=\"#{@locations[:search_path]}\" title=\"Search\">Search</a>", response.body.split("\n")[1]
-      assert_equal "<a href=\"#{@locations[:search_path]}?keywords=ruby\" title=\"Search\">Search</a>", response.body.split("\n")[2]
-    end
-  end
-
-  def test_should_check_path_method_with_array_params
-    get "#{app.drafts_path}" do |response|
-      assert response.ok?
-      assert_equal "Unpublished:#{@locations[:drafts_path]}#{@locations[:posts_path]}", response.body.split("\n")[0]
-      assert_equal "<a href=\"#{@locations[:drafts_path]}#{@locations[:posts_path]}\" title=\"Unpublished\">Unpublished</a>", response.body.split("\n")[1]
-    end
-  end
-end
-