emotions 0.1.7 → 0.2

data/lib/emotions.rb

@@ -1,6 +1,7 @@
 require 'emotions/version'
 
 require 'active_record'
+require 'emotions/errors'
 require 'emotions/emotion'
 require 'emotions/emotive'
 require 'emotions/emotional'
@@ -14,6 +15,26 @@ module Emotions
   def self.emotions
     @configuration.emotions ||= []
   end
+
+  def self.inject_into_active_record
+    @inject_into_active_record ||= Proc.new do
+      def self.acts_as_emotive
+        self.send :include, Emotions::Emotive
+      end
+
+      def self.acts_as_emotional
+        self.send :include, Emotions::Emotional
+      end
+
+      def self.emotional?
+        @emotional ||= self.ancestors.include?(Emotions::Emotional)
+      end
+
+      def self.emotive?
+        @emotive ||= self.ancestors.include?(Emotions::Emotive)
+      end
+    end
+  end
 end
 
 require 'emotions/railtie' if defined?(Rails) && Rails::VERSION::MAJOR >= 3

data/lib/emotions/emotional.rb

@@ -10,58 +10,107 @@ module Emotions
       end
     end
 
+    # @private
     def _emotions_about(emotive)
       self.emotions.where(emotive_id: emotive.id, emotive_type: emotive.class.name)
     end
 
+    # Return all emotions expressed by the emotional record
+    # towards another emotive record
+    #
+    # @example
+    #   user = User.first
+    #   picture = Picture.first
+    #   user.express! :happy, picture
+    #   user.emotions_about(picture)
+    #   # => [:happy]
     def emotions_about(emotive)
       _emotions_about(emotive).pluck(:emotion).map(&:to_sym)
     end
 
+    # Express an emotion towards another record
+    #
+    # @example
+    #   user = User.first
+    #   picture = Picture.first
+    #   user.express! :happy, picture
     def express!(emotion, emotive)
-      send("#{emotion}_about!", emotive)
+      emotion = _emotions_about(emotive).where(emotion: emotion).first_or_initialize
+
+      begin
+        emotion.tap(&:save!)
+      rescue ActiveRecord::RecordInvalid => e
+        raise InvalidEmotion.new(e.record)
+      end
     end
 
+    # No longer express an emotion towards another record
+    #
+    # @example
+    #   user = User.first
+    #   picture = Picture.first
+    #   user.no_longer_express! :happy, picture
     def no_longer_express!(emotion, emotive)
-      send("no_longer_#{emotion}_about!", emotive)
+      _emotions_about(emotive).where(emotion: emotion).first.tap { |e| e.try(:destroy) }
     end
 
     module ClassMethods
+      # Return an `ActiveRecord::Relation` containing the emotional records
+      # that expressed a specific emotion towards an emotive record
+      #
+      # @example
+      #   user = User.first
+      #   picture = Picture.first
+      #   user.express! :happy, picture
+      #   User.emotional_about(:happy, picture)
+      #   # => #<ActiveRecord::Relation [#<User id=1>]>
+      def emotional_about(emotion, emotive)
+        if emotive.class.emotive?
+          emotional_ids = emotive.emotions.where(emotion: emotion).where(emotional_type: self.name).pluck(:emotional_id)
+          where(id: emotional_ids)
+        else
+          # ActiveRecord 4 supports `.none`, not ActiveRecord 3
+          respond_to?(:none) ? none : where('1 = 0')
+        end
+      end
+
       def define_emotion_methods(emotion)
         class_eval <<-RUBY, __FILE__, __LINE__ + 1
           def #{emotion}_about?(emotive)
             !!#{emotion}_about(emotive).exists?
           end
-          alias #{emotion}? #{emotion}_about?
-          alias #{emotion}_with? #{emotion}_about?
-          alias #{emotion}_over? #{emotion}_about?
 
           def #{emotion}_about!(emotive)
-            emotion = #{emotion}_about(emotive).first_or_initialize
-            emotion.tap(&:save!)
+            express! #{emotion.inspect}, emotive
           end
-          alias #{emotion}_with! #{emotion}_about!
-          alias #{emotion}_over! #{emotion}_about!
 
           def no_longer_#{emotion}_about!(emotive)
-            #{emotion}_about(emotive).first.tap(&:destroy)
+            no_longer_express! #{emotion.inspect}, emotive
           end
