striuct 0.6.1 → 0.9.0

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

data/lib/striuct/classmethods/constructor.rb

@@ -1,66 +1,56 @@
-require 'keyvalidatable'
-require 'optionalargument'
-
-class Striuct; module ClassMethods
-
-  # @group Constructor
-  
-  # @return [Striuct]
-  def for_values(*values)
-    new_instance(*values)
+# frozen_string_literal: true
+
+class Striuct
+  module ClassMethods
+    # @group Constructor
+
+    # @return [Striuct]
+    def for_values(*values)
+      new_instance(*values)
+    end
+
+    alias_method :new, :for_values
+
+    # @param [Hash, Struct, Striuct, #each_pair] pairs
+    # @return [Striuct]
+    def for_pairs(pairs)
+      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)
+      instance
+    end
+
+    alias_method :[], :for_pairs
+
+    # for build the fixed object
+    # @param [Boolean] lock
+    # @param [Boolean] strict
+    # @yieldparam [Striuct] instance
+    # @yieldreturn [Striuct] instance
+    # @return [void]
+    def define(lock: true, strict: true)
+      raise ArgumentError, 'must with block' unless block_given?
+
+      new.tap { |instance|
+        yield instance
+
+        yets = autonyms.select { |autonym| !instance.assigned?(autonym) }
+        unless yets.empty?
+          raise "not assigned members are, yet '#{yets.inspect} in #{self}'"
+        end
+
+        invalids = autonyms.select { |autonym| !instance.valid?(autonym) }
+        if strict && !invalids.empty?
+          raise InvalidWritingError,
+                "invalids members are, yet '#{invalids.inspect} in #{self}'"
+        end
+
+        instance.lock_all if lock
+      }
+    end
+
+    # @endgroup
   end
-
-  alias_method :new, :for_values
-
-  # @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
-
-    instance = allocate
-    instance.__send__ :initialize_for_pairs, pairs
-    instance
-  end
-
-  alias_method :[], :for_pairs
-
-  # @return [Class]
-  DEFINE_OptArg = OptionalArgument.define {
-    opt :lock, default: true, condition: BOOLEAN?
-    opt :strict, default: true, condition: BOOLEAN?
-  }
-
-  # for build the fixed object
-  # @param [Hash] options
-  # @option options [Boolean] :lock
-  # @option options [Boolean] :strict
-  # @yieldparam [Striuct] instance
-  # @yieldreturn [Striuct] instance
-  # @return [void]
-  def define(options={})
-    raise ArgumentError, 'must with block' unless block_given?
-    opts = DEFINE_OptArg.parse options
-    
-    new.tap {|instance|
-      yield instance
-  
-      yets = autonyms.select{|autonym|! instance.assigned?(autonym)}
-      unless yets.empty?
-        raise "not assigned members are, yet '#{yets.inspect} in #{self}'"
-      end
-      
-      invalids = autonyms.select{|autonym|! instance.valid?(autonym)}
-      if opts.strict && !invalids.empty?
-        raise Validation::InvalidWritingError,
-               "invalids members are, yet '#{invalids.inspect} in #{self}'"
-      end
-
-      instance.lock_all if opts.lock
-    }
-  end
-
-  # @endgroup
-
-end; end
+end

data/lib/striuct/classmethods/copy.rb

@@ -1,52 +1,54 @@
-class Striuct; module ClassMethods
+# frozen_string_literal: true
 
-  # @group Basic Methods for Ruby's Object
+class Striuct
+  module ClassMethods
+    # @group Basic Methods for Ruby's Object
 
-  # @return [Class]
-  def clone
-    ret = super
-    ret.__send__ :close_member if closed?
-    ret
-  end
+    # @return [Class]
+    def clone
+      ret = super
+      ret.__send__(:close_member) if closed?
+      ret
+    end
 
-  # @return [Class]
-  def dup
-    copy_variables! super
-  end
+    # @return [Class]
+    def dup
+      copy_variables!(super)
+    end
 
