msfl_visitors 0.3.0.dev4 → 0.3.0.dev5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4554f6371fd69d07d2a7641ae0204d456e562015
-  data.tar.gz: 70c7283ab86975001e30f3bc8d3a05f931237a30
+  metadata.gz: 179b3ba53392e68b27a017eb798bf8f0035af481
+  data.tar.gz: 2e2360d9f0103674394969e4a73553d572cc5618
 SHA512:
-  metadata.gz: dbf90b327a979250cdeec535315cc365006798899e31b4f444d5de4dc5ec91636ec16bd15bcfa9280e1044347aff0f57546196a681a01b867783f7516ecabe48
-  data.tar.gz: eb4f1d5e44ec4e80dfa4821665b0047dcefd7402d6f49e30081a2144474793e60b8dc4e242e937372eada619c9f30e02542fe62b5523fdb648168a857d217b0e
+  metadata.gz: 9dd78a8a9b6cad36b44c93d887f1cb765dc3783756c95231c9b4833c725542e6549ba44a2f4c1d5b6fe2c2e85a18cba2fb9a5baa206cbd64096e09f138a11b95
+  data.tar.gz: 947ba05154658c97cebac6b5c9fd686d8a0ac2437ba17e402d493a5eca714e910efa4a269d9ce9907ed18cac100d441b067cd4309544172151f7db24ec04d65e

data/Gemfile

@@ -3,5 +3,4 @@ gem 'simplecov', :require => false, :group => :test           # MIT https://gith
 gem 'yard'                                                    # MIT https://github.com/lsegal/yard/blob/master/LICENSE + Ruby license for one file from the Ruby source lib/parser/ruby/legacy/ruby_lex.rb
 gem 'rspec'                                                   # MIT https://github.com/rspec/rspec/blob/master/License.txt
 gem 'byebug'
-gem 'msfl', "1.2.0.dev4"
-gem 'msfl_visitors', "0.3.0.dev4"
+gem 'msfl', "~> 1.2"

data/Gemfile.lock

@@ -7,10 +7,8 @@ GEM
     diff-lcs (1.2.5)
     docile (1.1.5)
     json (1.8.2)
-    msfl (1.2.0.dev4)
+    msfl (1.2.0)
       json (~> 1.7)
-    msfl_visitors (0.3.0.dev3)
-      msfl (= 1.2.0.dev4)
     rspec (3.2.0)
       rspec-core (~> 3.2.0)
       rspec-expectations (~> 3.2.0)
@@ -36,8 +34,7 @@ PLATFORMS
 
 DEPENDENCIES
   byebug
-  msfl (= 1.2.0.dev4)
-  msfl_visitors (= 0.3.0.dev3)
+  msfl (~> 1.2)
   rspec
   simplecov
   yard

data/README.md

@@ -15,15 +15,29 @@ require 'msfl_visitors'
 
 filter    = { make: "Toyota" }
 
-parser    = MSFLVisitors::Parsers::MSFLParser.new(dataset = MSFL::Datasets::Car.new)
+dataset   = MSFL::Datasets::Car.new
 
-ast       = parser.parse(filter)
+MSFLVisitors.get_chewy_clauses dataset, filter
 
