follow_system 0.0.6

data/lib/generators/follow_system/follow_system_generator.rb

@@ -0,0 +1,46 @@
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+###
+# FollowSystemGenerator class
+#
+# This class generates the follow model migration in follow system
+###
+class FollowSystemGenerator < Rails::Generators::Base
+  ###
+  # Includes Rails::Generators::Migration
+  ###
+  include Rails::Generators::Migration
+
+  ###
+  # Generator description definition
+  ###
+  desc "Generates a migration for the Follow 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_follows.rb'
+  end
+end
+

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

@@ -0,0 +1,47 @@
+###
+# CreateFollows class
+#
+# This class defines the create follows migration in follow system
+###
+class CreateFollows < ActiveRecord::Migration
+  ###
+  # Changes the database
+  ###
+  def change
+    ###
+    # Follows table creation
+    ###
+    create_table :follows do |t|
+      ###
+      # Followee id field and followee type field definition
+      ###
+      t.references :followee, polymorphic: true
+
+      ###
+      # Follower id fiel and follower type field definition
+      ###
+      t.references :follower, polymorphic: true
+
+      ###
+      # Timestamps fields definition
+      ###
+      t.timestamps null: false
+    end
+
+    ###
+    # Follows table followee id field and followee type field index addition
+    ###
+    add_index :follows, [:followee_id, :followee_type], name: "follows_followee_idx"
+
+    ###
+    # Follows table follower id field and follower type field index addition
+    ###
+    add_index :follows, [:follower_id, :follower_type], name: "follows_follower_idx"
+
+    ###
+    # Follows table followee id field and followee type field and follower id field and follower type field unique index addition
+    ###
+    add_index :follows, [:followee_id, :followee_type, :follower_id, :follower_type], name: "follows_followee_follower_idx", unique: true
+  end
+end
+

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

@@ -0,0 +1,47 @@
+###
+# CreateFollows class
+#
+# This class defines the test create follows migration in follow system
+###
+class CreateFollows < ActiveRecord::Migration
+  ###
+  # Changes the database
+  ###
+  def change
+    ###
+    # Follows table creation
+    ###
+    create_table :follows do |t|
+      ###
+      # Followee id field and followee type field definition
+      ###
+      t.references :followee, polymorphic: true
+
+      ###
+      # Follower id fiel and follower type field definition
+      ###
+      t.references :follower, polymorphic: true
+
+      ###
+      # Timestamps fields definition
+      ###
+      t.timestamps null: false
+    end
+
+    ###
+    # Follows table followee id field and followee type field index addition
+    ###
+    add_index :follows, [:followee_id, :followee_type], name: "follows_followee_idx"
+
+    ###
+    # Follows table follower id field and follower type field index addition
+    ###
+    add_index :follows, [:follower_id, :follower_type], name: "follows_follower_idx"
+
+    ###
+    # Follows table followee id field and followee type field and follower id field and follower type field unique index addition
+    ###
+    add_index :follows, [:followee_id, :followee_type, :follower_id, :follower_type], name: "follows_followee_follower_idx", unique: true
+  end
+end
+

data/spec/db/migrate/20140926000005_create_dummy_followers.rb

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

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

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

data/spec/follow_system/follow_spec.rb

