mongoid_taggable_with_context 0.8.0 → 0.8.1

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - rbx-18mode

data/Gemfile

@@ -12,8 +12,5 @@ group :development do
   gem 'yard'
   gem 'bundler', '>= 1.0.0'
   gem 'jeweler'
-  gem 'rcov'
-  gem 'reek'
-  gem 'roodi'
 end
 

data/README.md

@@ -0,0 +1,190 @@
+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)
+
+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.
+
+For instance, in a social network, a user might have tags that are called skills, interests, sports, and more. There is no real way to differentiate between tags and so an implementation of this type is not possible with `mongoid_taggable`.
+
+Another example, aggregation such as counting tag occurrences was achieved by map-reduce with `mongoid_taggable`. It was ok for small amount of tags, but when the amount of tags and documents grow, the original `mongoid_taggable` won't be able to scale to real-time statistics demand.
+
+Enter `mongoid_taggable_with_context`. Rather than tying functionality to a specific keyword (namely "tags"), `mongoid_taggable_with_context` allows you to specify an arbitrary number of *tag contexts* that can be used locally or in combination in the same way `mongoid_taggable` was used.
+
+`mongoid_taggable_with_context` also provides flexibility on aggregation strategy. In addition to the map-reduce strategy, this gem also comes with real-time strategy. By using real-time strategy, your document can quickly adjusts the aggregation collection whenever tags are inserted or removed with $inc operator. So performance won't be impacted as the number of tags and documents grow.
+
+Installation
+------------
+
+You can simply install from rubygems:
+
+```
+gem install mongoid_taggable_with_context
+```
+
+or in Gemfile:
+
+```ruby
+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:
+
+```ruby
+class Post
+  include Mongoid::Document
+  include Mongoid::TaggableWithContext
+
+  field :title
+  field :content
+
+  # default context is 'tags'.
+  # This creates #tags, #tags=, #tags_array, #tags_array= 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.
+  taggable
+
+  # tagging for 'interests' context.
+  # This creates #interests, #interests=, #interests_array, #interests_array= instance methods
+  taggable :interests
+
+  # tagging for 'skills' context.
+  # This creates #skills, #skills=, #skills_array, #skills_array= instance methods
+  # changing tag separator to "," (Default is " ")
+  taggable :skills, :separator => ','
+end
+```
+
+Then in your form, for example:
+
+```rhtml
+<% form_for @post do |f| %>
+  <p>
+    <%= f.label :title %><br />
+    <%= f.text_field :title %>
+  </p>
+  <p>
+    <%= f.label :content %><br />
+    <%= f.text_area :content %>
+  </p>
+  <p>
+    <%= f.label :tags %><br />
+    <%= text_field_tag 'post[tags]' %>
+  </p>
+  <p>
+    <%= f.label :interests %><br />
+    <%= text_field_tag 'post[interests]' %>
+  </p>
+  <p>
+    <%= f.label :skills %><br />
+    <%= text_field_tag 'post[skills]' %>
+  </p>
+  <p>
+    <button type="submit">Send</button>
+  </p>
+<% end %>
+```
+
+Aggregation Strategies
+----------------------
+
+By including an aggregation strategy in your document, tag aggregations will be automatically available to you.
+This lib presents the following aggregation strategies:
+
+* MapReduce
+* RealTime
+
+The following document will automatically aggregate counts on all tag contexts.
+
+```ruby
+class Post
+  include Mongoid::Document
+  include Mongoid::TaggableWithContext
+
+  # automatically adds real time aggregations to all tag contexts
+  include Mongoid::TaggableWithContext::AggregationStrategy::RealTime
+
+  # alternatively for map-reduce
+  # include Mongoid::TaggableWithContext::AggregationStrategy::MapReduce
+
+  field :title
+  field :content
+
+  taggable
+  taggable :interests
+  taggable :skills, :separator => ','
+end
+```
+
+When you include an aggregation strategy, your document also gains a few extra methods to retrieve aggregation data.
+In the case of previous example the following methods are included:
+
+```ruby
+Post.tags
+Post.tags_with_weight
+Post.interests
+Post.interests_with_weight
+Post.skills
+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.tags # will retrieve ["ant", "bee", "food", "honey", "juice", "strip", "zip"]
+Post.tags_with_weight # will retrieve:
+# [
+#   ['ant', 1],
+#   ['bee', 2],
+#   ['food', 3],
+#   ['honey', 1],
+#   ['juice', 1],
+#   ['strip', 1],
+#   ['zip', 1]
+# ]
+```
+
+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
+-----------------------------------------------
+
+* 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. 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
+---------
+
+Copyright (c) 2011 Aaron Qian. See LICENSE.txt for
+further details.

data/Rakefile

@@ -28,26 +28,7 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.rspec_opts = "--color --format progress"
 end
 
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-  spec.rcov_opts = "--exclude ~\/.rvm,spec"
-end
-
-require 'reek/rake/task'
-Reek::Rake::Task.new do |t|
-  t.fail_on_error = true
-  t.verbose = false
-  t.source_files = 'lib/**/*.rb'
-end
-
-require 'roodi'
-require 'roodi_task'
-RoodiTask.new do |t|
-  t.verbose = false
-end
-
 task :default => :spec
 
 require 'yard'
-YARD::Rake::YardocTask.new
+YARD::Rake::YardocTask.new

data/VERSION

@@ -1 +1 @@
-0.8.0
+0.8.1

data/lib/mongoid/taggable_with_context.rb

@@ -10,6 +10,7 @@ module Mongoid::TaggableWithContext
     self.context_array_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 "tag_contexts",                  :to => 'self.class'
     delegate "tag_options_for",               :to => 'self.class'
@@ -92,6 +93,9 @@ module Mongoid::TaggableWithContext
         def #{tags_field}=(s)
           write_attribute(:#{tags_array_field}, convert_string_to_array(s, get_tag_separator_for(:"#{tags_field}")))
         end
+        def #{tags_array_field}=(ary)
+          write_attribute(:#{tags_array_field}, clean_up_array(ary))
+        end
       END
     end
 
@@ -149,7 +153,7 @@ module Mongoid::TaggableWithContext
     end
 
     def convert_array_to_string(ary = [], separator = " ")
-      clean_up_array(ary).join(separator)
+      ary.join(separator)
     end
 
     def clean_up_array(ary = [])

data/mongoid_taggable_with_context.gemspec

@@ -5,22 +5,23 @@
 
 Gem::Specification.new do |s|
   s.name = "mongoid_taggable_with_context"
-  s.version = "0.8.0"
+  s.version = "0.8.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Qian"]
-  s.date = "2011-12-20"
+  s.date = "2012-03-14"
   s.description = "It provides some helpers to create taggable documents with context."
   s.email = "aq1018@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
+    ".travis.yml",
     "Gemfile",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "init.rb",
@@ -37,6 +38,10 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.rubygems_version = "1.8.10"
   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
@@ -50,9 +55,6 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<yard>, [">= 0"])
       s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-      s.add_development_dependency(%q<reek>, [">= 0"])
-      s.add_development_dependency(%q<roodi>, [">= 0"])
     else
       s.add_dependency(%q<mongoid>, [">= 2.0.0"])
       s.add_dependency(%q<database_cleaner>, [">= 0"])
@@ -62,9 +64,6 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<yard>, [">= 0"])
       s.add_dependency(%q<bundler>, [">= 1.0.0"])
       s.add_dependency(%q<jeweler>, [">= 0"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-      s.add_dependency(%q<reek>, [">= 0"])
-      s.add_dependency(%q<roodi>, [">= 0"])
     end
   else
     s.add_dependency(%q<mongoid>, [">= 2.0.0"])
@@ -75,9 +74,6 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<yard>, [">= 0"])
     s.add_dependency(%q<bundler>, [">= 1.0.0"])
     s.add_dependency(%q<jeweler>, [">= 0"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-    s.add_dependency(%q<reek>, [">= 0"])
-    s.add_dependency(%q<roodi>, [">= 0"])
   end
 end
 

data/spec/mongoid_taggable_with_context_spec.rb

@@ -73,6 +73,27 @@ describe Mongoid::TaggableWithContext do
     end
   end
 
+  context "saving tags from array" do
+    before :each do
+      @m = MyModel.new
+    end
+    
+    it "should remove repeated tags from array" do
+      @m.tags_array = %w[some new tags some new tags]
+      @m.tags_array == %w[some new tags]
+    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]
+    end
+
+    it "should remove empty strings from array" do
+      @m.tags_array = ["some", "", "new", "", "tags"]
+      @m.tags_array.should == %w[some new tags]
+    end
+  end
+
   context "changing separator" do
     before :all do
       MyModel.tags_separator = ";"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_taggable_with_context
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-20 00:00:00.000000000 Z
+date: 2012-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &70248022449940 !ruby/object:Gem::Requirement
+  requirement: &22089400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 2.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70248022449940
+  version_requirements: *22089400
 - !ruby/object:Gem::Dependency
   name: database_cleaner
-  requirement: &70248022449440 !ruby/object:Gem::Requirement
+  requirement: &22101640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70248022449440
+  version_requirements: *22101640
 - !ruby/object:Gem::Dependency
   name: bson
-  requirement: &70248022448940 !ruby/object:Gem::Requirement
+  requirement: &22100100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70248022448940
+  version_requirements: *22100100
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &70248022448420 !ruby/object:Gem::Requirement
+  requirement: &22099180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70248022448420
+  version_requirements: *22099180
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70248022447920 !ruby/object:Gem::Requirement
+  requirement: &22097660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70248022447920
+  version_requirements: *22097660
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70248022447420 !ruby/object:Gem::Requirement
+  requirement: &22112620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70248022447420
+  version_requirements: *22112620
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70248022446920 !ruby/object:Gem::Requirement
+  requirement: &22111660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70248022446920
+  version_requirements: *22111660
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70248022446440 !ruby/object:Gem::Requirement
+  requirement: &22111080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,52 +98,20 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70248022446440
-- !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: &70248022445860 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70248022445860
-- !ruby/object:Gem::Dependency
-  name: reek
-  requirement: &70248022445360 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70248022445360
-- !ruby/object:Gem::Dependency
-  name: roodi
-  requirement: &70248022444840 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70248022444840
+  version_requirements: *22111080
 description: It provides some helpers to create taggable documents with context.
 email: aq1018@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - .document
+- .travis.yml
 - Gemfile
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - init.rb
@@ -169,7 +137,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3893883792332336136
+      hash: -3234920624644795753
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -182,4 +150,6 @@ rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Mongoid taggable behaviour
-test_files: []
+test_files:
+- spec/mongoid_taggable_with_context_spec.rb
+- spec/spec_helper.rb

data/README.rdoc

@@ -1,174 +0,0 @@
-= Mongoid Taggable With Context
-
-A tagging lib for Mongoid that allows for custom tagging along dynamic contexts. This lib was originally based on 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.
-
-For instance, in a social network, a user might have tags that are called skills, interests, sports, and more. There is no real way to differentiate between tags and so an implementation of this type is not possible with Mongoid Taggable.
-
-Another example, aggregation such as counting tag occurrences was achieved by map-reduce with Mongoid Taggable. It was ok for small amount of tags, but when the amount of tags and documents grow, the original Mongoid Taggable won't be able to scale to real-time statistics demand.
-
-Enter Mongoid Taggable With Context. Rather than tying functionality to a specific keyword (namely "tags"), Mongoid Taggable With Context allows you to specify an arbitrary number of tag "contexts" that can be used locally or in combination in the same way Mongoid Taggable was used.
-
-Mongoid Taggable With Context also provides flexibility on aggregation strategy. In addition to the map-reduce strategy, Mongoid Taggable With Context also comes with real-time strategy. By using real-time strategy, your document can quickly adjusts the aggregation collection whenever tags are inserted or removed with $inc operator. So performance won't be impacted as the number of tags and documents grow.
-
-== Installation
-
-You can simply install from rubygems:
-
-  gem install mongoid_taggable_with_context
-
-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:
-
-  class Post
-    include Mongoid::Document
-    include Mongoid::TaggableWithContext
-
-    field :title
-    field :content
-
-    # default context is 'tags'.
-    # This creates #tags, #tags=, #tags_array, #tags_array= 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.
-    taggable
-    
-    # tagging for 'interests' context.
-    # This creates #interests, #interests=, #interests_array, #interests_array= instance methods
-    taggable :interests
-    
-    # tagging for 'skills' context.
-    # This creates #skills, #skills=, #skills_array, #skills_array= instance methods
-    # changing tag separator to "," (Default is " ") 
-    taggable :skills, :separator => ','
-  end
-
-Then in your form, for example:
-
-  <% form_for @post do |f| %>
-    <p>
-      <%= f.label :title %><br />
-      <%= f.text_field :title %>
-    </p>
-    <p>
-      <%= f.label :content %><br />
-      <%= f.text_area :content %>
-    </p>
-    <p>
-      <%= f.label :tags %><br />
-      <%= text_field_tag 'post[tags]' %>
-    </p>
-    <p>
-      <%= f.label :interests %><br />
-      <%= text_field_tag 'post[interests]' %>
-    </p>
-    <p>
-      <%= f.label :skills %><br />
-      <%= text_field_tag 'post[skills]' %>
-    </p>
-    <p>
-      <button type="submit">Send</button>
-    </p>
-  <% end %>
-
-
-== Aggregation Strategies
-
-By including an aggregation strategy in your document, tag aggregations will be automatically available to you.
-This lib presents the following aggregation strategies:
-
-* MapReduce
-* RealTime
-
-The following document will automatically aggregate counts on all tag contexts.
-
-  class Post
-    include Mongoid::Document
-    include Mongoid::TaggableWithContext
-    
-    # automatically adds real time aggregations to all tag contexts
-    include Mongoid::TaggableWithContext::AggregationStrategy::RealTime
-
-    # alternatively for map-reduce
-    # include Mongoid::TaggableWithContext::AggregationStrategy::MapReduce
-
-    field :title
-    field :content
-
-    taggable
-    taggable :interests
-    taggable :skills, :separator => ','
-  end
-
-When you include an aggregation strategy, your document also gains a few extra methods to retrieve aggregation data.
-In the case of previous example the following methods are included:
-
-  Post.tags
-  Post.tags_with_weight
-  Post.interests
-  Post.interests_with_weight
-  Post.skills
-  Post.skills_with_weight
-  
-Here is how to use these methods in more detail:
-
-  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:
-  # [
-  #   ['ant', 1],
-  #   ['bee', 2],
-  #   ['food', 3],
-  #   ['honey', 1],
-  #   ['juice', 1],
-  #   ['strip', 1],
-  #   ['zip', 1]
-  # ]
-
-== Changing default separator
-
-To change the default separator you may pass a *separator* argument to the macro:
-
-  class Post
-    include Mongoid::Document
-    include Mongoid::TaggableWithContext
-
-    field :title
-    field :content
-
-    taggable :separator => ','    # tags will be delineated by comma instead of space
-  end
-
-== Development and Testing
-
-Mongoid Taggable With Context uses Bundler for easy installation of development dependent gems.
-To get all dependent gems for development, while inside mongoid_taggable_with_context directory:
-
-  bundle install
-
-
-Mongoid Taggable With Context uses RSpec for its test coverage.
-Inside mongoid_taggable_with_context directory, you can run the specs with:
-
-  rake spec
-
-To see the test coverage, you need to be on ruby 1.8.7 (since latest rcov doesn't work 1.9)
-and run the following command:
-
-  rake rcov
-  
-== Next Up
-
-* More documentation.
-* More Strategies. ( Let me know what kind of strategies you want, or contribute your own. )