mongoid_taggable 0.1.4 → 0.1.5

data/README.textile

@@ -18,17 +18,17 @@ 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:
+To make a document taggable you 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:
+p. And in your form:
 
 bc.. <% form_for @post do |f| %>
   <p>
@@ -48,13 +48,20 @@ bc.. <% form_for @post do |f| %>
   </p>
 <% end %>
 
-p. In this case, the text fields for tags should receive the list of tags separated by comma (below in this document you will see how to change the separator)
+p. In this case, the text fields for tags should receive the list of tags separated by comma (See below for how to change the separator).
+
+p. Then your document will have the @tags@ and @tags_array@ getter and setter. @tags@ is as a plain string with tags separated by comma, and @tags_array@ an array representation.
+
+h2. Finding Objects by Tag
+
+p. Tagged models get a scope called @tagged_with@:
 
-p. Then your document will have the @tags@ and @tags_array@ getter and setter. The @tags@ you use as a plain string with tags separated by comma, and the @tags_array@ is an array with tags. These two properties are automatically synchronized.
+bc.. MyModel.tagged_with('foo')
+MyModel.published.tagged_with('foo').count
 
 h2. Tags Indexing
 
-This lib will automatically create an index of tags and their counts for you after saving the document, useful for getting 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:
+This module will automatically create an index of tags and their counts for you after saving the document. This can be used for 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")

data/Rakefile

@@ -7,7 +7,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gemspec|
     gemspec.name = "mongoid_taggable"
-    gemspec.version = "0.1.4"
+    gemspec.version = "0.1.5"
     gemspec.summary = "Mongoid taggable behaviour"
     gemspec.description = "Mongoid Taggable provides some helpers to create taggable documents."
     gemspec.email = "wilkerlucio@gmail.com"

data/lib/mongoid/taggable.rb

@@ -17,30 +17,33 @@ module Mongoid::Taggable
     # 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
+    # returns an array of distinct ordered list of tags defined in all documents
+
+    def tagged_with(tag)
+      self.any_in(:tags_array => [tag])
+    end
+
     def tags
       db = Mongoid::Config.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
+    # retrieve the list of tags with weight (i.e. count), this is useful for
     # creating tag clouds
     def tags_with_weight
       db = Mongoid::Config.master

data/mongoid_taggable.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongoid_taggable}
-  s.version = "0.1.4"
+  s.version = "0.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Wilker Lucio", "Kris Kowalik"]
-  s.date = %q{2011-03-09}
+  s.date = %q{2011-04-18}
   s.description = %q{Mongoid Taggable provides some helpers to create taggable documents.}
   s.email = %q{wilkerlucio@gmail.com}
   s.extra_rdoc_files = [
@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/wilkerlucio/mongoid_taggable}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.5.0}
+  s.rubygems_version = %q{1.7.2}
   s.summary = %q{Mongoid taggable behaviour}
   s.test_files = [
     "spec/mongoid/taggable_spec.rb",

data/spec/mongoid/taggable_spec.rb

@@ -20,6 +20,14 @@ class MyModel
 end
 
 describe Mongoid::Taggable do
+
+  context "finding by tag" do
+    it "locates tagged objects" do
+      m = MyModel.create!(:tags => "interesting,stuff")
+      MyModel.tagged_with('interesting').include?(m).should be_true
+    end
+  end
+
   context "saving tags from plain text" do
     before :each do
       @m = MyModel.new
@@ -75,7 +83,7 @@ describe Mongoid::Taggable do
       MyModel.tags_index_collection.should == "my_models_tags_index"
     end
 
-    context "retriving index" do
+    context "retrieving index" do
       before :each do
         MyModel.create!(:tags => "food,ant,bee")
         MyModel.create!(:tags => "juice,food,bee,zip")

metadata

@@ -2,7 +2,7 @@
 name: mongoid_taggable
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - Wilker Lucio
@@ -11,8 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-09 00:00:00 -03:00
-default_executable: 
+date: 2011-04-18 00:00:00 Z
 dependencies: []
 
 description: Mongoid Taggable provides some helpers to create taggable documents.
@@ -36,7 +35,6 @@ files:
 - rails/init.rb
 - spec/mongoid/taggable_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/wilkerlucio/mongoid_taggable
 licenses: []
 
@@ -60,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.0
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Mongoid taggable behaviour