-          alias no_longer_#{emotion}_with! no_longer_#{emotion}_about!
-          alias no_longer_#{emotion}_over! no_longer_#{emotion}_about!
 
           def #{emotion}_about(emotive)
             _emotions_about(emotive).where(emotion: #{emotion.to_s.inspect})
           end
+
+          alias #{emotion}? #{emotion}_about?
+          alias #{emotion}_with? #{emotion}_about?
+          alias #{emotion}_over? #{emotion}_about?
+
+          alias #{emotion}_with! #{emotion}_about!
+          alias #{emotion}_over! #{emotion}_about!
+
+          alias no_longer_#{emotion}_with! no_longer_#{emotion}_about!
+          alias no_longer_#{emotion}_over! no_longer_#{emotion}_about!
+
           alias #{emotion}_with #{emotion}_about
           alias #{emotion}_over #{emotion}_about
-
         RUBY
 
         instance_eval <<-RUBY, __FILE__, __LINE__ + 1
           def #{emotion}_about(emotive)
-            emotional_ids = emotive.#{emotion}_about.where(emotional_type: self.name).pluck(:emotional_id)
-            self.where(id: emotional_ids)
+            emotional_about(#{emotion.inspect}, emotive)
           end
+
           alias #{emotion}_with #{emotion}_about
           alias #{emotion}_over #{emotion}_about
         RUBY

data/lib/emotions/emotive.rb

@@ -10,14 +10,16 @@ module Emotions
       end
     end
 
+    # @private
     def update_emotion_counter(emotion)
-      attribute = :"#{emotion}_emotions_count"
+      attribute = "#{emotion}_emotions_count"
 
       if self.respond_to?(attribute)
         self.update_attribute(attribute, self.send("#{emotion}_about").count)
       end
     end
 
+    # @private
     module ClassMethods
       def define_emotion_methods(emotion)
         class_eval <<-RUBY, __FILE__, __LINE__ + 1

data/lib/emotions/errors.rb

@@ -0,0 +1,9 @@
+module Emotions
+  class InvalidEmotion < StandardError
+    attr_reader :emotion
+
+    def initialize(emotion)
+      @emotion = emotion
+    end
+  end
+end

data/lib/emotions/railtie.rb

@@ -4,23 +4,7 @@ require 'rails'
 module Emotions
   class Railtie < Rails::Railtie
     initializer 'emotions.active_record' do |app|
-      ActiveSupport.on_load :active_record do
-        def self.acts_as_emotive
-          self.send :include, Emotions::Emotive
-        end
-
-        def self.acts_as_emotional
-          self.send :include, Emotions::Emotional
-        end
-
-        def self.emotional?
-          !!@emotional
-        end
-
-        def self.emotive?
-          !!@emotive
-        end
-      end
+      ActiveSupport.on_load :active_record, {}, &Emotions.inject_into_active_record
     end
   end
 end

data/lib/emotions/version.rb

@@ -1,3 +1,3 @@
 module Emotions
-  VERSION = '0.1.7'
+  VERSION = '0.2'
 end

data/spec/emotions/emotional_spec.rb

@@ -53,21 +53,46 @@ describe Emotions::Emotional do
       context 'for user without emotions' do
         it { expect(user.emotions_about(picture)).to be_empty }
       end
+
+      context 'for invalid emotive' do
+        it { expect(user.emotions_about(user)).to be_empty }
+        it { expect{ user.emotions_about(user) }.to_not raise_error }
+      end
     end
 
     describe :express! do
       let(:picture) { Picture.create }
 
-      it { expect{ user.express! :happy, picture }.to change{ Emotions::Emotion.count }.from(0).to(1) }
-      it { expect{ user.express! :happy, picture }.to change{ user.happy_about? picture }.from(false).to(true) }
+      context 'with valid emotive and emotion' do
+        it { expect{ user.express! :happy, picture }.to change{ Emotions::Emotion.count }.from(0).to(1) }
+        it { expect{ user.express! :happy, picture }.to change{ user.happy_about? picture }.from(false).to(true) }
+      end
+
+      context 'with invalid emotive' do
+        it { expect{ user.express! :happy, user }.to raise_error(Emotions::InvalidEmotion) }
+      end
+
+      context 'with invalid emotion' do
+        it { expect{ user.express! :mad, picture }.to raise_error(Emotions::InvalidEmotion) }
+      end
     end
 
     describe :no_longer_express! do
       let(:picture) { Picture.create }
       before { user.happy_about!(picture) }
 
-      it { expect{ user.no_longer_express! :happy, picture }.to change{ Emotions::Emotion.count }.from(1).to(0) }
-      it { expect{ user.no_longer_express! :happy, picture }.to change{ user.happy_about? picture }.from(true).to(false) }
+      context 'with valid emotive and emotion' do
+        it { expect{ user.no_longer_express! :happy, picture }.to change{ Emotions::Emotion.count }.from(1).to(0) }
+        it { expect{ user.no_longer_express! :happy, picture }.to change{ user.happy_about? picture }.from(true).to(false) }
+      end
+
+      context 'with invalid emotive' do
+        it { expect{ user.no_longer_express! :happy, user }.to_not raise_error }
+      end
+
+      context 'with invalid emotion' do
+        it { expect{ user.no_longer_express! :mad, user }.to_not raise_error }
+      end
     end
 
     describe :DynamicMethods do
@@ -76,25 +101,44 @@ describe Emotions::Emotional do
         let(:picture) { Picture.create }
         let(:other_picture) { Picture.create }
 
-        it { expect(user.happy_about? picture).to be_true }
-        it { expect(user.happy_about? other_picture).to be_false }
+        context 'with valid emotive' do
+          it { expect(user.happy_about? picture).to be_true }
+          it { expect(user.happy_about? other_picture).to be_false }
+        end
+
+        context 'with invalid emotive' do
+          it { expect{ user.happy_about? user }.to_not raise_error }
+        end
       end
 
       describe :emotion_about! do
         let(:picture) { Picture.create }
 
-        it { expect(user.happy_about! picture).to be_instance_of(Emotions::Emotion) }
-        it { expect{ user.happy_about! picture }.to change{ Emotions::Emotion.count }.from(0).to(1) }
-        it { expect{ user.happy_about! picture }.to change{ user.happy_about? picture }.from(false).to(true) }
+        context 'with valid emotive' do
+          it { expect(user.happy_about! picture).to be_instance_of(Emotions::Emotion) }
+          it { expect{ user.happy_about! picture }.to change{ Emotions::Emotion.count }.from(0).to(1) }
+          it { expect{ user.happy_about! picture }.to change{ user.happy_about? picture }.from(false).to(true) }
+        end
+
+        context 'with invalid emotive' do
+          it { expect{ user.happy_about! user }.to raise_error(Emotions::InvalidEmotion) }
+        end
       end
 
       describe :no_longer_emotion_about! do
         before { user.happy_about!(picture) }
         let(:picture) { Picture.create }
 
-        it { expect(user.no_longer_happy_about! picture).to be_instance_of(Emotions::Emotion) }
-        it { expect{ user.no_longer_happy_about! picture }.to change{ Emotions::Emotion.count }.from(1).to(0) }
-        it { expect{ user.no_longer_happy_about! picture }.to change{ user.happy_about? picture }.from(true).to(false) }
+        context 'with valid emotive' do
+          it { expect(user.no_longer_happy_about! picture).to be_instance_of(Emotions::Emotion) }
+          it { expect{ user.no_longer_happy_about! picture }.to change{ Emotions::Emotion.count }.from(1).to(0) }
+          it { expect{ user.no_longer_happy_about! picture }.to change{ user.happy_about? picture }.from(true).to(false) }
+        end
+
+        context 'with invalid emotive' do
+          it { expect(user.no_longer_happy_about! user).to be_nil }
+          it { expect{ user.no_longer_happy_about! user }.to_not raise_error }
+        end
       end
     end
   end
@@ -119,8 +163,15 @@ describe Emotions::Emotional do
           first_other_user.happy_about! picture
         end
 
-        it { expect(User.happy_about(picture).to_a).to eql [user, first_other_user] }
-        it { expect(User.happy_about(picture).where('id != ?', first_other_user.id).to_a).to eql [user] }
+        context 'with valid emotive' do
+          it { expect(User.happy_about(picture).to_a).to eql [user, first_other_user] }
+          it { expect(User.happy_about(picture).where('id != ?', first_other_user.id).to_a).to eql [user] }
+        end
+
+        context 'with invalid emotive' do
+          it { expect(User.happy_about(user).to_a).to be_empty }
+          it { expect{ User.happy_about(user).to_a }.to_not raise_error }
+        end
       end
     end
   end

data/spec/spec_helper.rb

@@ -7,7 +7,9 @@ require 'emotions'
 
 # Require our macros and extensions
 Dir[File.expand_path('../../spec/support/macros/*.rb', __FILE__)].map(&method(:require))
-Dir[File.expand_path('../../spec/support/extensions/*.rb', __FILE__)].map(&method(:require))
+
+# Inject our methods into ActiveRecord (like our railtie does)
+ActiveRecord::Base.class_eval(&Emotions.inject_into_active_record)
 
 RSpec.configure do |config|
   # Include our macros

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: emotions
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-24 00:00:00.000000000 Z
+date: 2013-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -110,6 +110,7 @@ files:
 - lib/emotions/emotion.rb
 - lib/emotions/emotional.rb
 - lib/emotions/emotive.rb
+- lib/emotions/errors.rb
 - lib/emotions/railtie.rb
 - lib/emotions/version.rb
 - lib/generators/emotions/USAGE
@@ -119,7 +120,6 @@ files:
 - spec/emotions/emotional_spec.rb
 - spec/emotions/emotive_spec.rb
 - spec/spec_helper.rb
-- spec/support/extensions/active_record.rb
 - spec/support/macros/database_macros.rb
 - spec/support/macros/model_macros.rb
 homepage: https://github.com/mirego/emotions
@@ -137,7 +137,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -17030051057476021
+      hash: -451133210429222225
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -146,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -17030051057476021
+      hash: -451133210429222225
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -159,6 +159,5 @@ test_files:
 - spec/emotions/emotional_spec.rb
 - spec/emotions/emotive_spec.rb
 - spec/spec_helper.rb
-- spec/support/extensions/active_record.rb
 - spec/support/macros/database_macros.rb
 - spec/support/macros/model_macros.rb

data/spec/support/extensions/active_record.rb

@@ -1,17 +0,0 @@
-class ActiveRecord::Base
-  def self.acts_as_emotive
-    self.send :include, Emotions::Emotive
-  end
-
-  def self.acts_as_emotional
-    self.send :include, Emotions::Emotional
-  end
-
-  def self.emotive?
-    @emotive ||= self.ancestors.include?(Emotions::Emotive)
-  end
-
-  def self.emotional?
-    @emotional ||= self.ancestors.include?(Emotions::Emotional)
-  end
-end