rspec-rails-routing 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-rails-routing.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jason Harrelson
+
+MIT License
+
+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.md

@@ -0,0 +1,98 @@
+# RspecRailsRouting
+
+RSpec matchers for Rails routing.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rspec-rails-routing'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-rails-routing
+
+
+## Usage
+
+Create a routing spec helper.  In this file you will define at least a host.  You can
+add an addition level of indirection in order to have multiple hosts.  This is useful
+when subdomains are used in your application and must be speced for different routing.
+
+    # spec/support/routing_spec_helper.rb
+    module RoutingSpecHelper
+
+      module Hosts
+
+        def host
+          some_application_host
+        end
+
+        def some_application_host
+          'http://www.some-application.test'
+        end
+
+      end
+
+    end
+
+    RSpec.configure do |config|
+      config.include RoutingSpecHelper::Hosts, :type => :routing
+    end
+
+Write a routing spec.
+
+    # spec/routing/projects_routing_spec.rb
+    require 'spec_helper'
+
+    describe 'projects routing' do
+
+      let :args do
+        ['projects', { :host => host }]
+      end
+
+      describe 'path recognition' do
+
+        it { should recognize_restful_index_path( *args ) }
+        it { should recognize_restful_show_path( *args ) }
+        it { should recognize_restful_new_path( *args ) }
+        it { should recognize_restful_edit_path( *args ) }
+        it { should recognize_restful_create_path( *args ) }
+        it { should recognize_restful_update_path( *args ) }
+
+        it { should_not recognize_restful_destory_path( *args ) }
+
+      end
+
+      describe 'path helpers' do
+
+        # using an open struct here as ActiveRecord models do not have an ID until saved to DB
+        let :project do
+          OpenStruct.new( id: 1 )
+        end
+
+        it { should have_named_route( :projects, "/projects" ) }
+        it { should have_named_route( :project, project, "/projects/#{project.id}" ) }
+        it { should have_named_route( :new_project, "/projects/new" ) }
+        it { should have_named_route( :edit_project, project, "/projects/#{project.id}/edit" ) }
+        
+        # The create and update actions do not have path helpers as the paths are just the 
+        # index and show paths with different HTTP Verbs.
+
+      end
+
+    end
+
+Given the routes file.
+
+    # config/routes.rb
+    SomeApplication::Application.routes.draw do
+      resources :projects, :except => [:destroy]
+    end
+
+The preceding spec will pass.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rspec-rails-routing.rb

@@ -0,0 +1 @@
+require "rspec_rails_routing"

data/lib/rspec_rails_routing.rb

@@ -0,0 +1,9 @@
+require "rspec_rails_routing/version"
+
+module RspecRailsRouting
+
+  autoload :Matchers, 'rspec_rails_routing/matchers'
+
+end
+
+require 'rspec_rails_routing/rspec' if defined?( RSpec )

data/lib/rspec_rails_routing/matchers.rb

@@ -0,0 +1,53 @@
+require 'rspec/expectations'
+
+module RspecRailsRouting
+  module Matchers
+
+    autoload :HaveNamedRoute, 'rspec_rails_routing/matchers/have_named_route'
+    autoload :Helpers,        'rspec_rails_routing/matchers/helpers'
+    autoload :Routing,        'rspec_rails_routing/matchers/routing'
+
+  end
+end
+
+%w(
+  index
+  show
+  new
+  edit
+  create
+  update
+  destroy
+).each do |action|
+
+  RSpec::Matchers.define :"recognize_restful_#{action}_path" do |*args|
+
+    include RspecRailsRouting::Matchers::Helpers
+
+    url, path, path_template, controller, nesting_params = extract_info( action, args )
+
+    match do |actual|
+      begin
+        router.recognize_path( url, :method => http_verb_for( action ) ) == {
+          :controller => controller,
+          :action     => action
+        }.merge( nesting_params )
+      rescue ActionController::RoutingError => ex
+        false
+      end
+    end
+
+    description do
+      description_for action, path_template, controller
+    end
+
+    failure_message_for_should do |actual|
+      failure_message_for_should_for action, url
+    end
+
+    failure_message_for_should_not do |actual|
+      failure_message_for_should_not_for action, url
+    end
+
+  end
+end

data/lib/rspec_rails_routing/matchers/have_named_route.rb

@@ -0,0 +1,60 @@
+
+require 'rspec/expectations'
+
+module RspecRailsRouting
+  module Matchers
+    module Routing
+
+      class HaveNamedRoute
+        def initialize(context, name, *args)
+          @context = context
+          @name = name
+          @path = "#{name}_path"
+          @args = args
+          if ! args.last
+            raise ArgumentError, 'The last argument must be the expected uri'
+          end
+          @expected_uri = args.pop
+        end
+
+        def description
+          "have a route named #{@name}, where e.g. #{example_call} == #{@expected_uri}"
+        end
+
+        def matches?(subject)
+          begin
+            @actual_uri = @context.send( "#{@name}_path", *@args )
+            @actual_uri == @expected_uri
+          rescue NoMethodError
+            false
+          end
+        end
+
+        def failure_message_for_should
+          "expected #{example_call} to equal #{@expected_uri}, but got #{@actual_uri}"
+        end
+
+        def failure_message_for_should_not
+          "expected #{example_call} to not equal #{@expected_uri}, but it did"
+        end
+
+        def example_call
+          call = "#{@name}_path"
+          if ! @args.empty?
+            call << "(#{format_args( @args )})"
+          end
+
+          call
+        end
+
+        def format_args( args )
+          @args.map do |a|
+            a.is_a?( Hash ) ? a.inspect : a.to_s
+          end.join( ', ' )
+        end
+
+      end
+
+    end
+  end
+end

data/lib/rspec_rails_routing/matchers/helpers.rb

@@ -0,0 +1,103 @@
+module RspecRailsRouting
+  module Matchers
+    module Helpers
+
+      def router
+        Rails.application.routes
+      end
+
+      def extract_info( action, args )
+        options = args.extract_options!
+        domain  = args.pop
+
+        url_part = args.map do |p|
+          if p.is_a?( Symbol )
+            p.to_s
+          elsif p.is_a?( String )
+            "#{p}/1"
+          end
+        end.join( '/' )
+
+        url_template_part = args.map do |p|
+          if p.is_a?( Symbol )
+            p.to_s
+          elsif p.is_a?( String )
+            "#{p}/:#{p.singularize.foreign_key}"
+          end
+        end.join( '/' )
+
+        namespaces = args.select { |p| p.is_a?( Symbol ) }
+        args.shift( namespaces.size )
+
+        nesting_params = Hash[*args.map { |p| [p.singularize.foreign_key.to_sym, '1'] }.flatten]
+
+        if %w(show edit update destroy).include?( action.to_s )
+          nesting_params.merge! :id => '1'
+        end
+
+        url_end = case action.to_sym
+                    when :index, :create
+                      ''
+                    when :show, :update, :destroy
+                      '1'
+                    when :new
+                      'new'
+                    when :edit
+                      '1/edit'
+                  end
+
+        url_template_end = case action.to_sym
+                             when :index, :create
+                               ''
+                             when :show, :update, :destroy
+                               ':id'
+                             when :new
+                               'new'
+                             when :edit
+                               ':id/edit'
+                           end
+
+        path          = [url_part, domain, url_end].reject( &:blank? ).join( '/' )
+        path_template = [url_template_part, domain, url_template_end].reject( &:blank? ).join( '/' )
+        url           = "#{options[:host]}/" + path
+        controller    = [namespaces, domain].reject( &:blank? ).join( '/' )
+
+        return url, path, path_template, controller, nesting_params
+      end
+
+      def format_url_or_path( url_or_path )
+        is_url = !url_or_path.match( /^http/ ).nil?
+        has_slash = !url_or_path.match( /^\\/ ).nil?
+        needs_slash = !is_url && !has_slash
+
+        "#{needs_slash ? '/' : ''}#{url_or_path}".gsub( /\/1/, '/:id' )
+      end
+
+      def description_for( action, path_template, controller )
+        "route the RESTful #{action} path #{http_verb_for( action ).to_s.upcase} #{format_url_or_path( path_template )} to #{controller}##{action}"
+      end
+
+      def failure_message_for_should_for( action, url )
+        "failed to recognize the RESTful #{action} path #{http_verb_for( action ).to_s.upcase} #{url}"
+      end
+
+      def failure_message_for_should_not_for( action, url )
+        "recognized the RESTful #{action} path #{http_verb_for( action ).to_s.upcase} #{url}, but should not"
+      end
+
+      def http_verb_for( action )
+        case action.to_sym
+          when :index, :show, :new, :edit
+            :get
+          when :create
+            :post
+          when :update
+            :put
+          when :destroy
+            :delete
+        end
+      end
+
+    end
+  end
+end

data/lib/rspec_rails_routing/matchers/routing.rb

@@ -0,0 +1,63 @@
+require 'rspec/expectations'
+
+module RspecRailsRouting
+  module Matchers
+    module Routing
+
+      def have_named_route(name, *args)
+        HaveNamedRoute.new(self, name, *args)
+      end
+
+      #class HaveNamedRoute
+        #def initialize(context, name, *args)
+          #@context = context
+          #@name = name
+          #@path = "#{name}_path"
+          #@args = args
+          #if ! args.last
+            #raise ArgumentError, 'The last argument must be the expected uri'
+          #end
+          #@expected_uri = args.pop
+        #end
+
+        #def description
+          #"have a route named #{@name}, where e.g. #{example_call} == #{@expected_uri}"
+        #end
+
+        #def matches?(subject)
+          #begin
+            #@actual_uri = @context.send( "#{@name}_path", *@args )
+            #@actual_uri == @expected_uri
+          #rescue NoMethodError => ex
+            #false
+          #end
+        #end
+
+        #def failure_message_for_should
+          #"expected #{example_call} to equal #{@expected_uri}, but got #{@actual_uri}"
+        #end
+
+        #def failure_message_for_should_not
+          #"expected #{example_call} to not equal #{@expected_uri}, but it did"
+        #end
+
+        #def example_call
+          #call = "#{@name}_path"
+          #if ! @args.empty?
+            #call << "(#{format_args( @args )})"
+          #end
+
+          #call
+        #end
+
+        #def format_args( args )
+          #@args.map do |a|
+            #a.is_a?( Hash ) ? a.inspect : a.to_s
+          #end.join( ', ' )
+        #end
+
+      #end
+
+    end
+  end
+end

data/lib/rspec_rails_routing/rspec.rb

@@ -0,0 +1,7 @@
+require 'rspec/core'
+
+RSpec.configure do |config|
+
+  config.include RspecRailsRouting::Matchers::Routing, :type => :routing
+
+end

data/lib/rspec_rails_routing/version.rb

@@ -0,0 +1,7 @@
+module Rspec
+  module Rails
+    module Routing
+      VERSION = "1.0.0"
+    end
+  end
+end

data/rspec-rails-routing.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec_rails_routing/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-rails-routing"
+  spec.version       = Rspec::Rails::Routing::VERSION
+  spec.authors       = ["C. Jason Harrelson"]
+  spec.email         = ["jason@lookforwardenterprises.com"]
+  spec.description   = %q{Rspec matchers for Rails routing.}
+  spec.summary       = %q{Rspec matchers for Rails routing.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: rspec-rails-routing
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- C. Jason Harrelson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rspec matchers for Rails routing.
+email:
+- jason@lookforwardenterprises.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec-rails-routing.rb
+- lib/rspec_rails_routing.rb
+- lib/rspec_rails_routing/matchers.rb
+- lib/rspec_rails_routing/matchers/have_named_route.rb
+- lib/rspec_rails_routing/matchers/helpers.rb
+- lib/rspec_rails_routing/matchers/routing.rb
+- lib/rspec_rails_routing/rspec.rb
+- lib/rspec_rails_routing/version.rb
+- rspec-rails-routing.gemspec
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2030036764577703089
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2030036764577703089
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Rspec matchers for Rails routing.
+test_files: []