striuct 0.3.5.1 → 0.4.0

data/.travis.yml

@@ -12,3 +12,6 @@ matrix:
     - rvm: rbx-19mode
     - rvm: jruby-head
     - rvm: jruby-19mode
+
+before_install:
+  - gem install bundler

data/.yardopts

@@ -1 +1 @@
---readme README.md --private lib/**/*.rb --exclude inner|instancemethods/singleton_class - LICENSE
+--readme README.md --private lib/**/*.rb --exclude attributes|hashdeepdupulicatable - LICENSE

data/LICENSE

@@ -1,6 +1,6 @@
 (The MIT X11 License)
 
-Copyright (C) 2011 Kenichi Kamiya
+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

data/README.md

@@ -1,8 +1,6 @@
 striuct
 =======
 
-[![Build Status](https://secure.travis-ci.org/kachick/striuct.png)](http://travis-ci.org/kachick/striuct)
-
 Description
 -----------
 
@@ -103,6 +101,7 @@ Requirements
 
 * Ruby - [1.9.2 or later](http://travis-ci.org/#!/kachick/striuct)
 * [validation](https://github.com/kachick/validation) - 0.0.3
+* [optionalargument](https://github.com/kachick/optionalargument) - 0.0.1
 * [keyvalidatable](https://github.com/kachick/keyvalidatable) - 0.0.3
 
 Install
@@ -112,6 +111,11 @@ Install
 $ gem install striuct
 ```
 
+Build Status
+-------------
+
+[![Build Status](https://secure.travis-ci.org/kachick/striuct.png)](http://travis-ci.org/kachick/striuct)
+
 Link
 ----
 
@@ -126,6 +130,6 @@ License
 --------
 
 The MIT X11 License  
-Copyright (C) 2011 Kenichi Kamiya  
+Copyright (c) 2011 Kenichi Kamiya  
 See the file LICENSE for further details.
 

data/example/example1.rb

@@ -135,10 +135,11 @@ class SafetyNaming < Striuct.new
     debug $!
   end
   
-  # set lower
-  protect_level :struct
+  # tempolary set lower
+  conflict_management :struct do
+    member :__send__, :'?  !'
+  end
   
-  member :__send__, :'?  !'
 end
 
 # 2. Struct+ "Handy"
@@ -231,4 +232,4 @@ p a
 
 p MyC.new.to_struct
 myc = Striuct.new :a, :b
-p myc.new.to_struct
+p myc.new.to_struct

data/lib/striuct/classmethods/README.md

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

data/lib/striuct/classmethods/adjustment.rb

@@ -2,24 +2,13 @@ class Striuct; module ClassMethods
 
   # @group Adjuster
   
-  # @param [Symbol, String] name
-  def has_adjuster?(name)
-    autonym = autonym_for_name name
-
-    _attributes_for(autonym).has_adjuster?
-  end
-
-  alias_method :has_flavor?, :has_adjuster? # obsolute
-  
-  # @param [Symbol, String] name
-  def adjuster_for(name)
-    return nil unless has_adjuster? name
-    autonym = autonym_for_name name
+  # @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
-  
-  alias_method :flavor_for, :adjuster_for # obsolute
 
   # @endgroup
 

data/lib/striuct/{attributes.rb → classmethods/attributes.rb}

@@ -1,25 +1,23 @@
-class Striuct
+class Striuct; module ClassMethods
 
   # Attributes for each Member(Autonym)
   class Attributes
 
-    VALUES = [:condition, :adjuster].freeze
-    BOOLEANS = [
-                :inference,
-                :validate_with_setter,
-                :validate_with_getter
-               ].freeze
+    VALUES   = [ :condition,
+                 :adjuster  ].freeze
+
+    BOOLEANS = [ :inference,
+                 :safety_setter,
+                 :safety_getter ].freeze
     
     def initialize
-      @hash = {
-        inference:            false,
-        validate_with_setter: false,
-        validate_with_getter: false
-      }
+      @hash =  { inference:     false,
+                 safety_setter: false,
+                 safety_getter: false }
     end
     
     VALUES.each do |role|
-      define_method "has_#{role}?".to_sym do
+      define_method :"with_#{role}?" do
         @hash.has_key? role
       end
       
@@ -38,14 +36,14 @@ class Striuct
 
     def adjuster=(adjuster)
       unless ::Validation.adjustable? adjuster
-        raise ArgumentError, "wrong number of block argument #{arity} for 1"
+        raise ArgumentError, 'wrong object for adjuster'
       end
 
       @hash[:adjuster] = adjuster
     end
 
     BOOLEANS.each do |role|
-      define_method "#{role}?".to_sym do
+      define_method :"with_#{role}?" do
         @hash.fetch role
       end
       
@@ -56,7 +54,7 @@ class Striuct
       end   
     end
 
-    def has_default?
+    def with_default?
       @hash.has_key? :default_value
     end
 
@@ -111,4 +109,4 @@ class Striuct
     private_constant :Attributes
   end
 
-end
+end; end

data/lib/striuct/classmethods/{prevent_conflicts.rb → conflict_management.rb}

@@ -1,7 +1,8 @@
 class Striuct; module ClassMethods
   
-  # @group Prevent Naming Conflicts
+  # @group Member Conflict Management
 
+  # @return [Hash] Symbol => Fixnum
   NAMING_RISKS = {
     conflict:      10,
     no_identifier:  9,
@@ -10,32 +11,54 @@ class Striuct; module ClassMethods
     strict:         0 
   }.freeze
 
-  PROTECT_LEVELS = {
+  # @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(_nameable_for name){|r|r}
+    _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
 
-  # @param [Symbol] level
-  # @return [nil]
-  # change protect level for risk of naming members
-  def protect_level(level)
-    raise NameError unless PROTECT_LEVELS.has_key? level
+    @conflict_management_level = level
+  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
     
-    @protect_level = level
-    nil
+    yield
+  ensure
+    @conflict_management_level = before
+    self
   end
   
   # @param [Symbol] name
@@ -43,16 +66,16 @@ class Striuct; module ClassMethods
   # @yieldreturn [Boolean]
   def _check_safety_naming(name)
     estimation = _estimate_naming name
-    risk    = NAMING_RISKS[estimation]
-    plevels = PROTECT_LEVELS[@protect_level]
+    risk    = NAMING_RISKS.fetch estimation
+    plevels = CONFLICT_MANAGEMENT_LEVELS.fetch @conflict_management_level
     caution = "undesirable naming '#{name}', because #{estimation}"
 
     r = (
       case
-      when risk >= plevels[:error]
+      when risk >= plevels.fetch(:error)
         raise NameError, caution unless block_given?
         false
-      when risk >= plevels[:warn]
+      when risk >= plevels.fetch(:warn)
         warn caution unless block_given?
         false
       else

data/lib/striuct/classmethods/constructor.rb

@@ -9,10 +9,9 @@ class Striuct; module ClassMethods
     new_instance(*values)
   end
 
-  alias_method :load_values, :for_values
   alias_method :new, :for_values
 
-  # @param [Hash, Struct] pairs
+  # @param [Hash, Struct, Striuct, #each_pair] pairs
   # @return [Striuct]
   def for_pairs(pairs)
     raise TypeError, 'no pairs object' unless pairs.respond_to?(:each_pair)
@@ -26,7 +25,6 @@ class Striuct; module ClassMethods
     }
   end
 
-  alias_method :load_pairs, :for_pairs
   alias_method :[], :for_pairs
 
   # for build the fixed object
@@ -55,7 +53,7 @@ class Striuct; module ClassMethods
         raise Validation::InvalidWritingError, "invalids members are, yet '#{invalids.inspect} in #{self}'"
       end
 
-      instance.lock if lock
+      instance.lock_all if lock
     }
   end
 

data/lib/striuct/classmethods/copy.rb

@@ -30,7 +30,7 @@ class Striuct; module ClassMethods
     autonyms = @autonyms.dup
     aliases  = @aliases.dup
     attributes = @attributes.deep_dup
-    protect_level = @protect_level
+    conflict_management = @conflict_management_level
     
     subclass.class_eval do
       original_inherited subclass
@@ -38,7 +38,7 @@ class Striuct; module ClassMethods
       @autonyms = autonyms
       @aliases = aliases
       @attributes = attributes
-      @protect_level = protect_level
+      @conflict_management_level = conflict_management
     end
   end
      

data/lib/striuct/classmethods/default.rb

@@ -1,29 +1,20 @@
 class Striuct; module ClassMethods
 
   # @group With default value
-  
-  # @param [Symbol, String] name
-  def has_default?(name)
-    autonym = autonym_for_name name
-
-    _attributes_for(autonym).has_default?
-  end
-  
-  # @param [Symbol, String] name
-  def default_value_for(name)
-    autonym = autonym_for_name name
-    raise "#{name} has no default value" unless has_default? autonym
+    
+  # @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
 
-  alias_method :default_for, :default_value_for
-
-  # @param [Symbol, String] name
+  # @param [Symbol, String, #to_sym, Integer, #to_int] key - name / index
   # @return [Symbol] :value / :proc
-  def default_type_for(name)
-    autonym = autonym_for_name name
-    raise "#{name} has no default value" unless has_default? autonym
+  def default_type_for(key)
+    autonym = autonym_for_key key
+    raise KeyError unless with_default? autonym
  
     _attributes_for(autonym).default_type
   end

data/lib/striuct/classmethods/enum.rb

@@ -4,7 +4,7 @@ class Striuct; module ClassMethods
 
   # @yield [autonym] 
   # @yieldparam [Symbol] autonym - sequential under defined
-  # @yieldreturn [self]
+  # @yieldreturn [Class] self
   # @return [Enumerator]
   def each_autonym
     return to_enum(__callee__) unless block_given?
@@ -13,12 +13,11 @@ class Striuct; module ClassMethods
     self
   end
 
-  alias_method :each_name, :each_autonym
   alias_method :each_member, :each_autonym
   
   # @yield [index] 
   # @yieldparam [Integer] Index
-  # @yieldreturn [self]
+  # @yieldreturn [Class] self
   # @return [Enumerator]
   def each_index
     return to_enum(__callee__) unless block_given?
@@ -30,7 +29,7 @@ class Striuct; module ClassMethods
   # @yield [autonym, index]
   # @yieldparam [Symbol] autonym
   # @yieldparam [Integer] index
-  # @yieldreturn [self]
+  # @yieldreturn [Class] self
   # @return [Enumerator]
   def each_autonym_with_index
     return to_enum(__callee__) unless block_given?
@@ -39,7 +38,6 @@ class Striuct; module ClassMethods
     self
   end
 
-  alias_method :each_name_with_index, :each_autonym_with_index
   alias_method :each_member_with_index, :each_autonym_with_index
 
   # @endgroup

data/lib/striuct/classmethods/inner.rb

@@ -5,7 +5,7 @@ class Striuct; module ClassMethods
   private
 
   def _add_autonym(autonym)
-    autonym = _nameable_for autonym
+    autonym = autonym.to_sym
     raise NameError, 'already defined' if member? autonym
 
     @attributes[autonym] = Attributes.new
@@ -16,7 +16,7 @@ class Striuct; module ClassMethods
     @attributes.fetch autonym
   end
 
-  def _def_getter!(autonym) 
+  def _def_getter(autonym) 
     define_method autonym do
       _get autonym
     end
@@ -24,8 +24,8 @@ class Striuct; module ClassMethods
     nil
   end
 
-  def _def_setter!(autonym, condition, &adjuster)
-    unless Validation::Condition::ANYTHING.equal? condition
+  def _def_setter(autonym, condition, &adjuster)
+    unless ANYTHING.equal? condition
       _attributes_for(autonym).condition = condition
     end
 
@@ -40,12 +40,8 @@ class Striuct; module ClassMethods
     nil
   end
 
-  def _found_family!(_caller, autonym, our)
-    family = our.class
-
-    raise 'must not happen' unless inference?(autonym) and
-                                    autonym?(autonym) and
-                                   _caller.instance_of?(self)
+  def _found_family(autonym, other)
+    family = other.class
 
     _attributes_for(autonym).condition = family
     _attributes_for(autonym).inference = false

data/lib/striuct/classmethods/macro.rb

@@ -1,26 +1,21 @@
-require 'keyvalidatable'
-
 class Striuct; module ClassMethods
 
   # @group Macro for Member Definition
 
-  VALID_MEMBER_OPTIONS = [
-    :default,
-    :default_proc,
-    :inference,
-    :reader_validation,
-    :getter_validation,
-    :writer_validation,
-    :setter_validation
-  ].freeze
-  
-  DEFAULT_MEMBER_OPTIONS = {
-    setter_validation: true
-  }.freeze
+  ANYTHING = ::Validation::Condition::ANYTHING
   
+  ADD_MEMBER_OPTIONS = OptionalArgument.define {
+    opt :default_value, aliases: [:default]
+    opt :default_proc, aliases: [:lazy_default]
+    conflict :default_value, :default_proc
+    opt :inference, default: false
+    opt :setter_validation, aliases: [:writer_validation], default: true
+    opt :getter_validation, aliases: [:reader_validation], default: false
+  }
+
   private
 
-  # @param [Symbol, String] autonym
+  # @param [Symbol, String, #to_sym] autonym
   # @param [#===, Proc, Method, ANYTHING] condition
   # @param [Hash] options
   # @option options [BasicObject] :default
@@ -31,42 +26,32 @@ class Striuct; module ClassMethods
   # @option options [Boolean] :writer_validation
   # @option options [Boolean] :setter_validation
   # @return [nil]
-  def add_member(autonym, condition=Validation::Condition::ANYTHING, options=DEFAULT_MEMBER_OPTIONS, &adjuster)
+  def add_member(autonym, condition=ANYTHING, options={}, &adjuster)
     raise "can't modify frozen Class" if frozen?
     raise "already closed to add member in #{self}" if closed?
-    options = DEFAULT_MEMBER_OPTIONS.merge(options).extend(KeyValidatable)
-    options.validate_keys let: VALID_MEMBER_OPTIONS
-    if options.has_key?(:default) and options.has_key?(:default_proc)
-      raise ArgumentError, 'It is not able to choose "default" with "default_proc" in options'
-    end
     
-    autonym = _nameable_for autonym # First difinition for an autonym
+    options = ADD_MEMBER_OPTIONS.parse options
+    autonym = autonym.to_sym # First difinition for an autonym
 
     raise ArgumentError, %Q!already exist name "#{autonym}"! if member? autonym
     _check_safety_naming autonym
     _add_autonym autonym
 
-    if options[:setter_validation] or options[:writer_validation]
-      _attributes_for(autonym).validate_with_setter = true
-    end
+    _attributes_for(autonym).safety_setter = !!options.setter_validation
+    _attributes_for(autonym).safety_getter = !!options.getter_validation
 
-    if options[:getter_validation] or options[:reader_validation]
-      _attributes_for(autonym).validate_with_getter = true
-    end
-
-    if options[:inference]
+    if options.inference
       _attributes_for(autonym).inference = true
     end
 
-    _def_getter! autonym
-    _def_setter! autonym, condition, &adjuster
-    
-    if options.has_key?(:default)
-      set_default_value autonym, options.fetch(:default)
-    end
+    _def_getter autonym
+    _def_setter autonym, condition, &adjuster
     
-    if options.has_key?(:default_proc)
-      set_default_value autonym, &options.fetch(:default_proc)
+    case
+    when options.default_value?
+      set_default_value autonym, options.default_value
+    when options.default_proc?
+      set_default_value autonym, &options.default_proc
     end
     
     nil
@@ -74,8 +59,8 @@ class Striuct; module ClassMethods
 
   alias_method :member, :add_member
 
-  # @param [Symbol, String] autonym
-  # @param [Symbol, String] autonyms
+  # @param [Symbol, String, #to_sym] autonym
+  # @param [Symbol, String, #to_sym] autonyms
   # @return [nil]
   def add_members(autonym, *autonyms)
     raise "can't modify frozen Class" if frozen?
@@ -85,14 +70,14 @@ class Striuct; module ClassMethods
     nil
   end
 
-  # @param [Symbol, String] aliased
-  # @param [Symbol, String] autonym
+  # @param [Symbol, String, #to_sym] aliased
+  # @param [Symbol, String, #to_sym] autonym
   # @return [nil]
   def alias_member(aliased, autonym)
     raise "can't modify frozen Class" if frozen?
     raise "already closed to add members in #{self}" if closed?
-    autonym = autonym_for_name autonym
-    aliased  = _nameable_for aliased
+    autonym = autonym_for_member autonym
+    aliased  = aliased.to_sym
     raise ArgumentError, %Q!already exist name "#{aliased}"! if member? aliased
     _check_safety_naming aliased
 
@@ -102,13 +87,13 @@ class Striuct; module ClassMethods
     nil
   end
   
-  # @param [Symbol, String] name
+  # @param [Symbol, String, #to_sym] name
   # @return [nil]
   def set_default_value(name, value=nil, &block)
     raise "can't modify frozen Class" if frozen?
     raise "already closed to modify member attributes in #{self}" if closed?
-    autonym = autonym_for_name(name)
-    raise "already settled default value for #{name}" if has_default? autonym
+    autonym = autonym_for_member name
+    raise "already settled default value for #{name}" if with_default? autonym
 
     if block_given?
       unless value.nil?

data/lib/striuct/classmethods/names.rb

@@ -0,0 +1,75 @@
+class Striuct; module ClassMethods
+
+  # @group Named
+
+  # @return [Array<Symbol>]
+  def autonyms
+    @autonyms.dup
+  end
+
+  alias_method :members, :autonyms
+  
+  # @return [Array<Symbol>]
+  def all_members
+    @autonyms + @aliases.keys
+  end
+ 
+  # @param [Symbol, String, #to_sym] als
+  # @return [Symbol]
+  def autonym_for_alias(als) 
+    @aliases.fetch als.to_sym
+  rescue NoMethodError
+    raise TypeError
+  rescue KeyError
+    raise NameError
+  end
+
+  # @param [Symbol, String, #to_sym] name - autonym / aliased
+  # @return [Symbol]
+  def autonym_for_member(name)
+    raise TypeError unless name.respond_to? :to_sym
+    name = name.to_sym
+    
+    @autonyms.include?(name) ? name : autonym_for_alias(name)
+  end
+
+  # @param [Index, #to_int] index
+  # @return [Symbol] autonym
+  def autonym_for_index(index)
+    @autonyms.fetch index
+  end
+
+  # @param [Symbol, String, #to_sym, Integer, #to_int] key - name / index
+  # @return [Symbol] autonym
+  def autonym_for_key(key)
+    key.respond_to?(:to_sym) ? autonym_for_member(key) : autonym_for_index(key)
+  rescue NameError, IndexError, TypeError
+    raise KeyError
+  end
+
+  # @param [Symbol, String, #to_sym] autonym
+  # @return [Array<Symbol>]
+  def aliases_for_autonym(autonym)
+    raise TypeError unless autonym.respond_to?(:to_sym)
+    autonym = autonym.to_sym
+    raise NameError unless with_aliases? autonym
+
+    @aliases.select{|als, aut|autonym == aut}.keys
+  end
+  
+  # @return [Hash] alias => autonym
+  def aliases
+    @aliases.dup
+  end
+  
+  private
+
+  # for direct access inner data from own instance
+  # @return [Hash] alias => autonym
+  def _autonyms
+    @autonyms
+  end
+  
+  # @endgroup
+
+end; end