bookmarker 0.0.5 → 0.0.6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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/README.rdoc

@@ -0,0 +1,16 @@
+== bookmarker
+Add bookmarks to your models.
+
+* Add gem "bookmarker" to your Gemfile
+
+* Run generator: rails g bookmaker:install and rake db:migrate
+
+* Add is_bookmarkable to your bookmarkable model (for example Company)
+
+* Add is_bookmark_maker to your bookmark maker model (for example User)
+
+* Use @user.add_bookmark(@company, 'My bookmark description') or @user.unbookmark @company
+
+* Use @user.bookmarks for list of added bookmarks
+
+* Available methods: remove_bookmarks - delete all model bookmarks, find_bookmarks(Your class here, for ex. Company) - find bookmarks linked with specific class, has_in_bookmarks?(bookmarkable_instance)

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    = 'Bookmarker'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  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/bookmarker.rb

@@ -0,0 +1,18 @@
+require 'active_record'
+require 'active_support/inflector'
+
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+module Bookmarker
+  if defined?(ActiveRecord::Base)
+  	require "bookmarker/engine"
+	require "bookmarker/version"
+	require "bookmarker/engine"
+    require 'bookmarker/extenders/bookmarkable'
+    require 'bookmarker/extenders/bookmark_maker'
+    require 'bookmarker/bookmark'
+    ActiveRecord::Base.extend Bookmarker::Extenders::Bookmarkable
+    ActiveRecord::Base.extend Bookmarker::Extenders::BookmarkMaker
+  end
+end

data/lib/bookmarker/bookmark.rb

@@ -0,0 +1,18 @@
+module Bookmarker
+  class Bookmark < ::ActiveRecord::Base
+
+    attr_accessible :bookmarkable_id, :bookmarkable_type,
+      :bookmark_maker_id, :bookmark_maker_type,
+      :bookmarkable, :bookmark_maker, :description
+
+    belongs_to :bookmarkable, :polymorphic => true
+    belongs_to :bookmark_maker, :polymorphic => true
+
+    validates_presence_of :bookmarkable_id
+    validates_presence_of :bookmark_maker_id
+
+    validates_uniqueness_of :bookmarkable_id, :scope => [:bookmarkable_type, :bookmark_maker_id, :bookmarkable_type]
+
+  end
+
+end

data/lib/bookmarker/bookmark_maker.rb

@@ -0,0 +1,54 @@
+module Bookmarker
+  module BookmarkMaker
+
+    def self.included(base)
+
+      aliases = {
+        :add_bookmark => [:new_bookmark],
+        :unbookmark => [:remove_bookmark]
+      }
+
+      base.class_eval do
+
+        belongs_to :bookmark_maker, :polymorphic => true
+
+        validates_uniqueness_of :bookmark
+
+        has_many :bookmarks, :class_name => "Bookmarker::Bookmark", :as => :bookmark_maker
+
+        aliases.each do |method, links|
+          links.each do |new_method|
+            alias_method(new_method, method)
+          end
+        end
+      end
+    end
+
+    def add_bookmark bookmarkable, description = nil
+      bookmark = Bookmarker::Bookmark.new( :bookmarkable => bookmarkable, :bookmark_maker => self, :description => description)
+      bookmark.save ? true : false
+    end
+
+    def find_bookmarks bookmarkable_model
+      bookmarks.where(:bookmarkable_type => bookmarkable_model.base_class.name)
+    end
+
+    def remove_bookmarks
+      bookmarks.delete_all
+    end
+
+    def find_by_instance bookmarkable
+      bookmarks.where(:bookmarkable_id => bookmarkable.id, :bookmarkable_type => bookmarkable.class.name)
+    end
+
+    def unbookmark bookmarkable
+      bookmark = find_by_instance(bookmarkable).first        
+      bookmark.destroy ? true : false
+    end
+
+    def has_in_bookmarks? bookmarkable_instance
+      find_by_instance(bookmarkable_instance)
+      bookmarks.size > 0
+    end
+  end
+end

data/lib/bookmarker/bookmarkable.rb

@@ -0,0 +1,23 @@
+module Bookmarker
+  module Bookmarkable
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    def self.included base
+       base.class_eval do
+         belongs_to :bookmarkable, :polymorphic => true
+         has_many   :bookmarks, :class_name => "Bookmarker::Bookmark", :as => :bookmarkable
+       end
+    end
+
+    def default_conditions
+       {
+         :bookmarkable_id => self.id,
+         :bookmarkable_type => self.class.base_class.name.to_s
+       }
+    end
+
+  end
+end

data/lib/bookmarker/engine.rb

@@ -0,0 +1,4 @@
+module Feedbackable
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/bookmarker/extenders/bookmark_maker.rb

@@ -0,0 +1,22 @@
+module Bookmarker
+  module Extenders
+    module BookmarkMaker
+
+      def bookmark_maker?
+        false
+      end
+
+      def is_bookmark_maker(*args)
+        require 'bookmarker/bookmark_maker'
+        include Bookmarker::BookmarkMaker
+
+        class_eval do
+          def self.bookmark_maker?
+            true
+          end
+        end
+      end
+      
+    end
+  end
+end

data/lib/bookmarker/extenders/bookmarkable.rb

@@ -0,0 +1,21 @@
+module Bookmarker
+  module Extenders
+    module Bookmarkable
+
+      def bookmarkable?
+        false
+      end
+      
+      def is_bookmarkable
+        require 'bookmarker/bookmarkable'
+        include Bookmarker::Bookmarkable
+        class_eval do
+          def self.bookmarkable?
+            true
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/bookmarker/version.rb

@@ -0,0 +1,3 @@
+module Bookmarker
+  VERSION = "0.0.6"
+end

data/lib/generators/bookmarker/bookmarker_generator.rb

@@ -0,0 +1,39 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Bookmarker
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Generates migration for Bookmarker"
+
+      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
+          Time.new.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/create_bookmarks_table.rb'
+      end
+
+    end
+  end
+end

data/lib/generators/bookmarker/install_generator.rb

@@ -0,0 +1,35 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Bookmarker
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Generates migration for Bookmarker"
+
+      def self.orm
+        Rails::Generators.options[:rails][:orm]
+      end
+
+      def self.orm_has_migration?
+        [:active_record].include? orm
+      end
+
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          Time.new.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def copy_migration
+          migration_template 'migration.rb', 'db/migrate/create_bookmarks_table.rb'
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+class CreateBookmarksTable < ActiveRecord::Migration
+  def self.up
+    create_table :bookmarks do |t|
+      t.references :bookmarkable, :polymorphic => true
+      t.references :bookmark_maker, :polymorphic => true
+      t.text :description
+      t.timestamps
+    end
+
+    add_index :bookmarks, :bookmarkable_type
+    add_index :bookmarks, :bookmarkable_id
+
+    add_index :bookmarks, :bookmark_maker_type
+    add_index :bookmarks, :bookmark_maker_id
+
+  end
+
+  def self.down
+    drop_table :bookmarks
+  end
+end

data/lib/init.rb

@@ -0,0 +1 @@
+require 'bookmarker'

data/lib/tasks/bookmarker_tasks.rake

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bookmarker
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -66,6 +66,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/bookmarker/bookmark.rb
+- lib/bookmarker/bookmark_maker.rb
+- lib/bookmarker/bookmarkable.rb
+- lib/bookmarker/engine.rb
+- lib/bookmarker/extenders/bookmark_maker.rb
+- lib/bookmarker/extenders/bookmarkable.rb
+- lib/bookmarker/version.rb
+- lib/bookmarker.rb
+- lib/generators/bookmarker/bookmarker_generator.rb
+- lib/generators/bookmarker/install_generator.rb
+- lib/generators/bookmarker/templates/migration.rb
+- lib/init.rb
+- lib/tasks/bookmarker_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
 - test/bookmarker_test.rb
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css