mongoid_taggable_with_context 0.8.2 → 1.0.0

data/.travis.yml

@@ -1,6 +1,8 @@
 language: ruby
 rvm:
-  - 1.8.7
-  - 1.9.2
+  #- 1.8.7
+  #- 1.9.2
   - 1.9.3
-  - rbx-18mode
+  #- rbx-18mode
+
+services: mongodb

data/README.md

@@ -1,7 +1,7 @@
 mongoid_taggable_with_context
 =============================
 
-[![Build Status](https://secure.travis-ci.org/aq1018/mongoid_taggable_with_context.png?branch=master)](http://travis-ci.org/aq1018/mongoid_taggable_with_context) [![Dependency Status](https://gemnasium.com/aq1018/mongoid_taggable_with_context.png?travis)](https://gemnasium.com/aq1018/mongoid_taggable_with_context)
+[![Build Status](https://secure.travis-ci.org/lgs/mongoid_taggable_with_context.png?branch=master)](http://travis-ci.org/lgs/mongoid_taggable_with_context) [![Dependency Status](https://gemnasium.com/lgs/mongoid_taggable_with_context.png?travis)](https://gemnasium.com/lgs/mongoid_taggable_with_context)
 
 A tagging lib for Mongoid that allows for custom tagging along dynamic contexts. This gem was originally based on [mongoid_taggable](https://github.com/ches/mongoid_taggable) by Wilker Lúcio and Ches Martin. It has evolved substantially since that point, but all credit goes to them for the initial tagging functionality.
 
@@ -42,23 +42,22 @@ class Post
   field :content
 
   # default context is 'tags'.
-  # This creates #tags, #tags=, #tags_array, #tags_array= instance methods
+  # This creates #tags, #tags=, #tags_string instance methods
   # separator is " " by default
-  # #tags method returns space separated string
-  # #tags= methods accepts space separated string
-  # #tags_array method returns an array of tags
-  # #tags_array= method accepts an array of tags
-  # #tags and #tags_array are automatically synched.
+  # #tags method returns an array of tags
+  # #tags= methods accepts an array of tags or a separated string
+  # #tags_string method returns a separated string
   taggable
 
   # tagging for 'interests' context.
-  # This creates #interests, #interests=, #interests_array, #interests_array= instance methods
-  taggable :interests
+  # 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=, #skills_array, #skills_array= instance methods
+  # This creates #skills, #skills=, #my_skill_list instance methods
   # changing tag separator to "," (Default is " ")
-  taggable :skills, :separator => ','
+  taggable :skills, :separator => ',', :string_method => :my_skill_list
 end
 ```
 
@@ -118,7 +117,7 @@ class Post
   field :content
 
   taggable
-  taggable :interests
+  taggable :interests, :field => :interest_array
   taggable :skills, :separator => ','
 end
 ```

data/VERSION

@@ -1 +1 @@
-0.8.2
+1.0.0

data/lib/mongoid/taggable_with_context.rb

@@ -7,9 +7,9 @@ module Mongoid::TaggableWithContext
 
   included do
     class_attribute :taggable_with_context_options
-    class_attribute :context_array_to_context_hash
+    class_attribute :database_field_to_context_hash
     self.taggable_with_context_options = {}
-    self.context_array_to_context_hash = {}
+    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'
@@ -17,8 +17,8 @@ module Mongoid::TaggableWithContext
     delegate "format_tags_for_write",         :to => 'self.class'
     delegate "tag_contexts",                  :to => 'self.class'
     delegate "tag_options_for",               :to => 'self.class'
-    delegate "tag_array_attributes",          :to => 'self.class'
-    delegate "context_array_to_context_hash", :to => 'self.class'
+    delegate "tag_database_fields",           :to => 'self.class'
+    delegate "database_field_to_context_hash", :to => 'self.class'
   end
 
   module ClassMethods
@@ -46,60 +46,58 @@ module Mongoid::TaggableWithContext
     def taggable(*args)
       # init variables
       options = args.extract_options!
-      tags_field = (args.blank? ? :tags : args.shift).to_sym
+      tags_name = (args.blank? ? :tags : args.shift).to_sym
       options.reverse_merge!(
         :separator => TAGGABLE_DEFAULT_SEPARATOR,
-        :array_field => "#{tags_field}_array".to_sym
+        :string_method => "#{tags_name}_string".to_sym,
+        :field => tags_name
       )
-      tags_array_field = options[:array_field]
+      database_field = options[:field]
 
       # register / update settings
-      self.taggable_with_context_options[tags_field] = options
-      self.context_array_to_context_hash[options[:array_field]] = tags_field 
+      self.taggable_with_context_options[tags_name] = options
+      self.database_field_to_context_hash[database_field] = tags_name
 
       # setup fields & indexes
-      field tags_array_field, :type => Array, :default => options[:default]
-      # deprecated: index tags_array_field
-      # Invalid index specification on Category: tags_array, {}
+      field tags_name, :type => Array, :default => options[:default]
 
-      index({ tags_array_field => 1 }, { background: true })
+      index({ database_field => 1 }, { background: true })
 
       # singleton methods
       class_eval <<-END
         class << self
           # retrieve all tags ever created for the model
-          def #{tags_field}
-            tags_for(:"#{tags_field}")
+          def #{tags_name}
+            tags_for(:"#{tags_name}")
           end
 
           # retrieve all tags ever created for the model with weights
-          def #{tags_field}_with_weight
-            tags_with_weight_for(:"#{tags_field}")
+          def #{tags_name}_with_weight
+            tags_with_weight_for(:"#{tags_name}")
           end
 
-          def #{tags_field}_separator
-            get_tag_separator_for(:"#{tags_field}")
+          def #{tags_name}_separator
+            get_tag_separator_for(:"#{tags_name}")
           end
 
-          def #{tags_field}_separator=(value)
-            set_tag_separator_for(:"#{tags_field}", value)
+          def #{tags_name}_separator=(value)
+            set_tag_separator_for(:"#{tags_name}", value)
           end
 
-          def #{tags_field}_tagged_with(tags)
-            tagged_with(:"#{tags_field}", tags)
+          def #{tags_name}_tagged_with(tags)
+            tagged_with(:"#{tags_name}", tags)
           end
         end
       END
 
       # instance methods
       class_eval <<-END
-        def #{tags_field}
-          convert_array_to_string(#{tags_array_field}, get_tag_separator_for(:"#{tags_field}"))
+        def #{options[:string_method]}
+          convert_array_to_string(#{database_field}, get_tag_separator_for(:"#{tags_name}"))
         end
-        def #{tags_field}=(value)
-          write_attribute(:#{tags_array_field}, format_tags_for_write(value, get_tag_separator_for(:"#{tags_field}")))
+        def #{tags_name}=(value)
+          write_attribute(:#{database_field}, format_tags_for_write(value, get_tag_separator_for(:"#{tags_name}")))
         end
-        alias_method :#{tags_array_field}=, :#{tags_field}=
       END
     end
 
@@ -107,9 +105,9 @@ module Mongoid::TaggableWithContext
       self.taggable_with_context_options.keys
     end
     
-    def tag_array_attributes
+    def tag_database_fields
       self.taggable_with_context_options.keys.map do |context|
-        tag_options_for(context)[:array_field]
+        tag_options_for(context)[:field]
       end
     end
 
@@ -146,8 +144,8 @@ module Mongoid::TaggableWithContext
     # @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
-      array_field = tag_options_for(context)[:array_field]
-      all_in(array_field => tags)
+      database_field = tag_options_for(context)[:field]
+      all_in(database_field => tags)
     end
 
     # Helper method to convert a a tag input value of unknown type

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

@@ -33,7 +33,7 @@ module Mongoid::TaggableWithContext::AggregationStrategy
     protected
 
     def changed_tag_arrays
-      tag_array_attributes & changes.keys.map(&:to_sym)
+      tag_database_fields & changes.keys.map(&:to_sym)
     end
     
     def tags_changed?
@@ -47,7 +47,7 @@ module Mongoid::TaggableWithContext::AggregationStrategy
     end
     
     def map_reduce_context!(context)
-      field = tag_options_for(context)[:array_field]
+      field = tag_options_for(context)[:field]
 
       map = <<-END
         function() {

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

@@ -75,8 +75,8 @@ module Mongoid::TaggableWithContext::AggregationStrategy
       {self.class.tag_name_attribute.to_sym => tag}
     end
     
-    def update_tags_aggregation(context_array_field, old_tags=[], new_tags=[])
-      context = context_array_to_context_hash[context_array_field]
+    def update_tags_aggregation(database_field, old_tags=[], new_tags=[])
+      context = database_field_to_context_hash[database_field]
       coll = self.class.aggregation_database_collection_for(context)
 
       old_tags ||= []
@@ -98,19 +98,19 @@ module Mongoid::TaggableWithContext::AggregationStrategy
     
     def update_tags_aggregations_on_save
       indifferent_changes = HashWithIndifferentAccess.new changes
-      tag_array_attributes.each do |context_array|
-        next if indifferent_changes[context_array].nil?
+      tag_database_fields.each do |field|
+        next if indifferent_changes[field].nil?
 
-        old_tags, new_tags = indifferent_changes[context_array]
-        update_tags_aggregation(context_array, old_tags, new_tags)
+        old_tags, new_tags = indifferent_changes[field]
+        update_tags_aggregation(field, old_tags, new_tags)
       end
     end
     
     def update_tags_aggregations_on_destroy
-      tag_array_attributes.each do |context_array|
-        old_tags = send context_array
+      tag_database_fields.each do |field|
+        old_tags = send field
         new_tags = []
-        update_tags_aggregation(context_array, old_tags, new_tags)
+        update_tags_aggregation(field, old_tags, new_tags)
       end      
     end
   end

data/mongoid_taggable_with_context.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "mongoid_taggable_with_context"
-  s.version = "0.8.2"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Qian"]

data/spec/mongoid_taggable_with_context_spec.rb

@@ -44,11 +44,11 @@ describe Mongoid::TaggableWithContext do
     end
 
     it "should be nil for artists" do
-      @m.changes['artists'].should be_nil
+      @m.artists.should eql nil
     end
 
     it "should be array for albums" do
-      @m.changes['albums_array'].should eql([nil, []])
+      @m.albums.should eql []
     end
   end
 
@@ -57,44 +57,44 @@ describe Mongoid::TaggableWithContext do
       @m = MyModel.new
     end
 
-    it "should set tags array from string" do
+    it "should set tags from string" do
       @m.tags = "some new tag"
-      @m.tags_array.should == %w[some new tag]
+      @m.tags.should == %w[some new tag]
     end
     
-    it "should set artists array from string" do
+    it "should set artists tags from string" do
       @m.artists = "some new tag"
-      @m.artists_array.should == %w[some new tag]
+      @m.artists.should == %w[some new tag]
     end
 
-    it "should retrieve tags string from array" do
-      @m.tags_array = %w[some new tags]
-      @m.tags.should == "some new tags"
+    it "should retrieve tags string" do
+      @m.tags = %w[some new tags]
+      @m.tags_string.should == "some new tags"
     end
     
-    it "should retrieve artists string from array" do
-      @m.artists_array = %w[some new tags]
-      @m.artists.should == "some new tags"
+    it "should retrieve artists string" do
+      @m.artists = %w[some new tags]
+      @m.artists_string.should == "some new tags"
     end
 
     it "should strip tags before put in array" do
       @m.tags = "now   with   some spaces   in places "
-      @m.tags_array.should == %w[now with some spaces in places]
+      @m.tags.should == %w[now with some spaces in places]
     end
     
     it "should remove repeated tags from string" do
       @m.tags = "some new tags some new tags"
-      @m.tags_array.should == %w[some new tags]
+      @m.tags.should == %w[some new tags]
     end
     
     it "should remove repeated tags from array" do
       @m.tags = %w[some new tags some new tags]
-      @m.tags.should == "some new tags"
+      @m.tags.should == %w[some new tags]
     end
     
     it "should remove nil tags from array" do
       @m.tags = ["some", nil, "new", nil, "tags"]
-      @m.tags.should == "some new tags"
+      @m.tags.should == %w[some new tags]
     end
   end
 
@@ -105,28 +105,17 @@ describe Mongoid::TaggableWithContext do
     
     it "should remove repeated tags from array" do
       @m.tags = %w[some new tags some new tags]
-      @m.tags_array.should == %w[some new tags]
+      @m.tags.should == %w[some new tags]
     end
     
     it "should remove nil tags from array" do
       @m.tags = ["some", nil, "new", nil, "tags"]
-      @m.tags_array.should == %w[some new tags]
+      @m.tags.should == %w[some new tags]
     end
 
     it "should remove empty strings from array" do
       @m.tags = ["some", "", "new", "", "tags"]
-      @m.tags_array.should == %w[some new tags]
-    end
-  end
-
-  context "saving tags from array using tags_array alias method" do
-    before :each do
-      @m = MyModel.new
-    end
-
-    it "should remove nil tags from array" do
-      @m.tags_array = ["some", nil, "new", nil, "tags"]
-      @m.tags_array.should == %w[some new tags]
+      @m.tags.should == %w[some new tags]
     end
   end
 
@@ -145,12 +134,12 @@ describe Mongoid::TaggableWithContext do
 
     it "should split with custom separator" do
       @m.tags = "some;other;separator"
-      @m.tags_array.should == %w[some other separator]
+      @m.tags.should == %w[some other separator]
     end
 
-    it "should join with custom separator" do
-      @m.tags_array = %w[some other sep]
-      @m.tags.should == "some;other;sep"
+    it "should join string with custom separator" do
+      @m.tags = %w[some other sep]
+      @m.tags_string.should == "some;other;sep"
     end
   end
   
@@ -277,10 +266,10 @@ describe Mongoid::TaggableWithContext do
           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_array = m1.tags_array + %w[honey strip shoe]
+          m1.tags = m1.tags + %w[honey strip shoe]
           m1.save!
           
-          m3.artists_array = m3.artists_array + %w[grant greg gory]
+          m3.artists = m3.artists + %w[grant greg gory]
           m3.save!
         end
       
@@ -320,10 +309,10 @@ describe Mongoid::TaggableWithContext do
           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_array = m1.tags_array + %w[honey strip shoe] - %w[food]
+          m1.tags = m1.tags + %w[honey strip shoe] - %w[food]
           m1.save!
           
-          m3.artists_array = m3.artists_array + %w[grant greg gory] - %w[andy]
+          m3.artists = m3.artists + %w[grant greg gory] - %w[andy]
           m3.save!
           
           m2.destroy

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_taggable_with_context
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors: