markable 0.0.4

data/README.md

@@ -0,0 +1,199 @@
+# Markable
+
+Do your users want to add food, drinks, books, movies, and many
+other stuff to favorites?
+
+_— How should I name this table — users_foods or foods_users?_<br/>
+_— Damn, I forget to add ```:id => false``` to migration again!_<br/>
+_— Holy sh*t! I have to create a lot of tables for this relations!_
+
+Nope, you don't have to create relations or think about migrations — **markable** will handle this.
+
+Should your users be able to add each other to friends? Or do you want to
+make a twitter-like followers system?
+
+_— Oh… Self-relation again…_
+
+Nope, **markable** can handle it too!
+
+
+
+##Installation
+
+Add to your Gemfile
+
+```
+gem 'markable'
+```
+
+Run
+
+```
+bundle install
+rails generate markable:migration
+rake db:migrate
+```
+
+## Usage
+
+At first you should define markers — these are models which will mark
+other models.
+
+If User can mark Food as favorite, then User — is a marker.
+
+``` ruby
+class User < ActiveRecord::Base
+  acts_as_marker
+end
+```
+
+Then you should define markables
+
+``` ruby
+class Food < ActiveRecord::Base
+  markable_as :favorite
+end
+```
+
+Thats it! Now you can mark pizza as a favorite food of your user
+
+``` ruby
+user.set_mark :favorite, pizza
+# or
+user.mark_as_favorite pizza
+# or
+user.favorite_foods << pizza
+# yes, I know that "food" doesn't have a plural form, but rails don't :(
+```
+
+_— Also I hate broccoli!_
+
+As you wish! Just a little change to your Food model
+
+``` ruby
+class Food < ActiveRecord::Base
+  markable_as [ :hated, :favorite ]
+end
+```
+
+and The World will know, what kind of food do you hate.
+
+``` ruby
+user.hated_foods << broccoli
+```
+
+You can easily get list of all foods marked as favorite by your user
+
+``` ruby
+user.foods_marked_as :favorite
+# or
+user.foods_marked_as_favorite
+# or
+user.favorite_foods
+```
+
+Also you can get a list of all users, who loves pizza too!
+
+``` ruby
+pizza.users_have_marked_as :favorite
+# or
+pizza.users_have_marked_as_favorite
+```
+
+And all foods loved by users
+
+``` ruby
+Food.marked_as :favorite
+# or
+Food.marked_as_favorite
+```
+
+_— Hmm… What kind of food my friends likes?_
+
+``` ruby
+Food.marked_as_favorite :by => [ user1, user2, user3 ]
+```
+
+_— Hey! I have found a users who loves pizza too — I want to be friends with them!_
+
+No problem! Just make User markable as friendly!
+
+``` ruby
+class User < ActiveRecord::Base
+  acts_as_marker
+  markable_as :friendly, :by => :user
+end
+```
+
+And now you can add all pizza-lovers to your friends
+
+``` ruby
+user.friendly_users << pizza.users_have_marked_as_favorite
+```
+
+Piece of cake!
+
+## All Methods
+``` ruby
+class User < ActiveRecord::Base
+  acts_as_marker
+end
+class Food < ActiveRecord::Base
+  markable_as :favorite
+end
+```
+
+``` ruby
+# Getters
+user.favorite_foods # => [food1, food2, …]
+user.foods_marked_as :favorite # => [food1, food2, …]
+user.foods_marked_as_favorite # => [food1, food2, …]
+
+food.users_have_marked_as :favorite # => [user1, user2, …]
+food.users_have_marked_as_favorite # => [user1, user2, …]
+
+Food.marked_as :favorite # => [food1, food2, …]
+Food.marked_as :favorite, :by => user1 # => [food1, food2, …]
+Food.marked_as_favorite # => [food1, food2, …]
+Food.marked_as_favorite :by => user1 # => [food1, food2, …]
+
+# Setters
+user.favorite_foods << [food1, food2]
+user.foods_marked_as(:favorite) << [food1, food2]
+user.foods_marked_as_favorite << [food1, food2]
+user.mark_as_favorite [food1, food2]
+user.set_mark :favorite, [food1, food2]
+
+food.users_have_marked_as(:favorite) << [user1, user2]
+food.users_have_marked_as_favorite << [user1, user2]
+food.mark_as :favorite, [user1, user2]
+
+# Removals
+food.unmark :favorite
+food.unmark :favorite, :by => user1
+food.users_have_marked_as(:favorite).delete [food1, food2]
+food.users_have_marked_as_favorite.delete [food1, food2]
+user.remove_mark :favorite, [food1, food2]
+user.favorite_foods.delete [food1, food2]
+
+# Check
+food.marked_as? :favorite
+food.marked_as_favorite?
+```
+
+##Usage examples
+
+You can find some usage examples at wiki page: [Usage examples](https://github.com/chrome/markable/wiki/Usage-examples)
+
+## License
+
+The MIT License
+
+Copyright (c) 2012 Alex Chrome
+
+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/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Markable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/generators/markable/migration/migration_generator.rb

@@ -0,0 +1,39 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Markable
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    desc "Generates migration for Mark model"
+
+    def self.orm
+      Rails::Generators.options[:rails][:orm]
+    end
+
+    def self.source_root
+      File.join(File.dirname(__FILE__), 'templates', (orm.to_s unless orm.class.eql?(String)) )
+    end
+
+    def self.orm_has_migration?
+      [:active_record].include? orm
+    end
+
+    def self.next_migration_number(dirname)
+      if ActiveRecord::Base.timestamped_migrations
+        migration_number = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        migration_number += 1
+        migration_number.to_s
+      else
+        "%.3d" % (current_migration_number(dirname) + 1)
+      end
+    end
+
+    def create_migration_file
+      if self.class.orm_has_migration?
+        migration_template 'migration.rb', 'db/migrate/markable_migration'
+      end
+    end
+  end
+end
+

data/lib/generators/markable/migration/templates/active_record/migration.rb

@@ -0,0 +1,17 @@
+class MarkableMigration < ActiveRecord::Migration
+  def self.up
+    create_table :marks, :id => false do |t|
+      t.references :marker,   :polymorphic => true
+      t.references :markable, :polymorphic => true
+      t.string     :mark,     :limit => 128
+      t.datetime   :created_at
+    end
+
+    add_index :marks, [:markable_id, :markable_type, :mark]
+    add_index :marks, [:marker_id, :marker_type, :mark]
+  end
+
+  def self.down
+    drop_table :marks
+  end
+end

data/lib/markable.rb

@@ -0,0 +1,95 @@
+require 'models/mark'
+
+
+module Markable
+  mattr_accessor :markers, :markables, :models
+  @@markers   = []
+  @@markables = []
+  @@models    = []
+  @@marker_objects   = []
+  @@markable_objects = []
+
+protected
+
+  def self.set_models models
+    @@models = models unless @@models.count > 0
+  end
+
+  def self.add_markable markable
+    @@markable_objects.push markable
+    @@markables.push markable.name.to_sym
+    create_methods @@marker_objects, [ markable ]
+  end
+
+  def self.add_marker marker
+    @@marker_objects.push marker
+    @@markers.push marker.name.to_sym
+    create_methods [ marker ], @@markable_objects
+  end
+
+  def self.create_methods markers, markables
+    markables.try :each do |markable|
+      markers.try :each do |marker|
+        markable.markable_marks.each { |mark, options|
+          if options[:allowed_markers] == :all || options[:allowed_markers].include?(marker.marker_name)
+            markable_name = markable.name.downcase
+            method_name = "#{mark}_#{markable_name}".pluralize
+            marker.class_eval %(
+              def #{method_name}
+                #{markable.name}.marked_as :#{mark}, :by => self
+              end
+              def #{markable_name.pluralize}_marked_as mark
+                #{markable.name}.marked_as mark, :by => self
+              end
+              def #{markable_name.pluralize}_marked_as_#{mark}
+                #{markable.name}.marked_as :#{mark}, :by => self
+              end
+            )
+            unless marker.methods.include?("mark_as_#{mark}".to_sym)
+              marker.class_eval %(
+                def mark_as_#{mark}(objects)
+                  self.set_mark :#{mark}, objects
+                end
+              )
+            end
+            markable.class_eval %(
+              def #{marker.marker_name.to_s.pluralize}_have_marked_as mark
+                self.have_marked_as_by(mark, #{marker.name})
+              end
+
+              def #{marker.marker_name.to_s.pluralize}_have_marked_as_#{mark}
+                self.have_marked_as_by(:#{mark}, #{marker.name})
+              end
+            )
+          end
+        }
+      end
+    end
+  end
+
+  def self.can_mark_or_raise? marker_object, markables, mark
+    unless self.can_mark? marker_object, markables, mark
+      raise Markable::WrongMarkableType.new
+    end
+    true
+  end
+
+  def self.can_mark? markers, markables, mark
+    markables = [ markables ] unless markables.kind_of? Array
+    markers = [ markers ] unless markers.kind_of? Array
+    markers.all? { |marker_object| markables.all? { |markable| self.can_mark_object?(marker_object, markable, mark) } }
+  end
+
+  def self.can_mark_object? marker_object, markable_object, mark
+    marker_name = marker_object.class.name.to_sym
+    markable_name = markable_object.class.name.to_sym
+
+    @@markers.include?(marker_name) && @@markables.include?(markable_name) && markable_object.markable_marks.include?(mark) && 
+      (markable_object.markable_marks[mark][:allowed_markers] == :all || markable_object.markable_marks[mark][:allowed_markers].include?(marker_name.to_s.downcase.to_sym))
+  end
+end
+
+require 'markable/exceptions'
+require 'markable/acts_as_marker'
+require 'markable/acts_as_markable'
+

data/lib/markable/acts_as_markable.rb

@@ -0,0 +1,155 @@
+module Markable
+  module ActsAsMarkable
+    extend ActiveSupport::Concern
+
+    included do |a|
+    end
+
+    module ClassMethods
+      def markable_as(marks, options = {})
+        Markable.set_models ActiveRecord::Base.connection.tables.collect{|t| t.classify rescue nil }.compact
+
+        cattr_accessor :markable_marks
+
+        if options[:by]
+          markers = options[:by].kind_of?(Array) ? options[:by].map { |i| i.to_sym } : [ options[:by].to_sym ]
+        else
+          markers = :all
+        end
+
+        self.markable_marks ||= {}
+        marks = [ marks ] unless marks.kind_of? Array
+        marks.each { |mark|
+          self.markable_marks[ mark.to_sym ] = {
+            :allowed_markers => markers
+          }
+        }
+
+        class_eval do
+          has_many :markable_marks, :class_name => 'Markable::Mark', :as => :markable
+          include Markable::ActsAsMarkable::MarkableInstanceMethods
+
+          def self.marked_as mark, options = {}
+            if options[:by]
+              result = self.joins(:markable_marks).where( :marks => { :mark => mark, :marker_id => options[:by].id, :marker_type => options[:by].class.name } )
+              markable = self
+              result.class_eval do
+                define_method :<< do |object|
+                  if object.kind_of?(markable) || (object.kind_of?(Array) && object.all?{ |i| i.kind_of?(markable) })
+                    options[:by].set_mark mark, object
+                  else
+                    raise Markable::WrongMarkableType.new
+                  end
+                end
+                define_method :delete do |markable|
+                  options[:by].remove_mark mark, markable
+                end
+              end
+            else
+              result = self.joins(:markable_marks).where( :marks => { :mark => mark } )
+            end
+            result
+          end
+        end
+
+        self.markable_marks.each { |mark, o|
+          class_eval %(
+            def self.marked_as_#{mark}(options = {})
+              self.marked_as :#{mark}, options
+            end
+
+            def marked_as_#{mark}? options = {}
+              self.marked_as? :#{mark}, options
+            end
+          )
+        }
+
+        Markable.add_markable self
+      end
+    end
+
+    module MarkableInstanceMethods
+      def mark_as(mark, markers)
+        markers = [ markers ] unless markers.kind_of? Array
+        markers.each { |marker|
+          Markable.can_mark_or_raise? marker, self, mark
+          params = {
+            :markable_id => self.id,
+            :markable_type => self.class.name,
+            :marker_id => marker.id,
+            :marker_type => marker.class.name,
+            :mark => mark
+          }
+          Markable::Mark.create( params ) unless Markable::Mark.exists?( params )
+        }
+        true
+      end
+
+      def marked_as?(mark, options = {})
+        if options[:by]
+          Markable.can_mark_or_raise? options[:by], self, mark
+        end
+        params = {
+          :markable_id => self.id,
+          :markable_type => self.class.name,
+          :mark => mark
+        }
+        if options[:by]
+          params[:marker_id] = options[:by].id
+          params[:marker_type] = options[:by].class.name
+        end
+        Markable::Mark.exists?( params )
+      end
+
+      def unmark mark, options = {}
+        if options[:by]
+          Markable.can_mark_or_raise? options[:by], self, mark
+          markers = options[:by].kind_of?(Array) ? options[:by] : [ options[:by] ]
+          markers.each { |marker|
+            params = {
+              :markable_id => self.id,
+              :markable_type => self.class.name,
+              :marker_id => marker.id,
+              :marker_type => marker.class.name,
+              :mark => mark
+            }
+            Markable::Mark.delete_all(params)
+          }
+        else
+          params = {
+            :markable_id => self.id,
+            :markable_type => self.class.name,
+            :mark => mark
+          }
+          Markable::Mark.delete_all(params)
+        end
+        true
+      end
+
+      def have_marked_as_by(mark, target)
+        result = target.joins(:marker_marks).where( :marks => { :mark => mark, :markable_id => self.id, :markable_type => self.class.name } )
+        markable = self
+        result.class_eval do
+          define_method :<< do |markers|
+            markers = [ markers ] unless markers.kind_of? Array
+            markers.each { |marker|
+              marker.set_mark mark, markable
+            }
+            self
+          end
+          define_method :delete do |markers|
+            Markable.can_mark_or_raise? markers, markable, mark
+            markers = [ markers ] unless markers.kind_of? Array
+            markers.each { |marker|
+              marker.remove_mark mark, markable
+            }
+            self
+          end
+        end
+        result
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, Markable::ActsAsMarkable