mongoid-tags 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc23706960b5dbdd4256df7b49a3d3627e8da8f3
-  data.tar.gz: e4290aff3b45355969dc1a7dc41e673478b9d9b1
+  metadata.gz: cddf6fe5b25717c93d1e89b7d9de37b80fb64464
+  data.tar.gz: fd6d7ec565cec4c463023284e10dbf4b33c771ea
 SHA512:
-  metadata.gz: c412f36d162f9ad8b0cb75931e8151445a4e38bf7c3929c99ce21c3d664983afb2751556d0eebb103230444c1ba787617b3f849a0b324ce926692a1bae930882
-  data.tar.gz: 794f323764521ee059f88eda133bcea5f3bba9902b8a2ab377fa12ac2ee54cbc1c2da104387d9258008cee9ca0fddd9ac064f6bb1d539e0a07e346ec8744347a
+  metadata.gz: bbbeb676b72c5e002f652b892a1adaad91d9a45702d700e092cf03fcccf66b378ec118917214683fd7fcacd11813b1146f8e40a32680397ac90d58b630a31e17
+  data.tar.gz: d49e6435a96626e5f4415c3595b318cbec2e3cd606e93f4727bd824d61bb40c096877852642889e1270eba77eaa44721154ce7039fb2246b9072eb5f640019bc

data/.yardopts

@@ -0,0 +1,7 @@
+--title "mongoid-tags"
+--charset utf-8
+--no-stats
+--no-api
+-
+README.md
+LICENSE.md

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# Not released
+* Adds subqueries. See README.md for examples.
+
 # 0.3.0 (February 12, 2014)
 * Use Rake::FileList.
 * Removes Gemfile warning.

data/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
-
 gemspec
 
 gem 'minitest'
 gem 'rake'
+gem 'yard'

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2012-2014 Mario Uher
+
+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

@@ -19,9 +19,7 @@ class Document
   include Mongoid::Document
   include Mongoid::Tags
 end
-```
 
-```ruby
 # Documents tagged foo || bar
 Document.tagged('foo bar')
 
@@ -30,9 +28,15 @@ Document.tagged('+foo bar')
 
 # Documents tagged foo, but !bar
 Document.tagged('foo -bar')
+
+# Documents tagged foo and bar or baz
+Document.tagged('(+foo +bar) baz')
+
+# Documents tagged foo and bar, or foo and baz
+Document.tagged('(+foo +bar)(+foo +baz)')
 ```
 
-Be sure to checkout spec/integration_spec.rb for more examples. By the way, `tagged` returns a `Mongoid::Criteria` object so you can chain it to your existing criteria, e.g: `Document.where(published: true).tagged('foo').desc(:created_at)`
+Be sure to checkout test/integration_test.rb for more examples. By the way, `tagged` returns a `Mongoid::Criteria` object so you can chain it to your existing criteria, e.g: `Document.where(published: true).tagged('foo').desc(:created_at)`
 
 ## Contributing
 
@@ -48,21 +52,4 @@ Be sure to checkout spec/integration_spec.rb for more examples. By the way, `tag
 
 Copyright (c) 2012-2014 Mario Uher
 
-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.
+See LICENSE.md.

data/Rakefile

@@ -1,3 +1,13 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+  Bundler.require
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+YARD::Rake::YardocTask.new(:doc)
+
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|

data/lib/mongoid/tags.rb

@@ -6,20 +6,45 @@ module Mongoid
   module Tags
     extend ActiveSupport::Concern
 
+    # @!attribute tags
+    #   @return [Array] all tags of the current document
     included do |base|
       field :tags, type: Array, default: []
       index tags: 1
     end
 
     module ClassMethods
+      ##
+      # Returns a hash representing a Mongoid criteria
+      # for the given tag query.
+      #
+      # @example
+      #   hash = Document.selector('foo bar')
+      #   hash # => {"tags"=>{"$in"=>["foo", "bar"]}}
+      #
+      # @param [String] query The query you're searching for
+      #
+      # @return [Hash] Hash which can be used as a Mongoid criteria
       def selector(query)
-        parser.parse(query).tap do |result|
-          raise Error, parser.failure_reason unless result
-        end.to_criteria
+        parsed_query = parser.parse(query)
+        raise Mongoid::Tags::Error, parser.failure_reason unless parsed_query
+
+        parsed_query.to_criteria
       end
 
