striuct 0.6.1 → 0.9.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (89) hide show
  1. checksums.yaml +4 -4
  2. data/MIT-LICENSE.txt +21 -0
  3. data/README.md +44 -60
  4. data/lib/striuct/{requirements.rb → bootstrap.rb} +6 -2
  5. data/lib/striuct/classmethods/README.md +2 -2
  6. data/lib/striuct/classmethods/adjustment.rb +77 -13
  7. data/lib/striuct/classmethods/attributes.rb +94 -92
  8. data/lib/striuct/classmethods/conflict_management.rb +109 -106
  9. data/lib/striuct/classmethods/constructor.rb +55 -65
  10. data/lib/striuct/classmethods/copy.rb +45 -43
  11. data/lib/striuct/classmethods/default.rb +23 -21
  12. data/lib/striuct/classmethods/enum.rb +46 -44
  13. data/lib/striuct/classmethods/fix.rb +23 -21
  14. data/lib/striuct/classmethods/hashdeepdupulicatable.rb +15 -15
  15. data/lib/striuct/classmethods/inner.rb +57 -55
  16. data/lib/striuct/classmethods/length.rb +12 -10
  17. data/lib/striuct/classmethods/macro.rb +99 -106
  18. data/lib/striuct/classmethods/names.rb +69 -65
  19. data/lib/striuct/classmethods/predicate.rb +131 -129
  20. data/lib/striuct/classmethods/requirements.rb +2 -2
  21. data/lib/striuct/classmethods/to_struct.rb +21 -18
  22. data/lib/striuct/classmethods/validation.rb +15 -13
  23. data/lib/striuct/instancemethods/README.md +2 -2
  24. data/lib/striuct/instancemethods/assign.rb +29 -27
  25. data/lib/striuct/instancemethods/cast.rb +28 -26
  26. data/lib/striuct/instancemethods/compare.rb +26 -24
  27. data/lib/striuct/instancemethods/default.rb +31 -29
  28. data/lib/striuct/instancemethods/delegate_class_methods.rb +35 -33
  29. data/lib/striuct/instancemethods/enum.rb +86 -84
  30. data/lib/striuct/instancemethods/getter.rb +39 -37
  31. data/lib/striuct/instancemethods/hashy.rb +99 -97
  32. data/lib/striuct/instancemethods/lock.rb +46 -44
  33. data/lib/striuct/instancemethods/object.rb +50 -48
  34. data/lib/striuct/instancemethods/requirements.rb +9 -13
  35. data/lib/striuct/instancemethods/safety.rb +11 -9
  36. data/lib/striuct/instancemethods/setter.rb +46 -45
  37. data/lib/striuct/instancemethods/to_s.rb +39 -37
  38. data/lib/striuct/instancemethods/validation.rb +46 -29
  39. data/lib/striuct/instancemethods/values.rb +50 -48
  40. data/lib/striuct/singleton_class.rb +25 -18
  41. data/lib/striuct/structs.rb +3 -3
  42. data/lib/striuct.rb +7 -3
  43. metadata +18 -209
  44. data/.gitignore +0 -35
  45. data/.travis.yml +0 -17
  46. data/.yardopts +0 -1
  47. data/Gemfile +0 -11
  48. data/MIT-LICENSE +0 -22
  49. data/Rakefile +0 -11
  50. data/benchmark/basics.rb +0 -56
  51. data/example/README.rb +0 -50
  52. data/example/example1.rb +0 -195
  53. data/example/example2.rb +0 -20
  54. data/example/see_trace.rb +0 -32
  55. data/lib/striuct/instancemethods/keyvalidatable.rb +0 -9
  56. data/striuct.gemspec +0 -45
  57. data/test/helper.rb +0 -3
  58. data/test/test_sglc-constructor.rb +0 -36
  59. data/test/test_subc-c-add_members.rb +0 -13
  60. data/test/test_subc-c-close_member.rb +0 -36
  61. data/test/test_subc-c-constructor.rb +0 -92
  62. data/test/test_subc-c-copy.rb +0 -71
  63. data/test/test_subc-c-freeze.rb +0 -36
  64. data/test/test_subc-c-inheritable.rb +0 -58
  65. data/test/test_subc-c-safety_naming.rb +0 -73
  66. data/test/test_subc-f-alias_member.rb +0 -54
  67. data/test/test_subc-f-enum.rb +0 -159
  68. data/test/test_subc-f-predicate.rb +0 -647
  69. data/test/test_subc-f-to_struct.rb +0 -61
  70. data/test/test_subc-f-validation_util.rb +0 -59
  71. data/test/test_subc-f_debug.rb +0 -39
  72. data/test/test_subc-f_name.rb +0 -525
  73. data/test/test_subc-i-accessor.rb +0 -138
  74. data/test/test_subc-i-adjuster.rb +0 -95
  75. data/test/test_subc-i-assign.rb +0 -53
  76. data/test/test_subc-i-basic.rb +0 -43
  77. data/test/test_subc-i-cast.rb +0 -27
  78. data/test/test_subc-i-compare.rb +0 -52
  79. data/test/test_subc-i-copy.rb +0 -23
  80. data/test/test_subc-i-default_value.rb +0 -129
  81. data/test/test_subc-i-freeze.rb +0 -19
  82. data/test/test_subc-i-hashlike.rb +0 -144
  83. data/test/test_subc-i-keyvalidatable.rb +0 -25
  84. data/test/test_subc-i-lock.rb +0 -40
  85. data/test/test_subc-i-must.rb +0 -30
  86. data/test/test_subc-i-to_s_family.rb +0 -26
  87. data/test/test_subc-i-validation_specific_conditions.rb +0 -297
  88. data/test/test_subc-i-validation_with_getter.rb +0 -33
  89. data/test/test_version.rb +0 -13
data/example/example2.rb DELETED
@@ -1,20 +0,0 @@
1
- #!/usr/local/bin/ruby -w
2
-
3
- require_relative '../lib/striuct'
4
-
5
- User = Striuct.define do # other way "class User < Striuct.new"
6
- member :firstname, /\w+/ # look like case syntax in Ruby
7
- member :lank, AND(Fixnum, 1..10) # easy build multiple validation
8
- default :lank, 3 # set a normal default value
9
- member :registered, Time # look like type variable
10
- default :registered, &->{Time.now} # evaluate with construction
11
- p members #=> [firstname, lank, registered]
12
- end
13
-
14
- class MyUser < User
15
- p members #=> [firstname, lank, registered]
16
- member :foo # no validation, just an accessor
17
- p members #=> [firstname, lank, registered, :foo]
18
- end
19
-
20
- user = MyUser.new
data/example/see_trace.rb DELETED
@@ -1,32 +0,0 @@
1
- #/usr/bin/ruby -w
2
-
3
- require_relative '../lib/striuct'
4
-
5
- class User < Striuct.new
6
- member :id, Integer
7
- member :age, (20..140)
8
- end
9
-
10
- user = User.new
11
-
12
- begin
13
- user[:id] = 10.0
14
- rescue
15
- puts $!.backtrace
16
- end
17
-
18
- puts '-' * 80
19
-
20
- $stdout.flush
21
-
22
- begin
23
- user.age = 19
24
- rescue
25
- puts $!.backtrace
26
- end
27
-
28
- puts '-' * 80
29
-
30
- $stdout.flush
31
-
32
- user.age = 19
@@ -1,9 +0,0 @@
1
- class Striuct; module InstanceMethods
2
-
3
- KeyValidatable.instance_methods.each do |feature|
4
- if specific_feature = feature.to_s.sub!('members'){'autonyms'}
5
- def_delegator :self, feature, specific_feature.to_sym
6
- end
7
- end
8
-
9
- end; end
data/striuct.gemspec DELETED
@@ -1,45 +0,0 @@
1
- # coding: us-ascii
2
-
3
- lib_name = 'striuct'.freeze
4
-
5
- Gem::Specification.new do |gem|
6
- # specific
7
-
8
- gem.description = %q{Struct++ library.
9
-
10
- ---
11
-
12
- Validatable, Inheritable, Member Aliasing,
13
- Conflict Management, Default Value, Divide nil with unassign,
14
- Lock setter of each member, Hash flendly API, ... And more Struct++ features :)}
15
-
16
- gem.summary = gem.description.dup
17
- gem.homepage = "https://github.com/kachick/#{lib_name}"
18
- gem.license = 'MIT'
19
- gem.name = lib_name.dup
20
- gem.version = '0.6.1'
21
-
22
- gem.required_ruby_version = '>= 2.2'
23
-
24
- gem.add_runtime_dependency 'validation', '~> 0.1'
25
- gem.add_runtime_dependency 'optionalargument', '~> 0.3'
26
- gem.add_runtime_dependency 'keyvalidatable'
27
-
28
- gem.add_development_dependency 'test-unit', '>= 3.2.6', '< 4'
29
- gem.add_development_dependency 'yard', '>= 0.9.11', '< 2.0'
30
- gem.add_development_dependency 'rake', '>= 10', '< 20'
31
- gem.add_development_dependency 'bundler', '>= 1.10', '< 2'
32
-
33
- if RUBY_ENGINE == 'rbx'
34
- gem.add_dependency 'rubysl', '~> 2.2'
35
- end
36
-
37
- # common
38
-
39
- gem.authors = ['Kenichi Kamiya']
40
- gem.email = ['kachick1+ruby@gmail.com']
41
- gem.files = `git ls-files`.split($\)
42
- gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
43
- gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
44
- gem.require_paths = ['lib']
45
- end
data/test/helper.rb DELETED
@@ -1,3 +0,0 @@
1
- require 'test/unit'
2
-
3
- require_relative '../lib/striuct'
@@ -1,36 +0,0 @@
1
- require_relative 'helper'
2
-
3
- class Test_Striuct_Constructor < Test::Unit::TestCase
4
-
5
- def test_new
6
- cls = Striuct.new
7
- assert_not_instance_of Striuct, cls
8
- assert_instance_of Class, cls
9
- assert_kind_of Striuct, cls.new
10
-
11
- cls2 = Striuct.new :name, :age
12
-
13
- assert_equal cls2.members, [:name, :age]
14
-
15
- cls3 = Striuct.new :foo do
16
- member :var
17
- end
18
-
19
- assert_equal cls3.members, [:foo, :var]
20
- end
21
-
22
- def test_define
23
- assert_raises RuntimeError do
24
- Striuct.define do
25
- end
26
- end
27
-
28
- klass = Striuct.define do
29
- member :foo
30
- end
31
-
32
- assert_equal true, klass.closed?
33
- end
34
-
35
- end
36
-
@@ -1,13 +0,0 @@
1
- require_relative 'helper'
2
-
3
- class Test_Striuct_Subclass_Class_Macro < Test::Unit::TestCase
4
-
5
- def test_add_members
6
- klass = Striuct.new :foo do
7
- add_members :aaa, 'bbb', :ccc
8
- end
9
-
10
- assert_equal [:foo, :aaa, :bbb, :ccc], klass.members
11
- end
12
-
13
- end
@@ -1,36 +0,0 @@
1
- require_relative 'helper'
2
-
3
- class Test_Striuct_Subclass_Class_Close < Test::Unit::TestCase
4
-
5
- Sth = Striuct.new do
6
- member :foo
7
- end
8
-
9
- def test_class_close
10
- sth = Sth.new
11
-
12
- assert_equal true, sth.member?(:foo)
13
-
14
- Sth.class_eval do
15
- member :bar
16
- end
17
-
18
- assert_equal true, sth.member?(:bar)
19
- assert_equal [:foo, :bar], sth.members
20
-
21
- assert_equal false, Sth.closed?
22
-
23
- Sth.__send__ :close
24
-
25
- assert_equal true, Sth.closed?
26
-
27
- assert_raises RuntimeError do
28
- Sth.class_eval do
29
- member :var2
30
- end
31
- end
32
-
33
- assert_equal false, sth.member?(:var2)
34
- end
35
-
36
- end
@@ -1,92 +0,0 @@
1
- require_relative 'helper'
2
-
3
- class Test_Striuct_Subclass_Class_Constructor < Test::Unit::TestCase
4
-
5
- User = Striuct.define do
6
- member :name, AND(String, NOT(''))
7
- member :age, Integer
8
- end.freeze
9
-
10
- [:for_values, :new].each do |callee|
11
- define_method :"test_subclass_#{callee}" do
12
- user = User.public_send callee
13
- assert_instance_of User, user
14
- assert_not_kind_of Class, user
15
- assert_equal [:name, :age], user.members
16
- assert_equal [nil, nil], user.values
17
-
18
- assert_raises Validation::InvalidWritingError do
19
- User.public_send callee, :SYMBOL
20
- end
21
-
22
- assert_raises Validation::InvalidWritingError do
23
- User.public_send callee, ''
24
- end
25
-
26
- user = User.public_send callee, '.'
27
- assert_instance_of User, user
28
- assert_not_kind_of Class, user
29
- assert_equal ['.', nil], user.values
30
-
31
- assert_raises Validation::InvalidWritingError do
32
- User.public_send callee, '.', 1.0
33
- end
34
-
35
- user = User.public_send callee, '.', 1
36
- assert_equal ['.', 1], user.values
37
- end
38
- end
39
-
40
- def test_define
41
- user = User.define{|r|r.age = 1; r.name = 'a'}
42
- assert_same 1, user.age
43
-
44
- assert_raises RuntimeError do
45
- user.age = 1
46
- end
47
-
48
- user = User.define{|r|r.age = 1; r.name = 'a'}
49
- assert_same 1, user.age
50
- assert_same true, user.all_locked?
51
- assert_same false, user.frozen?
52
-
53
- assert_raises RuntimeError do
54
- User.define{|r|r.age = 1}
55
- end
56
-
57
- user = User.define(lock: true){|r|r.age = 1; r.name = 'a'}
58
- assert_same 1, user.age
59
- assert_same true, user.all_locked?
60
- user = User.define(lock: false){|r|r.age = 1; r.name = 'a'}
61
- assert_same false, user.all_locked?
62
- assert_equal true, user.strict?
63
-
64
- assert_raises Validation::InvalidWritingError do
65
- User.define{|r|r.age = 1; r.name = 'a'; r.name.clear}
66
- end
67
-
68
- user = User.define(strict: false){|r|r.age = 1; r.name = 'a'; r.name.clear}
69
- assert_equal '', user.name
70
- assert_equal false, user.strict?
71
- end
72
-
73
- Sth = Striuct.new :foo, :bar, :hoge
74
- SampleStruct = Struct.new :foo, :bar, :hoge
75
-
76
- def test_for_pairs_from_hash
77
- sth = Sth[hoge: 7, foo: 8]
78
-
79
- assert_equal [8, nil, 7], sth.values
80
-
81
- sth = Sth['hoge' => 7, 'foo' => 8]
82
-
83
- assert_equal [8, nil, 7], sth.values
84
- end
85
-
86
- def test_for_pairs_from_struct
87
- sth = Sth[SampleStruct.new 8, nil, 7]
88
-
89
- assert_equal [8, nil, 7], sth.values
90
- end
91
-
92
- end
@@ -1,71 +0,0 @@
1
- require_relative 'helper'
2
-
3
- class Test_Striuct_Subclass_Class_Copy < Test::Unit::TestCase
4
-
5
- def test_dup
6
- org_cls = Striuct.define do
7
- member :sth
8
- end.freeze
9
-
10
- assert_same true, org_cls.frozen?
11
- assert_same true, org_cls.closed?
12
- cls2 = org_cls.dup
13
- assert_same true, org_cls.frozen?
14
- assert_same true, org_cls.closed?
15
- assert_same false, cls2.frozen?
16
- assert_same false, cls2.closed?
17
- cls2.__send__ :member, :dummy1
18
- assert_same false, org_cls.member?(:dummy1)
19
- end
20
-
21
- def test_clone
22
- org_cls = Striuct.define do
23
- member :sth
24
- end.freeze
25
-
26
- assert_same true, org_cls.frozen?
27
- assert_same true, org_cls.closed?
28
- cls2 = org_cls.clone
29
- assert_same true, org_cls.frozen?
30
- assert_same true, org_cls.closed?
31
- assert_same true, cls2.frozen?
32
- assert_same true, cls2.closed?
33
- end
34
-
35
- def test_dup_deep
36
- org_cls = Striuct.define do
37
- member :foo, Numeric
38
- end
39
-
40
- foo = org_cls.new
41
- cls2 = org_cls.dup
42
- foo2 = cls2.new
43
- foo2.foo = 0.1
44
- assert_raises Validation::InvalidWritingError do
45
- foo2.foo = '1'
46
- end
47
-
48
- foo.foo = 1
49
-
50
- assert_same 1, foo.foo
51
- end
52
-
53
- def test_clone_deep
54
- org_cls = Striuct.define do
55
- member :foo, Numeric
56
- end
57
-
58
- foo = org_cls.new
59
- cls2 = org_cls.clone
60
- foo2 = cls2.new
61
- foo2.foo = 0.1
62
- assert_raises Validation::InvalidWritingError do
63
- foo2.foo = '1'
64
- end
65
-
66
- foo.foo = 1
67
-
68
- assert_same 1, foo.foo
69
- end
70
-
71
- end
@@ -1,36 +0,0 @@
1
- require_relative 'helper'
2
-
3
- class Test_Striuct_Subclass_Class_Freeze < Test::Unit::TestCase
4
-
5
- Sth = Striuct.new do
6
- member :foo
7
- end
8
-
9
- def test_class_freeze
10
- sth = Sth.new
11
-
12
- assert_same true, sth.member?(:foo)
13
-
14
- Sth.class_eval do
15
- member :bar
16
- end
17
-
18
- assert_same true, sth.member?(:bar)
19
- assert_equal [:foo, :bar], sth.members
20
-
21
- assert_same false, Sth.frozen?
22
-
23
- Sth.freeze
24
-
25
- assert_same true, Sth.frozen?
26
-
27
- assert_raises RuntimeError do
28
- Sth.class_eval do
29
- member :var2
30
- end
31
- end
32
-
33
- assert_same false, sth.member?(:var2)
34
- end
35
-
36
- end
@@ -1,58 +0,0 @@
1
- require_relative 'helper'
2
-
3
- class Test_Striuct_Subclass_Class_Inheritable < Test::Unit::TestCase
4
-
5
- Sth = Striuct.define do
6
- member :foo, String
7
- member :bar, OR(nil, Integer)
8
- end
9
-
10
- class SubSth < Sth
11
- member :hoge, OR(nil, 1..3)
12
- end
13
-
14
- class SubSubSth < SubSth
15
- member :rest, AND(/\d/, Symbol)
16
- end
17
-
18
- def test_inherit
19
- assert_equal [*Sth.members, :hoge], SubSth.members
20
- sth = Sth.new
21
- substh = SubSth.new
22
-
23
- assert_raises Validation::InvalidWritingError do
24
- substh.bar = 'str'
25
- end
26
-
27
- assert_raises Validation::InvalidWritingError do
28
- substh.hoge = 4
29
- end
30
-
31
- assert_raises NoMethodError do
32
- sth.hoge = 3
33
- end
34
-
35
- assert_raises NoMethodError do
36
- substh.rest = :a4
37
- end
38
-
39
- subsubsth = SubSubSth.new
40
-
41
- assert_raises Validation::InvalidWritingError do
42
- subsubsth.rest = 4
43
- end
44
-
45
- subsubsth.rest = :a4
46
-
47
- assert_equal :a4, subsubsth[:rest]
48
-
49
- assert_equal true, Sth.__send__(:closed?)
50
- assert_equal false, SubSth.__send__(:closed?)
51
- SubSth.__send__(:close)
52
- assert_equal true, SubSth.__send__(:closed?)
53
- assert_equal false, SubSubSth.__send__(:closed?)
54
- SubSubSth.__send__(:close)
55
- assert_equal true, SubSubSth.__send__(:closed?)
56
- end
57
-
58
- end
@@ -1,73 +0,0 @@
1
- require_relative 'helper'
2
-
3
- class Test_Striuct_Subclass_Class_SafetyNaming < Test::Unit::TestCase
4
-
5
- def test_cname?
6
- klass = Striuct.new
7
- assert_same false, klass.cname?(BasicObject)
8
- assert_same false, klass.cname?('m?')
9
- assert_same false, klass.cname?('__foo__')
10
- assert_same false, klass.cname?('a b')
11
- assert_same false, klass.cname?('object_id')
12
- assert_same false, klass.cname?('to_ary')
13
- assert_same true, klass.cname?('foo')
14
- klass.__send__ :set_conflict_management_level, :warning
15
- assert_same false, klass.cname?('m?')
16
- assert_same false, klass.cname?('__foo__')
17
- assert_same false, klass.cname?('a b')
18
- assert_same false, klass.cname?('object_id')
19
- assert_same false, klass.cname?('to_ary')
20
- assert_same true, klass.cname?('foo')
21
- klass.__send__ :set_conflict_management_level, :struct
22
- assert_same true, klass.cname?('m?')
23
- assert_same true, klass.cname?('__foo__')
24
- assert_same true, klass.cname?('a b')
25
- assert_same true, klass.cname?('object_id')
26
- assert_same true, klass.cname?('to_ary')
27
- assert_same true, klass.cname?('foo')
28
- end
29
-
30
- def test_protect
31
- klass = Striuct.new
32
- assert_raises NameError do
33
- klass.class_eval do
34
- member ''
35
- end
36
- end
37
-
38
- assert_raises NameError do
39
- klass.class_eval do
40
- member :'a b'
41
- end
42
- end
43
-
44
- assert_raises NameError do
45
- klass.class_eval do
46
- member :'__send__'
47
- end
48
- end
49
-
50
- assert_raises NameError do
51
- klass.class_eval do
52
- member :'__foo__'
53
- end
54
- end
55
-
56
- assert_raises NameError do
57
- klass.class_eval do
58
- member :'m?'
59
- end
60
- end
61
-
62
- assert_same false, klass.member?('m?')
63
-
64
- klass.class_eval do
65
- conflict_management :struct do
66
- member :'m?'
67
- end
68
- end
69
-
70
- assert_same true, klass.member?('m?')
71
- end
72
-
73
- end
@@ -1,54 +0,0 @@
1
- require_relative 'helper'
2
-
3
- class Test_Striuct_Subclass_AliasMember < Test::Unit::TestCase
4
-
5
- class Sth < Striuct.new
6
- member :foo, String
7
-
8
- member :bar, Integer do |v|
9
- v
10
- end
11
-
12
- member :hoge, Symbol
13
- default :hoge, :'Z'
14
- alias_member :abc, :bar
15
- default :abc, 8
16
- end
17
-
18
- def test_alias_member
19
- sth = Sth.new 'A'
20
- assert_equal [:foo, :bar, :hoge], sth.members
21
- assert_equal [:foo, :bar, :hoge], sth.autonyms
22
- assert_equal({abc: :bar}, sth.aliases)
23
- assert_equal [:foo, :bar, :hoge, :abc], sth.all_members
24
-
25
- assert_equal 8, sth[:abc]
26
- adjuster = Sth.__send__(:adjuster_for, :abc)
27
- assert_kind_of Proc, adjuster
28
- assert_same adjuster, Sth.__send__(:adjuster_for, :bar)
29
- assert_equal 8, sth.abc
30
- sth.abc = 5
31
- assert_equal 5, sth.bar
32
- sth[:abc] = 6
33
- assert_equal 6, sth.bar
34
-
35
- assert_raises Validation::InvalidWritingError do
36
- sth[:abc] = 'a'
37
- end
38
-
39
- assert_raises Validation::InvalidWritingError do
40
- sth.abc = 'a'
41
- end
42
-
43
- assert_raises Validation::InvalidWritingError do
44
- sth.bar = 'a'
45
- end
46
-
47
- assert_raises ArgumentError do
48
- Sth.class_eval do
49
- member :abc
50
- end
51
- end
52
- end
53
-
54
- end