mongoid_taggable_with_context 1.0.1 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 44ee2f3be92cc68b84183d7f2a192da8e71421c2
+  data.tar.gz: ec2e8f34ce303a3713d8fdda04bc1f3a61c33181
+SHA512:
+  metadata.gz: 8b62f2358559426336e8bdc989ef7230b54483a50f128a4634afe9126325ea0f51c3de56bb940dcfc48fbeca083b21952c9652566b5d2b20a40288a19218a12f
+  data.tar.gz: 1ae4c6c1ff1bb80011a61275d9f9945b7564a7d2270570ee86bbf9007a457ca56d52f66ee2be7b707cfb74e3a428c3aeb82245545c3966a11b8a9fb4f8f45901

data/README.md

@@ -28,10 +28,51 @@ or in Gemfile:
 gem 'mongoid_taggable_with_context'
 ```
 
-Basic Usage
------------
 
-To make a document taggable you need to include Mongoid::TaggableOnContext into your document and call the *taggable* macro with optional arguments:
+The "taggable" Macro Function
+-----------------------------
+
+Use the `taggable` macro function in your model to
+declare a tags field. Specify `field name`
+for tags, and `options` for tagging behavior.
+
+Example:
+
+   ```ruby
+   class Article
+     include Mongoid::Document
+     include Mongoid::TaggableWithContext
+     taggable :keywords, separator: ' ', default: ['foobar']
+   end
+   ```
+
+* `@param [ Symbol ] field`
+
+   (Optional) The name of the field for tags. Defaults to "tags"
+
+
+* `@param [ Hash ] options`
+
+   (Optional) Options for taggable behavior.
+
+
+    * `@option [ String ] :separator`
+
+        The delimiter used when converting the tags to and from String format. Defaults to " "
+
+
+    * `@option [ <various> ] :default, :as, :localize, etc.`
+
+        Options for Mongoid #field method will be automatically passed
+        to the underlying Array field (with the exception of `:type`,
+        which is coerced to `Array`).
+
+
+Example Usage
+-------------
+
+To make a document taggable you need to include Mongoid::TaggableOnContext
+into your document and call the *taggable* macro with optional arguments:
 
 ```ruby
 class Post
@@ -49,15 +90,15 @@ class Post
   # #tags_string method returns a separated string
   taggable
 
-  # tagging for 'interests' context.
-  # This creates #interests, #interests=, #interests_string instance methods
-  # The tags will be persisted in a database field called 'interest_array'
-  taggable :interests, :field => :interest_array
-
   # tagging for 'skills' context.
-  # This creates #skills, #skills=, #my_skill_list instance methods
+  # This creates #skills, #skills=, #skills_string instance methods
   # changing tag separator to "," (Default is " ")
-  taggable :skills, :separator => ',', :string_method => :my_skill_list
+  taggable :skills, separator: ','
+
+  # aliased context tagging.
+  # This creates #interests, #interests=, #interests_string instance methods
+  # The tags will be stored in a database field called 'ints'
+  taggable :ints, as: :interests
 end
 ```
 
@@ -91,6 +132,7 @@ Then in your form, for example:
 <% end %>
 ```
 
+
 Aggregation Strategies
 ----------------------
 
@@ -117,8 +159,8 @@ class Post
   field :content
 
   taggable
-  taggable :interests, :field => :interest_array
-  taggable :skills, :separator => ','
+  taggable :skills, separator: ','
+  taggable :ints, as: interests
 end
 ```
 
@@ -137,9 +179,9 @@ Post.skills_with_weight
 Here is how to use these methods in more detail:
 
 ```ruby
-Post.create!(:tags => "food,ant,bee")
-Post.create!(:tags => "juice,food,bee,zip")
-Post.create!(:tags => "honey,strip,food")
+Post.create!(tags: "food,ant,bee")
+Post.create!(tags: "juice,food,bee,zip")
+Post.create!(tags: "honey,strip,food")
 
 Post.tags # will retrieve ["ant", "bee", "food", "honey", "juice", "strip", "zip"]
 Post.tags_with_weight # will retrieve:
