tagalong 0.0.5 → 0.0.6

data/README.md

@@ -94,15 +94,30 @@ To list Tagger tags, call the `tags` method on a Tagger object. This will return
     @user.tags
     # => ['another_tag', 'some_tag', 'woot_tag']
 
-### List Tagger tags with usage info
+### List Tagger tags with more information
 
-To list Tagger tags with usage info, call the `tags` method on a Tagger object passing in a Taggable object. This will return a list of hash objects containing the tag ( **:tag** ), a boolean representing if the Taggable passed in is currently tagged with that tag ( **:used** ), and the number of references of that tag by the Tagger ( **:number_of_references** ). The resulting list of hashes is ordered by tag in ascending alphabetical order.
+You can get a list of tags that belong to a Tagger along with some additional information by calling the `tags_including` method. The result will be a hash that always contains the key **:name** which is the name of the tag. There can be other keys added to the hash if you choose to pass the option for them to the method. A list of the params you can pass and their explanations are below:
 
-    @user.tags(@contact)
+##### :number_of_references => true
+
+This only takes true as a value. When passed, it will add **:number_of_references** to the result hash. The value of **:number_of_references** is the number of times the tag is used by the Tagger.
+
+    @user.tags_including(:number_of_references => true)
+    # => [
+           { name: 'another_tag', :number_of_references => 42 },
+           { name: 'some_tag', :number_of_references => 23 },
+           { name: 'woot_tag', :number_of_references => 2 }
+         ]
+
+##### :has_been_tagged => @contact
+
+Takes a Taggable as a value. When passed, it will add **:has_been_tagged** to the result hash for each tag returned. The value of **:has_been_tagged** will contain a boolean representing if the Taggable passed is tagged by the current tag in the iteration.
+
+    @user.tags_including(:has_been_tagged => @contact)
     # => [
-           { tag: 'another_tag', :used => false, :number_of_references => 42 },
-           { tag: 'some_tag', :used => true, :number_of_references => 23 },
-           { tag: 'woot_tag', :used => true, :number_of_references => 2 }
+           { name: 'another_tag', :has_been_tagged => true },
+           { name: 'some_tag', :has_been_tagged => false },
+           { name: 'woot_tag', :has_been_tagged => true }
          ]
 
 ### List Taggable tags

data/lib/tagalong/tagger.rb

@@ -33,15 +33,32 @@ module Tagalong
         end
       end
 
-      def tags(taggable = nil)
-        if taggable == nil
-          return self.tagalong_tags.order("name ASC").map { |r| r.name }
-        else
-          return self.tagalong_tags.
-                  joins("LEFT OUTER JOIN tagalong_taggings ON tagalong_taggings.tagalong_tag_id = tagalong_tags.id AND tagalong_taggings.taggable_id = '#{taggable.id.to_s}'").
-                  select("tagalong_tags.id, tagalong_tags.name, tagalong_tags.number_of_references, tagalong_taggings.id as used").
-                  order("name ASC").map { |r| { :tag => r.name, :used => !r.used.nil?, :number_of_references => r.number_of_references } }
+      def tags
+        self.tagalong_tags.order("name ASC").map { |r| r.name }
+      end
+
+      def tags_including(options={})
+        out = []
+        query = self.tagalong_tags.order("name ASC")
+
+        if options[:has_been_tagged]
+          query = query.
+                    select("tagalong_tags.id, tagalong_tags.name, tagalong_tags.number_of_references, tagalong_taggings.id as used").
+                    joins("LEFT OUTER JOIN tagalong_taggings ON tagalong_taggings.tagalong_tag_id = tagalong_tags.id AND tagalong_taggings.taggable_id = '#{options[:has_been_tagged].id.to_s}'")
+        end
+        
+        query.each do |tag|
+          hash = {:name => tag.name}
+          if options[:number_of_references]
+            hash[:number_of_references] = tag.number_of_references
+          end
+          if options[:has_been_tagged]
+            hash[:has_been_tagged] = !tag.used.nil?
+          end
+          out << hash
         end
+        
+        return out
       end
 
       def taggables_with(name)

data/lib/tagalong/version.rb

@@ -1,3 +1,3 @@
 module Tagalong
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/lib/tagalong/tagger_spec.rb

@@ -63,43 +63,40 @@ describe "Tagger" do
           @user.tags.should == ["bar", "car", "foo"]
         end
       end
+    end
+
+    describe "#tags_including" do
+      before(:each) do
+        @user.tag(@contact, "tag1")
+        @user.tag(@contact, "tag2")
+      end
 
-      context "with a taggable" do
-        it "returns a hash of the tags with usage information about the passed taggable" do
-          tag = @user.tagalong_tags.create!(:name => "foo", :number_of_references => 1)
-          @contact.tagalong_taggings.create!(:tagalong_tag_id => tag.id)
-          @user.tagalong_tags.create!(:name => "bar", :number_of_references => 0)
-          tag = @user.tagalong_tags.create!(:name => "car", :number_of_references => 1)
-          @contact.tagalong_taggings.create!(:tagalong_tag_id => tag.id)
-          @user.tags(@contact).should == [
-            { :tag => "bar", :used => false, :number_of_references => 0 },
-            { :tag => "car", :used => true, :number_of_references => 1 },
-            { :tag => "foo", :used => true, :number_of_references => 1  }
+      context "without options passed" do
+        it "should return an array of hashes with name" do
+          @user.tags_including.should == [
+            {:name => 'tag1'},
+            {:name => 'tag2'}
           ]
         end
-
-        it "returns a hash of tags with usage information about the passed taggable on secondary calls when the taggable changes" do
-          tag = @user.tagalong_tags.create!(:name => "foo", :number_of_references => 1)
-          @contact.tagalong_taggings.create!(:tagalong_tag_id => tag.id)
-          @user.tagalong_tags.create!(:name => "bar", :number_of_references => 0)
-          tag = @user.tagalong_tags.create!(:name => "car", :number_of_references => 1)
-          @contact.tagalong_taggings.create!(:tagalong_tag_id => tag.id)
-          @user.tags(@contact).should == [
-            { :tag => "bar", :used => false, :number_of_references => 0 },
-            { :tag => "car", :used => true, :number_of_references => 1 },
-            { :tag => "foo", :used => true, :number_of_references => 1  }
+      end
+      
+      context "with number_of_references passed" do
+        it "should return an array of hashes with name and number_of_references" do
+          @user.tags_including(:number_of_references => true).should == [
+            {:name => 'tag1', :number_of_references => 1},
+            {:name => 'tag2', :number_of_references => 1}
           ]
-          @other_contact = Contact.create!(:name => "My Other Taggable")
-          tag = @user.tagalong_tags.create!(:name => "jones", :number_of_references => 1)
-          @other_contact.tagalong_taggings.create!(:tagalong_tag_id => tag.id)
-          tag = @user.tagalong_tags.create!(:name => "jimmy", :number_of_references => 2)
-          @other_contact.tagalong_taggings.create!(:tagalong_tag_id => tag.id)
-          @user.tags(@other_contact).should == [
-            { :tag => "bar", :used => false, :number_of_references => 0 },
-            { :tag => "car", :used => false, :number_of_references => 1 },
-            { :tag => "foo", :used => false, :number_of_references => 1  },
-            { :tag => "jimmy", :used => true, :number_of_references => 2  },
-            { :tag => "jones", :used => true, :number_of_references => 1 }
+        end
+      end
+
+      context "with a valid taggable passed as has_been_tagged" do
+        it "should return an array of hashes with name and has_been_tagged" do
+          @contact2 = Contact.create!(:name => "My Taggable 2")
+          @user.tag(@contact2, 'tag3')
+          @user.tags_including(:has_been_tagged => @contact).should == [
+            {:name => 'tag1', :has_been_tagged => true},
+            {:name => 'tag2', :has_been_tagged => true},
+            {:name => 'tag3', :has_been_tagged => false}
           ]
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tagalong
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-17 00:00:00.000000000 Z
+date: 2012-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70195968616540 !ruby/object:Gem::Requirement
+  requirement: &70298657761420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70195968616540
+  version_requirements: *70298657761420
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70195968616100 !ruby/object:Gem::Requirement
+  requirement: &70298657760980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70195968616100
+  version_requirements: *70298657760980
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70195968615680 !ruby/object:Gem::Requirement
+  requirement: &70298657760560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70195968615680
+  version_requirements: *70298657760560
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70195968615240 !ruby/object:Gem::Requirement
+  requirement: &70298657760120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70195968615240
+  version_requirements: *70298657760120
 description: A Rails tagging plugin that makes sense.
 email:
 - cyphactor@gmail.com