mongoid-minimal_tags 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 65a1888231645e34885a1f4082681d4c1cd96202
+  data.tar.gz: 834fb1a17e0de8257cebb2abbd26e13e7c191e74
+SHA512:
+  metadata.gz: f2192f50bbbd799cc2b626a75d10527ffa9ec6d6838a2debdf171eb64ca2f2ac8723b5ba44142ba1321d7d347a78a6c22f311acfe239d0a00603f7c3723fcb2a
+  data.tar.gz: e8807d5f6620ba81afef2e6af5eb313f73ef757cad2f01108082dc46269f035e9d1a0bb78799945421f52d88f000efee35a5888ec62a2a225e44a2d1b2a5b34a

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+test/coverage

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.2.3
+services:
+  - mongodb
+before_install: gem install bundler -v 1.10.6
+addons:
+  code_climate:
+    repo_token: 32212930c3d28b5f18f53b94b273de85659924850fc07c007ed87b852437c687

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,58 @@
+[![Build Status](https://travis-ci.org/harrisbaird/mongoid-minimal_tags.svg?branch=master)](https://travis-ci.org/harrisbaird/mongoid-minimal_tags)
+[![Code Climate](https://codeclimate.com/github/harrisbaird/mongoid-minimal_tags/badges/gpa.svg)](https://codeclimate.com/github/harrisbaird/mongoid-minimal_tags)
+[![Test Coverage](https://codeclimate.com/github/harrisbaird/mongoid-minimal_tags/badges/coverage.svg)](https://codeclimate.com/github/harrisbaird/mongoid-minimal_tags/coverage)
+[![Inline docs](http://inch-ci.org/github/harrisbaird/mongoid-minimal_tags.svg?branch=master)](http://inch-ci.org/github/harrisbaird/mongoid-minimal_tags)
+
+---
+
+# Mongoid::MinimalTags
+
+Mongoid::MinimalTags is a tiny gem for adding tagging support to [Mongoid](https://github.com/mongodb/mongoid) documents.
+
+Multiple tag fields can be used, each with their own way of formatting.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'mongoid-minimal_tags'
+```
+
+## Usage
+
+Start by including the `Mongoid::MinimalTags` module and define your tag fields
+with the `tag_field` method.
+
+```ruby
+class Document
+  include Mongoid::Document
+  include Mongoid::MinimalTags
+
+  tag_field :tags
+  tag_field :upcase_tags, formatter: UpcaseFormatter.new
+end
+```
+
+You can define multiple tag fields, just ensure they have unique names.  
+Formatters can be defined on each tag field if needed, otherwise the default be used.
+
+## Searching
+The following scopes are also added for each tag field:
+`.any_*`, `.all_*`, `.without_any_*`  
+All scopes return a `Mongoid::Criteria` and can be chained.
+
+```ruby
+Document.any_tags(['a', 'b', 'c'])
+Document.all_tags(['a', 'b', 'c'])
+Document.without_any_tags(['a', 'b', 'c'])
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write your tests
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+require 'yard'
+YARD::Rake::YardocTask.new(:doc)
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/lib/mongoid/minimal_tags/minimal_tags.rb

@@ -0,0 +1,49 @@
+require 'mongoid'
+
+module Mongoid
+  module MinimalTags
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    module ClassMethods
+      ##
+      # Creates a tag field, index, search methods and a callback for tag
+      # normalization on save.
+      #
+      # @example
+      #   class Document
+      #     include Mongoid::Document
+      #     include Mongoid::MinimalTags
+      #
+      #     tag_field :tags
+      #   end
+      #
+      #   doc = Document.create(tags: ['hello world', 'this is a test']).tags
+      #   # => ['hello-world', 'this-is-a-test']
+      #
+      #   doc == Document.any_tags(['HELLO WORLD']).first
+      #   # => true
+      #
+      # @param [String] field_name The field name to use in mongo and searching methods
+      # @param [Object] formatter The formatter to use, overriding the default
+      def tag_field(field_name, formatter: MinimalTags.default_formatter)
+        field field_name, type: Array, default: []
+        index field_name => 1
+
+        # Create the scopes for searching tags
+        MinimalTags.search_types.each do |type, prefix|
+          scope "#{prefix}_#{field_name}", lambda { |tags|
+            criteria.send(type, field_name => formatter.normalize(tags))
+          }
+        end
+
+        # Normalize tags on save
+        set_callback(:save, :before) do
+          tags = read_attribute(field_name)
+          write_attribute(field_name, formatter.normalize(tags))
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/minimal_tags/simple_formatter.rb

@@ -0,0 +1,17 @@
+module Mongoid
+  module MinimalTags
+    # A very simple tag formatter using ActiveSupport's parameterize.
+    # You should create your own rather than using this.
+    class SimpleFormatter
+      ##
+      # Returns an array of normalized tags
+      #
+      # @param [Array] tags Tags to normalize
+      #
+      # @return [Array] Unique, parameterized tags
+      def normalize(tags)
+        tags.map(&:parameterize).uniq
+      end
+    end
+  end
+end

data/lib/mongoid/minimal_tags/version.rb

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

data/lib/mongoid/minimal_tags.rb

@@ -0,0 +1,25 @@
+require 'mongoid/minimal_tags/minimal_tags'
+require 'mongoid/minimal_tags/simple_formatter'
+require 'mongoid/minimal_tags/version'
+
+module Mongoid
+  module MinimalTags
+    class << self
+      attr_writer :default_formatter
+
+      DEFAULT_SEARCH_TYPES = {
+        all: 'all',
+        in: 'any',
+        nin: 'without_any'
+      }
+
+      def default_formatter
+        @default_formatter ||= SimpleFormatter.new
+      end
+
+      def search_types
+        @search_types ||= DEFAULT_SEARCH_TYPES
+      end
+    end
+  end
+end

data/mongoid-minimal_tags.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid/minimal_tags/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mongoid-minimal_tags'
+  spec.version       = Mongoid::MinimalTags::VERSION
+  spec.authors       = ['harrisbaird']
+  spec.email         = ['mydancake@gmail.com']
+
+  spec.summary       = 'Simple tag fields for mongodb documents.'
+  spec.description   = 'Simple tag fields for mongodb documents.'
+  spec.homepage      = 'https://github.com/harrisbaird/mongoid-minimal_tags'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'mongoid', '>= 4.0.0', '<= 6.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-minimal_tags
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- harrisbaird
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple tag fields for mongodb documents.
+email:
+- mydancake@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/mongoid/minimal_tags.rb
+- lib/mongoid/minimal_tags/minimal_tags.rb
+- lib/mongoid/minimal_tags/simple_formatter.rb
+- lib/mongoid/minimal_tags/version.rb
+- mongoid-minimal_tags.gemspec
+homepage: https://github.com/harrisbaird/mongoid-minimal_tags
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Simple tag fields for mongodb documents.
+test_files: []
+has_rdoc: