bookmark_system 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c94b3b42cf789877750aece79699150f3283fef
+  data.tar.gz: 67b296976ba5ca794f6b69b14305b5c698747a1d
+SHA512:
+  metadata.gz: 9eb182702c6814527dbe38045e0817686f24223a10cb7a0923c690dd577bc5f25238c4d7aac8006c4d1128d425ae8fc9e434ae3efcdd4f13f07a8a0eb6d2a3b7
+  data.tar.gz: cfc178aad70c13942eb96d85fb4bc41d0f86457d7b0f10bc21a01f9e60aaa9fe18176708addb609e7609be57708420531e7a39de094b77881c4de0eb4240e291

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/gemfiles/*.lock
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+bookmark_system

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.1

data/.travis.yml

@@ -0,0 +1,23 @@
+language:
+  - ruby
+
+rvm:
+  - 2.0.0
+  - 2.1.3
+  - 2.2.1
+
+gemfile:
+  - gemfiles/rails4.1.gemfile
+  - gemfiles/rails4.2.gemfile
+
+install:
+  - "travis_retry bundle install"
+
+before_script:
+
+script:
+  - "bundle exec rake"
+
+branches:
+  only:
+    - master

data/Appraisals

@@ -0,0 +1,7 @@
+appraise "rails4.1" do
+  gem "rails", "4.1.10"
+end
+
+appraise "rails4.2" do
+  gem "rails", "4.2.1"
+end

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bookmark_system.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Pablo Martin Viva
+
+MIT License
+
+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.md

@@ -0,0 +1,93 @@
+# BookmarkSystem
+
+[![Build Status](https://travis-ci.org/pmviva/bookmark_system.png?gbranch=master)](https://travis-ci.org/pmviva/bookmark_system)
+[![Gem Version](https://badge.fury.io/rb/bookmark_system.svg)](http://badge.fury.io/rb/bookmark_system)
+
+An active record bookmark system developed using ruby on rails 4.1 applying domain driven design and test driven development principles.
+
+This gem is heavily influenced by cmer/socialization.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bookmark_system'
+```
+
+And then execute:
+
+```ruby
+$ bundle
+```
+
+Or install it yourself as:
+
+```ruby
+$ gem install bookmark_system
+```
+
+## Usage
+
+### Run the generator
+
+```ruby
+$ rails g bookmark_system
+```
+
+Let's suppose for a moment that you have a blog application and a User can bookmark a Post or several Post models.
+The user model becomes the bookmarker and the post model becomes the bookmarkee.
+
+### Post object
+```ruby
+class Post < ActiveRecord::Base
+  act_as_bookmarkee
+
+  validates :content, presence: true
+end
+```
+
+### User object
+```ruby
+class User < ActiveRecord::Base
+  act_as_bookmarker
+
+  validates :username, { presence: true, uniqueness: true }
+end
+```
+
+### Bookmarkee object methods
+```ruby
+post.is_bookmarkee? # returns true
+
+post.bookmarked_by?(user) # returns true if user bookmarks the post object, false otherwise
+
+post.bookmarkers_by(User) # returns a scope of BookmarkSystem::Bookmark join model that belongs to the post object and belongs to bookmarker objects of type User
+```
+
+
+### Bookmarker object methods
+```ruby
+user.is_bookmarker? # returns true
+
+user.bookmark(post) # Creates an instance of BookmarkSystem::Bookmark join model associating the user object and the post object, returns true if succeded, false otherwise
+
+user.unbookmark(post) # Destroys an instance of BookmarkSystem::Bookmark join model that associates the user object and the post object, returns true if succeded, false otherwise
+
+user.toggle_bookmark(post) # Bookmarks / unbookmarks the post
+
+user.bookmarks?(post) # returns true if the user object bookmarks the post object, false otherwise
+
+user.bookmarkees_by(Post) # returns a scope of BookmarkSystem::Bookmark join model that belongs to the user object and belongs to bookmarkee objects of type Post
+```
+
+For more information read the [api documentation](http://rubydoc.info/gems/bookmark_system).
+
+## Contributing
+
+1. Fork it ( https://github.com/pmviva/bookmark_system/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+task :default => [:spec]
+desc 'run Rspec specs'
+task :spec do
+  sh 'rspec spec'
+end
+

data/bookmark_system.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bookmark_system/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bookmark_system"
+  spec.version       = BookmarkSystem::VERSION
+  spec.authors       = ["Pablo Martin Viva"]
+  spec.email         = ["pmviva@gmail.com"]
+  spec.summary       = %q{An active record bookmark system.}
+  spec.description   = %q{An active record bookmark system developed using ruby on rails 4.1 applying domain driven design and test driven development principles.}
+  spec.homepage      = "http://github.com/pmviva/bookmark_system"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.0.0")
+
+  spec.add_dependency "rails", [ ">= 4.1", "< 5" ]
+
+  spec.add_development_dependency "appraisal", "~> 2.0"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "shoulda-matchers", "~> 2.7"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+end
+

data/gemfiles/rails4.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "4.1.10"
+
+gemspec :path => "../"

data/gemfiles/rails4.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "4.2.1"
+
+gemspec :path => "../"

data/lib/bookmark_system.rb

@@ -0,0 +1,45 @@
+require 'bookmark_system/bookmark'
+require 'bookmark_system/bookmarkee'
+require 'bookmark_system/bookmarker'
+
+###
+# BookmarkSystem module
+#
+# This module defines common behavior in bookmark system
+###
+module BookmarkSystem
+  ###
+  # Specifies if self can be bookmarked by {Bookmarker} objects
+  #
+  # @return [Boolean]
+  ###
+  def is_bookmarkee?
+    false
+  end
+
+  ###
+  # Specifies if self can bookmark {Bookmarkee} objects
+  #
+  # @return [Boolean]
+  ###
+  def is_bookmarker?
+    false
+  end
+
+  ###
+  # Instructs self to act as bookmarkee
+  ###
+  def act_as_bookmarkee
+    include Bookmarkee
+  end
+
+  ###
+  # Instructs self to act as bookmarker
+  ###
+  def act_as_bookmarker
+    include Bookmarker
+  end
+end
+
+ActiveRecord::Base.extend BookmarkSystem
+

data/lib/bookmark_system/bookmark.rb

@@ -0,0 +1,155 @@
+###
+# BookmarkSystem module
+#
+# This module defines common behavior in bookmark system
+###
+module BookmarkSystem
+  ###
+  # Bookmark class
+  #
+  # This class defines the bookmark model in bookmark system
+  ###
+  class Bookmark < ActiveRecord::Base
+    ###
+    # Belongs to bookmarkee association configuration
+    ###
+    belongs_to :bookmarkee, polymorphic: :true
+
+    ###
+    # Belongs to bookmarker association configuration
+    ###
+    belongs_to :bookmarker, polymorphic: :true
+
+    ###
+    # Creates a {Bookmark} relationship between a {Bookmarker} object and a {Bookmarkee} object
+    #
+    # @param [Bookmarker] bookmarker - the {Bookmarker} of the relationship
+    # @param [Bookmarkee] bookmarkee - the {Bookmarkee} of the relationship
+    # @return [Boolean]
+    ###
+    def self.bookmark(bookmarker, bookmarkee)
+      validate_bookmarkee(bookmarkee)
+      validate_bookmarker(bookmarker)
+
+      if bookmarks?(bookmarker, bookmarkee)
+        false
+      else
+        bookmark = scope_by_bookmarker(bookmarker).scope_by_bookmarkee(bookmarkee).build
+        bookmark.save
+        true
+      end
+    end
+
+    ###
+    # Destroys a {Bookmark} relationship between a {Bookmarker} object and a {Bookmarkee} object
+    #
+    # @param [Bookmarker] bookmarker - the {Bookmarker} of the relationship
+    # @param [Bookmarkee] bookmarkee - the {Bookmarkee} of the relationship
+    # @return [Boolean]
+    ###
+    def self.unbookmark(bookmarker, bookmarkee)
+      validate_bookmarkee(bookmarkee)
+      validate_bookmarker(bookmarker)
+
+      if bookmarks?(bookmarker, bookmarkee)
+        bookmark = scope_by_bookmarker(bookmarker).scope_by_bookmarkee(bookmarkee).take
+        bookmark.destroy
+        true
+      else
+        false
+      end
+    end
+
+    ###
+    # Toggles a {Bookmark} relationship between a {Bookmarker} object and a {Bookmarkee} object
+    #
+    # @param [Bookmarker] bookmarker - the {Bookmarker} of the relationship
+    # @param [Bookmarkee] bookmarkee - the {Bookmarkee} of the relationship
+    # @return [Boolean]
+    ###
+    def self.toggle_bookmark(bookmarker, bookmarkee)
+      validate_bookmarkee(bookmarkee)
+      validate_bookmarker(bookmarker)
+
+      if bookmarks?(bookmarker, bookmarkee)
+        unbookmark(bookmarker, bookmarkee)
+      else
+        bookmark(bookmarker, bookmarkee)
+      end
+    end
+
+    ###
+    # Specifies if a {Bookmarker} object bookmarks a {Bookmarkee} object
+    #
+    # @param [Bookmarker] bookmarker - the {Bookmarker} object to test against
+    # @param [Bookmarkee] bookmarkee - the {Bookmarkee} object to test against
+    # @return [Boolean]
+    ###
+    def self.bookmarks?(bookmarker, bookmarkee)
+      validate_bookmarkee(bookmarkee)
+      validate_bookmarker(bookmarker)
+
+      scope_by_bookmarker(bookmarker).scope_by_bookmarkee(bookmarkee).exists?
+    end
+
+    ###
+    # Retrieves a scope of {Bookmark} objects filtered by a {Bookmarkee} object
+    #
+    # @param [Bookmarkee] bookmarkee - the {Bookmarkee} to filter
+    # @return [ActiveRecord::Relation]
+    ###
+    def self.scope_by_bookmarkee(bookmarkee)
+      where(bookmarkee: bookmarkee)
+    end
+
+    ###
+    # Retrieves a scope of {Bookmark} objects filtered by a {Bookmarkee} type
+    #
+    # @param [Class] klass - the {Class} to filter
+    # @return [ActiveRecord::Relation]
+    ###
+    def self.scope_by_bookmarkee_type(klass)
+      where(bookmarkee_type: klass.to_s.classify)
+    end
+
+    ###
+    # Retrieves a scope of {Bookmark} objects filtered by a {Bookmarker} object
+    #
+    # @param [Bookmarker] bookmarker - the {Bookmarker} to filter
+    # @return [ActiveRecord::Relation]
+    ###
+    def self.scope_by_bookmarker(bookmarker)
+      where(bookmarker: bookmarker)
+    end
+
+    ###
+    # Retrieves a scope of {Bookmark} objects filtered by a {Bookmarker} type
+    #
+    # @param [Class] klass - the {Class} to filter
+    # @return [ActiveRecord::Relation]
+    ###
+    def self.scope_by_bookmarker_type(klass)
+      where(bookmarker_type: klass.to_s.classify)
+    end
+
+    private
+      ###
+      # Validates a bookmarkee object
+      #
+      # @raise [ArgumentError] if the bookmarkee object is invalid
+      ###
+      def self.validate_bookmarkee(bookmarkee)
+        raise ArgumentError.new unless bookmarkee.respond_to?(:is_bookmarkee?) && bookmarkee.is_bookmarkee?
+      end
+
+      ###
+      # Validates a bookmarker object
+      #
+      # @raise [ArgumentError] if the bookmarker object is invalid
+      ###
+      def self.validate_bookmarker(bookmarker)
+        raise ArgumentError.new unless bookmarker.respond_to?(:is_bookmarker?) && bookmarker.is_bookmarker?
+      end
+  end
+end
+