mongoid_oslc 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongoid_oslc.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Martin Magnusek
+
+MIT License
+
+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

@@ -0,0 +1,29 @@
+# MongoidOslc
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongoid_oslc'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid_oslc
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/mongoid/oslc/oslc_grammar.rb

@@ -0,0 +1,83 @@
+require 'treetop'
+
+module Mongoid
+  module Oslc
+    module OslcGrammar
+      class GrammarNode < Treetop::Runtime::SyntaxNode
+        def to_mongo_query
+          elements[0].to_mongo_query
+        end
+      end
+
+      class BinaryDecision < GrammarNode
+
+        def to_mongo_query
+          operand_1 = elements[0].to_mongo_query
+          operand_2 = elements[2].to_mongo_query
+          operand_1.merge(operand_2)
+        end
+      end
+
+      class LogicalOperator < GrammarNode
+      end
+
+      class Field < GrammarNode
+        def to_mongo_query
+          text_content
+        end
+      end
+
+      class Operator < GrammarNode
+        OPERATORS = {
+          "="   => "$in",
+          "!="  => "$neq",
+          ">"   => "$gt",
+          ">="  => "$gte",
+          "<"   => "$lt",
+          "<="  => "$lte",
+          "in"  => "$in"
+        }
+
+        def to_mongo_query
+          OPERATORS[text_value]
+        end
+
+        def to_mongo_query_with_value(value)
+          if text_value == "="
+            value
+          else
+            { OPERATORS[text_value] => value }
+          end
+        end
+      end
+
+      class UriRefEsc < GrammarNode
+        def to_mongo_query
+          # TODO: an angle bracket-delimited URI reference in which > and \ are \-escaped.
+          text_content
+        end
+      end
+
+      class BooleanValue < GrammarNode
+        def to_mongo_query
+          text_value == "true"
+        end
+      end
+
+      class StringEsc < GrammarNode
+        def to_mongo_query
+          text_value[1...-1]
+        end
+      end
+
+      class Condition < GrammarNode
+        def to_mongo_query
+          field = OSLC_FIELDS_MAPPING[elements[0].text_value]
+          value = elements[2].to_mongo_query
+          operator_with_value = elements[1].to_mongo_query_with_value(value)
+          { field => operator_with_value }
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/oslc/oslc_grammar.treetop

