bookmark_system 0.0.6

data/spec/bookmark_system/bookmarkee_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+###
+# Shared examples for BookmarkSystem::Bookmarkee
+###
+shared_examples_for BookmarkSystem::Bookmarkee 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 have many bookmarkers
+    ###
+    it "should have many bookmarkers" do
+      should have_many(:bookmarkers)
+    end
+  end
+
+  ###
+  # Describes class methods
+  ###
+  describe "class methods" do
+    ###
+    # Should be a bookmarkee
+    ###
+    it "should be a bookmarkee" do
+      expect(bookmarkee.is_bookmarkee?).to equal(true)
+    end
+
+    ###
+    # Should be bookmarked by a bookmarker
+    ###
+    it "should specify if is bookmarked by a bookmarker" do
+      expect(BookmarkSystem::Bookmark).to receive(:bookmarks?).with(bookmarker, bookmarkee) { true }
+
+      expect(bookmarkee.bookmarked_by?(bookmarker)).to equal(true)
+    end
+
+    ###
+    # Should scope bookmarkers filtered by bookmarker type
+    ###
+    it "should scope bookmarkers filtered by bookmarker type" do
+      scope = BookmarkSystem::Bookmark.scope_by_bookmarkee(bookmarkee).scope_by_bookmarker_type(DummyBookmarker)
+
+      expect(bookmarkee.bookmarkers_by(DummyBookmarker)).to eq(scope)
+    end
+  end
+end
+
+###
+# Describes DummyBookmarkee
+###
+describe DummyBookmarkee do
+  ###
+  # It behaves like BookmarkSystem::Bookmarkee
+  ###
+  it_behaves_like BookmarkSystem::Bookmarkee
+end
+

data/spec/bookmark_system/bookmarker_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+###
+# Shared examples for BookmarkSystem::Bookmarker
+###
+shared_examples_for BookmarkSystem::Bookmarker 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 have many bookmarkees
+    ###
+    it "should have many bookmarkees" do
+      should have_many(:bookmarkees)
+    end
+  end
+
+  ###
+  # Describes class methods
+  ###
+  describe "class methods" do
+    ###
+    # Should be a bookmarker
+    ###
+    it "should be a bookmarker" do
+      expect(bookmarker.is_bookmarker?).to equal(true)
+    end
+
+    ###
+    # Should bookmark a bookmarkee
+    ###
+    it "Should bookmark a bookmarkee" do
+      expect(BookmarkSystem::Bookmark).to receive(:bookmark).with(bookmarker, bookmarkee) { true }
+
+      expect(bookmarker.bookmark(bookmarkee)).to equal(true)
+    end
+
+    ###
+    # Should unbookmark a bookmarkee
+    ###
+    it "Should unbookmark a bookmarkee" do
+      expect(BookmarkSystem::Bookmark).to receive(:unbookmark).with(bookmarker, bookmarkee) { true }
+
+      expect(bookmarker.unbookmark(bookmarkee)).to equal(true)
+    end
+
+    ###
+    # Should toggle bookmark a bookmarkee
+    ###
+    it "Should toggle bookmark a bookmarkee" do
+      expect(BookmarkSystem::Bookmark).to receive(:toggle_bookmark).with(bookmarker, bookmarkee) { true }
+
+      expect(bookmarker.toggle_bookmark(bookmarkee)).to equal(true)
+    end
+
+    ###
+    # Should bookmark a bookmarkee
+    ###
+    it "should specify if bookmarks a bookmarkee" do
+      expect(BookmarkSystem::Bookmark).to receive(:bookmarks?).with(bookmarker, bookmarkee) { true }
+
+      expect(bookmarker.bookmarks?(bookmarkee)).to equal(true)
+    end
+
+    ###
+    # Should scope bookmarkees filtered by bookmarkee type
+    ###
+    it "should scope bookmarkees filtered by bookmarkee type" do
+      scope = BookmarkSystem::Bookmark.scope_by_bookmarker(bookmarker).scope_by_bookmarkee_type(DummyBookmarkee)
+
+      expect(bookmarker.bookmarkees_by(DummyBookmarkee)).to eq(scope)      
+    end
+  end
+end
+
+###
+# Describes DummyBookmarker
+###
+describe DummyBookmarker do
+  ###
+  # It behaves like BookmarkSystem::Bookmarker
+  ###
+  it_behaves_like BookmarkSystem::Bookmarker
+end
+

data/spec/db/migrate/20140926000000_create_bookmarks.rb

@@ -0,0 +1,47 @@
+###
+# CreateBookmarks class
+#
+# This class defines the test 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/db/migrate/20140926000005_create_dummy_bookmarkers.rb

@@ -0,0 +1,22 @@
+###
+# CreateDummyBookmarkers class
+#
+# This class defines the create dummy bookmarkers migration in bookmark system
+###
+class CreateDummyBookmarkers < ActiveRecord::Migration
+  ###
+  # Changes the database
+  ###
+  def change
+    ###
+    # Dummy bookmarkers table creation
+    ###
+    create_table :dummy_bookmarkers do |t|
+      ###
+      # Timestamps fields definition
+      ###
+      t.timestamps null: false
+    end
+  end
+end
+

data/spec/db/migrate/20140926000010_create_dummy_bookmarkees.rb

