gendalf 0.1 → 0.2

data/CHANGELOG

@@ -1 +1,3 @@
-v0.1. just a placeholder for the coming gem
+v0.2. First working implementation
+
+v0.1. Initial gem release

data/Manifest

@@ -1,4 +1,8 @@
 CHANGELOG
-README
-Rakefile
 Manifest
+Rakefile
+gendalf.gemspec
+lib/controllers/wizard_controller.rb
+lib/extensions/routes.rb
+lib/gendalf.rb
+lib/models/wizard_model.rb

data/Rakefile

@@ -1,2 +1,11 @@
 require 'echoe'  
-Echoe.new('gendalf')
+Echoe.new('gendalf') do |p|
+  p.project = 'gendalf'
+  p.author = 'Ivan Kasatenko'
+  p.email = 'sky.31338@gmail.com'
+  p.summary = 'Trivial gem to support wizard application style creation.'
+  p.url = 'http://github.com/skywriter/gendalf'
+  p.runtime_dependencies = ['activemodel', 'actionpack']
+  p.development_dependencies = ['echoe']
+  p.retain_gemspec = true
+end

data/gendalf.gemspec

@@ -2,29 +2,38 @@
 
 Gem::Specification.new do |s|
   s.name = %q{gendalf}
-  s.version = "0.1"
+  s.version = "0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
-  s.authors = [""]
-  s.date = %q{2011-02-15}
-  s.description = %q{}
-  s.email = %q{}
-  s.extra_rdoc_files = ["CHANGELOG", "README"]
-  s.files = ["CHANGELOG", "README", "Rakefile", "Manifest", "gendalf.gemspec"]
-  s.homepage = %q{}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Gendalf", "--main", "README"]
+  s.authors = ["Ivan Kasatenko"]
+  s.date = %q{2011-02-16}
+  s.description = %q{Trivial gem to support wizard application style creation.}
+  s.email = %q{sky.31338@gmail.com}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/controllers/wizard_controller.rb", "lib/extensions/routes.rb", "lib/gendalf.rb", "lib/models/wizard_model.rb"]
+  s.files = ["CHANGELOG", "Manifest", "Rakefile", "gendalf.gemspec", "lib/controllers/wizard_controller.rb", "lib/extensions/routes.rb", "lib/gendalf.rb", "lib/models/wizard_model.rb"]
+  s.homepage = %q{http://github.com/skywriter/gendalf}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Gendalf"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{gendalf}
   s.rubygems_version = %q{1.3.7}
-  s.summary = %q{}
+  s.summary = %q{Trivial gem to support wizard application style creation.}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activemodel>, [">= 0"])
+      s.add_runtime_dependency(%q<actionpack>, [">= 0"])
+      s.add_development_dependency(%q<echoe>, [">= 0"])
     else
+      s.add_dependency(%q<activemodel>, [">= 0"])
+      s.add_dependency(%q<actionpack>, [">= 0"])
+      s.add_dependency(%q<echoe>, [">= 0"])
     end
   else
+    s.add_dependency(%q<activemodel>, [">= 0"])
+    s.add_dependency(%q<actionpack>, [">= 0"])
+    s.add_dependency(%q<echoe>, [">= 0"])
   end
 end

data/lib/controllers/wizard_controller.rb

@@ -0,0 +1,97 @@
+module Gendalf 
+  
+  class WizardController < ActionController::Base
+    protect_from_forgery
+    
+    before_filter :redirect_to_current_step
+  
+    def model
+      @@model_name.to_s.camelize.constantize.steps[step_no]
+    end
+    
+    def step
+      @step = model.new(params[param_name])
+      send step_action_name
+      render :action => step_action_name
+    end
+  
+    def step_submit
+      if proceed_custom_or_default_step_submit
+        if respond_to?(step_action_name(step_no+1))
+          self.current_step = step_no+1
+          redirect_to wizard_path(self.current_step)
+        end
+      else
+        render :action => step_action_name
+      end
+    end
+  
+    class << self
+      def set_model_name(model_name)
+        @@model_name = model_name
+      end
+    
+      def model_name
+        @@model_name
+      end
+    end
+  
+    def default
+      redirect_to custom_wizard_path(current_step)
+    end
+  
+  protected
+
+    def wizard_model
+      raise "Please, implement 'wizard_model' method in #{self.class.name}"
+    end
+  
+    def current_step
+      raise "Please, implement 'current_step' method in #{self.class.name}"
+    end
+
+    def current_step=(step)
+      raise "Please, implement 'current_step=' method in #{self.class.name}"
+    end
+  
+    def wizard_path(step)
+      send("#{self.class.name.gsub('Controller', '').underscore}_path", :step => step+1)
+    end  
+
+  private
+
+    def redirect_to_current_step
+      redirect_to wizard_path(current_step) unless step_no == current_step
+    end
+  
+    def param_name
+      model.name.underscore
+    end
+
+    def proceed_custom_or_default_step_submit
+      respond_to?("#{step_action_name}_submit") ? 
+        send("#{step_action_name}_submit") :
+        default_step_submit
+    end
+
+    def default_step_submit
+      @step = model.new(params[param_name])
+      if @step.valid?
+        wizard_model.merge_step!(@step)
+        true
+      else
+        flash[:error] = @step.errors.full_messages
+        false
+      end
+    end
+
+    def step_no
+      params[:step].to_i-1
+    end
+
+    def step_action_name(action_step_no=nil)
+      "step#{action_step_no || step_no}"
+    end
+  end
+
+end

