minimal_tags 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3118809a99ce6d913ecca4bf1d8d22aaa03346b0
+  data.tar.gz: c983175357456a54692f580ebacc48f3fea2297b
+SHA512:
+  metadata.gz: 19132c49f3f729cc9fa755e7978cff8962a62e8ca6301c064f3d4540d510cdaa40070e07c86ef1b95b1e130e238a0ca2bfc9d6a271c7ba00d8b0e6203469da12
+  data.tar.gz: 091f14403dda0229c6c942af5036786683f34163c72fa9e35238c2ee61fa55182e21a6a5f7590e84c4091e424636a3e34bb61aaa5e680c0e5043b0e0e106ced3

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,15 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.2.3
+services:
+  - mongodb
+  - postgresql
+before_install:
+  - gem install bundler -v 1.10.6
+before_script:
+  - psql -c 'create database minimal_tags;' -U postgres
+addons:
+  code_climate:
+    repo_token: 3c954617ba40beceb056cc73b82e00a6dc1fa2193cda386dc6c2128bdd61a804

data/Gemfile

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

data/README.md

@@ -0,0 +1,73 @@
+[![Build Status](https://travis-ci.org/harrisbaird/minimal_tags.svg?branch=master)](https://travis-ci.org/harrisbaird/minimal_tags)
+[![Code Climate](https://codeclimate.com/github/harrisbaird/minimal_tags/badges/gpa.svg)](https://codeclimate.com/github/harrisbaird/minimal_tags)
+[![Test Coverage](https://codeclimate.com/github/harrisbaird/minimal_tags/badges/coverage.svg)](https://codeclimate.com/github/harrisbaird/minimal_tags/coverage)
+[![Inline docs](http://inch-ci.org/github/harrisbaird/minimal_tags.svg?branch=master)](http://inch-ci.org/github/harrisbaird/minimal_tags)
+
+---
+
+# MinimalTags
+
+MinimalTags is a tiny gem for adding tagging support to [Mongoid](https://github.com/mongodb/mongoid)  and ActiveRecord (Currently only Postgresql).
+
+Multiple tag fields can be used, each with their own way of formatting.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'minimal_tags'
+```
+
+### Mongoid
+There is nothing else to add, fields will be created when you define your tag fields.
+
+### ActiveRecord
+
+Add the following migration for each tag field you want.
+
+```ruby
+class AddTagsToPosts < ActiveRecord::Migration
+  def change
+    add_column :posts, :tags, :text, default: [], null: false, array: true
+    add_index :posts, :tags, using: :gin
+  end
+end
+
+```
+
+## Usage
+
+Start by including the `MinimalTags` module and define your tag fields
+with the `tag_field` method.
+
+```ruby
+class Document
+  include Mongoid::Document
+  include 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 and can be chained:
+`.any_*`, `.all_*`
+
+```ruby
+Document.any_tags(['a', 'b', 'c'])
+Document.all_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/minimal_tags.rb

@@ -0,0 +1,24 @@
+require 'minimal_tags/simple_formatter'
+require 'minimal_tags/version'
+
+module MinimalTags
+  class << self
+    attr_writer :default_formatter
+
+    def included(base)
+      ancestors = base.ancestors.collect(&:to_s)
+
+      if ancestors.include?('Mongoid::Document')
+        require 'minimal_tags/persistence/mongoid'
+        base.send :extend, Persistence::Mongoid
+      elsif ancestors.include?('ActiveRecord::Base')
+        require 'minimal_tags/persistence/activerecord'
+        base.send :extend, Persistence::Activerecord
+      end
+    end
+
+    def default_formatter
+      @default_formatter ||= SimpleFormatter.new
+    end
+  end
+end

data/lib/minimal_tags/persistence/activerecord.rb

@@ -0,0 +1,44 @@
+module MinimalTags
+  module Persistence
+    module Activerecord
+      TAG_SEARCH_TYPES = {
+        all: '@>',
+        any: '&&'
+      }
+
+      ##
+      # Creates a tag field, index, search methods and a callback for tag
+      # normalization on save.
+      #
+      # @example
+      #   class Posts < ActiveRecord::Base
+      #     include MinimalTags
+      #
+      #     tag_field :tags
+      #   end
+      #
+      #   doc = Posts.create(tags: ['hello world', 'this is a test']).tags
+      #   # => ['hello-world', 'this-is-a-test']
+      #
+      #   doc == Posts.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)
+        # Create the scopes for searching tags
+        TAG_SEARCH_TYPES.each do |prefix, operator|
+          scope "#{prefix}_#{field_name}", lambda { |tags|
+            where("#{field_name} #{operator} ARRAY[?]::varchar[]", 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/minimal_tags/persistence/mongoid.rb

@@ -0,0 +1,48 @@
+module MinimalTags
+  module Persistence
+    module Mongoid
+      TAG_SEARCH_TYPES = {
+        all: 'all',
+        any: 'in'
+      }
+
+      ##
+      # Creates a tag field, index, search methods and a callback for tag
+      # normalization on save.
+      #
+      # @example
+      #   class Posts
+      #     include Mongoid::Document
+      #     include MinimalTags
+      #
+      #     tag_field :tags
+      #   end
+      #
+      #   doc = Posts.create(tags: ['hello world', 'this is a test']).tags
+      #   # => ['hello-world', 'this-is-a-test']
+      #
+      #   doc == Posts.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
+        TAG_SEARCH_TYPES.each do |prefix, type|
+          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/minimal_tags/simple_formatter.rb

@@ -0,0 +1,15 @@
+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

data/lib/minimal_tags/version.rb

@@ -0,0 +1,3 @@
+module MinimalTags
+  VERSION = '0.2.0'
+end

data/minimal_tags.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'minimal_tags/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'minimal_tags'
+  spec.version       = MinimalTags::VERSION
+  spec.authors       = ['harrisbaird']
+  spec.email         = ['mydancake@gmail.com']
+
+  spec.summary       = 'Simple tag fields for ActiveRecord and Mongoid.'
+  spec.description   = 'Simple tag fields for ActiveRecord and Mongoid.'
+  spec.homepage      = 'https://github.com/harrisbaird/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_development_dependency 'mongoid', '>= 4.0.0', '<= 6.0.0'
+  spec.add_development_dependency 'activerecord', '>= 4.0.0', '<= 6.0.0'
+  spec.add_development_dependency 'pg'
+
+  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 'codeclimate-test-reporter'
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: minimal_tags
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- harrisbaird
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-09 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: :development
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :development
+  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: pg
+  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: 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: 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 ActiveRecord and Mongoid.
+email:
+- mydancake@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/minimal_tags.rb
+- lib/minimal_tags/persistence/activerecord.rb
+- lib/minimal_tags/persistence/mongoid.rb
+- lib/minimal_tags/simple_formatter.rb
+- lib/minimal_tags/version.rb
+- minimal_tags.gemspec
+homepage: https://github.com/harrisbaird/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.5.0
+signing_key: 
+specification_version: 4
+summary: Simple tag fields for ActiveRecord and Mongoid.
+test_files: []
+has_rdoc: