stub_requests 0.1.9 → 0.1.10

data/lib/stub_requests/hash_util.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-#
-# Abstraction over WebMock to reduce duplication
-#
-# @author Mikael Henriksson <mikael@zoolutions.se>
-# @since 0.1.0
-#
-module StubRequests
-  #
-  # Provides convenience methods for hashes
-  #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
-  #
-  module HashUtil
-    #
-    # Removes all entries with nil values (first level only)
-    #
-    # @param [Hash] options the hash to compact
-    #
-    # @return [Hash, nil] Returns
-    #
-    # @yieldparam [Hash] compacted the hash without nils
-    # @yieldreturn [void]
-    def self.compact(options)
-      return if options.blank?
-
-      compacted = options.delete_if { |_, val| val.blank? }
-      yield compacted if compacted.present?
-    end
-  end
-end

data/lib/stub_requests/observable.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-#
-# Abstraction over WebMock to reduce duplication
-#
-# @author Mikael Henriksson <mikael@zoolutions.se>
-# @since 0.1.0
-#
-module StubRequests
-  #
-  # Module Observable handles observing webmock requests
-  #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
-  # @since 0.1.3
-  #
-  module Observable
-  end
-end

data/lib/stub_requests/property.rb

@@ -1,112 +0,0 @@
-# frozen_string_literal: true
-
-#
-# Abstraction over WebMock to reduce duplication
-#
-# @author Mikael Henriksson <mikael@zoolutions.se>
-# @since 0.1.0
-#
-module StubRequests
-  #
-  # Module Property provides type checked attribute definition with default value
-  #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
-  # @since 0.1.2
-  #
-  module Property
-    include ArgumentValidation
-
-    #
-    # Extends the base class with the ClassMethods module
-    #
-    # @param [Class,Module] base the class where this module is included
-    #
-    # @return [void]
-    #
-    def self.included(base)
-      base.class_attribute :properties, default: {}
-      base.send(:extend, ClassMethods)
-    end
-
-    #
-    # Module ClassMethods provides class methods for {Property}
-    #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
-    #
-    module ClassMethods
-      #
-      # Define property methods for the name
-      #
-      # @param [Symbol] name the name of the property
-      # @param [Object] type the expected type of the property
-      # @param [Hash<Symbol>] options a hash with options
-      # @option options [Object] :default a default value for the property
-      #
-      # @return [void]
-      #
-      def property(name, type:, **options)
-        type = normalize_type(type, options)
-        default = options[:default]
-        Property::Validator.call(name, type, default, properties)
-
-        Docile.dsl_eval(self) do
-          define_property(name, type, default)
-        end
-      end
-
-      # @api private
-      def normalize_type(type, **options)
-        type_array = Array(type)
-        return type_array unless (default = options[:default])
-
-        type_array.concat([default.class]).flatten.uniq
-      end
-
-      # @api private
-      def define_property(name, type, default)
-        property_reader(name, default)
-        property_predicate(name)
-        property_writer(name, type)
-
-        set_property_default(name, default)
-        set_property_defined(name, type, default)
-      end
-
-      # @api private
-      def property_reader(name, default)
-        invar = "@#{name}"
-        silence_redefinition_of_method(name.to_s)
-        redefine_method(name) do
-          instance_variable_set(invar, default) unless instance_variable_defined?(invar)
-          instance_variable_get(invar)
-        end
-      end
-
-      # @api private
-      def property_predicate(name)
-        silence_redefinition_of_method("#{name}?")
-        redefine_method("#{name}?") do
-          !!public_send(name) # rubocop:disable Style/DoubleNegation
-        end
-      end
-
-      # @api private
-      def property_writer(name, type)
-        redefine_method("#{name}=") do |obj|
-          validate! name: name, value: obj, type: type
-          instance_variable_set("@#{name}", obj)
-        end
-      end
-
-      def set_property_default(name, default)
-        instance_variable_set("@#{name}", default)
-      end
-
-      # @api private
-      def set_property_defined(name, type, default)
-        self.properties ||= {}
-        properties[name] = { type: type, default: default }
-      end
-    end
-  end
-end

data/lib/stub_requests/property/validator.rb

@@ -1,135 +0,0 @@
-# frozen_string_literal: true
-
-#
-# Abstraction over WebMock to reduce duplication
-#
-# @author Mikael Henriksson <mikael@zoolutions.se>
-# @since 0.1.0
-#
-module StubRequests
-  #
-  # Module Property provides type checked attribute definition with default value
-  #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
-  # @since 0.1.2
-  #
-  module Property
-    #
-    # Class Validator provides validation for adding properties
-    #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
-    # @since 0.1.2
-    #
-    class Validator
-      include ArgumentValidation
-
-      #
-      # Validates that the property can be added to the class
-      #
-      #
-      # @param [Symbol] name the name of the property
-      # @param [Class, Module] type the type of the property
-      # @param [Object] default the default value of the property
-      # @param [Hash] properties the list of currently defined properties
-      #
-      # @raise [InvalidArgumentType] when name is not a Symbol
-      # @raise [InvalidArgumentType] when default does not match type
-      # @raise [PropertyDefined] when property has already been defined
-      #
-      # @return [void]
-      #
-      def self.call(name, type, default, properties)
-        new(name, type, default, properties).run_validations
-      end
-
-      #
-      # @!attribute [r] name
-      #   @return [Symbol] the name of the property
-      attr_reader :name
-      #
-      # @!attribute [r] type
-      #   @return [Class, Module] the type of the property
-      attr_reader :type
-      #
-      # @!attribute [r] default
-      #   @return [Object] the default value of the property
-      attr_reader :default
-      #
-      # @!attribute [r] properties
-      #   @return [Hash] the list of currently defined properties
-      attr_reader :properties
-
-      # Initializes a new {Validator}
-      #
-      # @param [Symbol] name the name of the property
-      # @param [Class, Module] type the type of the property
-      # @param [Object] default the default value of the property
-      # @param [Hash] properties the list of currently defined properties
-      #
-      def initialize(name, type, default = nil, properties = {})
-        @type       = Array(type).flatten
-        @default    = default
-        @name       = name
-        @properties = properties || {}
-      end
-
-      #
-      # Performs all validations
-      #
-      #
-      # @raise [InvalidArgumentType] when name is not a Symbol
-      # @raise [InvalidArgumentType] when default does not match type
-      # @raise [PropertyDefined] when property has already been defined
-      #
-      # @return [void]
-      #
-      def run_validations
-        validate_undefined
-        validate_name
-        validate_default
-      end
-
-      private
-
-      #
-      # Validates that the name is of type Symbol
-      #
-      # @raise [InvalidArgumentType] when name is not a Symbol
-      #
-      # @return [void]
-      #
-      def validate_name
-        validate! name: :name, value: name, type: Symbol
-      end
-
-      #
-      # Validate that the default value matches the type
-      #
-      #
-      # @raise [InvalidArgumentType] when default does not match type
-      #
-      # @return [void]
-      #
-      def validate_default
-        return unless default || default.is_a?(FalseClass)
-
-        validate! name: :default, value: default, type: type
-      end
-
-      #
-      # Validate that the property has not been defined
-      #
-      #
-      # @raise [PropertyDefined] when property has already been defined
-      #
-      # @return [void]
-      #
-      def validate_undefined
-        return unless properties
-        return unless (prop = properties[name])
-
-        raise PropertyDefined, name: name, type: prop[:type], default: prop[:default]
-      end
-    end
-  end
-end