motivation 0.0.2 → 0.0.3

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+### 0.0.3 / 2013-03-14
+* Change 'incomplete' tranlation key part to 'default'
+
+### 0.0.2 / 2013-03-14
+
+* Flip the order of completion status and step_name in translation key
+
+### 0.0.1 / 2013-03-14
+
+Initial Release!

data/README.md

@@ -88,10 +88,33 @@ Note it currently does not include i18n, you can pass the generated keys straigh
 your helper (such as `t` in Rails views).
 
 ```
-motivation.next_check.translation_key #=> "motivations.profile.setup_twitter.incomplete"
+motivation.next_check.translation_key #=> "motivations.profile.setup_twitter.default"
 ```
 
-The key format is `motivations.motivation_subject.step_name.[incomplete|complete]`
+The key format is `motivations.motivation_subject.step_name.[default|complete]`.  Note you can
+call `default_translation_key` as a shortcut to always grab the default translation key.  This is
+useful if you want to always have the same messaging regardless of completion status.  If you
+wish to provide alternate messaging based on completion, fill our your local data with both `default`
+and `complete` keys.
+
+Here's an example locale that would match the motivation key structure:
+
+```yaml
+en:
+  motivations:
+    project:
+      name:
+        default: "Add a project name"
+        complete: "Your project is named!"
+      support_email:
+        default: "Setup a support email address"
+        complete: "Your support email is ready to go"
+      users_added:
+        default: "Now go sign up some users"
+        complete: "Awesome, you've got users!"
+```
+
+
 
 ## Contributing
 

data/lib/motivation/version.rb

@@ -1,3 +1,3 @@
 module Motivation
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/motivation.rb

@@ -156,18 +156,23 @@ module Motivation
     # or for a completed step
     #   'motivations.project.complete.signed_up'
     #
-    def translation_key
+    def translation_key(end_key = status_key)
        [
         "motivations",
         @motivation.translation_key,
         @check.name,
-        status_key
+        end_key
       ].join('.')
     end
+
+    def default_translation_key
+      translation_key(:default)
+    end
+
     private
 
     def status_key
-      completed? ? "complete" : "incomplete"
+      completed? ? "complete" : "default"
     end
   end
 

data/spec/motivation_spec.rb

@@ -171,9 +171,9 @@ describe Motivation::WrappedCheck, "#translation_key" do
   end
 
   context "for a incomplete step" do
-    it "generates a key like motivations.project.step_name.incomplete" do
+    it "generates a key like motivations.project.step_name.default" do
       check.flag = false
-      expect(wrapped_check.translation_key).to eq "motivations.project.foo_bar.incomplete"
+      expect(wrapped_check.translation_key).to eq "motivations.project.foo_bar.default"
     end
   end
 
@@ -183,4 +183,15 @@ describe Motivation::WrappedCheck, "#translation_key" do
       expect(wrapped_check.translation_key).to eq "motivations.project.foo_bar.complete"
     end
   end
+
+  context "when an end_key is passed" do
+    it "uses the end_key as the terminal position" do
+      expect(wrapped_check.translation_key(:foobar)).to eq "motivations.project.foo_bar.foobar"
+    end
+  end
+
+  it "provides #default_translation_key as a convienience" do
+    expect(wrapped_check.default_translation_key).to eq "motivations.project.foo_bar.default"
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: motivation
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2160517160 !ruby/object:Gem::Requirement
+  requirement: &2160517080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,7 @@ dependencies:
         version: 2.13.0
   type: :development
   prerelease: false
-  version_requirements: *2160517160
+  version_requirements: *2160517080
 description: Simple DSL for use in classes to motivate a user towards a goal
 email:
 - xternal1+github@gmail.com
@@ -30,6 +30,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md