striuct 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c59316edafe027980857f258404996caaee0be26a0ad3265acee3cb067477db6
-  data.tar.gz: '086afe2f12bb06050cd7964a774fd087e6a7a710f0d54fe6bb3c4e647490e2d7'
+  metadata.gz: d820670e757190ed2db502b8d6e0c53a7689f299262695f3ca18cec69dd5270b
+  data.tar.gz: 8a27cca712c9a63c2a5207090a6a8d0d8dcecd24a13bf07fa16c243a3b24c366
 SHA512:
-  metadata.gz: 86c436676285e90dbafd4e1f9293b5cccfda99ce060e07a38893f4f0979c4c9f0b7c1c41da63e10ee479ff1323fa0f585c92113929bce766b072e577dc95b8cb
-  data.tar.gz: 0fca1e67d31013254edeb00043cf42699a3845b83bd4979db8623d0ef2786daff07db0ced0dcda068f297e1d577fca063703592f65242c26d793a3e17e9fb786
+  metadata.gz: c90d1e6cc1ac20015660134d88d863dc935d6db44128e0f49f7c807b6b357d4821055d989e9e9e3a8bb4c49382acbab04509bf0445389a454c72c3fb729cbd85
+  data.tar.gz: a7154a914174099a8b5d32fe4b534811c14187f3fb9e8735cba701764b7d9aee640de1c276711dcedb85915f33efc9fecac87dde0ae8a09d704d0bbf84f3f11b

data/README.md

@@ -1,49 +1,29 @@
-striuct
-=======
+# striuct
 
 ![Build Status](https://github.com/kachick/striuct/actions/workflows/test_behaviors.yml/badge.svg?branch=main)
 [![Gem Version](https://badge.fury.io/rb/striuct.png)](http://badge.fury.io/rb/striuct)
 
-Description
------------
-
 Struct++
 
-Features
---------
-
-### Strict
-
-* Easy and Flexible Validations
-* Prevent to conflict member names
-* Lock setters for each member
-
-### Useful
-
-* Hook just before setters
-* Default value
-* Member aliasing
-* Inheritable
-* Handling between nil <-> unassigned
-* Similar API for Hash
-
-### Onepoint
-
-* Base API looks like Struct
-* Pure Ruby :)
-
-Usage
------
+## Usage
 
 Require Ruby 2.6 or later
 
 Add this line to your `Gemfile`
 
 ```ruby
-gem 'striuct', '>= 0.7.0', '< 0.8.0'
+gem 'striuct', '>= 0.8.0', '< 0.9.0'
 ```
 
-### Overview - Case 1
+Then add below code into your Ruby code
+
+```ruby
+require 'striuct'
+```
+
+### Overview
+
+#### Case 1
 
 ```ruby
 require 'striuct'
@@ -72,7 +52,7 @@ ken = User[name: 'ken']                       # Construct from hash
 ken.id                   #=> 2
 ```
 
-### Overview - Case 2
+#### Case 2
 
 ```ruby
 class Foo < Striuct
@@ -102,7 +82,7 @@ foo.with_adjuster = '5'
 foo.with_adjuster        #=> 5                # Casted via adjuster
 ```
 
-### Overview - Case 3
+#### Case 3
 
 ```ruby
 class UseMustOption < Striuct
@@ -112,8 +92,32 @@ end
 UseMustOption.new #=> InvalidOperationError "`foo` require a value under `must` option "
 ```
 
-Link
-----
+## Features
+
+### Strict
+
+* Easy and Flexible Validations
+  * Basically use `#===` for the validation
+  * The pattern builder DSL is just using [eqq](https://github.com/kachick/eqq)
+  * When passed the Proc, it will be evaluated in the instance context
+* Prevent to conflict member names
+* Lock setters for each member
+
+### Useful
+
+* Hook just before setters
+* Default value
+* Member aliasing
+* Inheritable
+* Handling between nil <-> unassigned
+* Similar API for Hash
+
+### Finally
+
+* Base API looks like Struct
+* Pure Ruby :)
+
+## Link
 
 * [Repository](https://github.com/kachick/striuct)
 * [API documents](https://kachick.github.io/striuct/)

data/lib/striuct.rb

@@ -7,6 +7,10 @@
 class Striuct
   class Error < StandardError; end
   class InvalidOperationError < Error; end
+  class InvalidValueError < Error; end
+  class InvalidWritingError < InvalidValueError; end
+  class InvalidReadingError < InvalidValueError; end
+  class InvalidAdjustingError < InvalidValueError; end
 end
 
-require_relative 'striuct/requirements'
+require_relative 'striuct/bootstrap'

data/lib/striuct/{requirements.rb → bootstrap.rb}

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
-require 'validation'
+require 'forwardable'
+require 'eqq'
+
 require_relative 'structs'
 require_relative 'classmethods/requirements'
 require_relative 'instancemethods/requirements'

data/lib/striuct/classmethods/adjustment.rb

@@ -4,6 +4,68 @@ class Striuct
   module ClassMethods
     # @group Adjuster
 
+    # Adjuster Builders
+    # Apply adjuster when passed pattern.
+    # @param pattern [Proc, Method, #===]
+    # @param adjuster [Proc, #to_proc]
+    # @return [Proc]
+    def WHEN(pattern, adjuster)
+      unless Eqq.valid?(pattern)
+        raise ArgumentError, 'wrong object for pattern'
+      end
+
+      unless Striuct.adjustable?(adjuster)
+        raise ArgumentError, 'wrong object for adjuster'
+      end
+
+      ->v { _valid?(pattern, v) ? adjuster.call(v) : v }
+    end
+
+    # Sequential apply all adjusters.
+    # @param adjuster1 [Proc, #to_proc]
+    # @param adjuster2 [Proc, #to_proc]
+    # @param adjusters [Proc, #to_proc]
+    # @return [Proc]
+    def INJECT(adjuster1, adjuster2, *adjusters)
+      adjusters = [adjuster1, adjuster2, *adjusters]
+
+      unless adjusters.all? { |f| adjustable?(f) }
+        raise ArgumentError, 'wrong object for adjuster'
+      end
+
+      ->v {
+        adjusters.reduce(v) { |ret, adjuster| adjuster.call(ret) }
+      }
+    end
+
+    # Accept any parser when that respond to parse method.
+    # @param parser [#parse]
+    # @return [Proc]
+    def PARSE(parser)
+      if !::Integer.equal?(parser) && !parser.respond_to?(:parse)
+        raise ArgumentError, 'wrong object for parser'
+      end
+
+      ->v {
+        if ::Integer.equal?(parser)
+          ::Kernel.Integer(v)
+        else
+          parser.parse(
+            case v
+            when String
+              v
+            when ->_ { v.respond_to?(:to_str) }
+              v.to_str
+            when ->_ { v.respond_to?(:read) }
+              v.read
+            else
+              raise TypeError, 'wrong object for parsing source'
+            end
+          )
+        end
+      }
+    end
+
     # @param [Symbol, String, #to_sym, Integer, #to_int] key - name / index
     def adjuster_for(key)
       autonym = autonym_for_key(key)

data/lib/striuct/classmethods/attributes.rb

@@ -32,7 +32,7 @@ class Striuct
       end
 
       def condition=(condition)
-        unless ::Validation.conditionable?(condition)
+        unless Eqq.valid?(condition)
           raise TypeError, 'wrong object for condition'
         end
 
@@ -40,7 +40,7 @@ class Striuct
       end
 
       def adjuster=(adjuster)
-        unless ::Validation.adjustable?(adjuster)
+        unless Striuct.adjustable?(adjuster)
           raise ArgumentError, 'wrong object for adjuster'
         end
 

data/lib/striuct/classmethods/constructor.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'keyvalidatable'
-
 class Striuct
   module ClassMethods
     # @group Constructor
@@ -16,9 +14,8 @@ class Striuct
     # @param [Hash, Struct, Striuct, #each_pair] pairs
     # @return [Striuct]
     def for_pairs(pairs)
-      raise TypeError, 'no pairs object' unless pairs.respond_to?(:each_pair)
-
-      KeyValidatable.validate_array(KeyValidatable.keys_for(pairs).map(&:to_sym), let: all_members)
+      raise ArgumentError, 'no pairs object' unless pairs.respond_to?(:each_pair)
+      raise ArgumentError unless pairs.each_pair { |key, _value| all_members.include?(key.to_sym) }
 
       instance = allocate
       instance.__send__(:initialize_for_pairs, pairs)
@@ -46,7 +43,7 @@ class Striuct
 
         invalids = autonyms.select { |autonym| !instance.valid?(autonym) }
         if strict && !invalids.empty?
-          raise Validation::InvalidWritingError,
+          raise InvalidWritingError,
                 "invalids members are, yet '#{invalids.inspect} in #{self}'"
         end
 

data/lib/striuct/classmethods/macro.rb

@@ -4,36 +4,25 @@ class Striuct
   module ClassMethods
     # @group Macro for Member Definition
 
-    ANYTHING = ::Validation::Condition.anything
+    ANYTHING = Eqq.ANYTHING()
 
     # @return [Class]
-    ADD_MEMBER_OptArg = OptionalArgument.define {
-      opt(:default_value, aliases: [:default])
-      opt(:default_proc, aliases: [:lazy_default])
-      conflict(:default_value, :default_proc)
-      opt(:must, default: false)
-      opt(:setter_validation, aliases: [:writer_validation], default: true)
-      opt(:getter_validation, aliases: [:reader_validation], default: false)
-    }
 
     private
 
     # @param [Symbol, String, #to_sym] autonym
-    # @param [#===, Proc, Method] condition
-    # @param [Hash] options
-    # @option options [BasicObject] :default
-    # @option options [Proc] :default_proc
-    # @option options [Boolean] :must
-    # @option options [Boolean] :reader_validation
-    # @option options [Boolean] :getter_validation
-    # @option options [Boolean] :writer_validation
-    # @option options [Boolean] :setter_validation
-    # @return [nil]
-    def add_member(autonym, condition=anything, options={}, &adjuster)
+    # @param [#===, Proc, Method] pattern
+    # @param [Proc] default_proc
+    # @param [Boolean] must
+    # @param [Boolean] writer_validation
+    # @param [Boolean] reader_validation
+    # @return [void]
+    def add_member(autonym, pattern=ANYTHING, default_value: nil, default_proc: nil, must: false, writer_validation: true, reader_validation: false, &adjuster)
       _check_frozen
       _check_closed
 
-      options = ADD_MEMBER_OptArg.parse(options)
+      raise ArgumentError if !default_value.nil? && default_proc
+
       autonym = autonym.to_sym # First definition for an autonym
 
       raise ArgumentError, %Q!already exist name "#{autonym}"! if member?(autonym)
@@ -41,21 +30,21 @@ class Striuct
       _check_safety_naming(autonym)
       _add_autonym(autonym)
 
-      _attributes_for(autonym).safety_setter = !!options.setter_validation
-      _attributes_for(autonym).safety_getter = !!options.getter_validation
+      _attributes_for(autonym).safety_setter = writer_validation
+      _attributes_for(autonym).safety_getter = reader_validation
 
-      if options.must
+      if must
         _attributes_for(autonym).must = true
       end
 
       _def_getter(autonym)
-      _def_setter(autonym, condition, &adjuster)
+      _def_setter(autonym, pattern, &adjuster)
 
       case
-      when options.default_value?
-        set_default_value(autonym, options.default_value)
-      when options.default_proc?
-        set_default_value(autonym, &options.default_proc)
+      when !default_value.nil?
+        set_default_value(autonym, default_value)
+      when default_proc
+        set_default_value(autonym, &default_proc)
       end
 
       nil

data/lib/striuct/classmethods/requirements.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'optionalargument'
-
 require_relative 'hashdeepdupulicatable'
 require_relative 'attributes'
 require_relative 'inner'

data/lib/striuct/instancemethods/getter.rb

@@ -37,7 +37,7 @@ class Striuct
       value = @db[autonym]
 
       if with_safety_getter?(autonym) && !accept?(autonym, value)
-        raise ::Validation::InvalidReadingError,
+        raise InvalidReadingError,
               "#{value.inspect} is deficient for #{autonym} in #{self.class}"
       end
 

data/lib/striuct/instancemethods/requirements.rb

@@ -1,21 +1,15 @@
 # frozen_string_literal: true
 
-require 'forwardable'
-require 'keyvalidatable'
-
 class Striuct
   module InstanceMethods
     extend Forwardable
 
     # hide Forwardable's public/protected class_macro
     private_class_method(*Forwardable.instance_methods)
-
-    include KeyValidatable
   end
 end
 
 require_relative 'delegate_class_methods'
-require_relative 'keyvalidatable'
 require_relative 'object'
 require_relative 'compare'
 require_relative 'to_s'

data/lib/striuct/instancemethods/setter.rb

@@ -9,7 +9,7 @@ class Striuct
     def []=(key, value)
       autonym = autonym_for_key(key)
       _set(autonym, value)
-    rescue Validation::InvalidWritingError
+    rescue InvalidWritingError
       $!.set_backtrace(
         ["#{$!.backtrace[-1].sub(/[^:]+\z/) { '' }}in `[#{key.inspect}(#{autonym})]=': #{$!.message}", $!.backtrace[-1]]
       )
@@ -31,17 +31,17 @@ class Striuct
         begin
           value = instance_exec(value, &adjuster_for(autonym))
         rescue Exception
-          raise ::Validation::InvalidAdjustingError
+          raise InvalidAdjustingError
         end
       end
 
       if with_safety_setter?(autonym) && !accept?(autonym, value)
-        raise ::Validation::InvalidWritingError,
+        raise InvalidWritingError,
               "#{value.inspect} is deficient for #{autonym} in #{self.class}"
       end
 
       @db[autonym] = value
-    rescue ::Validation::InvalidError
+    rescue InvalidValueError
       unless /in \[\]=/.match?(caller(2..2).first.slice(/([^:]+)\z/))
         $!.backtrace.delete_if { |s| /#{Regexp.escape(File.dirname(__FILE__))}/ =~ s }
         $!.backtrace.first.sub!(/([^:]+)\z/) { "in `#{autonym}='" }

data/lib/striuct/instancemethods/validation.rb

@@ -4,6 +4,21 @@ class Striuct
   module InstanceMethods
     # @group Validation
 
+    # @param [Proc, Method, #===] pattern
+    # @param [Object] value
+    def _valid?(pattern, value)
+      !!(
+        case pattern
+        when Proc
+          instance_exec(value, &pattern)
+        when Method
+          pattern.call(value)
+        else
+          pattern === value
+        end
+      )
+    end
+
     # @param [Symbol, String, #to_sym, Integer, #to_int] key - name / index
     # @param value
     # true if passed under any condition

data/lib/striuct/singleton_class.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'validation'
-
 class Striuct
   class << self
     alias_method :new_instance, :new
@@ -40,6 +38,20 @@ class Striuct
       }
     end
 
+    # Return `true` if given object is sufficient as an adjuster role
+    def adjustable?(object)
+      case object
+      when Proc
+        object.arity == 1
+      else
+        if object.respond_to?(:to_proc)
+          object.to_proc.arity == 1
+        else
+          false
+        end
+      end
+    end
+
     private
 
     def inherited(subclass)
@@ -48,7 +60,7 @@ class Striuct
       subclass.class_eval {
         extend ClassMethods
         include Enumerable
-        include Validation
+        extend Eqq::Buildable
         include InstanceMethods
 
         _init

metadata

@@ -1,75 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: striuct
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Kenichi Kamiya
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-03 00:00:00.000000000 Z
+date: 2021-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: validation
+  name: eqq
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.0.5
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.0.5
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.3.0
-- !ruby/object:Gem::Dependency
-  name: optionalargument
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-- !ruby/object:Gem::Dependency
-  name: keyvalidatable
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.2.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.3.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.2.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.1.0
 description: "    Struct + validation + inheritable + default_value + etc...\n"
 email:
 - kachick1+ruby@gmail.com
@@ -80,6 +40,7 @@ files:
 - MIT-LICENSE.txt
 - README.md
 - lib/striuct.rb
+- lib/striuct/bootstrap.rb
 - lib/striuct/classmethods/README.md
 - lib/striuct/classmethods/adjustment.rb
 - lib/striuct/classmethods/attributes.rb
@@ -107,7 +68,6 @@ files:
 - lib/striuct/instancemethods/enum.rb
 - lib/striuct/instancemethods/getter.rb
 - lib/striuct/instancemethods/hashy.rb
-- lib/striuct/instancemethods/keyvalidatable.rb
 - lib/striuct/instancemethods/lock.rb
 - lib/striuct/instancemethods/object.rb
 - lib/striuct/instancemethods/requirements.rb
@@ -116,7 +76,6 @@ files:
 - lib/striuct/instancemethods/to_s.rb
 - lib/striuct/instancemethods/validation.rb
 - lib/striuct/instancemethods/values.rb
-- lib/striuct/requirements.rb
 - lib/striuct/singleton_class.rb
 - lib/striuct/structs.rb
 homepage: https://github.com/kachick/striuct
@@ -142,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: Struct++

data/lib/striuct/instancemethods/keyvalidatable.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-class Striuct
-  module InstanceMethods
-    KeyValidatable.instance_methods.each do |feature|
-      if specific_feature = feature.to_s.sub!('members') { 'autonyms' }
-        def_delegator :self, feature, specific_feature.to_sym
-      end
-    end
-  end
-end