emotions 0.0.1 → 0.1

data/Gemfile

@@ -1,4 +1,2 @@
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in emotions.gemspec
 gemspec

data/README.md

@@ -1,29 +1,71 @@
 # Emotions
 
-TODO: Write a gem description
+Emotions is a Ruby library that allows ActiveRecord records to express (and hopefully store) emotions about other records.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application’s Gemfile:
 
-    gem 'emotions'
+```ruby
+gem 'emotions'
+```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
-Or install it yourself as:
+Run the migration to add the `emotions` table:
 
-    $ gem install emotions
+```bash
+$ rails generate emotions:install
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+Configure the allowed emotions.
 
-## Contributing
+```ruby
+Emotions.configure do |config|
+  config.emotions = [:happy, :sad]
+end
+```
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Create a couple of models.
+
+```ruby
+class Picture < ActiveRecord::Base
+  acts_as_emotive
+end
+
+class User < ActiveRecord::Base
+  acts_as_emotional
+end
+```
+
+Express emotions towards other records.
+
+```ruby
+user = User.find(1)
+picture = Picture.find(2)
+
+user.happy_about!(picture)
+user.sad_about!(picture)
+user.emotions_about(picture)
+# => [:happy, :sad]
+
+user.happy_about?(picture)
+# => true
+
+user.no_longer_sad_about!(picture)
+user.sad_about?(picture)
+# => false
+
+picture.happy_about.map(&:emotional)
+# => [#<User id=1>]
+
+user.express!(:sad, picture)
+user.sad_about?(picure)
+# => true
+```

data/emotions.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = Emotions::VERSION
   spec.authors       = ["Rémi Prévost"]
   spec.email         = ["remi@exomel.com"]
-  spec.description   = ""
-  spec.summary       = ""
-  spec.homepage      = ""
+  spec.description   = 'Emotions is a Ruby library that allows ActiveRecord records to express (and hopefully store) emotions about other records.'
+  spec.summary       = 'Emotions is a Ruby library that allows ActiveRecord records to express (and hopefully store) emotions about other records.'
+  spec.homepage      = 'https://github.com/remiprev/emotions'
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "rails", ">= 3.0.0"
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
 end

data/lib/emotions.rb

@@ -1,5 +1,17 @@
 require "emotions/version"
+require "emotions/emotion"
+require "emotions/emotive"
+require "emotions/emotional"
 
 module Emotions
-  # Your code goes here...
+  def self.configure
+    @configuration = OpenStruct.new
+    yield(@configuration)
+  end
+
+  def self.emotions
+    @configuration.emotions ||= []
+  end
 end
+
+require 'emotions/railtie' if defined?(Rails) && Rails::VERSION::MAJOR >= 3

data/lib/emotions/emotion.rb

@@ -0,0 +1,16 @@
+module Emotions
+  class Emotion < ActiveRecord::Base
+    self.table_name = 'emotions'
+
+    # Validations
+    validates :emotional, presence: true
+    validates :emotive, presence: true
+    validates_each :emotion do |record, attr, value|
+      record.errors.add attr, 'invalid' unless Emotions.emotions.include?(value.try(:to_sym))
+    end
+
+    # Associations
+    belongs_to :emotional, polymorphic: true
+    belongs_to :emotive, polymorphic: true
+  end
+end

data/lib/emotions/emotional.rb

@@ -0,0 +1,53 @@
+module Emotions
+  module Emotional
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def acts_as_emotional
+        has_many :emotions, as: :emotional, class_name: 'Emotions::Emotion'
+
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def _emotions_about(emotive)
+            self.emotions.where(emotive_id: emotive.id, emotive_type: emotive.class.name)
+          end
+
+          def emotions_about(emotive)
+            _emotions_about(emotive).map(&:emotion).map(&:to_sym)
+          end
+
+          def express!(emotion, emotive)
+            send("\#{emotion}_about!", emotive)
+          end
+
+          def no_longer_express!(emotion, emotive)
+            send("no_longer_\#{emotion}_about!", emotive)
+          end
+        RUBY
+
+        Emotions.emotions.each do |emotion|
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{emotion}_about?(emotive)
+              #{emotion}_about(emotive).exists?
+            end
+
+            def #{emotion}_about?(emotive)
+              #{emotion}_about(emotive).exists?
+            end
+
+            def #{emotion}_about!(emotive)
+              #{emotion}_about(emotive).first_or_create!
+            end
+
+            def no_longer_#{emotion}_about!(emotive)
+              #{emotion}_about(emotive).destroy
+            end
+
+            def #{emotion}_about(emotive)
+              _emotions_about(emotive).where(emotion: #{emotion.to_s.inspect})
+            end
+          RUBY
+        end
+      end
+    end
+  end
+end

data/lib/emotions/emotive.rb

@@ -0,0 +1,25 @@
+module Emotions
+  module Emotive
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def acts_as_emotive
+        has_many :emotions, as: :emotive, class_name: 'Emotions::Emotion'
+
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def emotional_about
+            self.emotions.includes(:emotional)
+          end
+        RUBY
+
+        Emotions.emotions.each do |emotion|
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{emotion}_about
+              emotional_about.where(emotion: #{emotion.to_s.inspect})
+            end
+          RUBY
+        end
+      end
+    end
+  end
+end

data/lib/emotions/railtie.rb

@@ -0,0 +1,13 @@
+require 'emotions'
+require 'rails'
+
+module Emotions
+  class Railtie < Rails::Railtie
+    initializer "emotions.active_record" do |app|
+      ActiveSupport.on_load :active_record do
+        include Emotions::Emotive
+        include Emotions::Emotional
+      end
+    end
+  end
+end

data/lib/emotions/version.rb

@@ -1,3 +1,3 @@
 module Emotions
-  VERSION = "0.0.1"
+  VERSION = "0.1"
 end

data/lib/generators/emotions/USAGE

@@ -0,0 +1,3 @@
+Description:
+  The emotions:install generator generates a migration that will
+  create the `emotions` table in your database.

data/lib/generators/emotions/install_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Emotions
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+
+      # Implement the required interface for Rails::Generators::Migration.
+      # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+         "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def create_migration_file
+        migration_template 'migration.rb', 'db/migrate/emotions_migration.rb'
+      end
+    end
+  end
+end

data/lib/generators/emotions/templates/migration.rb

@@ -0,0 +1,26 @@
+class AddEmotions < ActiveRecord::Migration
+  def up
+    create_table :emotions do |t|
+      # The emotional model
+      t.string :emotional_type
+      t.integer :emotional_id
+
+      # The emotive model
+      t.string :emotive_type
+      t.integer :emotive_id
+
+      # The type of emotion
+      t.string :emotion
+
+      t.timestamps
+    end
+
+    add_index :emotions, [:emotional_type, :emotional_id, :emotive_type, :emotive_id, :emotion], unique: true, name: 'index_emotions_by_emotional_emotive_and_emotion'
+    add_index :emotions, [:emotional_type, :emotional_id, :emotive_type, :emotive_id], name: 'index_emotions_by_emotional_and_emotive'
+    add_index :emotions, [:emotive_type, :emotive_id, :emotion], name: 'index_emotions_by_emotional_and_emotive'
+  end
+
+  def down
+    drop_table :emotions
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: emotions
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: '0.1'
   prerelease: 
 platform: ruby
 authors:
@@ -11,6 +11,22 @@ bindir: bin
 cert_chain: []
 date: 2013-05-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -43,7 +59,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ''
+description: Emotions is a Ruby library that allows ActiveRecord records to express
+  (and hopefully store) emotions about other records.
 email:
 - remi@exomel.com
 executables: []
@@ -57,8 +74,15 @@ files:
 - Rakefile
 - emotions.gemspec
 - lib/emotions.rb
+- lib/emotions/emotion.rb
+- lib/emotions/emotional.rb
+- lib/emotions/emotive.rb
+- lib/emotions/railtie.rb
 - lib/emotions/version.rb
-homepage: ''
+- lib/generators/emotions/USAGE
+- lib/generators/emotions/install_generator.rb
+- lib/generators/emotions/templates/migration.rb
+homepage: https://github.com/remiprev/emotions
 licenses:
 - MIT
 post_install_message: 
@@ -73,7 +97,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3174883291997258005
+      hash: -16871718108920318
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -82,11 +106,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3174883291997258005
+      hash: -16871718108920318
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: ''
+summary: Emotions is a Ruby library that allows ActiveRecord records to express (and
+  hopefully store) emotions about other records.
 test_files: []