+      ##
+      # Returns a chainable criteria for all documents
+      # found by the given tag query.
+      #
+      # @example
+      #   documents = Document.tagged('foo bar')
+      #   documents # all documents tagged foo OR bar
+      #
+      # @param [String] query The query you're searching for
+      #
+      # @return [Mongoid::Criteria] Mongoid criteria to retrieve all matching documents
       def tagged(query)
-        where(tags: selector(query))
+        where(selector(query))
       end
 
     private
@@ -28,37 +53,135 @@ module Mongoid
       end
     end
 
+    ##
+    # Representation class for a tag query, e.g. `foo bar`.
+    #
+    # @api private
     class Query < Treetop::Runtime::SyntaxNode
-      def to_criteria(tags = nil)
-        {}.tap do |criteria|
-          (tags.presence || elements).each do |tag|
-            (criteria[tag.operator.selector] ||= []) << tag.to_criteria if tag.is_a? Tag
+      ##
+      # Returns a hash representing a Mongoid criteria
+      # for the current query.
+      #
+      # @api private
+      #
+      # @param elements
+      #
+      # @return [Hash] Hash which can be used as a Mongoid criteria
+      def to_criteria(elements = nil)
+        elements ||= self.elements
+
+        criteria = { 'tags' => Hash.new { |h, k| h[k] = [] } }
+
+        elements.each do |element|
+          criteria['tags'][element.operator.selector] << element.to_criteria if element.is_a?(Tag)
+
+          criteria['tags'].merge! to_criteria(Array(element.elements))['tags'] do |_, first, second|
+            first + second
+          end
+        end
+
+        criteria
+      end
+    end
+
+    ##
+    # Representation class for a subquery, e.g. `(foo bar)`.
+    #
+    # @api private
+    class SubQuery < Treetop::Runtime::SyntaxNode
+      ##
+      # Returns a hash representing a Mongoid criteria
+      # for the current query.
+      #
+      # @api private
+      #
+      # @param elements
+      #
+      # @return [Hash] Hash which can be used as a Mongoid criteria
+      def to_criteria(elements = nil)
+        elements ||= self.elements
+
+        criteria = []
+        subcriteria = { '$or' => [] }
 
-            criteria.merge!(to_criteria(tag.elements)) { |key, first, second| first + second } if tag.elements.present?
+        elements.each do |element|
+          case element
+          when Query
+            criteria << element.to_criteria
+          when SubQuery
+            element.to_criteria['$or'].each do |criterion|
+              criteria << criterion
+            end
           end
         end
+
+        criteria.each do |criterion|
+          subcriteria['$or'] << criterion
+        end
+
+        subcriteria
       end
     end
 
+    ##
+    # Representation class for a tag, e.g. `foo`.
+    #
+    # @api private
     class Tag < Treetop::Runtime::SyntaxNode
+      ##
+      # Returns a string for using this tag in a Mongoid criteria.
+      #
+      # @api private
+      #
+      # @return [String] String representing this tag for a Mongoid criteria
       def to_criteria
         tag.text_value
       end
     end
 
+    ##
+    # Representation class for "or" operator, e.g. ` `.
+    #
+    # @api private
     class OrOperator < Treetop::Runtime::SyntaxNode
+      ##
+      # Returns a string for using this operator in a Mongoid criteria.
+      #
+      # @api private
+      #
+      # @return [String] String representing this operator for a Mongoid criteria
       def selector
         '$in'
       end
     end
 
+    ##
+    # Representation class for "and" operator, e.g. `+`.
+    #
+    # @api private
     class AndOperator < Treetop::Runtime::SyntaxNode
+      ##
+      # Returns a string for using this operator in a Mongoid criteria.
+      #
+      # @api private
+      #
+      # @return [String] String representing this operator for a Mongoid criteria
       def selector
         '$all'
       end
     end
 
+    ##
+    # Representation class for "not" operator, e.g. `-`.
+    #
+    # @api private
     class NotOperator < Treetop::Runtime::SyntaxNode
+      ##
+      # Returns a string for using this operator in a Mongoid criteria.
+      #
+      # @api private
+      #
+      # @return [String] String representing this operator for a Mongoid criteria
       def selector
         '$nin'
       end

data/lib/mongoid/tags.tt

@@ -2,15 +2,19 @@ module Mongoid
   module Tags
     grammar Tags
       rule query
-        tag (space tag)* <Query>
+        subquery / tag (space tag)* <Query>
+      end
+
+      rule subquery
+        '(' space? query space? ')' space? query? <SubQuery>
       end
 
       rule tag
-        operator tag:([a-zA-Z0-9] [a-zA-Z0-9_]*) <Tag>
+        operator tag:([a-zA-Z0-9_]+) <Tag>
       end
 
       rule operator
