otoroshi 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 125c31a56b83045874e5c91780c2541b93c73a567914917c2b8d54c38650c32d
-  data.tar.gz: 45869708d77341f0a45cf3fed38f7719cdd50dac6e13cb7dc528fe36ac2b3f10
+  metadata.gz: cec895aa30d2fb89c0b824b38c2b0b710558419aa7ef1308769b8550969924ba
+  data.tar.gz: a8f06adce33632af173d95282440685ab009c6095f6db889e21b25ffd4cccb40
 SHA512:
-  metadata.gz: 435e9e8988c073ac9c3d8a661c0bdc0030e17118ffb39ca15674b86f6a2ccf9a20d0308a4a126a9c74b0b54aaaee27110e9d6a66d86b99b3f6727f3068484563
-  data.tar.gz: d32b924aa3c1446481a2ada3390783881ef1b66a52db41f4e4beb7e72a596e5a854606276443e6f59bad5527fd69c9c3759cb94a84e2d88e1eee9ab1bb6910ac
+  metadata.gz: 581a9bb26d5c1f861fa5f3c0e60d554c9a4f0e2f47c17df3856d957202ab1909ec74da411b2f0878c7ab0f0e59e904c1220b77e71f67dc1543a5959da0aa3f77
+  data.tar.gz: 7811ee410f737e3f53d133eee22d62d0ed1e6b140d45801cad33aff475ced6a2e6b1e91acd92b4047f4c38c12b53ce64256dd935a3571e49758fa41f760d2e75

data/lib/otoroshi/sanctuary.rb

@@ -1,53 +1,61 @@
 # frozen_string_literal: true
 
 module Otoroshi
-  # help setting and validating instance arguments
-  class Sanctuary
+  # Help setting and validating instance arguments
+  module Sanctuary
+    # Initialize an instance
+    # This method will be redefined each time a property is added to the class
+    def initialize; end
+
     class << self
-      # Add a new property to the class (called by inherited class)
-      # Example: property name, type: String, validate: ->(v) { v.length > 3 }, allow_nil: true
+      # Extend class method to the included class
+      def included(base)
+        base.extend ClassMethods
+      end
+    end
+
+    # Define class methods
+    module ClassMethods
+      # Add a new property to the class
+      # -------------------------------
+      #
+      # / Examples
+      #
+      # property name, type: String, validate: ->(v) { v.length > 3 }, allow_nil: true
+      # property score, type: Integer, validate: ->(v) { v >= 0 }, default: 0
+      #
       def property(name, type = Object, validate: ->(_) { true }, allow_nil: false, default: nil)
-        define_default(name, default)
+        add_to_properties(name, allow_nil, default)
         define_validate_type!(name, type, allow_nil)
-        define_validate!(name, validate, allow_nil)
+        define_validate_lambda!(name, validate, allow_nil)
         define_getter(name)
         define_setter(name)
-        add_to_properties(name)
+        redefine_initialize
       end
 
       # Return the (inherited) class properties
-      # (this method will be updated by ::add_to_properties(name))
+      # (this method will be updated by ::add_to_properties)
+      #
       def properties
-        []
+        {}
       end
 
       private
 
       # Update the ::properties method to add new property to the current list
-      def add_to_properties(name)
-        current = properties
-        define_singleton_method :properties do
-          current << name
-        end
-      end
-
-      # Define a private method that returns the default value
-      #
-      # ::define_default("score", 0)
-      # --------------------------
-      # def default_score
-      #   0
-      # end
       #
-      def define_default(name, default)
-        define_method(:"default_#{name}") { default }
-        private :"default_#{name}"
+      def add_to_properties(name, allow_nil, default)
+        current_state = properties
+        current_state[name] = { allow_nil: allow_nil, default: default }
+        define_singleton_method(:properties) { current_state }
       end
 
       # Define a private method that raises an error if type is not respected
       #
-      # ::define_validate_type!("score", Integer, false)
-      # ----------------------------------------------
+      # / Examples
+      #
+      # ::define_validate_type!("score", Integer, false) --> will define:
+      #
       # def validate_score_type!(value)
       #   return if allow_nil && value.nil?
       #   return if value.is_a?(Integer)
@@ -67,11 +75,16 @@ module Otoroshi
       end
 
       # Define a lambda to be call to validate that value match the type
+      # ----------------------------------------------------------------
+      #
+      # / Examples
       #
-      # ::type_validation(Integer)
-      # ----------------------------------------------
+      # ::type_validation(Integer) --> will return:
       # ->(v) { v.is_a? Integer }
       #
+      # :type_validation([String, Symbol]) --> will return:
+      # ->(v) { [String, Symbol].any? { |t| v.is_a? t } }
+      #
       def type_validation(type)
         if type.is_a? Array
           ->(v) { type.any? { |t| v.is_a? t } }
@@ -81,30 +94,36 @@ module Otoroshi
       end
 
       # Define a private method that raises an error if validate block returns false
+      # ----------------------------------------------------------------------------
+      #
+      # / Examples
+      #
+      # ::define_validate_lambda!("score", ->(v) { v >= 0 }, false) --> will define:
       #
-      # ::define_validate!("score", ->(v) { v >= 0 }, false)
-      # --------------------------------------------------
-      # def validate_score!(value)
+      # def validate_score_lambda!(value)
       #   return if false && value.nil?
       #   return if value >= 0
       #
       #   raise ArgumentError, ":score does not match validation"
       # end
       #
-      def define_validate!(name, validate, allow_nil)
-        define_method :"validate_#{name}!" do |value|
+      def define_validate_lambda!(name, validate, allow_nil)
+        define_method :"validate_#{name}_lambda!" do |value|
           return if allow_nil && value.nil?
           return if instance_exec(value, &validate)
 
           raise ArgumentError, ":#{name} does not match validation"
         end
-        private :"validate_#{name}!"
+        private :"validate_#{name}_lambda!"
       end
 
       # Define a getter method for the property
+      # ---------------------------------------
+      #
+      # / Examples
+      #
+      # ::define_getter("score") --> will define:
       #
-      # ::define_getter("score")
-      # ----------------------
       # def score
       #   @score
       # end
@@ -114,9 +133,12 @@ module Otoroshi
       end
 
       # Define a setter method for the property
+      # ---------------------------------------
+      #
+      # / Examples
+      #
+      # ::define_setter("score") --> will define:
       #
-      # ::define_setter("score")
-      # ----------------------
       # def score=(value)
       #   validate_score_type!(value)
       #   validate_score!(value)
@@ -126,39 +148,85 @@ module Otoroshi
       def define_setter(name)
         define_method :"#{name}=" do |value|
           __send__(:"validate_#{name}_type!", value)
-          __send__(:"validate_#{name}!", value)
+          __send__(:"validate_#{name}_lambda!", value)
           instance_variable_set("@#{name}", value)
         end
       end
-    end
 
-    # Initialize an instance and validate provided args
-    def initialize(args = {}) # rubocop:disable Style/OptionHash
-      validate_keys!(args.keys)
-      assign_values(args)
-    end
+      # Redefine the initialize method
+      # ------------------------------
+      #
+      # / Examples
+      #
+      # Given the properties:
+      #   foo: { allow_nil: false, default: nil }
+      #   bar: { allow_nil: true, default: 0 }
+      #
+      # ::define_initialize --> will define:
+      #
+      # def initialize(foo:, bar: 0)
+      #   self.foo = foo
+      #   self.bar = bar
+      # end
+      #
+      def redefine_initialize
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def initialize(#{initialize_parameters})
+            #{initialize_body}
+          end
+        RUBY
+      end
 
-    private
+      # Define initialize method parameters
+      # -----------------------------------
+      #
+      # / Examples
+      #
+      # Given the properties:
+      #   foo: { allow_nil: false, default: nil }
+      #   bar: { allow_nil: true, default: 0 }
+      #
+      # ::initialize_parameters --> will return:
+      # "foo:, bar: 0"
+      #
+      def initialize_parameters
+        properties.map { |key, options| "#{key}:#{default_parameter_for(options)}" }.join(', ')
+      end
 
-    # validate that provided keys match class properties
-    def validate_keys!(keys)
-      errors = keys.reject { |key| self.class.properties.include? key }
-      return if errors.empty?
+      # Define the default value of a parameter depending on options
+      # ------------------------------------------------------------
+      #
+      # / Examples
+      #
+      # default_parameter_for(allow_nil: true, default: 0) --> will return
+      #   ' 0'
+      #
+      # default_parameter_for(allow_nil: true, default: nil) --> will return
+      #   ' nil'
+      #
+      # default_parameter_for(allow_nil: false, default: nil) --> will return
+      #   ''
+      #
+      def default_parameter_for(options)
+        return " #{options[:default]}" if options[:default]
 
-      message =
-        if errors.one?
-          ":#{errors[0]} is not a valid property"
-        else
-          ":#{errors.join(', :')} are not valid properties"
-        end
-      raise ArgumentError, message
-    end
+        options[:allow_nil] ? ' nil' : ''
+      end
 
-    # assign value to each property
-    def assign_values(args)
-      self.class.properties.each do |property|
-        value = args.key?(property) ? args[property] : __send__(:"default_#{property}")
-        public_send(:"#{property}=", value)
+      # Define initialize method body
+      # -----------------------------
+      #
+      # / Examples
+      #
+      # Given the properties:
+      #   :foo, :bar
+      #
+      # ::initialize_body --> will return:
+      #   "self.foo = foo
+      #    self.bar = bar"
+      #
+      def initialize_body
+        properties.keys.map { |key| "self.#{key} = #{key}" }.join("\n")
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: otoroshi
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Edouard Piron
@@ -10,7 +10,7 @@ bindir: bin
 cert_chain: []
 date: 2020-10-10 00:00:00.000000000 Z
 dependencies: []
-description: Help setting and validating instance arguments
+description: Help defining class properties
 email: ed.piron@gmail.com
 executables: []
 extensions: []