stepper 0.0.1

data/.document

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

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+gem "rails", "~> 3.1.0"
+
+group :development do
+  gem "ruby-debug19", :require => 'ruby-debug'
+  gem "sqlite3"
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem "mocha"
+  gem "capybara"
+  gem "launchy"
+end
+

data/Gemfile.lock

@@ -0,0 +1,144 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.1.0)
+      actionpack (= 3.1.0)
+      mail (~> 2.3.0)
+    actionpack (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.2)
+      rack-cache (~> 1.0.3)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.0)
+    activemodel (3.1.0)
+      activesupport (= 3.1.0)
+      bcrypt-ruby (~> 3.0.0)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activeresource (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+    activesupport (3.1.0)
+      multi_json (~> 1.0)
+    addressable (2.2.6)
+    archive-tar-minitar (0.5.2)
+    arel (2.2.1)
+    bcrypt-ruby (3.0.1)
+    builder (3.0.0)
+    capybara (1.1.1)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 0.1.4)
+    childprocess (0.2.2)
+      ffi (~> 1.0.6)
+    columnize (0.3.4)
+    erubis (2.7.0)
+    ffi (1.0.9)
+    git (1.2.5)
+    hike (1.2.1)
+    i18n (0.6.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json_pure (1.6.1)
+    launchy (2.0.5)
+      addressable (~> 2.2.6)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    mail (2.3.0)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    metaclass (0.0.1)
+    mime-types (1.16)
+    mocha (0.10.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.0.3)
+    nokogiri (1.5.0)
+    polyglot (0.3.2)
+    rack (1.3.3)
+    rack-cache (1.0.3)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.1.0)
+      actionmailer (= 3.1.0)
+      actionpack (= 3.1.0)
+      activerecord (= 3.1.0)
+      activeresource (= 3.1.0)
+      activesupport (= 3.1.0)
+      bundler (~> 1.0)
+      railties (= 3.1.0)
+    railties (3.1.0)
+      actionpack (= 3.1.0)
+      activesupport (= 3.1.0)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2)
+    rcov (0.9.10)
+    rdoc (3.9.4)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    rubyzip (0.9.4)
+    selenium-webdriver (2.7.0)
+      childprocess (>= 0.2.1)
+      ffi (>= 1.0.7)
+      json_pure
+      rubyzip
+    shoulda (2.11.3)
+    sprockets (2.0.0)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (!= 1.3.0, ~> 1.1)
+    sqlite3 (1.3.4)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.29)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  capybara
+  jeweler (~> 1.6.4)
+  launchy
+  mocha
+  rails (~> 3.1.0)
+  rcov
+  ruby-debug19
+  shoulda
+  sqlite3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Anton Versal
+
+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,84 @@
+= Stepper
+
+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.
+== Installation
+You can use it with Rails 3:
+
+  gem install stepper
+== Getting Started
+=== Configuring model
+Create migration for model:
+
+  add_column :companies, :current_step, :string
+  add_index  :companies, :current_step
+
+Setup names of steps that you want to have:
+
+  has_steps :steps => %w{name city kind}
+
+Setup validation for each step if necessary, method should have name like <tt>validation_#{step_name}</tt>:
+
+  def validate_name
+    self.validates_presence_of :name
+  end
+
+  def validate_city
+    self.validates_presence_of :city
+  end
+
+  def validate_kind
+    self.validates_presence_of :kind
+  end
+
+Now Your model ready for multistep form!
+=== Configuring controller
+
+Stepper use +update+, +create+ and +new+ action.
+
+For controller you need just add +has_steps+ method:
+  class CompaniesController < ApplicationController
+    has_steps
+  end
+
+And you should have +show+ action because stepper redirects to it when last step finished. It will be configurable in a feature.
+=== Configuring view
+
+Add stepper helper method into the form in view that rendered by new action:
+
+  <%= form_for(@company) do |f| %>
+    <%= stepper f %>
+  <% end %>
+
++stepper+ helper renders partial according to the current step of form. Partials should have name like <tt>#{step_name}_step</tt>:
+
++name_step.html.erb+
+
+  <%= f.label :name %>
+  <%= f.text_field :name %>
+
++city_step.html.erb+
+
+  <%= f.label :city %>
+  <%= f.text_field :city %>
+
++kind_step.html.erb+
+
+  <%= f.label :kind %>
+  <%= f.text_field :kind %>
+
+== Contributing to stepper
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Anton Versal. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "stepper"
+  gem.homepage = "http://github.com/antonversal/stepper"
+  gem.license = "MIT"
+  gem.summary = %Q{Stepper is multistep form (wizard) solution for Rails 3.}
+  gem.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.}
+  gem.email = "ant.ver@gmail.com"
+  gem.authors = ["Anton Versal"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "stepper #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/app/views/stepper/_fields.html.erb

@@ -0,0 +1,17 @@
+<div class="stepper">
+  <%= f.hidden_field current_step_column, :value => resource.next_step %>
+  <%= render "#{resource.next_step}_step", :f => f %>
+
+  <ul class="actions">
+    <li class="first save"><%= f.submit :value => t('stepper.save').html_safe %></li>
+    <% unless resource.first_step?(resource.next_step) %>
+      <li class="previous_step"><%= f.submit :value => t('stepper.previous_step').html_safe %></li>
+    <% end %>
+    <% unless resource.last_step?(resource.next_step) %>
+      <li class="last next_step"><%= f.submit :value =>t('stepper.next_step').html_safe %></li>
+    <% else %>
+      <li class="last finish"><%= f.submit :value =>t('stepper.finish').html_safe %></li>
+    <% end %>
+  </ul>
+</div>
+

data/config/locales/stepper.yml

@@ -0,0 +1,6 @@
+en:
+  stepper:
+    next_step: 'Next'
+    previous_step: 'Previous'
+    save: 'Save'
+    finish: 'Finish'

data/lib/stepper.rb

@@ -0,0 +1,3 @@
+require 'rails'
+
+require 'stepper/railtie'

data/lib/stepper/controllers/controller_additions.rb

@@ -0,0 +1,75 @@
+module Stepper
+  module ControllerAdditions
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def has_steps(*args)
+        include InstanceMethods
+        stepper_resource_class.add_before_filter(self, *args)
+      end
+
+      def stepper_resource_class
+        ControllerResource
+      end
+
+    end
+
+    module InstanceMethods
+
+      def create
+        respond_to do |format|
+          if @_stepper_resource_instance.save
+            format.html { redirect_steps }
+          else
+            @_stepper_resource_instance.previous_step!
+            format.html { render :action => "new" }
+          end
+        end
+      end
+
+      def update
+
+        @_stepper_resource_instance.previous_step!.previous_step! if params[:commit] == t('stepper.previous_step').html_safe
+
+        @_stepper_resource_instance.previous_step! if params[:commit] == t('stepper.save').html_safe
+
+        respond_to do |format|
+          if @_stepper_resource_instance.save
+            format.html { redirect_steps }
+          else
+            @_stepper_resource_instance.previous_step!
+            format.html { render :action => "new" }
+          end
+        end
+      end
+
+      def new
+      end
+
+      protected
+
+        def redirect_steps
+          if params[:commit] == t('stepper.save').html_safe
+            redirect_to url_for(sanitized_params.merge(:action => "index"))
+          elsif params[:commit] == t('stepper.previous_step').html_safe and params[:action] == "update"
+            redirect_to url_for(sanitized_params.merge(:action => "new", :id => @_stepper_resource_instance.id))
+          elsif params[:commit] == t('stepper.next_step').html_safe
+            redirect_to url_for(sanitized_params.merge(:action => "new", :id => @_stepper_resource_instance.id)), :notice => "Step #{@_stepper_resource_instance.stepper_current_step.humanize} was successfully created."
+          elsif params[:commit] == t('stepper.finish').html_safe
+            redirect_to url_for(sanitized_params.merge(:action => "show", :id => @_stepper_resource_instance.id))
+          else
+            raise Stepper::StepperException.new("Unknown commit: #{params[:commit]}")
+          end
+        end
+
+        def sanitized_params
+          params.except(@_stepper_name, :commit, :id)
+        end
+    end
+
+  end
+
+end

data/lib/stepper/controllers/controller_resource.rb

@@ -0,0 +1,58 @@
+module Stepper
+  class ControllerResource
+
+    def self.add_before_filter(controller_class, *args)
+      resource_name = args.first
+      controller_class.send(:before_filter, :only => [:create, :update, :new]) do |controller|
+        controller_resource = controller.class.stepper_resource_class.new(controller, resource_name)
+        controller.instance_variable_set :@_stepper_resource_instance, controller_resource.load_resource
+        controller.instance_variable_set :@_stepper_name, controller_resource.name
+      end
+    end
+
+    def initialize(controller, *args)
+      @controller = controller
+      @params = controller.params
+      @name = args.first
+    end
+
+    def load_resource
+      self.resource_instance ||= load_resource_instance
+    end
+
+    def load_resource_instance
+      if @params[:action] == 'create'
+        resource = resource_class.new(@params[name] || {})
+      else
+        resource = unless @params[:id].blank?
+          resource_class.find(@params[:id])
+        else
+          resource_class.new
+        end
+        resource.attributes = @params[name] unless @params[name].blank?
+      end
+      resource
+    end
+
+    def resource_class
+      name.camelize.constantize
+    end
+
+    def name_from_controller
+      @params[:controller].sub("Controller", "").underscore.split('/').last.singularize
+    end
+
+    def name
+      @name || name_from_controller
+    end
+
+    def resource_instance=(object)
+      @controller.instance_variable_set "@#{name}", object
+    end
+
+    def resource_instance
+      @controller.instance_variable_get "@#{name}"
+    end
+
+  end
+end