msfl 1.1.6 → 1.2.0.dev

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9034a3e616954189429dc66d76be624f065b5f9b
-  data.tar.gz: 8ef828b22da3158dc126e3d8ae8a148bdf82f9b9
+  metadata.gz: 836568a1640ce165512978aa087ea16d8c87088e
+  data.tar.gz: d5898063d32d174b84522ab16a56265b4453b9a8
 SHA512:
-  metadata.gz: fe03bb90fc8cd612c5914217600a02dfb3a8fd4a5e08e6f701b5e80cdb704f8128e8335c245300d7a2ed6ad2d45b051ac804b496b7386f7350f3484aecf0975d
-  data.tar.gz: 920a0e38dbf3256d45695c60dced75252ddff4d8cf7babaa63825da13b72fb36c220dc13f08ccf364474b0478eb888c7854d01479b39c5e5562865b71ec24fc5
+  metadata.gz: 5df4af19fc17ababf06c3570af87f93021d6ff4dc7bfedf936dfe9942f3e4016d15e6eb5a8b4f73bb38292996ff173b36263eff1d0e24fe78a1f376f5662fcb2
+  data.tar.gz: ded9b1ceae6f7806502a2f8a3e0c5c3e5c19968c3a5dec9fac35e3d0f1ff7fe9eab8857feb13ae1ce92764ad085335a1ee16987861a60b2dc4a1172e5330eee6

data/README.md

@@ -1,5 +1,18 @@
 [![Circle CI](https://circleci.com/gh/Referly/msfl.svg?style=svg)](https://circleci.com/gh/Referly/msfl)
 
+# MSFL
+
+The Mattermark Semantic Filter Language is a language for _filtering_ data. It allows users to construct filters
+on sets of data in a Venn diagram like fashion. More formally it allows the user to create subsets of data.
+
+MSFL is different than other languages - it is _not_ a query language. It has no notion of concepts like _order_,
+_limit_, _offset_, _group_by_, or _having_.
+
+It does support faceted filtering through a vocabulary added in 1.2 which allows the user to define filters
+on the hyperset of the data. (In the non-hyper case all of the extra dimensions are simplified to constants.) If
+you don't know what faceted filtering is or this sounds overwhelming, just ignore this bit. When you get to the point
+that you need faceted filtering in your application then this will seem second nature.
+
 # Ruby Gem for the Mattermark Semantic Filter Language
 
 Contains serializers and validators (and perhaps other) MSFL goodies
@@ -8,27 +21,191 @@ Contains serializers and validators (and perhaps other) MSFL goodies
 
 MSFL is a context-free language. The context-free grammar is defined below.
 
-I'm not actually sure this is correct, it is definitely not comprehensive as it skips over the shortcut functionality.
+    # EXPRESSIONS
+
+    filter          =   lc , { filter_expr } , rc ;
+
+    filter_expr     =   range_expr
+                    |   binary_expr
+                    |   set_expr
+                    |   partial_expr
+                    |   foreign_expr ;
+
+    range_expr      =   between ;
+
+    binary_expr     =   comparisons
+                    |   containment ;
+
+    set_expr        =   and
+                    |   or ;
+
+    partial_expr    =   partial_op , colon , partial ;
+
+    foreign_expr    =   word , colon , filter ;
+
+    partial         =   lc , given_expr , comma , partial_filter , rc ;
+
+    given_expr      =   given_op , colon, filter ;
+
+    partial_filter  =   filter_op , colon , filter ;
+
+    between         =   value , colon , start_end
+                    |   value , colon , between_body ;
+
+    comparisons     =   comparison , { comma , comparison } ;
+
+    containment     =   word , colon , in_expr ;
+
+    and             =   and_op , colon , filters ;
+
+    or              =   or_op , colon , filters ;
+
+    comparison      =   word , colon , value
+                    |   word , colon , lc , comparison_list , rc ;
+
+    comparison_list =   comparison_expr , { comma , comparison_expr } ;
+
+    comparison_expr =   comparison_op , colon , value ;
+
+    in_expr         =   lc , in_op , colon , values , rc ;
+
+    filters         =   ls , { filter } , rs ;
+
+    values          =   ls , { value } , rs ;
+
+    between_body    =   lc , between_op , colon , start_end , rc ;
+
+    start_end       =   lc , start_expr , comma , end_expr , rc ;
+
+    start_expr      =   start_op , colon , range_value ;
+
+    end_expr        =   end_op , colon , range_value ;
+
+
+
+    # OPERATORS
+
+    partial_op      =   dq , "partial" , dq ;
+
+    given_op        =   dq , "given" , dq ;
+
+    filter_op       =   dq , "filter" , dq ;
+
+    in_op           =   dq , "in" , dq ;
+
+    between_op      =   dq , "between" , dq ;
+
+    start_op        =   dq , "start" , dq ;
+
+    end_op          =   dq , "end" , dq ;
+
+    comparison_op   =   lt_op
+                    |   gt_op
+                    |   lte_op
+                    |   gte_op
+                    |   eq_op ;
+
+    lt_op           =   dq , "lt" , dq ;
+
+    gt_op           =   dq , "gt" , dq ;
+
+    lte_op          =   dq , "lte" , dq ;
+
+    gte_op          =   dq , "gte" , dq ;
+
+    eq_op           =   dq , "eq" , dq ;
+
+    and_op          =   dq , "and" , dq ;
+
+    or_op           =   dq , "or" , dq ;
+
+
+
+    # VALUES AND TYPES
+
+    range_value     =   number
+                    |   date
+                    |   datetime
+                    |   time ;
+
+    value           =   word
+                    |   range_value
+                    |   boolean ;
+
+    word            =   dq , character , { character } , dq ;
+
+    number          =   integer | decimal ;
+
+    integer         =   [ hyphen ] , digit , { digit } ;
+
+    decimal         =   integer
+                    |   { integer } , dot , { digit } ;
+
+    boolean         =   true | false ;
+
+    true            =   "true"
+                    |   dq , "true" , dq
+                    |   "1"
+                    |   dq , "1" , dq ;
+
+    false           =   "false"
+                    |   dq , "false" , dq
+                    |   "0"
+                    |   dq , "0" , dq ;
+
+    date            =   ? ISO 8601 date format http://en.wikipedia.org/wiki/ISO_8601 ? ;
+
+    datetime        =   ? ISO 8601 combined date and time format http://en.wikipedia.org/wiki/ISO_8601 ? ;
+
+    time            =   ? ISO 8601 time format http://en.wikipedia.org/wiki/ISO_8601 ? ;
+
+    character       =   letter
+                    |   digit
+                    |   symbol ;
+
+    letter          =   "A" | "B" | "C" | "D" | "E" | "F" | "G"
+                    |   "H" | "I" | "J" | "K" | "L" | "M" | "N"
+                    |   "O" | "P" | "Q" | "R" | "S" | "T" | "U"
+                    |   "V" | "W" | "X" | "Y" | "Z"
+                    |   "a" | "b" | "c" | "d" | "e" | "f" | "g"
+                    |   "h" | "i" | "j" | "k" | "l" | "m" | "n"
+                    |   "o" | "p" | "q" | "r" | "s" | "t" | "u"
+                    |   "v" | "w" | "x" | "y" | "z" ;
+
+    digit           =   "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" ;
+
+    symbol          =   "'" | "~" | "." | "_" | "-" | ":" | "?" | "/" | "=" | "@" | "&" ;
+
+    left_curly      =   "{" ;
+
+    lc              =   left_curly ;
+
+    right_curly     =   "}" ;
+
+    rc              =   right_curly ;
+
+    left_square     =   "[" ;
+
+    ls              =   left_square ;
+
+    right_square    =   "]" ;
+
+    rs              =   right_square ;
+
+    comma           =   "," ;
+
+    hyphen          =   "-" ;
+
+    colon           =   ":" ;
+
+    double_quote    =   '"' ;
+
+    dq              =   double_quote ;
+
+    dot             =   "." ;
+
+
 
-```
-filter = range_op | binary_op | set_op
-set_op = and | or
-and = "{" "\"and\"" ":" list "}"
-or = "{" "\"or\"" ":" list "}"
-list = "[" filter? | (filter ("," filter)*) "]";
-range_op = between;
-between = "{" field ":" between_body | "{" "\"between\"" ":" between_body "}";
-between_body = "{" "\"start\"" ":" between_start "," "\"end\"" ":" between_end "}";
-between_start = integer | double | date | datetime | time;
-between_end = integer | double | date | datetime | time;
-binary_op = comparison | containment;
-comparison = "{" field ":" "{" comparison_op ":" atom "}" "}";
-field = "\"" ALPHANUMERIC+ "\"";
-comparison_op = "lt" | "gt" | "lte" | "gte" | "eq";
-containment = "{" field ":" "{" "\"in\"" ":" atom_list "}" "}";
-atom = string | integer | double | boolean | date | datetime | time;
-atom_list = "[" atom? | (atom ("," atom)*) "]";
-```
 
 ## Configuration
 
@@ -69,6 +246,14 @@ After parsing a MSFL filter it can be validated. Currently the validation is pri
 semantic validation on a per dataset basis. This will allow per attribute validations to be setup by the consumer
 of this gem, which will be run automatically during validation.
 
+Validation works in the following order
+
+1. Grammar validation
+
+2. Dataset configured validation
+
+3. Dataset semantic validation
+
 ## Frameworks
 
 ### Sinatra

data/lib/msfl/datasets/car.rb

@@ -8,7 +8,7 @@ module MSFL
       register_dataset
 
       def fields
-        [:make, :model, :year, :value]
+        [:make, :model, :year, :value, :owner]
       end
     end
   end

data/lib/msfl/datasets/person.rb

@@ -0,0 +1,15 @@
+require_relative 'base'
+
+module MSFL
+  module Datasets
+    # This is a fake dataset definition that shows the structure for composing your own and is used for testing
+    #  msfl
+    class Person < ::MSFL::Datasets::Base
+      register_dataset
+
+      def fields
+        [:name, :gender, :age, :cars]
+      end
+    end
+  end
+end

data/lib/msfl/parsers/json.rb

@@ -16,7 +16,7 @@ module MSFL
         obj
       end
 
-      # Converts Ruby Arrays is a partially parsed Ruby MSFL filter to MSFL::Types::Set objects
+      # Converts Ruby Arrays in a partially parsed Ruby MSFL filter to MSFL::Types::Set objects
       #
       # @param obj [Object] the object in which to convert Ruby Array objects to MSFL::Types::Set objects
       # @return [Object] the result of converting Ruby Arrays to MSFL::Types::Set objects

data/msfl.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'msfl'
-  s.version     = '1.1.6'
-  s.date        = '2015-04-01'
+  s.version     = '1.2.0.dev'
+  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."
   s.authors     = ["Courtland Caldwell"]

data/spec/msfl/parsers/json_spec.rb

@@ -34,6 +34,27 @@ describe "MSFL::Parsers::JSON" do
       it { is_expected.to be_a MSFL::Types::Set }
     end
 
+    context "when parsing a foreign" do
+
+      # The test scenario here is if we are limiting the set of cars by person criteria (only cars owned by people over 25)
+
+      let(:test_json) { '{"person":{"age":{"gte":25}}}' }
+
+      it "is an equivalent Ruby hash" do
+        expect(mut).to eq({ person: { age: { gte: 25 } } })
+      end
+
+    end
+
+    context "when parsing a partial" do
+
+      let(:test_json) { '{"partial":{"given":{"make":"Toyota"},"filter":{"avg_age":10}}}'}
+
+      it "is an equivalent Ruby Hash" do
+        expect(mut).to eq({ partial: { given: { make: "Toyota" }, filter: { avg_age: 10 } } })
+      end
+    end
+
   end
 
   describe ".arrays_to_sets" do

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: msfl
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 1.2.0.dev
 platform: ruby
 authors:
 - Courtland Caldwell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-01 00:00:00.000000000 Z
+date: 2015-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.3'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
 description: Serializers, validators, and other tasty goodness for the Mattermark
@@ -101,7 +101,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -116,6 +116,7 @@ files:
 - lib/msfl/datasets/base.rb
 - lib/msfl/datasets/car.rb
 - lib/msfl/datasets/movie.rb
+- lib/msfl/datasets/person.rb
 - lib/msfl/parsers.rb
 - lib/msfl/parsers/json.rb
 - lib/msfl/sinatra.rb
@@ -146,17 +147,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: MSFL in Ruby