mongoid_flaggable 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff6b2abe837b1dd044e1a8afcf38e4c66605e68d
-  data.tar.gz: 4aa81b9af99e6237852eafc88aef908a62112cc5
+  metadata.gz: ac3936d7fd6a4958b693caf93869747a2d927496
+  data.tar.gz: e8df29c37f1cfd3aeadbddb4f4ce4fad1c8f586c
 SHA512:
-  metadata.gz: 1b7b00c7d34488f154b8c538848ced376b323a11fdcc67605be3dd0127caca40c2547593c356e996e85002eba15f171b530017d994d5e0b543835847586adfb0
-  data.tar.gz: 7a6008b740b07b80e4bac4696a2c9aaf877541c30017e828f6d604f35a8714cb6d58b63a9963f650c8cffd1c9f3deb569884baba2d1a8eb13cb2cee04b02c573
+  metadata.gz: f26b1caad5c340a21d98bf55e12c715c8f55f46a3fa7fe52eda63403753f8ceaf7c77de4befaa44fa9fac7585a4005de0ac9c3d2cd5b61940e745a1aac032cec
+  data.tar.gz: 8aa8dbfffd91ee8c5674b723d4ed88e9b7d4f8a63c2df89634c3129b9b2cf059deb1d6b5a149d3d1a3010bf366edcdfec63ebfb4d583fbb1a29771907ce6e84c

data/README.md

@@ -0,0 +1,190 @@
+mongoid_flaggable [![Gem Version](https://badge.fury.io/rb/mongoid_flaggable.png)](http://badge.fury.io/rb/mongoid_flaggable) [![Code Climate](https://codeclimate.com/github/mchail/mongoid_flaggable.png)](https://codeclimate.com/github/mchail/mongoid_flaggable) [![Build Status](https://travis-ci.org/mchail/mongoid_flaggable.png?branch=master)](https://travis-ci.org/mchail/mongoid_flaggable)
+==============
+
+mongoid_flaggable is a lightweight and powerful way to add flags/tags (boolean values) to your mongoid models.
+
+# Installation
+
+Install directly from rubygems:
+
+```ruby
+gem install mongoid_flaggable
+```
+
+Or if you are using a Gemfile, place this in your Gemfile:
+
+```ruby
+gem 'mongoid_flaggable'
+```
+
+# Use cases
+
+This gem was created to give developers an easy way to flag mongoid models with boolean values. Flags are well-suited for temporary boolean values that do not merit the overhead of an additional field on the model and in the database. This includes gradual feature rollouts (whitelisting certain users for experimental features) and temporary metadata useful for analytics. Flags are *not* well-suited for data you intend to persist on your documents long-term.
+
+# Configure a model to be flaggable
+
+One line of code is needed to set up a model with mongoid_flaggable.
+
+```ruby
+class Book
+    include Mongoid::Document
+    include Mongoid::Flaggable         # it's this one
+end
+```
+
+Be sure to run `rake db:mongoid:create_indexes` after adding mongoid_flaggable to a model. This will create an index on the `flag_array` field it makes use of.
+
+# Basic usage
+
+```ruby
+book = Book.create
+book.flags                             #=> []
+book.add_flag!(:out_of_print)
+book.flags                             #=> ["out_of_print"]
+book.flag?(:out_of_print)              #=> true
+book.flag?(:florinese_translation)     #=> false
+book.remove_flag!(:out_of_print)
+book.flags                             #=> []
+```
+
+# API
+
+- All methods accept `"strings"` or `:symbols`. The arguments are cast to strings before being used.
+- Methods that end in a `!` will immediately write to the database. Methods without the bang will make updates in memory (if the intention of the method is to update data), but will not persist the changes (i.e. after calling `book.add_flag(:out_of_print)`, you must call `book.save` to persist the new flag).
+
+### Instance Methods
+
+Add a flag to a specific model **without saving**
+
+```ruby
+book.add_flag(:out_of_print)
+```
+
+Add a flag to a specific model **and save immediately**
+
+```ruby
+book.add_flag!(:out_of_print)
+```
+
+Remove a flag from a specific model **without saving**
+
+```ruby
+book.remove_flag(:out_of_print)
+```
+
+Remove a flag from a specific model **and save immediately**
+
+```ruby
+book.remove_flag!(:out_of_print)
+```
+
+Clear all flags from a specific model **without saving**
+
+```ruby
+book.clear_flags
+```
+
+Clear all flags from a specific model **and save immediately**
+
+```ruby
+book.clear_flags!
+```
+
+Get array of flags from a model - guaranteed to return an array or zero or more strings
+
+```ruby
+book.flags   # => ["out_of_print"]
+```
+
+Test for the presence of a flag
+
+```ruby
+book.flag?(:out_of_print)
+```
+
+Test for the presence of **any** of multiple flags
+
+```ruby
+book.any_flags?(:out_of_print, :florinese_translation)
+```
+
+Test for the presence of **all** of multiple flags
+
+```ruby
+book.all_flags?(:out_of_print, :florinese_translation)
+```
+
+### Class Methods
+
+- All finders return a `Mongoid::Criteria` that may be chained with additional clauses (e.g. `where`, `limit`, `skip`, `order_by`, etc.)
+
+Retrieve documents with a given flag
+
+```ruby
+Book.by_flag(:out_of_print)
+```
+
+Retrieve documents with **any** of multiple flags
+
+```ruby
+Book.by_any_flags(:out_of_print, :florinese_translation)
+```
+
+Retrieve documents with **all** of multiple flags
+
+```ruby
+Book.by_all_flags(:out_of_print, :florinese_translation)
+```
+
+Get the number of documents with a given flag
+
+```ruby
+Book.flag_count(:out_of_print)
+```
+
+Get the number of documents with **all** of multiple flags
+
+```ruby
+Book.flag_count(:out_of_print, :florinese_translation)
+```
+
+Get an array of all the distinct flags in use on the collection
+
+```ruby
+Book.distinct_flags
+```
+
+Add a flag to multiple documents matching given criteria
+
+```ruby
+Book.bulk_add_flag!(:out_of_print, {:last_printed_at.lt => 20.years.ago})
+```
+	
+Remove a flag from multiple documents matching given criteria
+
+```ruby
+Book.bulk_remove_flag!(:out_of_print, {author_name: "William Goldman"})
+```
+
+Remove a flag from all documents
+
+```ruby
+Book.bulk_remove_flag!(:out_of_print)
+```
+
+Get a sorted frequency hash of all flags used on a collection
+
+```ruby
+Book.flag_frequency           #=> {"out_of_print" => 20, "florinese_translation" => 5}
+```
+
+# Contributing
+
+1. Fork it
+2. Make your changes
+3. Write/update tests. Run with `rake`.
+4. Issue a Pull Request
+
+# License
+
+MIT. Go nuts.

data/lib/mongoid_flaggable/instance_methods.rb

@@ -8,7 +8,8 @@ module Mongoid
 			end
 
 			def add_flag!(flag)
-				add_to_set(:flag_array, flag.to_s)
+				add_flag(flag)
+				save
 			end
 
 			def remove_flag(flag)
@@ -17,7 +18,8 @@ module Mongoid
 			end
 
 			def remove_flag!(flag)
-				pull(:flag_array, flag.to_s)
+				remove_flag(flag)
+				save
 			end
 
 			def clear_flags

data/lib/mongoid_flaggable/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
 	module Flaggable
-		VERSION = "0.0.1"
+		VERSION = "0.0.2"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_flaggable
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Steve McHail
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-31 00:00:00.000000000 Z
+date: 2014-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid