mention_system 0.0.6

data/spec/mention_system/mentionee_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+###
+# Shared examples for MentionSystem::Mentionee
+###
+shared_examples_for MentionSystem::Mentionee do
+  ###
+  # Let mentionee be DummyMentionee.create
+  ###
+  let(:mentionee) { DummyMentionee.create }
+
+  ###
+  # Let mentioner be DummyMentioner.create
+  ###
+  let(:mentioner) { DummyMentioner.create }
+
+  ###
+  # Describes associations
+  ###
+  describe "associations" do
+    ###
+    # Should have many mentioners
+    ###
+    it "should have many mentioners" do
+      should have_many(:mentioners)
+    end
+  end
+
+  ###
+  # Describes class methods
+  ###
+  describe "class methods" do
+    ###
+    # Should be a mentionee
+    ###
+    it "should be a mentionee" do
+      expect(mentionee.is_mentionee?).to equal(true)
+    end
+
+    ###
+    # Should be mentioned by a mentioner
+    ###
+    it "should specify if is mentioned by a mentioner" do
+      expect(MentionSystem::Mention).to receive(:mentions?).with(mentioner, mentionee) { true }
+
+      expect(mentionee.mentioned_by?(mentioner)).to equal(true)
+    end
+
+    ###
+    # Should scope mentioners filtered by mentioner type
+    ###
+    it "should scope mentioners filtered by mentioner type" do
+      scope = MentionSystem::Mention.scope_by_mentionee(mentionee).scope_by_mentioner_type(DummyMentioner)
+
+      expect(mentionee.mentioners_by(DummyMentioner)).to eq(scope)
+    end
+  end
+end
+
+###
+# Describes DummyMentionee
+###
+describe DummyMentionee do
+  ###
+  # It behaves like MentionSystem::Mentionee
+  ###
+  it_behaves_like MentionSystem::Mentionee
+end
+

data/spec/mention_system/mentioner_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+###
+# Shared examples for MentionSystem::Mentioner
+###
+shared_examples_for MentionSystem::Mentioner do
+  ###
+  # Let mentionee be DummyMentionee.create
+  ###
+  let(:mentionee) { DummyMentionee.create }
+
+  ###
+  # Let mentioner be DummyMentioner.create
+  ###
+  let(:mentioner) { DummyMentioner.create }
+
+  ###
+  # Describes associations
+  ###
+  describe "associations" do
+    ###
+    # Should have many mentionees
+    ###
+    it "should have many mentionees" do
+      should have_many(:mentionees)
+    end
+  end
+
+  ###
+  # Describes class methods
+  ###
+  describe "class methods" do
+    ###
+    # Should be a mentioner
+    ###
+    it "should be a mentioner" do
+      expect(mentioner.is_mentioner?).to equal(true)
+    end
+
+    ###
+    # Should mention a mentionee
+    ###
+    it "Should mention a mentionee" do
+      expect(MentionSystem::Mention).to receive(:mention).with(mentioner, mentionee) { true }
+
+      expect(mentioner.mention(mentionee)).to equal(true)
+    end
+
+    ###
+    # Should unmention a mentionee
+    ###
+    it "Should unmention a mentionee" do
+      expect(MentionSystem::Mention).to receive(:unmention).with(mentioner, mentionee) { true }
+
+      expect(mentioner.unmention(mentionee)).to equal(true)
+    end
+
+    ###
+    # Should toggle mention a mentionee
+    ###
+    it "Should toggle mention a mentionee" do
+      expect(MentionSystem::Mention).to receive(:toggle_mention).with(mentioner, mentionee) { true }
+
+      expect(mentioner.toggle_mention(mentionee)).to equal(true)
+    end
+
+    ###
+    # Should mention a mentionee
+    ###
+    it "should specify if mentions a mentionee" do
+      expect(MentionSystem::Mention).to receive(:mentions?).with(mentioner, mentionee) { true }
+
+      expect(mentioner.mentions?(mentionee)).to equal(true)
+    end
+
+    ###
+    # Should scope mentionees filtered by mentionee type
+    ###
+    it "should scope mentionees filtered by mentionee type" do
+      scope = MentionSystem::Mention.scope_by_mentioner(mentioner).scope_by_mentionee_type(DummyMentionee)
+
+      expect(mentioner.mentionees_by(DummyMentionee)).to eq(scope)      
+    end
+  end
+end
+
+###
+# Describes DummyMentioner
+###
+describe DummyMentioner do
+  ###
+  # It behaves like MentionSystem::Mentioner
+  ###
+  it_behaves_like MentionSystem::Mentioner
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,116 @@
+require 'support/active_record'
+require 'support/shoulda_matchers'
+require 'mention_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
+
+###
+# DummyMentionee class
+#
+# This class defines the dummy mentionee model in mention system
+###
+class DummyMentionee < ActiveRecord::Base
+  ###
+  # Acts as mentionee
+  act_as_mentionee
+end
+
+###
+# DummyMentioner class
+#
+# This class defines the dummy mentioner model in mention system
+###
+class DummyMentioner < ActiveRecord::Base
+  ###
+  # Acts as mentioner
+  act_as_mentioner
+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,240 @@
+--- !ruby/object:Gem::Specification
+name: mention_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 mention 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
+- gemfiles/.empty
+- gemfiles/.gitignore
+- gemfiles/.keep
+- gemfiles/rails4.1.gemfile
+- gemfiles/rails4.2.gemfile
+- lib/.empty
+- lib/.gitignore
+- lib/.keep
+- lib/generators/.empty
+- lib/generators/.gitignore
+- lib/generators/.keep
+- lib/generators/mention_system/.empty
+- lib/generators/mention_system/.gitignore
+- lib/generators/mention_system/.keep
+- lib/generators/mention_system/mention_system_generator.rb
+- lib/generators/mention_system/templates/.empty
+- lib/generators/mention_system/templates/.gitignore
+- lib/generators/mention_system/templates/.keep
+- lib/generators/mention_system/templates/migration.rb
+- lib/mention_system.rb
+- lib/mention_system/.empty
+- lib/mention_system/.gitignore
+- lib/mention_system/.keep
+- lib/mention_system/mention.rb
+- lib/mention_system/mention_processor.rb
+- lib/mention_system/mentionee.rb
+- lib/mention_system/mentioner.rb
+- lib/mention_system/version.rb
+- mention_system.gemspec
+- spec/.empty
+- spec/.gitignore
+- spec/.keep
+- 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_mentions.rb
+- spec/db/migrate/20140926000005_create_dummy_mentioners.rb
+- spec/db/migrate/20140926000010_create_dummy_mentionees.rb
+- spec/mention_system/.empty
+- spec/mention_system/.gitignore
+- spec/mention_system/.keep
+- spec/mention_system/mention_processor_spec.rb
+- spec/mention_system/mention_spec.rb
+- spec/mention_system/mentionee_spec.rb
+- spec/mention_system/mentioner_spec.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/mention_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 like system.
+test_files:
+- spec/.empty
+- spec/.gitignore
+- spec/.keep
+- 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_mentions.rb
+- spec/db/migrate/20140926000005_create_dummy_mentioners.rb
+- spec/db/migrate/20140926000010_create_dummy_mentionees.rb
+- spec/mention_system/.empty
+- spec/mention_system/.gitignore
+- spec/mention_system/.keep
+- spec/mention_system/mention_processor_spec.rb
+- spec/mention_system/mention_spec.rb
+- spec/mention_system/mentionee_spec.rb
+- spec/mention_system/mentioner_spec.rb
+- spec/spec_helper.rb
+- spec/support/.empty
+- spec/support/.gitignore
+- spec/support/.keep
+- spec/support/active_record.rb
+- spec/support/shoulda_matchers.rb