wizardry 0.0.1 → 0.0.2

data/README.md

@@ -6,12 +6,84 @@ Simple step-by-step wizard for Rails.
 
 Add this line to your application's Gemfile:
 
-    gem 'wizardry'
+```ruby
+gem 'wizardry'
+```
 
-And then execute:
-
-    $ bundle
+And run the `bundle` command to install it.
 
 ## Usage
 
-TODO: Write usage instructions here
+Bring wizardry to your model:
+
+```ruby
+class Product < ActiveRecord::Base
+  wizardry :initial, :middle, :final
+end
+```
+
+And you will get a bunch of methods.
+To get name of the current step:
+
+```ruby
+@product.current_step # => 'initial'
+```
+
+To change the current step name:
+
+```ruby
+@product.current_step = :middle
+```
+
+Will be set only if new step name is included in wizardry steps (**initial**, **middle**, **final** in our example).
+
+For the second step name:
+
+```ruby
+@product.second_step # => 'middle'
+```
+
+Also `first_step`, `third_step`, etc. methods are available.
+
+You can check position of the current step:
+
+```ruby
+@product.second_step? # => true
+# or
+@product.current_step.middle? # => true
+```
+
+Also `first_step?`, `third_step?`, etc. methods are accessible.
+
+To get name of the next and previous steps:
+
+```ruby
+@product.next_step
+# and
+@product.previous_step
+```
+
+If not exists next/previous step then `nil` will be returned.
+
+Class methods are accessible:
+
+```ruby
+Product.steps # => ['initial', 'middle', 'final']
+# and
+Product.steps_regexp # => /initial|middle|final/
+```
+
+### Routing helpers
+
+Wizardry includes some routing helpers:
+
+```ruby
+resources :products do
+  has_wizardry
+end
+# same as
+wizardry_resources :products
+```
+
+will replace default *:id/edit* path with *:id/edit/:step* (and `:step => /initial|middle|final/` in our example).
+`has_wizardry` is also acceptable for singular resources. And `wizardry_resource` herper is here for that.

data/lib/wizardry.rb

@@ -1,6 +1,7 @@
 require 'wizardry/version'
 require 'wizardry/base'
+require 'wizardry/routes'
 
 module Wizardry
-  ORDINALS = [:first, :second, :third, :fourth, :fifth, :sixth, :seventh]
+  ORDINALS = %w[first second third fourth fifth sixth seventh]
 end

data/lib/wizardry/base.rb

@@ -4,9 +4,10 @@ module Wizardry
 
     module ClassMethods
       def wizardry(*steps)
-        cattr_accessor :steps, instance_writer: false
+        class_attribute :steps, :steps_regexp, instance_writer: false
 
-        self.steps = steps
+        self.steps = steps.map{ |s| s.to_s.inquiry }
+        self.steps_regexp = Regexp.new(steps.join('|'))
 
         include WizardryMethods
 
@@ -30,7 +31,8 @@ module Wizardry
       end
 
       def current_step=(step)
-        @current_step = step if steps.include?(step)
+        step = step.to_s
+        @current_step = step.inquiry if steps.include?(step)
       end
 
       def next_step

data/lib/wizardry/routes.rb

@@ -0,0 +1,34 @@
+class ActionDispatch::Routing::Mapper
+  def has_wizardry
+    unless resource_scope?
+      raise ArgumentError, "can't use has_wizardry outside resource(s) scope"
+    end
+
+    options = @scope[:scope_level_resource].options
+
+    if options.has_key?(:only)
+      only = Array.wrap(options.delete(:only))
+      only.map!(&:to_sym).delete(:edit)
+      options.merge!(only: only) if only.present?
+    end
+
+    except = Array.wrap(options.delete(:except))
+    except.map!(&:to_sym) << :edit
+    options.merge!(except: except.uniq)
+
+    res = @scope[:scope_level_resource].instance_variable_get(:@name)
+
+    get 'edit/:step' => :edit, step: res.to_s.classify.constantize.steps_regexp, as: :edit, on: :member
+  end
+
+  [:resources, :resource].each do |method|
+    class_eval <<-EOT, __FILE__, __LINE__ + 1
+      def wizardry_#{method}(*res)  # def wizardry_resources(*res)
+        #{method} *res do           #   resources *res do
+          has_wizardry              #     has_wizardry
+          yield if block_given?     #     yield if block_given?
+        end                         #   end
+      end                           # end
+    EOT
+  end
+end

data/lib/wizardry/version.rb

@@ -1,3 +1,3 @@
 module Wizardry
-  VERSION = "0.0.1"
+  VERSION = '0.0.2'
 end

data/spec/dummy/app/controllers/products_controller.rb

@@ -0,0 +1,2 @@
+class ProductsController < ApplicationController
+end

data/spec/dummy/config/routes.rb

@@ -1,58 +1,6 @@
 Dummy::Application.routes.draw do
-  # The priority is based upon order of creation:
-  # first created -> highest priority.
-
-  # Sample of regular route:
-  #   match 'products/:id' => 'catalog#view'
-  # Keep in mind you can assign values other than :controller and :action
-
-  # Sample of named route:
-  #   match 'products/:id/purchase' => 'catalog#purchase', :as => :purchase
-  # This route can be invoked with purchase_url(:id => product.id)
-
-  # Sample resource route (maps HTTP verbs to controller actions automatically):
-  #   resources :products
-
-  # Sample resource route with options:
-  #   resources :products do
-  #     member do
-  #       get 'short'
-  #       post 'toggle'
-  #     end
-  #
-  #     collection do
-  #       get 'sold'
-  #     end
-  #   end
-
-  # Sample resource route with sub-resources:
-  #   resources :products do
-  #     resources :comments, :sales
-  #     resource :seller
-  #   end
-
-  # Sample resource route with more complex sub-resources
-  #   resources :products do
-  #     resources :comments
-  #     resources :sales do
-  #       get 'recent', :on => :collection
-  #     end
-  #   end
-
-  # Sample resource route within a namespace:
-  #   namespace :admin do
-  #     # Directs /admin/products/* to Admin::ProductsController
-  #     # (app/controllers/admin/products_controller.rb)
-  #     resources :products
-  #   end
-
-  # You can have the root of your site routed with "root"
-  # just remember to delete public/index.html.
-  # root :to => 'welcome#index'
-
-  # See how all your routes lay out with "rake routes"
-
-  # This is a legacy wild controller route that's not recommended for RESTful applications.
-  # Note: This route will make all actions in every controller accessible via GET requests.
-  # match ':controller(/:action(/:id))(.:format)'
+  resources :products, except: :destroy, path_names: { new: :make } do
+    get :commit, on: :collection
+    has_wizardry
+  end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,20 @@
 ENV['RAILS_ENV'] = 'test'
 
-require File.expand_path('../dummy/config/environment.rb',  __FILE__)
+require File.expand_path('../dummy/config/environment.rb', __FILE__)
 require 'minitest/autorun'
+require 'action_controller/test_case'
+
+class MiniTest::Spec
+  include ActiveSupport::Testing::SetupAndTeardown
+end
+
+class RoutingSpec < Minitest::Spec
+  include ActionDispatch::Integration::Runner
+  include Rails.application.routes.url_helpers
+
+  before do
+    @routes = Rails.application.routes
+  end
+
+  register_spec_type(/Routing/, self)
+end

data/spec/wizardry/base_spec.rb

@@ -7,28 +7,47 @@ describe Wizardry::Base do
     end
 
     it 'must have steps array' do
-      assert_equal Product.steps, [:initial, :middle, :final]
+      assert_equal Product.steps, %w[initial middle final]
+    end
+
+    it 'must have steps regexp' do
+      assert_equal Product.steps_regexp, /initial|middle|final/
+    end
+
+    it 'must be instance of StringInquirer class in steps array' do
+      assert_equal Product.steps.map{ |s| s.instance_of?(ActiveSupport::StringInquirer) }, [true, true, true]
     end
   end
 
   describe 'instance methods' do
-    before :each do
+    before do
       @product = Product.new
     end
 
     it 'must return current step as first step' do
-      assert_equal @product.current_step, :initial
+      assert_equal @product.current_step, 'initial'
     end
 
-    it 'must set current step name' do
+    it 'must update current step name with instance of StringInquirer' do
+      @product.current_step = 'middle'
+      assert_equal @product.current_step, 'middle'
+      assert_instance_of ActiveSupport::StringInquirer, @product.current_step
+    end
+
+    it 'must update current step name when symbol is passed' do
       @product.current_step = :middle
-      assert_equal @product.current_step, :middle
+      assert_equal @product.current_step, 'middle'
+    end
+
+    it 'must not update current step name' do
+      @product.current_step = :fictional
+      refute_equal @product.current_step, 'fictional'
     end
 
     it 'must have ordinal methods' do
-      assert_equal @product.first_step,  :initial
-      assert_equal @product.second_step, :middle
-      assert_equal @product.last_step,   :final
+      assert_equal @product.first_step,  'initial'
+      assert_equal @product.second_step, 'middle'
+      assert_equal @product.last_step,   'final'
 
       assert @product.first_step?
       refute @product.second_step?
@@ -42,7 +61,7 @@ describe Wizardry::Base do
     end
 
     it 'must return next step name' do
-      assert_equal @product.next_step, :middle
+      assert_equal @product.next_step, 'middle'
     end
 
     it 'must return `nil` on last step' do
@@ -56,7 +75,7 @@ describe Wizardry::Base do
 
     it 'must return previous step name' do
       @product.current_step = :middle
-      assert_equal @product.previous_step, :initial
+      assert_equal @product.previous_step, 'initial'
     end
   end
 end

data/spec/wizardry/routes_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe 'Wizardry Routing' do
+  it 'must accept wizardry `edit` routes' do
+    assert_recognizes({ controller: 'products', action: 'edit', id: '1', step: 'initial'}, '/products/1/edit/initial')
+    assert_recognizes({ controller: 'products', action: 'edit', id: '1', step: 'middle'}, '/products/1/edit/middle')
+    assert_recognizes({ controller: 'products', action: 'edit', id: '1', step: 'final'}, '/products/1/edit/final')
+    assert '/products/1/initial', edit_product_path(id: 1, step: 'initial')
+  end
+
+  it 'must accept only valid steps' do
+    assert_raises ActionController::RoutingError do
+      assert_recognizes({ controller: 'products', action: 'edit', id: '1', step: 'fictional'}, '/products/1/edit/fictional')
+    end
+  end
+
+  it 'must not accept default `edit` route' do
+    assert_raises ActionController::RoutingError do
+      assert_recognizes({ controller: 'products', action: 'edit', id: '1'}, '/products/1/edit')
+    end
+  end
+
+  it 'must not accept `destroy` route' do
+    assert_raises ActionController::RoutingError do
+      assert_recognizes({ controller: 'products', action: 'destroy', id: '1'}, { path: '/products/1', method: :delete })
+    end
+  end
+
+  it 'must accept routes defined in block' do
+    assert_recognizes({ controller: 'products', action: 'commit' }, '/products/commit')
+    assert '/products/commit', commit_products_path
+  end
+
+  it 'must have overriden `new` path name' do
+    assert_recognizes({ controller: 'products', action: 'new' }, '/products/make')
+    assert '/products/make', new_product_path
+  end
+
+  it 'must have `wizardry_resources` helper' do
+    with_routing do |set|
+      set.draw{ wizardry_resources :products }
+
+      assert_recognizes({ controller: 'products', action: 'edit', id: '1', step: 'initial'}, '/products/1/edit/initial')
+    end
+  end
+
+  it 'must have `wizardry_resource` helper' do
+    with_routing do |set|
+      set.draw{ wizardry_resource :products }
+
+      assert_recognizes({ controller: 'products', action: 'edit', step: 'initial'}, '/products/edit/initial')
+    end
+  end
+
+  it 'must not let to use `has_wizardry` outside resource(s) scope' do
+    with_routing do |set|
+      assert_raises ArgumentError do
+        set.draw{ has_wizardry }
+      end
+    end
+  end
+
+  it 'must not accept default `edit` route with `only` option' do
+    with_routing do |set|
+      set.draw{ wizardry_resources :products, only: [:edit, :update] }
+
+      assert_raises ActionController::RoutingError do
+        assert_recognizes({ controller: 'products', action: 'edit', id: '1'}, '/products/1/edit')
+      end
+    end
+  end
+end

data/wizardry.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.test_files    = gem.files.grep(%r{^spec/})
   gem.name          = 'wizardry'
   gem.require_paths = ['lib']
   gem.version       = Wizardry::VERSION
@@ -16,4 +16,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'rails', '~> 3.2'
 
   gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'minitest'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wizardry
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-01 00:00:00.000000000 Z
+date: 2012-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: Simple step-by-step wizard for Rails
 email:
 - lexmag@gmail.com
@@ -57,11 +73,13 @@ files:
 - Rakefile
 - lib/wizardry.rb
 - lib/wizardry/base.rb
+- lib/wizardry/routes.rb
 - lib/wizardry/version.rb
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
 - spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/products_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/mailers/.gitkeep
 - spec/dummy/app/models/.gitkeep
@@ -94,6 +112,7 @@ files:
 - spec/dummy/script/rails
 - spec/spec_helper.rb
 - spec/wizardry/base_spec.rb
+- spec/wizardry/routes_spec.rb
 - wizardry.gemspec
 homepage: ''
 licenses: []
@@ -109,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3814436817286261879
+      hash: -4094284250890369797
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -118,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3814436817286261879
+      hash: -4094284250890369797
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -130,6 +149,7 @@ test_files:
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
 - spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/products_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/mailers/.gitkeep
 - spec/dummy/app/models/.gitkeep
@@ -162,3 +182,4 @@ test_files:
 - spec/dummy/script/rails
 - spec/spec_helper.rb
 - spec/wizardry/base_spec.rb
+- spec/wizardry/routes_spec.rb