mongoid_favoriteable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c59ba777852d20e63ba6ccb3770e1f461ab6920d
+  data.tar.gz: a5c99b617e77950ab7b5b9d153d054e4a7808134
+SHA512:
+  metadata.gz: 4e8fcf957bee025dd328821901103d3591bed347f8e7d5148f42195ceeb53ae3cc91c399f70619f7a78b157d72178c11d614a3186f9ac302424c31158f412329
+  data.tar.gz: 7e49186eb2dbdd600a66c4095c440924728a944d19a7495d64af0a93d78c282bf2e845e25bc1b9a95d0f32eb52e85b4df1b3257c0134e0a81d4a84c260c366ee

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,42 @@
+AllCops:
+  RunRailsCops: false
+
+LineLength:
+  Max: 120
+
+ClassLength:
+  CountComments: false  # count full line comments?
+  Max: 175
+
+MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 20
+
+HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Documentation:
+  Enabled: false
+
+DefaultScope:
+  Enabled: false
+
+CollectionMethods:
+  PreferredMethods:
+    map: 'collect'
+    map!: 'collect!'
+    reduce: 'inject'
+    find: 'detect'
+    find_all: 'select'
+
+Output:
+  Enabled: false
+
+HasAndBelongsToMany:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'rspec', :cmd => 'rspec --colour', :all_on_start => false, :all_after_pass => false do
+  watch('spec/spec_helper.rb')                       { 'spec' }
+  watch(%r{^spec/.+_spec\.rb})
+  watch(%r{^lib/(.+)\.rb})                           { |m| "spec/lib/#{m[1]}_spec.rb" }
+end
+
+guard :rubocop do
+  watch(%r{.+\.gemspec$})
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Greg Morrison (Crush & Lovely)
+
+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,134 @@
+# Favoriting for Mongoid Documents
+
+[![RubyGem Version](http://img.shields.io/gem/v/mongoid_favoriteable.svg?style=flat)](https://rubygems.org/gems/mongoid_favoriteable)
+[![Dependency Status](http://img.shields.io/gemnasium/crushlovely/mongoid_favoriteable.svg?style=flat)](https://gemnasium.com/crushlovely/mongoid_favoriteable)
+[![Circle CI](https://circleci.com/gh/crushlovely/mongoid_favoriteable.svg?style=shield)](https://circleci.com/gh/crushlovely/mongoid_favoriteable)
+[![Code Climate](http://img.shields.io/codeclimate/github/crushlovely/mongoid_favoriteable.svg?style=flat)](https://codeclimate.com/github/crushlovely/mongoid_favoriteable)
+[![Code Coverage](http://img.shields.io/codeclimate/coverage/github/crushlovely/mongoid_favoriteable.svg?style=flat)](https://codeclimate.com/github/crushlovely/mongoid_favoriteable)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mongoid_favoriteable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid_favoriteable
+
+## Usage
+
+Make sure you require the library and include the module within any mongoid models you wish to use the functionality.
+
+```ruby
+require 'mongoid_favoriteable'
+
+class Person
+  include MongoidFavoriteable
+  include Mongoid::Document
+end
+```
+
+Add the `favoriteable` declaration and include the designated model to be favorited
+
+```ruby
+class Food
+  include Mongoid::Document
+  field :name, :type => String
+end
+
+class Person
+  include MongoidFavoriteable
+  include Mongoid::Document
+
+  favoriteable :food
+end
+```
+
+You may also supply an optional `class_name` value to compensate for namespaced models
+
+```ruby
+favoriteable :city, :class_name => Location::City
+```
+
+## Module Methods
+
+By declaring the `favoriteable` functionality, a few dynamically generated methods are provided to handle favoriting. The class supplied to the module designates the method names:
+
+* `favorite_{klass}!`
+* `unfavorite_{klass}!`
+* `favorite_{pluralized_klass}`
+* `favorite_{klass}_ids`
+
+
+Let's say we've designated the `Food` class as favoriteable
+
+```ruby
+favoriteable :food
+```
+
+The following convenience methods become available:
+* `favorite_food!`
+* `unfavorite_food!`
+* `favorite_foods`
+* `favorite_food_ids`
+
+The bang methods require a model instance to be supplied:
+
+```ruby
+person = Person.create(:name => 'john')
+pizza = Food.create(:name => 'pizza')
+
+person.favorite_food!(pizza)
+
+=> true
+
+person.unfavorite_food!(pizza)
+
+=> true
+```
+
+`favorite_foods` will return a ```Mongoid::Criteria``` query object of all favorited food records
+
+```ruby
+person.favorite_foods
+
+=> #<Mongoid::Criteria
+  selector: {"_id"=>{"$in"=>[BSON::ObjectId('54fe002469702d5011c60100')]}}
+  options:  {}
+  class:    Food
+  embedded: false>
+
+person.favorite_foods.entries
+
+=> [#<Food _id: 54fe002469702d5011c60100, name: 'pizza' >]
+```
+
+`favorite_food_ids` will return an array of bson identifiers
+
+```ruby
+person.favorite_food_ids
+
+=> [BSON::ObjectId('54fe002469702d5011c60100')]
+```
+
+## Contributing
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so we don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so we can cherry-pick around it.
+
+
+## Copyright
+
+Copyright (c) 2015 Greg Morrison (Crush & Lovely). See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/mongoid_favoriteable.rb

@@ -0,0 +1,73 @@
+require 'active_support'
+require 'mongoid'
+require 'mongoid_favoriteable/version'
+
+module MongoidFavoriteable
+  extend ActiveSupport::Concern
+
+  included do
+    extend ClassMethods
+  end
+
+  module ClassMethods
+    # Public: Create a favoriteable attribute on the model.
+    #
+    # favoriteable - A symbol representing the singularized class name of the attribute to be favorited.
+    #                An optional :class_name value may be explicitly provided for namespaced classes.
+    # Examples:
+    #
+    #   class User
+    #     favoriteable :product, :class_name => Product
+    #   end
+    #
+    # The 'favoriteable' declaration will provide the following dynamically generated conveniences:
+
+    # Examples:
+    #
+    #   class User
+    #     favoriteable :product, :class_name => Product
+    #   end
+    #
+    # =>  field :favorite_product_ids, :type => Array, :default => []
+    # =>  index :favorite_product_ids => 1
+    # =>  user#favorite_product!(product)
+    #       - persists the provided product by performin an atomic #push to the
+    #       - favorite_product_ids array
+    #
+    # =>  user#unfavorite_product!(product)
+    #       - returns a boolean value contingent on whether the provided argument id
+    #       - is present in the favorite_product_ids array
+    #
+    # =>  user#favorited_product?(product)
+    #       - removes the provided product by performing an atomic #pull on the
+    #       - favorite_product_ids array
+    #
+    # =>  user#favorite_products
+    #       - executes a scoped query to return all favorited product instances
+    #       - NOTE: scoped query class is inferred from the favoriteable attribute declaration
+    #       - if the :class_name options is not explicitly provided
+    #
+    def favoriteable(klass, opts = {})
+      pluralized_klass = klass.to_s.pluralize
+      klass_constant = opts.fetch(:class_name, klass.to_s.classify).constantize
+
+      field :"favorite_#{klass}_ids", :type => Array, :default => []
+      index(:"favorite_#{klass}_ids" => 1)
+
+      define_method :"favorite_#{klass}!" do |favoritee|
+        return if send(:"favorited_#{klass}?", favoritee)
+        push(:"favorite_#{klass}_ids" => favoritee.id)
+      end
+      define_method :"unfavorite_#{klass}!" do |favoritee|
+        return unless send(:"favorited_#{klass}?", favoritee)
+        pull(:"favorite_#{klass}_ids" => favoritee.id)
+      end
+      define_method :"favorited_#{klass}?" do |favoritee|
+        send(:"favorite_#{klass}_ids").include? favoritee.id
+      end
+      define_method :"favorite_#{pluralized_klass}" do
+        klass_constant.where(:_id.in => send(:"favorite_#{klass}_ids"))
+      end
+    end
+  end
+end

data/lib/mongoid_favoriteable/version.rb

@@ -0,0 +1,3 @@
+module MongoidFavoriteable
+  VERSION = '0.1.0'
+end

data/mongoid_favoriteable.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid_favoriteable/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'mongoid_favoriteable'
+  spec.version     = MongoidFavoriteable::VERSION
+  spec.authors     = ['Greg Morrison']
+  spec.email       = ['greg@crushlovely.com']
+  spec.homepage    = 'https://github.com/crushlovely/mongoid_favoriteable'
+  spec.summary     = 'Favoriting functionality for your Mongoid models'
+  spec.description = 'Favoriting functionality for your Mongoid models'
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").collect { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'guard-rubocop'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+
+  spec.add_dependency 'activesupport', '>=2.1.0'
+  spec.add_runtime_dependency 'mongoid'
+end

data/spec/config/mongoid.yml

@@ -0,0 +1,6 @@
+development:
+  sessions:
+    default:
+      database: mongoid_favoriteable
+      hosts:
+        - localhost:<%= ENV.fetch('BOXEN_MONGODB_PORT', 27017) %>

data/spec/mongoid_favoriteable_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe MongoidFavoriteable do
+  class Food
+    include Mongoid::Document
+    field :name, :type => String
+  end
+
+  class Person
+    include Mongoid::Document
+    include MongoidFavoriteable
+    favoriteable :food
+  end
+
+  it 'has a version number' do
+    expect(MongoidFavoriteable::VERSION).not_to be nil
+  end
+
+  context 'module methods' do
+    let(:person) { Person.new }
+    it 'responds to included module methods' do
+      [:favorite_food!, :unfavorite_food!, :favorite_foods, :favorite_food_ids].each do |method|
+        expect(person.respond_to? method).to eq(true)
+      end
+    end
+  end
+
+  context 'favoriting' do
+    let(:food) { Food.create(:name => 'pizza') }
+    let(:person) { Person.create }
+
+    it 'favorites the instance' do
+      person.favorite_food!(food)
+      expect(person.favorite_food_ids).to include(food.id)
+    end
+
+    it 'unfavorites the instance' do
+      person.unfavorite_food!(food)
+      expect(person.favorite_food_ids).not_to include(food.id)
+    end
+
+    it 'returns favorited instances' do
+      person.favorite_food!(food)
+      expect(person.favorite_foods.present?).to eq(true)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+require 'rspec'
+require 'mongoid_favoriteable'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+Mongoid.load!('./spec/config/mongoid.yml', :development)
+
+# RSpec.configure do |config|
+# end

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_favoriteable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Greg Morrison
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Favoriting functionality for your Mongoid models
+email:
+- greg@crushlovely.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongoid_favoriteable.rb
+- lib/mongoid_favoriteable/version.rb
+- mongoid_favoriteable.gemspec
+- spec/config/mongoid.yml
+- spec/mongoid_favoriteable_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/crushlovely/mongoid_favoriteable
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Favoriting functionality for your Mongoid models
+test_files:
+- spec/config/mongoid.yml
+- spec/mongoid_favoriteable_spec.rb
+- spec/spec_helper.rb
+has_rdoc: