mongoid-flags 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,49 @@
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+.DS_Store
+
+# For TextMate
+*.tmproj
+tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+script: rake spec

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+gem "mongoid", "~> 3.0.3"
+gem "bson_ext", "~> 1.6"
+
+group :development do
+  gem "jeweler", "~> 1.8.4"
+  gem "rspec", "~> 2.10.0"
+end

data/Gemfile.lock

@@ -0,0 +1,51 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.9)
+      activesupport (= 3.2.9)
+      builder (~> 3.0.0)
+    activesupport (3.2.9)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    bson (1.7.0)
+    bson_ext (1.7.0)
+      bson (~> 1.7.0)
+    builder (3.0.4)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    i18n (0.6.1)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    mongoid (3.0.13)
+      activemodel (~> 3.1)
+      moped (~> 1.1)
+      origin (~> 1.0)
+      tzinfo (~> 0.3.22)
+    moped (1.2.9)
+    multi_json (1.3.7)
+    origin (1.0.10)
+    rake (10.0.1)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.0)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    tzinfo (0.3.35)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bson_ext (~> 1.6)
+  jeweler (~> 1.8.4)
+  mongoid (~> 3.0.3)
+  rspec (~> 2.10.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Thiago Jackiw
+
+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,125 @@
+# mongoid-flags [![Build Status](http://travis-ci.org/tjackiw/mongoid-flags.png)](http://travis-ci.org/tjackiw/mongoid-flags)
+
+Simple document flagging system for mongoid v3. HEAVILY INSPIRED by mongoid-simple-roles
+
+## Install
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'mongoid-flags'
+```
+
+And then execute:
+
+```ruby
+bundle install
+```
+
+Or install it yourself:
+
+```ruby
+gem install mongoid-flags
+```
+
+## Usage
+
+### Model
+
+```ruby
+class User
+  include Mongoid::Document
+  include Mongoid::Document::Flagable
+  
+  field :name, type: String
+end
+```
+
+### Instance Methods
+
+Let's first create an instance of the User model
+
+```ruby
+user = User.create(name: 'John Doe')
+```
+
+`add_flag(flag)` will add a flag to the instance. You need to explicitly call `.save` to persist the changes.
+
+```ruby
+user.add_flag('suspended')
+=> ["suspended"]
+user.reload
+user.has_flag?('suspended')
+=> false
+```
+
+`add_flag!(flag)` is same as `add_flag` but it automatically saves the instance.
+
+```ruby
+user.add_flag!('suspended')
+=> ["suspended"]
+user.reload
+user.has_flag?('suspended')
+=> true
+```
+
+`has_flag?(flag)` checks if a flag exist and returns `true` or `false`.
+
+```ruby
+user.add_flag!('suspended')
+=> ["suspended"]
+user.has_flag?('suspended')
+=> true
+user.has_flag?('underage')
+=> false
+```
+
+`remove_flag(flag)` removes a flag. You need to explicitly call `.save` to persist the changes.
+
+```ruby
+user.remove_flag('suspended')
+=> []
+user.reload
+user.has_flag?('suspended')
+=> true
+```
+
+`remove_flag!(flag)` same as `remove_flag` but it automatically saves the instance.
+
+```ruby
+user.remove_flag!('suspended')
+=> []
+user.reload
+user.has_flag?('suspended')
+=> false
+```
+
+### Class Methods
+
+`find_by_flags(flags)` performs a query based on the flags provided and returns an array of objects (if any). The argument can either be a String or an Array.
+
+```ruby
+User.find_by_flags('suspended')
+=> [<User>]
+
+User.find_by_flags(['suspended', 'underage'])
+=> [<User>]
+```
+
+## Contributing to mongoid-flags
+ 
+* 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 I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history.
+
+## Authors
+
+* Thiago Jackiw: [@tjackiw](http://twitter.com/tjackiw)
+
+## Copyright
+
+Copyright (c) 2012 Thiago Jackiw. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+  gem.name          = "mongoid-flags"
+  gem.version       = '0.0.1'
+  gem.homepage      = "http://github.com/tjackiw/mongoid-flags"
+  gem.license       = "MIT"
+  gem.summary       = %Q{Simple record flagging system for Mongoid documents}
+  gem.description   = %Q{Simple record flagging system for Mongoid documents}
+  gem.authors       = ["Thiago Jackiw"]
+  gem.email         = "tjackiw@gmail.com"
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_paths = ["lib"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+task :default => :spec
+
+desc "Run all specs"
+task "spec" do
+  exec "bundle exec rspec spec"
+end

data/lib/mongoid-flags.rb

@@ -0,0 +1,58 @@
+module Mongoid
+  module Document
+    module Flagable
+      def self.included(base)
+        base.class_eval do |klass|
+          klass.field :flags, type: Array
+          klass.index({ flags: 1 }, { background: true })
+
+          include InstanceMethods
+          extend  ClassMethods
+        end
+      end
+
+      module InstanceMethods
+
+        # Adds a flag, and you need to
+        # explicitly save the object
+        def add_flag(flag)
+          (self.flags ||= []) << flag
+          self.flags.uniq!
+          self.flags
+        end
+
+        # Adds a flag, and saves the object
+        def add_flag!(flag)
+          add_flag(flag)
+          save!
+          self.flags
+        end
+
+        # Checks if a flag exists
+        def has_flag?(flag)
+          (self.flags || []).include?(flag)
+        end
+
+        # Removes a flag, and you need to
+        # explicitly save the object
+        def remove_flag(flag)
+          (self.flags || []).delete_if { |n| n.casecmp(flag) == 0 }
+        end
+
+        # Removes a flag, and saves the object
+        def remove_flag!(flag)
+          remove_flag(flag)
+          save!
+          self.flags
+        end
+      end
+
+      module ClassMethods
+        def find_by_flags(flags)
+          flags = [flags] unless flags.is_a?(Array)
+          criteria.in(:flags => flags).to_a
+        end
+      end
+    end
+  end
+end

data/mongoid-flags.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "mongoid-flags"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Thiago Jackiw"]
+  s.date = "2012-11-22"
+  s.description = "Simple record flagging system for Mongoid documents"
+  s.email = "tjackiw@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".gitignore",
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "lib/mongoid-flags.rb",
+    "mongoid-flags.gemspec",
+    "mongoid.yml",
+    "spec/helper.rb",
+    "spec/mongoid-flags_spec.rb"
+  ]
+  s.homepage = "http://github.com/tjackiw/mongoid-flags"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Simple record flagging system for Mongoid documents"
+  s.test_files = ["spec/helper.rb", "spec/mongoid-flags_spec.rb"]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mongoid>, ["~> 3.0.3"])
+      s.add_runtime_dependency(%q<bson_ext>, ["~> 1.6"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.10.0"])
+    else
+      s.add_dependency(%q<mongoid>, ["~> 3.0.3"])
+      s.add_dependency(%q<bson_ext>, ["~> 1.6"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<rspec>, ["~> 2.10.0"])
+    end
+  else
+    s.add_dependency(%q<mongoid>, ["~> 3.0.3"])
+    s.add_dependency(%q<bson_ext>, ["~> 1.6"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<rspec>, ["~> 2.10.0"])
+  end
+end
+

data/mongoid.yml

@@ -0,0 +1,6 @@
+test:
+  sessions:
+    default:
+      database: mongoid-flags
+      hosts:
+        - localhost:27017

data/spec/helper.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'mongoid'
+require 'mongoid-flags'
+
+Mongoid.load!("mongoid.yml", :test)
+
+RSpec.configure do |config|
+  config.after(:each) do
+    Mongoid::Config.purge!
+  end
+end

data/spec/mongoid-flags_spec.rb

@@ -0,0 +1,61 @@
+require 'helper'
+
+class User
+  include Mongoid::Document
+  include Mongoid::Document::Flagable
+  field :name
+end
+
+describe "A Flagable model" do
+  let(:user) { User.new(name: 'John Doe') }
+
+  it "should have an add_flag method" do
+    user.should respond_to :add_flag
+  end
+
+  it "should have an add_flag! method" do
+    user.should respond_to :add_flag!
+  end
+
+  it "should have a has_flag? method" do
+    user.should respond_to :has_flag?
+  end
+
+  it "should have a remove_flag method" do
+    user.should respond_to :remove_flag
+  end
+
+  it "should have a remove_flag! method" do
+    user.should respond_to :remove_flag!
+  end
+
+  it "should be able to add a flag" do
+    flag = "suspended"
+    user.add_flag(flag)
+    user.has_flag?(flag).should be true
+  end
+
+  it "should be able to remove a flag" do
+    flag = "suspended"
+    user.add_flag(flag)
+    user.remove_flag(flag)
+    user.has_flag?(flag).should_not be true
+  end
+
+  it "should be able to call add_flag multiple times" do
+    user.add_flag('suspended')
+    user.add_flag('to be removed')
+    user.flags.count.should be 2
+  end
+
+  it "should only contain unique flags" do
+    user.add_flag('suspended')
+    user.add_flag('suspended')
+    user.flags.count.should be 1
+  end
+
+  it "should be able to find flagged users with find_by_flags" do
+    user.add_flag!('suspended')
+    User.find_by_flags('suspended').first.should eq(user)
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-flags
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Thiago Jackiw
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+description: Simple record flagging system for Mongoid documents
+email: tjackiw@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongoid-flags.rb
+- mongoid-flags.gemspec
+- mongoid.yml
+- spec/helper.rb
+- spec/mongoid-flags_spec.rb
+homepage: http://github.com/tjackiw/mongoid-flags
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -344049846899188400
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple record flagging system for Mongoid documents
+test_files:
+- spec/helper.rb
+- spec/mongoid-flags_spec.rb