mongoid_tag 0.0.1

data/Gemfile

@@ -0,0 +1,21 @@
+source 'http://rubygems.org'
+
+gem 'mongoid', '~> 2.1.0'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+
+group :development do
+
+  gem 'database_cleaner'
+  gem 'bson', '~> 1.3.0'
+  gem 'bson_ext', '~> 1.3.0'
+  gem 'rspec', '~> 2.3.0'
+  gem 'yard', '~> 0.6.0'
+  gem 'bundler', '~> 1.0.0'
+  gem 'jeweler', '~> 1.5.2'
+  gem 'rcov', '>= 0'
+  gem 'reek', '~> 1.2.8'
+  gem 'roodi', '~> 2.1.0'
+
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Christian Hager
+
+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.rdoc

@@ -0,0 +1,34 @@
+= Mongoid Tag
+
+This gem is heaviliy influenced by Aaron Qians mongoid_taggable_with_context gem. I needed a way to tag a model and let a contextual scope of that model hold meta-data about the tags.
+
+In example: when I tag a product with "nice", I wanted the products category to know how many products was tagged with "nice". I also wanted to store additional data about this tag such as color (i.e colored labels on gmail.)
+
+Since I have never written a gem before, this is also an attempt to do so and learn from it.
+
+== Usage
+
+  class Product
+    include Mongoid::Document
+    include Mongoid::Tag
+    belongs_to :category
+    tag :tags, :meta_in => :category
+  end
+
+  class Category
+    include Mongoid::Document
+    include Mongoid::Tag::Meta
+    tag_meta_for :tags
+  end
+
+  @c = Category.create
+  @product = Product.create(:tags => "new, expensive", :category => @c)
+
+  @product.tags => ["new", "expensive"]
+
+  @category.tags_with_weight => [["new", 1], ["expensive", 1]]
+
+  @category.add_tag("on sale", {:color => "#a2a2a2"}) #add any meta you want
+
+  @category.tags_with_meta => [["new", {:count => 1}], ["expensive", {:count => 1}], ["on sale", {:count => 0, :color => "#a2a2a2"}]]
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/init.rb

@@ -0,0 +1 @@
+require 'mongoid_tag'

data/lib/mongoid_tag.rb

@@ -0,0 +1,3 @@
+require 'mongoid_tag/tag'
+require 'mongoid_tag/meta'
+require 'mongoid_tag/meta_tag'

data/lib/mongoid_tag/meta.rb

@@ -0,0 +1,75 @@
+module Mongoid
+  module Tag
+    module Meta
+      extend ActiveSupport::Concern
+
+      included do
+        embeds_many :meta_tags, :as => :meta_tagable, :class_name => "Mongoid::Tag::MetaTag"
+      end
+
+      module ClassMethods
+
+        def tagmeta_for(*args)
+          field_name = (args.blank? ? :tags : args.shift).to_sym
+
+          class_eval %(
+            def #{field_name}_with_weight
+              get_weights_for(:#{field_name})
+            end
+
+            def #{field_name}_with_meta
+              get_meta_for(:#{field_name})
+            end
+
+            def add_#{field_name.to_s.chop.to_sym}(tag, meta={})
+              add_meta_tag(:#{field_name}, tag, meta)
+            end
+          )
+        end
+      end
+
+      module InstanceMethods
+        def get_weights_for(context)
+          meta_tags.where(:context => context).map{|tag| [tag.name, tag.count]}
+        end
+
+        def get_meta_for(context)
+          meta_tags.where(:context => context).map{|tag| [tag.name, tag.meta.merge(:count => tag.count)]}
+        end
+
+        def update_meta_tags(context, added=nil, removed=nil)
+          add_meta_tags(context, added) if added
+          remove_meta_tags(context, removed) if removed
+          save
+        end
+
+        def add_meta_tag(context, tag, meta)
+          old_tag = self.meta_tags.where(:name => tag, :context => context).first
+          if old_tag
+            old_tag.meta.merge!(meta)
+          else
+            self.meta_tags << MetaTag.new(:name => tag, :count => 1, :context => context, :meta => meta)
+          end
+        end
+
+        def add_meta_tags(context, tags)
+          tags.each do |tag|
+            old_tag = self.meta_tags.where(:name => tag, :context => context).first
+            if old_tag
+              old_tag.count += 1
+            else
+              self.meta_tags << MetaTag.new(:name => tag, :count => 1, :context => context)
+            end
+          end
+        end
+
+        def remove_meta_tags(context, tags)
+          tags.each do |tag|
+            old_tag = self.meta_tags.where(:name => tag, :context => context).first
+            old_tag.count -= 1 if old_tag
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid_tag/meta_tag.rb

@@ -0,0 +1,12 @@
+module Mongoid
+  module Tag
+    class MetaTag
+      include Mongoid::Document
+      field :name, :type => String
+      field :count, :type => Integer, :default => 0
+      field :context
+      field :meta, :type => Hash, :default => {}
+      embedded_in :meta_tagable, :polymorphic => true
+    end
+  end
+end

data/lib/mongoid_tag/tag.rb

@@ -0,0 +1,121 @@
+module Mongoid
+  module Tag
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :tagify_options
+      self.tagify_options = {}
+      after_save :update_meta_model
+      after_destroy :decrement_all_in_meta_model
+    end
+
+    module ClassMethods
+      def tag(*args)
+        options = args.extract_options!
+        field_name = (options.empty? ? :tags : args.shift).to_sym
+        array_field = "#{field_name}_array".to_sym
+
+        #set default options
+        options.reverse_merge!({
+          :array_field => array_field
+        })
+
+        # register / update settings
+        class_options = tagify_options || {}
+        class_options[field_name] = options
+        self.tagify_options = class_options
+
+        #create fields
+        field field_name, :type => String, :default => ""
+        field array_field, :type => Array, :default => []
+
+        #class methods
+        class_eval %(
+          class << self
+            def with_any_#{field_name}(tags)
+              any_in(:#{array_field} => tags.to_a)
+            end
+
+            def with_all_#{field_name}(tags)
+              all_in(:#{array_field} => tags.to_a)
+            end
+
+            def without_#{field_name}(tags)
+              not_in(:#{array_field} => tags.to_a)
+            end
+          end
+        )
+
+        #instance methods
+        class_eval %(
+          def #{field_name}=(s)
+            super
+            write_attribute(:#{array_field}, convert_string_to_array(s))
+          end
+
+          def #{array_field}=(a)
+            super
+            write_attribute(:#{field_name}, convert_array_to_string(a))
+          end
+        )
+
+      end
+    end
+
+    module InstanceMethods
+
+      attr :current_context
+
+      def convert_string_to_array(s)
+        s.split(",").map(&:strip)
+      end
+
+      def convert_array_to_string(a)
+        a.map(&:strip).join(", ")
+      end
+
+      def tag_contexts
+        tagify_options.keys
+      end
+
+      def tags_for_context
+        send("#{@current_context}_array".to_sym)
+      end
+
+      def context_has_meta_model?
+        !tagify_options[@current_context][:meta_in].blank?
+      end
+
+      def context_meta_model
+        send(tagify_options[@current_context][:meta_in])
+      end
+
+      def context_is_changed?
+        !changes[@current_context.to_s].blank?
+      end
+
+      def context_added_tags
+        tags_for_context - changes[@current_context.to_s][0].split(",").map(&:strip)
+      end
+
+      def context_removed_tags
+         changes[@current_context.to_s][0].split(",").map(&:strip) - tags_for_context
+      end
+
+      def update_meta_model
+        tag_contexts.each do |context|
+          @current_context = context
+          if context_is_changed? && context_has_meta_model?
+            context_meta_model.update_meta_tags(context, context_added_tags, context_removed_tags)
+          end
+        end
+      end
+
+      def decrement_all_in_meta_model
+        tag_contexts.each do |context|
+          context_meta_model.update_meta_tags(context, nil, tags_for_context)
+        end
+      end
+    end
+  end
+end

data/mongoid_tag.gemspec

@@ -0,0 +1,60 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mongoid_tag/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mongoid_tag"
+  s.version     = MongoidTag::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Christian Hager"]
+  s.email       = ["christian@rondeventure.com"]
+  s.homepage    = %q{http://github.com/aq1018/mongoid_taggable_with_context}
+  s.summary = %q{Mongoid tagging with scope and meta}
+  s.description = %q{Mongoid tagging gem that holds meta about tags in a scoped context.}
+
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+
+  s.rubygems_version = %q{1.6.2}
+
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+
+  s.files = [
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "init.rb",
+    "lib/mongoid_tag/tag.rb",
+    "lib/mongoid_tag/meta.rb",
+    "lib/mongoid_tag/meta_tag.rb",
+    "lib/mongoid_tag.rb",
+    "mongoid_tag.gemspec",
+    "spec/mongoid_tag_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  s.test_files = [
+    "spec/mongoid_tag_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  s.add_development_dependency(%q<database_cleaner>, [">= 0"])
+  s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+  s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+  s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+  s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+  s.add_development_dependency(%q<rcov>, [">= 0"])
+  s.add_development_dependency(%q<reek>, ["~> 1.2.8"])
+  s.add_development_dependency(%q<roodi>, ["~> 2.1.0"])
+
+  s.add_dependency(%q<mongoid>, ["~> 2.1.0"])
+  s.add_dependency(%q<bson>, ["~> 1.3.0"])
+  s.add_dependency(%q<bson_ext>, ["~> 1.3.0"])
+  s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+
+end

data/spec/mongoid_tag_spec.rb

@@ -0,0 +1,139 @@
+require 'spec_helper'
+
+class Product
+  include Mongoid::Document
+  include Mongoid::Tag
+  
+  tag :tags
+end
+
+class ProductWithCategory
+  include Mongoid::Document
+  include Mongoid::Tag
+  
+  belongs_to :category
+  
+  tag :tags, :meta_in => :category
+end
+
+class Category
+  include Mongoid::Document
+  include Mongoid::Tag::Meta
+  
+  has_many :products
+  
+  tagmeta_for :tags
+end
+
+
+describe Mongoid::Tag do
+  
+  describe "tagged object" do
+    before(:each) do
+      @p1 = Product.new
+      @p2 = Product.new
+    end
+    
+    it "should create a tags_array" do
+      @p1.tags = "new, blue"
+      @p1.tags_array.should == ["new", "blue"]
+    end
+    
+    it "should create a string from array" do
+      @p1.tags_array = ["new", "blue"]
+      @p1.tags.should == "new, blue"
+    end
+    
+    it "should wash away whitespace" do
+      @p1.tags = "new      ,       blue"
+      @p1.tags_array.should == ["new", "blue"]
+      @p1.tags_array = ["new     ", "     blue"]
+      @p1.tags.should == "new, blue"
+    end
+  end
+  
+  describe "scopes" do
+    before(:each) do
+      @p1 = Product.create
+      @p2 = Product.create
+    end
+    
+    it "finds all models tagged with one or more tags" do
+      @p1.tags = "new, green"
+      @p2.tags = "new, blue"
+      @p1.save; @p2.save;
+      Product.with_any_tags("new").to_a.should == [@p1, @p2]
+      Product.with_any_tags("green").to_a.should == [@p1]
+      Product.with_any_tags("blue").to_a.should == [@p2]
+      Product.with_any_tags(["new", "blue"]).to_a.should == [@p1, @p2]
+    end
+    
+    it "finds all models tagged with one or more tags" do
+      @p1.tags = "new, green"
+      @p2.tags = "new, blue"
+      @p1.save; @p2.save;
+      Product.with_all_tags("new").to_a.should == [@p1, @p2]
+      Product.with_all_tags("green").to_a.should == [@p1]
+      Product.with_all_tags("blue").to_a.should == [@p2]
+      Product.with_all_tags(["new", "blue"]).to_a.should == [@p2]
+    end
+    
+    it "fonds all models not tagged with one or more tags" do
+      @p1.tags = "new, green"
+      @p2.tags = "new, blue"
+      @p1.save; @p2.save;
+      Product.without_tags("new").to_a.should == []
+      Product.without_tags("green").to_a.should == [@p2]
+      Product.without_tags("blue").to_a.should == [@p1]
+      Product.without_tags(["new", "blue"]).to_a.should == []
+    end
+  end
+end
+
+
+describe Mongoid::Tag::Meta do
+  
+  before(:each) do
+    @c = Category.create
+    @p = ProductWithCategory.create(:category => @c)
+    @p2 = ProductWithCategory.create(:category => @c)
+  end
+  
+  it "should increase count when a a child is tagged" do
+    @p.update_attributes(:tags => "new, blue")
+    @c.tags_with_weight.should == [["new", 1], ["blue", 1]]
+    @p2.update_attributes(:tags => "blue")
+    @c.tags_with_weight.should == [["new", 1], ["blue", 2]]
+    @p2.update_attributes(:tags => "blue, green")
+    @c.tags_with_weight.should == [["new", 1], ["blue", 2], ["green", 1]]
+  end
+  
+  it "should decrease count when a tag is removed" do
+    @p.update_attributes(:tags => "new, blue")
+    @c.tags_with_weight.should == [["new", 1], ["blue", 1]]
+    @p.update_attributes(:tags => "new")
+    @c.tags_with_weight.should == [["new", 1], ["blue", 0]]
+  end
+  
+  it "should decrease count when a child is destroyed" do
+    @p.update_attributes(:tags => "new, blue")
+    @c.tags_with_weight.should == [["new", 1], ["blue", 1]]
+    @p.destroy
+    @c.tags_with_weight.should == [["new", 0], ["blue", 0]]
+  end
+  
+  it "can get the meta for all tags" do
+    @c.add_tag("cheap", {:color => "red"})
+    @c.tags_with_meta.should == [["cheap", {:color=>"red", :count=>1}]]
+    @c.add_tag("expensive", {:color => "green"})
+    @c.add_tag("medium", {:color => "#ddd"}) 
+    @c.tags_with_meta.should == [["cheap", {:color=>"red", :count=>1}], ["expensive", {:color=>"green", :count=>1}], ["medium", {:color=>"#ddd", :count=>1}]]
+  end
+  
+  it "can update meta for a tag" do
+    @c.add_tag("cheap", {:color => "red"})
+    @c.tags_with_meta.should == [["cheap", {:color=>"red", :count=>1}]]
+    @c.add_tag("cheap", {:color => "blue"})
+    @c.tags_with_meta.should == [["cheap", {:color=>"blue", :count=>1}]]
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'mongoid'
+require 'mongoid_tag.rb'
+require 'database_cleaner'
+
+RSpec.configure do |config|
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+
+end
+
+Mongoid.configure do |config|
+  config.skip_version_check = true
+  config.master = Mongo::Connection.new.db("mongoid_tag_test")
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_tag
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Christian Hager
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-07 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: &2160316240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2160316240
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2160315400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *2160315400
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2160314720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *2160314720
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2160314060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2160314060
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2160313440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *2160313440
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &2160312720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2160312720
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: &2160311160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+  type: :development
+  prerelease: false
+  version_requirements: *2160311160
+- !ruby/object:Gem::Dependency
+  name: roodi
+  requirement: &2160310440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *2160310440
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: &2160309720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2160309720
+- !ruby/object:Gem::Dependency
+  name: bson
+  requirement: &2160309000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2160309000
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: &2160308280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2160308280
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2160307560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2160307560
+description: Mongoid tagging gem that holds meta about tags in a scoped context.
+email:
+- christian@rondeventure.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- lib/mongoid_tag/tag.rb
+- lib/mongoid_tag/meta.rb
+- lib/mongoid_tag/meta_tag.rb
+- lib/mongoid_tag.rb
+- mongoid_tag.gemspec
+- spec/mongoid_tag_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/aq1018/mongoid_taggable_with_context
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: Mongoid tagging with scope and meta
+test_files:
+- spec/mongoid_tag_spec.rb
+- spec/spec_helper.rb