mongoid-tags 0.1.1

data/.gitignore

@@ -0,0 +1,25 @@
+# Because this is a gem, ignore Gemfile.lock:
+
+Gemfile.lock
+
+# And because this is Ruby, ignore the following
+#  (source: https://github.com/github/gitignore/blob/master/Ruby.gitignore):
+
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.0.1 (December 22, 2012)
+
+* First version.

data/Gemfile

@@ -0,0 +1,6 @@
+source :rubygems
+
+gemspec
+
+gem 'minitest'
+gem 'rake'

data/README.md

@@ -0,0 +1,68 @@
+# mongoid-tags
+
+Mongoid::Tags adds a simple tagging system to your Mongoid documents,
+and allows you to query them using a boolean search syntax.
+
+
+## Installation
+
+In your Gemfile:
+
+```ruby
+gem 'mongoid-tags'
+```
+
+## Usage
+
+```ruby
+class Document
+  include Mongoid::Document
+  include Mongoid::Tags
+end
+```
+
+```ruby
+# Documents tagged foo || bar
+Document.tagged('foo bar')
+
+# Documents tagged foo && bar
+Document.tagged('+foo bar')
+
+# Documents tagged foo, but !bar
+Document.tagged('foo -bar')
+```
+
+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)` 
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+(The MIT license)
+
+Copyright (c) 2012 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/Rakefile

@@ -0,0 +1,8 @@
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = Dir.glob('spec/**/*_spec.rb')
+end
+
+task(default: :test)

data/lib/mongoid/tags/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module Tags
+    VERSION = '0.1.1'
+  end
+end

data/lib/mongoid/tags.rb

@@ -0,0 +1,69 @@
+require 'active_support'
+require 'mongoid'
+require 'treetop'
+
+module Mongoid
+  module Tags
+    extend ActiveSupport::Concern
+
+    included do |base|
+      field :tags, type: Array, default: []
+      index tags: 1
+    end
+
+    module ClassMethods
+      def selector(query)
+        parser.parse(query).tap do |result|
+          raise Error, parser.failure_reason unless result
+        end.to_criteria
+      end
+
+      def tagged(query)
+        where(tags: selector(query))
+      end
+
+    private
+      def parser
+        @parser ||= Treetop.load(File.expand_path('../tags.tt', __FILE__)).new
+      end
+    end
+
+    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
+            
+            criteria.merge!(to_criteria(tag.elements)) { |key, first, second| first + second } if tag.elements.present?
+          end
+        end
+      end
+    end
+
+    class Tag < Treetop::Runtime::SyntaxNode
+      def to_criteria
+        tag.text_value
+      end
+    end
+
+    class OrOperator < Treetop::Runtime::SyntaxNode
+      def selector
+        '$in'
+      end
+    end
+
+    class AndOperator < Treetop::Runtime::SyntaxNode
+      def selector
+        '$all'
+      end
+    end
+
+    class NotOperator < Treetop::Runtime::SyntaxNode
+      def selector
+        '$nin'
+      end
+    end
+
+    class Error < StandardError; end
+  end
+end

data/lib/mongoid/tags.tt

@@ -0,0 +1,33 @@
+module Mongoid
+  module Tags
+    grammar Tags
+      rule query
+        tag (space tag)* <Query>
+      end
+
+      rule tag
+        operator tag:([a-zA-Z0-9] [a-zA-Z0-9_]*) <Tag>
+      end
+
+      rule operator
+         and_operator / not_operator / or_operator
+      end
+
+      rule or_operator
+        '' <OrOperator>
+      end
+
+      rule and_operator
+        '+' <AndOperator>
+      end
+
+      rule not_operator
+        '-' <NotOperator>
+      end
+
+      rule space
+        [\s]+
+      end
+    end
+  end
+end

data/mongoid-tags.gemspec

@@ -0,0 +1,18 @@
+require './lib/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.files         = `git ls-files`.split("\n")
+  gem.require_path  = 'lib'
+
+  gem.add_dependency 'activesupport'
+  gem.add_dependency 'mongoid'
+  gem.add_dependency 'treetop'
+end

data/spec/integration_spec.rb

@@ -0,0 +1,121 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe 'Mongoid::Tags integration' do
+  before do
+    # Create all possible combinations
+    3.times do |i|
+      %w[foo bar baz].combination(i + 1).each do |tags|
+        Document.create(tags: tags)
+      end
+    end
+  end
+
+
+  let(:query) { self.class.name.demodulize } # Use description as query ;)
+  subject { Document.tagged(query) }
+
+
+  describe 'foo' do
+    it 'returns documents including foo' do
+      subject.all? { |d| d.tags.include?('foo') }.must_equal true
+    end
+  end
+
+
+  describe '+foo' do
+    it 'returns documents including at least foo' do
+      subject.all? { |d| d.tags.include?('foo') }.must_equal true
+    end
+  end
+
+
+  describe '-foo' do
+    it 'returns documents not including foo' do
+      subject.none? { |d| d.tags.include?('foo') }.must_equal true
+    end
+  end
+
+
+  describe 'foo bar' do
+    it 'returns documents including foo or bar' do
+      subject.all? { |d| d.tags.include?('foo') || d.tags.include?('bar') }.must_equal true
+    end
+  end
+
+
+  describe '+foo bar' do
+    it 'returns documents including foo and bar' do
+      subject.all? { |d| d.tags.include?('foo') }.must_equal true
+      subject.all? { |d| d.tags.include?('bar') }.must_equal true
+    end
+  end
+
+
+  describe '-foo bar' do
+    it 'returns documents not including foo, but bar' do
+      subject.none? { |d| d.tags.include?('foo') }.must_equal true
+      subject.all?  { |d| d.tags.include?('bar') }.must_equal true
+    end
+  end
+
+
+  describe '-foo -bar' do
+    it 'returns documents not including foo and bar' do
+      subject.none? { |d| d.tags.include?('foo') }.must_equal true
+      subject.none? { |d| d.tags.include?('bar') }.must_equal true
+    end
+  end
+
+
+  describe 'foo bar baz' do
+    it 'returns documents including foo or bar' do
+      subject.all? { |d| d.tags.include?('foo') || d.tags.include?('bar') || d.tags.include?('baz') }.must_equal true
+    end
+  end
+
+
+  describe '+foo bar baz' do
+    it 'returns documents including at least foo and bar or baz' do
+      subject.all? { |d| d.tags.include?('foo') }.must_equal true
+      subject.all? { |d| d.tags.include?('bar') || d.tags.include?('baz') }.must_equal true
+    end
+  end
+
+
+  describe '+foo +bar baz' do
+    it 'returns documents including at least foo, bar and baz' do
+      subject.all? { |d| d.tags.include?('foo') }.must_equal true
+      subject.all? { |d| d.tags.include?('bar') }.must_equal true
+      subject.all? { |d| d.tags.include?('baz') }.must_equal true
+    end
+  end
+
+
+  describe '-foo bar baz' do
+    it 'returns documents not including foo, but bar or baz' do
+      subject.none? { |d| d.tags.include?('foo') }.must_equal true
+      subject.all?  { |d| d.tags.include?('bar') || d.tags.include?('baz') }.must_equal true
+    end
+  end
+
+
+  describe '-foo -bar baz' do
+    it 'returns documents not including foo and bar, but baz' do
+      subject.none? { |d| d.tags.include?('foo') }.must_equal true
+      subject.none? { |d| d.tags.include?('bar') }.must_equal true
+      subject.all?  { |d| d.tags.include?('baz') }.must_equal true
+    end
+  end
+
+
+  describe '-foo -bar -baz' do
+    it 'returns documents not including foo, bar and baz' do
+      subject.none? { |d| d.tags.include?('foo') }.must_equal true
+      subject.none? { |d| d.tags.include?('bar') }.must_equal true
+      subject.none? { |d| d.tags.include?('baz') }.must_equal true
+    end
+  end
+
+
+  after { Document.destroy_all }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'minitest/spec'
+
+require './lib/mongoid/tags'
+
+# Load support *.rb files in ./support
+Dir[File.expand_path('../support/*.rb', __FILE__)].each { |file| require file }

data/spec/support/connection.rb

@@ -0,0 +1 @@
+Mongoid.load!(File.expand_path('../mongoid.yml', __FILE__), 'test')

data/spec/support/document.rb

@@ -0,0 +1,4 @@
+class Document
+  include Mongoid::Document
+  include Mongoid::Tags
+end

data/spec/support/mongoid.yml

@@ -0,0 +1,8 @@
+test:
+  sessions:
+    default:
+      database: mongoid_tags_test
+      hosts:
+        - localhost:27017
+      options:
+        consistency: :strong

data/spec/tags_spec.rb

@@ -0,0 +1,76 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Mongoid::Tags do
+  describe :selector do
+    let(:query) { @__name__.match(/test_\d+_(.*)/).to_a.last } # Use description as query ;)
+    subject { Document.selector(query) }
+
+
+    it 'foo' do
+      subject.must_equal '$in' => %w[foo]
+    end
+
+
+    it '+foo' do
+      subject.must_equal '$all' => %w[foo]
+    end
+
+
+    it '- foo' do
+      proc { subject }.must_raise Mongoid::Tags::Error
+    end
+
+
+    it '-foo' do
+      subject.must_equal '$nin' => %w[foo]
+    end
+
+
+    it '- foo' do
+      proc { subject }.must_raise Mongoid::Tags::Error
+    end
+
+
+    it '/foo' do
+      proc { subject }.must_raise Mongoid::Tags::Error
+    end
+
+
+    it 'foo bar' do
+      subject.must_equal '$in' => %w[foo bar]
+    end
+
+
+    it 'foo +bar' do
+      subject.must_equal '$in' => %w[foo], '$all' => %w[bar]
+    end
+
+
+    it 'foo + bar' do
+      proc { subject }.must_raise Mongoid::Tags::Error
+    end
+
+
+    it 'foo +bar +baz' do
+      subject.must_equal '$in' => %w[foo], '$all' => %w[bar baz]
+    end
+
+
+    it 'foo +bar baz' do
+      subject.must_equal '$in' => %w[foo baz], '$all' => %w[bar]
+    end
+
+
+    it 'foo +bar -baz' do
+      subject.must_equal '$in' => %w[foo], '$all' => %w[bar], '$nin' => %w[baz]
+    end
+
+
+    it 'foo foo foo' do
+      # Removing duplicates does not gain any
+      # performance improvements.
+      skip
+      subject.must_equal '$in' => %w[foo]
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-tags
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.1.1
+platform: ruby
+authors:
+- Mario Uher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: activesupport
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: mongoid
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: treetop
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/mongoid/tags.rb
+- lib/mongoid/tags.tt
+- lib/mongoid/tags/version.rb
+- mongoid-tags.gemspec
+- spec/integration_spec.rb
+- spec/spec_helper.rb
+- spec/support/connection.rb
+- spec/support/document.rb
+- spec/support/mongoid.yml
+- spec/tags_spec.rb
+homepage: https://github.com/haihappen/mongoid-tags
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Simple tagging system with boolean search.
+test_files: []