bookmark_system 0.0.6

data/lib/bookmark_system/bookmarkee.rb

@@ -0,0 +1,58 @@
+###
+# BookmarkSystem module
+#
+# This module defines common behavior in bookmark system
+###
+module BookmarkSystem
+  ###
+  # Bookmarkee module
+  #
+  # This module defines bookmarkee behavior in bookmark system
+  ###
+  module Bookmarkee
+    ###
+    # Extends ActiveSupport::Concern
+    ###
+    extend ActiveSupport::Concern
+
+    ###
+    # Included configuration
+    ###
+    included do
+      ###
+      # Has many bookmarkers association configuration
+      ###
+      has_many :bookmarkers, class_name: "BookmarkSystem::Bookmark", as: :bookmarkee, dependent: :destroy
+    end
+
+    ###
+    # Specifies if self can be bookmarked by {Bookmarker} objects
+    #
+    # @return [Boolean]
+    ###
+    def is_bookmarkee?
+      true
+    end
+
+    ###
+    # Specifies if self is bookmarked by a {Bookmarker} object
+    #
+    # @param [Bookmarker] bookmarker - the {Bookmarker} object to test against
+    # @return [Boolean]
+    ###
+    def bookmarked_by?(bookmarker)
+      Bookmark.bookmarks?(bookmarker, self)
+    end
+
+    ###
+    # Retrieves a scope of {Bookmark} objects that bookmarks self filtered {Bookmarker} type
+    #
+    # @param [Class] klass - the {Class} to filter
+    # @return [ActiveRecord::Relation]
+    ###
+    def bookmarkers_by(klass)
+      Bookmark.scope_by_bookmarkee(self).scope_by_bookmarker_type(klass)
+    end
+  end
+end
+

data/lib/bookmark_system/bookmarker.rb

@@ -0,0 +1,88 @@
+###
+# BookmarkSystem module
+#
+# This module defines common behavior in bookmark system
+###
+module BookmarkSystem
+  ###
+  # Bookmarker module
+  #
+  # This module defines bookmarker behavior in bookmark system
+  ###
+  module Bookmarker
+    ###
+    # Extends ActiveSupport::Concern
+    ###
+    extend ActiveSupport::Concern
+
+    ###
+    # Included configuration
+    ###
+    included do
+      ###
+      # Has many bookmarkees association configuration
+      ###
+      has_many :bookmarkees, class_name: "BookmarkSystem::Bookmark", as: :bookmarker, dependent: :destroy
+    end
+
+    ###
+    # Specifies if self can bookmark {Bookmarkee} objects
+    #
+    # @return [Boolean]
+    ###
+    def is_bookmarker?
+      true
+    end
+
+    ###
+    # Creates a {Bookmark} relationship between self and a {Bookmarkee} object
+    #
+    # @param [Bookmarkee] bookmarkee - the bookmarkee of the {Bookmark} relationship
+    # @return [Boolean]
+    ###
+    def bookmark(bookmarkee)
+      Bookmark.bookmark(self, bookmarkee)
+    end
+
+    ###
+    # Destroys a {Bookmark} relationship between self and a {Bookmarkee} object
+    #
+    # @param [Bookmarkee] bookmarkee - the bookmarkee of the {Bookmark} relationship
+    # @return [Boolean]
+    ###
+    def unbookmark(bookmarkee)
+      Bookmark.unbookmark(self, bookmarkee)
+    end
+
+    ###
+    # Toggles a {Bookmark} relationship between self and a {Bookmarkee} object
+    #
+    # @param [Bookmarkee] bookmarkee - the bookmarkee of the {Bookmark} relationship
+    # @return [Boolean]
+    ###
+    def toggle_bookmark(bookmarkee)
+      Bookmark.toggle_bookmark(self, bookmarkee)
+    end
+
+    ###
+    # Specifies if self bookmarks a {Bookmarker} object
+    #
+    # @param [Bookmarkee] bookmarkee - the {Bookmarkee} object to test against
+    # @return [Boolean]
+    ###
+    def bookmarks?(bookmarkee)
+      Bookmark.bookmarks?(self, bookmarkee)
+    end
+
+    ###
+    # Retrieves a scope of {Bookmark} objects that are bookmarked by self
+    #
+    # @param [Class] klass - the {Class} to include
+    # @return [ActiveRecord::Relation]
+    ###
+    def bookmarkees_by(klass)
+      Bookmark.scope_by_bookmarker(self).scope_by_bookmarkee_type(klass)
+    end
+  end
+end
+

data/lib/bookmark_system/version.rb

@@ -0,0 +1,12 @@
+###
+# BookmarkSystem module
+#
+# This module defines common behavior in bookmark system
+###
+module BookmarkSystem
+  ###
+  # Version constant definition
+  ###
+  VERSION = "0.0.6"
+end
+

data/lib/generators/bookmark_system/bookmark_system_generator.rb

@@ -0,0 +1,46 @@
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+###
+# BookmarkSystemGenerator class
+#
+# This class generates the bookmark model migration in bookmark system
+###
+class BookmarkSystemGenerator < Rails::Generators::Base
+  ###
+  # Includes Rails::Generators::Migration
+  ###
+  include Rails::Generators::Migration
+
+  ###
+  # Generator description definition
+  ###
+  desc "Generates a migration for the Bookmark model"
+
+  ###
+  # Retrieves the source root
+  #
+  # @return [String]
+  ###
+  def self.source_root
+    @source_root ||= File.dirname(__FILE__) + '/templates'
+  end
+
+  ###
+  # Retrieves the next migration number
+  #
+  # @path [String] path - the path to calculate the next migration number
+  # @return [String]
+  ###
+  def self.next_migration_number(path)
+    ActiveRecord::Generators::Base.next_migration_number(path)
+  end
+
+  ###
+  # Generates the migration
+  ###
+  def generate_migration
+    migration_template 'migration.rb', 'db/migrate/create_bookmarks.rb'
+  end
+end
+

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

@@ -0,0 +1,47 @@
+###
+# CreateBookmarks class
+#
+# This class defines the create bookmarks migration in bookmark system
+###
+class CreateBookmarks < ActiveRecord::Migration
+  ###
+  # Changes the database
+  ###
+  def change
+    ###
+    # Bookmarks table creation
+    ###
+    create_table :bookmarks do |t|
+      ###
+      # Bookmarkee id field and bookmarkee type field definition
+      ###
+      t.references :bookmarkee, polymorphic: true
+
+      ###
+      # Bookmarker id fiel and bookmarker type field definition
+      ###
+      t.references :bookmarker, polymorphic: true
+
+      ###
+      # Timestamps fields definition
+      ###
+      t.timestamps null: false
+    end
+
+    ###
+    # Bookmarks table bookmarkee id field and bookmarkee type field index addition
+    ###
+    add_index :bookmarks, [:bookmarkee_id, :bookmarkee_type], name: "bookmarks_bookmarkee_idx"
+
+    ###
+    # Bookmarks table bookmarker id field and bookmarker type field index addition
+    ###
+    add_index :bookmarks, [:bookmarker_id, :bookmarker_type], name: "bookmarks_bookmarker_idx"
+
+    ###
+    # Bookmarks table bookmarkee id field and bookmarkee type field and bookmarker id field and bookmarker type field unique index addition
+    ###
+    add_index :bookmarks, [:bookmarkee_id, :bookmarkee_type, :bookmarker_id, :bookmarker_type], name: "bookmarks_bookmarkee_bookmarker_idx", unique: true
+  end
+end
+

data/spec/bookmark_system/bookmark_spec.rb