@@ -0,0 +1,80 @@
+# oslc_where    ::= "oslc.where=" compound_term
+# compound_term ::= simple_term (space? boolean_op space? simple_term)*
+# simple_term   ::= term | scoped_term
+# space         ::= " " /* a space character */
+# boolean_op    ::= "and"
+# term          ::= identifier_wc comparison_op value | identifier_wc space in_op space? in_val
+# scoped_term   ::= identifier_wc "{" compound_term "}"
+# identifier_wc ::= identifier | wildcard
+# identifier    ::= PrefixedName
+# PrefixedName  ::= /* see "SPARQL Query Language for RDF", http://www.w3.org/TR/rdf-sparql-query/#rPrefixedName */
+# wildcard      ::= "*"
+# comparison_op ::= "=" | "!=" | "<" | ">" | "<=" | ">="
+# in_op         ::= "in"
+# in_val        ::= "[" value ("," value)* "]"
+# value         ::= uri_ref_esc | literal_value
+# uri_ref_esc   ::= /* an angle bracket-delimited URI reference in which > and \ are \-escaped. */
+# literal_value ::= boolean | decimal | string_esc (LANGTAG | ("^^" PrefixedName))?
+# boolean       ::= "true" | "false"
+# decimal       ::= /* see "XML Schema Part 2: Datatypes Second Edition", http://www.w3.org/TR/xmlschema-2/ */
+# string_esc    ::= /* a string enclosed in double quotes, with certain characters escaped. See below. */
+# LANGTAG       ::= /* see "SPARQL Query Language for RDF", http://www.w3.org/TR/rdf-sparql-query/#rLANGTAG */
+
+grammar OslcGrammar
+
+  rule decision
+    binary_decision / simple_term
+  end
+
+  rule binary_decision
+    operand_1:simple_term space? boolean_op space? operand_2:decision <Mongoid::Oslc::OslcGrammar::BinaryDecision>
+  end
+
+  rule simple_term
+    term
+  end
+
+  rule term
+    field comparison_op value <Mongoid::Oslc::OslcGrammar::Condition>
+  end
+
+  rule boolean_op
+    'and' <Mongoid::Oslc::OslcGrammar::LogicalOperator>
+  end
+
+  rule space
+    ' '
+  end
+
+  rule field
+    [\w\:]+ <Mongoid::Oslc::OslcGrammar::Field>
+  end
+
+  rule comparison_op
+    [\=\>\<\!] <Mongoid::Oslc::OslcGrammar::Operator>
+  end
+
+  rule value
+    literal_value / uri_ref_esc
+  end
+
+  rule uri_ref_esc
+    [\w]+ <Mongoid::Oslc::OslcGrammar::UriRefEsc>
+  end
+
+  rule literal_value
+    boolean / decimal / string_esc
+  end
+
+  rule boolean
+    'true' <Mongoid::Oslc::OslcGrammar::BooleanValue> / 'false' <Mongoid::Oslc::OslcGrammar::BooleanValue>
+  end
+
+  rule decimal
+    [\d]+
+  end
+
+  rule string_esc
+    '"' [^\"]* '"' <Mongoid::Oslc::OslcGrammar::StringEsc>
+  end
+end

data/lib/mongoid/oslc/strategy.rb

@@ -0,0 +1,33 @@
+require 'treetop'
+require 'mongoid/oslc/oslc_grammar'
+
+module Mongoid
+  module Oslc
+    class Strategy
+      attr_reader :parser
+
+      def self.to_query(query, *args)
+        options = { :verbose => true }
+        options.merge!(args.extract_options!)
+
+        Treetop.load File.join(File.dirname(__FILE__), "oslc_grammar")
+        @parser = OslcGrammarParser.new
+
+        tree = @parser.parse(query)
+        raise Search::QueryParsingError.new(query, @parser.index) if tree.nil?
+
+        clean_tree(tree)
+
+        tree.to_mongo_query
+      end
+
+      private
+
+      def self.clean_tree(root_node)
+        return if(root_node.elements.nil?)
+        root_node.elements.delete_if{|node| node.class.name == "Treetop::Runtime::SyntaxNode" }
+        root_node.elements.each {|node| self.clean_tree(node) }
+      end
+    end
+  end
+end

data/lib/mongoid/oslc/version.rb

@@ -0,0 +1,3 @@
+module Mongoid::Oslc
+  VERSION = '0.0.1'
+end

data/lib/mongoid/oslc.rb

@@ -0,0 +1,22 @@
+require 'mongoid/oslc/strategy'
+
+# OSLC
+OSLC_FIELDS_MAPPING ||= {
+  "dcterms:title"           => "title",
+  "dcterms:description"     => "description",
+  "dcterms:created"         => "created_at",
+  "oslc_cm:closed"          => "closed"
+}
+
+module Mongoid
+  module Oslc
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def oslc_where(query)
+        mongoid_query = Strategy.to_query(query)
+        where(mongoid_query)
+      end
+    end
+  end
+end

data/lib/mongoid_oslc.rb

@@ -0,0 +1,3 @@
+require "mongoid"
+require "mongoid/oslc/version"
+

data/mongoid_oslc.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid'
+require 'mongoid/oslc/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "mongoid_oslc"
+  gem.version       = Mongoid::Oslc::VERSION
+  gem.authors       = ["Martin Magnusek"]
+  gem.email         = ["magnusekm@gmail.com"]
+  gem.description   = %q{Extension for mongoid to parse oslc.where}
+  gem.summary       = ""
+  gem.homepage      = ""
+
+  gem.add_runtime_dependency 'mongoid', ['<= 4.0', '>= 3.0']
+  gem.add_runtime_dependency 'treetop'
+
+  gem.add_development_dependency('rake', ['>= 0.9.2'])
+  gem.add_development_dependency('rspec', ['~> 2.8'])
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/spec/lib/mongoid/oslc/strategy_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Mongoid::Oslc::Strategy do
+  let(:parser) { Mongoid::Oslc::Strategy }
+
+  def parse_query(query, verbose = true)
+    parser.to_query(query, :verbose => verbose)
+  end
+
+  it "has to_query method" do
+    parser.respond_to?(:to_query).should be_true
+  end
+
+  describe "#parse" do
+
+    it "should parse simple query" do
+      parse_query('dcterms:title="requirement"').should eql({"title"=>"requirement"})
+    end
+
+    it "should parse query with conjunction" do
+      parse_query('dcterms:title="requirement" and dcterms:description="first"').should eql({
+        "title"=>"requirement",
+        "description"=>"first"
+      })
+    end
+
+    it "should parse query with other comparison_op" do
+      parse_query('dcterms:created>"2010-04-01"').should eql({"created_at"=>{"$gt"=>"2010-04-01"}})
+    end
+
+    it "should parse query with boolean value" do
+      parse_query('oslc_cm:closed=true').should eql({"closed"=> true})
+    end
+
+    it "should parse query with boolean value" do
+      parse_query('oslc_cm:closed=false').should eql({"closed"=> false})
+    end
+  end
+end

data/spec/lib/mongoid/oslc_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+class MongoDocument
+  include Mongoid::Document
+  include Mongoid::Oslc
+
+end
+
+describe Mongoid::Oslc do
+  subject { MongoDocument.new }
+
+  describe "class" do
+    it "should have method #oslc_where" do
+      MongoDocument.respond_to?(:oslc_where).should be_true
+    end
+
+    it "should create criteria" do
+      query = MongoDocument.oslc_where('dcterms:title="Requirement"')
+      query.class.should eql Mongoid::Criteria
+      query.selector.should eql({"title" => "Requirement"})
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'mongoid'
+require 'mongoid/oslc'
+
+require 'rspec'
+
+Mongoid.configure do |config|
+  config.connect_to('mongoid_oslc_where_test')
+end
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.after(:each) { Mongoid.purge! }
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_oslc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Martin Magnusek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - <=
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - <=
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: treetop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+description: Extension for mongoid to parse oslc.where
+email:
+- magnusekm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongoid/oslc.rb
+- lib/mongoid/oslc/oslc_grammar.rb
+- lib/mongoid/oslc/oslc_grammar.treetop
+- lib/mongoid/oslc/strategy.rb
+- lib/mongoid/oslc/version.rb
+- lib/mongoid_oslc.rb
+- mongoid_oslc.gemspec
+- spec/lib/mongoid/oslc/strategy_spec.rb
+- spec/lib/mongoid/oslc_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3408470218474486260
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3408470218474486260
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- spec/lib/mongoid/oslc/strategy_spec.rb
+- spec/lib/mongoid/oslc_spec.rb
+- spec/spec_helper.rb