mongoid-tag-collectible 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+services:
+  - mongodb

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.1.0 (06/26/2013)
+
+* Initial public release, written on a plane from SF to NYC - [@dblock](https://github.com/dblock).

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem "rspec"
+gem "rake"

data/LICENSE.md

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2013 Daniel Doubrovkine.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,81 @@
+Mongoid::TagCollectible
+=======================
+
+[![Build Status](https://travis-ci.org/dblock/mongoid-tag-collectible.png)](https://travis-ci.org/dblock/mongoid-tag-collectible)
+
+Easily maintain a collection of `Tag` instances with aggregate counts from your model's `tags`.
+
+### Install
+
+Add `mongoid-tag-collectible` to your Gemfile.
+
+```
+gem 'mongoid-tag-collectible'
+```
+
+### Use
+
+``` ruby
+class Thing
+  include Mongoid::Document
+  include Mongoid::TagCollectible::Tagged
+end
+
+thing1 = Thing.create!(tags: [ 'funny', 'red' ])
+thing2 = Thing.create!(tags: [ 'funny', 'yellow' ])
+
+funny_tag = ThingTag.find('funny') # find by tag
+funny_tag.name # "funny"
+funny_tag.count # 2, not a database query
+funny_tag.tagged # thing1 and thing2
+```
+
+#### Renaming Tags
+
+You can rename a tag, which causes all the tags in your model's `tags` collection to be renamed.
+
+``` ruby
+ThingTag.find('funny').update_attributes!(name: 'sad')
+
+Thing.first.tags # [ 'sad', 'red' ]
+```
+
+#### Destroying Tags
+
+You can destroy a tag, which also removes it from your model's `tags` collection.
+
+``` ruby
+ThingTag.find('red').destroy
+Thing.first.tags # [ 'sad' ]
+```
+
+#### Case-Sensitive
+
+Tags are case-sensitive. Transform your tags in `before_validation` if you don't want this behavior.
+
+``` ruby
+class Thing
+  before_validation :downcase_tags
+
+  private
+
+  def downcase_tags
+    tags = tags.map(&:downcase) if tags
+  end
+end
+```
+
+### Contribute
+
+You're encouraged to contribute to this gem.
+
+* Fork this project.
+* Make changes, write tests.
+* Updated CHANGELOG.
+* Make a pull request, bonus points for topic branches.
+
+### Copyright and License
+
+Copyright Daniel Doubrovkine and Contributors, Artsy Inc., 2013
+
+[MIT License](LICENSE.md)

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler/gem_tasks'
+
+Bundler.setup :default, :development
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList["spec/**/*_spec.rb"]
+end
+
+task :default => :spec

data/examples/readme.rb

@@ -0,0 +1,39 @@
+require 'bundler'
+Bundler.setup(:default, :development)
+
+require 'mongoid-tag-collectible'
+
+Mongoid.configure do |config|
+  config.connect_to('mongoid_tag_collectible_example')
+end
+
+class Thing
+  include Mongoid::Document
+  include Mongoid::TagCollectible::Tagged
+
+  before_validation :downcase_tags
+
+  private
+
+  def downcase_tags
+    tags = tags.map(&:downcase) if tags
+  end
+end
+
+thing1 = Thing.create!(tags: [ 'funny', 'red' ])
+thing2 = Thing.create!(tags: [ 'funny', 'yellow' ])
+
+funny_tag = ThingTag.where(name: 'funny').first
+puts funny_tag.name # funny
+puts funny_tag.count # 2
+p funny_tag.tagged.to_a # thing1 and thing2
+
+# rename a tag
+ThingTag.find('funny').update_attributes!(name: 'sad')
+p Thing.first.tags # [ 'sad', 'red' ]
+
+# delete a tag
+ThingTag.find('red').destroy
+p Thing.first.tags # [ 'sad' ]
+
+Mongoid.default_session.drop

data/lib/mongoid-tag-collectible.rb

@@ -0,0 +1,6 @@
+require 'mongoid'
+require 'active_support'
+
+require 'mongoid-tag-collectible/version'
+require 'mongoid-tag-collectible/tag.rb'
+require 'mongoid-tag-collectible/tagged.rb'

data/lib/mongoid-tag-collectible/tag.rb

@@ -0,0 +1,51 @@
+module Mongoid
+  module TagCollectible
+    class Tag
+      include Mongoid::Document
+      include Mongoid::Timestamps
+
+      field :name, type: String
+      index({ name: 1 }, { unique: true })
+
+      field :count, type: Integer, default: 0
+      index({ count: -1 })
+
+      before_destroy :_remove_tags!
+      before_update :_rename_tag!
+      attr_accessor :renaming
+
+      def renaming?
+        !! renaming
+      end
+
+      def tagged
+        tagged_class.where(tags: self.name)
+      end
+
+      def _remove_tags!
+        tagged_class.remove_tag!(self[:name]) unless renaming?
+      end
+
+      def self.find(value)
+        if Moped::BSON::ObjectId.legal?(value)
+          super(value)
+        else
+          where(name: value).first
+        end
+      end
+
+      private
+
+      def _rename_tag!
+        if ! new_record? && name_changed?
+          self.class.where(name: name).each do |tag|
+            tag.renaming = true
+            tag.destroy
+          end
+          tagged_class.rename_tag!(name_was, name)
+        end
+      end
+
+    end
+  end
+end

data/lib/mongoid-tag-collectible/tagged.rb

@@ -0,0 +1,78 @@
+module Mongoid
+  module TagCollectible
+    module Tagged
+      extend ActiveSupport::Concern
+
+      included do
+        field :tags, type: Array, default: []
+        index({ tags: 1 })
+        scope :tagged, where({ :tags.nin => [ nil, [] ], :tags.ne => nil })
+        after_save :_update_tags!
+        after_destroy :_destroy_tags!
+        cattr_accessor :tag_class
+
+        klass = Class.new(Mongoid::TagCollectible::Tag) do
+          cattr_accessor :tagged_class
+        end
+        klass.tagged_class = self
+        klass.store_in collection: "#{self.name.underscore}_tags"
+        Object.const_set "#{self.name}Tag", klass
+        self.tag_class = "#{self.name}Tag".constantize
+      end
+
+      module ClassMethods
+
+        def rename_tag!(old_tag, new_tag)
+          self.collection.where({ tags: old_tag }).update({ '$addToSet' => { tags: new_tag }}, multi: true)
+          self.remove_tag!(old_tag)
+        end
+
+        def remove_tag!(tag_name)
+          self.collection.where({ tags: tag_name }).update({'$pull' => { tags: tag_name}}, multi: true)
+        end
+
+      end
+
+      private
+
+      def _update_tags!
+        return unless tags_changed?
+        before = (tags_was || [])
+        after = (tags || [])
+        # added tags
+        (after - before).each do |tag|
+          next unless tag && tag.length > 0
+          self.tag_class.collection.find(
+            name: tag,
+            _type: self.tag_class.name
+          ).upsert(
+            "$inc" => { count: 1 }
+          )
+        end
+        # removed tags
+        (before - after).each do |tag|
+          next unless tag && tag.length > 0
+          self.tag_class.collection.find(
+            name: tag,
+            _type: self.tag_class.name
+          ).upsert(
+            "$inc" => { count: -1 }
+          )
+        end
+      end
+
+      def _destroy_tags!
+        tags.each do |tag|
+          next unless tag && tag.length > 0
+          self.tag_class.collection.find(
+            name: tag,
+            _type: self.tag_class.name
+          ).upsert(
+            "$inc" => { count: -1 }
+          )
+        end
+      end
+
+    end
+  end
+end

data/lib/mongoid-tag-collectible/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module TagCollectible
+    VERSION = '0.1.0'
+  end
+end

data/lib/mongoid_tag_collectible.rb

@@ -0,0 +1 @@
+require 'mongoid-tag-collectible'

data/mongoid-tag-collectible.gemspec

@@ -0,0 +1,18 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'mongoid-tag-collectible/version'
+
+Gem::Specification.new do |s|
+  s.name = "mongoid-tag-collectible"
+  s.version = Mongoid::TagCollectible::VERSION
+  s.authors = [ "Daniel Doubrovkine" ]
+  s.email = "dblock@dblock.org"
+  s.platform = Gem::Platform::RUBY
+  s.required_rubygems_version = '>= 1.3.6'
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = [ "lib" ]
+  s.homepage = "http://github.com/dblock/mongoid-tag-collectible"
+  s.licenses = [ "MIT" ]
+  s.summary = "Easily maintain a collection of Tag instances with aggregate counts from your model's tags."
+  s.add_dependency "mongoid", ">= 3.0.0"
+  s.add_dependency "activesupport"
+end

data/spec/config/mongoid.yml

@@ -0,0 +1,9 @@
+test:
+  sessions:
+    default:
+      database: mongoid-tag-collectible
+      hosts:
+        - localhost:27017
+      options:
+        raise_not_found_error: false
+        safe: true

data/spec/mongoid-tag-collectible/tag_spec.rb

@@ -0,0 +1,126 @@
+# coding: utf-8
+require 'spec_helper'
+
+describe Mongoid::TagCollectible::Tag do
+  describe "tag" do
+    it "stores tags in a collection name defined by the class" do
+      TestTaggedTag.collection.name.should == "test_tagged_tags"
+    end
+  end
+  describe "without tags" do
+    it "generates no entries in 'tags' when tags is nil" do
+      TestTagged.create!
+      TestTaggedTag.all.size.should == 0
+    end
+    it "generates no entries in 'tags' when tags is empty" do
+      TestTagged.create!(tags: [])
+      TestTaggedTag.all.size.should == 0
+    end
+    it "generates no entries in 'tags' when tags contains an empty or nil value" do
+      TestTagged.create!(tags: ["", nil])
+      TestTaggedTag.all.size.should == 0
+    end
+  end
+  describe "with tags" do
+    it "find by id" do
+      TestTagged.create!(tags: ['one'])
+      TestTaggedTag.find(TestTaggedTag.first.id).should be_a TestTaggedTag
+    end
+    it "find by tag" do
+      TestTagged.create!(tags: ['one'])
+      TestTaggedTag.find('one').should be_a TestTaggedTag
+    end
+    it "generates a tags collection that is case-sensitive" do
+      TestTagged.create!(tags: ['one'])
+      TestTagged.create!(tags: ['One'])
+      TestTagged.create!(name: "whatever")
+      TestTaggedTag.count.should == 2
+    end
+    it "generates a tags collection with the tag with several tags" do
+      TestTagged.create!(tags: ["one"])
+      TestTagged.create!(tags: ["one", "two"])
+      tags = TestTaggedTag.all.desc(:count)
+      tags.size.should == 2
+      tags[0].name.should == "one"
+      tags[0].count.should == 2
+      tags[1].name.should == "two"
+      tags[1].count.should == 1
+    end
+    it "prevents duplicates" do
+      TestTaggedTag.create!(name: "one")
+      expect { TestTaggedTag.create!(name: "one") }.to raise_error Moped::Errors::OperationFailure, /duplicate key error/
+    end
+  end
+  describe "incrementally" do
+    before(:each) do
+      @instance1 = TestTagged.create!(tags: ["one"])
+      @instance2 = TestTagged.create!(tags: ["one", "two"])
+      @tags_before = TestTaggedTag.all.desc(:count)
+    end
+    it "increments an existing tag by 1 when a tagged instance is added" do
+      TestTagged.create!(tags: ["one", "two", "three"])
+      tags_after = TestTaggedTag.all.desc(:count)
+      tags_after.size.should == 3
+      # 'one'
+      tags_after[0].id.should == @tags_before[0].id
+      tags_after[0].name.should == "one"
+      tags_after[0].count.should == 3
+      # 'two'
+      tags_after[1].id.should == @tags_before[1].id
+      tags_after[1].name.should == "two"
+      tags_after[1].count.should == 2
+      # 'three'
+      tags_after[2].name.should == "three"
+      tags_after[2].count.should == 1
+    end
+    it "decrements an existing tag by 1 and removes tags with zero when a tagged instance is removed" do
+      @instance2.destroy
+      tags_after = TestTaggedTag.all.desc(:count)
+      tags_after.size.should == 2
+      tags_after[0].id.should == @tags_before[0].id
+      tags_after[0].name.should == "one"
+      tags_after[0].count.should == 1
+      tags_after[1].id.should == @tags_before[1].id
+      tags_after[1].name.should == "two"
+      tags_after[1].count.should == 0
+    end
+  end
+  describe "renaming" do
+    it "renames all instances of tag" do
+      instance = TestTagged.create!(tags: ['one'])
+      TestTaggedTag.where(name: 'one').first.update_attributes!(name: 'two')
+      instance.reload.tags.should == ['two']
+      TestTaggedTag.count.should == 1
+    end
+    it "avoids duplicate tags when renaming to an existing tag" do
+      instance = TestTagged.create!(tags: ['one', 'two'])
+      TestTaggedTag.where(name: 'one').first.update_attributes!(name: 'two')
+      TestTaggedTag.count.should == 1
+      instance.reload.tags.should == ['two']
+    end
+    it "preserves renamed tags when TestTaggedTag.update! is called" do
+      instance1 = TestTagged.create!(tags: ['one', 'two'])
+      instance2 = TestTagged.create!(tags: ['two'])
+      instance3 = TestTagged.create!(tags: ['one'])
+      TestTaggedTag.where(name: 'one').first.update_attributes!(name: 'two')
+      [instance1, instance2, instance3].each{ |a| a.reload.tags.should == ['two'] }
+      TestTaggedTag.where(name: 'two').count.should == 1
+      TestTaggedTag.where(name: 'one').count.should == 0
+      [instance1, instance2, instance3].each{ |a| a.reload.tags.should == ['two'] }
+      TestTaggedTag.where(name: 'two').count.should == 1
+      TestTaggedTag.where(name: 'one').count.should == 0
+    end
+  end
+  describe "instances" do
+    it "returns all matching tagged instances" do
+      TestTagged.create!(tags: ['one'])
+      TestTagged.create!(tags: ['one'])
+      tag = TestTaggedTag.first
+      tag.tagged.count.should == 2
+      tag.tagged.each { |a| a.should be_a TestTagged }
+    end
+    it "returns a non-nil result if there are no matching tagged instances" do
+      TestTaggedTag.new.tagged.count.should == 0
+    end
+  end
+end

data/spec/mongoid-tag-collectible/tagged_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Mongoid::TagCollectible::Tagged do
+  let(:instance) { TestTagged.create! }
+  describe "tag_class" do
+    it "defines tag_class" do
+      instance.class.tag_class.should == TestTaggedTag
+    end
+  end
+  describe "rename_tag" do
+    context "doesn't match an existing tag" do
+      it "is the same" do
+        old_tags = instance.class.all.map{ |a| a.tags }
+        instance.class.rename_tag! 'Yellow', 'yellow'
+        instance.class.all.map{ |a| a.tags }.should eq old_tags
+      end
+    end
+    context "matches an existing tag" do
+      it "is different" do
+        instance.tags = [ 'Yellow', 'Mellow' ]
+        instance.save!
+        old_tags = instance.class.all.map{ |a| a.tags }
+        instance.class.rename_tag! 'Yellow', 'Blue'
+        instance.class.all.map{ |a| a.tags }.should_not eq old_tags
+        instance.reload.tags.should include 'Blue'
+        instance.tags.should include 'Mellow'
+        instance.tags.should_not include 'Yellow'
+      end
+    end
+  end
+  describe "remove_tag!" do
+    it "deletes tag" do
+      instance.tags = [ 'Yellow', 'Mellow' ]
+      instance.save!
+      instance.class.remove_tag!('Yellow')
+      instance.class.find(instance.id).tags.should == [ 'Mellow' ]
+    end
+  end
+end

data/spec/mongoid-tag-collectible/version_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Mongoid::TagCollectible do
+  it "has a version" do
+    Mongoid::TagCollectible::VERSION.should_not be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'rspec'
+require 'mongoid-tag-collectible'
+
+require 'support/mongoid'
+require 'support/test_tagged'

data/spec/support/mongoid.rb

@@ -0,0 +1,16 @@
+ENV["MONGOID_ENV"] = "test"
+
+Mongoid.load! "spec/config/mongoid.yml"
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Mongoid.purge!
+    TestTagged.tag_class.index_options.each_pair do |name, options|
+      TestTagged.tag_class.collection.indexes.create(name, options)
+    end
+  end
+  config.after(:all) do
+    Mongoid.default_session.drop
+  end
+end
+

data/spec/support/test_tagged.rb

@@ -0,0 +1,5 @@
+class TestTagged
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  include Mongoid::TagCollectible::Tagged
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-tag-collectible
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Daniel Doubrovkine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: dblock@dblock.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- examples/readme.rb
+- lib/mongoid-tag-collectible.rb
+- lib/mongoid-tag-collectible/tag.rb
+- lib/mongoid-tag-collectible/tagged.rb
+- lib/mongoid-tag-collectible/version.rb
+- lib/mongoid_tag_collectible.rb
+- mongoid-tag-collectible.gemspec
+- spec/config/mongoid.yml
+- spec/mongoid-tag-collectible/tag_spec.rb
+- spec/mongoid-tag-collectible/tagged_spec.rb
+- spec/mongoid-tag-collectible/version_spec.rb
+- spec/spec_helper.rb
+- spec/support/mongoid.rb
+- spec/support/test_tagged.rb
+homepage: http://github.com/dblock/mongoid-tag-collectible
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3407508302417476120
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Easily maintain a collection of Tag instances with aggregate counts from
+  your model's tags.
+test_files: []