-visitor   = MSFLVisitors::Visitor.new 
+=> [{:clause=>"make == \"Toyota\""}]
+
+```
 
-visitor.visit_tree ast
+## Facted example
 
-=> [{:clause=>"make == \"Toyota\""}]
+```ruby
+require 'msfl'
+# Load one of the test datasets
+require 'msfl/datasets/car'
+require 'msfl_visitors'
+
+filter    = { partial: { given: { make: "Toyota" }, filter: { avg_age: 10 } } }
+
+dataset   = MSFL::Datasets::Car.new
+
+MSFLVisitors.get_chewy_clauses dataset, filter
+
+=> [{:clause=>{partial: {terms: {make: 'Toyota'}, aggregations: { filter: { range: { avg_age: { gt: 10 }}} }}}}]
 
 ```
 

data/lib/msfl_visitors/nodes/named_value.rb

@@ -11,6 +11,11 @@ module MSFLVisitors
       def accept(visitor)
         visitor.visit(self)
       end
+
+      def ==(other)
+        self.class == other.class &&
+            value == other.value
+      end
     end
   end
 end

data/lib/msfl_visitors/parsers/msfl_parser.rb

@@ -34,7 +34,7 @@ module MSFLVisitors
             MSFLVisitors::Nodes::Word.new obj.to_s
 
           else
-            fail ArgumentError, "Invalid NMSFL, unable to parse."
+            fail ArgumentError, "Invalid NMSFL, unable to parse type: #{obj.class}."
         end
       end
 
@@ -80,7 +80,9 @@ module MSFLVisitors
               args = [hash_dispatch(:dataset, value[:dataset]), hash_dispatch(:filter, value[:filter])]
 
             when :partial
-              args = [hash_dispatch(:given, value[:given]), hash_dispatch(:filter, value[:filter])]
+              args = [hash_dispatch(:given, value[:given]),
+                      MSFLVisitors::Nodes::NamedValue.new(MSFLVisitors::Nodes::Word.new("partial"),
+                                                          hash_dispatch(:filter, value[:filter]))]
 
             when :dataset
               args = [value]

data/lib/msfl_visitors.rb

@@ -1,4 +1,3 @@
-require_relative 'msfl_visitors/ast'
 require_relative 'msfl_visitors/nodes'
 require_relative 'msfl_visitors/visitor'
 require_relative 'msfl_visitors/parsers/msfl_parser'
@@ -6,8 +5,13 @@ require_relative 'msfl_visitors/parsers/msfl_parser'
 module MSFLVisitors
 
   class << self
-    def get_chewy_clauses(dataset, nmsfl)
+    def get_chewy_clauses(dataset, msfl)
+      unless dataset.is_a? MSFL::Datasets::Base
+        raise ArgumentError, "The first argument to MSFLVisitors.get_chewy_clauses must be a descendant of MSFL::Datasets::Base."
+      end
       parser    = MSFLVisitors::Parsers::MSFLParser.new dataset
+      converter = MSFL::Converters::Operator.new
+      nmsfl     = converter.run_conversions msfl
       ast       = parser.parse nmsfl
       visitor   = MSFLVisitors::Visitor.new
       visitor.visit_tree ast

data/msfl_visitors.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'msfl_visitors'
-  s.version     = '0.3.0.dev4'
+  s.version     = '0.3.0.dev5'
   s.date        = '2015-05-15'
   s.summary     = "Convert MSFL to other forms"
   s.description = "Visitor pattern approach to converting MSFL to other forms."
@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.homepage    =
       'https://github.com/Referly/msfl_visitors'
-  s.add_runtime_dependency "msfl", "1.2.0.dev4"
+  s.add_runtime_dependency "msfl", "1.2.0"
   s.add_development_dependency "rake", "~> 10.3"
   s.add_development_dependency "simplecov", "~> 0.10"
   s.add_development_dependency "yard", "~> 0.8"

data/spec/msfl_visitors_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe MSFLVisitors do
+
+  describe ".get_chewy_clauses" do
+
+    subject { described_class.get_chewy_clauses dataset, msfl }
+
+    let(:dataset) { MSFL::Datasets::Car.new }
+
+    let(:msfl) { { make: "Toyota" } }
+
+    it "converts an msfl filter into normal MSFL form" do
+      imitation_converter = double('Imitation Converter')
+      expect(imitation_converter).to receive(:run_conversions).once
+      expect(MSFL::Converters::Operator).to receive(:new).once { imitation_converter }
+      subject
+    end
+
+    context "when the first argument is not a descendant of MSFL::Datasets::Base" do
+
+      let(:dataset) { double('Invalid Dataset') }
+
+      it "raises an ArgumentError" do
+        expect { subject }.to raise_error ArgumentError
+      end
+    end
+
+    describe "examples from README" do
+
+      context "when the filter is { make: \"Toyota\" }" do
+
+        it 'returns: [{:clause=>"make == \"Toyota\""}]' do
+          expect(subject).to eq [{:clause=>"make == \"Toyota\""}]
+        end
+      end
+
+      context "when the filter is { partial: { given: { make: \"Toyota\" }, filter: { avg_age: 10 } } }" do
+
+        let(:msfl) { { partial: { given: { make: "Toyota" }, filter: { avg_age: 10 } } } }
+
+        it "returns: [{:clause=>{partial: {terms: {make: \"Toyota\"}, aggs: { filter: { range: { avg_age: { gt: 10 }}} }}}}]" do
+          expect(subject).to eq [
+            {
+                clause: {
+                    given: {
+                        filter: { term: { make: "Toyota"} },
+                        aggs: {
+                            partial: {
+                                filter: {
+                                    term: { avg_age: 10 }
+                                }}}}},
+                method_to_execute: :aggregations
+            }
+          ]
+        end
+      end
+    end
+  end
+end

data/spec/parsers/msfl_parser_spec.rb

@@ -150,7 +150,7 @@ describe MSFLVisitors::Parsers::MSFLParser do
 
 
 
-          let(:partial_node)        { MSFLVisitors::Nodes::Partial.new given_node, explicit_filter_node }
+          let(:partial_node)        { MSFLVisitors::Nodes::Partial.new given_node, named_value }
 
             let(:given_node)          { MSFLVisitors::Nodes::Given.new [given_equal_node] }
 
@@ -161,6 +161,7 @@ describe MSFLVisitors::Parsers::MSFLParser do
                 let(:given_value_node)    { MSFLVisitors::Nodes::Word.new "Toyota" }
 
 
+          let(:named_value)    { MSFLVisitors::Nodes::NamedValue.new MSFLVisitors::Nodes::Word.new("partial"), explicit_filter_node }
             # explicit_filter_node already defined
 
               # equal_node already defined

data/spec/visitors/chewy_term_filter_spec.rb

@@ -71,24 +71,36 @@ describe MSFLVisitors::Visitor do
 
       subject { visitor.visit_tree node }
 
+      let(:expected) do
+        [{
+             clause: {
+                 given: {
+                     filter: {
+                         term: { make: "Toyota" }
+                     },
+                     aggs: {
+                         partial: {
+                             filter: { range: { age: { gt: 10 }}}
+                         }
+                     }
+                 }
+             },
+             method_to_execute: :aggregations
+         }]
+      end
+
       it "results in the appropriate aggregation clause" do
-        exp = [{
-                   clause: {
-                       given: {
-                           filter: {
-                               term: { make: "Toyota" }
-                           },
-                           aggs: {
-                               partial: {
-                                   filter: { range: { age: { gt: 10 }}}
-                               }
-                           }
-                       }
-                   },
-                   method_to_execute: :aggregations
-               }]
         visitor.mode = :aggregations
-        expect(subject).to eq exp
+        expect(subject).to eq expected
+      end
+
+      context "when the Partial node is wrapped in a Filter node" do
+
+        let(:node) { MSFLVisitors::Nodes::Filter.new([MSFLVisitors::Nodes::Partial.new(given_node, named_value)]) }
+
+        it "results in the appropriate aggregation clause" do
+          expect(subject).to eq expected
+        end
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: msfl_visitors
 version: !ruby/object:Gem::Version
-  version: 0.3.0.dev4
+  version: 0.3.0.dev5
 platform: ruby
 authors:
 - Courtland Caldwell
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.0.dev4
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.0.dev4
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +108,6 @@ files:
 - Rakefile
 - circle.yml
 - lib/msfl_visitors.rb
-- lib/msfl_visitors/ast.rb
 - lib/msfl_visitors/nodes.rb
 - lib/msfl_visitors/nodes/and.rb
 - lib/msfl_visitors/nodes/base.rb
@@ -142,7 +141,7 @@ files:
 - lib/msfl_visitors/visitor.rb
 - msfl_visitors.gemspec
 - simplecov_custom_profiles.rb
-- spec/ast_spec.rb
+- spec/msfl_visitors_spec.rb
 - spec/nodes/iterator_spec.rb
 - spec/parsers/msfl_parser_spec.rb
 - spec/spec_helper.rb
@@ -172,7 +171,7 @@ signing_key:
 specification_version: 4
 summary: Convert MSFL to other forms
 test_files:
-- spec/ast_spec.rb
+- spec/msfl_visitors_spec.rb
 - spec/nodes/iterator_spec.rb
 - spec/parsers/msfl_parser_spec.rb
 - spec/spec_helper.rb

data/lib/msfl_visitors/ast.rb

@@ -1,20 +0,0 @@
-module MSFLVisitors
-  class AST
-
-    attr_accessor :root
-
-    def initialize(obj, parser = MSFLVisitors::Parsers::MSFLParser.new)
-      self.root = parser.parse obj
-    end
-
-    # Use this method to walk the AST with a particular visitor
-    def accept(visitor)
-      root.accept visitor
-    end
-
-    def ==(other)
-      self.class == other.class &&
-          root == other.root
-    end
-  end
-end

data/spec/ast_spec.rb

@@ -1,78 +0,0 @@
-require 'spec_helper'
-
-describe MSFLVisitors::AST do
-
-  let(:msfl) { { make: "Honda" } }
-
-  describe "#initialize" do
-
-    let(:parser) do
-      p = double('Fake Parser')
-      expect(p).to receive(:parse).with(msfl).once
-      p
-    end
-
-    subject { described_class.new msfl, parser }
-
-    it "eagerly parses the first argument" do
-      subject
-    end
-
-    context "when a parser is specified" do
-
-      it "uses the specified parser" do
-        subject
-      end
-    end
-  end
-
-  describe "#accept" do
-
-    let(:parser) { double('Fake Parser', parse: root) }
-
-    let(:root) do
-      r = double('Fake Root Node')
-      expect(r).to receive(:accept).with(visitor).once
-      r
-    end
-
-    let(:visitor) { double('Fake Visitor') }
-
-    subject { described_class.new(msfl, parser).accept visitor }
-
-    it "delegates to the root node" do
-      subject
-    end
-  end
-
-  describe "#==" do
-
-    subject { left == right }
-
-    let(:left) { described_class.new(msfl) }
-
-    let(:right) { described_class.new(msfl) }
-
-    context "when the two ASTs are the same class" do
-
-      context "when the two ASTs have equal root nodes" do
-
-        it { is_expected.to be true }
-      end
-
-      context "when the two ASTs do not have equal root nodes" do
-
-        let(:right) { described_class.new({ value: 1000 }) }
-
-        it { is_expected.to be false }
-      end
-    end
-
-    context "when the two ASTs are not the same class" do
-
-      let(:right) { double('Fake AST') }
-
-      it { is_expected.to be false }
-    end
-  end
-end