wizardry 0.0.2 → 0.0.3

data/README.md

@@ -4,7 +4,7 @@ Simple step-by-step wizard for Rails.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's `Gemfile`:
 
 ```ruby
 gem 'wizardry'
@@ -63,7 +63,7 @@ To get name of the next and previous steps:
 @product.previous_step
 ```
 
-If not exists next/previous step then `nil` will be returned.
+If not exists **next/previous** step then `nil` will be returned.
 
 Class methods are accessible:
 
@@ -85,5 +85,39 @@ end
 wizardry_resources :products
 ```
 
-will replace default *:id/edit* path with *:id/edit/:step* (and `:step => /initial|middle|final/` in our example).
+will replace default `:id/edit` path with `:id/edit/:step` (and `:step => /initial|middle|final/` in our example).
 `has_wizardry` is also acceptable for singular resources. And `wizardry_resource` herper is here for that.
+
+## I18n
+
+```
+en:
+  wizardry:
+    steps:
+      initial: 'Product details'
+      middle: 'Upload images'
+```
+
+To get the translated step name:
+
+```ruby
+@product.step_title(:middle) # => 'Upload images'
+```
+
+If you are passing nonexistent step name, then will be returned `nil`.
+
+Without providing the step name, you will get the translation for `current_step`:
+
+```ruby
+@product.step_title # => 'Product details'
+```
+
+In case of absence of step translation:
+
+```ruby
+@product.step_title(:final) # => 'Final'
+```
+
+## License
+
+MIT License. Copyright 2012 Aleksey Magusev.

data/lib/wizardry/base.rb

@@ -36,16 +36,21 @@ module Wizardry
       end
 
       def next_step
-        steps[current_step_index + 1] unless last_step?
+        steps[current_step_idx + 1] unless last_step?
       end
 
       def previous_step
-        steps[current_step_index - 1] unless first_step?
+        steps[current_step_idx - 1] unless first_step?
+      end
+
+      def step_title(step = current_step)
+        return nil if step !~ steps_regexp
+        I18n.translate(step, scope: 'wizardry.steps', default: step.to_s.humanize)
       end
 
       private
 
-      def current_step_index
+      def current_step_idx
         steps.index(current_step)
       end
     end

data/lib/wizardry/version.rb

@@ -1,3 +1,3 @@
 module Wizardry
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

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

@@ -2,4 +2,7 @@
 # See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
 
 en:
-  hello: "Hello world"
+  wizardry:
+    steps:
+      initial: Product details
+      middle: Upload images

data/spec/wizardry/base_spec.rb

@@ -77,5 +77,24 @@ describe Wizardry::Base do
       @product.current_step = :middle
       assert_equal @product.previous_step, 'initial'
     end
+
+    it 'must return translated name of step' do
+      assert_equal @product.step_title(:middle), 'Upload images'
+    end
+
+    it 'must return translated name of current step if no step passed' do
+      assert_equal @product.step_title, 'Product details'
+      @product.current_step = :middle
+      assert_equal @product.step_title, 'Upload images'
+    end
+
+    it 'must fall back to default name of step' do
+      assert_equal @product.step_title(:final), 'Final'
+      assert_equal @product.step_title('final'), 'Final'
+    end
+
+    it 'must return `nil` for nonexistent step name' do
+      assert_nil @product.step_title(:fictional)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wizardry
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-13 00:00:00.000000000 Z
+date: 2012-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -128,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4094284250890369797
+      hash: -1406875781771055287
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -137,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4094284250890369797
+      hash: -1406875781771055287
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24