mongoid_oslc 0.1.1 → 0.1.2

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+services: mongodb
+rvm:
+  - 1.9.3

data/README.md

@@ -1,5 +1,9 @@
 # MongoidOslc
 
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/versative/mongoid_oslc)
+[![Dependency Status](https://gemnasium.com/versative/mongoid_oslc.png)](https://gemnasium.com/versative/mongoid_oslc)
+[![Build Status](https://travis-ci.org/versative/mongoid_oslc.png)](https://travis-ci.org/versative/mongoid_oslc)
+
 Extension for mongoid to parse oslc.where
 
 ## Installation
@@ -18,54 +22,68 @@ Or install it yourself as:
 
 ## Usage
 
+### Configure
+
 Add initializer with your configuration.
 
-    Mongoid::Oslc.configure do |config|
-      config.default_namespaces = [:rtc]
-    end
+```ruby
+Mongoid::Oslc.configure do |config|
+  config.default_namespaces = [:oslc_custom]
+end
+```
 
 Include Mongoid::Oslc module to your document
 
-    class Article
-      include Mongoid::Document
-      include Mongoid::Oslc
-
-      domain    'oslc_cm'
-      describe  'http://open-services.net/ns/cm#ChangeRequest'
-
-      oslc_field :title,       type: String, mapping: 'dcterms:title'
-      oslc_field :description, type: String, mapping: 'dcterms:description'
-
-    end
-
-    Article.oslc_where('dcterms:title="First article" and dcterms:description="First article description"')
-    => #<Mongoid::Criteria
-      selector: {"title"=>"First article", "description"=>"First article description"},
-      options:  {},
-      class:    Article,
-      embedded: false>
-
-    Mongoid::Oslc.resources.mapping
-    => {
-      "dcterms:title"=>{
-        :name=>:title,
-        :value_type=>"http://www.w3.org/2001/XMLSchema#string",
-        :read_only=>false,
-        :occurs=>"http://open-services.net/ns/core#Zero-or-one",
-        :allowed_values=>[],
-        :embedded=>false,
-        :range=>[]
-      },
-      "dcterms:description"=>{
-        :name=>:description,
-        :value_type=>"http://www.w3.org/2001/XMLSchema#string",
-        :read_only=>false,
-        :occurs=>"http://open-services.net/ns/core#Zero-or-one",
-        :allowed_values=>[],
-        :embedded=>false,
-        :range=>[]
-      }
-    }
+```ruby
+class Article
+  include Mongoid::Document
+  include Mongoid::Oslc
+
+  domain    'oslc_cm'
+  describe  'http://open-services.net/ns/cm#ChangeRequest'
+
+  oslc_field :title,       type: String, mapping: 'dcterms:title'
+  oslc_field :description, type: String, mapping: 'dcterms:description'
+
+end
+```
+
+### Search
+
+```ruby
+Article.oslc_where('dcterms:title="First article" and dcterms:description="First article description"')
+=> #<Mongoid::Criteria
+  selector: {"title"=>"First article", "description"=>"First article description"},
+  options:  {},
+  class:    Article,
+  embedded: false>
+```
+
+### Mappings
+
+```ruby
+Mongoid::Oslc.resources.mapping
+=> {
+  "dcterms:title"=>{
+    :name=>:title,
+    :value_type=>"http://www.w3.org/2001/XMLSchema#string",
+    :read_only=>false,
+    :occurs=>"http://open-services.net/ns/core#Zero-or-one",
+    :allowed_values=>[],
+    :embedded=>false,
+    :range=>[]
+  },
+  "dcterms:description"=>{
+    :name=>:description,
+    :value_type=>"http://www.w3.org/2001/XMLSchema#string",
+    :read_only=>false,
+    :occurs=>"http://open-services.net/ns/core#Zero-or-one",
+    :allowed_values=>[],
+    :embedded=>false,
+    :range=>[]
+  }
+}
+```
 
 ## Contributing
 

data/lib/mongoid/oslc.rb

@@ -18,25 +18,25 @@ module Mongoid
     end
 
     def domain
-      Mongoid::Oslc.resources[self._type][:domain]
+      Mongoid::Oslc.resources[self.class.name][:domain]
     end
 
     def describe
-      Mongoid::Oslc.resources[self._type][:describe]
+      Mongoid::Oslc.resources[self.class.name][:describe]
     end
 
     def oslc_value(oslc_name)
-      field_properties = Mongoid::Oslc.resources[self._type][:fields][oslc_name]
-      self[field_properties[:name]]
+      field_name = Mongoid::Oslc.resources.field_name(oslc_name)
+      self[field_name]
     end
 
     module ClassMethods
       def domain(name)
-        Mongoid::Oslc.resources[self.to_s].merge!(domain: name)
+        Mongoid::Oslc.resources[self.name].merge!(domain: name)
       end
 
       def describe(describe)
-        Mongoid::Oslc.resources[self.to_s].merge!(describe: describe)
+        Mongoid::Oslc.resources[self.name].merge!(describe: describe)
       end
 
       def oslc_field(name, options = {})
@@ -48,12 +48,13 @@ module Mongoid
       def oslc_embeds_many(name, options = {})
         oslc_options = options_for_oslc(options)
         embeds_many(name, options)
-        register_oslc_field(name, oslc_options.merge(type: Array, embedded: true))
+        embedded_class = relations[name.to_s].class_name.constantize
+        register_oslc_field(name, oslc_options.merge(type: Array, embedded: embedded_class))
       end
 
       def oslc_fields
         (ancestors - included_modules).inject({}) do |hash, ancestor_class|
-          hash.merge(Mongoid::Oslc.resources[ancestor_class.to_s][:fields])
+          hash.merge(Mongoid::Oslc.resources[ancestor_class.name][:fields])
         end
       end
 
@@ -63,34 +64,33 @@ module Mongoid
       end
 
       def register_oslc_field(name, options)
-        mandatory = options[:mandatory] || false
-        occurs = if mandatory && options[:type] == Array
-          ::Oslc::ONE_OR_MANY
-        elsif mandatory
-          ::Oslc::EXACTLY_ONE
-        elsif options[:type] == Array
-          ::Oslc::ZERO_OR_MANY
-        else
-          ::Oslc::ZERO_OR_ONE
-        end
-
-        Mongoid::Oslc.resources[self.to_s][:fields][options[:mapping]] = {
+        Mongoid::Oslc.resources[self.name][:fields][options[:mapping]] = {
           name: name,
           value_type: ::Oslc::VALUE_TYPES[options[:value_type] || fields[name.to_s].type.to_s],
           read_only: (options[:read_only] || false),
-          occurs: occurs,
+          occurs: occurs(options),
           allowed_values: (options[:allowed_values] || []),
-          embedded: (options[:embedded] ? relations[name.to_s].class_name.constantize : false),
+          embedded: (options[:embedded] || false),
           range: (options[:range] || [])
         }
       end
 
       private
 
+      def occurs(options)
+        mandatory = options[:mandatory] || false
+        case
+          when mandatory && options[:type] == Array then ::Oslc::ONE_OR_MANY
+          when mandatory                            then ::Oslc::EXACTLY_ONE
+          when options[:type] == Array              then ::Oslc::ZERO_OR_MANY
+          else ::Oslc::ZERO_OR_ONE
+        end
+      end
+
       def options_for_oslc(options)
         [:value_type, :read_only, :allowed_values, :mapping, :mandatory, :range].inject({}) do |hash, field|
           hash.merge(field => options.delete(field))
-        end.merge(type: options[:type])
+        end.reject{|field, value| value.nil?}.merge(type: options[:type])
       end
     end
   end

data/lib/mongoid/oslc/config.rb

@@ -31,6 +31,6 @@ module Mongoid::Oslc
 
   # this is ugly. why can't we pass the default value to config_accessor...?
   configure do |config|
-    config.default_namespaces = [:rtc]
+    config.default_namespaces = [:oslc_custom]
   end
 end

data/lib/mongoid/oslc/grammar.rb

@@ -14,7 +14,7 @@ module Mongoid
         def to_mongo_query
           operand_1 = elements[0].to_mongo_query
           operand_2 = elements[2].to_mongo_query
-          operand_1.merge(operand_2)
+          operand_1.deep_merge(operand_2)
         end
       end
 
@@ -81,18 +81,12 @@ module Mongoid
         end
       end
 
-      class NilValue < GrammarNode
+      class BlankValue < GrammarNode
         def to_mongo_query
           nil
         end
       end
 
-      class EmptyValue < GrammarNode
-        def to_mongo_query
-          []
-        end
-      end
-
       class DecimalValue < GrammarNode
         def to_mongo_query
           text_value.to_f
@@ -101,14 +95,22 @@ module Mongoid
 
       class StringEsc < GrammarNode
         def to_mongo_query
-          text_value[1...-1]
+          value = text_value[1...-1]
+          if value.starts_with?("*") || value.ends_with?("*")
+            value.starts_with?("*") ? value.slice!(0)  : value.prepend("\\A")
+            value.ends_with?("*")   ? value.slice!(-1) : value.concat("\\z")
+            value = Regexp.new(value)
+          end
+          value
         end
       end
 
       class Condition < GrammarNode
         def to_mongo_query
-          field = Mongoid::Oslc.resources.field_name(elements[0].text_value)
-          value = elements[2].to_mongo_query
+          oslc_name = elements[0].text_value
+          field     = Mongoid::Oslc.resources.field_name(oslc_name)
+          value     = elements[2].to_mongo_query
+          value     = [] if value.nil? && Mongoid::Oslc.resources.is_field_array?(oslc_name)
           operator_with_value = elements[1].to_mongo_query_with_value(value)
           { field => operator_with_value }
         end

data/lib/mongoid/oslc/grammar.treetop

@@ -21,9 +21,8 @@
 # LANGTAG       ::= /* see "SPARQL Query Language for RDF", http://www.w3.org/TR/rdf-sparql-query/#rLANGTAG */
 
 # Extension
-# literal_value ::= | nil_value | empty_value
-# nil_value     ::= "nil"
-# empty_value   ::= "empty"
+# literal_value ::= | blank_value
+# blank_value   ::= "blank"
 
 grammar Grammar
 
@@ -76,19 +75,15 @@ grammar Grammar
   end
 
   rule literal_value
-    boolean / decimal / string_esc / nil_value / empty_value
+    boolean / decimal / string_esc / blank_value
   end
 
   rule boolean
     'true' <Mongoid::Oslc::Grammar::BooleanValue> / 'false' <Mongoid::Oslc::Grammar::BooleanValue>
   end
 
-  rule nil_value
-    'nil' <Mongoid::Oslc::Grammar::NilValue>
-  end
-
-  rule empty_value
-    'empty' <Mongoid::Oslc::Grammar::EmptyValue>
+  rule blank_value
+    'blank' <Mongoid::Oslc::Grammar::BlankValue>
   end
 
   rule decimal

data/lib/mongoid/oslc/resources.rb

@@ -18,12 +18,27 @@ module Mongoid
       end
 
       def field_name(oslc_name)
-        if Mongoid::Oslc.config.default_namespaces.include?(oslc_name.split(":")[0].to_sym)
-          oslc_name.split(':')[1].to_sym
+        if custom_field?(oslc_name)
+          oslc_name.split(":")[1].to_sym
         else
           mapping[oslc_name][:name]
         end
       end
+
+      def is_field_array?(oslc_name)
+        if custom_field?(oslc_name)
+          false
+        else
+          occurs = self.mapping[oslc_name][:occurs]
+          occurs == ::Oslc::ZERO_OR_MANY || occurs == ::Oslc::ONE_OR_MANY
+        end
+      end
+
+      private
+
+      def custom_field?(oslc_name)
+        Mongoid::Oslc.config.default_namespaces.include? oslc_name.split(":")[0].to_sym
+      end
     end
   end
 end

data/lib/mongoid/oslc/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Oslc
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

data/mongoid_oslc.gemspec

@@ -6,9 +6,10 @@ Gem::Specification.new do |gem|
   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.description   = "Extension for mongoid to parse oslc.where"
+  gem.summary       = "Extension for mongoid to parse oslc.where"
+  gem.homepage      = "http://github.com/versative/mongoid_oslc"
+  gem.licenses      = ["MIT"]
 
   gem.add_runtime_dependency 'activesupport', '~> 3.0'
   gem.add_runtime_dependency 'mongoid', '>= 3.0', '< 4.0'

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

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Mongoid::Oslc::Resources do
+  subject { Mongoid::Oslc.resources }
+
+  describe "#class_for" do
+    it "should return correct class name" do
+      subject.class_for('http://open-services.net/ns/cm#ChangeRequest').should eql 'MongoDocument'
+    end
+  end
+
+  describe "#domain" do
+    it "should return correct domain" do
+      subject.domain('http://open-services.net/ns/cm#ChangeRequest').should eql 'oslc_cm'
+    end
+  end
+
+  describe "#mapping" do
+    it "should register all document fields" do
+      subject.mapping.keys.should eql ['dcterms:title', 'dcterms:description', 'dcterms:creator', 'oslc_cm:closed', 'dcterms:created', 'dcterms:modified']
+    end
+  end
+
+  describe "#field_name" do
+    it "should return field name" do
+      subject.field_name('dcterms:title').should eql :title
+    end
+
+    it "should return field name for custom field" do
+      subject.field_name('oslc_custom:custom_field').should eql :custom_field
+    end
+  end
+end

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

@@ -1,19 +1,5 @@
 require 'spec_helper'
 
-class MongoDocument
-  include Mongoid::Document
-  include Mongoid::Oslc
-  include Mongoid::Timestamps
-
-  oslc_field :title,        type: String, mapping: 'dcterms:title'
-  oslc_field :description,  type: String, mapping: 'dcterms:description'
-  oslc_field :closed,       type: Boolean,mapping: 'oslc_cm:closed'
-
-  register_oslc_field :created_at, mapping: 'dcterms:created',  value_type: 'DateTime'
-  register_oslc_field :updated_at, mapping: 'dcterms:modified', value_type: 'DateTime'
-
-end
-
 describe Mongoid::Oslc::Strategy do
   let(:parser) { Mongoid::Oslc::Strategy }
 
@@ -41,16 +27,20 @@ describe Mongoid::Oslc::Strategy do
       parse_query('dcterms:created>"2010-04-01"').should eql({created_at: {"$gt"=>"2010-04-01"}})
     end
 
+    it "should parse query with range" do
+      parse_query('dcterms:created>"2012-12-08" and dcterms:created<"2012-12-30"').should eql({created_at: {"$gt"=>"2012-12-08", "$lt"=>"2012-12-30"}})
+    end
+
     it "should parse query with not value" do
       parse_query('dcterms:title!="First"').should eql({title: {"$ne" => "First"}})
     end
 
-    it "should parse query with nil value" do
-      parse_query('dcterms:title=nil').should eql({title: nil})
+    it "should parse query with blank value" do
+      parse_query('dcterms:title=blank').should eql({title: nil})
     end
 
-    it "should parse query with empty value" do
-      parse_query('dcterms:title=empty').should eql({title: []})
+    it "should parse query with blank value" do
+      parse_query('dcterms:creator=blank').should eql({creators: []})
     end
 
     it "should parse query with decimal value" do
@@ -77,9 +67,17 @@ describe Mongoid::Oslc::Strategy do
       parse_query('dcterms:title in ["First","Second"]').should eql({title: {"$in"=>["First", "Second"]}})
     end
 
+    it "should parse query with wild char" do
+      parse_query('dcterms:title="*requirement*"').should eql({title: /requirement/})
+    end
+
+    it "should parse query with wild char" do
+      parse_query('dcterms:title="requirement*"').should eql({title: /\Arequirement/})
+    end
+
     describe "custom fields" do
       it "should parse query with custom namespace" do
-        parse_query('rtc:color="Black"').should eql({color: "Black"})
+        parse_query('oslc_custom:color="Black"').should eql({color: "Black"})
       end
     end
   end

data/spec/lib/mongoid/oslc_spec.rb

@@ -1,15 +1,20 @@
 require 'spec_helper'
 
-class MongoDocument
-  include Mongoid::Document
-  include Mongoid::Oslc
+describe Mongoid::Oslc do
+  subject { MongoDocument.new }
 
-  oslc_field :title, type: String, mapping: 'dcterms:title'
+  it { subject.domain.should eql    'oslc_cm' }
+  it { subject.describe.should eql  'http://open-services.net/ns/cm#ChangeRequest' }
 
-end
+  describe "#oslc_value" do
+    before do
+      subject.title = 'Document title'
+    end
 
-describe Mongoid::Oslc do
-  subject { MongoDocument.new }
+    it "should return title value" do
+      subject.oslc_value('dcterms:title').should eql 'Document title'
+    end
+  end
 
   describe "class" do
     it "should have method #oslc_where" do

data/spec/spec_helper.rb

@@ -5,6 +5,24 @@ require 'mongoid/oslc'
 
 require 'rspec'
 
+class MongoDocument
+  include Mongoid::Document
+  include Mongoid::Oslc
+  include Mongoid::Timestamps
+
+  domain    'oslc_cm'
+  describe  'http://open-services.net/ns/cm#ChangeRequest'
+
+  oslc_field :title,        type: String, mapping: 'dcterms:title'
+  oslc_field :description,  type: String, mapping: 'dcterms:description'
+  oslc_field :creators,     type: Array,  mapping: 'dcterms:creator', value_type: 'Resource', default: []
+  oslc_field :closed,       type: Boolean,mapping: 'oslc_cm:closed'
+
+  register_oslc_field :created_at, mapping: 'dcterms:created',  value_type: 'DateTime'
+  register_oslc_field :updated_at, mapping: 'dcterms:modified', value_type: 'DateTime'
+
+end
+
 Mongoid.configure do |config|
   config.connect_to('mongoid_oslc_where_test')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_oslc
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-05 00:00:00.000000000 Z
+date: 2013-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -121,6 +121,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -135,11 +136,13 @@ files:
 - lib/mongoid/oslc/version.rb
 - lib/mongoid_oslc.rb
 - mongoid_oslc.gemspec
+- spec/lib/mongoid/oslc/resources_spec.rb
 - spec/lib/mongoid/oslc/strategy_spec.rb
 - spec/lib/mongoid/oslc_spec.rb
 - spec/spec_helper.rb
-homepage: ''
-licenses: []
+homepage: http://github.com/versative/mongoid_oslc
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -152,7 +155,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3353479294008417306
+      hash: -3967237591695565408
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -161,14 +164,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3353479294008417306
+      hash: -3967237591695565408
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: ''
+summary: Extension for mongoid to parse oslc.where
 test_files:
+- spec/lib/mongoid/oslc/resources_spec.rb
 - spec/lib/mongoid/oslc/strategy_spec.rb
 - spec/lib/mongoid/oslc_spec.rb
 - spec/spec_helper.rb