stepper 0.0.1

data/lib/stepper/engine.rb

@@ -0,0 +1,4 @@
+module Stepper #:nodoc:
+  class Engine < ::Rails::Engine #:nodoc:
+  end
+end

data/lib/stepper/exceptions.rb

@@ -0,0 +1,4 @@
+module Stepper
+  class StepperException < RuntimeError
+  end
+end

data/lib/stepper/helper/action_view_additions.rb

@@ -0,0 +1,14 @@
+module Stepper
+  module ActionViewAdditions
+    module InstanceMethods
+      def stepper(form)
+        resource = self.instance_variable_get :@_stepper_resource_instance
+        current_step_column = resource.class._stepper_current_step_column
+        self.render(:partial => "stepper/fields",
+                    :locals => { :f => form,
+                                 :resource => resource,
+                                 :current_step_column => current_step_column }).to_s
+      end
+    end
+  end
+end

data/lib/stepper/models/active_record_additions.rb

@@ -0,0 +1,96 @@
+module Stepper
+  module ActiveRecordAdditions
+
+    def self.included(base)
+      base.extend ClassMethods
+      base.validate :current_step_validation
+    end
+
+    module ClassMethods
+      def has_steps(options = {})
+        #check options
+        raise Stepper::StepperException.new("Options for has_steps must be in a hash.") unless options.is_a? Hash
+        options.each do |key, value|
+          unless [:current_step_column, :steps].include? key
+            raise Stepper::StepperException.new("Unknown option for has_steps: #{key.inspect} => #{value.inspect}.")
+          end
+        end
+
+        raise Stepper::StepperException.new(":steps condition can't be blank") if options[:steps].blank?
+
+        #set current step column
+        class_attribute :_stepper_current_step_column
+        self._stepper_current_step_column = options[:current_step_column] || :current_step
+
+        class_attribute :_stepper_steps
+        self._stepper_steps= options[:steps]
+
+        include InstanceMethods
+      end
+    end
+
+    module InstanceMethods
+
+      def stepper_current_step_column
+        self.class._stepper_current_step_column
+      end
+
+      def stepper_steps
+        self.class._stepper_steps
+      end
+
+      def stepper_current_step_index
+        stepper_steps.index(stepper_current_step)
+      end
+
+      alias_method(:steps, :stepper_steps) unless self.respond_to? :steps
+
+      def stepper_current_step
+        self.send(self.class._stepper_current_step_column)
+      end
+
+      def stepper_current_step=(step)
+        self.send("#{self.class._stepper_current_step_column}=", step)
+      end
+
+      def last_step?(step = stepper_current_step)
+        step == self.stepper_steps.last
+      end
+
+      def first_step?(step = stepper_current_step)
+        (step == stepper_steps.first) or stepper_current_step.blank? && step.blank?
+      end
+
+      def previous_step
+        return nil if (first_step? or stepper_current_step.blank?)
+        stepper_steps[stepper_steps.index(stepper_current_step) - 1]
+      end
+
+      def previous_step!
+        self.stepper_current_step = self.previous_step
+        self
+      end
+
+      def next_step
+        return stepper_steps.first if self.stepper_current_step.blank?
+        return nil if self.last_step?
+        stepper_steps[stepper_steps.index(stepper_current_step) + 1]
+      end
+
+      def next_step!
+        self.stepper_current_step = self.next_step
+        self
+      end
+
+      protected
+
+        def current_step_validation
+          return if stepper_current_step.blank?
+          for i in 0..stepper_current_step_index do
+            self.send("validate_#{stepper_steps[i]}") if self.respond_to?("validate_#{stepper_steps[i]}", true)
+          end
+        end
+
+    end
+  end
+end

data/lib/stepper/railtie.rb

@@ -0,0 +1,26 @@
+require 'rails'
+
+require 'stepper/engine'
+require 'stepper/controllers/controller_additions'
+require 'stepper/controllers/controller_resource'
+require 'stepper/exceptions'
+require 'stepper/models/active_record_additions'
+require 'stepper/helper/action_view_additions'
+
+module Stepper
+  class Railtie < ::Rails::Railtie #:nodoc:
+    initializer 'stepper' do |app|
+      ActiveSupport.on_load(:active_record) do
+        ::ActiveRecord::Base.send :include, Stepper::ActiveRecordAdditions
+      end
+
+      ActiveSupport.on_load(:action_controller) do
+        ::ActionController::Base.send :include, Stepper::ControllerAdditions
+      end
+
+      ActiveSupport.on_load(:action_view) do
+        ::ActionView::Base.send :include, Stepper::ActionViewAdditions::InstanceMethods
+      end
+    end
+  end
+end

data/stepper.gemspec

@@ -0,0 +1,136 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{stepper}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Anton Versal}]
+  s.date = %q{2011-09-30}
+  s.description = %q{Stepper is multistep form (wizard) solution for Rails 3. Stepper allows you to split up your large form into series of pages that users can navigate through to complete the form and save it state.}
+  s.email = %q{ant.ver@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "app/views/stepper/_fields.html.erb",
+    "config/locales/stepper.yml",
+    "lib/stepper.rb",
+    "lib/stepper/controllers/controller_additions.rb",
+    "lib/stepper/controllers/controller_resource.rb",
+    "lib/stepper/engine.rb",
+    "lib/stepper/exceptions.rb",
+    "lib/stepper/helper/action_view_additions.rb",
+    "lib/stepper/models/active_record_additions.rb",
+    "lib/stepper/railtie.rb",
+    "stepper.gemspec",
+    "test/controllers/controller_additions_test.rb",
+    "test/controllers/controller_resource_test.rb",
+    "test/controllers/controller_test.rb",
+    "test/helper.rb",
+    "test/helpers/helper_test.rb",
+    "test/integration/steps_test.rb",
+    "test/models/assigns_test.rb",
+    "test/models/instance_test.rb",
+    "test/models/models_test.rb",
+    "test/models/validation_test.rb",
+    "test/rails_app/Rakefile",
+    "test/rails_app/app/controllers/application_controller.rb",
+    "test/rails_app/app/controllers/companies_controller.rb",
+    "test/rails_app/app/helpers/application_helper.rb",
+    "test/rails_app/app/mailers/.gitkeep",
+    "test/rails_app/app/models/.gitkeep",
+    "test/rails_app/app/models/company.rb",
+    "test/rails_app/app/models/users.rb",
+    "test/rails_app/app/views/companies/_step1_step.html.erb",
+    "test/rails_app/app/views/companies/_step2_step.html.erb",
+    "test/rails_app/app/views/companies/_step3_step.html.erb",
+    "test/rails_app/app/views/companies/index.html.erb",
+    "test/rails_app/app/views/companies/new.html.erb",
+    "test/rails_app/app/views/companies/show.html.erb",
+    "test/rails_app/app/views/layouts/application.html.erb",
+    "test/rails_app/config.ru",
+    "test/rails_app/config/application.rb",
+    "test/rails_app/config/boot.rb",
+    "test/rails_app/config/database.yml",
+    "test/rails_app/config/environment.rb",
+    "test/rails_app/config/environments/development.rb",
+    "test/rails_app/config/environments/production.rb",
+    "test/rails_app/config/environments/test.rb",
+    "test/rails_app/config/initializers/backtrace_silencers.rb",
+    "test/rails_app/config/initializers/inflections.rb",
+    "test/rails_app/config/initializers/mime_types.rb",
+    "test/rails_app/config/initializers/secret_token.rb",
+    "test/rails_app/config/initializers/session_store.rb",
+    "test/rails_app/config/initializers/wrap_parameters.rb",
+    "test/rails_app/config/locales/en.yml",
+    "test/rails_app/config/routes.rb",
+    "test/rails_app/db/migrate/20110928102949_create_tables.rb",
+    "test/rails_app/db/schema.rb",
+    "test/rails_app/lib/assets/.gitkeep",
+    "test/rails_app/lib/tasks/.gitkeep",
+    "test/rails_app/public/404.html",
+    "test/rails_app/public/422.html",
+    "test/rails_app/public/500.html",
+    "test/rails_app/public/favicon.ico",
+    "test/rails_app/public/index.html",
+    "test/rails_app/public/robots.txt",
+    "test/rails_app/script/rails"
+  ]
+  s.homepage = %q{http://github.com/antonversal/stepper}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
+  s.summary = %q{Stepper is multistep form (wizard) solution for Rails 3.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, ["~> 3.1.0"])
+      s.add_development_dependency(%q<ruby-debug19>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_development_dependency(%q<capybara>, [">= 0"])
+      s.add_development_dependency(%q<launchy>, [">= 0"])
+    else
+      s.add_dependency(%q<rails>, ["~> 3.1.0"])
+      s.add_dependency(%q<ruby-debug19>, [">= 0"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<capybara>, [">= 0"])
+      s.add_dependency(%q<launchy>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rails>, ["~> 3.1.0"])
+    s.add_dependency(%q<ruby-debug19>, [">= 0"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<capybara>, [">= 0"])
+    s.add_dependency(%q<launchy>, [">= 0"])
+  end
+end
+

data/test/controllers/controller_additions_test.rb

@@ -0,0 +1,16 @@
+require 'helper'
+
+class ControllerAdditionsTest < ActiveSupport::TestCase
+    setup do
+      @controller_class = Class.new
+      @controller = @controller_class.new
+      @controller_class.send(:include, Stepper::ControllerAdditions)
+    end
+
+    test "should has_steps setup before filter which passes call to ControllerResource" do
+      Stepper::ControllerResource.stubs(:new).with(@controller, nil).stubs(:load_resource)
+      @controller_class.stubs(:before_filter).with(:only => [:create, :update, :new])
+      @controller_class.has_steps
+    end
+
+end

data/test/controllers/controller_resource_test.rb

@@ -0,0 +1,49 @@
+require 'helper'
+
+class ControllerResourceTest < ActiveSupport::TestCase
+    setup do
+      @params = HashWithIndifferentAccess.new(:controller => "companies")
+      @controller_class = Class.new
+      @controller = @controller_class.new
+      @controller.stubs(:params).returns(@params)
+    end
+
+    test "should load resource into instance variable if params[:id] is specified" do
+      Company.stubs(:find).with(1).returns(mock_company(:id => 1))
+      @params.merge!(:action => "new", :id => mock_company.id)
+      resource = Stepper::ControllerResource.new(@controller)
+      resource.load_resource
+      assert_equal @controller.instance_variable_get(:@company), mock_company
+    end
+
+    test "should build resource and load into instance variable if params[:id] is not specified" do
+      Company.stubs(:new).returns(mock_company)
+      @params.merge!(:action => "new")
+      resource = Stepper::ControllerResource.new(@controller)
+      resource.load_resource
+      assert_equal @controller.instance_variable_get(:@company), mock_company
+    end
+
+    test "should load resource into instance variable(:new)" do
+      Company.stubs(:new).returns(mock_company)
+      @params.merge!(:action => "create")
+      resource = Stepper::ControllerResource.new(@controller)
+      resource.load_resource
+      assert_equal @controller.instance_variable_get(:@company), mock_company
+    end
+
+    test "should not load resource into instance variable if instance variable exists" do
+      @controller.instance_variable_set(:@company, mock_company)
+      @params.merge!(:action => "next_step", :id => 15)
+      resource = Stepper::ControllerResource.new(@controller)
+      resource.load_resource
+      assert_equal @controller.instance_variable_get(:@company), mock_company
+    end
+
+    protected
+      def mock_company(stubs={})
+        @mock_company ||= mock(stubs)
+      end
+
+
+end

data/test/controllers/controller_test.rb

@@ -0,0 +1,138 @@
+require 'helper'
+
+class CompaniesControllerTest < ActionController::TestCase
+  tests CompaniesController
+
+  test "should raise error if commit is unknown" do
+    Company.expects(:new).with({'name' => 'Hina'}).returns(mock_company)
+    mock_company.expects(:save).returns(true)
+    mock_company.stubs(:id).returns(1)
+    assert_raise Stepper::StepperException do
+      post(:create, {:company => {:name => "Hina"}, :commit => "some commit"})
+    end
+  end
+
+  test "should assign resource if params[:id] exists" do
+    @controller.expects(:render)
+    Company.expects(:find).with('1').returns(mock_company)
+    get :new, :id => 1
+    assert_response :success
+    assert_equal assigns(:company), mock_company
+  end
+
+  test "should get existing assigns" do
+    @controller.expects(:render)
+    @controller.instance_variable_set(:@company, mock_company)
+    get :new, :id => 1
+    assert_equal assigns(:company), mock_company
+  end
+
+  protected
+    def mock_company(stubs={})
+      @mock_company ||= mock(stubs)
+    end
+end
+
+class CompaniesCreateControllerTest < ActionController::TestCase
+  tests CompaniesController
+
+  setup do
+    Company.expects(:new).with({'name' => 'Hina'}).returns(mock_company)
+    mock_company.expects(:save).returns(true)
+    mock_company.stubs(:id).returns(1)
+  end
+
+  test "should redirect to next step if commit 'Next step'" do
+    mock_company.stubs(:stepper_current_step).returns("step1")
+    post(:create, {:company => {:name => "Hina"}, :commit => "Next step"})
+    assert_response :redirect
+    assert_redirected_to "http://test.host/companies/new?id=1"
+    assert_equal flash[:notice], "Step Step1 was successfully created."
+  end
+
+  test "should redirect to index if commit 'Finish later'" do
+    post(:create, {:company => {:name => "Hina"}, :commit => "Finish later"})
+    assert_response :redirect
+    assert_redirected_to "http://test.host/companies"
+  end
+
+  protected
+  def mock_company(stubs={})
+    @mock_company ||= mock(stubs)
+  end
+end
+
+class CompaniesUpdateControllerTest < ActionController::TestCase
+  tests CompaniesController
+
+  setup do
+    Company.expects(:find).with('1').returns(mock_company)
+    mock_company.expects(:attributes=).with({'code' => '23'}).returns(true)
+    mock_company.expects(:save).returns(true)
+    mock_company.stubs(:id).returns(1)
+  end
+
+  test "should redirect to next step if commit 'Next step'" do
+    mock_company.stubs(:stepper_current_step).returns("step2")
+    put(:update, {:company => {:code => "23"}, :commit => "Next step", :id => 1})
+    assert_response :redirect
+    assert_redirected_to "http://test.host/companies/new?id=1"
+    assert_equal flash[:notice], "Step Step2 was successfully created."
+  end
+
+  test "should redirect to index if commit 'Finish later'" do
+    mock_company.stubs(:previous_step!)
+    put(:update, {:company => {:code => "23"}, :commit => "Finish later", :id => 1})
+    assert_response :redirect
+    assert_redirected_to "http://test.host/companies"
+  end
+
+  test "should redirect to previous step if commit 'Previous step'" do
+    mock_company.expects(:previous_step!).returns(mock_company).at_least(2)
+    mock_company.stubs(:current_step).returns("step2")
+    put(:update, {:company => {:code => "23"}, :commit => "Previous step", :id => 1})
+    assert_response :redirect
+    assert_redirected_to "http://test.host/companies/new?id=1"
+  end
+
+  test "should redirect to show if commit 'Finish form'" do
+    put(:update, {:company => {:code => "23"}, :commit => "Finish form", :id => 1})
+    assert_response :redirect
+    assert_redirected_to "http://test.host/companies/1"
+  end
+
+  protected
+  def mock_company(stubs={})
+    @mock_company ||= mock(stubs)
+  end
+end
+
+class CompaniesInvalidParamsControllerTest < ActionController::TestCase
+  tests CompaniesController
+
+  setup do
+    @controller.expects(:render).at_least_once
+  end
+
+  test "should create action render to new action if object.save returns false" do
+    Company.expects(:new).with({'name' => 'Hina'}).returns(mock_company)
+    mock_company.expects(:save).returns(false)
+    mock_company.expects(:previous_step!)
+    post(:create, {:company => {:name => "Hina"}, :commit => "Next step"})
+    assert_response :success
+  end
+
+  test "should update action redirect to new action if object.save returns false" do
+    Company.expects(:find).with('1').returns(mock_company)
+    mock_company.expects(:attributes=).with({"name" => "Hina"}).returns(true)
+    mock_company.expects(:save).returns(false)
+    mock_company.expects(:previous_step!)
+    post(:update, {:company => {:name => "Hina"}, :id => 1, :commit => "Next step"})
+    assert_response :success
+  end
+
+  protected
+  def mock_company(stubs={})
+    @mock_company ||= mock(stubs)
+  end
+end