striuct 0.3.1 → 0.3.2

data/.gitignore

@@ -30,3 +30,5 @@ doc/
 
 # other
 *.lock
+*.bak
+tool/

data/.yardopts

@@ -0,0 +1 @@
+--readme README.md --protected --private lib/**/*.rb --exclude inner|instancemethods/singleton_class - LICENSE

data/History.rdoc

@@ -1,3 +1,9 @@
+=== 0.3.2 2012-9-4
+
+* fix:
+  * #assign
+  * .for_pairs, .[]
+
 === 0.3.1 2012-9-2
 
 * add:

data/Manifest.txt

@@ -6,27 +6,46 @@ Manifest.txt
 Rakefile
 Gemfile
 striuct.gemspec
+.yardopts
+
 lib/striuct.rb
 lib/striuct/version.rb
 lib/striuct/specificcontainer.rb
+lib/striuct/singleton_class.rb
+
 lib/striuct/classmethods.rb
 lib/striuct/classmethods/requirements.rb
-lib/striuct/classmethods/constants.rb
-lib/striuct/classmethods/basic.rb
+lib/striuct/classmethods/inner.rb
+lib/striuct/classmethods/named.rb
+lib/striuct/classmethods/object.rb
+lib/striuct/classmethods/length.rb
+lib/striuct/classmethods/to_struct.rb
 lib/striuct/classmethods/constructor.rb
-lib/striuct/classmethods/safety.rb
-lib/striuct/classmethods/handy.rb
+lib/striuct/classmethods/enum.rb
+lib/striuct/classmethods/default.rb
+lib/striuct/classmethods/adjustment.rb
 lib/striuct/classmethods/macro.rb
-lib/striuct/classmethods/inner.rb
+lib/striuct/classmethods/prevent_conflicts.rb
+lib/striuct/classmethods/validation.rb
+
 lib/striuct/instancemethods.rb
 lib/striuct/instancemethods/requirements.rb
 lib/striuct/instancemethods/singleton_class.rb
-lib/striuct/instancemethods/basic.rb
-lib/striuct/instancemethods/safety.rb
-lib/striuct/instancemethods/handy.rb
-lib/striuct/instancemethods/hashlike.rb
+lib/striuct/instancemethods/delegate_class_methods.rb
 lib/striuct/instancemethods/inner.rb
-lib/striuct/singleton_class.rb
+lib/striuct/instancemethods/object.rb
+lib/striuct/instancemethods/compare.rb
+lib/striuct/instancemethods/values.rb
+lib/striuct/instancemethods/to_struct.rb
+lib/striuct/instancemethods/default.rb
+lib/striuct/instancemethods/enum.rb
+lib/striuct/instancemethods/hashy.rb
+lib/striuct/instancemethods/subscript.rb
+lib/striuct/instancemethods/assign.rb
+lib/striuct/instancemethods/lock.rb
+lib/striuct/instancemethods/validation.rb
+lib/striuct/instancemethods/safety.rb
+
 test/helper.rb
 test/test_striuct.rb
 test/test_striuct_define.rb
@@ -36,7 +55,7 @@ test/test_striuct_subclass_assign.rb
 test/test_striuct_subclass_classlock.rb
 test/test_striuct_subclass_classmethods.rb
 test/test_striuct_subclass_cloning.rb
-test_striuct_subclass_default_value.rb
+test/test_striuct_subclass_default_value.rb
 test/test_striuct_subclass_for_pairs.rb
 test/test_striuct_subclass_freeze.rb
 test/test_striuct_subclass_functional_condition.rb
@@ -50,10 +69,12 @@ test/test_striuct_subclass_safetynaming.rb
 test/test_striuct_subclass_specific_conditions.rb
 test/test_striuct_subclass_to_struct.rb
 test/test_striuct_version.rb
-examples/README.rb
-examples/example1.rb
-examples/example2.rb
-examples/example.old.rdoc
-examples/see_trace.rb
-benchmarks/basics.rb
+
+example/README.rb
+example/example1.rb
+example/example2.rb
+example/example.old.rdoc
+example/see_trace.rb
+
+benchmark/basics.rb
 

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
 -----------
 
@@ -13,9 +11,9 @@ Features
 
 ### Strict
 
-* Base API looks like Struct
 * Easy and Flexible Validations
 * Prevent to conflict member names
+* Lock setters for each member
 
 ### Useful
 
@@ -23,9 +21,12 @@ Features
 * Default value
 * Member aliasing
 * Inheritable
+* Hndling between nil <-> unassigned
+* More flendly API for Hash
 
 ### Onepoint
 
+* Base API looks like Struct
 * Pure Ruby :)
 
 Usage
@@ -63,7 +64,7 @@ ken.id                   #=> 2
 
 #### Basics
 
-examples/*
+example/*
 
 Requirements
 -------------
@@ -83,6 +84,7 @@ Link
 ----
 
 * [code](https://github.com/kachick/striuct)
+* [API](http://kachick.github.com/docs/striuct/api/frames.html)
 * [issues](https://github.com/kachick/striuct/issues)
 * [CI](http://travis-ci.org/#!/kachick/striuct)
 * [gem](https://rubygems.org/gems/striuct)

data/lib/striuct/classmethods/adjustment.rb

@@ -0,0 +1,31 @@
+class Striuct; module ClassMethods
+
+  # @group Adjuster
+  
+  # @param [Symbol, String] name
+  def has_adjuster?(name)
+    autonym = autonym_for name
+
+    ! adjuster_for(autonym).nil?
+  end
+
+  alias_method :has_flavor?, :has_adjuster?
+  
+  # @param [Symbol, String] name
+  def adjuster_for(name)
+    _adjuster_for autonym_for(name)
+  end
+  
+  alias_method :flavor_for, :adjuster_for
+
+  private
+  
+  def _adjuster_for(name)
+    @adjusters[name]
+  end
+
+  alias_method :_flavor_for, :_adjuster_for
+
+  # @endgroup
+
+end; end

data/lib/striuct/classmethods/constructor.rb

@@ -1,9 +1,10 @@
 require 'keyvalidatable'
 
 class Striuct; module ClassMethods
+
   # @group Constructor
   
-  # @return [Subclass]
+  # @return [Striuct]
   def for_values(*values)
     new_instance(*values)
   end
@@ -11,12 +12,10 @@ class Striuct; module ClassMethods
   alias_method :load_values, :for_values
   alias_method :new, :for_values
 
-  # @param [Hash, Struct]
+  # @param [Hash, Struct] pairs
   # @return [Striuct]
   def for_pairs(pairs)
-    unless pairs.respond_to?(:each_pair) and pairs.respond_to?(:keys)
-      raise TypeError, 'no pairs object'
-    end
+    raise TypeError, 'no pairs object' unless pairs.respond_to?(:each_pair)
 
     pairs.dup.extend(KeyValidatable).validate_keys let: all_members
 
@@ -39,19 +38,19 @@ class Striuct; module ClassMethods
   # @return [void]
   def define(options={lock: true, strict: true})
     raise ArgumentError, 'must with block' unless block_given?
-    options.extend(KeyValidatable).validate_keys let: [:lock, :strict]
+    options.dup.extend(KeyValidatable).validate_keys let: [:lock, :strict]
     
     lock, strict = options[:lock], options[:strict]
     
     new.tap {|instance|
       yield instance
   
-      unless (yets = each_name.select{|name|! instance.assign?(name)}).empty?
+      unless (yets = autonyms.select{|autonym|! instance.assign?(autonym)}).empty?
         raise "not assigned members are, yet '#{yets.inspect} in #{self}'"
       end
       
       if strict &&
-        ! (invalids = each_name.select{|name|! instance.valid?(name)}).empty?
+        ! (invalids = autonyms.select{|autonym|! instance.valid?(autonym)}).empty?
 
         raise Validation::InvalidWritingError, "invalids members are, yet '#{invalids.inspect} in #{self}'"
       end
@@ -61,4 +60,5 @@ class Striuct; module ClassMethods
   end
 
   # @endgroup
+
 end; end

data/lib/striuct/classmethods/default.rb

@@ -0,0 +1,28 @@
+class Striuct; module ClassMethods
+
+  # @group With default value
+  
+  # @param [Symbol, String] name
+  def has_default?(name)
+    autonym = autonym_for name
+
+    @defaults.has_key? autonym
+  end
+  
+  # @param [Symbol, String] name
+  def default_for(name)
+    autonym = autonym_for name
+    raise "#{name} has no default value" unless has_default? autonym
+    
+    _default_for autonym
+  end
+  
+  private
+  
+  def _default_for(name)
+    @defaults[name]
+  end
+
+  # @endgroup
+
+end; end

data/lib/striuct/classmethods/enum.rb

@@ -0,0 +1,49 @@
+class Striuct; module ClassMethods
+
+  # @group Enumerative
+
+  # @yield [autonym] 
+  # @yieldparam [Symbol] autonym - sequential under defined
+  # @yieldreturn [self]
+  # @return [Enumerator]
+  def each_autonym
+    return to_enum(__callee__) unless block_given?
+
+    _autonyms.each{|autonym|yield autonym}
+    self
+  end
+
+  alias_method :each_name, :each_autonym
+  alias_method :each_member, :each_autonym
+  alias_method :each_key, :each_autonym
+  
+  # @yield [index] 
+  # @yieldparam [Integer] Index
+  # @yieldreturn [self]
+  # @return [Enumerator]
+  def each_index
+    return to_enum(__callee__) unless block_given?
+
+    _autonyms.each_index{|index|yield index}
+    self
+  end
+
+  # @yield [autonym, index]
+  # @yieldparam [Symbol] autonym
+  # @yieldparam [Integer] index
+  # @yieldreturn [self]
+  # @return [Enumerator]
+  def each_autonym_with_index
+    return to_enum(__callee__) unless block_given?
+
+    _autonyms.each_with_index{|autonym, index|yield autonym, index}
+    self
+  end
+
+  alias_method :each_name_with_index, :each_autonym_with_index
+  alias_method :each_member_with_index, :each_autonym_with_index
+  alias_method :each_key_with_index, :each_autonym_with_index
+
+  # @endgroup
+
+end; end

data/lib/striuct/classmethods/inner.rb

@@ -1,19 +1,32 @@
 class Striuct; module ClassMethods
-  # @group Use Only Inner
+
+  # @group Inner Methods
 
   private
 
-  def _names
-    @names
+  def __getter__!(name) 
+    define_method name do
+      __get__ name
+    end
+    
+    nil
+  end
+
+  def _autonyms
+    @autonyms
   end
   
+  alias_method :_names, :_autonyms
+  
   def _alias_member(aliased, original)
     @aliases[aliased] = original
   end
   
-  def _original_for(aliased)
+  def _autonym_for(aliased)
     @aliases[aliased]
   end
+  
+  alias_method :_original_for, :_autonym_for
 
   def _aliases_for(original)
     @aliases.group_by{|aliased, org|org}[original]
@@ -35,8 +48,8 @@ class Striuct; module ClassMethods
     @inferences[name] = true
   end
   
-  def _set_flavor(name, flavor)
-    @flavors[name] = flavor
+  def _set_adjuster(name, adjuster)
+    @adjusters[name] = adjuster
   end
   
   def _set_condition(name, condition)
@@ -47,84 +60,9 @@ class Striuct; module ClassMethods
     @defaults[name] = value
   end
 
-  # @param [Symbol, String, #to_sym, #to_str] name
-  def autonym_for(name)
-    name = keyable_for name
-    
-    if _names.include? name
-      name
-    else
-      if original = _original_for(name)
-        original
-      else
-        raise NameError, "not defined member for #{name}"
-      end
-    end
-  end
-
-  # @param [Symbol, String, #to_sym] name
-  # @return [Symbol]
-  def keyable_for(name)
-    name.to_sym
-  end
-
-  # @param [Symbol] name
-  # @return [void]
-  # @yieldreturn [Boolean]
-  def _check_safety_naming(name)
-    estimation = _estimate_naming name
-    risk    = NAMING_RISKS[estimation]
-    plevels = PROTECT_LEVELS[@protect_level]
-    caution = "undesirable naming '#{name}', because #{estimation}"
-
-    r = (
-      case
-      when risk >= plevels[:error]
-        raise NameError, caution unless block_given?
-        false
-      when risk >= plevels[: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
-
-  def __getter__!(name) 
-    define_method name do
-      __get__ name
-    end
-    
-    nil
-  end
-
-  def __setter__!(name, condition, &flavor)
+  def __setter__!(name, condition, &adjuster)
     __set_condition__! name, condition unless Validation::Condition::ANYTHING.equal? condition
-    __set_flavor__! name, &flavor if block_given?
+    __set_adjuster__! name, &adjuster if block_given?
 
     define_method :"#{name}=" do |value|
       __set__ name, value
@@ -144,9 +82,9 @@ class Striuct; module ClassMethods
     nil
   end
 
-  def __set_flavor__!(name, &flavor)
-    if ::Validation.adjustable? flavor
-      _set_flavor name, flavor
+  def __set_adjuster__!(name, &adjuster)
+    if ::Validation.adjustable? adjuster
+      _set_adjuster name, adjuster
     else
       raise ArgumentError, "wrong number of block argument #{arity} for 1"
     end
@@ -170,27 +108,6 @@ class Striuct; module ClassMethods
     nil
   end
   
-  def _condition_for(name)
-    @conditions[name]
-  end
-  
-  # @param [Symbol, String] name
-  def condition_for(name)
-    _condition_for autonym_for(name)
-  end
-  
-  def _flavor_for(name)
-    @flavors[name]
-  end
-
-  # @param [Symbol, String] name
-  def flavor_for(name)
-    _flavor_for autonym_for(name)
-  end
-  
-  def _default_for(name)
-    @defaults[name]
-  end
-
   # @endgroup
+
 end; end

data/lib/striuct/classmethods/length.rb

@@ -0,0 +1,14 @@
+class Striuct; module ClassMethods
+
+  # @group Length/Size
+
+  # @return [Integer]
+  def length
+    @autonyms.length
+  end
+  
+  alias_method :size, :length
+
+  # @endgroup
+
+end; end

data/lib/striuct/classmethods/macro.rb

@@ -1,19 +1,8 @@
 require 'keyvalidatable'
 
 class Striuct; module ClassMethods
-  # @group Macro for Definition
 
-  private
-
-  # @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
-    
-    @protect_level = level
-    nil
-  end
+  # @group Macro for Member Definition
 
   VALID_MEMBER_OPTIONS = [
     :default,
@@ -28,8 +17,14 @@ class Striuct; module ClassMethods
   DEFAULT_MEMBER_OPTIONS = {
     setter_validation: true
   }.freeze
+  
+  def closed?
+    [@autonyms, @adjusters, @defaults, @aliases].any?(&:frozen?)
+  end
 
-  # @param [Symbol, String] name
+  private
+
+  # @param [Symbol, String] autonym
   # @param [#===, Proc, Method, ANYTHING] condition
   # @param [Hash] options
   # @option options [BasicObject] :default
@@ -40,7 +35,7 @@ class Striuct; module ClassMethods
   # @option options [Boolean] :writer_validation
   # @option options [Boolean] :setter_validation
   # @return [nil]
-  def add_member(name, condition=Validation::Condition::ANYTHING, options=DEFAULT_MEMBER_OPTIONS, &flavor)
+  def add_member(autonym, condition=Validation::Condition::ANYTHING, options=DEFAULT_MEMBER_OPTIONS, &adjuster)
     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
@@ -48,23 +43,24 @@ class Striuct; module ClassMethods
       raise ArgumentError, 'It is not able to choose "default" with "default_proc" in options'
     end
     
-    name = keyable_for name
-    raise ArgumentError, %Q!already exist name "#{name}"! if member? name
-    _check_safety_naming name
-    _mark_setter_validation name if options[:setter_validation] or options[:writer_validation]
-    _mark_getter_validation name if options[:getter_validation] or options[:reader_validation]
-    _mark_inference name if options[:inference]
+    autonym = keyable_for autonym # First difinition for an autonym
 
-    @names << name
-    __getter__! name
-    __setter__! name, condition, &flavor
+    raise ArgumentError, %Q!already exist name "#{autonym}"! if member? autonym
+    _check_safety_naming autonym
+    _mark_setter_validation autonym if options[:setter_validation] or options[:writer_validation]
+    _mark_getter_validation autonym if options[:getter_validation] or options[:reader_validation]
+    _mark_inference autonym if options[:inference]
+
+    @autonyms << autonym
+    __getter__! autonym
+    __setter__! autonym, condition, &adjuster
     
     if options.has_key?(:default)
-      set_default_value name, options.fetch(:default)
+      set_default_value autonym, options.fetch(:default)
     end
     
     if options.has_key?(:default_proc)
-      set_default_value name, &options.fetch(:default_proc)
+      set_default_value autonym, &options.fetch(:default_proc)
     end
     
     nil
@@ -72,30 +68,29 @@ class Striuct; module ClassMethods
 
   alias_method :member, :add_member
 
-  # @param [Symbol, String] name
-  # @param [Symbol, String] *names
+  # @param [Symbol, String] autonym
+  # @param [Symbol, String] autonyms
   # @return [nil]
-  def add_members(name, *names)
+  def add_members(autonym, *autonyms)
     raise "already closed to add members in #{self}" if closed?
     
-    [name, *names].each {|_name|add_member _name}
+    [autonym, *autonyms].each {|_autonym|add_member _autonym}
     nil
   end
 
   # @param [Symbol, String] aliased
-  # @param [Symbol, String] original
+  # @param [Symbol, String] autonym
   # @return [nil]
-  def alias_member(aliased, original)
+  def alias_member(aliased, autonym)
     raise "already closed to add members in #{self}" if closed?
-    original = keyable_for original
+    autonym = autonym_for autonym
     aliased  = keyable_for aliased
-    raise NameError unless member? original
     raise ArgumentError, %Q!already exist name "#{aliased}"! if member? aliased
     _check_safety_naming aliased
 
-    alias_method aliased, original
-    alias_method "#{aliased}=", "#{original}="
-    _alias_member aliased, original
+    alias_method aliased, autonym
+    alias_method :"#{aliased}=", :"#{autonym}="
+    _alias_member aliased, autonym
     nil
   end
   
@@ -103,8 +98,8 @@ class Striuct; module ClassMethods
   # @return [nil]
   def set_default_value(name, value=nil, &block)
     raise "already closed to modify member attributes in #{self}" if closed?
-    name = autonym_for(name)
-    raise "already settled default value for #{name}" if has_default? name
+    autonym = autonym_for(name)
+    raise "already settled default value for #{name}" if has_default? autonym
 
     value = (
       if block_given?
@@ -112,7 +107,7 @@ class Striuct; module ClassMethods
           arity = block.arity
           
           if valid_default_proc? block
-            SpecificContainer.new block
+            DefaultProcHolder.new block
           else
             raise ArgumentError, "wrong number of block parameter #{arity} for 0..2"
           end
@@ -124,19 +119,20 @@ class Striuct; module ClassMethods
       end
     )
     
-    _set_default_value name, value
+    _set_default_value autonym, value
     nil
   end
   
   alias_method :default, :set_default_value
   
+  # @param [Proc] _proc
   def valid_default_proc?(_proc)
     _proc.arity <= 2
   end
   
   # @return [self]
   def close_member
-    [@names, @flavors, @defaults, @aliases].each(&:freeze)
+    [@autonyms, @adjusters, @defaults, @aliases].each(&:freeze)
     self
   end
   
@@ -144,4 +140,5 @@ class Striuct; module ClassMethods
   alias_method :close, :close_member
   
   # @endgroup
+
 end; end