msfl 1.2.0.dev4 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64f2f1391e2c2d84010f3f24dea6c05876914c0a
-  data.tar.gz: 043011b2811609dca0d3c64f77bf3bc38fc18736
+  metadata.gz: b9ef0585bfa75b7826d47d868b90dfbf41db7974
+  data.tar.gz: efa739290d0c5d8385bcf6c058505d61a3655d42
 SHA512:
-  metadata.gz: a76a648c5915c1f12bffe6df8ccbc177a664414046df5690d5e1ed71325b825aa2914a8b9ebc836376818347ff8db797adb35a2bb694cdbf37147fbd39d84217
-  data.tar.gz: 60ba3c0cf3aedf8dea480b7eb79072a49002ec27a22143f2dbda12e66e1825be7bf29ce2374fe90b707c54a8566c536ac733684bbb9e2698127fb7f45ac4a992
+  metadata.gz: 414df49e29c8205a0e9aa0f1f2cf2d50e7876c730ddbdb2b47e865f42fd7f4734aa5b90002edda0c8dea1a03f4b6d075f4677d36538a168533e976bf19fa49f9
+  data.tar.gz: 164c713872e391bf2a94a373a852b01ab6b0cea05a41698ea9cec4cf11aebf056dd0f512afe914c31464bb24892e8855898203baa936b2b16827e0a08e281461

data/README.md

@@ -17,6 +17,50 @@ that you need faceted filtering in your application then this will seem second n
 
 Contains serializers and validators (and perhaps other) MSFL goodies
 
+# Converters
+
+One aspect of the msfl gem is the conversion of standard msfl into what we internally call NMSFL (normalized Mattermark
+Semantic Filter Language). NMSFL serves as an intermediate language in which some of the human friendly conveniences
+are replaced with a syntax that is easier for machines to parse.
+
+## A noop conversion
+```ruby
+require 'msfl'
+# Require one of the test datasets
+require 'msfl/datasets/car'
+
+msfl      = { make: "Chevy" }
+converter = MSFL::Converters::Operator.new
+nmsfl     = converter.run_conversions msfl
+
+=> {:make=>"Chevy"}
+```
+
+## A conversion from an implicit AND to an explicit one
+```ruby
+require 'msfl'
+# Require one of the test datasets
+require 'msfl/datasets/car'
+
+msfl      = { make: "Chevy", year: { gt: 2000 } }
+converter = MSFL::Converters::Operator.new
+nmsfl     = converter.run_conversions msfl
+
+=> {:and=>#<MSFL::Types::Set: {{:make=>"Chevy"}, {:year=>{:gt=>2000}}}>}
+```
+
+## A conversion from between to gte / lte
+```ruby
+require 'msfl'
+# Require one of the test datasets
+require 'msfl/datasets/car'
+
+msfl      = { year: { between: { start: 2010, end: 2015 } } }
+converter = MSFL::Converters::Operator.new
+nmsfl     = converter.run_conversions msfl
+
+=> {:and=>#<MSFL::Types::Set: {{:year=>{:gte=>2010}}, {:year=>{:lte=>2015}}}>}
+```
 ## EBNF
 
 MSFL is a context-free language. The context-free grammar is defined below.

data/lib/msfl/converters/operator.rb

@@ -109,6 +109,9 @@ module MSFL
             result = i_to_e_bin_op obj, parent_key
           elsif logical_operators.include?(first_key)
             result = i_to_e_log_op obj, parent_key
+          elsif first_key == :partial
+            result = { partial: { given: implicit_and_to_explicit_recursively(obj[:partial][:given]),
+                                  filter: implicit_and_to_explicit_recursively(obj[:partial][:filter]) } }
           else
             # the first key is not an operator
             # if there is only one key just assign the result of calling this method recursively on the value to the result for the key

data/lib/msfl/validators/definitions/hash_key.rb

@@ -13,7 +13,7 @@ module MSFL
 
         # Operators still needing parsing: ellipsis2, tilda
         def hash_key_operators
-          binary_operators.concat(logical_operators)
+          binary_operators.concat(logical_operators).concat(partial_operators)
         end
 
         def binary_operators
@@ -30,6 +30,15 @@ module MSFL
               :gt,          # >
               :gte,         # >=
               :neg,         # logical negation
+
+          ]
+        end
+
+        def partial_operators
+          [
+              :partial,     # faceted / aggregate
+              :given,       # given
+              :filter,      # explicit filter
           ]
         end
 

data/msfl.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'msfl'
-  s.version     = '1.2.0.dev4'
+  s.version     = '1.2.0'
   s.date        = '2015-05-12'
   s.summary     = "MSFL in Ruby"
   s.description = "Serializers, validators, and other tasty goodness for the Mattermark Semantic Filter Language in Ruby."

data/spec/msfl/converters/operator_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe "MSFL::Converters::Operator" do
+describe MSFL::Converters::Operator do
 
   describe "#run_conversions" do
 
@@ -573,4 +573,17 @@ describe "MSFL::Converters::Operator" do
       end
     end
   end
+
+  describe "running conversions on a normal msfl filter containing a partial" do
+
+    subject { converter.run_conversions msfl }
+
+    let(:converter) { described_class.new }
+
+    let(:msfl) { { partial: { given: { make: "Toyota" }, filter: { avg_age: 10 } } } }
+
+    it "is unchanged" do
+      expect(subject).to eq msfl
+    end
+  end
 end

data/spec/msfl/datasets/base_spec.rb

@@ -66,4 +66,13 @@ describe "MSFL::Datasets::Base" do
       expect(mut).to eq errors
     end
   end
+
+  describe "#foreigns" do
+
+    subject { test_instance.foreigns }
+
+    it "is intended to be overridden" do
+      expect(subject).to eq []
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: msfl
 version: !ruby/object:Gem::Version
-  version: 1.2.0.dev4
+  version: 1.2.0
 platform: ruby
 authors:
 - Courtland Caldwell
@@ -152,9 +152,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2