@@ -0,0 +1,22 @@
+###
+# CreateDummyBookmarkees class
+#
+# This class defines the create dummy bookmarkees migration in bookmark system
+###
+class CreateDummyBookmarkees < ActiveRecord::Migration
+  ###
+  # Changes the database
+  ###
+  def change
+    ###
+    # Dummy bookmarkees table creation
+    ###
+    create_table :dummy_bookmarkees do |t|
+      ###
+      # Timestamps fields definition
+      ###
+      t.timestamps null: false
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,116 @@
+require 'support/active_record'
+require 'support/shoulda_matchers'
+require 'bookmark_system'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end
+
+###
+# DummyBookmarkee class
+#
+# This class defines the dummy bookmarkee model in bookmark system
+###
+class DummyBookmarkee < ActiveRecord::Base
+  ###
+  # Acts as bookmarkee
+  act_as_bookmarkee
+end
+
+###
+# DummyBookmarker class
+#
+# This class defines the dummy bookmarker model in bookmark system
+###
+class DummyBookmarker < ActiveRecord::Base
+  ###
+  # Acts as bookmarker
+  act_as_bookmarker
+end
+

data/spec/support/active_record.rb

@@ -0,0 +1,12 @@
+require 'active_record'
+
+###
+# Active record database configuration
+###
+ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+
+###
+# Active record migrator configuration
+###
+ActiveRecord::Migrator.up 'spec/db/migrate'
+

data/spec/support/shoulda_matchers.rb

@@ -0,0 +1,2 @@
+require 'shoulda/matchers'
+

metadata

@@ -0,0 +1,237 @@
+--- !ruby/object:Gem::Specification
+name: bookmark_system
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- Pablo Martin Viva
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: An active record bookmark system developed using ruby on rails 4.1 applying
+  domain driven design and test driven development principles.
+email:
+- pmviva@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".empty"
+- ".gitignore"
+- ".keep"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bookmark_system.gemspec
+- gemfiles/.empty
+- gemfiles/.gitignore
+- gemfiles/.keep
+- gemfiles/rails4.1.gemfile
+- gemfiles/rails4.2.gemfile
+- lib/.empty
+- lib/.gitignore
+- lib/.keep
+- lib/bookmark_system.rb
+- lib/bookmark_system/.empty
+- lib/bookmark_system/.gitignore
+- lib/bookmark_system/.keep
+- lib/bookmark_system/bookmark.rb
+- lib/bookmark_system/bookmarkee.rb
+- lib/bookmark_system/bookmarker.rb
+- lib/bookmark_system/version.rb
+- lib/generators/.empty
+- lib/generators/.gitignore
+- lib/generators/.keep
+- lib/generators/bookmark_system/.empty
+- lib/generators/bookmark_system/.gitignore
+- lib/generators/bookmark_system/.keep
+- lib/generators/bookmark_system/bookmark_system_generator.rb
+- lib/generators/bookmark_system/templates/.empty
+- lib/generators/bookmark_system/templates/.gitignore
+- lib/generators/bookmark_system/templates/.keep
+- lib/generators/bookmark_system/templates/migration.rb
+- spec/.empty
+- spec/.gitignore
+- spec/.keep
+- spec/bookmark_system/.empty
+- spec/bookmark_system/.gitignore
+- spec/bookmark_system/.keep
+- spec/bookmark_system/bookmark_spec.rb
+- spec/bookmark_system/bookmarkee_spec.rb
+- spec/bookmark_system/bookmarker_spec.rb
+- spec/db/.empty
+- spec/db/.gitignore
+- spec/db/.keep
+- spec/db/migrate/.empty
+- spec/db/migrate/.gitignore
+- spec/db/migrate/.keep
+- spec/db/migrate/20140926000000_create_bookmarks.rb
+- spec/db/migrate/20140926000005_create_dummy_bookmarkers.rb
+- spec/db/migrate/20140926000010_create_dummy_bookmarkees.rb
+- spec/spec_helper.rb
+- spec/support/.empty
+- spec/support/.gitignore
+- spec/support/.keep
+- spec/support/active_record.rb
+- spec/support/shoulda_matchers.rb
+homepage: http://github.com/pmviva/bookmark_system
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: An active record bookmark system.
+test_files:
+- spec/.empty
+- spec/.gitignore
+- spec/.keep
+- spec/bookmark_system/.empty
+- spec/bookmark_system/.gitignore
+- spec/bookmark_system/.keep
+- spec/bookmark_system/bookmark_spec.rb
+- spec/bookmark_system/bookmarkee_spec.rb
+- spec/bookmark_system/bookmarker_spec.rb
+- spec/db/.empty
+- spec/db/.gitignore
+- spec/db/.keep
+- spec/db/migrate/.empty
+- spec/db/migrate/.gitignore
+- spec/db/migrate/.keep
+- spec/db/migrate/20140926000000_create_bookmarks.rb
+- spec/db/migrate/20140926000005_create_dummy_bookmarkers.rb
+- spec/db/migrate/20140926000010_create_dummy_bookmarkees.rb
+- spec/spec_helper.rb
+- spec/support/.empty
+- spec/support/.gitignore
+- spec/support/.keep
+- spec/support/active_record.rb
+- spec/support/shoulda_matchers.rb