motivation 0.0.1 → 0.0.2

data/README.md

@@ -1,7 +1,12 @@
 # Motivation
 
 Simple DSL for use in classes to motivate a user towards a goal.  An example
-goal might be "Complete Profile", or "Setup Project"
+goal might be "Complete Profile", or "Setup Project".
+
+This was heavily inspired by [progression](https://github.com/mguterl/progression).
+
+I switched primarily because I wanted to use specific classes rather than inject into
+an existing model namespace, and extend the DSL some.
 
 ## Installation
 
@@ -19,6 +24,8 @@ Or install it yourself as:
 
 ## Usage
 
+Create a motivational class and `include Motivation`.
+
 ```ruby
 require "motivation"
 
@@ -43,7 +50,7 @@ class ProfileMotivation
   # check is heavy and you want to use a cached result.  This
   # will define a method `#complete_tweets_added
   step :tweets_added
-  check { cached_tweets_count.to_i > 0 || profile.tweets.length > 0 }
+  check { profile.cached_tweets_count.to_i > 0 || profile.tweets.length > 0 }
   complete { profile.cached_tweets_count = profile.tweets.length.to_i }
 end
 
@@ -60,12 +67,31 @@ Note that the `check` and `complete` blocks will not tolerate early returns, you
 will get a `LocalJumpError`.  If you want to simplify your DSL definitions, you can
 just call methods, including privates, in your ProfileMotivation class itself.
 
-## Acknowledgements
+You can also iterate over checks for a motivation instance:
 
-This was heavily inspired by [progression](https://github.com/mguterl/progression).
+```ruby
+motivation.each_check do |check|
+  puts check.name
+  puts check.completed?
+end
+```
 
-I switched primarily because I wanted to use specific classes rather than inject into
-an existing model namespace, and extend the DSL some.
+You can get the next incomplete check, this is useful if you want to render
+a message in a header, for instance.
+
+```ruby
+motivation.next_check
+```
+
+Motivation checks are wrapped to provide a tranlation key suitable for use with i18n.
+Note it currently does not include i18n, you can pass the generated keys straight to
+your helper (such as `t` in Rails views).
+
+```
+motivation.next_check.translation_key #=> "motivations.profile.setup_twitter.incomplete"
+```
+
+The key format is `motivations.motivation_subject.step_name.[incomplete|complete]`
 
 ## Contributing
 

data/lib/motivation/version.rb

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

data/lib/motivation.rb

@@ -16,16 +16,20 @@ module Motivation
     true
   end
 
-  def checks
+  def unwrapped_checks
     self.class.checks
   end
 
+  def checks
+    unwrapped_checks.collect { |c| WrappedCheck.new(c, self) }
+  end
+
   def each_check(&block)
-    wrapped_checks.each &block
+    checks.each &block
   end
 
-  def wrapped_checks
-    checks.collect { |c| WrappedCheck.new(c, self) }
+  def next_check
+    checks.detect { |c| ! c.completed? }
   end
 
   def completions
@@ -155,9 +159,9 @@ module Motivation
     def translation_key
        [
         "motivations",
-        @motivation.key,
-        status_key,
-        @check.name
+        @motivation.translation_key,
+        @check.name,
+        status_key
       ].join('.')
     end
     private

data/spec/motivation_spec.rb

@@ -136,11 +136,26 @@ describe Motivation do
     end
   end
 
+  describe "getting the next check" do
+    it "returns the first wrapped check that is incomplete" do
+      project.name = "name"
+      project.subdomain = nil
+      expect(motivation.next_check.name.to_s).to eq "subdomain_setup"
+      project.subdomain = "subdomain"
+      expect(motivation.next_check.name.to_s).to eq "local_method_step"
+    end
+
+    it "returns nil if all checks are complete" do
+      motivation.method_check = true
+      expect(motivation.next_check).to be_nil
+    end
+  end
+
 end
 
 describe Motivation::WrappedCheck, "#translation_key" do
   let(:check) { OpenStruct.new }
-  let(:motivation) { stub(:motivation, :key => "project") }
+  let(:motivation) { stub(:motivation, :translation_key => "project") }
   let(:wrapped_check) { Motivation::WrappedCheck.new(check, motivation) }
 
   before do
@@ -156,16 +171,16 @@ describe Motivation::WrappedCheck, "#translation_key" do
   end
 
   context "for a incomplete step" do
-    it "generates a key like motivations.project.incomplete.step_name" do
+    it "generates a key like motivations.project.step_name.incomplete" do
       check.flag = false
-      expect(wrapped_check.translation_key).to eq "motivations.project.incomplete.foo_bar"
+      expect(wrapped_check.translation_key).to eq "motivations.project.foo_bar.incomplete"
     end
   end
 
   context "for a completed step" do
-    it "generates a key like motivations.project.complete.step_name" do
+    it "generates a key like motivations.project.step_name.complete" do
       check.flag = true
-      expect(wrapped_check.translation_key).to eq "motivations.project.complete.foo_bar"
+      expect(wrapped_check.translation_key).to eq "motivations.project.foo_bar.complete"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: motivation
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors: