acts_as_important 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a15ea261b84c9494ce983efa27865b1af4123640
+  data.tar.gz: e43c33d759fc7698577a58d27096790b7ddf5b2e
+SHA512:
+  metadata.gz: 16b6c8164c8eb716e28d1c84855ef909b95825f26ef56b02e102e6edd1300ba3a3769d066fa3e2820ff3538d4435ce99e9551f729e0d358cd06a089f74b005b3
+  data.tar.gz: c437495f64b0432e384d14d479d0c829db32a09104e3dede3e1d6d79505b94ef3bd472f82572520197ae54a8588b0d610b9fecbdb14c1b150ea4d0034e345f5a

data/lib/acts_as_important/acts_as_important.rb

@@ -0,0 +1,84 @@
+module ActsAsImportant
+  module ActMethod #:nodoc:
+    def acts_as_important(options = {})
+      has_many :importance_indicators, :as => :record, :dependent => :destroy
+      
+      has_many :active_importance_indicators, :class_name => 'ImportanceIndicator', :as => :record, :dependent => :destroy, :conditions =>['active = ?', true]
+      has_many :concerned_users, :through => :active_importance_indicators, :source => :user
+
+      # Left joins importance indicators from a particular user
+      scope :with_user_importance, lambda{|user| joins("LEFT OUTER JOIN importance_indicators ON importance_indicators.record_id = #{quoted_table_name}.id AND importance_indicators.record_type = '#{name}' AND importance_indicators.user_id = #{user.id}")}
+      
+      scope :important_to, lambda{|user| joins(:importance_indicators).where("importance_indicators.user_id = #{user.id} AND importance_indicators.active = true")}
+      scope :was_important_to, lambda{|user| joins(:importance_indicators).where("importance_indicators.user_id = #{user.id} AND importance_indicators.active = false")}
+      scope :not_important_to, lambda{|user| with_user_importance(user).where("importance_indicators.record_id IS NULL")}
+      scope :important_to_user_first, lambda{|user| with_user_importance(user).reorder('importance_indicators.record_id IS NOT NULL DESC')}
+
+      extend ActsAsImportant::ClassMethods
+      include ActsAsImportant::InstanceMethods
+    end
+    
+    # Call this method from the user model
+    def concerned_with_importance
+      has_many :importance_indicators
+    end
+  end
+
+  module ClassMethods
+    # Find all the importance_indicators of the records by the user in a single SQL query and cache them in the records for use in the view.
+    def cache_importance_for(records, user)
+      importance_indicators = []
+      ImportanceIndicator.where(:record_type => name, :record_id => records.collect(&:id), :user_id => user.id).each do |importance_indicator|
+        importance_indicators[importance_indicator.record_id] = importance_indicator
+      end
+
+      for record in records
+        record.cached_importance = importance_indicators[record.id] || false
+      end
+      
+      return importance_indicators      
+    end
+  end
+  
+  module InstanceMethods
+    attr_accessor :cached_importance
+
+    def acts_like_important?
+      true
+    end
+
+    def important_to!(user)
+      importance_indicators.create(:user_id => user.id) unless important_to?(user)
+    rescue ActiveRecord::RecordNotUnique # Database-level uniqueness constraint failed.
+      return true      
+    end
+    
+    def important_to?(user)
+      if indicator = importance_indicator_for(user)
+        indicator.active?
+      end
+    end
+
+    def was_important_to?(user)
+      if indicator = importance_indicator_for(user)
+        !indicator.active?
+      end
+    end
+
+    def importance_indicator_for(user)
+      case cached_importance
+      when nil
+        importance_indicators.loaded? ? importance_indicators.detect{|i| i.user_id == user.id} : importance_indicators.find_by_user_id(user.id)
+      when false
+        nil
+      else
+        cached_importance
+      end
+    end
+    
+    def importance_note_for(user)
+      importance_indicator_for(user).try(:note)
+    end
+  end
+end
+

data/lib/acts_as_important/importance_indicator.rb

@@ -0,0 +1,4 @@
+class ImportanceIndicator < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :record, :polymorphic => true
+end

data/lib/acts_as_important.rb

@@ -0,0 +1,4 @@
+require 'acts_as_important/acts_as_important'
+require 'acts_as_important/importance_indicator'
+
+ActiveRecord::Base.extend ActsAsImportant::ActMethod

data/lib/generators/migration_generator.rb

@@ -0,0 +1,17 @@
+class ActsAsImportantMigrationGenerator < Rails::Generators::Base
+  def create_migration_file
+    create_file "db/migrations/initializer.rb", <<-EOV
+      class ActsAsImportantTables < ActiveRecord::Migration
+        def change
+          create_table :importance_indicators do |t|
+            t.belongs_to :user
+            t.belongs_to :record, :polymorphic => true
+            t.text       :note
+          end
+
+          add_index :importance_indicators, [:record_id, :record_type], :name => 'index_importance_indicators', :unique => true
+        end
+      end
+    EOV
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_important
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Nicholas Jakobsen
+- Ryan Wallace
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: 
+email: contact@culturecode.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/acts_as_important.rb
+- lib/acts_as_important/acts_as_important.rb
+- lib/acts_as_important/importance_indicator.rb
+- lib/generators/migration_generator.rb
+homepage: http://github.com/culturecode/acts_as_important
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Allows the you track what records are important to users and why.
+test_files: []