data/lib/extensions/routes.rb

@@ -0,0 +1,13 @@
+class ActionDispatch::Routing::Mapper
+  def wizard(url, controller, total_steps)
+    match "#{url}/step:step" => "#{controller.to_s.underscore}#step", :via => :get, :as => controller.to_s.underscore.to_sym
+    match "#{url}/step:step" => "#{controller.to_s.underscore}#step_submit", :via => :post, :as => controller.to_s.underscore.to_sym
+    match "#{url}" => "#{controller.to_s.underscore}#default", :via => :get
+
+
+    model_prefix = "#{controller.to_s.camelcase}Controller".constantize.model_name.to_s.underscore    
+    total_steps.times do |idx|
+      match "#{url}/step#{idx+1}" => "#{controller.to_s.underscore}#step", :via => :get, :as => "#{model_prefix}_#{idx}_steps"
+    end
+  end
+end

data/lib/gendalf.rb

@@ -0,0 +1,5 @@
+$HERE = File.dirname(__FILE__)
+
+require "#{$HERE}/controllers/wizard_controller.rb"
+require "#{$HERE}/models/wizard_model.rb"
+require "#{$HERE}/extensions/routes.rb"

data/lib/models/wizard_model.rb

@@ -0,0 +1,92 @@
+module Gendalf 
+  
+  class WizardModel
+    include ActiveModel::Validations
+    include ActiveModel::Serialization
+  
+    attr_accessor :step
+  
+    def merge_step!(step_model)
+      step_model.class.step_attributes.each do |attrib|
+        send("#{attrib}=", step_model.send(attrib))
+      end
+    end
+  
+    class << self    
+      # Defines a step
+      def define_step(step_no, step_attributes, &validations_block)
+        define_attributes step_attributes
+      
+        @steps ||= []
+        @steps[step_no] = step_model_class(step_no, step_attributes, &validations_block)
+      end
+    
+      def define_null_step(step_no)
+        define_step step_no, [] do
+        end
+      end
+
+      alias_method :define_final_step, :define_null_step
+    
+      def steps
+        @steps
+      end
+
+    private
+      # Defines steps attributes.
+      def define_attributes(step_attributes)
+        [*step_attributes].each do |attrib|
+          instance_eval do
+            attr_accessor attrib.to_sym
+          end
+        end
+      end
+    
+      # Create a step model class (used for validations and holding intermediate step values)
+      def step_model_class(step_no, step_attributes, &validations_block)
+        step_model_class = Class.new
+      
+        # make its name accessible to itself
+        step_model_class.instance_variable_set :@name, "#{self.name}_#{step_no}_Step"
+        # ... and save step attributes for future merging
+        step_model_class.instance_variable_set :@step_attributes, [*step_attributes]
+      
+        # make it an proper ActiveModel
+        step_model_class.instance_eval do
+          include ActiveModel::Validations
+          include ActiveModel::Serialization
+          include ActiveModel::Conversion
+        
+          def name; @name; end
+          def step_attributes; @step_attributes; end
+        end
+      
+        step_model_class.class_eval do
+          def initialize(attributes = {})
+            return unless attributes.kind_of? Hash
+            attributes.each do |name, value|  
+              send("#{name}=", value)  
+            end  
+          end
+        
+          def persisted?
+            false
+          end
+        end
+      
+        # define appropriate attributes for the step
+        [*step_attributes].each do |attrib|
+          step_model_class.instance_eval do
+            attr_accessor attrib.to_sym
+          end
+        end  
+      
+        # give user a chance to add the validations
+        step_model_class.instance_eval(&validations_block)
+      
+        return step_model_class
+      end
+    end  
+  end
+
+end

metadata

@@ -1,40 +1,87 @@
 --- !ruby/object:Gem::Specification 
 name: gendalf
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 1
-  version: "0.1"
+  - 2
+  version: "0.2"
 platform: ruby
 authors: 
-- ""
+- Ivan Kasatenko
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-02-15 00:00:00 +03:00
+date: 2011-02-16 00:00:00 +03:00
 default_executable: 
-dependencies: []
-
-description: ""
-email: ""
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activemodel
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Trivial gem to support wizard application style creation.
+email: sky.31338@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
 - CHANGELOG
-- README
+- lib/controllers/wizard_controller.rb
+- lib/extensions/routes.rb
+- lib/gendalf.rb
+- lib/models/wizard_model.rb
 files: 
 - CHANGELOG
-- README
-- Rakefile
 - Manifest
+- Rakefile
 - gendalf.gemspec
+- lib/controllers/wizard_controller.rb
+- lib/extensions/routes.rb
+- lib/gendalf.rb
+- lib/models/wizard_model.rb
 has_rdoc: true
-homepage: ""
+homepage: http://github.com/skywriter/gendalf
 licenses: []
 
 post_install_message: 
@@ -43,8 +90,6 @@ rdoc_options:
 - --inline-source
 - --title
 - Gendalf
-- --main
-- README
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -72,6 +117,6 @@ rubyforge_project: gendalf
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: ""
+summary: Trivial gem to support wizard application style creation.
 test_files: []