-         and_operator / not_operator / or_operator
+        and_operator / not_operator / or_operator
       end
 
       rule or_operator

data/lib/mongoid/tags/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Tags
-    VERSION = '0.3.1'
+    VERSION = '1.0.0'
   end
 end

data/mongoid-tags.gemspec

@@ -1,19 +1,23 @@
-$: << File.expand_path('../lib', __FILE__)
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'mongoid/tags/version'
 
-Gem::Specification.new do |gem|
-  gem.name          = 'mongoid-tags'
-  gem.version       = Mongoid::Tags::VERSION
-  gem.authors       = 'Mario Uher'
-  gem.email         = 'uher.mario@gmail.com'
-  gem.homepage      = 'https://github.com/haihappen/mongoid-tags'
-  gem.summary       = 'Simple tagging system with boolean search.'
-  gem.description   = 'Mongoid::Tags adds a simple tagging system to your Mongoid documents, and allows you to query them using a boolean search syntax.'
+Gem::Specification.new do |spec|
+  spec.name          = "mongoid-tags"
+  spec.version       = Mongoid::Tags::VERSION
+  spec.authors       = "Mario Uher"
+  spec.email         = "uher.mario@gmail.com"
+  spec.homepage      = "https://github.com/haihappen/mongoid-tags"
+  spec.summary       = "Simple tagging system with boolean search."
+  spec.description   = "Mongoid::Tags adds a simple tagging system to your Mongoid documents, and allows you to query them using a boolean search syntax."
+  spec.license       = "MIT"
 
-  gem.files         = `git ls-files`.split("\n")
-  gem.require_path  = 'lib'
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
 
-  gem.add_dependency 'activesupport'
-  gem.add_dependency 'mongoid'
-  gem.add_dependency 'treetop'
+  spec.add_dependency 'activesupport', '~> 4'
+  spec.add_dependency 'mongoid', '~> 4'
+  spec.add_dependency 'treetop', '~> 1'
 end

data/test/integration_test.rb

@@ -1,8 +1,8 @@
 require_relative 'test_helper'
 
 # Create all possible combinations of tags.
-3.times do |i|
-  %w[foo bar baz].combination(i + 1).each do |tags|
+4.times do |i|
+  %w[foo bar baz qux].combination(i + 1).each do |tags|
     Document.create tags: tags
   end
 end
@@ -16,8 +16,16 @@ def include?(*tags)
   end
 end
 
+def include_all?(*tags)
+  proc do |document|
+    tags.all? do |tag|
+      document.tags.include?(tag)
+    end
+  end
+end
 
-class IntegrationTest < Minitest::Unit::TestCase
+
+class IntegrationTest < Minitest::Test
   def test_documents_including_foo
     assert Document.tagged('foo').all? &include?('foo')
   end
@@ -117,4 +125,31 @@ class IntegrationTest < Minitest::Unit::TestCase
     assert documents.none? &include?('bar')
     assert documents.none? &include?('baz')
   end
+
+
+  def test_documents_including_both_foo_and_bar_and_or_baz
+    documents = Document.tagged('(+foo +bar) baz').to_a
+
+    assert documents.any?  &include_all?('foo', 'bar')
+    documents.delete_if    &include_all?('foo', 'bar')
+    assert documents.all?  &include?('baz')
+  end
+
+
+  def test_documents_including_both_foo_and_bar_and_or_baz_or_qux
+    documents = Document.tagged('(+foo +bar) baz qux').to_a
+
+    assert documents.any?  &include_all?('foo', 'bar')
+    documents.delete_if    &include_all?('foo', 'bar')
+    assert documents.any?  &include?('baz', 'qux')
+  end
+
+
+  def test_documents_including_foo_and_bar_or_baz_and_qux
+    documents = Document.tagged('(+foo +bar)(+baz +qux)').to_a
+
+    assert documents.any? &include_all?('foo', 'bar')
+    documents.delete_if   &include_all?('foo', 'bar')
+    assert documents.any? &include_all?('baz', 'qux')
+  end
 end

data/test/mongoid.yml

@@ -4,5 +4,3 @@ test:
       database: mongoid_tags_test
       hosts:
         - localhost:27017
-      options:
-        consistency: :strong

data/test/tags_test.rb

@@ -1,19 +1,33 @@
 require_relative 'test_helper'
 
-class TagsTest < Minitest::Unit::TestCase
+class TagsTest < Minitest::Test
   def assert_selector(query, selector)
     assert_equal selector, Document.selector(query)
   end
 
   def test_valid_queries
