striuct 0.1.7 → 0.2.3

data/History.rdoc

@@ -1,10 +1,52 @@
+=== 0.2.3 2012-4-2
+
+* fix:
+  * Conditions.#NAND
+  * Conditions.#XOR
+  * Conditions.#XNOR
+
+=== 0.2.2 2012-3-30
+
+* add:
+  * aliases Conditions#[FUNC()] -> Conditions#[FUNC?()]
+
+* fix:
+  * GENERICS check when build condition
+  * arity checker when default with block parameter
+
+=== 0.2.1 2012-1-30
+
+* delete:
+  * Conditions#ANY, ALL
+
+* add:
+  * can choose timing of validation (member with option and safety_setter? and more)
+  * add Flavors (Useful flavor builders)
+  * .#to_struct_class, #to_struct
+  * #each_name_with_index (alias-> #each_member_with_index, #each_key_with_index)
+
+=== 0.2.0 2012-1-27
+
+* delete:
+  * constant StrictStruct
+  * Eigen.#sufficient? (alias -> valid?, accept?)
+
+* modify:
+  * conditions to a condition (use condition generator Conditions#OR)
+  * to expr a flavor, before check condition
+  * inference flag under option parameter
+  * long macro names (define_xxx -> add_xxx)
+
+* add:
+  * #each_pair_with_index
+
 === 0.1.7 2012-1-26
 
 * add:
   * default with Proc
   * detail error message in Subclass.#[]=
 
-* fix
+* fix:
   * class duplicating
 
 === 0.1.6 2012-1-25

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+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
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -1,30 +1,34 @@
 History.rdoc
 Manifest.txt
 README.rdoc
-README.ja.rdoc
+README.ja.old.rdoc
 Rakefile
+LICENSE
 lib/striuct.rb
-lib/striuct/frame.rb
 lib/striuct/version.rb
 lib/striuct/abstract.rb
 lib/striuct/conditions.rb
-lib/striuct/subclassable/frame.rb
-lib/striuct/subclassable/classutil.rb
-lib/striuct/subclassable/basic.rb
-lib/striuct/subclassable/safety.rb
-lib/striuct/subclassable/handy.rb
-lib/striuct/subclassable/hashlike.rb
-lib/striuct/subclassable/yaml.rb
-lib/striuct/subclassable/inner.rb
-lib/striuct/subclassable/eigen/frame.rb
-lib/striuct/subclassable/eigen/basic.rb
-lib/striuct/subclassable/eigen/constructor.rb
-lib/striuct/subclassable/eigen/safety.rb
-lib/striuct/subclassable/eigen/handy.rb
-lib/striuct/subclassable/eigen/macro.rb
-lib/striuct/subclassable/eigen/inner.rb
+lib/striuct/flavors.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/yaml.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
 test/test_striuct.rb
 example/example.rb
+example/example1.rb
+example/example2.rb
+example/example.old.rdoc
 example/benchmarks.rb
 example/see_trace.rb

data/{README.ja.rdoc → README.ja.old.rdoc}

@@ -6,7 +6,7 @@
 
 == DESCRIPTION
 
-Struct以上の手軽さで扱える、Structより堅いコンテナを目指しています。
+Structっぽい手触りで扱える、多機能なStructを目指しています。
 
 メンバ名にチェックがかかる＆一つの新しいクラスとして扱えるStructは、場面によってはHashよりも好ましい事があるかと思います。
 でもそうやってStructを使うぐらいなわけだから、値の方にもある程度のチェックをかけたいと思う事が多くありませんか？
@@ -33,7 +33,7 @@ RubyのStructを愛しつつも、こういった部分をなんとかしたい
 * 構造体としてのメンバ追加時、Rubyの既存メソッドと干渉しないかを指定レベル別にチェック出来ます。
 * 違和感のない継承利用
 * なるべくStructの心地よい操作感を残したまま機能追加をしています。
-* 既存クラスやメソッドの上書き等を（勝手には）しない、控えめな名前空間
+* 既存クラスやメソッドの上書き等をしない、控えめな名前空間
 * Pure Ruby
 
 == SYNOPSIS
@@ -41,9 +41,8 @@ RubyのStructを愛しつつも、こういった部分をなんとかしたい
 * setup
     require 'striuct'
 
-* 2つの名前空間をお借りしますが、どっちも同じクラスを指します
+* この名前空間以外は汚しません。
     Striuct
-    StrictStruct
 
 === Struct+ "Safety"
 
@@ -98,11 +97,11 @@ RubyのStructを愛しつつも、こういった部分をなんとかしたい
       db.monsters = [monster]
     end
 
-* 構造体クラスのコンテキスト内だけで使える "inference" というメソッドの返り値を渡すと、
-  最初に参照したオブジェクトのクラスが、以降全インスタンスでの参照条件となります。
+* オプションパラメータにinferenceというキーワードをtrueで渡すと、
+  最初に参照したオブジェクトのクラスが以降全インスタンスでの参照条件となります。
     class FlexibleContainer < Striuct.new
-      member :anything, inference
-      member :number, Numeric, inference
+      member :anything, anything, inference: true
+      member :number, Numeric, inference: true
     end
 
     fc1, fc2 = FlexibleContainer.new, FlexibleContainer.new
@@ -171,15 +170,11 @@ RubyのStructを愛しつつも、こういった部分をなんとかしたい
 
 * memberマクロへブロックを渡しておくと、チェック後一処理加えた値を参照可能です。
     class User2 < Striuct.new
-      # 数字っぽければIntegerへ変換してから
-      member :age, /\A\d+\z/, Numeric do |v|
-        Integer v
-      end
+      # 必ずInteger経由でキャスト
+      member :age, Fixnum, &->v{Integer v}
       
       # Symbolに変換した上で代入。
-      member :name, ->v{v.respond_to? :to_s} do |v|
-        v.to_s.to_sym
-      end
+      member :name, Symbol, &->v{v.to_s.to_sym}
     end
     
     user2 = User2.new
@@ -193,6 +188,7 @@ RubyのStructを愛しつつも、こういった部分をなんとかしたい
 ==== Default
 
 * defaultマクロを用いることで、メンバ毎に標準値を定義することが出来ます。
+  ブロックを渡すと、初期化時にブロックの中身を評価して設定します。（Hash.newっぽく）
     class User3 < Striuct.new
       member  :lank, Fixnum
       default :lank, 3
@@ -265,7 +261,6 @@ RubyのStructを愛しつつも、こういった部分をなんとかしたい
 == Note
 
 * 現状、このReadme含めてドキュメントは殆ど更新出来ていません。
-  0.2.0 までにはなんとかしたい
 
 == REQUIREMENTS
 

data/README.rdoc

@@ -1,277 +1,63 @@
 = Striuct
 
 * http://github.com/kachick/striuct
-* https://rubygems.org/gems/striuct
+* http://rubygems.org/gems/striuct
 * http://rubyforge.org/projects/striuct
 
-== DESCRIPTION
+== Description
 
-Striuct = (YetAnotherStruct << safety << useful)
+Struct++
 
-== FEATURES
-* When you link a object, Striuct checks "They are valid objects?".
-  These checkers don't depend only types(class).
-  
-  The safety is made from your expressions.
-* When use "inference", member will be fixed under class of first passed object.
-* It is without undesirable naming of conflict, no-identifier and some cases.
-* You can add a step just before link a object. (named "flavor" at here)
-* You can use default-value, and we have different meanings between nil and default-value.
-* It is easy to alias member name.
-* You can use inherite of structual class. 
-* Base API looks like Struct.
-* No taint your name-space.
-* Pure Ruby
+== Features
+
+* Base APIs look like Struct.
+* Easy and Flexible Validations
+* Hook just before running setters
+* Default value
+* Member aliasing
+* Inheritable
+* Pure Ruby :)
 
