striuct 0.4.3 → 0.4.4

data/README.md

@@ -94,6 +94,17 @@ foo.with_adjuster = '5'
 foo.with_adjuster        #=> 5                # Casted via adjuster
 ```
 
+### Overview - Case 3
+
+```ruby
+class UseMustOption < Striuct
+  member :foo, Integer, must: true
+end
+
+UseMustOption.new #=> InvalidOperationError "`foo` require a value under `must` option "
+```
+
+
 ### How to build flexible conditions ?
 
 * That from validation library.  

data/example/README.rb

@@ -43,4 +43,11 @@ foo.bar = 1.2
 #~ foo.bar = 1          #=> error
 
 foo.with_adjuster = '5'
-p foo.with_adjuster
+p foo.with_adjuster
+
+class UseMustOption < Striuct
+  member :foo, Integer, must: true
+end
+
+#~ p UseMustOption.new #=> InvalidOperationError
+p UseMustOption.new(1)

data/lib/striuct.rb

@@ -3,6 +3,10 @@
 
 # @abstract
 class Striuct
+
+  class Error < StandardError; end
+  class InvalidOperationError < Error; end
+
 end
 
 require_relative 'striuct/requirements'

data/lib/striuct/classmethods/attributes.rb

@@ -1,17 +1,19 @@
 class Striuct; module ClassMethods
 
-  # Attributes for each Member(Autonym)
+  # Attributes for autonym of each member
   class Attributes
 
     VALUES   = [ :condition,
                  :adjuster  ].freeze
 
     BOOLEANS = [ :inference,
+                 :must,
                  :safety_setter,
                  :safety_getter ].freeze
     
     def initialize
       @hash =  { inference:     false,
+                 must:          false,
                  safety_setter: false,
                  safety_getter: false }
     end
@@ -47,7 +49,7 @@ class Striuct; module ClassMethods
         @hash.fetch role
       end
       
-      define_method "#{role}=".to_sym do |arg|
+      define_method :"#{role}=" do |arg|
         raise TypeError unless arg.equal?(true) or arg.equal?(false)
 
         @hash[role] = arg

data/lib/striuct/classmethods/constructor.rb

@@ -17,13 +17,11 @@ class Striuct; module ClassMethods
   def for_pairs(pairs)
     raise TypeError, 'no pairs object' unless pairs.respond_to?(:each_pair)
     KeyValidatable.validate_array KeyValidatable.keys_for(pairs).map(&:to_sym),
-                                       let: all_members
+                                  let: all_members
 
-    new.tap {|instance|
-      pairs.each_pair do |name, value|
-        instance[name] = value
-      end
-    }
+    instance = allocate
+    instance.__send__ :initialize_for_pairs, pairs
+    instance
   end
 
   alias_method :[], :for_pairs

data/lib/striuct/classmethods/inner.rb

@@ -2,6 +2,17 @@ class Striuct; module ClassMethods
 
   # @group Inner Methods
 
+  # for debug
+  # @return [Hash]
+  def attributes
+    {
+      autonyms: @autonyms.dup,
+      aliases: @aliases.dup,
+      conflict_management_level: @conflict_management_level,
+      attributes_each_autonym: @attributes.dup
+    }
+  end
+
   private
 
   def _init

data/lib/striuct/classmethods/macro.rb

@@ -10,6 +10,7 @@ class Striuct; module ClassMethods
     opt :default_proc, aliases: [:lazy_default]
     conflict :default_value, :default_proc
     opt :inference, default: false
+    opt :must, default: false
     opt :setter_validation, aliases: [:writer_validation], default: true
     opt :getter_validation, aliases: [:reader_validation], default: false
   }
@@ -22,6 +23,7 @@ class Striuct; module ClassMethods
   # @option options [BasicObject] :default
   # @option options [Proc] :default_proc
   # @option options [Boolean] :inference
+  # @option options [Boolean] :must
   # @option options [Boolean] :reader_validation
   # @option options [Boolean] :getter_validation
   # @option options [Boolean] :writer_validation
@@ -45,6 +47,10 @@ class Striuct; module ClassMethods
       _attributes_for(autonym).inference = true
     end
 
+    if options.must
+      _attributes_for(autonym).must = true
+    end
+
     _def_getter autonym
     _def_setter autonym, condition, &adjuster
     

data/lib/striuct/classmethods/predicate.rb

@@ -92,6 +92,17 @@ class Striuct; module ClassMethods
     _attributes_for(autonym).with_inference?
   end
 
+  # @param [Symbol, String, #to_sym, Integer, #to_int] key - name / index
+  def with_must?(key)
+    autonym = autonym_for_key key
+  rescue Exception
+    false
+  else
+    _attributes_for(autonym).with_must?
+  end
+
+  alias_method :must?, :with_must?
+
   # @param [Symbol, String, #to_sym, Integer, #to_int] key - name / index
   def with_safety_getter?(key)
     autonym = autonym_for_key key

data/lib/striuct/instancemethods/assign.rb

@@ -14,6 +14,9 @@ class Striuct; module InstanceMethods
   def unassign(key)
     _check_frozen
     _check_locked key
+    if must? key
+      raise InvalidOperationError, "`#{key}` require a value under `must` option"
+    end
     
     @db.delete autonym_for_key(key)
   end

data/lib/striuct/instancemethods/delegate_class_methods.rb

@@ -8,7 +8,7 @@ class Striuct; module InstanceMethods
     :autonym_for_member,
     :autonym_for_index,
     :autonym_for_key,
-    :autonyms, :members, :all_members, :aliases,
+    :autonyms, :members, :all_members, :aliases, :attributes,
     :has_autonym?, :autonym?,
     :has_alias?, :alias?, :aliased?,
     :has_member?, :member?,
@@ -22,6 +22,7 @@ class Striuct; module InstanceMethods
     :with_safety_getter?, :with_safety_reader?,
     :with_safety_setter?, :with_safety_writer?,
     :with_inference?,
+    :with_must?, :must?,
     :with_default?,
     :default_value_for, :default_type_for,
     :with_adjuster?,

data/lib/striuct/instancemethods/object.rb

@@ -1,26 +1,52 @@
 class Striuct; module InstanceMethods
 
   # @group Basic Methods for Ruby's Object
-  
-  def initialize(*values)
-    @db, @locks = {}, {}
-    replace_values(*values)
-    excess_autonyms = _autonyms.last(size - values.size)
-    _set_defaults(*excess_autonyms)
-  end
 
   # @return [self]
   def freeze
     @db.freeze; @locks.freeze
     super
   end
-  
+
   private
+
+  def initialize(*values)
+    _initialize_database
+
+    replace_values(*values)
+    excess_autonyms = _autonyms.last(size - values.size)
+    _set_defaults(*excess_autonyms)
+
+    each_autonym do |autonym|
+      _check_must autonym
+    end
+  end
+
+  def initialize_for_pairs(pairs)
+    _initialize_database
+    
+    excess_autonyms = _autonyms.dup
+    pairs.each_pair do |key, value|
+      autonym = autonym_for_key key
+      self[autonym] = value
+      excess_autonyms.delete autonym
+    end
+
+    _set_defaults(*excess_autonyms)
+
+    excess_autonyms.each do |autonym|
+      _check_must autonym
+    end
+  end
   
   def initialize_copy(original)
     @db, @locks = @db.dup, {}
   end
 
+  def _initialize_database
+    @db, @locks = {}, {}
+  end
+
   def _check_frozen
     raise "can't modify frozen #{self.class}" if frozen?
   end
@@ -29,6 +55,12 @@ class Striuct; module InstanceMethods
     raise "can't modify locked member `#{key}`" if locked? key
   end
 
+  def _check_must(key)
+    if must?(key) && !assigned?(key)
+      raise InvalidOperationError, "`#{key}` require a value under `must` option"
+    end
+  end
+
   # @endgroup
 
 end; end

data/lib/striuct/instancemethods/to_s.rb

@@ -4,13 +4,21 @@ class Striuct; module InstanceMethods
   
   # @return [String]
   def inspect
-    "#<struct' #{self.class} strict?:#{strict?}".tap {|s|
+    "#<struct' #{self.class}".tap {|s|
       each_pair do |autonym, value|
         suffix = (with_default?(autonym) && default?(autonym)) ? '/default' : nil
-        s << " #{autonym}=#{value.inspect}#{suffix}("
-        s << "valid?:#{valid? autonym}, "
-        s << "locked?:#{locked? autonym}"
-        s << '),'
+        label_valid = valid?(autonym) ? nil : :invalid
+        label_lock = locked?(autonym) ? :locked : nil
+        label_must = must?(autonym) ? :must : nil
+        labels = [label_valid, label_lock, label_must].select{|_|_}
+
+        s << " #{autonym}=#{value.inspect}#{suffix}"
+        unless labels.empty?
+          s << '('
+          s << labels.join(', ')
+          s << ')'
+        end
+        s << ','
       end
       
       s.chop!

data/striuct.gemspec

@@ -1,7 +1,9 @@
 Gem::Specification.new do |gem|
   # specific
 
-  gem.description   = %q{Struct++ library
+  gem.description   = %q{Struct++ library.
+
+---
 
   Validatable, Inheritable, Member Aliasing,
   Conflict Management, Default Value, Divide nil with unassign,
@@ -11,7 +13,7 @@ Gem::Specification.new do |gem|
   gem.homepage      = 'http://kachick.github.com/striuct/'
   gem.license       = 'MIT'
   gem.name          = 'striuct'
-  gem.version       = '0.4.3'
+  gem.version       = '0.4.4'
 
   gem.required_ruby_version = '>= 1.9.2'
 

data/test/test_subc-f-predicate.rb

@@ -382,6 +382,70 @@ class Test_Striuct_Subclass_Predicate_InferenceValidation < Test::Unit::TestCase
 
 end
 
+class Test_Striuct_Subclass_Predicate_Must < Test::Unit::TestCase
+
+  class Subclass < Striuct
+    member :no_with
+    alias_member :als_no_with, :no_with
+    member :with, BasicObject, must: true
+    alias_member :als_with, :with
+    member :with_any, BasicObject, must: true
+    alias_member :als_with_any, :with_any
+    member(:adj_with, BasicObject, must: true) do |_|; end
+    alias_member :als_adj_with, :adj_with
+
+    close_member
+  end.freeze
+
+  INSTANCE = Subclass[als_with: 1, als_with_any: 1, adj_with: 1].freeze
+  
+  TYPE_PAIRS = {
+    class: Subclass,
+    instance: INSTANCE
+  }.freeze
+
+  [:with_must?, :must?].each do |predicate|
+    TYPE_PAIRS.each_pair do |type, reciever|
+      define_method :"test_#{type}_#{predicate}" do
+        assert_same false, reciever.public_send(predicate, :no_with)
+        assert_same false, reciever.public_send(predicate, :als_no_with)
+        assert_same false, reciever.public_send(predicate, 'no_with')
+        assert_same false, reciever.public_send(predicate, 'als_no_with')
+        assert_same false, reciever.public_send(predicate, 0)
+        assert_same false, reciever.public_send(predicate, 0.9)
+        
+        assert_same true, reciever.public_send(predicate, :with)
+        assert_same true, reciever.public_send(predicate, :als_with)
+        assert_same true, reciever.public_send(predicate, 'with')
+        assert_same true, reciever.public_send(predicate, 'als_with')
+        assert_same true, reciever.public_send(predicate, 1)
+        assert_same true, reciever.public_send(predicate, 1.9)
+
+        assert_same true, reciever.public_send(predicate, :with_any)
+        assert_same true, reciever.public_send(predicate, :als_with_any)
+        assert_same true, reciever.public_send(predicate, 'with_any')
+        assert_same true, reciever.public_send(predicate, 'als_with_any')
+        assert_same true, reciever.public_send(predicate, 2)
+        assert_same true, reciever.public_send(predicate, 2.9)
+
+        assert_same true, reciever.public_send(predicate, :adj_with)
+        assert_same true, reciever.public_send(predicate, :als_adj_with)
+        assert_same true, reciever.public_send(predicate, 'adj_with')
+        assert_same true, reciever.public_send(predicate, 'als_adj_with')
+        assert_same true, reciever.public_send(predicate, 3)
+        assert_same true, reciever.public_send(predicate, 3.9)
+        
+        assert_same false, reciever.public_send(predicate, :none)
+        assert_same false, reciever.public_send(predicate, 'none')
+        assert_same false, reciever.public_send(predicate, 4)
+        assert_same false, reciever.public_send(predicate, 4.9)
+        assert_same false, reciever.public_send(predicate, BasicObject.new)
+      end
+    end
+  end
+
+end
+
 
 class Test_Striuct_Subclass_Predicate_HookTiming_Setter_Enable < Test::Unit::TestCase
 

data/test/test_subc-f_debug.rb

@@ -0,0 +1,39 @@
+require_relative 'helper'
+
+class Test_Striuct_Subclass_Debug < Test::Unit::TestCase
+
+  Subclass = Striuct.define do
+    member :foo
+    member :bar
+    alias_member :als_foo, :foo
+  end.freeze
+
+  INSTANCE = Subclass.new.freeze
+  
+  TYPE_PAIRS = {
+    Class: Subclass,
+    Instance: INSTANCE
+  }.freeze
+
+  [:attributes].each do |callee|
+    TYPE_PAIRS.each_pair do |type, reciever|
+      define_method :"test_#{type}_#{callee}" do
+        assert_same true, reciever.public_methods.include?(callee)
+        ret = reciever.public_send(callee)
+        assert_instance_of Hash, ret
+        assert_equal [:autonyms, :aliases, :conflict_management_level, :attributes_each_autonym], ret.keys
+        assert_equal Subclass.autonyms, ret.fetch(:autonyms)
+        assert_equal Subclass.aliases, ret.fetch(:aliases)
+        assert_equal Subclass.conflict_management_level, ret.fetch(:conflict_management_level)
+        assert_equal Subclass.instance_variable_get(:@attributes), ret.fetch(:attributes_each_autonym)
+        
+        10.times do
+          ret2 = reciever.public_send(callee)
+          assert_not_same ret, ret2
+          assert_equal ret, ret2
+        end
+      end
+    end
+  end
+
+end

data/test/test_subc-i-must.rb

@@ -0,0 +1,30 @@
+require_relative 'helper'
+
+class Test_Striuct_Subclass_Must < Test::Unit::TestCase
+
+  Sth = Striuct.define do
+    member :foo, ANYTHING?, must: false
+    member :bar, ANYTHING?, must: true
+    member :baz
+  end
+  
+  def test_must
+    assert_raises(Striuct::InvalidOperationError) do
+      Sth.new :foo
+    end
+
+    assert_raises(Striuct::InvalidOperationError) do
+      Sth.new foo: :foo, baz: :baz
+    end
+
+    sth = Sth.new :foo, :bar, :baz
+    assert_instance_of(Sth, sth)
+
+    assert_raises(Striuct::InvalidOperationError) do
+      sth.unassign :bar
+    end
+
+    assert_nil(sth.bar = nil)
+  end
+
+end

data/test/test_subc-i-to_s_family.rb

@@ -3,23 +3,24 @@ require_relative 'helper'
 class Test_Striuct_Subclass_Instance_to_s_Family < Test::Unit::TestCase
 
   class User < Striuct.new
-    member :id, Integer
-    member :last_name, /\A\w+\z/
-    member :family_name, /\A\w+\z/
-    member :address, /\A((\w+) ?)+\z/
-    member :age, ->age{(20..140).include? age}
+    member :id, Integer, must: true
+    member :name, /\w+/
+  end
+
+  def setup
+    @sth = User.new 9999, 'taro'
+    @sth.lock(:name)
+    @sth.name.clear
   end
 
   def test_to_s
-    user = User.new 9999, 'taro', 'yamada', 'Tokyo Japan', 30
-    assert_equal %q!#<struct' Test_Striuct_Subclass_Instance_to_s_Family::User id=9999, last_name="taro", family_name="yamada", address="Tokyo Japan", age=30>!,
-                 user.to_s
+    assert_equal %q!#<struct' Test_Striuct_Subclass_Instance_to_s_Family::User id=9999, name="">!,
+                 @sth.to_s
   end
 
   def test_inspect
-    user = User.new 9999, 'taro', 'yamada', 'Tokyo Japan', 30
-    assert_equal %q!#<struct' Test_Striuct_Subclass_Instance_to_s_Family::User strict?:true id=9999(valid?:true, locked?:false), last_name="taro"(valid?:true, locked?:false), family_name="yamada"(valid?:true, locked?:false), address="Tokyo Japan"(valid?:true, locked?:false), age=30(valid?:true, locked?:false)>!,
-                 user.inspect
+    assert_equal %q!#<struct' Test_Striuct_Subclass_Instance_to_s_Family::User id=9999(must), name=""(invalid, locked)>!,
+                 @sth.inspect
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: striuct
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-31 00:00:00.000000000 Z
+date: 2013-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: validation
@@ -125,7 +125,7 @@ dependencies:
     - - <
       - !ruby/object:Gem::Version
         version: '2'
-description: ! "Struct++ library\n\n  Validatable, Inheritable, Member Aliasing,\n
+description: ! "Struct++ library.\n\n---\n\n  Validatable, Inheritable, Member Aliasing,\n
   \ Conflict Management, Default Value, Divide nil with unassign,\n  Lock setter of
   each member, Hash flendly API, ... And more Struct++ features :)"
 email:
@@ -202,6 +202,7 @@ files:
 - test/test_subc-f-predicate.rb
 - test/test_subc-f-to_struct.rb
 - test/test_subc-f-validation_util.rb
+- test/test_subc-f_debug.rb
 - test/test_subc-f_name.rb
 - test/test_subc-i-accessor.rb
 - test/test_subc-i-adjuster.rb
@@ -215,6 +216,7 @@ files:
 - test/test_subc-i-hashlike.rb
 - test/test_subc-i-keyvalidatable.rb
 - test/test_subc-i-lock.rb
+- test/test_subc-i-must.rb
 - test/test_subc-i-to_s_family.rb
 - test/test_subc-i-validation_inference.rb
 - test/test_subc-i-validation_specific_conditions.rb
@@ -244,9 +246,9 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Struct++ library  Validatable, Inheritable, Member Aliasing, Conflict Management,
-  Default Value, Divide nil with unassign, Lock setter of each member, Hash flendly
-  API, ... And more Struct++ features :)
+summary: Struct++ library.  ---  Validatable, Inheritable, Member Aliasing, Conflict
+  Management, Default Value, Divide nil with unassign, Lock setter of each member,
+  Hash flendly API, ... And more Struct++ features :)
 test_files:
 - test/helper.rb
 - test/test_sglc-constructor.rb
@@ -262,6 +264,7 @@ test_files:
 - test/test_subc-f-predicate.rb
 - test/test_subc-f-to_struct.rb
 - test/test_subc-f-validation_util.rb
+- test/test_subc-f_debug.rb
 - test/test_subc-f_name.rb
 - test/test_subc-i-accessor.rb
 - test/test_subc-i-adjuster.rb
@@ -275,6 +278,7 @@ test_files:
 - test/test_subc-i-hashlike.rb
 - test/test_subc-i-keyvalidatable.rb
 - test/test_subc-i-lock.rb
+- test/test_subc-i-must.rb
 - test/test_subc-i-to_s_family.rb
 - test/test_subc-i-validation_inference.rb
 - test/test_subc-i-validation_specific_conditions.rb