striuct 0.4.4 → 0.7.0

checksums.yaml

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

data/MIT-LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2011 Kenichi Kamiya
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,7 +1,7 @@
 striuct
 =======
 
-[![Build Status](https://secure.travis-ci.org/kachick/striuct.png)](http://travis-ci.org/kachick/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
@@ -25,7 +25,7 @@ Features
 * Member aliasing
 * Inheritable
 * Handling between nil <-> unassigned
-* More flendly API for Hash
+* Similar API for Hash
 
 ### Onepoint
 
@@ -35,17 +35,26 @@ Features
 Usage
 -----
 
+Require Ruby 2.6 or later
+
+Add this line to your `Gemfile`
+
+```ruby
+gem 'striuct', '>= 0.7.0', '< 0.8.0'
+```
+
 ### Overview - Case 1
 
 ```ruby
 require 'striuct'
 
 class Person < Striuct
-  member :fullname, AND(String, /\A.+\z/)     # Flexible Validation
-  alias_member :name, :fullname               # Use other name
+  member :full_name, AND(String, /\A.+\z/)     # Flexible Validation
+  alias_member :name, :full_name               # Use other name
 end
 
-class User < Person                           # Inheritable
+# Inheritable
+class User < Person
   member :id, Integer,                        # Looks typed validation
               default_proc: ->{User.next_id}  # With default value
 
@@ -56,26 +65,26 @@ class User < Person                           # Inheritable
 end
 
 john = User.new 'john'
-john[:name]              #=> 'john' 
+john[:name]              #=> 'john'
 john.name = ''           #=> Exception        # Validate with setter
 john.id                  #=> 1
 ken = User[name: 'ken']                       # Construct from hash
 ken.id                   #=> 2
 ```
+
 ### Overview - Case 2
 
 ```ruby
 class Foo < Striuct
   member :foo
-  member :bar, Numeric,                       # First validation under Numeric
-               inference: true                # And use inference Validation
+  member :bar, Numeric
   member :with_adjuster, Integer,
                          &->v{Integer v}      # Use adjuster before a setter
 end
 
 foo = Foo.new
 
-# nil <-> unaasigned
+# nil <-> unassigned
 foo.foo                  #=> nil
 foo.assigned?(:foo)      #=> false
 foo.foo = nil
@@ -85,7 +94,6 @@ foo.assigned?(:foo)      #=> true
 foo.lock(:foo)
 foo.foo = nil            #=> error
 
-# Inference Validation
 foo.bar = 1.2            #=> pass             # memorize 1.2's class is Float
 foo.bar = 1              #=> error            # 1 is not Float
 
@@ -104,37 +112,8 @@ end
 UseMustOption.new #=> InvalidOperationError "`foo` require a value under `must` option "
 ```
 
-
-### How to build flexible conditions ?
-
-* That from validation library.  
-  See the [validation-API](http://kachick.github.com/validation/yard/frames.html)
-
-Requirements
--------------
-
-* Ruby - [1.9.2 or later](http://travis-ci.org/#!/kachick/striuct)
-
-Install
--------
-
-```bash
-gem install striuct
-```
-
 Link
 ----
 
-* [code](https://github.com/kachick/striuct)
-* [wiki](https://github.com/kachick/striuct/wiki)
-* [API](http://kachick.github.com/striuct/yard/frames.html)
-* [issues](https://github.com/kachick/striuct/issues)
-* [CI](http://travis-ci.org/#!/kachick/striuct)
-* [gem](https://rubygems.org/gems/striuct)
-
-License
---------
-
-The MIT X11 License  
-Copyright (c) 2011 Kenichi Kamiya  
-See MIT-LICENSE for further details.
+* [Repository](https://github.com/kachick/striuct)
+* [API documents](https://kachick.github.io/striuct/)

data/lib/striuct.rb

@@ -1,12 +1,12 @@
+# frozen_string_literal: true
+
 # striuct - Struct++
 # Copyright (c) 2011-2012 Kenichi Kamiya
 
 # @abstract
 class Striuct
-
   class Error < StandardError; end
   class InvalidOperationError < Error; end
-
 end
 
-require_relative 'striuct/requirements'
+require_relative 'striuct/requirements'

data/lib/striuct/classmethods/README.md

@@ -1,10 +1,10 @@
 Note
 =====
 
-This dir's tree is diveded under roles/features.  
+This dir's tree is divided under roles/features.
 Not only divided by CONSTANT names.
 
 CONSTANT
 --------
 
-* attributes - Attributes
+* attributes - Attributes

data/lib/striuct/classmethods/adjustment.rb

@@ -1,15 +1,17 @@
-class Striuct; module ClassMethods
-
-  # @group Adjuster
-  
-  # @param [Symbol, String, #to_sym, Integer, #to_int] key - name / index
-  def adjuster_for(key)
-    autonym = autonym_for_key key
-    raise KeyError unless with_adjuster? autonym
-    
-    _attributes_for(autonym).adjuster
-  end
+# frozen_string_literal: true
+
+class Striuct
+  module ClassMethods
+    # @group Adjuster
 
-  # @endgroup
+    # @param [Symbol, String, #to_sym, Integer, #to_int] key - name / index
+    def adjuster_for(key)
+      autonym = autonym_for_key(key)
+      raise KeyError unless with_adjuster?(autonym)
 
-end; end
+      _attributes_for(autonym).adjuster
+    end
+
+    # @endgroup
+  end
+end

data/lib/striuct/classmethods/attributes.rb

@@ -1,114 +1,116 @@
-class Striuct; module ClassMethods
-
-  # Attributes for autonym of each member
-  class Attributes
-
-    VALUES   = [ :condition,
-                 :adjuster  ].freeze
-
-    BOOLEANS = [ :inference,
-                 :must,
-                 :safety_setter,
-                 :safety_getter ].freeze
-    
-    def initialize
-      @hash =  { inference:     false,
-                 must:          false,
-                 safety_setter: false,
-                 safety_getter: false }
-    end
-    
-    VALUES.each do |role|
-      define_method :"with_#{role}?" do
-        @hash.has_key? role
+# frozen_string_literal: true
+
+class Striuct
+  module ClassMethods
+    # Attributes for autonym of each member
+    class Attributes
+      VALUES   = [:condition,
+                  :adjuster].freeze
+
+      BOOLEANS = [
+        :must,
+        :safety_setter,
+        :safety_getter
+      ].freeze
+
+      def initialize
+        @hash = {
+          must: false,
+          safety_setter: false,
+          safety_getter: false
+        }
       end
-      
-      define_method role do
-        @hash.fetch role
+
+      VALUES.each do |role|
+        define_method :"with_#{role}?" do
+          @hash.key?(role)
+        end
+
+        define_method role do
+          @hash.fetch(role)
+        end
       end
-    end
 
-    def condition=(condition)
-      unless ::Validation.conditionable? condition
-        raise TypeError, 'wrong object for condition' 
+      def condition=(condition)
+        unless ::Validation.conditionable?(condition)
+          raise TypeError, 'wrong object for condition'
+        end
+
+        @hash[:condition] = condition
       end
 
-      @hash[:condition] = condition
-    end
+      def adjuster=(adjuster)
+        unless ::Validation.adjustable?(adjuster)
+          raise ArgumentError, 'wrong object for adjuster'
+        end
 
-    def adjuster=(adjuster)
-      unless ::Validation.adjustable? adjuster
-        raise ArgumentError, 'wrong object for adjuster'
+        @hash[:adjuster] = adjuster
       end
 
-      @hash[:adjuster] = adjuster
-    end
+      BOOLEANS.each do |role|
+        define_method :"with_#{role}?" do
+          @hash.fetch(role)
+        end
+
+        define_method :"#{role}=" do |arg|
+          raise TypeError unless arg.equal?(true) || arg.equal?(false)
 
-    BOOLEANS.each do |role|
-      define_method :"with_#{role}?" do
-        @hash.fetch role
+          @hash[role] = arg
+        end
       end
-      
-      define_method :"#{role}=" do |arg|
-        raise TypeError unless arg.equal?(true) or arg.equal?(false)
 
-        @hash[role] = arg
-      end   
-    end
+      def with_default?
+        @hash.key?(:default_value)
+      end
 
-    def with_default?
-      @hash.has_key? :default_value
-    end
+      def default_value
+        @hash.fetch(:default_value)
+      end
 
-    def default_value
-      @hash.fetch :default_value
-    end
+      def default_type
+        @hash.fetch(:default_type)
+      end
 
-    def default_type
-      @hash.fetch :default_type
-    end
+      # @param [Symbol] type - :value / :lazy
+      def set_default(value, type)
+        raise TypeError unless type.equal?(:value) || type.equal?(:lazy)
 
-    # @param [Symbol] type - :value / :lazy
-    def set_default(value, type)
-      raise TypeError unless type.equal?(:value) or type.equal?(:lazy)
-      check_default_lazy_proc value if type.equal?(:lazy)
-      
-      @hash[:default_type] = type
-      @hash[:default_value] = value
-    end
+        check_default_lazy_proc(value) if type.equal?(:lazy)
 
-    def check_default_lazy_proc(_proc)
-      raise TypeError unless _proc.respond_to? :call
-      arity = _proc.arity
-      unless arity <= 2
-        raise ArgumentError, "wrong number of block parameter #{arity} for 0..2"
+        @hash[:default_type] = type
+        @hash[:default_value] = value
       end
-    end
 
-    def freeze
-      ret = super
-      @hash.freeze
-      ret
-    end
+      def check_default_lazy_proc(proc)
+        raise TypeError unless proc.respond_to?(:call)
 
-    def dup
-      ret = super
-      @hash = @hash.dup
-      ret
-    end
-    
-    private
-    
-    def initialize_copy(original)
-      ret = super original
-      @hash = @hash.dup
-      ret
-    end
+        arity = proc.arity
+        unless arity <= 2
+          raise ArgumentError, "wrong number of block parameter #{arity} for 0..2"
+        end
+      end
 
-  end
+      def freeze
+        ret = super
+        @hash.freeze
+        ret
+      end
+
+      def dup
+        ret = super
+        @hash = @hash.dup
+        ret
+      end
+
+      private
+
+      def initialize_copy(original)
+        ret = super(original)
+        @hash = @hash.dup
+        ret
+      end
+    end
 
-  if respond_to? :private_constant
     private_constant :Attributes
   end
-
-end; end
+end

data/lib/striuct/classmethods/conflict_management.rb

@@ -1,112 +1,115 @@
-class Striuct; module ClassMethods
-  
-  # @group Member Conflict Management
-
-  # @return [Hash] Symbol => Fixnum
-  NAMING_RISKS = {
-    conflict:      10,
-    no_identifier:  9,
-    bad_manners:    5,
-    no_ascii:       3,
-    strict:         0 
-  }.freeze
-
-  # @return [Hash] Symbol => Hash
-  CONFLICT_MANAGEMENT_LEVELS = {
-    struct:      {error: 99, warn: 99},
-    warning:     {error: 99, warn:  5},
-    error:       {error:  9, warn:  5},
-    prevent:     {error:  5, warn:  1},
-    nervous:     {error:  1, warn:  1}
-  }.each(&:freeze).freeze
-  
-  # @return [Symbol]
-  DEFAULT_CONFLICT_MANAGEMENT_LEVEL = :prevent
-
-  # @param [Object] name
-  # accpeptable the name into own member, under protect level of runtime
-  def cname?(name)
-    _check_safety_naming(name.to_sym){|r|r}
-  rescue Exception
-    false
-  end
-  
-  attr_reader :conflict_management_level
-
-  private
-  
-  # @param [Symbol, String, #to_sym] level
-  # @return [Symbol] level
-  # change level of management conflict member names
-  def set_conflict_management_level(level)
-    level = level.to_sym
-    raise NameError unless CONFLICT_MANAGEMENT_LEVELS.has_key? level
-
-    @conflict_management_level = level
-  end
+# frozen_string_literal: true
 
-  # @param [Symbol, String, #to_sym] level
-  # @see [#set_conflict_management_level]
-  # @yieldreturn [self]
-  # @return [void]
-  # @raise [ArgumentError] if no block given
-  # temp scope of a conflict_management_level
-  def conflict_management(level=DEFAULT_CONFLICT_MANAGEMENT_LEVEL)
-    before = @conflict_management_level
-    set_conflict_management_level level
-    
-    yield
-  ensure
-    @conflict_management_level = before
-    self
-  end
-  
-  # @param [Symbol] name
-  # @return [void]
-  # @yieldreturn [Boolean]
-  def _check_safety_naming(name)
-    estimation = _estimate_naming name
-    risk    = NAMING_RISKS.fetch estimation
-    plevels = CONFLICT_MANAGEMENT_LEVELS.fetch @conflict_management_level
-    caution = "undesirable naming '#{name}', because #{estimation}"
-
-    r = (
-      case
-      when risk >= plevels.fetch(:error)
-        raise NameError, caution unless block_given?
-        false
-      when risk >= plevels.fetch(:warn)
-        warn caution unless block_given?
-        false
-      else
-        true
-      end
-    )
+class Striuct
+  module ClassMethods
+    # @group Member Conflict Management
 
-    yield r if block_given?
-  end
-  
-  # @param [Symbol] name
-  # @return [Symbol]
-  def _estimate_naming(name)
-    if (instance_methods + private_instance_methods).include? name
-      return :conflict
+    # @return [Hash] Symbol => Fixnum
+    NAMING_RISKS = {
+      conflict: 10,
+      no_identifier: 9,
+      bad_manners: 5,
+      no_ascii: 3,
+      strict: 0
+    }.freeze
+
+    # @return [Hash] Symbol => Hash
+    CONFLICT_MANAGEMENT_LEVELS = {
+      struct: { error: 99, warn: 99 },
+      warning: { error: 99, warn: 5 },
+      error: { error: 9, warn: 5 },
+      prevent: { error:  5, warn:  1 },
+      nervous: { error:  1, warn:  1 }
+    }.each(&:freeze).freeze
+
+    # @return [Symbol]
+    DEFAULT_CONFLICT_MANAGEMENT_LEVEL = :prevent
+
+    # @param [Object] name
+    # acceptable the name into own member, under protect level of runtime
+    def cname?(name)
+      _check_safety_naming(name.to_sym) { |r| r }
+    rescue Exception
+      false
     end
 
-    return :no_ascii unless name.encoding.equal? Encoding::ASCII
-
-    case name
-    when /[\W]/, /\A[^a-zA-Z_]/, :''
-      :no_identifier
-    when /\Aeach/, /\A__[^_]*__\z/, /\A_[^_]*\z/, /[!?]\z/, /\Ato_/
-      :bad_manners
-    when /\A[a-zA-Z_]\w*\z/
-      :strict
-    else
-      raise 'must not happen'
+    attr_reader :conflict_management_level
+
+    private
+
+    # @param [Symbol, String, #to_sym] level
+    # @return [Symbol] level
+    # change level of management conflict member names
+    def set_conflict_management_level(level)
+      level = level.to_sym
+      raise NameError unless CONFLICT_MANAGEMENT_LEVELS.key?(level)
+
+      @conflict_management_level = level
     end
-  end
-  
-  # @endgroup
 
-end; end
+    # @param [Symbol, String, #to_sym] level
+    # @see [#set_conflict_management_level]
+    # @yieldreturn [self]
+    # @return [void]
+    # @raise [ArgumentError] if no block given
+    # temp scope of a conflict_management_level
+    def conflict_management(level=DEFAULT_CONFLICT_MANAGEMENT_LEVEL)
+      before = @conflict_management_level
+      set_conflict_management_level(level)
+
+      yield
+    ensure
+      @conflict_management_level = before
+      self
+    end
+
+    # @param [Symbol] name
+    # @return [void]
+    # @yieldreturn [Boolean]
+    def _check_safety_naming(name)
+      estimation = _estimate_naming(name)
+      risk    = NAMING_RISKS.fetch(estimation)
+      plevels = CONFLICT_MANAGEMENT_LEVELS.fetch(@conflict_management_level)
+      caution = "undesirable naming '#{name}', because #{estimation}"
+
+      r = (
+        case
+        when risk >= plevels.fetch(:error)
+          raise NameError, caution unless block_given?
+
+          false
+        when risk >= plevels.fetch(:warn)
+          warn(caution) unless block_given?
+          false
+        else
+          true
+        end
+      )
+
+      yield r if block_given?
+    end
+
+    # @param [Symbol] name
+    # @return [Symbol]
+    def _estimate_naming(name)
+      if (instance_methods + private_instance_methods).include?(name)
+        return :conflict
+      end
+
+      return :no_ascii unless name.encoding.equal?(Encoding::ASCII)
+
+      case name
+      when /\W/, /\A[^a-zA-Z_]/, :''
+        :no_identifier
+      when /\Aeach/, /\A__[^_]*__\z/, /\A_[^_]*\z/, /[!?]\z/, /\Ato_/
+        :bad_manners
+      when /\A[a-zA-Z_]\w*\z/
+        :strict
+      else
+        raise 'must not happen'
+      end
+    end
+
+    # @endgroup
+  end
+end