@@ -0,0 +1,177 @@
+require 'spec_helper'
+
+###
+# Describes BookmarkSystem::Bookmark
+###
+describe BookmarkSystem::Bookmark do
+  ###
+  # Let bookmarkee be DummyBookmarkee.create
+  ###
+  let(:bookmarkee) { DummyBookmarkee.create }
+
+  ###
+  # Let bookmarker be DummyBookmarker.create
+  ###
+  let(:bookmarker) { DummyBookmarker.create }
+
+  ###
+  # Describes associations
+  ###
+  describe "associations" do
+    ###
+    # Should belong to bookmarkee
+    ###
+    it "should belong to bookmarkee" do
+      should belong_to(:bookmarkee)
+    end
+
+    ###
+    # Should belong to bookmarker
+    ###
+    it "should belong to bookmarker" do
+      should belong_to(:bookmarker)
+    end
+  end
+
+  ###
+  # Describes class methods
+  ###
+  describe "class methods" do
+    ###
+    # Should raise argument error on invalid bookmarkee when bookmarks
+    ###
+    it "should raise argument error on invalid bookmarkee when bookmarks" do
+      expect { BookmarkSystem::Bookmark.bookmark(bookmarker, bookmarker) }.to raise_error ArgumentError
+    end
+
+    ###
+    # Should raise argument error on invalid bookmarker when bookmarks
+    ###
+    it "should raise argument error on invalid bookmarker when bookmarks " do
+      expect { BookmarkSystem::Bookmark.bookmark(bookmarkee, bookmarkee) }.to raise_error ArgumentError
+    end
+
+    ###
+    # Should bookmark
+    ###
+    it "should bookmark" do
+      expect(BookmarkSystem::Bookmark.bookmark(bookmarker, bookmarkee)).to equal(true)
+    end
+
+    ###
+    # Should not bookmark
+    ###
+    it "should not bookmark" do
+      BookmarkSystem::Bookmark.bookmark(bookmarker, bookmarkee)
+
+      expect(BookmarkSystem::Bookmark.bookmark(bookmarker, bookmarkee)).to equal(false)
+    end
+
+    ###
+    # Should raise argument error on invalid bookmarkee when unbookmarks
+    ###
+    it "should raise argument error on invalid bookmarkee when unbookmarks" do
+      expect { BookmarkSystem::Bookmark.unbookmark(bookmarker, bookmarker) }.to raise_error ArgumentError
+    end
+
+    ###
+    # Should raise argument error on invalid bookmarker when unbookmarks
+    ###
+    it "should raise argument error on invalid bookmarker when unbookmarks" do
+      expect { BookmarkSystem::Bookmark.unbookmark(bookmarkee, bookmarkee) }.to raise_error ArgumentError
+    end
+
+    ###
+    # Should unbookmark
+    ###
+    it "should unbookmark" do
+      BookmarkSystem::Bookmark.bookmark(bookmarker, bookmarkee)
+
+      expect(BookmarkSystem::Bookmark.unbookmark(bookmarker, bookmarkee)).to equal(true)
+    end
+
+    ###
+    # Should not unbookmark
+    ###
+    it "should not unbookmark" do
+      expect(BookmarkSystem::Bookmark.unbookmark(bookmarker, bookmarkee)).to equal(false)
+    end
+
+    ###
+    # Should raise argument error on invalid bookmarkee when toggle bookmark
+    ###
+    it "should raise argument error on invalid bookmarkee when toggle bookmark" do
+      expect { BookmarkSystem::Bookmark.toggle_bookmark(bookmarker, bookmarker) }.to raise_error ArgumentError
+    end
+
+    ###
+    # Should raise argument error on invalid bookmarker when toggle bookmark
+    ###
+    it "should raise argument error on invalid bookmarker when toggle bookmark" do
+      expect { BookmarkSystem::Bookmark.toggle_bookmark(bookmarkee, bookmarkee) }.to raise_error ArgumentError
+    end
+
+    ###
+    # Should toggle bookmark
+    ###
+    it "should toggle bookmark" do
+      expect(BookmarkSystem::Bookmark.bookmarks?(bookmarker, bookmarkee)).to equal(false)
+
+      BookmarkSystem::Bookmark.toggle_bookmark(bookmarker, bookmarkee)
+
+      expect(BookmarkSystem::Bookmark.bookmarks?(bookmarker, bookmarkee)).to equal(true)
+
+      BookmarkSystem::Bookmark.toggle_bookmark(bookmarker, bookmarkee)
+
+      expect(BookmarkSystem::Bookmark.bookmarks?(bookmarker, bookmarkee)).to equal(false)
+    end
+
+    ###
+    # Should specify if bookmarks
+    ###
+    it "should specify if bookmarks" do
+      expect(BookmarkSystem::Bookmark.bookmarks?(bookmarker, bookmarkee)).to equal(false)
+
+      BookmarkSystem::Bookmark.bookmark(bookmarker, bookmarkee)
+
+      expect(BookmarkSystem::Bookmark.bookmarks?(bookmarker, bookmarkee)).to equal(true)
+    end
+
+    ###
+    # Should scope bookmarks by bookmarkee
+    ###
+    it "should scope bookmarks by bookmarkee" do
+      scope = BookmarkSystem::Bookmark.where(bookmarkee: bookmarkee)
+
+      expect(BookmarkSystem::Bookmark.scope_by_bookmarkee(bookmarkee)).to eq(scope)
+    end
+
+    ###
+    # Should scope bookmarks by bookmarkee type
+    ####
+    it "should scope bookmarks by bookmarkee type" do
+      scope = BookmarkSystem::Bookmark.where(bookmarkee_type: DummyBookmarkee)
+
+      expect(BookmarkSystem::Bookmark.scope_by_bookmarkee_type(DummyBookmarkee)).to eq(scope)
+    end
+
+    ###
+    # Should scope bookmarks by bookmarker
+    ###
+    it "should scope bookmarks by bookmarker" do
+      scope = BookmarkSystem::Bookmark.where(bookmarker: bookmarker)
+
+      expect(BookmarkSystem::Bookmark.scope_by_bookmarker(bookmarker)).to eq(scope)
+    end
+
+    ###
+    # Should scope bookmarks by bookmarker type
+    ####
+    it "should scope bookmarks by bookmarker type" do
+      scope = BookmarkSystem::Bookmark.where(bookmarker_type: DummyBookmarker)
+
+      expect(BookmarkSystem::Bookmark.scope_by_bookmarker_type(DummyBookmarker)).to eq(scope)
+    end
+  end
+end
+