@@ -0,0 +1,177 @@
+require 'spec_helper'
+
+###
+# Describes FollowSystem::Follow
+###
+describe FollowSystem::Follow do
+  ###
+  # Let followee be DummyFollowee.create
+  ###
+  let(:followee) { DummyFollowee.create }
+
+  ###
+  # Let follower be DummyFollower.create
+  ###
+  let(:follower) { DummyFollower.create }
+
+  ###
+  # Describes associations
+  ###
+  describe "associations" do
+    ###
+    # Should belong to followee
+    ###
+    it "should belong to followee" do
+      should belong_to(:followee)
+    end
+
+    ###
+    # Should belong to follower
+    ###
+    it "should belong to follower" do
+      should belong_to(:follower)
+    end
+  end
+
+  ###
+  # Describes class methods
+  ###
+  describe "class methods" do
+    ###
+    # Should raise argument error on invalid followee when follows
+    ###
+    it "should raise argument error on invalid followee when follows" do
+      expect { FollowSystem::Follow.follow(follower, follower) }.to raise_error ArgumentError
+    end
+
+    ###
+    # Should raise argument error on invalid follower when follows
+    ###
+    it "should raise argument error on invalid follower when follows " do
+      expect { FollowSystem::Follow.follow(followee, followee) }.to raise_error ArgumentError
+    end
+
+    ###
+    # Should follow
+    ###
+    it "should follow" do
+      expect(FollowSystem::Follow.follow(follower, followee)).to equal(true)
+    end
+
+    ###
+    # Should not follow
+    ###
+    it "should not follow" do
+      FollowSystem::Follow.follow(follower, followee)
+
+      expect(FollowSystem::Follow.follow(follower, followee)).to equal(false)
+    end
+
+    ###
+    # Should raise argument error on invalid followee when unfollows
+    ###
+    it "should raise argument error on invalid followee when unfollows" do
+      expect { FollowSystem::Follow.unfollow(follower, follower) }.to raise_error ArgumentError
+    end
+
+    ###
+    # Should raise argument error on invalid follower when unfollows
+    ###
+    it "should raise argument error on invalid follower when unfollows" do
+      expect { FollowSystem::Follow.unfollow(followee, followee) }.to raise_error ArgumentError
+    end
+
+    ###
+    # Should unfollow
+    ###
+    it "should unfollow" do
+      FollowSystem::Follow.follow(follower, followee)
+
+      expect(FollowSystem::Follow.unfollow(follower, followee)).to equal(true)
+    end
+
+    ###
+    # Should not unfollow
+    ###
+    it "should not unfollow" do
+      expect(FollowSystem::Follow.unfollow(follower, followee)).to equal(false)
+    end
+
+    ###
+    # Should raise argument error on invalid followee when toggle follow
+    ###
+    it "should raise argument error on invalid followee when toggle follow" do
+      expect { FollowSystem::Follow.toggle_follow(follower, follower) }.to raise_error ArgumentError
+    end
+
+    ###
+    # Should raise argument error on invalid follower when toggle follow
+    ###
+    it "should raise argument error on invalid follower when toggle follow" do
+      expect { FollowSystem::Follow.toggle_follow(followee, followee) }.to raise_error ArgumentError
+    end
+
+    ###
+    # Should toggle follow
+    ###
+    it "should toggle follow" do
+      expect(FollowSystem::Follow.follows?(follower, followee)).to equal(false)
+
+      FollowSystem::Follow.toggle_follow(follower, followee)
+
+      expect(FollowSystem::Follow.follows?(follower, followee)).to equal(true)
+
+      FollowSystem::Follow.toggle_follow(follower, followee)
+
+      expect(FollowSystem::Follow.follows?(follower, followee)).to equal(false)
+    end
+
+    ###
+    # Should specify if follows
+    ###
+    it "should specify if follows" do
+      expect(FollowSystem::Follow.follows?(follower, followee)).to equal(false)
+
+      FollowSystem::Follow.follow(follower, followee)
+
+      expect(FollowSystem::Follow.follows?(follower, followee)).to equal(true)
+    end
+
+    ###
+    # Should scope follows by followee
+    ###
+    it "should scope follows by followee" do
+      scope = FollowSystem::Follow.where(followee: followee)
+
+      expect(FollowSystem::Follow.scope_by_followee(followee)).to eq(scope)
+    end
+
+    ###
+    # Should scope follows by followee type
+    ####
+    it "should scope follows by followee type" do
+      scope = FollowSystem::Follow.where(followee_type: DummyFollowee)
+
+      expect(FollowSystem::Follow.scope_by_followee_type(DummyFollowee)).to eq(scope)
+    end
+
+    ###
+    # Should scope follows by follower
+    ###
+    it "should scope follows by follower" do
+      scope = FollowSystem::Follow.where(follower: follower)
+
+      expect(FollowSystem::Follow.scope_by_follower(follower)).to eq(scope)
+    end
+
+    ###
+    # Should scope follows by follower type
+    ####
+    it "should scope follows by follower type" do
+      scope = FollowSystem::Follow.where(follower_type: DummyFollower)
+
+      expect(FollowSystem::Follow.scope_by_follower_type(DummyFollower)).to eq(scope)
+    end
+  end
+end
+

data/spec/follow_system/followee_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+###
+# Shared examples for FollowSystem::Followee
+###
+shared_examples_for FollowSystem::Followee do
+  ###
+  # Let followee be DummyFollowee.create
+  ###
+  let(:followee) { DummyFollowee.create }
+
+  ###
+  # Let follower be DummyFollower.create
+  ###
+  let(:follower) { DummyFollower.create }
+
+  ###
+  # Describes associations
+  ###
+  describe "associations" do
+    ###
+    # Should have many followers
+    ###
+    it "should have many followers" do
+      should have_many(:followers)
+    end
+  end
+
+  ###
+  # Describes class methods
+  ###
+  describe "class methods" do
+    ###
+    # Should be a followee
+    ###
+    it "should be a followee" do
+      expect(followee.is_followee?).to equal(true)
+    end
+
+    ###
+    # Should be followed by a follower
+    ###
+    it "should specify if is followed by a follower" do
+      expect(FollowSystem::Follow).to receive(:follows?).with(follower, followee) { true }
+
+      expect(followee.followed_by?(follower)).to equal(true)
+    end
+
+    ###
+    # Should scope followers filtered by follower type
+    ###
+    it "should scope followers filtered by follower type" do
+      scope = FollowSystem::Follow.scope_by_followee(followee).scope_by_follower_type(DummyFollower)
+
+      expect(followee.followers_by(DummyFollower)).to eq(scope)
+    end
+  end
+end
+
+###
+# Describes DummyFollowee
+###
+describe DummyFollowee do
+  ###
+  # It behaves like FollowSystem::Followee
+  ###
+  it_behaves_like FollowSystem::Followee
+end
+

data/spec/follow_system/follower_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+###
+# Shared examples for FollowSystem::Follower
+###
+shared_examples_for FollowSystem::Follower do
+  ###
+  # Let followee be DummyFollowee.create
+  ###
+  let(:followee) { DummyFollowee.create }
+
+  ###
+  # Let follower be DummyFollower.create
+  ###
+  let(:follower) { DummyFollower.create }
+
+  ###
+  # Describes associations
+  ###
+  describe "associations" do
+    ###
+    # Should have many followees
+    ###
+    it "should have many followees" do
+      should have_many(:followees)
+    end
+  end
+
+  ###
+  # Describes class methods
+  ###
+  describe "class methods" do
+    ###
+    # Should be a follower
+    ###
+    it "should be a follower" do
+      expect(follower.is_follower?).to equal(true)
+    end
+
+    ###
+    # Should follow a followee
+    ###
+    it "Should follow a followee" do
+      expect(FollowSystem::Follow).to receive(:follow).with(follower, followee) { true }
+
+      expect(follower.follow(followee)).to equal(true)
+    end
+
+    ###
+    # Should unfollow a followee
+    ###
+    it "Should unfollow a followee" do
+      expect(FollowSystem::Follow).to receive(:unfollow).with(follower, followee) { true }
+
+      expect(follower.unfollow(followee)).to equal(true)
+    end
+
+    ###
+    # Should toggle follow a followee
+    ###
+    it "Should toggle follow a followee" do
+      expect(FollowSystem::Follow).to receive(:toggle_follow).with(follower, followee) { true }
+
+      expect(follower.toggle_follow(followee)).to equal(true)
+    end
+
+    ###
+    # Should follow a followee
+    ###
+    it "should specify if follows a followee" do
+      expect(FollowSystem::Follow).to receive(:follows?).with(follower, followee) { true }
+
+      expect(follower.follows?(followee)).to equal(true)
+    end
+
+    ###
+    # Should scope followees filtered by followee type
+    ###
+    it "should scope followees filtered by followee type" do
+      scope = FollowSystem::Follow.scope_by_follower(follower).scope_by_followee_type(DummyFollowee)
+
+      expect(follower.followees_by(DummyFollowee)).to eq(scope)      
+    end
+  end
+end
+
+###
+# Describes DummyFollower
+###
+describe DummyFollower do
+  ###
+  # It behaves like FollowSystem::Follower
+  ###
+  it_behaves_like FollowSystem::Follower
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,116 @@
+require 'support/active_record'
+require 'support/shoulda_matchers'
+require 'follow_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
+
+###
+# DummyFollowee class
+#
+# This class defines the dummy followee model in follow system
+###
+class DummyFollowee < ActiveRecord::Base
+  ###
+  # Acts as followee
+  act_as_followee
+end
+
+###
+# DummyFollower class
+#
+# This class defines the dummy follower model in follow system
+###
+class DummyFollower < ActiveRecord::Base
+  ###
+  # Acts as follower
+  act_as_follower
+end
+