-== SYNOPSIS
+== Usage
 
 * setup
     require 'striuct'
 
-* use two namespace (same meanings)
-    Striuct
-    StrictStruct
-
-=== Struct+ "Safety"
-
-==== "member" macro
-
-* Use "member" and you get a accessor, it looks Struct with tester(validator)s. 
-    class User < Striuct.new
-      member :id,   Integer
-      member :age,  (20..140)
-      member :name, OR(/\A\w+\z/, /\A\w+ \w+\z/)
-    end
-
-    # pass
-    user = User.new 128381, 20
+=== Example
 
-    # pass
-    user.age = 30
-    user[2] = 'foo bar'
-
-    # fail
-    user[:id] = 10.0
-    user.age = 19
-    user[2] = nil
-
-* Use functional object and you get a tester on upstairs.
-    module Game
-      class Character
-      end
-
-      class DB < Striuct.new
-        member :monsters,   ->list{(list - characters).empty?}
-        member :characters, GENERICS(Character)
-      end
-      
-      monster = Character.new
-      db = DB.new
-      
-      # fail
-      db.characters = [1, 2]
-      
-      # pass
-      db.characters = [monster, Character.new]
-      
-      # fail
-      db.monsters = [Character.new]
-      
-      # pass
-      db.monsters = [monster]
+    Person = Striuct.define do
+      member :name, AND(String, /\A\w+( \w+)?\z/)
     end
-
-* Use "inference" and all instance test under class of first passed object.
-    class FlexibleContainer < Striuct.new
-      member :anything, inference
-      member :number, Numeric, inference
-    end
-
-    fc1, fc2 = FlexibleContainer.new, FlexibleContainer.new
-    # pass
-    fc1.anything = 'str'
- 
-    # fail
-    fc1.anything = :sym
-    fc2.anything = :sym
-    
-    # pass
-    fc2.anything = 'string too'
     
