rory 0.3.10 → 0.3.11

data/lib/rory.rb

@@ -4,6 +4,7 @@ require 'yaml'
 require 'sequel'
 require 'rory/application'
 require 'rory/dispatcher'
+require 'rory/route'
 require 'rory/support'
 require 'rory/controller'
 

data/lib/rory/controller.rb

@@ -1,9 +1,12 @@
-require_relative 'renderer'
+require 'rory/renderer'
+require 'rory/path_generation'
 
 module Rory
   # Interface for Controller class.  Subclass this to create controllers
   # with actions that will be called by the Dispatcher when a route matches.
   class Controller
+    include PathGeneration
+
     attr_accessor :locals
 
     def initialize(request, routing, app = nil)
@@ -27,19 +30,23 @@ module Rory
     end
 
     def route_template
-      "#{@route[:controller]}/#{@route[:action]}"
+      "#{@route.controller}/#{@route.action}"
     end
 
     def layout
       nil
     end
 
+    def base_path
+      @request.script_name
+    end
+
     def default_renderer_options
       {
         :layout => layout,
         :locals => locals,
         :app => @app,
-        :base_url => @request.script_name
+        :base_path => base_path
       }
     end
 
@@ -69,7 +76,7 @@ module Rory
 
     def present
       # if a method exists on the controller for the requested action, call it.
-      action = @route[:action]
+      action = @route.action
       before_action
       self.send(action) if self.respond_to?(action)
       after_action

data/lib/rory/dispatcher.rb

@@ -21,16 +21,6 @@ module Rory
       end
     end
 
-    def method
-      override_method = @request.params.delete('_method')
-      method = if override_method && ['put', 'patch', 'delete'].include?(override_method.downcase)
-        override_method
-      else
-        @request.request_method
-      end
-      method.downcase
-    end
-
     def redirect(path = '/')
       unless path =~ /\:\/\//
         path = "#{@request.scheme}://#{@request.host_with_port}#{path}"
@@ -53,30 +43,25 @@ module Rory
 
     def controller_class
       if route
-        controller_name = Rory::Support.camelize("#{route[:controller]}_controller")
-        if route[:module]
-          controller_name.prepend "#{Rory::Support.camelize("#{route[:module]}")}/"
+        controller_name = Rory::Support.camelize("#{route.controller}_controller")
+        if route.module
+          controller_name.prepend "#{Rory::Support.camelize("#{route.module}")}/"
         end
         Rory::Support.constantize(controller_name)
       end
     end
 
     def get_route
-      match = nil
-      mapped_route = route_map.detect do |route_hash|
-        path_name = @request.path_info[1..-1] || ''
-        match = route_hash[:regex].match(path_name)
-        methods = route_hash[:methods] || []
-        match && (methods.empty? || methods.include?(method.to_sym))
+      mapped_route = all_routes.detect do |route|
+        route.matches_request?(@request)
       end
       if mapped_route
-        symbolized_param_names = match.names.map { |name| name.to_sym }
-        @request.params.merge! Hash[symbolized_param_names.zip(match.captures)]
+        @request.params.merge! mapped_route.path_params(@request)
       end
       mapped_route
     end
 
-    def route_map
+    def all_routes
       @app ? @app.routes : []
     end
   end

data/lib/rory/path_generation.rb

@@ -0,0 +1,13 @@
+module Rory
+  module PathGeneration
+    def path_to(route_name, fields = {})
+      if route = @app.routes.detect { |r| r.name == route_name }
+        path = route.mask.dup.prepend('/').prepend(base_path.to_s)
+        fields.each do |key, value|
+          path.gsub!(/\:#{key}/, value.to_s)
+        end
+        path
+      end
+    end
+  end
+end

data/lib/rory/renderer/context.rb

@@ -1,14 +1,17 @@
+require 'rory/path_generation'
+
 module Rory
   class Renderer
     class Context
-      attr_reader :base_url
+      include Rory::PathGeneration
+      attr_reader :base_path
 
       def initialize(options = {})
         (options[:locals] || {}).each do |key, value|
           singleton_class.send(:define_method, key) { value }
         end
         @app = options[:app]
-        @base_url = options[:base_url]
+        @base_path = options[:base_path]
       end
 
       def get_binding
@@ -16,7 +19,7 @@ module Rory
       end
 
       def render(template_name, opts = {})
-        opts = { :layout => false, :app => @app, :base_url => @base_url }.merge(opts)
+        opts = { :layout => false, :app => @app, :base_path => @base_path }.merge(opts)
         renderer = Rory::Renderer.new(template_name, opts)
         renderer.render
       end

data/lib/rory/route.rb

@@ -0,0 +1,66 @@
+module Rory
+  class Route
+    attr_reader :controller, :action, :mask
+
+    def initialize(mask, options = {})
+      @mask = mask.gsub(/^\//, '')
+      @options = options
+      @controller, @action = options[:to].split('#')
+    end
+
+    def name
+      "#{controller}_#{action}"
+    end
+
+    def ==(other)
+      to_h == other.to_h
+    end
+
+    def regex
+      /^#{@mask.gsub(/:([\w_]+)/, "(?<\\1>\[\^\\\/\]+)")}$/
+    end
+
+    def module
+      @options[:module]
+    end
+
+    def methods
+      @options[:methods] || []
+    end
+
+    def matches_request?(request)
+      @match = regex.match(request.path_info[1..-1] || '')
+      @match &&
+        (methods.empty? ||
+          methods.include?(method_from_request(request).to_sym))
+    end
+
+    def path_params(request)
+      @match ||= regex.match(request.path_info[1..-1] || '')
+      symbolized_param_names = @match.names.map { |name| name.to_sym }
+      Hash[symbolized_param_names.zip(@match.captures)]
+    end
+
+    def to_h
+      {
+        :mask => @mask,
+        :controller => @controller,
+        :action => @action,
+        :module => @module,
+        :methods => @methods
+      }
+    end
+
+  private
+
+    def method_from_request(request)
+      override_method = request.params.delete('_method')
+      method = if override_method && ['put', 'patch', 'delete'].include?(override_method.downcase)
+        override_method
+      else
+        request.request_method
+      end
+      method.downcase
+    end
+  end
+end

data/lib/rory/route_mapper.rb

@@ -29,17 +29,7 @@ module Rory
     def match(mask, options = {})
       options.merge!(@scope_options)
       options[:to] ||= mask.split('/').first
-      mask.gsub!(/^\//, '')
-      regex = /^#{mask.gsub(/:([\w_]+)/, "(?<\\1>\[\^\\\/\]+)")}$/
-      controller, action = options[:to].split('#')
-      route = {
-        :controller => controller,
-        :action => action,
-        :regex => regex
-      }
-      route[:module] = options[:module] if options[:module]
-      route[:methods] = options[:methods] if options[:methods]
-      @routes << route
+      @routes << Route.new(mask, options)
     end
   end
 end

data/lib/rory/version.rb

@@ -1,3 +1,3 @@
 module Rory
-  VERSION = '0.3.10'
+  VERSION = '0.3.11'
 end

data/spec/fixture_app/config/routes.rb

@@ -1,6 +1,6 @@
 Fixture::Application.set_routes do
   match 'foo/:id/bar', :to => 'foo#bar', :methods => [:get, :post]
-  match '/foo', :to => 'monkeys', :methods => [:put]
+  match '/foo', :to => 'monkeys', :methods => [:delete]
   match 'this/:path/is/:very_awesome', :to => 'awesome#rad'
   scope :module => 'goose' do
     match 'lumpies/:lump', :to => 'lumpies#show', :methods => [:get]

data/spec/fixture_app/views/test/a_link.html.erb

@@ -1 +1 @@
-You came from <%= base_url %>.
+You came from <%= base_path %>.

data/spec/lib/rory/application_spec.rb

@@ -66,19 +66,16 @@ describe Rory::Application do
   end
 
   describe ".routes" do
-    it "generates a routing table from route configuration" do
-      # note: we're comparing the inspected arrays here because the arrays
-      # won't be equal, despite appearing the same - this is because the Regexes
-      # are different objects.
-      Fixture::Application.routes.inspect.should == [
-        { :controller => 'foo', :action => 'bar', :regex => /^foo\/(?<id>[^\/]+)\/bar$/, :methods => [:get, :post] },
-        { :controller => 'monkeys', :action => nil, :regex => /^foo$/, :methods => [:put] },
-        { :controller => 'awesome', :action => 'rad', :regex => /^this\/(?<path>[^\/]+)\/is\/(?<very_awesome>[^\/]+)$/},
-        { :controller => 'lumpies', :action => 'show', :regex => /^lumpies\/(?<lump>[^\/]+)$/, :module => 'goose', :methods => [:get] },
-        { :controller => 'rabbits', :action => 'chew', :regex => /^rabbits\/(?<chew>[^\/]+)$/, :module => 'goose/wombat', :methods => [:get] },
-        { :controller => 'root', :action => 'vegetable', :regex => /^$/, :methods => [:get] },
-        { :controller => 'for_reals', :action => 'srsly', :regex => /^for_reals\/(?<parbles>[^\/]+)$/, :methods => [:get] }
-      ].inspect
+    it "generates a collection of routing objects from route configuration" do
+      expect(Fixture::Application.routes).to eq [
+        Rory::Route.new('foo/:id/bar', :to => 'foo#bar', :methods => [:get, :post]),
+        Rory::Route.new('foo', :to => 'monkeys', :methods => [:delete]),
+        Rory::Route.new('this/:path/is/:very_awesome', :to => 'awesome#rad'),
+        Rory::Route.new('lumpies/:lump', :to => 'lumpies#show', :methods => [:get], :module => 'goose'),
+        Rory::Route.new('rabbits/:chew', :to => 'rabbits#chew', :methods => [:get], :module => 'goose/wombat'),
+        Rory::Route.new('', :to => 'root#vegetable', :methods => [:get]),
+        Rory::Route.new('for_reals/:parbles', :to => 'for_reals#srsly', :methods => [:get])
+      ]
     end
   end
 

data/spec/lib/rory/controller_spec.rb

@@ -1,10 +1,7 @@
 describe Rory::Controller do
   before :each do
     @routing = {
-      :route => {
-        :controller => 'test',
-        :action => 'letsgo'
-      }
+      :route => Rory::Route.new('', :to => 'test#letsgo')
     }
 
     @request = double('Rack::Request', {
@@ -13,6 +10,12 @@ describe Rory::Controller do
     })
   end
 
+  it_has_behavior 'path_generation' do
+    let(:path_generator) {
+      Rory::Controller.new(@request, @routing, Fixture::Application)
+    }
+  end
+
   describe '#layout' do
     it 'defaults to nil' do
       controller = Rory::Controller.new(@request, @routing)
@@ -49,7 +52,7 @@ describe Rory::Controller do
         :layout => 'pretend',
         :locals => { :a => 1 },
         :app => :scooby,
-        :base_url => 'script_root'
+        :base_path => 'script_root'
       }
       allow(Rory::Renderer).to receive(:new).
         with('also/fake', renderer_options).
@@ -76,6 +79,13 @@ describe Rory::Controller do
     end
   end
 
+  describe "#base_path" do
+    it "returns script_name from request" do
+      controller = Rory::Controller.new(@request, @routing)
+      expect(controller.base_path).to eq 'script_root'
+    end
+  end
+
   describe "#present" do
     it "calls filters and action from route if exists on controller" do
       controller = Rory::Controller.new(@request, @routing)

data/spec/lib/rory/dispatcher_spec.rb

@@ -33,7 +33,8 @@ describe Rory::Dispatcher do
     end
 
     it "instantiates a controller with the parsed request and calls present" do
-      allow(dispatcher).to receive(:get_route).and_return({ :controller => 'stub' })
+      route = Rory::Route.new('', :to => 'stub#index')
+      allow(dispatcher).to receive(:get_route).and_return(route)
       dispatcher.dispatch.should == {
         :whatever => :yay,
         :present_called => true # see StubController in /spec/fixture_app
@@ -41,9 +42,8 @@ describe Rory::Dispatcher do
     end
 
     it "dispatches properly to a scoped controller" do
-      allow(dispatcher).to receive(:get_route).and_return({
-        :controller => 'lumpies', :module => 'goose'
-      })
+      route = Rory::Route.new('', :to => 'lumpies#index', :module => 'goose')
+      allow(dispatcher).to receive(:get_route).and_return(route)
       dispatcher.dispatch.should == {
         :whatever => :yay,
         :in_scoped_controller => true # see Goose::LumpiesController in /spec/fixture_app
@@ -51,9 +51,8 @@ describe Rory::Dispatcher do
     end
 
     it "dispatches properly to a nested scoped controller" do
-      allow(dispatcher).to receive(:get_route).and_return({
-        :controller => 'rabbits', :module => 'goose/wombat'
-      })
+      route = Rory::Route.new('', :to => 'rabbits#index', :module => 'goose/wombat')
+      allow(dispatcher).to receive(:get_route).and_return(route)
       dispatcher.dispatch.should == {
         :whatever => :yay,
         :in_scoped_controller => true # see Goose::Wombat::RabbitsController in /spec/fixture_app
@@ -74,33 +73,35 @@ describe Rory::Dispatcher do
     end
 
     it "matches the path from the request to the routes table" do
-      @request.stub(:path_info => '/foo', :request_method => 'PUT')
-      @dispatcher.route.should == {
-        :controller => 'monkeys',
-        :action => nil,
-        :regex => /^foo$/,
-        :methods => [:put]
-      }
+      @request.stub(:path_info => '/foo/3/bar', :request_method => 'GET')
+      expect(@dispatcher.route).to eq Rory::Route.new('/foo/:id/bar', {
+        :to => 'foo#bar',
+        :methods => [:get, :post]
+      })
+    end
+
+    it "uses override method from params if exists" do
+      @request.stub(:path_info => '/foo', :params => { '_method' => 'delete' }, :request_method => 'PUT')
+      expect(@dispatcher.route).to eq Rory::Route.new('/foo', {
+        :to => 'monkeys',
+        :methods => [:delete]
+      })
     end
 
     it "works with empty path" do
       @request.stub(:path_info => '', :request_method => 'GET')
-      @dispatcher.route.should == {
-        :controller => 'root',
-        :action => 'vegetable',
-        :regex => /^$/,
+      expect(@dispatcher.route).to eq Rory::Route.new('/', {
+        :to => 'root#vegetable',
         :methods => [:get]
-      }
+      })
     end
 
     it "works with root url represented by slash" do
       @request.stub(:path_info => '/', :request_method => 'GET')
-      @dispatcher.route.should == {
-        :controller => 'root',
-        :action => 'vegetable',
-        :regex => /^$/,
+      expect(@dispatcher.route).to eq Rory::Route.new('/', {
+        :to => 'root#vegetable',
         :methods => [:get]
-      }
+      })
     end
 
     it "returns nil if no route found" do
@@ -120,38 +121,11 @@ describe Rory::Dispatcher do
 
     it "assigns named matches to params hash" do
       @request.stub(:path_info => '/this/some-thing_or-other/is/wicked', :request_method => 'GET')
-      @dispatcher.route.inspect.should == {
-        :controller => 'awesome',
-        :action => 'rad',
-        :regex => /^this\/(?<path>[^\/]+)\/is\/(?<very_awesome>[^\/]+)$/,
-      }.inspect
+      expect(@dispatcher.route).to eq Rory::Route.new('/this/:path/is/:very_awesome', {
+        :to => 'awesome#rad'
+      })
 
       @request.params.should == {:path=>"some-thing_or-other", :very_awesome=>"wicked"}
     end
   end
-
-  describe '#method' do
-    it 'returns downcased method from request' do
-      request = {:whatever => :yay}
-      request.stub(:path_info => '/', :request_method => 'POST', :params => {})
-      dispatcher = Rory::Dispatcher.new(request, Fixture::Application)
-      dispatcher.method.should == 'post'
-    end
-
-    ['put', 'patch', 'delete'].each do |override_method|
-      it "overrides request method if _method from params is #{override_method}" do
-        request = {:whatever => :yay}
-        request.stub(:path_info => '/', :request_method => 'POST', :params => {'_method' => override_method})
-        dispatcher = Rory::Dispatcher.new(request, Fixture::Application)
-        dispatcher.method.should == override_method
-      end
-    end
-
-    it 'ignores overriding _method if not valid' do
-      request = {:whatever => :yay}
-      request.stub(:path_info => '/', :request_method => 'POST', :params => {'_method' => 'rhubarb'})
-      dispatcher = Rory::Dispatcher.new(request, Fixture::Application)
-      dispatcher.method.should == 'post'
-    end
-  end
 end

data/spec/lib/rory/renderer/context_spec.rb

@@ -1,12 +1,20 @@
 describe Rory::Renderer::Context do
+  it_has_behavior 'path_generation' do
+    let(:path_generator) {
+      Rory::Renderer::Context.new({
+        :app => Fixture::Application
+      })
+    }
+  end
+
   describe "#render" do
     it "returns sub-renderer output" do
       renderer_context = Rory::Renderer::Context.new({
         :app => :an_app,
-        :base_url => 'yoyo'
+        :base_path => 'yoyo'
       })
       passed_renderer_options = {
-        :layout => false, :app => :an_app, :base_url => 'yoyo'
+        :layout => false, :app => :an_app, :base_path => 'yoyo'
       }
       allow(Rory::Renderer).to receive(:new).
         with('not/real', passed_renderer_options).
@@ -18,11 +26,11 @@ describe Rory::Renderer::Context do
       renderer_context = Rory::Renderer::Context.new({
         :locals => { :thing => :great },
         :app => :an_app,
-        :base_url => 'yoyo',
+        :base_path => 'yoyo',
         :layout => 'groooovy'
       })
       passed_renderer_options = {
-        :layout => false, :app => :an_app, :base_url => 'yoyo'
+        :layout => false, :app => :an_app, :base_path => 'yoyo'
       }
       allow(Rory::Renderer).to receive(:new).
         with('also/fake', passed_renderer_options).

data/spec/lib/rory/renderer_spec.rb

@@ -26,8 +26,8 @@ describe Rory::Renderer do
         "Don't Say A Bad Word: Poop!"
     end
 
-    it "exposes base_url to template" do
-      controller = Rory::Renderer.new('test/a_link', :base_url => 'spoo')
+    it "exposes base_path to template" do
+      controller = Rory::Renderer.new('test/a_link', :base_path => 'spoo')
       controller.render.should == 'You came from spoo.'
     end
   end

data/spec/lib/rory/route_spec.rb

@@ -0,0 +1,8 @@
+describe Rory::Route do
+  describe '#name' do
+    it 'returns concatenated controller and action' do
+      route = described_class.new('/whatever', :to => 'pigeons#index')
+      expect(route.name).to eq 'pigeons_index'
+    end
+  end
+end

data/spec/support/shared_examples/path_generation.rb

@@ -0,0 +1,27 @@
+RSpec.configure do |c|
+  c.alias_it_should_behave_like_to :it_has_behavior, 'has behavior:'
+end
+
+shared_examples 'path_generation' do
+  describe '#path_to' do
+    it 'returns mask from route with given name prepended with root slash' do
+      allow(path_generator).to receive(:base_path).and_return(nil)
+      expect(path_generator.path_to('awesome_rad')).
+        to eq '/this/:path/is/:very_awesome'
+    end
+
+    it 'prepends base_path to returned mask' do
+      allow(path_generator).to receive(:base_path).and_return('/strawminos')
+      expect(path_generator.path_to('awesome_rad')).
+        to eq '/strawminos/this/:path/is/:very_awesome'
+    end
+
+    it 'substitutes tokens with given fields' do
+      allow(path_generator).to receive(:base_path).and_return('/strawminos')
+      expect(path_generator.path_to('awesome_rad', :path => 'house', :very_awesome => 352)).
+        to eq '/strawminos/this/house/is/352'
+    end
+  end
+end
+
+  

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rory
 version: !ruby/object:Gem::Version
-  version: 0.3.10
+  version: 0.3.11
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-03 00:00:00.000000000 Z
+date: 2014-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -192,8 +192,10 @@ files:
 - lib/rory/application.rb
 - lib/rory/controller.rb
 - lib/rory/dispatcher.rb
+- lib/rory/path_generation.rb
 - lib/rory/renderer/context.rb
 - lib/rory/renderer.rb
+- lib/rory/route.rb
 - lib/rory/route_mapper.rb
 - lib/rory/support.rb
 - lib/rory/tasks.rb
@@ -221,10 +223,12 @@ files:
 - spec/lib/rory/dispatcher_spec.rb
 - spec/lib/rory/renderer/context_spec.rb
 - spec/lib/rory/renderer_spec.rb
+- spec/lib/rory/route_spec.rb
 - spec/lib/rory/support_spec.rb
 - spec/lib/rory_spec.rb
 - spec/requests/controller_spec.rb
 - spec/spec_helper.rb
+- spec/support/shared_examples/path_generation.rb
 - LICENSE.txt
 - Rakefile
 - README.rdoc