mongoid_taggable 0.1.0

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (c) 2010 Wilker Lúcio <wilkerlucio@gmail.com>
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.textile

@@ -0,0 +1,95 @@
+h1. Mongoid Taggable
+
+Mongoid Taggable provides some helpers to create taggable documents.
+
+h2. Installation
+
+You can simple install from rubygems:
+
+bc. gem install mongoid_taggable
+
+or as a Rails Plugin:
+
+bc. script/plugin install git://github.com/wilkerlucio/mongoid_taggable.git
+
+h2. Basic Usage
+
+To make a document taggable you just need to include Mongoid::Taggable into your document:
+
+bc.. class Post
+  include Mongoid::Document
+  include Mongoid::Taggable
+  
+  field :title
+  field :content
+end
+
+p. Them in your form:
+
+bc.. <% 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 />
+    <%= f.text_field :tags %>
+  </p>
+  <p>
+    <button type="submit">Send</button>
+  </p>
+<% end %>
+
+p. In this case, the text fields for tags should receive the list of tags separated by colon (above in this document you will see how to change the separator)
+
+p. Them your document will have the @tags@ and @tags_array@ getter and setter. The @tags@ you use as a plain string with tags separated by colon, the @tags_array@ is an array with tags, these two properties are automatic synchronized.
+
+h2. Tags Indexing
+
+This lib will automatic create for you and index of tags after save the document, this index is useful to get a list of all tags used in documents of this collection or to create a tag cloud. See the following example to understand how to use it:
+
+bc.. 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]
+# ]
+
+p. If you don't want to use this feature, its good to disable for improve performance:
+
+bc.. class Post
+  include Mongoid::Document
+  include Mongoid::Taggable
+  
+  disable_tags_index! # will disable index creation
+  
+  field :title
+  field :content
+end
+
+h2. Changing default separator
+
+To change default separator you just need to call @tags_separator@ method on class:
+
+bc.. class Post
+  include Mongoid::Document
+  include Mongoid::Taggable
+  
+  tags_separator ';' # will change tags separator to ;
+  
+  field :title
+  field :content
+end

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "mongoid_taggable"
+    gemspec.version = "0.1.0"
+    gemspec.summary = "Mongoid taggable behaviour"
+    gemspec.description = "Mongoid Taggable provides some helpers to create taggable documents."
+    gemspec.email = "wilkerlucio@gmail.com"
+    gemspec.homepage = "http://github.com/kriss/mongo_taggable"
+    gemspec.authors = ["Wilker Lúcio", "Kris Kowalik"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the mongoid_taggable plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the mongoid_taggable plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MongoidTaggable'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1 @@
+require 'mongoid/taggable'

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/mongoid/taggable.rb

@@ -0,0 +1,106 @@
+# Copyright (c) 2010 Wilker Lúcio <wilkerlucio@gmail.com>
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#    http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongoid::Taggable
+  def self.included(base)
+    # create fields for tags and index it
+    base.field :tags_array, :type => Array
+    base.index [['tags_array', Mongo::ASCENDING]]
+    
+    # add callback to save tags index
+    base.after_save do |document|
+      document.class.save_tags_index!
+    end
+    
+    # extend model
+    base.extend         ClassMethods
+    base.send :include, InstanceMethods
+    
+    # enable indexing as default
+    base.enable_tags_index!
+  end
+  
+  module ClassMethods
+    # get an array with all defined tags for this model, this list returns
+    # an array of distinct ordered list of tags defined in all documents
+    # of this model
+    def tags
+      db = Mongoid::Config.instance.master
+      db.collection(tags_index_collection).find.to_a.map{ |r| r["_id"] }
+    end
+    
+    # retrieve the list of tags with weight(count), this is usefull for
+    # creating tag clouds
+    def tags_with_weight
+      db = Mongoid::Config.instance.master
+      db.collection(tags_index_collection).find.to_a.map{ |r| [r["_id"], r["value"]] }
+    end
+    
+    def disable_tags_index!
+      @do_tags_index = false
+    end
+    
+    def enable_tags_index!
+      @do_tags_index = true
+    end
+    
+    def tags_separator(separator = nil)
+      @tags_separator = separator if separator
+      @tags_separator || ','
+    end
+    
+    def tags_index_collection
+      "#{collection_name}_tags_index"
+    end
+
+    def save_tags_index!
+      return unless @do_tags_index
+      
+      db = Mongoid::Config.instance.master
+      coll = db.collection(collection_name)
+
+      map = "function() {
+        if (!this.tags_array) {
+          return;
+        }
+
+        for (index in this.tags_array) {
+          emit(this.tags_array[index], 1);
+        }
+      }"
+
+      reduce = "function(previous, current) {
+        var count = 0;
+
+        for (index in current) {
+          count += current[index]
+        }
+
+        return count;
+      }"
+
+      coll.map_reduce(map, reduce, :out => tags_index_collection)
+    end
+  end
+  
+  module InstanceMethods
+    def tags
+      (tags_array || []).join(self.class.tags_separator)
+    end
+    
+    def tags=(tags)
+      self.tags_array = tags.split(self.class.tags_separator).map(&:strip)
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'mongoid/taggable'

data/spec/mongoid/taggable_spec.rb

@@ -0,0 +1,112 @@
+# Copyright (c) 2010 Wilker Lúcio <wilkerlucio@gmail.com>
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#    http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require File.join(File.dirname(__FILE__), %w[.. spec_helper])
+
+class MyModel
+  include Mongoid::Document
+  include Mongoid::Taggable
+end
+
+describe Mongoid::Taggable do
+  context "saving tags from plain text" do
+    before :each do
+      @m = MyModel.new
+    end
+    
+    it "should set tags array from string" do
+      @m.tags = "some,new,tag"
+      @m.tags_array.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"
+    end
+    
+    it "should strip tags before put in array" do
+      @m.tags = "now ,  with, some spaces  , in places "
+      @m.tags_array.should == ["now", "with", "some spaces", "in places"]
+    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_array.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"
+    end
+  end
+  
+  context "indexing tags" do
+    it "should generate the index collection name based on model" do
+      MyModel.tags_index_collection.should == "my_models_tags_index"
+    end
+    
+    context "retriving index" do
+      before :each do
+        MyModel.create!(:tags => "food,ant,bee")
+        MyModel.create!(:tags => "juice,food,bee,zip")
+        MyModel.create!(:tags => "honey,strip,food")
+      end
+      
+      it "should retrieve the list of all saved tags distinct and ordered" do
+        MyModel.tags.should == %w[ant bee food honey juice strip zip]
+      end
+      
+      it "should retrieve a list of tags with weight" do
+        MyModel.tags_with_weight.should == [
+          ['ant', 1],
+          ['bee', 2],
+          ['food', 3],
+          ['honey', 1],
+          ['juice', 1],
+          ['strip', 1],
+          ['zip', 1]
+        ]
+      end
+    end
+    
+    context "avoiding index generation" do
+      before :all do
+        MyModel.disable_tags_index!
+      end
+      
+      after :all do
+        MyModel.enable_tags_index!
+      end
+      
+      it "should not generate index" do
+        MyModel.create!(:tags => "sample,tags")
+        MyModel.tags.should == []
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+begin
+  require File.join(File.dirname(__FILE__), %w[.. .. .. .. spec spec_helper])
+rescue LoadError
+  puts "You need to install rspec in your base app"
+  exit
+end
+
+plugin_spec_dir = File.dirname(__FILE__)

data/tasks/mongoid_taggable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :mongoid_taggable do
+#   # Task goes here
+# end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: mongoid_taggable
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Wilker L\xC3\xBAcio"
+- Kris Kowalik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-19 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Mongoid Taggable provides some helpers to create taggable documents.
+email: wilkerlucio@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- LICENSE
+- README.textile
+- Rakefile
+- init.rb
+- install.rb
+- lib/mongoid/taggable.rb
+- rails/init.rb
+- spec/mongoid/taggable_spec.rb
+- spec/spec_helper.rb
+- tasks/mongoid_taggable_tasks.rake
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/kriss/mongo_taggable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Mongoid taggable behaviour
+test_files: 
+- spec/spec_helper.rb
+- spec/mongoid/taggable_spec.rb