-    assert_selector 'foo', '$in' => %w[foo]
-    assert_selector '+foo', '$all' => %w[foo]
-    assert_selector '-foo', '$nin' => %w[foo]
-    assert_selector 'foo bar', '$in' => %w[foo bar]
-    assert_selector 'foo +bar', '$in' => %w[foo], '$all' => %w[bar]
-    assert_selector 'foo +bar +baz', '$in' => %w[foo], '$all' => %w[bar baz]
-    assert_selector 'foo +bar baz', '$in' => %w[foo baz], '$all' => %w[bar]
-    assert_selector 'foo +bar -baz', '$in' => %w[foo], '$all' => %w[bar], '$nin' => %w[baz]
+    assert_selector 'foo', { 'tags' => { '$in' => %w[foo] }}
+    assert_selector '+foo', { 'tags' => { '$all' => %w[foo] }}
+    assert_selector '-foo', { 'tags' => { '$nin' => %w[foo] }}
+    assert_selector 'foo bar', { 'tags' => { '$in' => %w[foo bar] }}
+    assert_selector 'foo +bar', { 'tags' => { '$in' => %w[foo], '$all' => %w[bar] }}
+    assert_selector 'foo +bar +baz', { 'tags' => { '$in' => %w[foo], '$all' => %w[bar baz] }}
+    assert_selector 'foo +bar baz', { 'tags' => { '$in' => %w[foo baz], '$all' => %w[bar] }}
+    assert_selector 'foo +bar -baz', { 'tags' => { '$in' => %w[foo], '$all' => %w[bar], '$nin' => %w[baz] }}
+
+    assert_selector '(foo)', { '$or' => [{ 'tags' => { '$in' => %w[foo] } }] }
+    assert_selector '(foo bar)', { '$or' => [{ 'tags' => { '$in' => %w[foo bar] } }] }
+    assert_selector '( foo bar )', { '$or' => [{ 'tags' => { '$in' => %w[foo bar] } }] }
+    assert_selector '(foo)(bar)', { '$or' => [{ 'tags' => { '$in' => %w[foo] } }, { 'tags' => { '$in' => %w[bar] } }] }
+    assert_selector '(foo)(bar)(baz)', { '$or' => [{ 'tags' => { '$in' => %w[foo] } }, { 'tags' => { '$in' => %w[bar] } }, { 'tags' => { '$in' => %w[baz] } }] }
+    assert_selector '(+foo)(-bar)', { '$or' => [{ 'tags' => { '$all' => %w[foo] } }, { 'tags' => { '$nin' => %w[bar] } }] }
+
+    assert_selector '(+foo +bar)(+foo +baz)', { '$or' => [{ 'tags' => { '$all' => %w[foo bar] } }, { 'tags' => { '$all' => %w[foo baz] } }] }
+    assert_selector '(+foo +bar)(+foo +baz)(+foo +qux)', { '$or' => [{ 'tags' => { '$all' => %w[foo bar] } }, { 'tags' => { '$all' => %w[foo baz] } }, { 'tags' => { '$all' => %w[foo qux] } }] }
+
+    assert_selector '(+foo +bar) baz qux', { '$or' => [{ 'tags' => { '$all' => %w[foo bar] } }, { 'tags' => { '$in' => %w[baz qux] } } ]}
+
+    assert_selector '_foo _bar', { 'tags' => { '$in' => %w[_foo _bar] }}
   end
 
   def test_invalid_queries

data/test/test_helper.rb

@@ -12,3 +12,4 @@ class Document
 end
 
 Mongoid.load!(File.expand_path('../mongoid.yml', __FILE__), 'test')
+Mongoid.purge!

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-tags
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Mario Uher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-17 00:00:00.000000000 Z
+date: 2014-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: treetop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 description: Mongoid::Tags adds a simple tagging system to your Mongoid documents,
   and allows you to query them using a boolean search syntax.
 email: uher.mario@gmail.com
@@ -60,8 +60,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
+- LICENSE.md
 - README.md
 - Rakefile
 - lib/mongoid/tags.rb
@@ -73,7 +75,8 @@ files:
 - test/tags_test.rb
 - test/test_helper.rb
 homepage: https://github.com/haihappen/mongoid-tags
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -91,8 +94,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Simple tagging system with boolean search.
-test_files: []
+test_files:
+- test/integration_test.rb
+- test/mongoid.yml
+- test/tags_test.rb
+- test/test_helper.rb
+has_rdoc: