sinatra-mapping 0.1.0 → 0.1.1

data/CHANGES

@@ -1,5 +1,10 @@
 = Changes
 
+[0.1.1 - July 2009]
+  * New helper methods have been added.
+
+  * Improvements in map method.
+
 [0.1.0 - July 2009]
   * This version has been extracted from
     {Postview}[http://postview.rubyforge.org] project.

data/README

@@ -1,4 +1,10 @@
-= Sinatra Mapping - Map easily URLs paths
+= Sinatra::Mapping - Map easily URLs paths
+
+
+* {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]
 
 {Sinatra}[http://www.sinatrarb.com]
 {mapping extension}[http://sinatra-mapping.rubyforge.org] is a minimal
@@ -10,7 +16,7 @@ Install stable version gem:
 
 Or, install development version gem:
 
-  gem install sinatra-mapping --source http://gems.github.com
+  gem install hallison-sinatra-mapping --source http://gems.github.com
 
 == Getting start
 
@@ -31,31 +37,31 @@ Example:
 
     get root_path do
       # /blog/
-      # do anything for root path.
+      # do something for root path.
     end
 
     get posts_path do
       # /blog/articles
-      # do anything for posts path.
+      # do something for posts path.
     end
 
     get posts_path(":year/:month/:day/:permalink") do |year, month, day, permalink|
       # /blog/articles/2009/10/08/permalink-for-your-article
-      # do anything for posts path using parameters for find a post.
+      # do something for posts path using parameters for find a post.
     end
 
     get tags_path do
       # /blog/labels
-      # do anything for tags path.
+      # do something for tags path.
     end
 
     get archive_path do
-      # do anything for archive path.
+      # do something for archive path.
     end
 
     get archive_path(":year/:month/:day/:permalink") do |year, month, day, permalink|
       # /blog/archived-articles/1978/10/08/permalink-for-your-article
-      # do anything for archive path using parameters for find a post.
+      # do something for archive path using parameters for find a post.
     end
 
   end
@@ -64,8 +70,8 @@ Easy!!!
 
 == More informations
 
-* See {changes}[:link:CHANGES.html] for understand the goals of which
-  release
+* See the {changes}[:link:CHANGES.html] for understand the goals of
+  that release version.
 * {License}[:link:LICENSE.html]
 
 == Copyright

data/Rakefile

@@ -7,25 +7,23 @@ load    'sinatra-mapping.gemspec'
 desc "Generate version for release and tagging."
 task :version, [:major, :minor, :patch, :release, :date, :cycle] do |taskspec, version|
   require 'parsedate'
-  current      = YAML.load_file(taskspec.name.upcase)
+  current      = YAML.load_file(taskspec.name.upcase) || {}
   version_date = Date.new(*ParseDate.parsedate(version[:date] || current[:date].to_s).compact) unless version or current
-  if current and version_date
-    newer        = {
-      :major   => version[:major].to_i   || current[:major].to_i,
-      :minor   => version[:minor].to_i   || current[:minor].to_i,
-      :patch   => version[:patch].to_i   || current[:patch].to_i,
-      :release => version[:release].to_s.empty? ? nil : version[:release].to_i,
-      :date    => version_date           || Date.today,
-      :cycle   => version[:cycle]        || current[:cycle]
-    }
+  newer        = {
+    :major   => version[:major].to_i   || current[:major].to_i,
+    :minor   => version[:minor].to_i   || current[:minor].to_i,
+    :patch   => version[:patch].to_i   || current[:patch].to_i,
+    :release => version[:release].to_s.empty? ? nil : version[:release].to_i,
+    :date    => version_date           || Date.today,
+    :cycle   => version[:cycle]        || current[:cycle]
+  }
 
-    newer.merge(current) do |key, new_value, current_value|
-      new_value || current_value
-    end
+  newer.merge(current) do |key, new_value, current_value|
+    new_value || current_value
+  end
 
-    File.open(taskspec.name.upcase, "w") do |version_file|
-      version_file << newer.to_yaml
-    end
+  File.open(taskspec.name.upcase, "w") do |version_file|
+    version_file << newer.to_yaml
   end
 end
 
@@ -36,7 +34,7 @@ Rake::GemPackageTask.new(@spec) do |pkg|
 end
 
 Rake::RDocTask.new("doc") do |rdoc|
-  rdoc.title    = "Sinatra - Mapping"
+  rdoc.title    = "Sinatra::Mapping"
   rdoc.main     = "README"
   rdoc.options  = [ '-SHN', '-f', 'darkfish' ]
   rdoc.rdoc_dir = 'doc'

data/VERSION

@@ -1,7 +1,7 @@
 --- 
 :release: 
-:date: 2009-07-15
+:date: 2009-07-17
 :cycle: Development version, pre-alpha
 :major: 0
 :minor: 1
-:patch: 0
+:patch: 1

data/lib/sinatra/mapping.rb

@@ -20,26 +20,34 @@ module Sinatra
     #   map :root,    "tasks"       # => /tasks/
     #   map :changes, "last-changes # => /tasks/last-changes
     def map(name, path = nil)
-      @root_path ||= ""
       @locations ||= {}
       if name.to_sym == :root
-        @root_path = cleanup_paths("/#{path}/")
+        @locations[:root] = cleanup_paths("/#{path}/")
         metadef "#{name}_path" do |*paths|
-          @root_path
+          @locations[:root]
         end
       else
         @locations[name.to_sym] = path || name.to_s
         metadef "#{name}_path" do |*paths|
-          path_to(@locations[name.to_sym], *paths)
+          map_path_to(@locations[name.to_sym], *paths)
         end
       end
     end
 
+    # Returns URL path with query instructions.
+    def query_path_to(*args)
+      args.compact!
+      query  = args.pop if args.last.kind_of?(Hash)
+      path   = map_path_to(*args)
+      path  << "?" << Rack::Utils::build_query(query) if query
+      path
+    end
+
   private
 
     # Check arguments. If argument is a symbol and exist map path before
     # setted, then return path mapped by symbol name.
-    def path_to(*args)
+    def map_path_to(*args)
       path_mapped(*locations_get_from(*args))
     end
 
@@ -50,7 +58,6 @@ module Sinatra
 
     # Get paths from location maps.
     def locations_get_from(*args)
-      args.delete(:root)
       args.collect do |path|
         @locations.has_key?(path) ? @locations[path] : path
       end
@@ -67,17 +74,3 @@ module Sinatra
 
 end # module Sinatra
 
-#  private
-#
-#    attr_reader   :root
-#    attr_accessor :locations
-#
-#    def root_set_to(path)
-#      @root = path_clean("/#{path}/")
-#    end
-#    alias :root= :root_set_to
-#
-#
-#  private
-#
-#

data/lib/sinatra/mapping_helpers.rb

@@ -1,17 +1,33 @@
 module Sinatra
 
-  # This module contains several helper methods for maps written using
+  # This module contains several helper methods for paths written using 
   # {map}[:link:./Sinatra/Mapping.html#map] method.
+  #
+  # For use this helper, add the following syntax in application source:
+  #
+  #   register Sinatra::MappingHelpers
   module MappingHelpers
 
-    # Create title using a path mapped. Other else, return just arguments
-    # joined by spaces and capitalise.
+    # Creates a title using a path mapped. Otherwise, returns just arguments
+    # joined by spaces and capitalised.
     def title_path(path, *args)
       title = (options.send("#{path}_path") || path).to_s.gsub('/',' ').strip
       title.gsub!(/\W/,' ') # Cleanup
       (args.empty? ? title : "#{title} #{args.join(' ')}").capitalize
     end
 
+    # Returns all paths with query parameters. Example:
+    #
+    #   # in Sinatra application:
+    #   map :post, "articles"
+    #   map :tags, "labels"
+    #   # use the following instructions:
+    #   path_to :tags, "ruby", :posts
+    #   # returns "/labels/ruby/articles"
+    def path_to(*args)
+      options.query_path_to(*args)
+    end
+
   end # module MapHelpers
 
 end # module Sinatra

data/test/test_mapping.rb

@@ -10,60 +10,61 @@ require 'ruby-debug'
 class AppForTest < Sinatra::Base
 
   register Sinatra::Mapping
+  helpers  Sinatra::MappingHelpers
 
   map :root                        # root_path    => /
   map :posts,   "articles"         # posts_path   => /articles
-  map :archive, "archive/articles" # archive_path => /articles/archive
+  map :archive, "archive/articles" # archive_path => /archive/articles
   map :about                       # about_path   => /about
 
-  helpers Sinatra::MappingHelpers
+  #mapping YAML.load_file("#{File.dirname(__FILE__)}/fixtures.yml")
 
   before do
     @date = Date.today
   end
 
   get root_path do
-    "#{title_path :root}:#{options.root_path}"
+    "#{title_path :root}:#{path_to :root}"
   end
 
   get posts_path do
-    "#{title_path :posts}:#{options.posts_path}"
+    "#{title_path :posts}:#{path_to :posts}"
   end
 
   get posts_path "/" do
-    redirect options.posts_path, 301
+    redirect path_to(:posts), 301
   end
 
   get posts_path "/:year/:month/:day/:permalink" do |year, month, day, permalink|
-    "#{title_path :posts}:" + options.posts_path("#{@date.to_s.gsub('-','/')}/#{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 options.posts_path(year, month, day, permalink), 301
+    redirect path_to(:posts, year, month, day, permalink), 301
   end
 
   get archive_path do
-    "#{title_path :archive}:#{options.archive_path}"
+    "#{title_path :archive}:#{path_to :archive}"
   end
 
   get archive_path "/" do
-    redirect options.archive_path, 301
+    redirect path_to(:archive), 301
   end
 
   get archive_path "/:year/:month/:day/:permalink" do |year, month, day, permalink|
-    "#{title_path :archive}:" + options.archive_path("#{@date.to_s.gsub('-','/')}/#{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 options.archive_path(year, month, day, permalink), 301
+    redirect path_to(:archive, year, month, day, permalink), 301
   end
 
   get about_path do
-    "#{title_path :about}:#{options.about_path}"
+    "#{title_path :about}:#{path_to :about}"
   end
 
   get about_path "/" do
-    redirect options.about_path, 301
+    redirect path_to(:about), 301
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra-mapping
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Hallison Batista
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-15 00:00:00 -04:00
+date: 2009-07-17 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency