url_mount 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+*.gem

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Daniel Neighman
+
+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.rdoc

@@ -0,0 +1,94 @@
+= UrlMount
+
+UrlMount is a universal mount point designed for use in rack applications.
+
+It provides a simple way to pass a url mounting point to the mounted application.
+
+This means that when you mount an application in the url space, it's a simple to_s to get the mount point of where the application is.
+
+== Example
+
+Say you mount an application at "/foo/bar"
+
+<pre><code>router.mount("/foo/bar").to(my_app)
+
+# behind the scenes, the routers mount method should do this:
+
+  if my_app.respond_to?(:url_mount=)
+    mount_point = UrlMount.new("/foo/bar")
+    my_app.url_mount = mount_point
+  end
+</code></pre>
+
+This means that if an application can handle a url_mount, you give it one.
+
+This then allows the +my_app+ applciation, to know where it's mounted.  Generating a url is now as simple as
+<pre><code>File.join(url_mount.to_s, "/local/url/path")</code></pre>
+
+The benefit of this is that all routers or applciations can make use of this.  If used, it can act as a universal glue between rack applications where parent apps can let the child applications know where they're mounted.
+
+=== Show me the code
+
+urlmount is made to be used with many routers that are currently available.
+
+<pre><code>
+# simple string mounting point
+mount = urlmount.new("/foo/bar")
+mount.to_s == "/foo/bar"
+
+# Mount Point including variables
+mount = UrlMount.new("/foo/:bar")
+mount.to_s(:bar => "something") == "/foo/something"
+mount.to_s #=> Raises UrlMount::Ungeneratable because a required variable was not found
+mount.required_variables == [:bar]
+
+# Mount Point including optional variables
+mount = UrlMount.new("/foo/:bar(/:baz)")
+mount.to_s(:bar => "doh") == "/foo/doh"
+mount.to_s(:bar => "doh", :baz => "hah") == "/foo/doh/hah"
+mount.required_variables == [:bar]
+mount.optional_variables == [:baz]
+
+# Mount Point with defaults
+mount = UrlMount.new("/foo/:bar(/:baz)", :bar => "default_bar")
+mount.to_s == "/foo/default_bar"
+mount.to_s(:baz => "baz_value") == "/foo/default_bar/baz_value"
+mount.to_s(:bar => "other_bar") == "/foo/other_bar"
+
+# Nested mounting point
+mount_parent = UrlMount.new("/foo/bar")
+mount_child  = UrlMount.new("/baz/:barry)
+
+mount_child.url_mount = mount_parent
+
+mount_parent.to_s == "/foo/bar"
+mount_child.to_s(:barry =>"barry_value") == "/foo/bar/baz/barry_value"
+</code></pre>
+
+Considering that UrlMounts can be nested, when you mount an application you should do it something like this.
+
+<pre><code>
+if mounted_app.respond_to?(:url_mount=)
+  mount = UrlMount.new(path, deafult_options)
+
+  # If this app is mounted, add this apps mount point to
+  # the mount point for the child app
+  mount.url_mount = self.url_mount if self.url_mount
+
+  mounted_app.url_mount = mount
+end
+</code></pre>
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Daniel Neighman. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "url_mount"
+    gem.summary = %Q{Universal mounting points for rack applications}
+    gem.description = %Q{Glue to allow mounted rack applications to know where they're mounted}
+    gem.email = "has.sox@gmail.com"
+    gem.homepage = "http://github.com/hassox/url_mount"
+    gem.authors = ["Daniel Neighman"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "url_mount #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/url_mount.rb

@@ -0,0 +1,160 @@
+class UrlMount
+  class Ungeneratable < StandardError; end
+  # Inspiration for this is taken straight from Usher.  http://github.com/joshbuddy/usher
+  DELIMETERS = ['/', '(', ')']
+
+  attr_accessor :raw_path, :options, :url_mount
+  alias_method :defaults, :options
+
+  def initialize(path, opts = {})
+    @raw_path, @options = path, opts
+    @url_split_regex = Regexp.new("[^#{DELIMETERS.collect{|d| Regexp.quote(d)}.join}]+|[#{DELIMETERS.collect{|d| Regexp.quote(d)}.join}]")
+  end
+
+  def local_segments
+    @local_segments || parse_local_segments
+  end
+
+  def required_variables
+    @required_variables ||= begin
+      required_variable_segments.map{|s| s.name}
+    end
+  end
+
+  def optional_variables
+    @optional_variables ||= begin
+      optional_variable_segments.map{|s| s.name}
+    end
+  end
+
+  def required_variable_segments
+    @required_variable_segments ||= begin
+      local_segments.map{|s| s.required_variable_segments}.flatten.compact
+    end
+  end
+
+  def optional_variable_segments
+    @optional_variable_segments ||= begin
+      local_segments.map{|s| s.optional_variable_segments}.flatten.compact
+    end
+  end
+
+  def variables
+    @variables ||= begin
+      {
+        :required => required_variables,
+        :optional => optional_variables
+      }
+    end
+  end
+
+  def to_s(opts = {})
+    opts = options.merge(opts)
+    requirements_met =  (required_variables - (opts.keys & required_variables)).empty?
+
+    raise Ungeneratable, "Missing required variables" unless requirements_met
+    File.join(local_segments.inject([]){|url, segment| str = segment.to_s(opts); url << str if str; url}) =~ /(.*?)\/?$/
+    result = $1
+    url_mount.nil? ? result : File.join(url_mount.to_s(opts), result)
+  end
+
+  private
+  def parse_local_segments
+    stack = []
+    @local_segments = []
+    buffer = ""
+    raw_path.scan(@url_split_regex).each do |segment|
+      case segment
+      when '/'
+        if stack.empty?
+          @local_segments << Segment::Delimeter.new
+        else
+          buffer << segment
+        end
+      when '('
+        buffer << '(' unless stack.empty?
+        stack << segment
+      when ')'
+        stack.pop
+        if stack.empty?
+          @local_segments << Segment::Conditional.new(buffer, options)
+          buffer = ""
+        else
+          buffer << ')'
+        end
+      when /^\:(.*)/
+        if stack.empty?
+          @local_segments << Segment::Variable.new($1, true, options)
+        else
+          buffer << segment
+        end
+      else
+        if stack.empty?
+          @local_segments << Segment::Static.new(segment)
+        else
+          buffer << segment
+        end
+      end
+    end
+    @local_segments
+  end
+
+  class Segment
+
+    class Base
+      attr_accessor :name
+
+      def required!; @required = true; end
+      def required?; !!@required; end
+
+      def optional_variable_segments; []; end
+      def required_variable_segments; []; end
+    end
+
+    class Delimeter < Base
+      def to_s(opts = {}); "/"; end
+    end
+
+    class Static < Base
+      def initialize(name); @name = name; end
+      def to_s(opts = {}); @name; end
+    end
+
+    class Variable < Base
+      def initialize(name, required, options)
+        @name, @required = name.to_sym, true
+      end
+
+      def optional_variable_segments
+        []
+      end
+
+      def required_variable_segments
+        [self]
+      end
+
+      def to_s(opts = {})
+        opts[name]
+      end
+    end
+
+    class Conditional < Base
+      attr_reader :segments
+      def initialize(path, options)
+        @url_mount = UrlMount.new(path, options)
+      end
+
+      def optional_variable_segments
+        (@url_mount.required_variable_segments + @url_mount.optional_variable_segments).map{|s| s.name}
+      end
+
+      def required_variable_segments; []; end
+
+      def to_s(opts = {})
+        if (opts.keys & @url_mount.required_variables) == @url_mount.required_variables
+          @url_mount.to_s(opts)
+        end
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'url_mount'
+
+class Test::Unit::TestCase
+end

data/test/test_url_mount.rb

@@ -0,0 +1,126 @@
+require 'helper'
+
+class TestUrlMount < Test::Unit::TestCase
+  should "initialize with a path and options" do
+    u = UrlMount.new("/some/path", :some => "options")
+    assert_equal u.raw_path, "/some/path"
+    assert_equal u.options,  :some => "options"
+    assert_equal({:some => "options"}, u.defaults)
+  end
+
+
+  context "required variables" do
+    should "calculate the required variables of the mount as an emtpy array when there are none" do
+      u = UrlMount.new("/foo")
+      assert_equal [], u.required_variables
+    end
+
+    should "calculate the required variables as part of the variables when there are none" do
+      u = UrlMount.new("/foo")
+      assert_equal( {:required => [], :optional => []}, u.variables )
+    end
+
+    should "calculate the required variables when there are some" do
+      u = UrlMount.new("/foo/:bar/baz/:homer")
+      assert_equal [:bar, :homer], u.required_variables
+      assert_equal( {:required => [:bar, :homer], :optional => []}, u.variables )
+    end
+
+    should "generate a static url mount" do
+      u = UrlMount.new("/foo/bar")
+      assert_equal "/foo/bar", u.to_s
+    end
+
+    should "generate a dynamic url with static and variable segments" do
+      u = UrlMount.new("/foo/:bar/baz/:barry")
+      assert_equal "/foo/bar/baz/sue", u.to_s(:bar => "bar", :barry => "sue")
+    end
+
+    should "raise an exception when a required variable is missing" do
+      u = UrlMount.new("/foo/:bar/:baz")
+      assert_raises UrlMount::Ungeneratable do
+        u.to_s(:bar => "baz")
+      end
+    end
+  end
+
+  context "optional variables" do
+    should "calculate the optional varialbles of the mount as an emtpy array when there are none" do
+      u = UrlMount.new("/foo/bar")
+      assert_equal [], u.optional_variables
+    end
+
+    should "calculate optional variables when there are some" do
+      u = UrlMount.new("/foo(/:bar(/:baz))")
+      assert_equal [:bar, :baz], u.optional_variables
+    end
+
+    should "calculate optional variables when there are some" do
+      u = UrlMount.new("/foo(/:bar(/:baz))")
+      assert_equal "/foo/gary", u.to_s(:bar => "gary")
+    end
+
+    should "skip nested optional variables when the optional parent is not present" do
+      u = UrlMount.new("/foo(/:bar(/:baz))")
+      assert_equal "/foo", u.to_s(:baz => "sue")
+    end
+  end
+
+  context "default variables" do
+    should "generate a simple url with a variable with a default" do
+      u = UrlMount.new("/foo/:bar", :bar => "default")
+      assert_equal "/foo/default", u.to_s
+    end
+
+    should "generate urls with multiple varilables using defaults" do
+      u = UrlMount.new("/foo/:bar/:baz", :bar => "bar", :baz => "baz")
+      assert_equal "/foo/bar/baz", u.to_s
+    end
+
+    should "generate urls with optional variables" do
+      u = UrlMount.new("/foo(/:bar)", :bar => "bar")
+      assert_equal "/foo/bar", u.to_s
+    end
+
+    should "generate urls with mixed variables" do
+      u = UrlMount.new("/foo/:bar(/:baz(/:barry))", :barry => "bazz", :bar => "clue")
+      assert_equal "/foo/clue", u.to_s
+      assert_equal "/foo/clue/sue/bazz", u.to_s(:baz => "sue")
+    end
+
+    should "generate urls with overwritten defaults" do
+      u = UrlMount.new("/foo/:bar(/:baz)", :bar => "barr", :baz => "bazz")
+      assert_equal "/foo/sue/larry",  u.to_s(:bar => "sue", :baz => "larry")
+      assert_equal "/foo/barr/gary",  u.to_s(:baz => "gary")
+      assert_equal "/foo/harry/bazz", u.to_s(:bar => "harry")
+    end
+  end
+
+  context "complex compound urls" do
+    should "generate complex urls containing multiple nested conditionals and multiple required variables" do
+      u = UrlMount.new("/foo(/:bar(/:baz))/:gary")
+      assert_equal "/foo/gary",           u.to_s(:gary => "gary")
+      assert_equal "/foo/bar/gary",       u.to_s(:gary => "gary", :bar => "bar")
+      assert_equal "/foo/bar/baz/gary",   u.to_s(:gary => "gary", :bar => "bar", :baz => "baz")
+      assert_raises UrlMount::Ungeneratable do
+        u.to_s(:bar => "bar")
+      end
+    end
+  end
+
+  context "nested url mounts" do
+    should "allow a mount to accept a mount" do
+      u1 = UrlMount.new("/root/:bar")
+      u2 = UrlMount.new("/baz/barry")
+      u1.url_mount = u2
+    end
+
+    should "generate the mount" do
+      u1 = UrlMount.new("/root/bar")
+      u2 = UrlMount.new("/baz/barry")
+      u1.url_mount = u2
+      assert "/root/bar", u1.to_s
+      assert "/root/bar/baz/barry", u2.to_s
+    end
+  end
+end

data/url_mount.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{url_mount}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Daniel Neighman"]
+  s.date = %q{2010-02-18}
+  s.description = %q{Glue to allow mounted rack applications to know where they're mounted}
+  s.email = %q{has.sox@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/url_mount.rb",
+     "test/helper.rb",
+     "test/test_url_mount.rb",
+     "url_mount.gemspec"
+  ]
+  s.homepage = %q{http://github.com/hassox/url_mount}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Universal mounting points for rack applications}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_url_mount.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: url_mount
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Daniel Neighman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-18 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Glue to allow mounted rack applications to know where they're mounted
+email: has.sox@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/url_mount.rb
+- test/helper.rb
+- test/test_url_mount.rb
+- url_mount.gemspec
+has_rdoc: true
+homepage: http://github.com/hassox/url_mount
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Universal mounting points for rack applications
+test_files: 
+- test/helper.rb
+- test/test_url_mount.rb