mongo_mapper_tagger 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f18a52122328c024458d2942c397475ff023fe3
+  data.tar.gz: 9ef72345a064a047f51433b8235e22e538fbc290
+SHA512:
+  metadata.gz: 5bdeff914b6bb0b2dc6127a176e82968d063b66170059d35a94a2eedaa94f570029fd198f6484d4f2b7eaffe8255518542c34e8e576bed761d8fd88b45c22751
+  data.tar.gz: b130fe1ce030aab75836c0592f067494d90e43d0f3c0bf049475c573eadf81743921aa41af6d708d98510abc4167e01e1e5b1d3d2ca0004e08b8c10363b9f11c

data/lib/mongo_mapper/plugins/mongo_mapper_tagger.rb

@@ -0,0 +1,76 @@
+# @author Dan Guilak
+
+require 'mongo_mapper'
+require 'set'
+
+module MongoMapper
+  module Plugins
+    module MongoMapperTagger
+      extend ActiveSupport::Concern
+
+      included do
+        has_many :tags, as: :mongo_taggable, class_name: "MongoMapper::Tag"
+      end
+
+      module ClassMethods
+        # Returns a query of all objects with a particular tag.
+        #
+        # @param tag [String] the tag to find
+        # @return [Plucky] the query of objects with that tag.
+        def by_tag(tag)
+          ids = MongoMapper::Tag.where(mongo_taggable_type: self.name, tag: tag).distinct(:mongo_taggable_id)
+
+          where(_id: { '$in': ids })
+        end
+      end
+
+      # Returns an array of strings of the current tags on the object.
+      #
+      # @return [Array] an array of strings representing the tags on an object.
+      def tag_list
+        tags.map(&:tag)
+      end
+
+      # Sets the tags on the object using (see #update_tags_from_list!)
+      #
+      # @param new_tag_list [String] the new delimiter-separated list of tags with which
+      #   to update the object.
+      def tag_list=(new_tag_list)
+        update_tags_from_list!(new_tag_list)
+      end
+
+      # Takes a new list of tags as a delimited string, adds and removes
+      # tags on the object as necessary in order to get the object tags to
+      # match the new list.
+      #
+      # @param new_tag_list [String] the new delimiter-separated list of tags with which
+      #    to update the object
+      # @param delimiter [String] the delimiter for new_tag_list (default comma)
+      def update_tags_from_list!(new_tag_list, delimiter=',')
+        old_tag_list = tag_list.to_set
+        new_tag_list = new_tag_list.split(delimiter).to_set
+
+        to_remove = (old_tag_list - new_tag_list).to_a
+        to_add = (new_tag_list - old_tag_list).to_a
+
+        to_remove.each { |tag| MongoMapper::Tag.remove_by_object_and_tag!(self, tag) }
+
+        to_add.each { |tag| MongoMapper::Tag.add_by_object_and_tag!(self, tag) }
+      end
+
+      # Removes a tag from the object.
+      #
+      # @param tag [String] the tag to remove from the object.
+      def remove_tag!(tag)
+        MongoMapper::Tag.remove_by_object_and_tag!(self, tag)
+      end
+
+      # Adds a tag to the object.
+      #
+      # @param tag [String] the tag to add to the object.
+      def add_tag!(tag)
+        MongoMapper::Tag.add_by_object_and_tag!(self, tag)
+      end
+    end
+  end
+end

data/lib/mongo_mapper/plugins/mongo_mapper_tagger/tag.rb

@@ -0,0 +1,114 @@
+# @author Dan Guilak
+
+class MongoMapper::Tag
+  class TagNotFound < StandardError; end
+
+  include MongoMapper::Document
+
+  key :tag, String, required: true
+
+  ensure_index :tag
+  ensure_index :mongo_taggable_type
+  ensure_index :mongo_taggable_id
+
+  belongs_to :mongo_taggable, polymorphic: true
+
+  validates_uniqueness_of :tag, scope: [ :mongo_taggable_id, :mongo_taggable_type ]
+
+  class << self
+    # Removes a tag by the type of the object, the id of the object, and the tag name.
+    # Raises an error if the tag wasn't found.
+    #
+    # @param taggable_type [String] the type (class name) of the object.
+    # @param taggable_id [String] the BSON ID of the object.
+    # @param tag_name [String] the name of the tag to remove.
+    def remove_by_type_and_id_and_tag!(taggable_type, taggable_id, tag_name)
+      success = remove_by_type_and_id_and_tag(taggable_type, taggable_id, tag_name)
+
+      raise TagNotFound unless success
+    end
+
+    # Removes a tag by the type of the object, the id of the object, and the tag name.
+    #
+    # @param taggable_type [String] the type (class name) of the object.
+    # @param taggable_id [String] the BSON ID of the object.
+    # @param tag_name [String] the name of the tag to remove.
+    # @return [Boolean] true if successful, false if not
+    def remove_by_type_and_id_and_tag(taggable_type, taggable_id, tag_name)
+      tag = first(mongo_taggable_type: taggable_type, mongo_taggable_id: taggable_id, tag: tag_name)
+
+      return false unless tag.present?
+
+      success = tag.destroy
+      success && success["ok"] == 1
+    end
+
+    # Adds a tag by the type of the object, the id of the object, and the tag name.
+    # Raises an error if the tag wasn't created successfully.
+    #
+    # @param taggable_type [String] the type (class name) of the object.
+    # @param taggable_id [String] the BSON ID of the object.
+    # @param tag_name [String] the name of the tag to add.
+    def add_by_type_and_id_and_tag!(taggable_type, taggable_id, tag_name)
+      create!(mongo_taggable_type: taggable_type, mongo_taggable_id: taggable_id, tag: tag_name)
+    end
+
+    # Adds a tag by the type of the object, the id of the object, and the tag name.
+    #
+    # @param taggable_type [String] the type (class name) of the object.
+    # @param taggable_id [String] the BSON ID of the object.
+    # @param tag_name [String] the name of the tag to add.
+    # @return [Boolean] true if successful, false if not
+    def add_by_type_and_id_and_tag(taggable_type, taggable_id, tag_name)
+      find_args = {
+        mongo_taggable_type: taggable_type,
+        mongo_taggable_id: taggable_id,
+        tag: tag_name,
+      }
+
+      # `create` will return the object if it finds it, rather than returning false.
+      if first(find_args).present?
+        return false
+      end
+
+      success = create(find_args)
+
+      success.present?
+    end
+
+    # Removes a tag on an object.
+    # Raises if the tag isn't found.
+    #
+    # @param object [Object] object from which to remove the tag
+    # @param tag_name [String] tag to remove from the object.
+    def remove_by_object_and_tag!(object, tag_name)
+      remove_by_type_and_id_and_tag!(object.class.name, object.id, tag_name)
+    end
+
+    # Removes a tag on an object.
+    #
+    # @param object [Object] object from which to remove the tag
+    # @param tag_name [String] tag to remove from the object.
+    # @return [Boolean] true if successful, false if not
+    def remove_by_object_and_tag(object, tag_name)
+      remove_by_type_and_id_and_tag(object.class.name, object.id, tag_name)
+    end
+
+    # Adds a tag on an object.
+    #
+    # @param object [Object] object from which to remove the tag
+    # @param tag_name [String] tag to add to the object.
+    def add_by_object_and_tag(object, tag_name)
+      add_by_type_and_id_and_tag(object.class.name, object.id, tag_name)
+    end
+
+    # Adds a tag on an object.
+    # Raises if the tag wasn't successfully created.
+    #
+    # @param object [Object] object on which to add the tag
+    # @param tag_name [String] tag to add to the object.
+    def add_by_object_and_tag!(object, tag_name)
+      add_by_type_and_id_and_tag!(object.class.name, object.id, tag_name)
+    end
+  end
+end

data/lib/mongo_mapper_tagger.rb

@@ -0,0 +1,9 @@
+require 'mongo_mapper'
+
+module MongoMapper
+  autoload :Tag, 'mongo_mapper/plugins/mongo_mapper_tagger/tag'
+
+  module Plugins
+    autoload :MongoMapperTagger, 'mongo_mapper/plugins/mongo_mapper_tagger'
+  end
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: mongo_mapper_tagger
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Dan Guilak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-04 00:00:00.000000000 Z
+dependencies: []
+description: Dead simple tagging for MongoMapper
+email: dan@learnup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mongo_mapper/plugins/mongo_mapper_tagger.rb
+- lib/mongo_mapper/plugins/mongo_mapper_tagger/tag.rb
+- lib/mongo_mapper_tagger.rb
+homepage: http://github.com/golearnup/mongo_mapper_tagger
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Dead simple tagging for MongoMapper
+test_files: []
+has_rdoc: