striuct 0.3.0 → 0.3.1

data/.gitignore

@@ -0,0 +1,32 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+coverage.data
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# bundler
+vendor/
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+# tmp-old
+.old
+
+# editor
+*~
+.redcar
+
+# other
+*.lock

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - ruby-head
+  - 1.9.3
+  - 1.9.2
+  - rbx-19mode # Rubinius in 1.9 mode

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'yard', '>=0.8.2.1'
+end
+
+group :test do
+  gem 'rake'
+end

data/History.rdoc

@@ -1,3 +1,8 @@
+=== 0.3.1 2012-9-2
+
+* add:
+  * default value via member macro
+
 === 0.3.0 2012-4-3
 
 * modify:

data/Manifest.txt

@@ -1,31 +1,59 @@
+README.md
+README.ja.old.rdoc
+LICENSE
 History.rdoc
 Manifest.txt
-README.rdoc
-README.ja.old.rdoc
 Rakefile
-LICENSE
+Gemfile
+striuct.gemspec
 lib/striuct.rb
 lib/striuct/version.rb
-lib/striuct/abstract.rb
-lib/striuct/containable.rb
-lib/striuct/containable/classutil.rb
-lib/striuct/containable/basic.rb
-lib/striuct/containable/safety.rb
-lib/striuct/containable/handy.rb
-lib/striuct/containable/hashlike.rb
-lib/striuct/containable/inner.rb
-lib/striuct/containable/eigen.rb
-lib/striuct/containable/eigen/basic.rb
-lib/striuct/containable/eigen/constructor.rb
-lib/striuct/containable/eigen/safety.rb
-lib/striuct/containable/eigen/handy.rb
-lib/striuct/containable/eigen/macro.rb
-lib/striuct/containable/eigen/inner.rb
-test/test_helper.rb
+lib/striuct/specificcontainer.rb
+lib/striuct/classmethods.rb
+lib/striuct/classmethods/requirements.rb
+lib/striuct/classmethods/constants.rb
+lib/striuct/classmethods/basic.rb
+lib/striuct/classmethods/constructor.rb
+lib/striuct/classmethods/safety.rb
+lib/striuct/classmethods/handy.rb
+lib/striuct/classmethods/macro.rb
+lib/striuct/classmethods/inner.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/inner.rb
+lib/striuct/singleton_class.rb
+test/helper.rb
 test/test_striuct.rb
-example/example.rb
-example/example1.rb
-example/example2.rb
-example/example.old.rdoc
-example/benchmarks.rb
-example/see_trace.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_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
+examples/README.rb
+examples/example1.rb
+examples/example2.rb
+examples/example.old.rdoc
+examples/see_trace.rb
+benchmarks/basics.rb
+

data/README.md

