sinatra-mapping 0.1.0

data/CHANGES

@@ -0,0 +1,8 @@
+= Changes
+
+[0.1.0 - July 2009]
+  * This version has been extracted from
+    {Postview}[http://postview.rubyforge.org] project.
+
+  * Add first methods for build maps in base application.
+

data/INFO

@@ -0,0 +1,14 @@
+:name: sinatra-mapping
+:summary:
+  Sinatra mapping extension for web application.
+:description:
+  Sinatra mapping extension is a minimal module that is useful for create
+  map names for Sinatra web application.
+:authors:
+  - Hallison Batista
+:email: email@hallisonbatista.com
+:homepage: http://sinatra-mapping.rubyforge.org/
+:dependencies:
+  rack: >= 1.0.0
+  sinatra: >= 0.9.2
+

data/LICENSE

@@ -0,0 +1,21 @@
+= The MIT License
+
+Copyright (c) 2009 Hallison Batista
+
+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

@@ -0,0 +1,74 @@
+= Sinatra Mapping - Map easily URLs paths
+
+{Sinatra}[http://www.sinatrarb.com]
+{mapping extension}[http://sinatra-mapping.rubyforge.org] is a minimal
+module that is useful for create map names for Sinatra web application.
+
+Install stable version gem:
+
+  gem install sinatra-mapping
+
+Or, install development version gem:
+
+  gem install sinatra-mapping --source http://gems.github.com
+
+== Getting start
+
+Use extension using registered method in main source of application.
+Example:
+
+  require 'sinatra'
+  require 'sinatra/mapping'
+
+  class BlogAppication < Sinatra::Base
+
+    register Sinatra::Mapping
+
+    map :root,    "blog"              # => /blog/
+    map :posts,   "articles"          # => /blog/articles
+    map :tags,    "labels"            # => /blog/labels
+    map :archive, "archived-articles" # => /blog/archived-articles
+
+    get root_path do
+      # /blog/
+      # do anything for root path.
+    end
+
+    get posts_path do
+      # /blog/articles
+      # do anything 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.
+    end
+
+    get tags_path do
+      # /blog/labels
+      # do anything for tags path.
+    end
+
+    get archive_path do
+      # do anything 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.
+    end
+
+  end
+
+Easy!!!
+
+== More informations
+
+* See {changes}[:link:CHANGES.html] for understand the goals of which
+  release
+* {License}[:link:LICENSE.html]
+
+== Copyright
+
+Copyright (c) 2009 Hallison Batista
+

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rdoc'
+require 'rake/testtask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+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)
+  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.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
+  end
+end
+
+Rake::TestTask.new
+
+Rake::GemPackageTask.new(@spec) do |pkg|
+  pkg.need_tar_bz2 = true
+end
+
+Rake::RDocTask.new("doc") do |rdoc|
+  rdoc.title    = "Sinatra - Mapping"
+  rdoc.main     = "README"
+  rdoc.options  = [ '-SHN', '-f', 'darkfish' ]
+  rdoc.rdoc_dir = 'doc'
+  rdoc.rdoc_files.include(
+    "CHANGES",
+    "LICENSE",
+    "README",
+    "lib/**/*.rb"
+  )
+end
+

data/VERSION

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

data/lib/sinatra/mapping.rb

@@ -0,0 +1,83 @@
+require 'sinatra/base'
+
+# Informations about Sinatra DSL, please, visit the
+# {official site}[http://www.sinatrarb.com/].
+module Sinatra
+
+  # This extension is useful for any Web application written using
+  # Sinatra DSL. The main goal is help developers to write URL path
+  # methods.
+  module Mapping
+
+    # Write URL path method for use in HTTP methods.
+    #
+    # The map method most be used by following syntax:
+    #
+    #   map <name>, <path>
+    #
+    # If name is equal :root, then returns path ended by slash "/".
+    #
+    #   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}/")
+        metadef "#{name}_path" do |*paths|
+          @root_path
+        end
+      else
+        @locations[name.to_sym] = path || name.to_s
+        metadef "#{name}_path" do |*paths|
+          path_to(@locations[name.to_sym], *paths)
+        end
+      end
+    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)
+      path_mapped(*locations_get_from(*args))
+    end
+
+    # Returns all paths mapped by root path in prefix.
+    def path_mapped(*args)
+      !args.empty? ? cleanup_paths("/#{@root_path}/#{args.join('/')}") : @root_root
+    end
+
+    # 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
+    end
+
+    # Clean all duplicated slashes.
+    def cleanup_paths(*paths)
+      paths.join('/').gsub(/[\/]{2,}/,'/')
+    end
+
+  end # module Mapping
+
+  register Mapping
+
+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

@@ -0,0 +1,18 @@
+module Sinatra
+
+  # This module contains several helper methods for maps written using
+  # {map}[:link:./Sinatra/Mapping.html#map] method.
+  module MappingHelpers
+
+    # Create title using a path mapped. Other else, return just arguments
+    # joined by spaces and capitalise.
+    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
+
+  end # module MapHelpers
+
+end # module Sinatra
+

data/sinatra-mapping.gemspec

@@ -0,0 +1,28 @@
+@version  = YAML.load_file("VERSION")
+@info     = YAML.load_file("INFO")
+@manifest = `git ls-files`.split.sort.reject{ |out| out =~ /^\./ || out =~ /^doc/ }
+@spec     = Gem::Specification.new do |gemspec|
+  gemspec.platform = Gem::Platform::RUBY
+  gemspec.version  = [ @version[:major], @version[:minor], @version[:patch], @version[:release] ].compact.join('.')
+  gemspec.date     = @version[:date]
+
+  @info.each do |info, value|
+    gemspec.send("#{info}=", value) if gemspec.respond_to? "#{info}="
+  end
+
+  @info[:dependencies].each do |name, version|
+    gemspec.add_dependency name, version
+  end
+
+  gemspec.require_paths = %w[lib]
+  gemspec.files = @manifest
+  gemspec.test_files = gemspec.files.select{ |path| path =~ /^test\/test_.*.rb/ }
+
+  gemspec.has_rdoc = true
+  gemspec.extra_rdoc_files = %w[README LICENSE]
+
+  gemspec.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Sinatra - Mapping", "--main", "README"]
+  gemspec.rubyforge_project = gemspec.name
+  gemspec.rubygems_version = "1.3.3"
+end if @version || @info # Gem::Specification
+

data/test/test_mapping.rb

@@ -0,0 +1,175 @@
+$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 AppForTest < Sinatra::Base
+
+  register Sinatra::Mapping
+
+  map :root                        # root_path    => /
+  map :posts,   "articles"         # posts_path   => /articles
+  map :archive, "archive/articles" # archive_path => /articles/archive
+  map :about                       # about_path   => /about
+
+  helpers Sinatra::MappingHelpers
+
+  before do
+    @date = Date.today
+  end
+
+  get root_path do
+    "#{title_path :root}:#{options.root_path}"
+  end
+
+  get posts_path do
+    "#{title_path :posts}:#{options.posts_path}"
+  end
+
+  get posts_path "/" do
+    redirect options.posts_path, 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}")
+  end
+
+  get posts_path "/:year/:month/:day/:permalink/" do |year, month, day, permalink|
+    redirect options.posts_path(year, month, day, permalink), 301
+  end
+
+  get archive_path do
+    "#{title_path :archive}:#{options.archive_path}"
+  end
+
+  get archive_path "/" do
+    redirect options.archive_path, 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}")
+  end
+
+  get archive_path "/:year/:month/:day/:permalink/" do |year, month, day, permalink|
+    redirect options.archive_path(year, month, day, permalink), 301
+  end
+
+  get about_path do
+    "#{title_path :about}:#{options.about_path}"
+  end
+
+  get about_path "/" do
+    redirect options.about_path, 301
+  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"
+    }
+  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 "#{@locations[:root_path]}" do |response|
+      assert response.ok?
+      assert_equal "http://example.org#{@locations[:root_path]}", last_request.url
+      assert_equal ":#{@locations[:root_path]}", response.body
+    end
+  end
+
+  def test_should_return_ok_in_posts_path
+    get "#{@locations[:posts_path]}" do |response|
+      assert response.ok?
+      assert_equal "http://example.org#{@locations[:posts_path]}", last_request.url
+      assert_equal "Articles:#{@locations[:posts_path]}", response.body
+    end
+
+    get "#{@locations[:posts_path]}/" do
+      follow_redirect!
+      assert last_response.ok?
+      assert_equal "http://example.org#{@locations[:posts_path]}", last_request.url
+    end
+
+    path = "#{@locations[: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 "#{@locations[: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 "#{@locations[:archive_path]}/" do
+      follow_redirect!
+      assert last_response.ok?
+      assert_equal "http://example.org#{@locations[:archive_path]}", last_request.url
+    end
+
+    path = "#{@locations[: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 "#{@locations[: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 "#{@locations[:about_path]}/" do
+      follow_redirect!
+      assert last_response.ok?
+      assert_equal "http://example.org#{@locations[:about_path]}", last_request.url
+    end
+  end
+end
+

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: sinatra-mapping
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Hallison Batista
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-15 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: 1.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.2
+    version: 
+description: Sinatra mapping extension is a minimal module that is useful for create map names for Sinatra web application.
+email: email@hallisonbatista.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+files: 
+- CHANGES
+- INFO
+- LICENSE
+- README
+- Rakefile
+- VERSION
+- lib/sinatra/mapping.rb
+- lib/sinatra/mapping_helpers.rb
+- sinatra-mapping.gemspec
+- test/test_mapping.rb
+has_rdoc: true
+homepage: http://sinatra-mapping.rubyforge.org/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Sinatra - Mapping
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: sinatra-mapping
+rubygems_version: 1.3.3
+signing_key: 
+specification_version: 3
+summary: Sinatra mapping extension for web application.
+test_files: 
+- test/test_mapping.rb