stub_requests 0.1.9 → 0.1.10

data/lib/stub_requests/concerns/property.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  module Concerns
+    #
+    # 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]
+          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
+end

data/lib/stub_requests/concerns/property/validator.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  module Concerns
+    #
+    # 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
+end

data/lib/stub_requests/concerns/register_verb.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module StubRequests
+  module Concerns
+    #
+    # Module RegisterVerb provides <description>
+    # @since 0.1.10
+    #
+    #
+    # @author Mikael Henriksson <mikael@zoolutions.se>
+    #
+    module RegisterVerb
+      #
+      # Convenience wrapper for register
+      #
+      #
+      # @example **Register a get endpoint**
+      # .  get("documents/:id", as: :documents_show)
+      #
+      # @param [String] path the path to the endpoint
+      # @param [Symbol] as the id of the endpoint
+      #
+      # @return [Endpoint] the registered endpoint
+      #
+      def any(path, as:) # rubocop:disable Naming/UncommunicativeMethodParamName
+        register(as, __method__, path)
+      end
+
+      #
+      # Convenience wrapper for register
+      #
+      #
+      # @example **Register a get endpoint**
+      # .  get("documents/:id", as: :documents_show)
+      #
+      # @param [String] path the path to the endpoint
+      # @param [Symbol] as the id of the endpoint
+      #
+      # @return [Endpoint] the registered endpoint
+      #
+      def get(path, as:) # rubocop:disable Naming/UncommunicativeMethodParamName
+        register(as, __method__, path)
+      end
+
+      #
+      # Register a :post endpoint
+      #
+      #
+      # @example **Register a post endpoint**
+      # .  post("documents", as: :documents_create)
+      #
+      # @param [String] path the path to the endpoint
+      # @param [Symbol] as the id of the endpoint
+      #
+      # @return [Endpoint] the registered endpoint
+      #
+      def post(path, as:) # rubocop:disable Naming/UncommunicativeMethodParamName
+        register(as, __method__, path)
+      end
+
+      #
+      # Register a :patch endpoint
+      #
+      #
+      # @example **Register a patch endpoint**
+      # .  patch("documents/:id", as: :documents_update)
+      #
+      # @param [String] path the path to the endpoint
+      # @param [Symbol] as the id of the endpoint
+      #
+      # @return [Endpoint] the registered endpoint
+      #
+      def patch(path, as:) # rubocop:disable Naming/UncommunicativeMethodParamName
+        register(as, __method__, path)
+      end
+
+      #
+      # Register a :put endpoint
+      #
+      #
+      # @example **Register a put endpoint**
+      # .  put("documents/:id", as: :documents_update)
+      #
+      # @param [String] path the path to the endpoint
+      # @param [Symbol] as the id of the endpoint
+      #
+      # @return [Endpoint] the registered endpoint
+      #
+      def put(path, as:) # rubocop:disable Naming/UncommunicativeMethodParamName
+        register(as, __method__, path)
+      end
+
+      #
+      # Register a :delete endpoint
+      #
+      #
+      # @example **Register a delete endpoint**
+      # .  delete("documents/:id", as: :documents_destroy)
+      #
+      # @param [String] path the path to the endpoint
+      # @param [Symbol] as the id of the endpoint
+      #
+      # @return [Endpoint] the registered endpoint
+      #
+      def delete(path, as:) # rubocop:disable Naming/UncommunicativeMethodParamName
+        register(as, __method__, path)
+      end
+    end
+  end
+end

data/lib/stub_requests/configuration.rb

@@ -14,8 +14,25 @@ module StubRequests
   # @since 0.1.2
   #
   class Configuration
-    include Property
+    # includes "Concerns::Property"
+    # @!parse include Concerns::Property
+    include Concerns::Property
 
-    property :record_metrics, type: [TrueClass, FalseClass], default: false
+    #
+    # @!attribute [rw] record_stubs
+    #   @return [Hash] record_stubs set to true to keep track of stubs
+    property :record_stubs, type: [TrueClass, FalseClass], default: false
+    #
+    # @!attribute [rw] jaro_options
+    #   @return [Hash] options to use for jaro winkler
+    property :jaro_options, type: Hash, default: {
+      weight: 0.1,
+      threshold: 0.7,
+      ignore_case: true,
+    }
+    #
+    # @!attribute [rw] logger
+    #   @return [Logger] any object that responds to the standard logger methods
+    property :logger, type: Logger
   end
 end

data/lib/stub_requests/dsl.rb

@@ -29,15 +29,15 @@ module StubRequests
   #   Stubs.instance_methods #=> [:stub_documents_show, :stub_documents_index, :stub_documents_create]
   #   module Stubs
   #     def stub_documents_show(id:, &block)
-  #        stub_endpoint(:documents, :show, id: id, &block)
+  #        stub_endpoint(:documents_show, id: id, &block)
   #     end
   #
   #     def stub_documents_index(&block)
-  #        stub_endpoint(:documents, :index, &block)
+  #        stub_endpoint(:documents_index, &block)
   #     end
   #
   #     def stub_documents_create(&block)
-  #        stub_endpoint(:documents, :create, &block)
+  #        stub_endpoint(:documents_create, &block)
   #     end
   #    end
   #
@@ -90,9 +90,8 @@ module StubRequests
     # @param [Module] receiver the receiver of the stub methods
     #
     def initialize(service_id, receiver: nil)
-      @service   = StubRequests::ServiceRegistry.instance.find!(service_id)
+      @endpoints = StubRequests::EndpointRegistry[service_id]
       @receiver  = receiver
-      @endpoints = service.endpoints.endpoints.values
     end
 
     #
@@ -123,7 +122,7 @@ module StubRequests
 
     def method_definitions
       @method_definitions ||= endpoints.map do |endpoint|
-        MethodDefinition.new(service.id, endpoint.id, endpoint.route_params)
+        MethodDefinition.new(endpoint.id, endpoint.route_params)
       end
     end
   end

data/lib/stub_requests/dsl/method_definition.rb

@@ -13,10 +13,6 @@ module StubRequests
       # @return [String]
       BLOCK_ARG = "&block"
 
-      #
-      # @!attribute [r] service_id
-      #   @return [Symbol] the id of a registered service
-      attr_reader :service_id
       #
       # @!attribute [r] endpoint_id
       #   @return [Symbol] the id of a registered endpoint
@@ -29,12 +25,10 @@ module StubRequests
       #
       # Initialize a new endpoint of {MethodDefinition}
       #
-      # @param [Symbol] service_id the id of a registered service
       # @param [Symbol] endpoint_id the id of a registered endpoint
       # @param [Array<Symbol>] route_params the route parameter keys
       #
-      def initialize(service_id, endpoint_id, route_params)
-        @service_id   = service_id
+      def initialize(endpoint_id, route_params)
         @endpoint_id  = endpoint_id
         @route_params = route_params
       end
@@ -52,7 +46,7 @@ module StubRequests
       def to_s
         <<~METHOD
           def #{name}(#{keywords})
-            StubRequests.stub_endpoint(:#{service_id}, :#{endpoint_id}, #{arguments})
+            StubRequests.stub_endpoint(:#{endpoint_id}, #{arguments})
           end
         METHOD
       end