phillumeny 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 53f0a80e90261ef7bd81c063c905b8cd84e95cdb
-  data.tar.gz: bb55c8e0eb57052af2bf0dec1cc6c6666c98fcf0
+SHA256:
+  metadata.gz: 8403edeb95537840758d0411c34a4cb4eac959f3ae89498309a1c3faf62c7b59
+  data.tar.gz: cdddf19e194bdf21d13f8beaaf58f5e8185986cd443b5867381033c4c872edcb
 SHA512:
-  metadata.gz: 8abac74f92990787081850397babe4fecfeeaaf1302186ce0ee64f1c006aca43dcf4e2ddb9f81c1e3504a4f541188becb47e724718139f6524bb5d2514d40f59
-  data.tar.gz: cf740b8212962b00295acb35ae679b2a0a9654b5be2e5064c89021e5d256b064d4eb981502c32f60c990095853f543db425f5cef8dc235a9e6c7922aa7a395ee
+  metadata.gz: 31e35ad66e92c1618c210c2a3a26a5d5a6f14b136c31179314e0b990d132c40163943ba0a1f213fc9e5989d9d5eabf8f6a7a8d8d3b8f7834a168d418d73f803e
+  data.tar.gz: 37a789b49915fb23ce58f7cf4ee1863226eada76cbef064b173440bac967e9cca55864519aef919345144dd5b78ae6296a93e27de0b860c65c281795e750a78c

data/lib/phillumeny/active_model.rb

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+module Phillumeny
+
+  # Matchers  testing ActiveModel functionality
+  module ActiveModel
+
+    def validate_presence_of_any(*args)
+      ValidatePresenceOfAny.new(args)
+    end
+
+    # Used for testing conditional validation of presence where you need one of the other
+    #
+    # @example
+    #
+    #   class Webpage
+    #
+    #     include ActiveModel::Validations
+    #
+    #     attr_accessor :body
+    #     attr_accessor :headline
+    #     attr_accessor :title
+    #
+    #     validates :body,
+    #               presence: true
+    #
+    #     validates :headline,
+    #               presence: true,
+    #               unless: -> { title.present? }
+    #
+    #     validates :title,
+    #               presence: true,
+    #               inclusion: { allow_blank: true, in: ['this'] },
+    #               unless: -> { headline.present? && headline != 'needs title' }
+    #
+    #   end
+    #
+    #   RSpec.describe Webpage, type: :model do
+    #
+    #     it { should     validate_presence_of_any(:headline, :title).valid_values(title: 'this') }
+    #     it { should_not validate_presence_of_any(:headline, :title) }
+    #     it { should_not validate_presence_of_any(:headline, :title).valid_value(:title, 'that') }
+    #
+    #   end
+    class ValidatePresenceOfAny
+
+      attr_reader :attributes
+      attr_reader :subject
+
+      # Description used when matcher is used
+      #
+      # @api private
+      #
+      # @return [String]
+      def description
+        "validate the presence of any of these attributes: #{attributes.join(', ')}"
+      end
+
+      # Compiles the error message for display
+      #
+      # @api private
+      #
+      # @return [String]
+      def failure_message
+        messages = [subject.inspect]
+        attributes.each do |attribute|
+          messages << subject.errors.full_messages_for(attribute)
+        end
+        messages.compact.join("\n")
+      end
+
+      # Sets up arguments for the matcher
+      #
+      # @api private
+      #
+      # @return [void]
+      def initialize(args)
+        @attributes = args
+      end
+
+      # Runs the logic to determine if expectations are being met
+      #
+      # @api private
+      #
+      # @return [Boolean]
+      def matches?(subject)
+        @subject = subject
+        store_initial_values
+        invalid_when_none_present? && attributes.all? do |attribute|
+          clear_attributes_and_errors
+          initialize_value(attribute)
+          free_of_errors_on_attribute?(attribute) ? other_attributes_valid?(attribute) : false
+        end
+      end
+
+      # Explicitly set the value to test for an attribute if 'X' is not acceptable
+      #
+      # @api public
+      #
+      # @example
+      #   it { should validate_presence_of_any(:headline, :title).valid_value(:title, 'A valid title') }
+      #
+      # @return [self]
+      def valid_value(attribute, value)
+        attribute_values[attribute] = value
+        self
+      end
+
+      # Explicitly set the value to test for an attribute if 'X' is not acceptable
+      #
+      # @api public
+      #
+      # @example
+      #   it do
+      #     should validate_presence_of_any(:headline, :title).valid_values(title: 'A valid title')
+      #   end
+      #
+      # @return [self]
+      def valid_values(**values)
+        attribute_values.merge!(values)
+        self
+      end
+
+      private
+
+      # Storage for our initial and valid values for the attributes we are testing against
+      #
+      # @api private
+      #
+      # @return [Hash]
+      def attribute_values
+        @attribute_values ||= {}
+      end
+
+      # Clears all of the attributes that we are testing against
+      #
+      # @api private
+      #
+      # @return [void]
+      def clear_attributes_and_errors
+        attributes.each do |attribute|
+          subject.send("#{attribute}=", nil)
+        end
+        subject.errors.clear
+      end
+
+      # Checks that the current attribute we are checking against passes its other validations
+      #
+      # @api private
+      #
+      # @return [Boolean]
+      def free_of_errors_on_attribute?(attribute)
+        subject.class.validators_on(attribute).each do |validator|
+          # Can/do we use self[attribute] here or would that be better used in the
+          # conditional Proc on the validation itself?
+          validator.validate_each(subject, attribute, subject.send(attribute))
+        end
+        subject.errors[attribute].empty?
+      end
+
+      # Sets the value of the attribute that we currently testing against
+      #
+      # @api private
+      #
+      # @return [void]
+      def initialize_value(attribute)
+        subject.send("#{attribute}=", attribute_values[attribute] || 'X')
+      end
+
+      def invalid_when_none_present?
+        clear_attributes_and_errors
+        !subject.valid? && attributes.all? { |attribute| subject.errors[attribute].present? }
+      end
+
+      # Checks that the other attributes that we are checking against are valid as promised
+      #
+      # @api private
+      #
+      # @return [Boolean]
+      def other_attributes_valid?(exclude_attribute)
+        subject.valid?
+        (attributes - [exclude_attribute]).all? do |attribute|
+          subject.errors[attribute].empty?
+        end
+      end
+
+      # Store the initial values of our subject before we start messing around with it
+      #
+      # @api private
+      #
+      # @return [void]
+      def store_initial_values
+        attributes.each do |attribute|
+          next if attribute_values.key?(attribute)
+          attribute_values[attribute] = subject.send(attribute)
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/phillumeny/factory_bot.rb

@@ -19,9 +19,7 @@ module Phillumeny
     class HaveAValidFactory
 
       def description
-        msg = "have a valid factory '#{@name}'"
-        msg << " with the trait '#{@trait}'" if @trait
-        msg
+        "have a valid factory '#{@name}'#{"with the trait '#{@trait}'" if @trait}"
       end
 
       def failure_message

data/lib/phillumeny/version.rb

@@ -7,7 +7,7 @@ module Phillumeny
   module Version
 
     MAJOR      = 0
-    MINOR      = 1
+    MINOR      = 2
     PATCH      = 0
     PRERELEASE = nil
     # PRERELEASE = 'alpha'.freeze

data/lib/phillumeny.rb

@@ -2,6 +2,7 @@
 
 require 'phillumeny/version'
 
+require 'phillumeny/active_model'
 require 'phillumeny/factory_bot'
 
 # Phillumeny is a collection of RSpec matchers for verbose testers that I use to fills some of the gaps

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: phillumeny
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Michael Deering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-30 00:00:00.000000000 Z
+date: 2018-02-25 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -32,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/phillumeny.rb
+- lib/phillumeny/active_model.rb
 - lib/phillumeny/factory_bot.rb
 - lib/phillumeny/version.rb
 homepage: https://github.com/mdeering/phillumeny
@@ -53,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.5
 signing_key: 
 specification_version: 4
 summary: Collection of RSpec matchers for verbose testers.