-    # fail
-    fc1.number = 'str'
-    
-    # pass
-    fc1.number = 1.0
-
-    # fail
-    fc2.number = 1
-
-==== Protect from risks in naming members
-
-* Standard Struct dosen't check member-name. 
-    NoGuard = Struct.new :object_id, :'?  !'
-    noguard = NoGuard.new false
-    noguard.object_id #=> false
-    noguard.methods.include?(:'?  !') #=> false(lost!!)
-
-* Striuct provides safety levels for this. (default: :prevent)
-    class SafetyNaming < Striuct.new
-      begin
-        member :object_id
-      rescue
-        p $!
-      end
-      
-      begin
-        member :'?  !'
-      rescue
-        p $!
-      end
-      
-      # set lower
-      protect_level :struct
-      
-      member :object_id, :'?  !'
-    end
-
-==== Support utils
-
-* valid? / acccept? / sufficient?   # can set a argument to a member 
-* conditionable?           # can set a condition for any members
-* inference?               # inference member and no passed any object
-* restrict?                # has any conditions for a member
-* strict?                  # now, all members are passed any conditions
-* secure?                  # instance and class are fixed and strict 
-* cname?                   # can use member name under protect level
-
-=== Struct+ "Handy"
-
-==== Flavor
-
-* Block with member macro, it is called "flavor" at here.
-  Below cases for type cast.
-    class User2 < Striuct.new
-      member :age, /\A\d+\z/, Numeric do |arg|
-        Integer arg
-      end
-      
-      member :name, ->v{v.respond_to? :to_s} do |v|
-        v.to_s.to_sym
-      end
+    class User < Person
+      member :id, AND(Integer, 1..99999)
     end
     
-    user2 = User2.new
-    user2.age = 9 #=> 9(Fixnum)
-    user2.age = 10.1 #=> 10(Fixnum)
-    user2.age = '10' #=> 10(Fixnum)
+    user = User.new
+    user.members      #=> [:name, :id]
+    user.name = :Ken  #=> error
+    user.name = ''    #=> error
+    user.name = 'Ken' #=> pass
 
-    user2.name = 10 #=> :10(Symbol)
-    user2.name = Class #=> :Class(Symbol)
+=== More Example
 
-==== Default
+example/*
 
-* provides default value
-    class User3 < Striuct.new
-      member  :lank, Fixnum
-      default :lank, 3
-      member  :name
-    end
-    
-    user3 = User3.new
-    user3.lank #=> 3
-    
-* Standard Struct always define "nil is default". Realy?
-    user3.name  #=> nil
-    user3.assign? :name #=> false
-    user3.name = nil
-    user3.assign? :name #=> true
-
-==== Alias
-
-* alias member name
-    class User3
-      alias_member :position, :lank
-    end
-    
-    user3.lank.equal? user3.position #=> true
-    user3[:lank].equal? user3[:position] #=> true
-    user3[:position] = 4
-    user3.lank  #=> 4
-
-==== Inherit
-
-* (writing...)
-
-==== Lock
-
-* (writing...)
-
-==== New Constructors
-
-* Subclass.define reject floating object.
-  * block parameter is new instance
-  * except if no finished to assign each member
-  * returning object is tested strict(optional)
-  * returning object is locked(optional)
-      user3 = User3.define do |r|
-        r.lank = 10
-        r.name = 'foo'
-      end
-
-* Subclass.[](load_pairs) make from Hash and like Hash
-    user3 = User3[lank: 10, name: 'foo']
-
-=== Almost interfaces are keeping Struct has.
+== Requirements
 
-    Sth1 = Striuct.new do
-      def my_special_method
-      end
-    end
-    
-    Sth1.new.respond_to?(:my_special_method) #=> true
-
-=== HashLike
-
-* some interfaces import from Hash
-
-* easy cast to Hash
-    user3.to_h #=> {:lank=>3, :name=>nil}
-
-
-== Note
-
-* Documents are poor
-
-== REQUIREMENTS
-
-* Ruby 1.9.2 and later (tested 1.9.2, 1.9.3)
-
-== INSTALL
-
-* sudo gem install striuct
+* Ruby 1.9.2 or later
+  
+  tested release versions
 
-== LICENSE
+  * 1.9.3-p125
+  * 1.9.2-p290
 
-(The MIT License)
+== Installation
 
-Copyright (c) 2011  Kenichi Kamiya
+* gem install striuct
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+== License
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+Copyright (C) 2011  Kenichi Kamiya
 
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The MIT License (See the file LICENSE.)

data/Rakefile

@@ -1,5 +1,5 @@
 require 'rubygems'
-gem 'hoe', '~> 2.13.0'
+gem 'hoe', '~> 3.0.1'
 require 'hoe'
 require 'fileutils'
 
@@ -13,7 +13,7 @@ $hoe = Hoe.spec 'striuct' do
   developer 'Kenichi Kamiya', 'kachick1+ruby@gmail.com'
   self.rubyforge_name       = self.name
   require_ruby_version '>= 1.9.2'
-  dependency 'yard', '~> 0.7.4', :development
+  dependency 'yard', '~> 0.7.5', :development
 end
 
 require 'newgem/tasks'