striuct 0.3.2 → 0.3.3

data/History.rdoc

@@ -1,3 +1,15 @@
+=== 0.3.3 2012-9-7
+
+* modify:
+  * SubClass#to_s
+  * SubClass#inspect
+
+* fix:
+  * SubClass.freeze
+
+* add:
+  * compatibility with keyvalidatable-API
+
 === 0.3.2 2012-9-4
 
 * fix:

data/LICENSE

@@ -1,6 +1,6 @@
-(The MIT License)
+(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/Manifest.txt

@@ -13,6 +13,7 @@ lib/striuct/version.rb
 lib/striuct/specificcontainer.rb
 lib/striuct/singleton_class.rb
 
+lib/striuct/classmethods/README.md
 lib/striuct/classmethods.rb
 lib/striuct/classmethods/requirements.rb
 lib/striuct/classmethods/inner.rb
@@ -28,15 +29,16 @@ lib/striuct/classmethods/macro.rb
 lib/striuct/classmethods/prevent_conflicts.rb
 lib/striuct/classmethods/validation.rb
 
+lib/striuct/instancemethods/README.md
 lib/striuct/instancemethods.rb
 lib/striuct/instancemethods/requirements.rb
-lib/striuct/instancemethods/singleton_class.rb
 lib/striuct/instancemethods/delegate_class_methods.rb
+lib/striuct/instancemethods/keyvalidatable.rb
 lib/striuct/instancemethods/inner.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/cast.rb
 lib/striuct/instancemethods/default.rb
 lib/striuct/instancemethods/enum.rb
 lib/striuct/instancemethods/hashy.rb
@@ -47,28 +49,36 @@ lib/striuct/instancemethods/validation.rb
 lib/striuct/instancemethods/safety.rb
 
 test/helper.rb
-test/test_striuct.rb
-test/test_striuct_define.rb
-test/test_striuct_subclass_adjuster
-test/test_striuct_subclass_alias_member.rb
-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/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
-test/test_striuct_subclass_getter_validation.rb
-test/test_striuct_subclass_hashlike.rb
-test/test_striuct_subclass_inference.rb
-test/test_striuct_subclass_inheritable.rb
-test/test_striuct_subclass_instance.rb
-test/test_striuct_subclass_lock.rb
-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
+test/test_striuct-version.rb
+test/test_striuct-singleton_class-define.rb
+test/test_striuct-subclass-class-cloning.rb
+test/test_striuct-subclass-class-close.rb
+test/test_striuct-subclass-class-freeze.rb
+test/test_striuct-subclass-class-constructor.rb
+test/test_striuct-subclass-class-inheritable.rb
+test/test_striuct-subclass-class-macro.rb
+test/test_striuct-subclass-class-safety_naming.rb
+test/test_striuct-subclass-class-validation.rb
+test/test_striuct-subclass-feature-alias_member.rb
+test/test_striuct-subclass-feature-to_struct.rb
+test/test_striuct-subclass-instance-accessor.rb
+test/test_striuct-subclass-instance-adjuster.rb
+test/test_striuct-subclass-instance-assign.rb
+test/test_striuct-subclass-instance-basic.rb
+test/test_striuct-subclass-instance-cloning.rb
+test/test_striuct-subclass-instance-compare.rb
+test/test_striuct-subclass-instance-default_value.rb
+test/test_striuct-subclass-instance-enum.rb
+test/test_striuct-subclass-instance-freeze.rb
+test/test_striuct-subclass-instance-hashlike.rb
+test/test_striuct-subclass-instance-keyvalidatable.rb
+test/test_striuct-subclass-instance-lock.rb
+test/test_striuct-subclass-instance-to_s_family.rb
+test/test_striuct-subclass-instance-validation_functional_condition.rb
+test/test_striuct-subclass-instance-validation_inference.rb
+test/test_striuct-subclass-instance-validation_specific_conditions.rb
+test/test_striuct-subclass-instance-validation_with_getter.rb
+test/test_striuct-subclass-instance_names.rb
 
 example/README.rb
 example/example1.rb

data/README.md

@@ -21,7 +21,7 @@ Features
 * Default value
 * Member aliasing
 * Inheritable
-* Hndling between nil <-> unassigned
+* Handling between nil <-> unassigned
 * More flendly API for Hash
 
 ### Onepoint
@@ -32,7 +32,7 @@ Features
 Usage
 -----
 
-### Overview
+### Overview - Case 1
 
 ```ruby
 require 'striuct'
@@ -59,6 +59,36 @@ 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, inference: true
+  member :with_adjuster, Integer, &->v{Integer v}
+end
+
+foo = Foo.new
+
+# nil <-> unaasigned
+foo.foo                  #=> nil
+foo.assign?(:foo)        #=> false
+foo.foo = nil
+foo.assign?(:foo)        #=> true
+
+# Lock to a member
+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
+
+# With adjuster
+foo.with_adjuster = '5'
+foo.with_adjuster        #=> 5                # Casted via adjuster
+```
+
 
 ### More Examples
 
@@ -71,7 +101,7 @@ Requirements
 
 * Ruby 1.9.2 or later [MRI/YARV, Rubinius](http://travis-ci.org/#!/kachick/striuct)
 * validation - 0.0.3
-* keyvalidatable - 0.0.2
+* keyvalidatable - 0.0.3
 
 Install
 -------
@@ -88,12 +118,11 @@ Link
 * [issues](https://github.com/kachick/striuct/issues)
 * [CI](http://travis-ci.org/#!/kachick/striuct)
 * [gem](https://rubygems.org/gems/striuct)
-* [gem+](http://metagem.info/gems/striuct)
 
 License
 --------
 
-The MIT X License  
+The MIT X11 License  
 Copyright (c) 2011 Kenichi Kamiya  
 See the file LICENSE for further details.
 

data/example/README.rb

@@ -22,4 +22,23 @@ p john[:name]      #=> 'john'
 #~ p john.name = ''  #=> error
 p john.id          #=> 1
 ken = User[name: 'ken']                       # Construct from hash
-p ken.id           #=> 2
+p ken.id           #=> 2
+
+class Foo < Striuct
+  member :foo
+  member :bar, Numeric, inference: true
+  member :with_adjuster, Integer, &->v{Integer v}
+end
+
+foo = Foo.new
+p foo.foo           #=> nil
+p foo.assign?(:foo) #=> false
+foo.foo = nil
+p foo.assign?(:foo) #=> true
+foo.lock(:foo)
+#~ foo.foo = nil       #=> error
+foo.bar = 1.2
+#~ foo.bar = 1          #=> error
+
+foo.with_adjuster = '5'
+p foo.with_adjuster

data/lib/striuct/classmethods/README.md

@@ -0,0 +1,5 @@
+For developer
+==============
+
+* This dir's tree is diveded under roles/features.
+  Not under CONSTANT names.

data/lib/striuct/classmethods/adjustment.rb

@@ -13,15 +13,17 @@ class Striuct; module ClassMethods
   
   # @param [Symbol, String] name
   def adjuster_for(name)
-    _adjuster_for autonym_for(name)
+    autonym = autonym_for name
+    
+    _adjuster_for autonym
   end
   
   alias_method :flavor_for, :adjuster_for
 
   private
   
-  def _adjuster_for(name)
-    @adjusters[name]
+  def _adjuster_for(autonym)
+    @adjusters[autonym]
   end
 
   alias_method :_flavor_for, :_adjuster_for

data/lib/striuct/classmethods/default.rb

@@ -19,8 +19,8 @@ class Striuct; module ClassMethods
   
   private
   
-  def _default_for(name)
-    @defaults[name]
+  def _default_for(autonym)
+    @defaults[autonym]
   end
 
   # @endgroup

data/lib/striuct/classmethods/enum.rb

@@ -9,7 +9,7 @@ class Striuct; module ClassMethods
   def each_autonym
     return to_enum(__callee__) unless block_given?
 
-    _autonyms.each{|autonym|yield autonym}
+    @autonyms.each{|autonym|yield autonym}
     self
   end
 
@@ -24,7 +24,7 @@ class Striuct; module ClassMethods
   def each_index
     return to_enum(__callee__) unless block_given?
 
-    _autonyms.each_index{|index|yield index}
+    @autonyms.each_index{|index|yield index}
     self
   end
 
@@ -36,7 +36,7 @@ class Striuct; module ClassMethods
   def each_autonym_with_index
     return to_enum(__callee__) unless block_given?
 
-    _autonyms.each_with_index{|autonym, index|yield autonym, index}
+    @autonyms.each_with_index{|autonym, index|yield autonym, index}
     self
   end
 

data/lib/striuct/classmethods/inner.rb

@@ -12,69 +12,49 @@ class Striuct; module ClassMethods
     nil
   end
 
-  def _autonyms
-    @autonyms
+  def _remove_inference(autonym)
+    @inferences.delete autonym
   end
   
-  alias_method :_names, :_autonyms
-  
-  def _alias_member(aliased, original)
-    @aliases[aliased] = original
-  end
-  
-  def _autonym_for(aliased)
-    @aliases[aliased]
-  end
-  
-  alias_method :_original_for, :_autonym_for
-
-  def _aliases_for(original)
-    @aliases.group_by{|aliased, org|org}[original]
-  end
-
-  def _remove_inference(name)
-    @inferences.delete name
-  end
-  
-  def _mark_setter_validation(name)
-    @setter_validations[name] = true
+  def _mark_setter_validation(autonym)
+    @setter_validations[autonym] = true
   end
 
-  def _mark_getter_validation(name)
-    @getter_validations[name] = true
+  def _mark_getter_validation(autonym)
+    @getter_validations[autonym] = true
   end
 
-  def _mark_inference(name)
-    @inferences[name] = true
+  def _mark_inference(autonym)
+    @inferences[autonym] = true
   end
   
-  def _set_adjuster(name, adjuster)
-    @adjusters[name] = adjuster
+  def _set_adjuster(autonym, adjuster)
+    @adjusters[autonym] = adjuster
   end
   
-  def _set_condition(name, condition)
-    @conditions[name] = condition
+  def _set_condition(autonym, condition)
+    @conditions[autonym] = condition
   end
   
-  def _set_default_value(name, value)
-    @defaults[name] = value
+  def _set_default_value(autonym, value)
+    @defaults[autonym] = value
   end
 
-  def __setter__!(name, condition, &adjuster)
-    __set_condition__! name, condition unless Validation::Condition::ANYTHING.equal? condition
-    __set_adjuster__! name, &adjuster if block_given?
+  def __setter__!(autonym, condition, &adjuster)
+    __set_condition__! autonym, condition unless Validation::Condition::ANYTHING.equal? condition
+    __set_adjuster__! autonym, &adjuster if block_given?
 
-    define_method :"#{name}=" do |value|
-      __set__ name, value
+    define_method :"#{autonym}=" do |value|
+      __set__ autonym, value
     end
  
     nil
 
   end
   
-  def __set_condition__!(name, condition)
+  def __set_condition__!(autonym, condition)
     if ::Validation.conditionable? condition
-      _set_condition name, condition
+      _set_condition autonym, condition
     else
       raise TypeError, 'wrong object for condition'
     end
@@ -82,9 +62,9 @@ class Striuct; module ClassMethods
     nil
   end
 
-  def __set_adjuster__!(name, &adjuster)
+  def __set_adjuster__!(autonym, &adjuster)
     if ::Validation.adjustable? adjuster
-      _set_adjuster name, adjuster
+      _set_adjuster autonym, adjuster
     else
       raise ArgumentError, "wrong number of block argument #{arity} for 1"
     end
@@ -92,18 +72,17 @@ class Striuct; module ClassMethods
     nil
   end
 
-  def __found_family__!(_caller, name, our)
+  def __found_family__!(_caller, autonym, our)
     family = our.class
 
-    raise 'must not happen' unless name.instance_of?(Symbol) and
-                                   inference?(name) and
-                                   member?(name) and
+    raise 'must not happen' unless inference?(autonym) and
+                                    autonym?(autonym) and
                                    _caller.instance_of?(self)
 
     raise ArgumentError unless Validation.conditionable? family
 
-    _set_condition name, family
-    _remove_inference name
+    _set_condition autonym, family
+    _remove_inference autonym
 
     nil
   end

data/lib/striuct/classmethods/named.rb

@@ -39,7 +39,7 @@ class Striuct; module ClassMethods
   def autonym_for(name)
     name = keyable_for name
     
-    if _autonyms.include? name
+    if @autonyms.include? name
       name
     else
       if autonym = _autonym_for(name)
@@ -61,13 +61,15 @@ class Striuct; module ClassMethods
   alias_method :original?, :autonym?
   
   # @param [Symbol, String] name
-  def aliased?(name)
+  def alias?(name)
     name = keyable_for name
     raise NameError unless member? name
 
     @aliases.has_key? name
   end
   
+  alias_method :aliased?, :alias?
+  
   # @param [Symbol, String] autonym
   def has_aliases?(autonym)
     raise NameError unless autonym? autonym
@@ -88,6 +90,24 @@ class Striuct; module ClassMethods
   def aliases
     @aliases.dup
   end
+  
+  private
+  
+  def _autonyms
+    @autonyms
+  end
+  
+  def _alias_member(aliased, autonym)
+    @aliases[aliased] = autonym
+  end
+  
+  def _autonym_for(aliased)
+    @aliases[aliased]
+  end
+  
+  def _aliases_for(autonym)
+    @aliases.group_by{|aliased, an|an}.fetch(autonym)
+  end
 
   # @endgroup
 

data/lib/striuct/classmethods/object.rb

@@ -4,7 +4,7 @@ class Striuct; module ClassMethods
 
   # @return [self]
   def freeze
-    __stores__.each(&:freeze)
+    __floating_attributes__.each(&:freeze)
     super
   end
 
@@ -12,12 +12,42 @@ class Striuct; module ClassMethods
   def dup
     r = super
     @autonyms, @adjusters, @defaults, @aliases,
-    @setter_validations, @getter_validations = 
-    *[@autonyms, @adjusters, @defaults, @aliases,
-      @setter_validations, @getter_validations].map(&:dup)
-    @conditions, @inferences = @conditions.dup, @inferences.dup
+    @setter_validations, @getter_validations,
+    @conditions, @inferences    = 
+    *__floating_attributes__.map(&:dup)
     r
   end
+  
+  private
+  
+  def inherited(subclass)
+    autonyms = @autonyms.dup
+    attributes = [@conditions, @adjusters, @defaults, @inferences, @aliases, @setter_validations, @getter_validations].map(&:dup)
+    protect_level = @protect_level
+    
+    subclass.class_eval do
+      original_inherited subclass
+      
+      @autonyms = autonyms
+      @conditions, @adjusters, @defaults, @inferences, @aliases, @setter_validations, @getter_validations = *attributes
+      @protect_level = protect_level
+    end
+  end
+     
+  def initialize_copy(original)
+    ret = super original
+    @autonyms, @adjusters, @defaults, @aliases,
+    @setter_validations, @getter_validations,
+    @conditions, @inferences    = 
+    *__floating_attributes__.map(&:dup)
+    ret
+  end
+
+  def __floating_attributes__
+    [@autonyms, @adjusters, @defaults, @aliases,
+     @setter_validations, @getter_validations,
+     @conditions, @inferences]
+  end
 
   # @endgroup
 

data/lib/striuct/instancemethods/README.md

@@ -0,0 +1,5 @@
+For developer
+==============
+
+* This dir's tree is diveded under roles/features.
+  Not under CONSTANT names.

data/lib/striuct/instancemethods/assign.rb

@@ -23,7 +23,7 @@ class Striuct; module InstanceMethods
 
   # all members aren't assigned
   def empty?
-    autonyms.none?{|autonym|assign? autonym}
+    _autonyms.none?{|autonym|assign? autonym}
   end
 
   # @endgroup

data/lib/striuct/instancemethods/cast.rb

@@ -0,0 +1,35 @@
+class Striuct; module InstanceMethods 
+
+  # @group Cast
+
+  # @return [self]
+  def to_striuct
+    self
+  end
+
+  # @return [Struct]
+  def to_struct
+    self.class.to_struct_class.new(*values)
+  end
+  
+  # @return [Hash]
+  def to_h(reject_no_assign=false)
+    return @db.dup if reject_no_assign
+
+    {}.tap {|h|
+      each_pair do |autonym, val|
+        h[autonym] = val
+      end
+    }
+  end
+  
+  # @return [Array]
+  def values
+    each_value.to_a
+  end
+  
+  alias_method :to_a, :values
+
+  # @endgroup
+
+end; end

data/lib/striuct/instancemethods/compare.rb

@@ -4,13 +4,13 @@ class Striuct; module InstanceMethods
   
   # @return [Boolean]
   def ==(other)
-    __compare_all__ other, :==
+    __compare_all__? other, :==
   end
 
   alias_method :===, :==
   
   def eql?(other)
-    __compare_all__ other, :eql?
+    __compare_all__? other, :eql?
   end
 
   # @return [Integer]
@@ -21,9 +21,8 @@ class Striuct; module InstanceMethods
   private  
 
   # @param [Symbol] method
-  def __compare_all__(other, method)
-    instance_of?(other.class) && \
-      each_pair.all?{|k, v|v.__send__ method, other[k]}
+  def __compare_all__?(other, method)
+    other.instance_of?(self.class) && each_pair.all?{|k, v|v.__send__ method, other[k]}
   end
 
   # @endgroup

data/lib/striuct/instancemethods/delegate_class_methods.rb

@@ -1,9 +1,16 @@
+require 'forwardable'
+
 class Striuct; module InstanceMethods
+  
+  extend Forwardable
+  
+  # Forwardable has public/protected class_macro
+  private_class_method(*Forwardable.instance_methods)
 
   # @group Delegate Class Methods
   
-  # @see self.class.*args
-  delegate_class_methods(
+  def_delegators :'self.class',
+    :_autonyms,
     :keyable_for, :autonym_for, :aliases_for,
     :validator_for, :condition_for,
     :adjuster_for, :flavor_for,
@@ -13,8 +20,9 @@ class Striuct; module InstanceMethods
     :restrict?, :has_validator?, :has_condition?,
     :safety_getter?, :safety_reader?, :safety_setter?, :safty_writer?, :inference?,
     :has_default?, :default_for, :has_adjuster?, :has_flavor?
-  )
 
-  # @endgroup
+  private :_autonyms
 
+  # @endgroup
+  
 end; end

data/lib/striuct/instancemethods/hashy.rb

@@ -5,17 +5,6 @@ class Striuct; module InstanceMethods
   # @group Like Ruby's Hash
   
   alias_method :fetch, :[]
-  
-  # @return [Hash]
-  def to_h(reject_no_assign=false)
-    return @db.dup if reject_no_assign
-
-    {}.tap {|h|
-      each_pair do |autonym, val|
-        h[autonym] = val
-      end
-    }
-  end
 
   def has_value?(value)
     @db.has_value? value

data/lib/striuct/instancemethods/keyvalidatable.rb

@@ -0,0 +1,14 @@
+require 'keyvalidatable'
+
+class Striuct; module InstanceMethods
+
+  extend Forwardable
+  include KeyValidatable
+
+  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