otoroshi 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2993a278f341533c1590cd6bdea9291033167104f94018808577f67cbcd2f0ae
+  data.tar.gz: 725a187567625f428485a80edd5025b0ae7e3a859bebd4d73ea14557353a89ad
+SHA512:
+  metadata.gz: c14d31b349b599ff5ef0db40dbaed8723b47bd53de648589ace6ac8ccfeba85b926d263070fe7d13a0746168399508127cd4e3a33df032ff8cfef5d5a9d5380c
+  data.tar.gz: 19311d09a63ee50e89bd3b3c7dead8faeaba0bd1a4803dfba363c422b0c13704fbeb3bb60799cfac9d681736e209d1587b44be76840bc5736aff4822c6cf9c24

data/lib/otoroshi/sanctuary.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+module Otoroshi
+  # help setting and validating instance arguments
+  class Sanctuary
+    class << self
+      # Add a new property to the class (called by inherited class)
+      # Example: property name, type: String, validate: ->(v) { v.length > 3 }, optional: true
+      def property(name, type = Object, validate: ->(_) { true }, optional: false, default: nil)
+        define_default(name, default)
+        define_validate_type!(name, type, optional)
+        define_validate!(name, validate, optional)
+        define_getter(name)
+        define_setter(name)
+        add_to_properties(name)
+      end
+
+      # Return the (inherited) class properties
+      # (this method will be updated by ::add_to_properties(name))
+      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}"
+      end
+
+      # Define a private method that raises an error if type is not respected
+      #
+      # ::define_validate_type!("score", Integer, false)
+      # ----------------------------------------------
+      # def validate_score_type!(value)
+      #   return if optional && value.nil?
+      #   return if value.is_a?(Integer)
+      #
+      #   raise ArgumentError, ":score does not match type validation"
+      # end
+      #
+      def define_validate_type!(name, type, optional)
+        lambda = type_validation(type)
+        define_method :"validate_#{name}_type!" do |value|
+          return if type.nil? || optional && value.nil?
+          return if lambda.call(value)
+
+          raise ArgumentError, ":#{name} does not match type validation"
+        end
+        private :"validate_#{name}_type!"
+      end
+
+      # Define a lambda to be call to validate that value match the type
+      #
+      # ::type_validation(Integer)
+      # ----------------------------------------------
+      # ->(v) { v.is_a? Integer }
+      #
+      def type_validation(type)
+        if type.is_a? Array
+          ->(v) { type.any? { |t| v.is_a? t } }
+        else
+          ->(v) { v.is_a? type }
+        end
+      end
+
+      # Define a private method that raises an error if validate block returns false
+      #
+      # ::define_validate!("score", ->(v) { v >= 0 }, false)
+      # --------------------------------------------------
+      # def validate_score!(value)
+      #   return if false && value.nil?
+      #   return if value >= 0
+      #
+      #   raise ArgumentError, ":score does not match validation"
+      # end
+      #
+      def define_validate!(name, validate, optional)
+        define_method :"validate_#{name}!" do |value|
+          return if optional && value.nil?
+          return if instance_exec(value, &validate)
+
+          raise ArgumentError, ":#{name} does not match validation"
+        end
+        private :"validate_#{name}!"
+      end
+
+      # Define a getter method for the property
+      #
+      # ::define_getter("score")
+      # ----------------------
+      # def score
+      #   @score
+      # end
+      #
+      def define_getter(name)
+        define_method(name) { instance_variable_get("@#{name}") }
+      end
+
+      # Define a setter method for the property
+      #
+      # ::define_setter("score")
+      # ----------------------
+      # def score=(value)
+      #   validate_score_type!(value)
+      #   validate_score!(value)
+      #   @score = value
+      # end
+      #
+      def define_setter(name)
+        define_method :"#{name}=" do |value|
+          __send__(:"validate_#{name}_type!", value)
+          __send__(:"validate_#{name}!", 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
+
+    private
+
+    # validate that provided keys match class properties
+    def validate_keys!(keys)
+      errors = keys.reject { |key| self.class.properties.include? key }
+      return if errors.empty?
+
+      message =
+        if errors.one?
+          ":#{errors[0]} is not a valid property"
+        else
+          ":#{errors.join(', :')} are not valid properties"
+        end
+      raise ArgumentError, message
+    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)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,43 @@
+--- !ruby/object:Gem::Specification
+name: otoroshi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Edouard Piron
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-10-10 00:00:00.000000000 Z
+dependencies: []
+description: Help setting and validating instance arguments
+email: ed.piron@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/otoroshi/sanctuary.rb
+homepage: https://rubygems.org/gems/otoroshi
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Otoroshi
+test_files: []