make_flagable 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 kgalli
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest

@@ -0,0 +1,13 @@
+MIT-LICENSE
+README.rdoc
+Rakefile
+generators/make_flagable_migration_generator.rb
+generators/templates/migration.rb
+init.rb
+lib/flag.rb
+lib/flagging.rb
+lib/make_flagable.rb
+tasks/make_flagable_tasks.rake
+test/make_flagable_test.rb
+test/test_helper.rb
+Manifest

data/README.rdoc

@@ -0,0 +1,45 @@
+= MakeFlagable
+
+Rails gem to add flagging functionality to a specific ActiveRecord model.
+
+== Installation
+
+In environment.rb:
+
+  Rails::Initializer.run do |config|
+    config.gem 'make_flagable', :lib => 'make_flagable', :source => 'http://gems.github.com'
+  end
+
+At your application root, run:
+
+  $ sudo rake gems:install
+
+Next, generate and run:
+
+  $ script/generate make_flagable_migration
+  $ rake db:migrate
+
+== Usage
+
+To add flagging functionality to the ActiveRecord model, simply add make_flagable to your class:
+
+  class Entry < ActiveRecord::Base
+    make_flagable
+
+    validates_presence_of :description
+
+    def description
+      "#{description}"
+    end
+  end
+
+To add a flag you can use the add_flag() mehtod:
+
+  e = Entry.new
+  # assuming you get the user_id by current_user.id
+  @e.add_flag(:flag_type => 'spam', :user_id => current_user.id)
+
+
+== Licence
+
+Copyright (c) 2009 kgalli, released under the MIT license

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('make_flagable', '0.1.0') do |p|
+  p.description     = "A Rails Plugin to add flagging functionality to any model you like."
+  p.url             = "http://github.com/kgalli/MakeFlagable"
+  p.author          = "kgalli"
+  p.email           = "mail@kgalli.de"
+  p.ignore_pattern  = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*rake"].sort.each { |ext| load ext }

data/generators/make_flagable_migration_generator.rb

@@ -0,0 +1,11 @@
+class MakeFlagableMigrationGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.migration_template 'migration.rb', 'db/migrate'
+    end
+  end
+ 
+  def file_name
+    'create_flags_and_flaggings'
+  end
+end

data/generators/templates/migration.rb

@@ -0,0 +1,31 @@
+class CreateFlagsAndFlaggings < ActiveRecord::Migration
+ def self.up
+    create_table :flags do |t|
+      t.string :identifier
+      t.string :flag_type
+      t.text :description 
+
+      t.timestamps
+    end
+    
+    create_table :flaggings do |t|
+      t.integer :flag_id
+      t.string :flagable_id
+      t.string :flagable_type
+      t.integer :user_id
+      t.text :description 
+    
+      t.timestamps
+    end
+    add_index "flags", ["flag_type"], :name => "fk_flags_flag_type"
+    add_index "flaggings", ["user_id"], :name => "fk_flaggings_user"
+    add_index "flaggings", ["flagable_id"], :name => "fk_flaggings_flagable_id"
+    add_index "flaggings", ["flagable_type"], :name => "fk_flaggings_flagable_type"
+    
+  end
+
+  def self.down
+    drop_table :flags
+    drop_table :flaggings
+  end
+end

data/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+require 'make_flagable'

data/lib/flag.rb

@@ -0,0 +1,31 @@
+class Flag < ActiveRecord::Base
+  include Comparable
+
+  # relationships
+  has_many :flaggings
+  has_many :make_flagables, :through => :flaggings
+
+  # virtual attributes used to store additional
+  # information about the flaggings for a model 
+  attr_accessor :user_id, :flag_description
+
+  # avoid to flag a model twice with specific
+  # flag type
+  validates_uniqueness_of :flag_type
+
+  # Helper class method to lookup all flags assigned
+  # to all make_flabable types for a given user.
+  def self.find_flags_by_user(user)
+    find(:all,
+      :conditions => ["user_id = ?", user.id],
+      :order => "created_at DESC"
+    )
+  end
+
+  # implemented to be able to use the conventional
+  # comparison operators accessible via include Comparable
+  # -->: <, <=, ==, >=, >
+  def <=>(other)
+    flag_type.to_s <=> other.flag_type.to_s 
+  end
+end

data/lib/flagging.rb

@@ -0,0 +1,25 @@
+class Flagging < ActiveRecord::Base
+  belongs_to :flag
+  belongs_to :flagable,  :polymorphic => true
+  belongs_to :user
+
+  validates_uniqueness_of :user_id, :scope => [:flag_id, :flagable_id, :flagable_type]
+
+  def self.has_flagged?(flagable)
+    begin
+      Flag.find_flags_for_make_flagable(flagable.type, flagable.id)
+      return true
+    rescue
+      return false
+    end
+  end
+
+  def self.find_or_create_by_user_id_flable_id_flable_type(arg)
+      find(:all, :select => '*', :conditions => ["user_id = ? AND flagable_id = ? AND flagable_type = ? ",
+                                 arg[:user_id], arg[:flagable_id],arg[:flagable_type]],
+                                :limit => 1 ) || create(arg)
+  end
+  #def flagable_type=(type)
+  #     super(type.to_s.classify.constantize.base_class.to_s)
+  #end
+end

data/lib/make_flagable.rb

@@ -0,0 +1,104 @@
+module MakeFlagable
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def make_flagable
+      has_many :flaggings, :as => :flagable
+      has_many :flags, :through => :flaggings
+      include MakeFlagable::InstanceMethods # --> instance methods   xx_xx()
+      extend MakeFlagable::SingletonMethods # --> class methods self.xx_xx()
+    end
+  end
+
+  module SingletonMethods
+    # returns all flagged objects
+    # (each object only ones --> group)
+    def flagged
+      find(:all, :joins => {:flags => :flaggings}, :group => "#{make_flagable}.id")
+    end
+
+    # returns all objects flagged with a given flag_type
+    def flagged_with_flag_type(flag_type)
+      find(:all, :joins => {:flags => :flaggings}, :conditions => ["flags.flag_type = ?", flag_type],
+           :group => "#{pluralized_class_name(self)}.id, flags.flag_type")
+    end
+
+    private
+      # return the class name of a given object
+      def class_name(obj)
+        ActiveRecord::Base.send(:class_name_of_active_record_descendant, obj).to_s
+      end
+
+      # returns pluralized class name of a given object
+      def pluralized_class_name(obj)
+        class_name(obj).to_s.pluralize.downcase
+      end
+
+  end
+
+  module InstanceMethods
+
+    # returns if the flagable model is flagged
+    def flagged?
+      flags.empty?
+    end
+
+    # returns if the flagable model is flagged with
+    # a given flag type
+    def flagged_as_flag_type?(flag_type)
+      if flags.find(:first, :conditions => ["flag_type = ?", flag_type]) != nil
+        return true
+      else
+        return false
+      end
+    end
+
+    # returns if the flagable model is flagged by a given user
+    # (flag type doesn't matter)
+    def flagged_by_user?(user)
+      if flags.find(:first, :conditions => ["flaggings.user_id = ?", user.id]) != nil
+        true
+      else
+        false
+      end
+    end
+
+    # returns the flags for the flagable model
+    # (grouped by flag type --> no duplicates)
+    def flags_grouped_by_flag_type
+      flags.find(:all, :group => "flags.flag_type", :order => 'count(flags.flag_type) DESC' )
+    end
+
+
+    # delete all flags with specific flag_type
+    # from flagable model
+    def unflag_by_flag_type(flag_type)
+      flaggings_to_destroy = self.flaggings.find(:all, :joins => :flag, :conditions => ["flags.flag_type = ?", flag_type])
+      self.flaggings.destroy(flaggings_to_destroy) if flaggings_to_destroy != nil
+    end
+
+    # helper method to flag a flagable model
+    # by setting up the right flagging associations
+    # user_id and description are virtual attributes
+    # provided by the flag model
+    def add_flag(options)
+      flag = Flag.find_or_create_by_flag_type(options[:flag_type].to_s)
+      flag.user_id = options[:user_id]
+      flag.flag_description = options[:flag_description]
+
+      flagging = Flagging.find(:first, :conditions => ["flaggings.flagable_id = ? AND flaggings.user_id = ? AND flaggings.flagable_type = ? AND flag_id = ?",
+                                               self.id, flag.user_id, self.class.name.to_s, flag.id], :limit => 1)
+      flagging = Flagging.new if flagging == nil 
+      flagging.description = flag.flag_description
+      flagging.flagable = self
+      flagging.flag = flag
+      flagging.user_id = flag.user_id
+      flagging.save
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, MakeFlagable)

data/make_flagable.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{make_flagable}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["kgalli"]
+  s.date = %q{2009-10-31}
+  s.description = %q{A Rails Plugin to add flagging functionality to any model you like.}
+  s.email = %q{mail@kgalli.de}
+  s.extra_rdoc_files = ["README.rdoc", "lib/flag.rb", "lib/flagging.rb", "lib/make_flagable.rb", "tasks/make_flagable_tasks.rake"]
+  s.files = ["MIT-LICENSE", "README.rdoc", "Rakefile", "generators/make_flagable_migration_generator.rb", "generators/templates/migration.rb", "init.rb", "lib/flag.rb", "lib/flagging.rb", "lib/make_flagable.rb", "tasks/make_flagable_tasks.rake", "test/make_flagable_test.rb", "test/test_helper.rb", "Manifest", "make_flagable.gemspec"]
+  s.homepage = %q{http://github.com/kgalli/MakeFlagable}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Make_flagable", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{make_flagable}
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{A Rails Plugin to add flagging functionality to any model you like.}
+  s.test_files = ["test/make_flagable_test.rb", "test/test_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/tasks/make_flagable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :make_flagable do
+#   # Task goes here
+# end

data/test/make_flagable_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class MakeFlagableTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: make_flagable
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- kgalli
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-31 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: A Rails Plugin to add flagging functionality to any model you like.
+email: mail@kgalli.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/flag.rb
+- lib/flagging.rb
+- lib/make_flagable.rb
+- tasks/make_flagable_tasks.rake
+files: 
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- generators/make_flagable_migration_generator.rb
+- generators/templates/migration.rb
+- init.rb
+- lib/flag.rb
+- lib/flagging.rb
+- lib/make_flagable.rb
+- tasks/make_flagable_tasks.rake
+- test/make_flagable_test.rb
+- test/test_helper.rb
+- Manifest
+- make_flagable.gemspec
+has_rdoc: true
+homepage: http://github.com/kgalli/MakeFlagable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Make_flagable
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: make_flagable
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Rails Plugin to add flagging functionality to any model you like.
+test_files: 
+- test/make_flagable_test.rb
+- test/test_helper.rb