classx 0.0.4 → 0.0.5

data/ChangeLog

@@ -1,3 +1,117 @@
+commit de3b716466a8c30e31f75483977bfcd9f19f871a
+Author: Keiji, Yoshimi <walf443@gmail.com>
+Date:   Mon Oct 27 00:00:14 2008 +0900
+
+    oops. spec message fixed.
+
+commit 8c892fc051bba7175cbaa02dd9d29cdd3bab7d51
+Author: Keiji, Yoshimi <walf443@gmail.com>
+Date:   Sun Oct 26 23:00:20 2008 +0900
+
+    update benchmark result.
+
+commit ad6a1e8be27e44d38b2a357f060086053572ecb2
+Author: Keiji, Yoshimi <walf443@gmail.com>
+Date:   Sun Oct 26 18:53:28 2008 +0900
+
+    fixed bug. when you handle some methods that use with block, it not worked.
+
+commit ad34cf6a7f3d119379a2bc78b4060504b404db9e
+Author: Keiji, Yoshimi <walf443@gmail.com>
+Date:   Fri Sep 19 08:59:34 2008 +0900
+
+    added coerce to log_rotate.
+
+commit 8b4cc50e9395bb801beafd60afc579e279e7604d
+Author: Keiji, Yoshimi <walf443@gmail.com>
+Date:   Fri Sep 19 08:52:38 2008 +0900
+
+    added CoerceWithProc.
+
+commit cc2917b5b7f1088428936f9065932c7d630ae356
+Author: Keiji, Yoshimi <walf443@gmail.com>
+Date:   Fri Sep 19 08:37:39 2008 +0900
+
+    added validate to log_rotate.
+
+commit ef422314b28c741950a04e4a9d75a532c4f4a0ab
+Author: Keiji, Yoshimi <walf443@gmail.com>
+Date:   Fri Sep 19 08:29:22 2008 +0900
+
+    fixed bug:  ClassX::Commandable with none kind_of specified attribute does not output :desc to help.
+
+commit 62217b9347f6470db829ef66de116a9bdab04c7c
+Author: Keiji, Yoshimi <walf443@gmail.com>
+Date:   Fri Sep 19 08:20:01 2008 +0900
+
+    added more shortcut.
+
+commit 497ac5c854faa719a90eabcabeb5fbecdd25997f
+Author: Keiji, Yoshimi <walf443@gmail.com>
+Date:   Fri Sep 19 08:11:18 2008 +0900
+
+    added log_rotate attribute.
+
+commit b06e8dac0d7084623426f37568369ca251cf6550
+Author: Keiji, Yoshimi <walf443@gmail.com>
+Date:   Fri Sep 19 08:01:23 2008 +0900
+
+    trigger is not neeed.
+
+commit 343c1efcb9c8fe4c6ccb7674edefeeacf64740e9
+Author: Keiji, Yoshimi <walf443@gmail.com>
+Date:   Fri Sep 19 07:55:14 2008 +0900
+
+    tweak for rdoc.
+
+commit 51dcdd598cfac6d432494dede4427589dcefb665
+Author: Keiji, Yoshimi <walf443@gmail.com>
+Date:   Wed Sep 17 08:59:48 2008 +0900
+
+    change #before_init to class method and change name process_init_args.
+
+commit 6437f8ca6ef3cb443d3e1ced0a7a7d2b61062edb
+Author: Keiji, Yoshimi <walf443@gmail.com>
+Date:   Wed Sep 17 08:42:13 2008 +0900
+
+    adding document.
+
+commit b9bdffc8f2146ef793a0c03e63182d5a4388ad07
+Author: Keiji, Yoshimi <walf443@gmail.com>
+Date:   Tue Sep 16 09:00:40 2008 +0900
+
+    added document.
+
+commit 4a2807b839fe7c9e4d2989e025cf94d415c92e69
+Author: Keiji, Yoshimi <walf443@gmail.com>
+Date:   Tue Sep 16 08:52:28 2008 +0900
+
+    trigger should take array as default.
+
+commit 0171feab3293523d26f70220d8501de1ac6f518d
+Author: Keiji, Yoshimi <walf443@gmail.com>
+Date:   Tue Sep 16 08:14:18 2008 +0900
+
+    update benchmark.
+
+commit d85fa7ded08434e5300e434996eb63686a5753bf
+Author: Keiji, Yoshimi <walf443@gmail.com>
+Date:   Tue Sep 16 08:07:34 2008 +0900
+
+    trigger option support.
+
+commit 355ede71dc0b98f78ebb40b616945f2e192abdc8
+Author: Keiji, Yoshimi <walf443@gmail.com>
+Date:   Mon Sep 15 15:54:03 2008 +0900
+
+    refactering
+
+commit 723cffd4439723f9533c8e681a9202ca5836d3c5
+Author: Keiji, Yoshimi <walf443@gmail.com>
+Date:   Sat Sep 13 00:38:06 2008 +0900
+
+    released 0.0.4
+
 commit c27d76a9e41d7f1d6f02160c6c0b555c6cd68206
 Author: Keiji, Yoshimi <walf443@gmail.com>
 Date:   Sat Sep 13 00:28:06 2008 +0900

data/Rakefile

@@ -17,7 +17,7 @@ DESCRIPTION       = <<-"END_DESCRIPTION"
 Meta Framework extending and flexible attribute like Moose ( perl )
 END_DESCRIPTION
 BIN_FILES         = %w(  )
-VERS              = "0.0.4"
+VERS              = "0.0.5"
 
 EXTRA_RDOC_FILES = []
 HECKLE_ROOT_MODULES = ["Classx"]
@@ -28,7 +28,7 @@ SPEC = Gem::Specification.new do |s|
 	s.platform          = Gem::Platform::RUBY
 	s.has_rdoc          = true
 	s.extra_rdoc_files  = DEFAULT_EXTRA_RDOC_FILES + EXTRA_RDOC_FILES
-	s.rdoc_options     += RDOC_OPTS + ['--title', "#{NAME} documentation"]
+	s.rdoc_options     += RDOC_OPTS + ['--title', "#{NAME} documentation", ]
 	s.summary           = DESCRIPTION
 	s.description       = DESCRIPTION
 	s.author            = AUTHOR

data/bench/attribute_set.rb

@@ -55,6 +55,16 @@ end
 # On my environment( MacBook1.1 Intel Core Duo 1.83 GHz, 2GB), result is like that. TOOOOO SLOOOW classX!!!!.
 # 
 # ----------------------------------------------------------
+# result after 0171feab
+# classx with attr_name = val   0.030000   0.000000   0.030000 (  0.035114)
+# classx with attr_name(val)    0.040000   0.000000   0.040000 (  0.053949)
+# normal class                  0.010000   0.000000   0.010000 (  0.001969)
+# ----------------------------------------------------------
+# result after d85fa7ded
+# classx with attr_name = val   0.020000   0.010000   0.030000 (  0.031880)
+# classx with attr_name(val)    0.040000   0.000000   0.040000 (  0.049979)
+# normal class                  0.000000   0.000000   0.000000 (  0.002021)
+# ----------------------------------------------------------
 # result after 92ed088b ( before 0.0.4 )
 #                                 user     system      total        real
 # classx with attr_name = val   0.020000   0.010000   0.030000 (  0.029100)

data/bench/define_attribute.rb

@@ -156,7 +156,25 @@ end
 # On my environment( MacBook1.1 Intel Core Duo 1.83 GHz, 2GB), result is like that. TOOOOO SLOOOW classX!!!!.
 # 
 # ----------------------------------------------------------
+# result after ad6a1e8be27
+#                             user     system      total        real
+# attr_reader               0.010000   0.000000   0.010000 (  0.009723)
+# simple define             0.220000   0.010000   0.230000 (  0.284162)
+# with declare              0.230000   0.020000   0.250000 (  0.296754)
+# with writable             0.180000   0.020000   0.200000 (  0.216788)
+# with optional             0.260000   0.020000   0.280000 (  0.296184)
+# with default              0.200000   0.010000   0.210000 (  0.234367)
+# with default Proc         0.270000   0.020000   0.290000 (  0.321229)
+# with default Proc lazy    0.210000   0.010000   0.220000 (  0.238869)
+# with validate Proc        0.310000   0.030000   0.340000 (  0.358173)
+# with validate Regexp      0.200000   0.010000   0.210000 (  0.236095)
+# with handles Array        0.240000   0.020000   0.260000 (  0.278163)
+# with handles Hash         0.380000   0.020000   0.400000 (  0.433075)
+# with include              0.210000   0.010000   0.220000 (  0.237816)
+# with extend               0.200000   0.020000   0.220000 (  0.246489)
+# ----------------------------------------------------------
 # result after 92ed088b ( before 0.0.4 )
+#                             user     system      total        real
 # attr_reader               0.010000   0.000000   0.010000 (  0.011373)
 # simple define             0.190000   0.020000   0.210000 (  0.245375)
 # with declare              0.210000   0.020000   0.230000 (  0.269984)

