wicked 0.3.0 → 0.3.1

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.3.1
+* Prettier code, thanks code climate
+
 ## 0.3.0
 
 * [#22] enable I18n on wicked paths with `Wicked::Wizard::Translated`

data/README.md

@@ -2,6 +2,8 @@
 
 [![Build Status](https://secure.travis-ci.org/schneems/wicked.png)](http://travis-ci.org/schneems/wicked)
 
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/schneems/wicked)
+
 Use wicked to make your Rails controllers into step-by-step wizards. To see Wicked in action check out the example [Rails app](https://github.com/schneems/wicked_example) or [watch the screencast](http://schneems.com/post/18437886598/wizard-ify-your-rails-controllers-with-wicked).
 
 ## Why
@@ -241,7 +243,7 @@ This will allow you to specify translation keys instead of literal step names. L
 
     steps :first, :second
 
-So the urls would be `/after_signup/first` and `/after_signup/second`. But you want them to show up differntly for different locales. For example someone coming form a Spanish speaking locale should see `/after_signup/uno` and `after_signup/dos`.
+So the urls would be `/after_signup/first` and `/after_signup/second`. But you want them to show up differently for different locales. For example someone coming form a Spanish speaking locale should see `/after_signup/uno` and `after_signup/dos`.
 
 To internationalize first you need to create your locales files under `config/locales` such as `config/locales/es.yml` for Spanish. You then need to add a `first` and `second` key under a `wicked` key like this:
 

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/lib/wicked/controller/concerns/steps.rb

@@ -15,32 +15,32 @@ module Wicked::Controller::Concerns::Steps
 
   # will return true if step passed in is the currently rendered step
   def current_step?(step_name)
-    return false if step_name.nil? || step.nil?
+    return false unless current_and_given_step_exists?(step_name)
     step == step_name
   end
 
   # will return true if the step passed in has already been executed by the wizard
   def past_step?(step_name)
-    return false if steps.index(step).nil? || steps.index(step_name).nil?
-    steps.index(step) > steps.index(step_name)
+    return false unless current_and_given_step_exists?(step_name)
+    current_step_index > step_index_for(step_name)
   end
 
   # will return true if the step passed in has already been executed by the wizard
   def future_step?(step_name)
-    return false if steps.index(step).nil? || steps.index(step_name).nil?
-    steps.index(step) < steps.index(step_name)
+    return false unless current_and_given_step_exists?(step_name)
+    current_step_index < step_index_for(step_name)
   end
 
   # will return true if the last step is the step passed in
   def previous_step?(step_name)
-    return false if steps.index(step).nil? || steps.index(step_name).nil?
-    steps.index(step) - 1  == steps.index(step_name)
+    return false unless current_and_given_step_exists?(step_name)
+    (current_step_index - 1)  == step_index_for(step_name)
   end
 
   # will return true if the next step is the step passed in
   def next_step?(step_name)
-    return false if steps.index(step).nil? || steps.index(step_name).nil?
-    steps.index(step) + 1  == steps.index(step_name)
+    return false unless current_and_given_step_exists?(step_name)
+    (current_step_index + 1)  == step_index_for(step_name)
   end
 
   module ClassMethods
@@ -80,5 +80,20 @@ module Wicked::Controller::Concerns::Steps
     step
   end
 
+  private
+
+  def step_index_for(step_name)
+    steps.index(step_name)
+  end
+
+  def current_step_index
+    step_index_for(step)
+  end
+
+  def current_and_given_step_exists?(step_name)
+    return false if current_step_index.nil? || steps.index(step_name).nil?
+    return true
+  end
+
 
 end

data/lib/wicked/wizard.rb

@@ -22,11 +22,20 @@ module Wicked
     end
 
     private
-    def setup_wizard
-      redirect_to wizard_path(steps.first) if params[:id].try(:to_sym) == :wizard_first
-      redirect_to wizard_path(steps.last)  if params[:id].try(:to_sym) == :wizard_last
 
-      @step          = params[:id].try(:to_sym) || steps.first
+    def check_redirect_to_first_last!(step)
+      redirect_to wizard_path(steps.first) if step == :wizard_first
+      redirect_to wizard_path(steps.last)  if step == :wizard_last
+    end
+
+    def setup_step_from(the_step)
+      the_step = the_step.try(:to_sym) || steps.first
+      check_redirect_to_first_last!(the_step)
+      return the_step
+    end
+
+    def setup_wizard
+      @step          = setup_step_from(params[:id])
       @previous_step = previous_step(@step)
       @next_step     = next_step(@step)
     end

data/lib/wicked/wizard/translated.rb

@@ -6,8 +6,7 @@ module Wicked
       included do
         include Wicked::Wizard
         skip_before_filter :setup_wizard
-
-        before_filter :setup_wizard_translated
+        before_filter      :setup_wizard_translated
       end
 
       # creates a hash where keys are translated steps, values are the name of the view file
@@ -41,18 +40,12 @@ module Wicked
       #
       #     steps "wicked.first", "wicked.second"
       #
-
       def setup_wizard_translated
-        self.steps     = wizard_translations.keys
-
-        redirect_to wizard_path(steps.first) if params[:id].try(:to_sym) == :wizard_first
-        redirect_to wizard_path(steps.last)  if params[:id].try(:to_sym) == :wizard_last
-        original_step = params[:id] = params[:id].to_sym
-
-
-        @previous_step = previous_step(original_step)
-        @next_step     = next_step(original_step)
-        @step          = wizard_translations[params[:id]]
+        step_name      = setup_step_from(params[:id])
+        self.steps     = wizard_translations.keys        # must come before setting previous/next steps
+        @previous_step = previous_step(step_name)
+        @next_step     = next_step(step_name)
+        @step          = wizard_translations[step_name]  # translates step name to url
       end
       public
     end

data/wicked.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "wicked"
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["schneems"]
-  s.date = "2012-10-30"
+  s.date = "2012-11-12"
   s.description = "Wicked is a Rails engine for producing easy wizard controllers"
   s.email = "richard.schneeman@gmail.com"
   s.extra_rdoc_files = [
@@ -100,7 +100,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/schneems/wicked"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
+  s.rubygems_version = "1.8.10"
   s.summary = "Use Wicked to turn your controller into a wizard"
 
   if s.respond_to? :specification_version then

metadata

@@ -1,165 +1,122 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: wicked
-version: !ruby/object:Gem::Version 
-  hash: 19
+version: !ruby/object:Gem::Version
+  version: 0.3.1
   prerelease: 
-  segments: 
-  - 0
-  - 3
-  - 0
-  version: 0.3.0
 platform: ruby
-authors: 
+authors:
 - schneems
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-10-30 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+date: 2012-11-12 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70119200321980 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 3
-        - 0
-        - 7
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.7
   type: :runtime
-  name: activesupport
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70119200321980
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70119200321480 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 3
-        - 0
-        - 7
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.7
   type: :runtime
-  name: rails
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70119200321480
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70119200320960 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  name: rake
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70119200320960
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70119200320460 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 1
-        - 6
-        - 4
+      - !ruby/object:Gem::Version
         version: 1.6.4
   type: :development
-  name: jeweler
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *70119200320460
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &70119200319960 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  name: rcov
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *70119200319960
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: &70119200319440 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 0
-        - 4
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.4.0
   type: :development
-  name: capybara
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *70119200319440
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: &70119200318900 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  name: launchy
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: *70119200318900
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70119200318400 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  name: sqlite3
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: *70119200318400
+- !ruby/object:Gem::Dependency
+  name: activerecord-jdbcsqlite3-adapter
+  requirement: &70119200317880 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  name: activerecord-jdbcsqlite3-adapter
-  version_requirements: *id009
+  prerelease: false
+  version_requirements: *70119200317880
 description: Wicked is a Rails engine for producing easy wizard controllers
 email: richard.schneeman@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.md
-files: 
+files:
 - .rvmrc
 - .travis.yml
 - CHANGELOG.md
@@ -241,37 +198,31 @@ files:
 - test/wicked_test.rb
 - wicked.gemspec
 homepage: http://github.com/schneems/wicked
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 3821284544051991557
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Use Wicked to turn your controller into a wizard
 test_files: []
-