@@ -154,22 +196,6 @@ Post.tags_with_weight # will retrieve:
 # ]
 ```
 
-Changing default separator
---------------------------
-
-To change the default separator you may pass a *separator* argument to the macro:
-
-```ruby
-class Post
-  include Mongoid::Document
-  include Mongoid::TaggableWithContext
-
-  field :title
-  field :content
-
-  taggable :separator => ','    # tags will be delineated by comma instead of space
-end
-```
 
 Contributing to mongoid_taggable_with_context
 -----------------------------------------------
@@ -182,6 +208,7 @@ Contributing to mongoid_taggable_with_context
 * 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. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
+
 Copyright
 ---------
 

data/Rakefile

@@ -1,23 +1,21 @@
 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'
+Bundler.setup
 
+require 'rake'
 require 'jeweler'
+
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require 'mongoid/taggable_with_context/version'
+
 Jeweler::Tasks.new do |gem|
   gem.name = "mongoid_taggable_with_context"
-  gem.homepage = "http://github.com/aq1018/mongoid_taggable_with_context"
+  gem.homepage = "http://github.com/lgs/mongoid_taggable_with_context"
   gem.license = "MIT"
   gem.summary = %Q{Mongoid taggable behaviour}
-  gem.description = %Q{It provides some helpers to create taggable documents with context.}
-  gem.email = "aq1018@gmail.com"
-  gem.authors = ["Aaron Qian"]
+  gem.description = %Q{Add multiple tag fields on Mongoid documents with aggregation capability.}
+  gem.authors = ["Aaron Qian", "Luca G. Soave", "John Shields", "Wilker Lucio", "Ches Martin"]
+  gem.version = Mongoid::TaggableWithContext::VERSION
 end
 Jeweler::RubygemsDotOrgTasks.new
 
@@ -28,7 +26,7 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.rspec_opts = "--color --format progress"
 end
 
-task :default => :spec
+task default: :spec
 
 require 'yard'
 YARD::Rake::YardocTask.new

data/lib/mongoid/taggable_with_context.rb

@@ -2,23 +2,18 @@ module Mongoid::TaggableWithContext
   extend ActiveSupport::Concern
 
   class AggregationStrategyMissing < Exception; end
+  class InvalidTagsFormat < Exception; end
 
-  TAGGABLE_DEFAULT_SEPARATOR = ' '
+  DEFAULT_FIELD = :tags
+  DEFAULT_SEPARATOR = ' '
 
   included do
     class_attribute :taggable_with_context_options
-    class_attribute :database_field_to_context_hash
     self.taggable_with_context_options = {}
-    self.database_field_to_context_hash = {}
-    delegate "convert_string_to_array",       :to => 'self.class'
-    delegate "convert_array_to_string",       :to => 'self.class'
-    delegate "clean_up_array",                :to => 'self.class'
-    delegate "get_tag_separator_for",         :to => 'self.class'
-    delegate "format_tags_for_write",         :to => 'self.class'
-    delegate "tag_contexts",                  :to => 'self.class'
-    delegate "tag_options_for",               :to => 'self.class'
-    delegate "tag_database_fields",           :to => 'self.class'
-    delegate "database_field_to_context_hash", :to => 'self.class'
+  end
+
+  def tags_string_for(context)
+    self.read_attribute(context).join(self.class.get_tag_separator_for(context))
   end
 
   module ClassMethods
@@ -29,85 +24,82 @@ module Mongoid::TaggableWithContext
     #
     #   class Article
     #     include Mongoid::Document
-    #     include Mongoid::Taggable
-    #     taggable :keywords, :separator => ' ', :aggregation => true, :default_type => "seo"
+    #     include Mongoid::TaggableWithContext
+    #     taggable :keywords, separator: ' ', default: ['foobar']
     #   end
     #
     # @param [ Symbol ] field The name of the field for tags.
     # @param [ Hash ] options Options for taggable behavior.
     #
-    # @option options [ String ] :separator The tag separator to
-    #   convert from; defaults to ','
-    # @option options [ true, false ] :aggregation Whether or not to
-    #   aggregate counts of tags within the document collection using
-    #   map/reduce; defaults to false
-    # @option options [ String ] :default_type The default type of the tag.
-    #   Each tag can optionally have a tag type. The default type is nil
+    # @option options [ String ] :separator
+    #   The delimiter used when converting the tags to and from String format. Defaults to ' '
+    # @option options [ <various> ] :default, :as, :localize, etc.
+    #   Options for Mongoid #field method will be automatically passed
+    #   to the underlying Array field
     def taggable(*args)
       # init variables
       options = args.extract_options!
-      tags_name = (args.blank? ? :tags : args.shift).to_sym
-      options.reverse_merge!(
-        :separator => TAGGABLE_DEFAULT_SEPARATOR,
-        :string_method => "#{tags_name}_string".to_sym,
-        :field => tags_name
-      )
-      database_field = options[:field]
+
+      raise 'taggable :field option has been removed as of version 1.1.0. Please use the syntax "taggable <database_name>, as: <tag_name>"' if options[:field]
+      raise 'taggable :string_method option has been removed as of version 1.1.0. Please define an alias to "<tags>_string"' if options[:string_method]
+
+      # db_field: the field name stored in the database
+      options[:db_field] = args.present? ? args.shift.to_sym : DEFAULT_FIELD
+
+      # field: the field name used to identify the tags. :field will
+      # be identical to :db_field unless the :as option is specified
+      options[:field] = options[:as] || options[:db_field]
+
+      options.reverse_merge!(separator: DEFAULT_SEPARATOR)
 
       # register / update settings
-      self.taggable_with_context_options[tags_name] = options
-      self.database_field_to_context_hash[database_field] = tags_name
+      self.taggable_with_context_options[options[:field]] = options
 
       # setup fields & indexes
-      field tags_name, :type => Array, :default => options[:default]
+      field options[:db_field], mongoid_field_options(options)
 
-      index({ database_field => 1 }, { background: true })
+      index({ options[:field] => 1 }, { background: true })
 
       # singleton methods
-      class_eval <<-END
-        class << self
-          # retrieve all tags ever created for the model
-          def #{tags_name}
-            tags_for(:"#{tags_name}")
-          end
-
-          # retrieve all tags ever created for the model with weights
-          def #{tags_name}_with_weight
-            tags_with_weight_for(:"#{tags_name}")
-          end
-
-          def #{tags_name}_separator
-            get_tag_separator_for(:"#{tags_name}")
-          end
-
-          def #{tags_name}_separator=(value)
-            set_tag_separator_for(:"#{tags_name}", value)
-          end
-
-          def #{tags_name}_tagged_with(tags)
-            tagged_with(:"#{tags_name}", tags)
-          end
+      self.class.class_eval do
+        # retrieve all tags ever created for the model
+        define_method options[:field] do
+          tags_for(options[:field])
+        end
+
+        # retrieve all tags ever created for the model with weights
+        define_method :"#{options[:field]}_with_weight" do
+          tags_with_weight_for(options[:field])
+        end
+
+        define_method :"#{options[:field]}_separator" do
+          get_tag_separator_for(options[:field])
+        end
+
+        define_method :"#{options[:field]}_tagged_with" do |tags|
+          tagged_with(options[:field], tags)
         end
-      END
+      end
 
-      # instance methods
-      class_eval <<-END
-        def #{options[:string_method]}
-          convert_array_to_string(#{database_field}, get_tag_separator_for(:"#{tags_name}"))
+      #instance methods
+      class_eval do
+        define_method :"#{options[:field]}_string" do
+          tags_string_for(options[:field])
         end
-        def #{tags_name}=(value)
-          write_attribute(:#{database_field}, format_tags_for_write(value, get_tag_separator_for(:"#{tags_name}")))
+
+        define_method :"#{options[:field]}=" do |value|
+          write_attribute(options[:field], self.class.format_tags_for(options[:field], value))
         end
-      END
+      end
     end
 
     def tag_contexts
       self.taggable_with_context_options.keys
     end
-    
+
     def tag_database_fields
       self.taggable_with_context_options.keys.map do |context|
-        tag_options_for(context)[:field]
+        tag_options_for(context)[:db_field]
       end
     end
 
@@ -127,9 +119,6 @@ module Mongoid::TaggableWithContext
       self.taggable_with_context_options[context][:separator]
     end
 
-    def set_tag_separator_for(context, value)
-      self.taggable_with_context_options[context][:separator] = value.nil? ? TAGGABLE_DEFAULT_SEPARATOR : value.to_s
-    end
 
     # Find documents tagged with all tags passed as a parameter, given
     # as an Array or a String using the configured separator.
@@ -143,39 +132,32 @@ module Mongoid::TaggableWithContext
     # @param [ Array<String, Symbol>, String ] :tags Tags to match.
     # @return [ Criteria ] A new criteria.
     def tagged_with(context, tags)
-      tags = convert_string_to_array(tags, get_tag_separator_for(context)) if tags.is_a? String
-      database_field = tag_options_for(context)[:field]
-      all_in(database_field => tags)
+      tags = format_tags_for(context, tags)
+      field = tag_options_for(context)[:field]
+      all_in(field => tags)
     end
 
     # Helper method to convert a a tag input value of unknown type
     # to a formatted array.
-    def format_tags_for_write(value, separator = TAGGABLE_DEFAULT_SEPARATOR)
-      if value.is_a? Array
-        clean_up_array(value)
-      else
-        convert_string_to_array(value, separator)
-      end
+    def format_tags_for(context, value)
+      # 0) Tags must be an array or a string
+      raise InvalidTagsFormat unless value.is_a?(Array) || value.is_a?(String)
+      # 1) convert String to Array
+      value = value.split(get_tag_separator_for(context)) if value.is_a? String
+      # 2) remove all nil values
+      # 3) strip all white spaces. Could leave blank strings (e.g. foo, , bar, baz)
+      # 4) remove all blank strings
+      # 5) remove duplicate
+      value.compact.map(&:strip).reject(&:blank?).uniq
     end
 
-    # Helper method to convert a String to an Array based on the
-    # configured tag separator.
-    def convert_string_to_array(str = "", separator = TAGGABLE_DEFAULT_SEPARATOR)
-      clean_up_array(str.split(separator))
-    end
+    protected
 
-    def convert_array_to_string(ary = [], separator = TAGGABLE_DEFAULT_SEPARATOR)
-      #ary.join(separator)
-      (ary || []).join(separator)
+    # Prepares valid Mongoid option keys from the taggable options
+    # @param [ Hash ] :options The taggable options hash.
+    # @return [ Hash ] A options hash for the Mongoid #field method.
+    def mongoid_field_options(options = {})
+      options.slice(*::Mongoid::Fields::Validators::Macro::OPTIONS).merge!(type: Array)
     end
-
-    def clean_up_array(ary = [])
-      # 0). remove all nil values
-      # 1). strip all white spaces. Could leave blank strings (e.g. foo, , bar, baz)
-      # 2). remove all blank strings
-      # 3). remove duplicate
-      ary.compact.map(&:strip).reject(&:blank?).uniq
-    end
-
   end
 end

data/lib/mongoid/taggable_with_context/aggregation_strategy/map_reduce.rb

@@ -2,9 +2,9 @@ module Mongoid::TaggableWithContext::AggregationStrategy
   module MapReduce
     extend ActiveSupport::Concern
     included do
-      set_callback :save,     :after, :map_reduce_all_contexts!, :if => :tags_changed?
+      set_callback :save,     :after, :map_reduce_all_contexts!, if: :tags_changed?
       set_callback :destroy,  :after, :map_reduce_all_contexts!
-      delegate :aggregation_collection_for, :to => "self.class"
+      delegate :aggregation_collection_for, to: "self.class"
     end
     
     module ClassMethods
@@ -19,13 +19,13 @@ module Mongoid::TaggableWithContext::AggregationStrategy
       end
 
       def tags_for(context, conditions={})
-        aggregation_database_collection_for(context).find({:value => {"$gt" => 0 }}).sort(_id: 1).to_a.map{ |t| t["_id"] }
+        aggregation_database_collection_for(context).find({value: {"$gt" => 0 }}).sort(_id: 1).to_a.map{ |t| t["_id"] }
       end
 
       # retrieve the list of tag with weight(count), this is useful for
       # creating tag clouds
       def tags_with_weight_for(context, conditions={})
-        aggregation_database_collection_for(context).find({:value => {"$gt" => 0 }}).sort(_id: 1).to_a.map{ |t| [t["_id"], t["value"].to_i] }
+        aggregation_database_collection_for(context).find({value: {"$gt" => 0 }}).sort(_id: 1).to_a.map{ |t| [t["_id"], t["value"].to_i] }
       end
       
     end
@@ -33,7 +33,7 @@ module Mongoid::TaggableWithContext::AggregationStrategy
     protected
 
     def changed_tag_arrays
-      tag_database_fields & changes.keys.map(&:to_sym)
+      self.class.tag_database_fields & changes.keys.map(&:to_sym)
     end
     
     def tags_changed?
@@ -41,19 +41,19 @@ module Mongoid::TaggableWithContext::AggregationStrategy
     end
     
     def map_reduce_all_contexts!
-      tag_contexts.each do |context|
+      self.class.tag_contexts.each do |context|
         map_reduce_context!(context)
       end
     end
     
     def map_reduce_context!(context)
-      field = tag_options_for(context)[:field]
+      db_field = self.class.tag_options_for(context)[:db_field]
 
       map = <<-END
         function() {
-          if (!this.#{field})return;
-          for (index in this.#{field})
-            emit(this.#{field}[index], 1);
+          if (!this.#{db_field})return;
+          for (index in this.#{db_field})
+            emit(this.#{db_field}[index], 1);
         }
       END
 

data/lib/mongoid/taggable_with_context/aggregation_strategy/real_time.rb

@@ -23,13 +23,13 @@ module Mongoid::TaggableWithContext::AggregationStrategy
       end
 
       def tags_for(context, conditions={})
-        aggregation_database_collection_for(context).find({:value => {"$gt" => 0 }}).sort(tag_name_attribute.to_sym => 1).to_a.map{ |t| t[tag_name_attribute] }
+        aggregation_database_collection_for(context).find({value: {"$gt" => 0 }}).sort(tag_name_attribute.to_sym => 1).to_a.map{ |t| t[tag_name_attribute] }
       end
 
       # retrieve the list of tag with weight(count), this is useful for
       # creating tag clouds
       def tags_with_weight_for(context, conditions={})
-        aggregation_database_collection_for(context).find({:value => {"$gt" => 0 }}).sort(tag_name_attribute.to_sym => 1).to_a.map{ |t| [t[tag_name_attribute], t["value"].to_i] }
+        aggregation_database_collection_for(context).find({value: {"$gt" => 0 }}).sort(tag_name_attribute.to_sym => 1).to_a.map{ |t| [t[tag_name_attribute], t["value"].to_i] }
       end
 
       def recalculate_all_context_tag_weights!
@@ -75,8 +75,7 @@ module Mongoid::TaggableWithContext::AggregationStrategy
       {self.class.tag_name_attribute.to_sym => tag}
     end
     
-    def update_tags_aggregation(database_field, old_tags=[], new_tags=[])
-      context = database_field_to_context_hash[database_field]
+    def update_tags_aggregation(context, old_tags=[], new_tags=[])
       coll = self.class.aggregation_database_collection_for(context)
 
       old_tags ||= []
@@ -87,10 +86,10 @@ module Mongoid::TaggableWithContext::AggregationStrategy
 
       
       tags_removed.each do |tag|
-        coll.find(get_conditions(context, tag)).upsert({'$inc' => {:value => -1}})
+        coll.find(get_conditions(context, tag)).upsert({'$inc' => {value: -1}})
       end
       tags_added.each do |tag|
-        coll.find(get_conditions(context, tag)).upsert({'$inc' => {:value => 1}})
+        coll.find(get_conditions(context, tag)).upsert({'$inc' => {value: 1}})
       end
       #coll.find({_id: {"$in" => tags_removed}}).update({'$inc' => {:value => -1}}, [:upsert])
       #coll.find({_id: {"$in" => tags_added}}).update({'$inc' => {:value => 1}}, [:upsert])
@@ -98,7 +97,7 @@ module Mongoid::TaggableWithContext::AggregationStrategy
     
     def update_tags_aggregations_on_save
       indifferent_changes = HashWithIndifferentAccess.new changes
-      tag_database_fields.each do |field|
+      self.class.tag_database_fields.each do |field|
         next if indifferent_changes[field].nil?
 
         old_tags, new_tags = indifferent_changes[field]
@@ -107,7 +106,7 @@ module Mongoid::TaggableWithContext::AggregationStrategy
     end
     
     def update_tags_aggregations_on_destroy
-      tag_database_fields.each do |field|
+      self.class.tag_database_fields.each do |field|
         old_tags = send field
         new_tags = []
         update_tags_aggregation(field, old_tags, new_tags)

data/lib/mongoid/taggable_with_context/group_by/aggregation_strategy/real_time.rb

@@ -35,7 +35,7 @@ module Mongoid::TaggableWithContext::GroupBy::AggregationStrategy
 
       protected
       def query(context, group_by)
-        aggregation_database_collection_for(context).find({:value => {"$gt" => 0 }, :group_by_field => group_by}).sort(tag_name_attribute.to_sym => 1)
+        aggregation_database_collection_for(context).find({value: {"$gt" => 0 }, group_by_field: group_by}).sort(tag_name_attribute.to_sym => 1)
       end
     end
 
@@ -45,7 +45,7 @@ module Mongoid::TaggableWithContext::GroupBy::AggregationStrategy
       conditions = {self.class.tag_name_attribute.to_sym => tag}
       group_by_field = self.class.get_tag_group_by_field_for(context)
       if group_by_field
-        conditions.merge!({:group_by_field => self.send(group_by_field)})
+        conditions.merge!({group_by_field: self.send(group_by_field)})
       end
       conditions
     end

data/lib/mongoid/taggable_with_context/group_by/taggable_with_context.rb

@@ -7,24 +7,23 @@ module Mongoid::TaggableWithContext::GroupBy
       def taggable(*args)
         super(*args)
         args.extract_options!
-        tags_field = (args.blank? ? :tags : args.shift).to_sym
-        self.taggable_with_context_options[tags_field].reverse_merge!(:group_by_field => nil)
+        tags_field = args.present? ? args.shift.to_sym : :tags
+        self.taggable_with_context_options[tags_field].reverse_merge!(group_by_field: nil)
 
-        class_eval <<-END
-          class << self
-            def #{tags_field}(group_by=nil)
-              tags_for(:"#{tags_field}", group_by)
-            end
+        # singleton methods
+        self.class.class_eval do
+          define_method tags_field do |group_by = nil|
+            tags_for(tags_field, group_by)
+          end
 
-            def #{tags_field}_with_weight(group_by=nil)
-              tags_with_weight_for(:"#{tags_field}", group_by)
-            end
+          define_method :"#{tags_field}_with_weight" do |group_by = nil|
+            tags_with_weight_for(tags_field, group_by)
+          end
 
-            def #{tags_field}_group_by_field
-              get_tag_group_by_field_for(:"#{tags_field}")
-            end
+          define_method :"#{tags_field}_group_by_field" do
+            get_tag_group_by_field_for(tags_field)
           end
-        END
+        end
       end
 
       def tags_for(context, group_by, conditions={})

data/lib/mongoid/taggable_with_context/version.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+module Mongoid
+  module TaggableWithContext
+    VERSION = '1.1.0'
+  end
+end

data/lib/mongoid_taggable_with_context.rb

@@ -4,4 +4,5 @@ require File.join(File.dirname(__FILE__), 'mongoid/taggable_with_context')
 require File.join(File.dirname(__FILE__), 'mongoid/taggable_with_context/aggregation_strategy/map_reduce')
 require File.join(File.dirname(__FILE__), 'mongoid/taggable_with_context/aggregation_strategy/real_time')
 require File.join(File.dirname(__FILE__), 'mongoid/taggable_with_context/group_by/taggable_with_context')
-require File.join(File.dirname(__FILE__), 'mongoid/taggable_with_context/group_by/aggregation_strategy/real_time')
+require File.join(File.dirname(__FILE__), 'mongoid/taggable_with_context/group_by/aggregation_strategy/real_time')
+require File.join(File.dirname(__FILE__), 'mongoid/taggable_with_context/version')

data/mongoid_taggable_with_context.gemspec

@@ -1,17 +1,16 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# Instead, edit Jeweler::Tasks in rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = "mongoid_taggable_with_context"
-  s.version = "1.0.1"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Aaron Qian"] #["Johnny Shields", "Steve Chung", "Luca G. Soave", "Aaron Qian"]
-  s.date = "2013-02-18"
-  s.description = "It provides some helpers to create taggable documents with context."
-  s.email = ["aq1018@gmail.com"]
+  s.authors = ["Aaron Qian", "Luca G. Soave", "John Shields", "Wilker Lucio", "Ches Martin"]
+  s.date = "2013-05-18"
+  s.description = "Add multiple tag fields on Mongoid documents with aggregation capability."
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md"
@@ -23,13 +22,13 @@ Gem::Specification.new do |s|
     "LICENSE.txt",
     "README.md",
     "Rakefile",
-    "VERSION",
     "init.rb",
     "lib/mongoid/taggable_with_context.rb",
     "lib/mongoid/taggable_with_context/aggregation_strategy/map_reduce.rb",
     "lib/mongoid/taggable_with_context/aggregation_strategy/real_time.rb",
     "lib/mongoid/taggable_with_context/group_by/aggregation_strategy/real_time.rb",
     "lib/mongoid/taggable_with_context/group_by/taggable_with_context.rb",
+    "lib/mongoid/taggable_with_context/version.rb",
     "lib/mongoid_taggable_with_context.rb",
     "mongoid_taggable_with_context.gemspec",
     "spec/mongoid_taggable_with_context_spec.rb",
@@ -40,10 +39,6 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.rubygems_version = "1.8.24"
   s.summary = "Mongoid taggable behaviour"
-  s.test_files = [
-    "spec/mongoid_taggable_with_context_spec.rb",
-    "spec/spec_helper.rb"
-  ]
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/spec/mongoid_taggable_with_context_spec.rb

@@ -6,7 +6,7 @@ class MyModel
     
   taggable
   taggable :artists
-  taggable :albums, :default => []
+  taggable :albums, default: []
 end
 
 class M1
@@ -15,7 +15,7 @@ class M1
   include Mongoid::TaggableWithContext::AggregationStrategy::MapReduce
   
   taggable
-  taggable :artists
+  taggable :a, as: :artists
 end
 
 class M2
@@ -32,8 +32,8 @@ class M3
   include Mongoid::TaggableWithContext::GroupBy::AggregationStrategy::RealTime
 
   field :user
-  taggable :group_by_field => :user
-  taggable :artists, :group_by_field => :user
+  taggable group_by_field: :user
+  taggable :artists, group_by_field: :user
 end
 
 describe Mongoid::TaggableWithContext do
@@ -119,35 +119,11 @@ describe Mongoid::TaggableWithContext do
     end
   end
 
-  context "changing separator" do
-    before :all do
-      MyModel.tags_separator = ";"
-    end
-
-    after :all do
-      MyModel.tags_separator = " "
-    end
-
-    before :each do
-      @m = MyModel.new
-    end
-
-    it "should split with custom separator" do
-      @m.tags = "some;other;separator"
-      @m.tags.should == %w[some other separator]
-    end
-
-    it "should join string with custom separator" do
-      @m.tags = %w[some other sep]
-      @m.tags_string.should == "some;other;sep"
-    end
-  end
-  
   context "tagged_with" do
     before :each do
-      @m1 = MyModel.create!(:tags => "food ant bee", :artists => "jeff greg mandy aaron andy")
-      @m2 = MyModel.create!(:tags => "juice food bee zip", :artists => "grant andrew andy")
-      @m3 = MyModel.create!(:tags => "honey strip food", :artists => "mandy aaron andy")
+      @m1 = MyModel.create!(tags: "food ant bee", artists: "jeff greg mandy aaron andy")
+      @m2 = MyModel.create!(tags: "juice food bee zip", artists: "grant andrew andy")
+      @m3 = MyModel.create!(tags: "honey strip food", artists: "mandy aaron andy")
     end
     
     it "should retrieve a list of documents" do
@@ -181,9 +157,9 @@ describe Mongoid::TaggableWithContext do
 
       context "on create directly" do
         before :each do
-          klass.create!(:user => "user1", :tags => "food ant bee", :artists => "jeff greg mandy aaron andy")
-          klass.create!(:user => "user1", :tags => "juice food bee zip", :artists => "grant andrew andy")
-          klass.create!(:user => "user2", :tags => "honey strip food", :artists => "mandy aaron andy")
+          klass.create!(user: "user1", tags: "food ant bee", artists: "jeff greg mandy aaron andy")
+          klass.create!(user: "user1", tags: "juice food bee zip", artists: "grant andrew andy")
+          klass.create!(user: "user2", tags: "honey strip food", artists: "mandy aaron andy")
         end
       
         it "should retrieve the list of all saved tags distinct and ordered" do
@@ -262,9 +238,9 @@ describe Mongoid::TaggableWithContext do
       
       context "on create then update" do
         before :each do
-          m1 = klass.create!(:user => "user1", :tags => "food ant bee", :artists => "jeff greg mandy aaron andy")
-          m2 = klass.create!(:user => "user1", :tags => "juice food bee zip", :artists => "grant andrew andy")
-          m3 = klass.create!(:user => "user2", :tags => "honey strip food", :artists => "mandy aaron andy")
+          m1 = klass.create!(user: "user1", tags: "food ant bee", artists: "jeff greg mandy aaron andy")
+          m2 = klass.create!(user: "user1", tags: "juice food bee zip", artists: "grant andrew andy")
+          m3 = klass.create!(user: "user2", tags: "honey strip food", artists: "mandy aaron andy")
           
           m1.tags = m1.tags + %w[honey strip shoe]
           m1.save!
@@ -305,9 +281,9 @@ describe Mongoid::TaggableWithContext do
 
       context "on create, update, then destroy" do
         before :each do
-          m1 = klass.create!(:user => "user1", :tags => "food ant bee", :artists => "jeff greg mandy aaron andy")
-          m2 = klass.create!(:user => "user1", :tags => "juice food bee zip", :artists => "grant andrew andy")
-          m3 = klass.create!(:user => "user2", :tags => "honey strip food", :artists => "mandy aaron andy")
+          m1 = klass.create!(user: "user1", tags: "food ant bee", artists: "jeff greg mandy aaron andy")
+          m2 = klass.create!(user: "user1", tags: "juice food bee zip", artists: "grant andrew andy")
+          m3 = klass.create!(user: "user2", tags: "honey strip food", artists: "mandy aaron andy")
           
           m1.tags = m1.tags + %w[honey strip shoe] - %w[food]
           m1.save!
@@ -377,6 +353,10 @@ describe Mongoid::TaggableWithContext do
     let(:klass) { M3 }
     it_should_behave_like "aggregation"
 
+    it "should have artists_group_by_field value :user" do
+      klass.artists_group_by_field.should == :user
+    end
+
     it "should generate the tags aggregation collection name correctly" do
       klass.aggregation_collection_for(:tags).should == "m3s_tags_aggregation"
     end
@@ -387,9 +367,9 @@ describe Mongoid::TaggableWithContext do
 
     context "for groupings" do
       before :each do
-        klass.create!(:user => "user1", :tags => "food ant bee", :artists => "jeff greg mandy aaron andy")
-        klass.create!(:user => "user1", :tags => "juice food bee zip", :artists => "grant andrew andy")
-        klass.create!(:user => "user2", :tags => "honey strip food", :artists => "mandy aaron andy")
+        klass.create!(user: "user1", tags: "food ant bee", artists: "jeff greg mandy aaron andy")
+        klass.create!(user: "user1", tags: "juice food bee zip", artists: "grant andrew andy")
+        klass.create!(user: "user2", tags: "honey strip food", artists: "mandy aaron andy")
       end
 
       it "should retrieve the list of all saved tags distinct and ordered" do
@@ -433,4 +413,25 @@ describe Mongoid::TaggableWithContext do
       end
     end
   end
+
+  context "removed options" do
+    it "should throw error if :field option is specified" do
+      expect do
+        class Invalid
+          include Mongoid::Document
+          include Mongoid::TaggableWithContext
+          taggable field: :foobar
+        end
+      end.to raise_error
+    end
+    it "should throw error if :string_method option is specified" do
+      expect do
+        class Invalid
+          include Mongoid::Document
+          include Mongoid::TaggableWithContext
+          taggable string_method: :foobar
+        end
+      end.to raise_error
+    end
+  end
 end

metadata

@@ -1,115 +1,105 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_taggable_with_context
 version: !ruby/object:Gem::Version
-  version: 1.0.1
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Aaron Qian
+- Luca G. Soave
+- John Shields
+- Wilker Lucio
+- Ches Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-18 00:00:00.000000000 Z
+date: 2013-05-18 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.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: It provides some helpers to create taggable documents with context.
-email:
-- aq1018@gmail.com
+description: Add multiple tag fields on Mongoid documents with aggregation capability.
+email: 
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -122,13 +112,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- VERSION
 - init.rb
 - lib/mongoid/taggable_with_context.rb
 - lib/mongoid/taggable_with_context/aggregation_strategy/map_reduce.rb
 - lib/mongoid/taggable_with_context/aggregation_strategy/real_time.rb
 - lib/mongoid/taggable_with_context/group_by/aggregation_strategy/real_time.rb
 - lib/mongoid/taggable_with_context/group_by/taggable_with_context.rb
+- lib/mongoid/taggable_with_context/version.rb
 - lib/mongoid_taggable_with_context.rb
 - mongoid_taggable_with_context.gemspec
 - spec/mongoid_taggable_with_context_spec.rb
@@ -136,29 +126,26 @@ files:
 homepage: http://github.com/lgs/mongoid_taggable_with_context
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 3
 summary: Mongoid taggable behaviour
-test_files:
-- spec/mongoid_taggable_with_context_spec.rb
-- spec/spec_helper.rb
+test_files: []
 has_rdoc: 

data/VERSION

@@ -1 +0,0 @@
-1.0.0