data/bench/initialize.rb

@@ -41,6 +41,14 @@ end
 # On my environment( MacBook1.1 Intel Core Duo 1.83 GHz, 2GB), result is like that. TOOOOO SLOOOW classX!!!!.
 #
 # ----------------------------------------------------------
+# result after 0171feab
+# classx        0.080000   0.000000   0.080000 (  0.099778)
+# normal class  0.000000   0.000000   0.000000 (  0.005175)
+# ----------------------------------------------------------
+# result after d85fa7de
+# classx        0.070000   0.000000   0.070000 (  0.094902)
+# normal class  0.010000   0.000000   0.010000 (  0.004398)
+# ----------------------------------------------------------
 # result after 92ed088b ( before 0.0.4 )
 # classx        0.060000   0.010000   0.070000 (  0.083939)
 # normal class  0.010000   0.000000   0.010000 (  0.004305)

data/example/commandable.rb

@@ -23,10 +23,10 @@ class YourApp
 
   def run
     # do something!!
-    logger.info('starting your_app')
+    info 'starting your_app'
     attribute_of
-    logger.debug(attribute_of.pretty_inspect)
-    logger.info('end your app')
+    debug attribute_of.pretty_inspect
+    info 'end your app'
   end
 end
 

data/lib/classx.rb

@@ -50,7 +50,11 @@ module ClassX
   # This method checking required value is setted and taking value is valid to attribute.
   #
   def initialize *args
-    hash = before_init(*args)
+    if respond_to? :before_init
+      warn 'before_init is deprecated. please define process_init_args class method'
+    else
+      hash = self.class.process_init_args(*args)
+    end
 
     unless hash && hash.kind_of?(Hash)
       raise ArgumentError, "#{hash.inspect} was wrong as arguments. please specify kind of Hash instance"
@@ -101,17 +105,6 @@ module ClassX
     @__attribute_of
   end
 
-  # processing initialize argument to hash
-  # you can override this method for not taking initializer your classx based class.
-  def before_init *args
-    raise ArgumentError if args.size > 1
-
-    hash = args.first
-    hash.nil? ? {} : hash
-  end
-
-  alias process_init_args before_init
-
   # automatically called this method on last of #initialize.
   # you can override this method.
   def after_init
@@ -196,10 +189,22 @@ module ClassX
     end
   end
 
+  module ClassMethods
+    # processing initialize argument to hash
+    # you can override this method for not taking initializer your classx based class.
+    def process_init_args *args
+      raise ArgumentError if args.size > 1
+
+      hash = args.first
+      hash.nil? ? {} : hash
+    end
+  end
+
   private
 
   def self.included klass
     klass.extend(Attributes)
+    klass.extend(ClassMethods)
   end
 
 end

data/lib/classx/attribute.rb

@@ -78,6 +78,12 @@ module ClassX
         end
       end
 
+      module CoerceWithProc #:nodoc:
+        def coerce val
+          config[:coerce].call(val)
+        end
+      end
+
       module CoerceNothing #:nodoc:
         def coerce val
           val
@@ -91,11 +97,9 @@ module ClassX
       end
       module DefaultWithNoProc #:nodoc:
         def default parent
-          begin
-            config[:default].dup
-          rescue Exception
-            config[:default]
-          end
+          config[:default].dup
+        rescue Exception
+          config[:default]
         end
       end
 
@@ -152,6 +156,14 @@ module ClassX
           true
         end
       end
+
+      module TriggerArrayProc #:nodoc:
+        def trigger parent, val
+          config[:trigger].each do |trg|
+            trg.call(parent, val)
+          end
+        end
+      end
     end
 
     module InstanceMethods #:nodoc:
@@ -171,6 +183,9 @@ module ClassX
         val = self.class.coerce(val)
         raise ClassX::InvalidAttrArgument unless self.class.validate? val
         @data = val
+
+        self.class.trigger(@parent, val)
+        @data
       end
 
       def inspect
@@ -210,6 +225,8 @@ module ClassX
           klass.extend(ClassX::AttributeMethods::ClassMethods::CoerceWithHash)
         when Array
           klass.extend(ClassX::AttributeMethods::ClassMethods::CoerceWithArray)
+        when Proc
+          klass.extend(ClassX::AttributeMethods::ClassMethods::CoerceWithProc)
         end
       else
         klass.extend(ClassX::AttributeMethods::ClassMethods::CoerceNothing)
@@ -244,6 +261,18 @@ module ClassX
         klass.extend(ClassX::AttributeMethods::ClassMethods::ValidateNothing)
       end
 
+      # you can specify :trigger option for invoking event on setting value to attribute.
+      # :trigger should take Proc or multi Proc Array.
+      if args[:trigger]
+        unless args[:trigger].kind_of?(Array)
+          args[:trigger] = [ args[:trigger] ]
+        end
+        klass.extend(ClassX::AttributeMethods::ClassMethods::TriggerArrayProc)
+      else
+        args[:trigger] = []
+        klass.extend(ClassX::AttributeMethods::ClassMethods::TriggerArrayProc)
+      end
+
       # for extending attribute point.
       if args[:include]
         case args[:include]

data/lib/classx/attributes.rb

@@ -131,15 +131,19 @@ module ClassX
           case attr_class.config[:handles]
           when Hash
             attr_class.config[:handles].each do |before, after|
-              define_method before do |*args|
-                __send__("#{name}").__send__ after, *args
-              end
+              class_eval <<-CLASS_EVAL
+                def #{before} *args, &block
+                  __send__("#{name}").__send__ "#{after}", *args, &block
+                end
+              CLASS_EVAL
             end
           when Array
             attr_class.config[:handles].each do |meth|
-              define_method meth do |*args|
-                __send__("#{name}").__send__ meth, *args
-              end
+              class_eval <<-CLASS_EVAL
+                def #{meth} *args, &block
+                  __send__("#{name}").__send__ "#{meth}", *args, &block
+                end
+              CLASS_EVAL
             end
           end
         end

data/lib/classx/commandable.rb

@@ -96,9 +96,9 @@ module ClassX
               end
             else
               if short_option_of[short_option] == key
-                opt.on("-#{short_option}", "--#{key} #{val_format}") {|v| value_of[key] = v }
+                opt.on("-#{short_option}", "--#{key} #{val_format}", val.desc ) {|v| value_of[key] = v }
               else
-                opt.on("--#{key} #{val_format}") {|v| value_of[key] = v }
+                opt.on("--#{key} #{val_format}", val.desc ) {|v| value_of[key] = v }
               end
             end
           end

data/lib/classx/role/logger.rb

@@ -38,22 +38,28 @@ module ClassX
         alias to_i to_log_level
       end
 
-      # dummy method for rdoc.
-      def logger; end
+      def logger; end # dummy method for rdoc
 
-      has :logger,
+      # you can use #debug, #info, #warn, #error, #fatal method
+      # shortcut for logger.debug, logger.info, logger.warn, logger.error, logger.fatal.
+      # default output is $stderr.
+      # see also Logger
+      has :logger, {
         :optional      => true,
         :no_cmd_option => true,
-        :lazy          => true, 
+        :lazy          => true,
         :default       => proc {|mine|
-          logger = ::Logger.new(mine.logfile)
+          logger = ::Logger.new(mine.logfile, mine.log_rotate)
           logger.level = mine.attribute_of['log_level'].to_i
           logger.progname = $0
 
           logger
-        }
+        },
+        :handles => [:debug, :info, :warn, :error, :fatal ],
+      }
 
-      has :log_level,
+      # log_level (debug|info|warn|error|fatal) ( default info )
+      has :log_level, {
         :kind_of    => String,
         :desc       => 'log_level (debug|info|warn|error|fatal) (default info)',
         :optional   => true,
@@ -61,13 +67,39 @@ module ClassX
         :include    => ToLogLevel,
         :validate   => proc {|val|
           val && ::Logger::Severity.const_defined?(val.to_s.upcase)
-        }
+        },
+      }
 
-      has :logfile,
+      # output logfile ( default STDERR ).
+      has :logfile, {
         :kind_of    => String,
         :desc       => 'output logfile. (default STDERR)',
         :optional   => true,
-        :default    => $stderr # hmm, is name bad?
+        :default    => $stderr, # hmm, is name bad?
+      }
+
+      # size or (daily|weekly|monthly) (default nil)
+      has :log_rotate, {
+        :desc     => "size or (daily|weekly|monthly) (default nil)",
+        :optional => true,
+        :validate => proc {|val|
+          return true if val =~ /^(daily|weekly|monthly)$/
+          return true if val.to_i > 0
+
+          false
+        },
+        # convert for ClassX::Commandable
+        :coerce   => proc {|val|
+          return val if val.kind_of? Integer
+          return val if val =~ /^(daily|weekly|monthly)$/
+
+          if val.respond_to?(:to_i) && val.to_i > 0
+            val.to_i
+          else
+            val
+          end
+        },
+      }
 
     end
   end