-  private
-  
-  def inherited(subclass)
-    ret = super subclass
-    copy_variables! subclass
-    ret
-  end
-     
-  def initialize_copy(original)
-    ret = super original
-    @autonyms = @autonyms.dup
-    @aliases = @aliases.dup
-    @attributes = @attributes.deep_dup
-    ret
-  end
+    private
 
-  # @return [familar_class]
-  def copy_variables!(familar_class)
-    autonyms = @autonyms.dup
-    aliases  = @aliases.dup
-    attributes = @attributes.deep_dup
-    conflict_management = @conflict_management_level
-
-    familar_class.class_eval do      
-      @autonyms = autonyms
-      @aliases = aliases
-      @attributes = attributes
-      @conflict_management_level = conflict_management
+    def inherited(subclass)
+      ret = super(subclass)
+      copy_variables!(subclass)
+      ret
     end
 
-    familar_class
-  end
+    def initialize_copy(original)
+      ret = super(original)
+      @autonyms = @autonyms.dup
+      @aliases = @aliases.dup
+      @attributes = @attributes.deep_dup
+      ret
+    end
 
-  # @endgroup
+    # @return [familiar_class]
+    def copy_variables!(familiar_class)
+      autonyms = @autonyms.dup
+      aliases  = @aliases.dup
+      attributes = @attributes.deep_dup
+      conflict_management = @conflict_management_level
+
+      familiar_class.class_eval do
+        @autonyms = autonyms
+        @aliases = aliases
+        @attributes = attributes
+        @conflict_management_level = conflict_management
+      end
+
+      familiar_class
+    end
 
-end; end
+    # @endgroup
+  end
+end

data/lib/striuct/classmethods/default.rb

@@ -1,24 +1,26 @@
-class Striuct; module ClassMethods
+# frozen_string_literal: true
 
-  # @group With default value
-    
-  # @param [Symbol, String, #to_sym, Integer, #to_int] key - name / index
-  def default_value_for(key)
-    autonym = autonym_for_key key
-    raise KeyError unless with_default? autonym
- 
-    _attributes_for(autonym).default_value
-  end
+class Striuct
+  module ClassMethods
+    # @group With default value
 
-  # @param [Symbol, String, #to_sym, Integer, #to_int] key - name / index
-  # @return [Symbol] :value / :proc
-  def default_type_for(key)
-    autonym = autonym_for_key key
-    raise KeyError unless with_default? autonym
- 
-    _attributes_for(autonym).default_type
-  end
-  
-  # @endgroup
+    # @param [Symbol, String, #to_sym, Integer, #to_int] key - name / index
+    def default_value_for(key)
+      autonym = autonym_for_key(key)
+      raise KeyError unless with_default?(autonym)
+
+      _attributes_for(autonym).default_value
+    end
 
-end; end
+    # @param [Symbol, String, #to_sym, Integer, #to_int] key - name / index
+    # @return [Symbol] :value / :proc
+    def default_type_for(key)
+      autonym = autonym_for_key(key)
+      raise KeyError unless with_default?(autonym)
+
+      _attributes_for(autonym).default_type
+    end
+
+    # @endgroup
+  end
+end

data/lib/striuct/classmethods/enum.rb

@@ -1,45 +1,47 @@
-class Striuct; module ClassMethods
-
-  # @group Enumerative
-
-  # @yield [autonym] 
-  # @yieldparam [Symbol] autonym - sequential under defined
-  # @yieldreturn [Class] self
-  # @return [Enumerator]
-  def each_autonym
-    return to_enum(__callee__) { size } unless block_given?
-
-    @autonyms.each{|autonym|yield autonym}
-    self
+# frozen_string_literal: true
+
+class Striuct
+  module ClassMethods
+    # @group Enumerative
+
+    # @yield [autonym]
+    # @yieldparam [Symbol] autonym - sequential under defined
+    # @yieldreturn [Class] self
+    # @return [Enumerator]
+    def each_autonym
+      return to_enum(__callee__) { size } unless block_given?
+
+      @autonyms.each { |autonym| yield autonym }
+      self
+    end
+
+    alias_method :each_member, :each_autonym
+
+    # @yield [index]
+    # @yieldparam [Integer] Index
+    # @yieldreturn [Class] self
+    # @return [Enumerator]
+    def each_index
+      return to_enum(__callee__) { size } unless block_given?
+
+      @autonyms.each_index { |index| yield index }
+      self
+    end
+
+    # @yield [autonym, index]
+    # @yieldparam [Symbol] autonym
+    # @yieldparam [Integer] index
+    # @yieldreturn [Class] self
+    # @return [Enumerator]
+    def each_autonym_with_index
+      return to_enum(__callee__) { size } unless block_given?
+
+      @autonyms.each_with_index { |autonym, index| yield autonym, index }
+      self
+    end
+
+    alias_method :each_member_with_index, :each_autonym_with_index
+
+    # @endgroup
   end
-
-  alias_method :each_member, :each_autonym
-  
-  # @yield [index] 
-  # @yieldparam [Integer] Index
-  # @yieldreturn [Class] self
-  # @return [Enumerator]
-  def each_index
-    return to_enum(__callee__) { size }  unless block_given?
-
-    @autonyms.each_index{|index|yield index}
-    self
-  end
-
-  # @yield [autonym, index]
-  # @yieldparam [Symbol] autonym
-  # @yieldparam [Integer] index
-  # @yieldreturn [Class] self
-  # @return [Enumerator]
-  def each_autonym_with_index
-    return to_enum(__callee__) { size }  unless block_given?
-
-    @autonyms.each_with_index{|autonym, index|yield autonym, index}
-    self
-  end
-
-  alias_method :each_member_with_index, :each_autonym_with_index
-
-  # @endgroup
-
-end; end
+end

data/lib/striuct/classmethods/fix.rb

@@ -1,28 +1,30 @@
-class Striuct; module ClassMethods
+# frozen_string_literal: true
 
-  # @group Fix inner data structures 
+class Striuct
+  module ClassMethods
+    # @group Fix inner data structures
 
-  # @return [self]
-  def freeze
-    [@autonyms, @attributes, @aliases].each(&:freeze)
-    super
-  end
+    # @return [self]
+    def freeze
+      [@autonyms, @attributes, @aliases].each(&:freeze)
+      super
+    end
 
-  def closed?
-    [@autonyms, @attributes, @aliases].any?(&:frozen?)
-  end
+    def closed?
+      [@autonyms, @attributes, @aliases].any?(&:frozen?)
+    end
 
-  private
+    private
 
-  # @return [self]
-  def close_member
-    [@autonyms, @attributes, @aliases].each(&:freeze)
-    self
-  end
-  
-  alias_method :fix_structural, :close_member
-  alias_method :close, :close_member
+    # @return [self]
+    def close_member
+      [@autonyms, @attributes, @aliases].each(&:freeze)
+      self
+    end
 
-  # @endgroup
+    alias_method :fix_structural, :close_member
+    alias_method :close, :close_member
 
-end; end
+    # @endgroup
+  end
+end

data/lib/striuct/classmethods/hashdeepdupulicatable.rb

@@ -1,19 +1,19 @@
-class Striuct; module ClassMethods
+# frozen_string_literal: true
 
-  module HashDeepDupulicatable
-
-    # @return [Hash]
-    def deep_dup
-      dup.tap {|h|
-        each_pair do |key, value|
-          h[key] = value.dup
-        end
-        h.extend HashDeepDupulicatable
-      }
+class Striuct
+  module ClassMethods
+    module HashDeepDupulicatable
+      # @return [Hash]
+      def deep_dup
+        dup.tap { |h|
+          each_pair do |key, value|
+            h[key] = value.dup
+          end
+          h.extend HashDeepDupulicatable
+        }
+      end
     end
 
+    private_constant :HashDeepDupulicatable
   end
-
-  private_constant :HashDeepDupulicatable
-
-end; end
+end