msfl 1.2.0 → 1.2.1.dev1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9ef0585bfa75b7826d47d868b90dfbf41db7974
-  data.tar.gz: efa739290d0c5d8385bcf6c058505d61a3655d42
+  metadata.gz: 06a5c190ca1f28269f35a382637758327bb4d601
+  data.tar.gz: f0bfb4e6be47d3d69b6b4a568bf70247f30a9fcd
 SHA512:
-  metadata.gz: 414df49e29c8205a0e9aa0f1f2cf2d50e7876c730ddbdb2b47e865f42fd7f4734aa5b90002edda0c8dea1a03f4b6d075f4677d36538a168533e976bf19fa49f9
-  data.tar.gz: 164c713872e391bf2a94a373a852b01ab6b0cea05a41698ea9cec4cf11aebf056dd0f512afe914c31464bb24892e8855898203baa936b2b16827e0a08e281461
+  metadata.gz: f55554e68871ad1faf1421d380881229f3ef9092c4d2d37776cb1873e523291cf0915a9a0998b592820738433710f1c8f50fe7a34fa066b597a11575bbc8a6c0
+  data.tar.gz: b9c507c62f4dab0cd1312971b7bddc77632c94738e3b0428b36e79fd945d075274360c57bbd75087ca534f9321983ab870943a1b280fa2822173ea2481c5a3b9

data/lib/msfl/datasets/base.rb

@@ -41,6 +41,17 @@ module MSFL
         MSFL::Datasets::Base.registered_datasets = registered_datasets
       end
 
+
+      # Returns a new instance of the specified dataset.
+      #
+      # @param dataset_name [Symbol] the name of the dataset to instantiate
+      # @return [MSFL::Datasets::Base, Nil] a new instance of the specified dataset, if it can be found, otherwise nil
+      def self.dataset_from(dataset_name)
+        klass = MSFL::Datasets::Base.registered_datasets[dataset_name]
+        dataset = klass.new if klass
+        dataset ||= nil
+      end
+
       # The descendant class MUST override this method otherwise all field validations will fail
       #
       # The method defines an array of symbols, indicating what fields are supported for the Dataset
@@ -50,6 +61,23 @@ module MSFL
         raise NoMethodError, "Descendants of MSFL::Datasets::Base are required to implement the #fields method"
       end
 
+      # Returns true if the specified field is valid directly or through a foreign dataset
+      #
+      # @param field_name [Symbol] the name of the field to check and see if the dataset supports it
+      # @return [Bool] true if the field is supported by the dataset
+      # @todo write direct test of this
+      def has_field?(field_name)
+        direct_fields = self.fields
+        foreigns.each do |f|
+          foreign_dataset = self.class.dataset_from f
+          if foreign_dataset
+            direct_fields.concat foreign_dataset.fields
+          end
+        end
+        direct_fields.include? field_name
+      end
+
+
       # The descendant class SHOULD override this method, in future versions of MSFL it is execpted to
       # become a MUST for descendants to override.
       #
@@ -73,6 +101,22 @@ module MSFL
         hash_key_operators
       end
 
+      # If the dataset supports the operator this method returns true
+      #
+      # @param operator [Symbol] the operator to check if the dataset supports it
+      # @return [Bool] true if the dataset supports the operator
+      # @todo write test of this guy
+      def has_operator?(operator)
+        ops = operators
+        foreigns.each do |f|
+          foreign_dataset = self.class.dataset_from f
+          if foreign_dataset
+            ops.concat foreign_dataset.operators
+          end
+        end
+        ops.include? operator
+      end
+
       # This method returns the errors argument. The errors argument is unchanged if type conformity validation passes,
       # otherwise an error is added to errors.
       #

data/lib/msfl/datasets/car.rb

@@ -12,7 +12,7 @@ module MSFL
       end
 
       def fields
-        [:make, :model, :year, :value].concat foreigns
+        [:make, :model, :year, :value]
       end
     end
   end

data/lib/msfl/datasets/person.rb

@@ -12,7 +12,7 @@ module MSFL
       end
 
       def fields
-        [:name, :gender, :age].concat foreigns
+        [:name, :gender, :age]
       end
     end
   end

data/lib/msfl/sinatra.rb

@@ -27,7 +27,7 @@ module MSFL
       def dataset_from(params)
         dataset_name = params[:dataset].to_sym unless params[:dataset].nil?
         dataset_name ||= nil
-        Datasets::Base.registered_datasets[dataset_name].new if Datasets::Base.registered_datasets.has_key?(dataset_name)
+        Datasets::Base.dataset_from dataset_name
       end
 
       # Creates a semantic validator instance that is ready to validate the dataset

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

@@ -4,7 +4,7 @@ module MSFL
       module HashKey
 
         def valid_hash_key?(key)
-          valid_hash_keys.include? key
+          self.dataset.has_operator?(key) || self.dataset.has_field?(key)
         end
 
         def valid_hash_keys
@@ -30,7 +30,9 @@ module MSFL
               :gt,          # >
               :gte,         # >=
               :neg,         # logical negation
-
+              :foreign,     # Defines a filter on a related item
+              :dataset,     # A foreign dataset
+              :filter,      # an explicit filter
           ]
         end
 

data/lib/msfl/validators/semantic.rb

@@ -73,10 +73,10 @@ module MSFL
           # Then make a recursive call to validate on the value so that it and its elements are validated
           #  later I might be able to optimize this by only making the recursive call for Sets and Hashes
           #
-          if dataset.operators.include? key
+          if dataset.has_operator? key
             dataset.validate_operator_conforms key, current_field, errors
             opts[:parent_operator] = key
-          elsif dataset.fields.include? key
+          elsif dataset.has_field? key
             current_field = key
             dataset.validate_type_conforms value, current_field, errors
             dataset.validate_value_conforms value, current_field, errors

data/msfl.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'msfl'
-  s.version     = '1.2.0'
-  s.date        = '2015-05-12'
+  s.version     = '1.2.1.dev1'
+  s.date        = '2015-05-20'
   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/sinatra_spec.rb

@@ -1,4 +1,6 @@
 require 'spec_helper'
+require 'msfl/datasets/car'
+require 'msfl/datasets/person'
 
 
 describe "MSFL::Sinatra" do
@@ -93,5 +95,17 @@ describe "MSFL::Sinatra" do
     let(:params) { nil }
 
     it_behaves_like "an invocation of MSFL::Sinatra.validate"
+
+    context "when validating a foreign" do
+
+      context "when the foreign is valid" do
+
+        let(:params) { { dataset: :car, filter: filter } }
+
+        let(:filter) { { foreign: { dataset: 'person', filter: { age: { gte: 25 } } } } }
+
+        it { is_expected.to eq true }
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: msfl
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1.dev1
 platform: ruby
 authors:
 - Courtland Caldwell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-12 00:00:00.000000000 Z
+date: 2015-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -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: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2