striuct 0.3.0 → 0.3.1

data/lib/striuct/{containable/eigen → classmethods}/macro.rb

@@ -1,4 +1,6 @@
-class Striuct; module Containable; module Eigen
+require 'keyvalidatable'
+
+class Striuct; module ClassMethods
   # @group Macro for Definition
 
   private
@@ -14,6 +16,8 @@ class Striuct; module Containable; module Eigen
   end
 
   VALID_MEMBER_OPTIONS = [
+    :default,
+    :default_proc,
     :inference,
     :reader_validation,
     :getter_validation,
@@ -28,11 +32,22 @@ class Striuct; module Containable; module Eigen
   # @param [Symbol, String] name
   # @param [#===, Proc, Method, ANYTHING] condition
   # @param [Hash] options
+  # @option options [BasicObject] :default
+  # @option options [Proc] :default_proc
+  # @option options [Boolean] :inference
+  # @option options [Boolean] :reader_validation
+  # @option options [Boolean] :getter_validation
+  # @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)
     raise "already closed to add member in #{self}" if closed?
-    options = DEFAULT_MEMBER_OPTIONS.merge options
-    raise ArgumentError, 'invalid option parameter is' unless (options.keys - VALID_MEMBER_OPTIONS).empty?
+    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
+    
     name = keyable_for name
     raise ArgumentError, %Q!already exist name "#{name}"! if member? name
     _check_safety_naming name
@@ -43,6 +58,15 @@ class Striuct; module Containable; module Eigen
     @names << name
     __getter__! name
     __setter__! name, condition, &flavor
+    
+    if options.has_key?(:default)
+      set_default_value name, options.fetch(:default)
+    end
+    
+    if options.has_key?(:default_proc)
+      set_default_value name, &options.fetch(:default_proc)
+    end
+    
     nil
   end
 
@@ -79,16 +103,18 @@ class Striuct; module Containable; module Eigen
   # @return [nil]
   def set_default_value(name, value=nil, &block)
     raise "already closed to modify member attributes in #{self}" if closed?
-    name = originalkey_for(keyable_for name)
+    name = autonym_for(name)
     raise "already settled default value for #{name}" if has_default? name
 
     value = (
       if block_given?
         if value.nil?
-          if (arity = block.arity) <= 2
+          arity = block.arity
+          
+          if valid_default_proc? block
             SpecificContainer.new block
           else
-            raise ArgumentError, "wrong number of block parameter #{arity} for 2"
+            raise ArgumentError, "wrong number of block parameter #{arity} for 0..2"
           end
         else
           raise ArgumentError, 'can not use value and block arguments'
@@ -104,6 +130,10 @@ class Striuct; module Containable; module Eigen
   
   alias_method :default, :set_default_value
   
+  def valid_default_proc?(_proc)
+    _proc.arity <= 2
+  end
+  
   # @return [self]
   def close_member
     [@names, @flavors, @defaults, @aliases].each(&:freeze)
@@ -114,4 +144,4 @@ class Striuct; module Containable; module Eigen
   alias_method :close, :close_member
   
   # @endgroup
-end; end; end
+end; end

data/lib/striuct/classmethods/requiremnets.rb

@@ -0,0 +1,7 @@
+require_relative 'constants'
+require_relative 'inner'
+require_relative 'basic'
+require_relative 'constructor'
+require_relative 'handy'
+require_relative 'macro'
+require_relative 'safety'

data/lib/striuct/{containable/eigen → classmethods}/safety.rb

@@ -1,17 +1,17 @@
-class Striuct; module Containable; module Eigen
+class Striuct; module ClassMethods
   # @group Struct+ Safety
   
   # @param [Symbol, String] name
   # inference checker is waiting yet
   def inference?(name)
-    name = originalkey_for(keyable_for name)
+    name = autonym_for name
 
     @inferences.has_key? name
   end
 
   # @param [Symbol, String] name
   def has_condition?(name)
-    name = originalkey_for(keyable_for name)
+    name = autonym_for name
 
     @conditions.has_key?(name)
   end
@@ -20,7 +20,7 @@ class Striuct; module Containable; module Eigen
 
   # @param [Symbol, String] name
   def safety_getter?(name)
-    name = originalkey_for(keyable_for name)
+    name = autonym_for name
 
     @getter_validations.has_key?(name)
   end
@@ -29,7 +29,7 @@ class Striuct; module Containable; module Eigen
   
   # @param [Symbol, String] name
   def safety_setter?(name)
-    name = originalkey_for(keyable_for name)
+    name = autonym_for name
 
     @setter_validations.has_key?(name)
   end
@@ -49,4 +49,4 @@ class Striuct; module Containable; module Eigen
   end
 
   # @endgroup
-end; end; end
+end; end

data/lib/striuct/classmethods.rb

@@ -0,0 +1 @@
+require_relative 'classmethods/requiremnets'

data/lib/striuct/{containable → instancemethods}/basic.rb

@@ -1,4 +1,4 @@
-class Striuct; module Containable
+class Striuct; module InstanceMethods
   # @group Basic
   
   def initialize(*values)
@@ -8,7 +8,7 @@ class Striuct; module Containable
 
   # see self.class.*args
   delegate_class_methods(
-    :members, :keys, :names,
+    :members, :keys, :names, :autonyms, :all_members, :aliases,
     :has_member?, :member?, :has_key?, :key?,
     :length, :size
   )
@@ -64,10 +64,10 @@ class Striuct; module Containable
     true_name = nil
     __subscript__(key){|name|true_name = name; __set__ name, value}
   rescue Validation::InvalidWritingError
-    $@ = [
-      "#{$@[-1].sub(/[^:]+\z/){''}}in `[#{key.inspect}(#{true_name})]=': #{$!.message}",
-      $@[-1]
-    ]
+    $!.set_backtrace([
+      "#{$!.backtrace[-1].sub(/[^:]+\z/){''}}in `[#{key.inspect}(#{true_name})]=': #{$!.message}",
+      $!.backtrace[-1]
+    ])
 
     raise
   end

data/lib/striuct/{containable → instancemethods}/handy.rb

@@ -1,4 +1,4 @@
-class Striuct; module Containable 
+class Striuct; module InstanceMethods 
   # @group Struct + Handy
   
   # see self.class.*args
@@ -57,7 +57,7 @@ class Striuct; module Containable
   
   # @param [Symbol, String] name
   def assign?(name)
-    name = originalkey_for(keyable_for name)
+    name = autonym_for name
     
     @db.has_key? name
   end
@@ -72,7 +72,7 @@ class Striuct; module Containable
 
   # @param [Symbol, String] name
   def default?(name)
-    name = originalkey_for(keyable_for name)
+    name = autonym_for name
 
     default_for(name) == self[name]
   end

data/lib/striuct/{containable → instancemethods}/hashlike.rb

@@ -1,4 +1,4 @@
-class Striuct; module Containable
+class Striuct; module InstanceMethods
   # @group HashLike
   
   # @return [Hash]
@@ -31,8 +31,9 @@ class Striuct; module Containable
 
   alias_method :value?, :has_value?
 
-  # @yield [name, value]
   # keep truthy only (unassign falsy member)
+  # @yield [name, value]
+  # @yieldparam [Symbol] name
   # @see #each_pair
   # @return [Enumerator]
   # @yieldreturn [self]
@@ -54,6 +55,7 @@ class Striuct; module Containable
 
   # @see #select!
   # @yield [name, value]
+  # @yieldparam [Symbol] name
   # @return [Enumerator]
   def keep_if(&block)
     raise "can't modify frozen #{self.class}" if frozen?
@@ -65,6 +67,7 @@ class Striuct; module Containable
   # @see #select!
   # keep falsy only (unassign truthy member)
   # @yield [name, value]
+  # @yieldparam [Symbol] name
   # @return [Enumerator]
   def reject!
     raise "can't modify frozen #{self.class}" if frozen?
@@ -83,6 +86,7 @@ class Striuct; module Containable
 
   # @see #reject!
   # @yield [name, value]
+  # @yieldparam [Symbol] name
   # @return [Enumerator]
   def delete_if(&block)
     raise "can't modify frozen #{self.class}" if frozen?
@@ -93,9 +97,9 @@ class Striuct; module Containable
   end
 
   # @param [Symbol, String] name
-  # @return [Array] [name, value]
+  # @return [Array] e.g [name, value]
   def assoc(name)
-    name = originalkey_for(keyable_for name)
+    name = autonym_for name
 
     [name, self[name]]
   end
@@ -113,7 +117,8 @@ class Striuct; module Containable
 
   # @see #select!
   # @yield [name, value]
-  # @return [Subclass]
+  # @yieldparam [Symbol] name
+  # @return [Striuct]
   def select(&block)
     return to_enum(__method__) unless block_given?
 
@@ -122,7 +127,8 @@ class Striuct; module Containable
 
   # @see #reject!
   # @yield [name, value]
-  # @return [Subclass]
+  # @yieldparam [Symbol] name
+  # @return [Striuct]
   def reject(&block)
     return to_enum(__method__) unless block_given?
 

data/lib/striuct/{containable → instancemethods}/inner.rb

@@ -1,11 +1,12 @@
-class Striuct; module Containable
+class Striuct; module InstanceMethods
+
   private
   
   # @group Use Only Inner
   
   # see self.class.*args
   delegate_class_methods(
-    :keyable_for, :flavor_for, :condition_for, :originalkey_for
+    :keyable_for, :flavor_for, :condition_for, :autonym_for
   )
   
   def initialize_copy(original)
@@ -13,7 +14,7 @@ class Striuct; module Containable
   end
 
   def __get__(name)
-    name = originalkey_for(keyable_for name)
+    name = autonym_for name
     value = @db[name]
   
     if safety_getter?(name) and !accept?(name, value)
@@ -26,7 +27,7 @@ class Striuct; module Containable
 
   def __set__(name, value)
     raise "can't modify frozen #{self.class}" if frozen?
-    name = originalkey_for(keyable_for name)
+    name = autonym_for name
     raise "can't modify locked member #{name}" if lock? name
 
     if has_flavor? name
@@ -49,9 +50,8 @@ class Striuct; module Containable
     @db[name] = value
   rescue ::Validation::InvalidError
     unless /in \[\]=/ =~ caller[1].slice(/([^:]+)\z/)
-      $@.delete_if{|s|/#{Regexp.escape(File.dirname __FILE__)}/ =~ s}
-      $@.first.sub!(/([^:]+)\z/){"in `#{name}='"}
-      $@ << $@.last
+      $!.backtrace.delete_if{|s|/#{Regexp.escape(File.dirname __FILE__)}/ =~ s}
+      $!.backtrace.first.sub!(/([^:]+)\z/){"in `#{name}='"}
     end
   
     raise
@@ -62,7 +62,7 @@ class Striuct; module Containable
     when Symbol, String
       name = keyable_for key
       if member? name
-        yield originalkey_for(name)
+        yield autonym_for(name)
       else
         raise NameError
       end
@@ -117,4 +117,5 @@ class Striuct; module Containable
   end
   
   # @endgroup
+
 end; end

data/lib/striuct/instancemethods/requirements.rb

@@ -0,0 +1,6 @@
+require_relative 'singleton_class'
+require_relative 'inner'
+require_relative 'basic'
+require_relative 'handy'
+require_relative 'hashlike'
+require_relative 'safety'

data/lib/striuct/{containable → instancemethods}/safety.rb

@@ -1,4 +1,4 @@
-class Striuct; module Containable
+class Striuct; module InstanceMethods
   # @group Struct+ Safety
   
   # see self.class.*args
@@ -9,7 +9,7 @@ class Striuct; module Containable
   # @param [Object] value - no argument and use own
   # passed under any condition
   def sufficient?(name, value=self[name])
-    name = originalkey_for(keyable_for name)
+    name = autonym_for name
     return true unless restrict? name
     
     _valid? condition_for(name), value

data/lib/striuct/instancemethods/singleton_class.rb

@@ -0,0 +1,19 @@
+class Striuct; module InstanceMethods
+
+  class << self
+    
+    private
+    
+    def delegate_class_method(name)
+      define_method name do |*args, &block|
+        self.class.__send__ name, *args, &block
+      end
+    end
+    
+    def delegate_class_methods(name, *names)
+      [name, *names].each{|_name|delegate_class_method _name}
+    end
+    
+  end
+
+end; end

data/lib/striuct/instancemethods.rb

@@ -0,0 +1 @@
+require_relative 'instancemethods/requirements'

data/lib/striuct/requirements.rb

@@ -0,0 +1,6 @@
+require_relative 'version'
+require_relative 'structs'
+require_relative 'specificcontainer'
+require_relative 'classmethods'
+require_relative 'instancemethods'
+require_relative 'singleton_class'

data/lib/striuct/singleton_class.rb

@@ -0,0 +1,93 @@
+require_relative 'instancemethods'
+
+class Striuct
+
+  class << self
+
+    # @group Constructor
+    
+    alias_method :new_instance, :new
+    private :new_instance
+    
+    # @param [Symbol, String] *names
+    # @return [Class]
+    def new(*names, &block)
+      # warning for Ruby's Struct.new user
+      first = names.first
+      if first.instance_of?(String) and /\A[A-Z]/ =~ first
+        warn "no define constant #{first}"
+      end
+
+      Class.new self do
+        names.each do |name|
+          member name
+        end
+
+        class_eval(&block) if block_given?
+      end
+    end
+
+    # @yieldreturn [Class] (see Striuct.new) - reject floating class
+    # @return [void]
+    def define(&block)
+      raise ArgumentError, 'must with block' unless block_given?
+
+      new(&block).tap do |subclass|
+        subclass.instance_eval do
+          raise 'not yet finished' if members.empty?
+          close
+        end
+      end
+    end
+
+    # @groupend
+
+    private
+    
+    alias_method :original_inherited, :inherited
+    
+    def inherited(subclass)
+      attributes = (
+        if equal? ::Striuct
+          [[], {}, {}, {}, {}, {}, {}, {}, :prevent]
+        else
+          [
+           *[
+             @names, @conditions, @flavors, @defaults,
+             @inferences, @aliases, @setter_validations,
+             @getter_validations
+            ].map(&:dup), @protect_level
+          ]
+        end
+      )
+      
+      eigen = self
+
+      subclass.class_eval do
+        original_inherited subclass
+
+        if ::Striuct.equal? eigen
+          extend ClassMethods
+          include Enumerable
+          include InstanceMethods
+        end
+        
+        @names, @conditions, @flavors, @defaults,
+        @inferences, @aliases, @setter_validations,
+        @getter_validations, @protect_level = *attributes
+        
+        singleton_class.instance_eval do
+          define_method :initialize_copy do |original|
+            @names, @flavors, @defaults, @aliases,
+            @setter_validations, @getter_validations = 
+            *[@names, @flavors, @defaults, @aliases,
+              @setter_validations, @getter_validations].map(&:dup)
+            @conditions, @inferences = @conditions.dup, @inferences.dup
+          end
+        end
+      end
+    end
+
+  end
+
+end

data/lib/striuct/specificcontainer.rb

@@ -0,0 +1,17 @@
+class Striuct
+
+  class SpecificContainer
+
+    attr_reader :value
+
+    def initialize(value)
+      @value = value
+    end
+
+  end
+  
+  if respond_to? :private_constant
+    private_constant :SpecificContainer
+  end
+
+end

data/lib/striuct/structs.rb

@@ -0,0 +1,7 @@
+class Striuct
+
+  # namespace for .to_struct_class, #to_struct
+  module Structs
+  end
+
+end

data/lib/striuct/version.rb

@@ -1,4 +1,5 @@
 class Striuct
-  VERSION = '0.3.0'.freeze
-  Version = VERSION
+
+  VERSION = '0.3.1'.freeze
+
 end

data/lib/striuct.rb

@@ -1,18 +1,13 @@
-# Copyright (C) 2011  Kenichi Kamiya
-# Striuct
-#   Provides a Struct++ class.
+# striuct - Provides a Struct++ class.
+# Copyright (c) 2011 Kenichi Kamiya
 
 require 'validation'
 
-# @author Kenichi Kamiya
 # @abstract
 class Striuct
+
   include Validation
 
-  # namespace for .to_struct_class, #to_struct
-  module Structs
-  end
 end
 
-require_relative 'striuct/version'
-require_relative 'striuct/abstract'
+require_relative 'striuct/requirements'

data/striuct.gemspec

@@ -0,0 +1,24 @@
+# I don't know why dose occur errors below.
+#  require_relative 'lib/striuct/version'
+require File.expand_path('../lib/striuct/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Kenichi Kamiya']
+  gem.email         = ['kachick1+ruby@gmail.com']
+  gem.summary       = %q{Struct++}
+  gem.description   = %q{validatable, inheritable, And more Struct++ features :)}
+  gem.homepage      = 'https://github.com/kachick/striuct'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'striuct'
+  gem.require_paths = ['lib']
+  gem.version       = Striuct::VERSION.dup # dup for https://github.com/rubygems/rubygems/commit/48f1d869510dcd325d6566df7d0147a086905380#-P0
+
+  gem.required_ruby_version = '>=1.9.2'
+  gem.add_runtime_dependency 'validation', '~>0.0.3.1'
+  gem.add_runtime_dependency 'keyvalidatable', '~>0.0.2'
+  gem.add_development_dependency 'yard', '>=0.8.2.1'
+end
+

data/test/{test_helper.rb → helper.rb}

@@ -1,2 +1,5 @@
 require 'test/unit'
+
+$VERBOSE = true
+
 require_relative '../lib/striuct'