wicked 0.4.0 → 0.5.0

data/README.md

@@ -278,6 +278,49 @@ Now when you visit your controller with the proper locale set your url's should
 
 Wicked expects your files to be named the same as your keys, so when a user visits `after_signup/dos` with the `es` locale it will render the `second.html.erb` file.
 
+
+**Important:** When you do this the value of `step` as well as
+`next_step` and `previous_step` and all the values within `steps` will
+be translated to what locale you are using. To translate them to the
+"canonical" values that you've have in your controller you'll need so
+use `wizard_value` method.
+
+For example, if you had this in your controller, and you converted it to
+a use Wicked translations, so this will not work:
+
+```
+  steps :confirm_password, :confirm_profile, :find_friends
+
+  def show
+    case step
+    when :find_friends
+      @friends = current_user.find_friends
+    end
+    render_wizard
+  end
+```
+
+Instead you need to use `wizard_value` to get the "reverse translation" in your controller code like this:
+
+
+```
+  steps :confirm_password, :confirm_profile, :find_friends
+
+  def show
+    case wizard_value(step)
+    when :find_friends
+      @friends = current_user.find_friends
+    end
+    render_wizard
+  end
+```
+
+The important thing to remember is that `step` and the values in `steps` are
+always going to be in the same language if you're using the Wicked translations.
+If you need any values to match the values set directly in your controller,
+ or the names of your files (i.e. `views/../confirm_password.html.erb`, then you need
+to use `wizard_value` method.
+
 ## Custom URL's
 
 Very similar to using I18n from above but instead of making new files for different languages, you can stick with one language. Make sure you are using the right module:
@@ -301,6 +344,10 @@ Now you can change the values in the URL's to whatever you want without changing
 ```ruby
 config.i18n.default_locale = :de
 ```
+**Important:** Don't forget to use `wizard_value()` method to make
+sure you are using the right cannonical values of `step`,
+`previous_step`, `next_step`, etc. If you are comparing them to non
+wicked generate values.
 
 Custom crafted wizard urls: just another way Wicked makes your app a little more saintly.
 
@@ -324,7 +371,7 @@ def set_steps
 end
 ```
 
-Note: Do not pass user submitted params directly into `self.steps` while using the custom or translated urls. The translator calls `to_sym` on steps provided, and if a user is allowed to submit arbitrary symbols, they could flood the take down your production app by filling up the symbol table. So just don't do it.
+Note: Do not pass user submitted params directly into `self.steps` while using the custom or translated urls. The translator calls `to_sym` on steps provided, and if a user is allowed to submit arbitrary symbols, they could flood the take down your production app by filling up the symbol table. So, just don't do it.
 
 ## About
 

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

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

@@ -8,7 +8,7 @@ module Wicked::Controller::Concerns::RenderRedirect
     if @skip_to
       redirect_to wizard_path(@skip_to), options
     else
-      render_step @step, options
+      render_step wizard_value(step), options
     end
   end
 

data/lib/wicked/wizard.rb

@@ -22,6 +22,11 @@ module Wicked
       redirect_to wizard_path(steps.first, clean_params)
     end
 
+    # returns the canonical value for a step name, needed for translation support
+    def wizard_value(step_name)
+      step_name
+    end
+
     private
 
     def clean_params
@@ -45,12 +50,16 @@ module Wicked
       raise "Wicked Wizard steps expected but not yet set, if setting via `before_filter` use `prepend_before_filter`" if steps.nil?
     end
 
-    def setup_wizard
-      @step          = setup_step_from(params[:id])
-      check_steps!(@step)
+    def set_previous_next(step)
       @previous_step = previous_step(@step)
       @next_step     = next_step(@step)
     end
+
+    def setup_wizard
+      @step = setup_step_from(params[:id])
+      check_steps!(@step)
+      set_previous_next(@step)
+    end
     public
   end
 end

data/lib/wicked/wizard/translated.rb

@@ -2,28 +2,65 @@ module Wicked
   module Wizard
     module Translated
       extend ActiveSupport::Concern
+      include Wicked::Wizard
 
       included do
-        include Wicked::Wizard
         skip_before_filter :setup_wizard
         before_filter      :setup_wizard_translated
+
+        helper_method      :wizard_translate, :wizard_value
       end
 
       # creates a hash where keys are translated steps, values are the name of the view file
-      # {:first => "first", :second => "second"}
-      # {:uno   => "first",   :dos  => "second"}
+      #
+      #  es:
+      #    hello: "hola mundo"
+      #    wicked:
+      #      first: "uno"
+      #      second: "dos"
+      #
+      #   steps :first, :second
+      #
+      # {:uno   => :first, :dos    => :second} # spanish
+      # {:first => :first, :second => :second} # english
       #
       def wizard_translations
         @wizard_translations ||= steps.inject(ActiveSupport::OrderedHash.new) do |hash, step|
-          step        = step.to_s.split(".").last
-          translation = I18n.t("wicked.#{step}").to_sym
+          step              = step.to_s.split(".").last
+          translation       = wizard_translate(step)
           hash[translation] = step.to_sym
           hash
         end
       end
 
-      private
+      # takes a canonical wizard value and translates to correct language
+      #
+      # es.yml
+      # wicked:
+      #   first: "uno"
+      #
+      #   wizard_translate(:first) # => :uno
+      def wizard_translate(step_name)
+        I18n.t("wicked.#{step_name}", :raise => true).to_sym
+      rescue I18n::MissingTranslationData
+        # don't symbolize if key doesn't exist
+        I18n.t("wicked.#{step_name}")
+      end
+
+      # takes an already translated value and converts to a canonical wizard value
+      #
+      # es.yml
+      # wicked:
+      #   first: "uno"
+      #
+      #   wizard_value(step) # => :first
+      #
+      def wizard_value(step_name)
+        wizard_translations[step]
+      end
+
 
+      private
       # sets up a translated wizard controller
       # translations are expected under the 'wicked' namespace
       #
@@ -41,14 +78,13 @@ module Wicked
       #     steps "wicked.first", "wicked.second"
       #
       def setup_wizard_translated
-        self.steps     = wizard_translations.keys     # must come before setting previous/next steps
-        step_name      = setup_step_from(params[:id])
-        check_steps!(step_name)
-        @previous_step = previous_step(step_name)
-        @next_step     = next_step(step_name)
-        @step          = wizard_translations[step_name]  # translates step name to url
+        self.steps = wizard_translations.keys     # must come before setting previous/next steps
+        @step      = setup_step_from(params[:id])
+        check_steps!(@step)
+        set_previous_next(@step)
       end
       public
     end
   end
 end
+

data/test/dummy/app/controllers/i18n_controller.rb

@@ -1,7 +1,7 @@
 class I18nController < ApplicationController
   include Wicked::Wizard::Translated
 
-  steps :first, :second
+  steps :first, :second, :last_step
 
   def show
     render_wizard

data/test/dummy/app/views/i18n/first.html.erb

@@ -1,4 +1,5 @@
-<%= I18n.t('wicked.first') %>
+<%= "Hey ya'll we're looking at: #{I18n.t('wicked.first')}" %>
 
+<%= render :partial =>  "step_positions/step_position" %>
 
-<%= link_to "hello", next_wizard_path %>
+<%= link_to "hello", next_wizard_path %>

data/test/dummy/app/views/i18n/last_step.html.erb

@@ -0,0 +1,9 @@
+
+<%= "Hey ya'll we're looking at: #{I18n.t('wicked.last_step')}" %>
+
+
+<%= render :partial =>  "step_positions/step_position" %>
+
+
+
+

data/test/dummy/app/views/i18n/second.html.erb

@@ -1 +1,7 @@
-<%= I18n.t('wicked.second') %>
+<%= "Hey ya'll we're looking at: #{I18n.t('wicked.second')}" %>
+
+
+
+<%= render :partial =>  "step_positions/step_position" %>
+
+

data/test/dummy/app/views/step_positions/_step_position.html.erb

@@ -1,9 +1,10 @@
 <% wizard_steps.each do |s| %>
   <p>
-    <%= "#{s} step is the current step"    if current_step?(s)  %><br />
-    <%= "#{s} step is a past step"         if past_step?(s) %><br />
-    <%= "#{s} step is a future step"       if future_step?(s)   %><br />
-    <%= "#{s} step was the previous step"  if previous_step?(s)     %><br />
-    <%= "#{s} step is the next step"       if next_step?(s)     %><br />
+    <strong><u><%= s.inspect %></u></strong><br />
+    <%= current_step?(s)  ? "#{s} step is the current step"   : "nope" %><br />
+    <%= past_step?(s)     ? "#{s} step is a past step"        : "nope" %><br />
+    <%= future_step?(s)   ? "#{s} step is a future step"      : "nope" %><br />
+    <%= previous_step?(s) ? "#{s} step was the previous step" : "nope" %><br />
+    <%= next_step?(s)     ? "#{s} step is the next step"      : "nope" %><br />
   </p>
-<% end %>
+<% end %>

data/test/dummy/config/locales/en.yml

@@ -5,4 +5,5 @@ en:
   hello: "Hello world"
   wicked:
     first: "first"
-    second: "second"
+    second: "second"
+    last_step: "last_step"

data/test/dummy/config/locales/es.yml

@@ -5,4 +5,6 @@ es:
   hello: "hola mundo"
   wicked:
     first: "uno"
-    second: "dos"
+    second: "dos"
+    last_step: "último_paso"
+

data/test/integration/i18n_test.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 require 'test_helper'
 
 class I18nTest < ActiveSupport::IntegrationCase
@@ -5,14 +7,27 @@ class I18nTest < ActiveSupport::IntegrationCase
   test 'renders in spanish' do
     step = :uno
     visit(i18n_path(step, :locale => :es))
-    assert has_content?('uno')
+    assert has_content?("Hey ya'll we're looking at: uno")
     assert has_link?('hello', :href => i18n_path(:dos))
+    assert has_content?('uno step is the current step')      # current_step?
+    assert true                                              # past_step?
+    assert has_content?('dos step is a future step')         # future_step?
+    assert has_content?('último_paso step is a future step') # future_step?
+    assert true                                              # previous_step?
+    assert has_content?('dos step is the next step')         # next_step?
   end
 
   test 'renders in english' do
     step = :first
     visit(i18n_path(step, :locale => :en))
-    assert has_content?('first')
+    assert has_content?("Hey ya'll we're looking at: first")
     assert has_link?('hello', :href => i18n_path(:second))
+
+    assert has_content?('first step is the current step')   # current_step?
+    assert true                                             # past_step?
+    assert has_content?('last_step step is a future step')  # future_step?
+    assert has_content?('second step is a future step')     # future_step?
+    assert true                                             # previous_step?
+    assert has_content?('second step is the next step')     # next_step?
   end
 end

data/wicked.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "wicked"
-  s.version = "0.4.0"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["schneems"]
-  s.date = "2013-01-16"
+  s.date = "2013-01-27"
   s.description = "Wicked is a Rails engine for producing easy wizard controllers"
   s.email = "richard.schneeman@gmail.com"
   s.extra_rdoc_files = [
@@ -49,6 +49,7 @@ Gem::Specification.new do |s|
     "test/dummy/app/views/bar/second.html.erb",
     "test/dummy/app/views/dynamic_steps/first.html.erb",
     "test/dummy/app/views/i18n/first.html.erb",
+    "test/dummy/app/views/i18n/last_step.html.erb",
     "test/dummy/app/views/i18n/second.html.erb",
     "test/dummy/app/views/jump/first.html.erb",
     "test/dummy/app/views/jump/last_step.html.erb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wicked
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-16 00:00:00.000000000Z
+date: 2013-01-27 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70204702345240 !ruby/object:Gem::Requirement
+  requirement: &70274032800580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *70204702345240
+  version_requirements: *70274032800580
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70204702344580 !ruby/object:Gem::Requirement
+  requirement: &70274032799480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 3.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *70204702344580
+  version_requirements: *70274032799480
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70204702343980 !ruby/object:Gem::Requirement
+  requirement: &70274032798600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70204702343980
+  version_requirements: *70274032798600
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70204702341060 !ruby/object:Gem::Requirement
+  requirement: &70274032797260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70204702341060
+  version_requirements: *70274032797260
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70204702340560 !ruby/object:Gem::Requirement
+  requirement: &70274032795260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70204702340560
+  version_requirements: *70274032795260
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &70204702340040 !ruby/object:Gem::Requirement
+  requirement: &70274032793220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: 0.4.0
   type: :development
   prerelease: false
-  version_requirements: *70204702340040
+  version_requirements: *70274032793220
 - !ruby/object:Gem::Dependency
   name: launchy
-  requirement: &70204702339560 !ruby/object:Gem::Requirement
+  requirement: &70274032791980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70204702339560
+  version_requirements: *70274032791980
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70204702339020 !ruby/object:Gem::Requirement
+  requirement: &70274032790300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70204702339020
+  version_requirements: *70274032790300
 - !ruby/object:Gem::Dependency
   name: activerecord-jdbcsqlite3-adapter
-  requirement: &70204702338540 !ruby/object:Gem::Requirement
+  requirement: &70274032789360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +109,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70204702338540
+  version_requirements: *70274032789360
 description: Wicked is a Rails engine for producing easy wizard controllers
 email: richard.schneeman@gmail.com
 executables: []
@@ -150,6 +150,7 @@ files:
 - test/dummy/app/views/bar/second.html.erb
 - test/dummy/app/views/dynamic_steps/first.html.erb
 - test/dummy/app/views/i18n/first.html.erb
+- test/dummy/app/views/i18n/last_step.html.erb
 - test/dummy/app/views/i18n/second.html.erb
 - test/dummy/app/views/jump/first.html.erb
 - test/dummy/app/views/jump/last_step.html.erb
@@ -217,7 +218,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2935823026133279485
+      hash: 3061735520943754362
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: