riaction 1.1.0 → 1.2.0

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG #
 
+## 1.2.0 ##
+
+* Added rspec matchers
+* rake task to list all defined events also shows default params
+
 ## 1.1.0 ##
 
 * Entire re-spec and re-factor of gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    riaction (1.0.0)
+    riaction (1.2.0)
       activerecord (>= 3.0.0)
       activesupport (>= 3.0.0)
       rake

data/README.md

@@ -107,7 +107,14 @@ Models in your application may declare any number of events that they wish to lo
     #  stars                        :integer(4)
     #  text                         :string(255)
 
-In the above example, `:write_a_review` is the name of the event and should match the key used on IActionable.  The value for `:trigger` determines the action that will cause the event to fire, and can also be `:update` or `:destroy`, and will automatically fire when a record is created, updated, or destroyed, respectively. The value given to `:profile` should return the riaction profile object that this event will be logged under.
+In the above example: 
+
+* `:write_a_review` is the name of the event and should match the key used on IActionable.  
+* The value for `:trigger` determines the action that will cause the event to fire, and can also be `:update` or `:destroy`, and will automatically fire when a record is created, updated, or destroyed, respectively.
+* **If the value for `:trigger` is not given, `:create` will be assumed.**
+* The value given to `:profile` should return the riaction profile object that this event will be logged under.
+
+<!-- end list -->
 
 #### Event Parameters ####
 
@@ -123,7 +130,7 @@ Part of the power in the way IActionable may be configured to process your event
 
     riaction :event, :name => :write_a_review, :trigger => :create, :profile => :user, :params => Proc.new{|record| {:length => record.text.length}}
 
-...or the name of an instance method (which ought to return a hash)
+...or the name of an instance method (which ought to return a hash):
 
     riaction :event, :name => :write_a_review, :trigger => :create, :profile => :user, :params => :stats
 
@@ -155,12 +162,20 @@ If the object given as the riaction profile for an event defines more than one p
 
 #### Profiles With Their Own Events ####
 
-A class the declares itself as a profile may also declare events which rely on that same class as the profile object:
+A class that declares itself as a profile may also declare events, and for those events it may point to itself as the profile to use:
 
     riaction :profile, :type => :player, :custom => :id
     riaction :event, :name => :join_the_game, :trigger => :create, :profile => :self
 
-In the above example of a declaration on the User class, the user will fire a `:join_the_game` event using itself as the profile upon its creation.  The profile declaration should come before the event declaration.
+In the above example of a declaration on the User class, the user will fire a `:join_the_game` event using itself as the profile upon its creation.  _The profile declaration must come before the event declaration._
+
+#### Turning Riaction Off ####
+
+If you want to avoid the automatic creation of a profile, or the automatic logging of an event, classes that declare themselves as riaction profiles or event drivers provide a method to disable those automatic events:
+
+    User.riactionless{ User.create(:nickname => 'zortnac') }                    # won't create the profile for the newly created user
+    Review.riactionless{ @user_instance.reviews.create(:text => "loved it!") }  # won't fire the 'write_a_review' event
+    Review.riactionless{ @review_instance.trigger_thumbs_up! }                  # won't fire the 'receive_thumbs_up' event
 
 ### Rails Rake Tasks ###
 

data/lib/riaction.rb

@@ -1,4 +1,5 @@
 require 'ruby-iactionable'
 require "riaction/version"
 require "riaction/riaction"
-require "riaction/railtie" if defined?(Rails)
+require "riaction/railtie" if defined?(Rails)
+require "rspec/matchers/riaction" if defined?(RSpec)

data/lib/riaction/version.rb

@@ -1,3 +1,3 @@
 module Riaction
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/rspec/matchers/riaction.rb

@@ -0,0 +1,113 @@
+RSpec::Matchers.define :define_riaction_profile do |expected_type|
+  chain :identified_by do |identifiers|
+    @identifiers = identifiers
+  end
+    
+  match do |actual|
+    if actual.riactionary? && actual.riaction_profile? && actual.riaction_profile_keys.has_key?(expected_type)
+      if @identifiers.present?
+        if @identifiers.select{|id_type, id|  actual.riaction_profile_keys[expected_type][:identifiers].has_key?(id_type) &&
+                                              actual.riaction_profile_keys[expected_type][:identifiers][id_type] == id}.size == @identifiers.size
+          true
+        else
+          false
+        end
+      else
+        true
+      end
+    else
+      false
+    end
+  end
+  
+  failure_message_for_should do |actual|
+    if @identifiers.present?
+      "expected that #{actual} would define a riaction profile of type #{expected_type} with identifiers #{@identifiers.keys.join(", ")}"
+    else
+      "expected that #{actual} would define a riaction profile of type #{expected_type}"
+    end
+  end
+end
+
+RSpec::Matchers.define :identify_with_riaction_as do |expected_type, expected_ids|
+  match do |actual|
+    if  actual.class.riactionary? && 
+        actual.class.riaction_profile? && 
+        actual.riaction_profile_keys.has_key?(expected_type) &&
+        expected_ids.select{|id_type, id| actual.riaction_profile_keys[expected_type].fetch(id_type, nil) == id}.size == expected_ids.size
+      true
+    else
+      false
+    end
+  end
+  
+  failure_message_for_should do |actual|
+    "expected that instance of #{actual.class} would use the value(s) #{expected_ids} to identify to IActionable"
+  end
+end
+
+RSpec::Matchers.define :define_riaction_event do |expected_event|
+  chain :triggered_on do |expected_trigger|
+    @expected_trigger = expected_trigger
+  end
+    
+  match do |actual|
+    if actual.riactionary? && actual.riaction_events? && actual.riaction_events.has_key?(expected_event)
+      if @expected_trigger.present?
+        if actual.riaction_events[expected_event][:trigger] == @expected_trigger
+          true
+        else
+          false
+        end
+      else
+        true
+      end
+    else
+      false
+    end
+  end
+  
+  failure_message_for_should do |actual|
+    if @expected_trigger.present?
+      "expected that #{actual} would define a riaction event named #{expected_event} triggered on #{@expected_trigger}"
+    else
+      "expected that #{actual} would define a riaction event named #{expected_event}"
+    end
+  end
+end
+
+RSpec::Matchers.define :log_riaction_event_with_profile do |expected_event, expected_profile_type, expected_profile_id_type, expected_profile_id|
+  match do |actual|
+    if  actual.class.riactionary? && 
+        actual.class.riaction_events? && 
+        actual.riaction_event_params.has_key?(expected_event) &&
+        actual.riaction_event_params[expected_event][:profile][:type] == expected_profile_type &&
+        actual.riaction_event_params[expected_event][:profile][:id_type] == expected_profile_id_type &&
+        actual.riaction_event_params[expected_event][:profile][:id] == expected_profile_id
+      true
+    else
+      false
+    end
+  end
+  
+  failure_message_for_should do |actual|
+    "expected that instance of #{actual.class} would log event #{expected_event} with the profile keys: #{expected_profile_type}, #{expected_profile_id_type}, #{expected_profile_id}"
+  end
+end
+
+RSpec::Matchers.define :log_riaction_event_with_params do |expected_event, expected_params|
+  match do |actual|
+    if  actual.class.riactionary? && 
+        actual.class.riaction_events? && 
+        actual.riaction_event_params.has_key?(expected_event) &&
+        actual.riaction_event_params[expected_event][:params] == expected_params
+      true
+    else
+      false
+    end
+  end
+  
+  failure_message_for_should do |actual|
+    "expected that instance of #{actual.class} would log event #{expected_event} with params #{expected_params}"
+  end
+end

data/lib/tasks/riaction.rake

@@ -10,6 +10,7 @@ namespace 'riaction' do
         Riaction::Riaction::EVENT_CLASSES.each do |class_name|
           klass = class_name.constantize
           puts "#{klass} defines the following events:"
+          opts = klass.riaction_options
           klass.riaction_events.each_pair do |name, deets|
             puts " :#{name}:"
             if Riaction::Constants.crud_actions.include? deets[:trigger]
@@ -47,6 +48,17 @@ namespace 'riaction' do
               puts "    Event Params: #{deets[:params]}"
             end
             
+            if opts[:default_event_params].present?
+              case opts[:default_event_params]
+              when Symbol
+                puts "      Params included by default: Hash returned by :#{opts[:default_event_params]}"
+              when Proc
+                puts "      Params included by default: Hash returned via Proc"
+              when Hash
+                puts "      Params included by default: #{opts[:default_event_params]}"
+              end
+            end
+            
             case deets[:guard]
             when NilClass
               puts "    Guard: None"

data/spec/custom_matchers_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper.rb'
+
+ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'users'")
+ActiveRecord::Base.connection.create_table(:users) do |t|
+  t.string :name
+  t.string :email
+  t.timestamps
+end
+
+class User < ActiveRecord::Base
+  extend Riaction::Riaction::ClassMethods
+  
+  has_many :comments, :dependent => :destroy
+end
+
+ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'comments'")
+ActiveRecord::Base.connection.create_table(:comments) do |t|
+  t.belongs_to :user
+  t.string :content
+end
+
+class Comment < ActiveRecord::Base
+  extend Riaction::Riaction::ClassMethods
+  
+  belongs_to :user
+end
+
+
+describe "Custom matchers for riaction" do
+  before do
+    User.reset_riaction if User.riactionary?
+    Comment.reset_riaction if Comment.riactionary?
+
+    # multiple test runs are building up the callbacks
+    Comment.class_eval do
+      reset_callbacks :create
+      reset_callbacks :update
+      reset_callbacks :destroy
+    end
+  end
+  
+  describe "profile objects" do
+    before do
+      User.class_eval do
+        riaction :profile, :type => :player, :custom => :id
+      end
+    end
+    
+    describe "at the class level" do
+      it "should raise an ExpectationNotMetError when asserting that the class defines a profile type that isn't actually defined" do
+        lambda {User.should define_riaction_profile(:bogus)}.should raise_error(RSpec::Expectations::ExpectationNotMetError)
+      end
+      
+      it "should not raise an ExpectationNotMetError when asserting that the class defines a profile type that is actually defined" do
+        lambda {User.should define_riaction_profile(:player)}.should_not raise_error(RSpec::Expectations::ExpectationNotMetError)
+      end
+      
+      it "should raise an ExpectationNotMetError when asserting that the class uses an identifier that it doesn't define" do
+        lambda {User.should define_riaction_profile(:player).identified_by(:bogus => :bogus)}.should raise_error(RSpec::Expectations::ExpectationNotMetError)
+      end
+      
+      it "should not raise an ExpectationNotMetError when asserting that the class uses an identifier that is correctlty defined" do
+        lambda {User.should define_riaction_profile(:player).identified_by(:custom => :id)}.should_not raise_error(RSpec::Expectations::ExpectationNotMetError)
+      end
+    end
+    
+    describe "at the instance level" do
+      before do
+        @user = User.riactionless{ User.create(:name => 'zortnac') }
+      end
+      
+      it "should raise an ExpectationNotMetError when asserting that the instance should deliver the correct identifiers and it does not" do
+        lambda {@user.should identify_with_riaction_as(:player, :custom => 'bogus')}.should raise_error(RSpec::Expectations::ExpectationNotMetError)
+      end
+      
+      it "should not raise an ExpectationNotMetError when asserting that the instance should deliver the correct identifiers and it does" do
+        lambda {@user.should identify_with_riaction_as(:player, :custom => @user.id)}.should_not raise_error(RSpec::Expectations::ExpectationNotMetError)
+      end
+    end
+  end
+  
+  describe "event objects" do
+    before do 
+      User.class_eval do
+        riaction :profile, :type => :player, :custom => :id
+      end
+      
+      Comment.class_eval do
+        riaction :event, :name => :make_a_comment, :trigger => :create, :profile => :user, :params => {:comment => :content}
+      end
+    end
+    
+    describe "at the class level" do
+      it "should raise an ExpectationNotMetError when incorrectly asserting that the class defines an event" do
+        lambda {Comment.should define_riaction_event(:bogus)}.should raise_error(RSpec::Expectations::ExpectationNotMetError)
+      end
+      
+      it "should not raise an ExpectationNotMetError when correctly asserting that the class defines an event" do
+        lambda {Comment.should define_riaction_event(:make_a_comment)}.should_not raise_error(RSpec::Expectations::ExpectationNotMetError)
+      end
+      
+      it "should raise an ExpectationNotMetError when incorrectly asserting that the class defines the event on a specific action" do
+        lambda {Comment.should define_riaction_event(:make_a_comment).triggered_on(:bogus)}.should raise_error(RSpec::Expectations::ExpectationNotMetError)
+      end
+      
+      it "should not raise an ExpectationNotMetError when correctly asserting that the class defines the event on a specific action" do
+        lambda {Comment.should define_riaction_event(:make_a_comment).triggered_on(:create)}.should_not raise_error(RSpec::Expectations::ExpectationNotMetError)
+      end
+    end
+    
+    describe "at the instance level" do
+      before do
+        @user = User.riactionless{ User.create(:name => 'zortnac') }
+        @comment = Comment.riactionless{ Comment.create(:user => @user, :content => "this is a comment") }
+      end
+      
+      it "should raise an ExpectationNotMetError when incorrectly asserting that the instance uses the desired riaction profile" do
+        lambda {@comment.should log_riaction_event_with_profile(:make_a_comment, :player, :custom, -1)}.should raise_error(RSpec::Expectations::ExpectationNotMetError)
+      end
+      
+      it "should raise an ExpectationNotMetError when correctly asserting that the instance uses the desired riaction profile" do
+        lambda {@comment.should log_riaction_event_with_profile(:make_a_comment, :player, :custom, @user.id)}.should_not raise_error(RSpec::Expectations::ExpectationNotMetError)
+      end
+      
+      it "should raise an ExpectationNotMetError when incorrectly asserting that the instance uses the desired params" do
+        lambda {@comment.should log_riaction_event_with_params(:make_a_comment, {:comment => "bogus"})}.should raise_error(RSpec::Expectations::ExpectationNotMetError)
+      end
+      
+      it "should raise an ExpectationNotMetError when correctly asserting that the instance uses the desired params" do
+        lambda {@comment.should log_riaction_event_with_params(:make_a_comment, {:comment => @comment.content})}.should_not raise_error(RSpec::Expectations::ExpectationNotMetError)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: riaction
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-10 00:00:00.000000000Z
+date: 2012-02-21 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2161139200 !ruby/object:Gem::Requirement
+  requirement: &2160644000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *2161139200
+  version_requirements: *2160644000
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2161138580 !ruby/object:Gem::Requirement
+  requirement: &2160643540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161138580
+  version_requirements: *2160643540
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &2161138020 !ruby/object:Gem::Requirement
+  requirement: &2160637060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161138020
+  version_requirements: *2160637060
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2161137440 !ruby/object:Gem::Requirement
+  requirement: &2160636500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2161137440
+  version_requirements: *2160636500
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &2161136640 !ruby/object:Gem::Requirement
+  requirement: &2160635460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *2161136640
+  version_requirements: *2160635460
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2161136140 !ruby/object:Gem::Requirement
+  requirement: &2160634940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *2161136140
+  version_requirements: *2160634940
 - !ruby/object:Gem::Dependency
   name: resque
-  requirement: &2161135740 !ruby/object:Gem::Requirement
+  requirement: &2160634560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2161135740
+  version_requirements: *2160634560
 - !ruby/object:Gem::Dependency
   name: ruby-iactionable
-  requirement: &2161134860 !ruby/object:Gem::Requirement
+  requirement: &2160633900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,7 @@ dependencies:
         version: 0.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *2161134860
+  version_requirements: *2160633900
 description: Wrapper for IActionable's restful API and an "acts-as" style interface
   for models to behave as profiles and drive game events.
 email:
@@ -126,8 +126,10 @@ files:
 - lib/riaction/railtie.rb
 - lib/riaction/riaction.rb
 - lib/riaction/version.rb
+- lib/rspec/matchers/riaction.rb
 - lib/tasks/riaction.rake
 - riaction.gemspec
+- spec/custom_matchers_spec.rb
 - spec/event_performer_spec.rb
 - spec/profile_creation_spec.rb
 - spec/riaction_spec.rb
@@ -159,6 +161,7 @@ specification_version: 3
 summary: Wrapper for IActionable's restful API and an "acts-as" style interface for
   models to behave as profiles and drive game events.
 test_files:
+- spec/custom_matchers_spec.rb
 - spec/event_performer_spec.rb
 - spec/profile_creation_spec.rb
 - spec/riaction_spec.rb