@@ -0,0 +1,97 @@
+striuct
+=======
+
+[![Build Status](https://secure.travis-ci.org/kachick/striuct.png)](http://travis-ci.org/kachick/striuct)
+
+Description
+-----------
+
+Struct++
+
+Features
+--------
+
+### Strict
+
+* Base API looks like Struct
+* Easy and Flexible Validations
+* Prevent to conflict member names
+
+### Useful
+
+* Hook just before setters
+* Default value
+* Member aliasing
+* Inheritable
+
+### Onepoint
+
+* Pure Ruby :)
+
+Usage
+-----
+
+### Overview
+
+```ruby
+require 'striuct'
+
+class Person < Striuct
+  member :fullname, AND(String, /\A.+\z/)     # Flexible Validation
+  alias_member :name, :fullname               # Use other name
+end
+
+class User < Person                           # Inheritable
+  member :id, Integer,                        # Looks typed validation
+              default_proc: ->{User.next_id}  # With default value
+
+  def self.next_id
+    @id ||= 0
+    @id += 1
+  end
+end
+
+john = User.new 'john'
+john[:name]              #=> 'john' 
+john.name = ''           #=> Exception        # Validate with setter
+john.id                  #=> 1
+ken = User[name: 'ken']                       # Construct from hash
+ken.id                   #=> 2
+```
+
+### More Examples
+
+#### Basics
+
+examples/*
+
+Requirements
+-------------
+
+* Ruby 1.9.2 or later [MRI/YARV, Rubinius](http://travis-ci.org/#!/kachick/striuct)
+* validation - 0.0.3
+* keyvalidatable - 0.0.2
+
+Install
+-------
+
+```shell
+$ gem install striuct
+```
+
+Link
+----
+
+* [code](https://github.com/kachick/striuct)
+* [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  
+Copyright (c) 2011 Kenichi Kamiya  
+See the file LICENSE for further details.
+

data/Rakefile

@@ -1,25 +1,11 @@
-require 'rubygems'
-gem 'hoe', '~> 3.0.1'
-require 'hoe'
-require 'fileutils'
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
 
-Hoe.plugin :newgem
-# Hoe.plugin :website
-# Hoe.plugin :cucumberfeatures
+require 'rake/testtask'
 
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.spec 'striuct' do
-  developer 'Kenichi Kamiya', 'kachick1+ruby@gmail.com'
-  self.rubyforge_name       = self.name
-  require_ruby_version '>= 1.9.2'
-  dependency 'validation', '~> 0.0.3', :runtime
-  dependency 'yard', '~> 0.7.5', :development
-end
+task default: [:test]
 
-require 'newgem/tasks'
-Dir['tasks/**/*.rake'].each { |t| load t }
+Rake::TestTask.new do |tt|
+  tt.verbose = true
+end
 
-# TODO - want other tests/tasks run by default? Add them to the list
-# remove_task :default
-# task :default => [:spec, :features]

data/examples/README.rb

@@ -0,0 +1,25 @@
+$VERBOSE = true
+
+require '../lib/striuct'
+
+class Person < Striuct
+  member :fullname, AND(String, /\A.+\z/)     # Flexible Validation
+  alias_member :name, :fullname               # Use other name
+end
+
+class User < Person                           # Inheritable
+  member :id, Integer,                        # Looks typed validation
+              default_proc: ->{User.next_id}  # With default value
+
+  def self.next_id
+    @id ||= 0
+    @id += 1
+  end
+end
+
+john = User.new 'john'
+p john[:name]      #=> 'john' 
+#~ p john.name = ''  #=> error
+p john.id          #=> 1
+ken = User[name: 'ken']                       # Construct from hash
+p ken.id           #=> 2

data/{example → examples}/example1.rb

@@ -77,7 +77,7 @@ end
 
 # through "inference", and check under first passed object class
 class FlexibleContainer < Striuct.new
-  member :anything, anything, inference: true
+  member :anything, ANYTHING?, inference: true
   member :number,   Numeric, inference: true
 end
 

data/{example → examples}/example2.rb

@@ -2,7 +2,7 @@
 
 $VERBOSE = true
 
-require_relative 'lib/striuct'
+require_relative '../lib/striuct'
 
 User = Striuct.define do  # other way "class User < Striuct.new"
   member :firstname, /\w+/ # look like case syntax in Ruby

data/{example → examples}/see_trace.rb

@@ -15,6 +15,10 @@ rescue
   puts $!.backtrace
 end
 
+puts '-' * 80
+
+$stdout.flush
+
 begin
   user.age = 19
 rescue

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

@@ -1,4 +1,4 @@
-class Striuct; module Containable; module Eigen
+class Striuct; module ClassMethods
   # @group Basic
 
   # @return [Array<Symbol>]
@@ -6,11 +6,17 @@ class Striuct; module Containable; module Eigen
     @names.dup
   end
 
+  alias_method :autonyms, :names
   alias_method :members, :names
   alias_method :keys, :names
+  
+  # @return [Array<Symbol>]
+  def all_members
+    @names + @aliases.keys
+  end
 
   def has_member?(name)
-    originalkey_for(keyable_for name)
+    autonym_for name
   rescue Exception
     false
   else
@@ -36,11 +42,13 @@ class Striuct; module Containable; module Eigen
 
   def dup
     r = super
-    @names, @flavors, @defaults, @aliases, @setter_validations, @getter_validations = 
-    *[@names, @flavors, @defaults, @aliases, @setter_validations, @getter_validations].map(&:dup)
+    @names, @flavors, @defaults, @aliases,
+    @setter_validations, @getter_validations = 
+    *[@names, @flavors, @defaults, @aliases,
+      @setter_validations, @getter_validations].map(&:dup)
     @conditions, @inferences = @conditions.dup, @inferences.dup
     r
   end
 
   # @endgroup
-end; end; end
+end; end

data/lib/striuct/classmethods/constants.rb

@@ -0,0 +1,23 @@
+class Striuct
+
+  module ClassMethods
+
+    NAMING_RISKS = {
+      conflict:      10,
+      no_identifier:  9,
+      bad_manners:    5,
+      no_ascii:       3,
+      strict:         0 
+    }.freeze
+
+    PROTECT_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
+
+  end
+
+end

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

@@ -1,21 +1,24 @@
-class Striuct; module Containable; module Eigen
+require 'keyvalidatable'
+
+class Striuct; module ClassMethods
   # @group Constructor
   
   # @return [Subclass]
-  def load_values(*values)
+  def for_values(*values)
     new_instance(*values)
   end
 
-  alias_method :new, :load_values
+  alias_method :load_values, :for_values
+  alias_method :new, :for_values
 
-  # @param [#each_pair, #keys] pairs ex: Hash, Struct
-  # @return [Subclass]
-  def load_pairs(pairs)
+  # @param [Hash, Struct]
+  # @return [Striuct]
+  def for_pairs(pairs)
     unless pairs.respond_to?(:each_pair) and pairs.respond_to?(:keys)
       raise TypeError, 'no pairs object'
     end
 
-    raise ArgumentError, "different members" unless (pairs.keys - keys).empty?
+    pairs.dup.extend(KeyValidatable).validate_keys let: all_members
 
     new.tap {|instance|
       pairs.each_pair do |name, value|
@@ -24,16 +27,19 @@ class Striuct; module Containable; module Eigen
     }
   end
 
-  alias_method :[], :load_pairs
+  alias_method :load_pairs, :for_pairs
+  alias_method :[], :for_pairs
 
-  # @yieldparam [Subclass] instance
-  # @yieldreturn [Subclass] instance
-  # @return [void]
   # 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={lock: true, strict: true})
-    raise TypeError, 'arguments have to be pairs object' unless options.respond_to? :keys
-    raise ArgumentError, 'Unknown parameters' unless (options.keys - [:lock, :strict]).empty?
     raise ArgumentError, 'must with block' unless block_given?
+    options.extend(KeyValidatable).validate_keys let: [:lock, :strict]
     
     lock, strict = options[:lock], options[:strict]
     
@@ -55,4 +61,4 @@ class Striuct; module Containable; module Eigen
   end
 
   # @endgroup
-end; end; end
+end; end

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

@@ -1,4 +1,4 @@
-class Striuct; module Containable; module Eigen
+class Striuct; module ClassMethods
   # @group Struct+ Handy
 
   # @yield [name] 
@@ -40,29 +40,23 @@ class Striuct; module Containable; module Eigen
 
   # @param [Symbol, String] name
   def original?(name)
-    if member? name
-      @names.include? name
-    else
-      raise NameError
-    end
+    raise NameError unless member? name
+
+    @names.include? name
   end
   
   # @param [Symbol, String] name
   def aliased?(name)
-    if member? name
-      @aliases.has_key? name
-    else
-      raise NameError
-    end
+    raise NameError unless member? name
+
+    @aliases.has_key? name
   end
   
   # @param [Symbol, String] original
   def has_aliases?(original)
-    if original? original
-      @aliases.has_value? original
-    else
-      raise NameError
-    end
+    raise NameError unless original? original
+
+    @aliases.has_value? original
   end
   
   # @param [Symbol, String] original
@@ -76,24 +70,29 @@ class Striuct; module Containable; module Eigen
       raise NameError
     end
   end
+  
+  # @return [Hash] alias => autonym
+  def aliases
+    @aliases.dup
+  end
 
   # @param [Symbol, String] name
   def has_flavor?(name)
-    name = originalkey_for(keyable_for name)
+    name = autonym_for name
 
     ! flavor_for(name).nil?
   end
 
   # @param [Symbol, String] name
   def has_default?(name)
-    name = originalkey_for(keyable_for name)
+    name = autonym_for name
 
     @defaults.has_key? name
   end
   
   # @param [Symbol, String] name
   def default_for(name)
-    name = originalkey_for(keyable_for name)
+    name = autonym_for name
   
     if has_default? name
       _default_for name
@@ -122,4 +121,4 @@ class Striuct; module Containable; module Eigen
   end
 
   # @endgroup
-end; end; end
+end; end

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

@@ -1,4 +1,4 @@
-class Striuct; module Containable; module Eigen
+class Striuct; module ClassMethods
   # @group Use Only Inner
 
   private
@@ -48,7 +48,7 @@ class Striuct; module Containable; module Eigen
   end
 
   # @param [Symbol, String, #to_sym, #to_str] name
-  def originalkey_for(name)
+  def autonym_for(name)
     name = keyable_for name
     
     if _names.include? name
@@ -62,32 +62,10 @@ class Striuct; module Containable; module Eigen
     end
   end
 
-  # @param [Symbol, String, #to_sym, #to_str] name
-  # @return [Symbol] name(keyable)
+  # @param [Symbol, String, #to_sym] name
+  # @return [Symbol]
   def keyable_for(name)
-    return name if name.instance_of? Symbol
-
-    r = (
-      case name
-      when Symbol, String
-        name.to_sym
-      else
-        case
-        when name.respond_to?(:to_sym)
-          name.to_sym
-        when name.respond_to?(:to_str)
-          name.to_str.to_sym
-        else
-          raise TypeError
-        end
-      end
-    )
-
-    if r.instance_of? Symbol
-      r
-    else
-      raise 'must not happen'
-    end
+    name.to_sym
   end
 
   # @param [Symbol] name
@@ -148,8 +126,8 @@ class Striuct; module Containable; module Eigen
     __set_condition__! name, condition unless Validation::Condition::ANYTHING.equal? condition
     __set_flavor__! name, &flavor if block_given?
 
-    define_method "#{name}=" do |value|
-        __set__ name, value
+    define_method :"#{name}=" do |value|
+      __set__ name, value
     end
  
     nil
@@ -198,7 +176,7 @@ class Striuct; module Containable; module Eigen
   
   # @param [Symbol, String] name
   def condition_for(name)
-    _condition_for originalkey_for(keyable_for name)
+    _condition_for autonym_for(name)
   end
   
   def _flavor_for(name)
@@ -207,7 +185,7 @@ class Striuct; module Containable; module Eigen
 
   # @param [Symbol, String] name
   def flavor_for(name)
-    _flavor_for originalkey_for(keyable_for name)
+    _flavor_for autonym_for(name)
   end
   
   def _default_for(name)
@@ -215,4 +193,4 @@ class Striuct; module Containable; module Eigen
   end
 
   # @endgroup
-end; end; end
+end; end