pathway 0.11.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27b3570a78198f711d1d781ec9f48cdf2cbe8846034abda268f5137f6c88f2fe
-  data.tar.gz: d10a76ae2edb906058ac291a8e106f05457bf89ce86558355f331ddbc058b5d1
+  metadata.gz: bb77df296a81bb4d0d277c4c802e990727f58e9c6fd5dee20ca3e0986aa954f2
+  data.tar.gz: 6921ad015f25c29bf669d815b86518eba9c11938da78f8f37aec9ab6d9a3ed4f
 SHA512:
-  metadata.gz: 751de3262b354b783d190959c2c72d251c73226886d4e808fe47421283e93961fd124d51dd65bb52df206532e24c3daf007487df384c0f45e1ce323d7cc1d537
-  data.tar.gz: b21d812ee34395e29d160613e791fb0f2616351da56445653623429fbb9da091d8dba6d64bc2123de51799022aa9182a157ab985a848f68977a37d754e86c5b0
+  metadata.gz: 1f1d59e04131f194731a6890aa40cf498df3bd15fbe65818ed6e90b43e3a96a1ef94d647737bd94fa8e1e43eef3583a3bcc04df03c7e45ea155f7e6f998610a1
+  data.tar.gz: 222112d0f9a8a7c23499afa2d656f961fdef7e32df3de6c165e55fb81357d2db27605ea3882d1d7d2c1886165f25b27d9d272d6c493cd5fd5bfe5894ff25ae18

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.11.1] - 2020-01-09
+### Changed
+- Improve custom `rspec` matchers for testing field presence on schemas
+
 ## [0.11.0] - 2020-01-02
 ### Changed
 - Add support for `dry-validation` 1.0 and above

data/lib/pathway/rspec/matchers/accept_optional_fields.rb

@@ -6,27 +6,38 @@ RSpec::Matchers.define :accept_optional_fields do |*fields|
   match do |form|
     @form, @fields = form, fields
 
-    not_defined.empty? && not_optional.empty?
+    not_defined.empty? &&
+      not_optional.empty? &&
+      allowing_null_values_matches? &&
+      not_allowing_null_values_matches?
   end
 
   match_when_negated do |form|
+    raise NotImplementedError, 'expect().not_to accept_optional_fields.not_allowing_null_values is not supported.' if @allowing_null_values || @not_allowing_null_values
+
     @form, @fields = form, fields
 
     not_defined.empty? && optional.empty?
   end
 
   description do
-    "accept #{field_list} as optional #{pluralize_fields}"
+    null_value_allowed = @allowing_null_values ? ' allowing null values' : ''
+    null_value_disallowed = @not_allowing_null_values ? ' not allowing null values' : ''
+    "accept #{field_list} as optional #{pluralize_fields}#{null_value_allowed}#{null_value_disallowed}"
   end
 
   failure_message do
-    "Expected to accept #{field_list} as optional #{pluralize_fields} but " +
-      [not_optional_list, not_defined_list].compact.join("; and ")
+    null_value_allowed = @allowing_null_values ? ' allowing null values' : ''
+    null_value_disallowed = @not_allowing_null_values ? ' not allowing null values' : ''
+
+    "Expected to accept #{field_list} as optional #{pluralize_fields}#{null_value_allowed}#{null_value_disallowed} but " +
+      as_sentence([not_optional_list, not_defined_list, accepting_null_list, not_accepting_null_list].compact,
+                  connector: '; ', last_connector: '; and ')
   end
 
   failure_message_when_negated do
     "Did not expect to accept #{field_list} as optional #{pluralize_fields} but " +
-      [optional_list, not_defined_list].compact.join("; and ")
+      [optional_list, not_defined_list].compact.join('; and ')
   end
 
   include Pathway::Rspec::FormSchemaHelpers
@@ -36,7 +47,19 @@ RSpec::Matchers.define :accept_optional_fields do |*fields|
   end
 
   def not_optional_list
-    "#{as_list(not_required)} #{were_was(not_required)} not optional" if not_optional.any?
+    "#{as_list(not_optional)} #{were_was(not_optional)} not optional" if not_optional.any?
+  end
+
+  chain :allowing_null_values do
+    fail 'cannot use allowing_null_values and not_allowing_null_values at the same time' if @not_allowing_null_values
+
+    @allowing_null_values = true
+  end
+
+  chain :not_allowing_null_values do
+    fail 'cannot use allowing_null_values and not_allowing_null_values at the same time' if @allowing_null_values
+
+    @not_allowing_null_values = true
   end
 end
 

data/lib/pathway/rspec/matchers/form_schema_helpers.rb

@@ -21,6 +21,14 @@ module Pathway
         "#{as_list(not_defined)} #{were_was(not_defined)} not defined" if not_defined.any?
       end
 
+      def accepting_null_list
+        "#{as_list(null_value_allowed)} #{were_was(null_value_allowed)} accepting null values" if @not_allowing_null_values && null_value_allowed.any?
+      end
+
+      def not_accepting_null_list
+        "#{as_list(null_value_disallowed)} #{were_was(null_value_disallowed)} not accepting null values" if @allowing_null_values && null_value_disallowed.any?
+      end
+
       def required
         @required ||= @fields.select { |field| required?(field) }
       end
@@ -29,12 +37,20 @@ module Pathway
         @optional ||= @fields.select { |field| optional?(field) }
       end
 
+      def null_value_allowed
+        @null_value_allowed ||= @fields.select { |field| null_value_allowed?(field) }
+      end
+
+      def null_value_disallowed
+        @null_value_disallowed ||= @fields.select { |field| null_value_disallowed?(field) }
+      end
+
       def not_required
         @not_required ||= defined - required
       end
 
       def not_optional
-        @not_required ||= defined - optional
+        @not_optional ||= defined - optional
       end
 
       def not_defined
@@ -60,6 +76,26 @@ module Pathway
           left.type == :predicate && left.name == :key? && left.args.first == field
         end
       end
+
+      def allowing_null_values_matches?
+        @allowing_null_values ? @fields.all? { |field| null_value_allowed?(field) } : true
+      end
+
+      def not_allowing_null_values_matches?
+        @not_allowing_null_values ? @fields.all? { |field| null_value_disallowed?(field) } : true
+      end
+
+      def null_value_allowed?(field)
+        rule = rules[field]&.right&.rule
+        predicate = rule&.left
+        predicate.present? && predicate.type == :not && predicate.rules&.first&.name == :nil?
+      end
+
+      def null_value_disallowed?(field)
+        rule = rules[field]&.right&.rule
+        predicate = rule&.left
+        predicate.present? && predicate.type == :predicate && predicate.name == :filled?
+      end
     end
   end
 end

data/lib/pathway/rspec/matchers/list_helpers.rb

@@ -3,8 +3,8 @@
 module Pathway
   module Rspec
     module ListHelpers
-      def as_list(items)
-        as_sentence(items.map(&:inspect))
+      def as_list(items, **kwargs)
+        as_sentence(items.map(&:inspect), **kwargs)
       end
 
       def as_sentence(items, connector: ', ', last_connector: ' and ')

data/lib/pathway/rspec/matchers/require_fields.rb

@@ -6,27 +6,38 @@ RSpec::Matchers.define :require_fields do |*fields|
   match do |form|
     @form, @fields = form, fields
 
-    not_defined.empty? && not_required.empty?
+    not_defined.empty? &&
+      not_required.empty? &&
+      allowing_null_values_matches? &&
+      not_allowing_null_values_matches?
   end
 
   match_when_negated do |form|
+    raise NotImplementedError, 'expect().not_to require_fields.not_allowing_null_values is not supported.' if @allowing_null_values || @not_allowing_null_values
+
     @form, @fields = form, fields
 
     not_defined.empty? && required.empty?
   end
 
   description do
-    "require #{field_list} as #{pluralize_fields}"
+    null_value_allowed = @allowing_null_values ? ' allowing null values' : ''
+    null_value_disallowed = @not_allowing_null_values ? ' not allowing null values' : ''
+    "require #{field_list} as #{pluralize_fields}#{null_value_allowed}#{null_value_disallowed}"
   end
 
   failure_message do
-    "Expected to require #{field_list} as #{pluralize_fields} but " +
-      [not_required_list, not_defined_list].compact.join("; and ")
+    null_value_allowed = @allowing_null_values ? ' allowing null values' : ''
+    null_value_disallowed = @not_allowing_null_values ? ' not allowing null values' : ''
+
+    "Expected to require #{field_list} as #{pluralize_fields}#{null_value_allowed}#{null_value_disallowed} but " +
+      as_sentence([not_required_list, not_defined_list, accepting_null_list, not_accepting_null_list].compact,
+                  connector: '; ', last_connector: '; and ')
   end
 
   failure_message_when_negated do
     "Did not expect to require #{field_list} as #{pluralize_fields} but " +
-      [required_list, not_defined_list].compact.join("; and ")
+      [required_list, not_defined_list].compact.join('; and ')
   end
 
   include Pathway::Rspec::FormSchemaHelpers
@@ -38,6 +49,18 @@ RSpec::Matchers.define :require_fields do |*fields|
   def not_required_list
     "#{as_list(not_required)} #{were_was(not_required)} not required" if not_required.any?
   end
+
+  chain :allowing_null_values do
+    fail 'cannot use allowing_null_values and not_allowing_null_values at the same time' if @not_allowing_null_values
+
+    @allowing_null_values = true
+  end
+
+  chain :not_allowing_null_values do
+    fail 'cannot use allowing_null_values and not_allowing_null_values at the same time' if @allowing_null_values
+
+    @not_allowing_null_values = true
+  end
 end
 
 RSpec::Matchers.alias_matcher :require_field, :require_fields

data/lib/pathway/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pathway
-  VERSION = '0.11.0'
+  VERSION = '0.11.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pathway
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Pablo Herrero
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-02 00:00:00.000000000 Z
+date: 2020-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-inflector