tbpgr_utils 0.0.18 → 0.0.19

data/README.md

@@ -18,32 +18,33 @@ Or install it yourself as:
 
 ## Usage
 ### List
-| class/module/method                                    | mean                                                                                                       |
-|:-----------                                            |:------------                                                                                               |
-|TbpgrUtils Array#together                               |loop all arrays by block                                                                                    |
-|TbpgrUtils Array#together_concat                        |together version of Array#concat. together_concat has alias :tconcat                                        |
-|TbpgrUtils Array#together_map                           |together version of Enumerable#map. together_map has aliases [:tmap, :together_collect, :tcollect]          |
-|TbpgrUtils Array#together_reduce                        |together version of Enumerable#reduce. together_reduce has aliases [:treduce, :together_inject, :tinject]   |
-|TbpgrUtils Array#together_select                        |together version of Enumerable#select. together_select has aliases [:tselect, :together_find_all, :tfindall]|
-|TbpgrUtils Array#together_with_index                    |loop all arrays by block with index                                                                         |
-|AttributesInitializable::ClassMethods.attr_accessor_init|generate attr_accessor + initializer                                                                        |
-|AttributesInitializable::ClassMethods.attr_reader_init  |generate attr_reader + initializer                                                                          |
-|AttributesInitializable::ClassMethods.attr_writer init  |generate attr_writer + initializer                                                                          |
-|Ghostable module                                        |help to create ghost method(dynamic method define by ussing method_missing + pattern-method-name)           |
-|TbpgrUtils Kernel#bulk_define_methods                   |define methods to classes. methods have simple return value.                                                |
-|TestToolbox Kernel#capture_stdout                       |capture STDOUT                                                                                              |
-|TestToolbox Kernel#dp_line                              |debug print line for print-debugging                                                                        |
-|TbpgrUtils Kernel#print_eval                            |Print code + eval result                                                                                    |
-|TbpgrUtils Kernel#puts_eval                             |Puts code + eval result                                                                                     |
-|TbpgrUtils Kernel#bulk_puts_eval                        |Puts each-line-code + eval result                                                                           |
-|TbpgrUtils Module.alias_methods                         |create alias methods                                                                                        |
-|TbpgrUtils Object#any_of?                               |if self match any one of items, return true                                                                 |
-|TbpgrUtils Object#boolean?                              |data type check for boolean                                                                                 |
-|TbpgrUtils Object#my_methods                            |return public/protected/private self define methods                                                         |
-|TbpgrUtils Object#to_bool                               |syntax sugar of !!. convert [false, nil] => fasel, other => true.                                           |
-|TbpgrUtils String#justify_table                         |justify pipe format table string                                                                            |
-|Templatable module                                      |get result from template + placeholder                                                                      |
-|TemplateMethodable module                               |for Template Method Pattern                                                                                 |
+| class/module/method                                                                                               | mean                                                                                                                |
+|:-----------                                                                                                       |:------------                                                                                                        |
+|[TbpgrUtils Array#together](#arraytogether)                                                                        |loop all arrays by block                                                                                             |
+|[TbpgrUtils Array#together_concat](#arraytogether_concat)                                                          |together version of Array#concat. together_concat has alias :tconcat                                                 |
+|[TbpgrUtils Array#together_map](#arraytogether_mapor-tmap-together_collect-tcollect)                               |together version of Enumerable#map. together_map has aliases [:tmap, :together_collect, :tcollect]                   |
+|[TbpgrUtils Array#together_reduce](#arraytogether_reduceor-treduce-together_inject-tinject)                        |together version of Enumerable#reduce. together_reduce has aliases [:treduce, :together_inject, :tinject]            |
+|[TbpgrUtils Array#together_select](#arraytogether_selector-tselect-together_find_all-tfindall)                     |together version of Enumerable#select. together_select has aliases [:tselect, :together_find_all, :tfindall]         |
+|[TbpgrUtils Array#together_with_index](#arraytogether_with_index)                                                  |loop all arrays by block with index                                                                                  |
+|[AttributesHashable.to_hash](#attributeshashableto_hash)                                                           |define to_hash method for get instance_values                                                                        |
+|[AttributesInitializable::ClassMethods.attr_accessor_init](#attributesinitializableclassmethodsattr_accessor_init) |generate attr_accessor + initializer                                                                                 |
+|[AttributesInitializable::ClassMethods.attr_reader_init](#attributesinitializableclassmethodsattr_reader_init)     |generate attr_reader + initializer                                                                                   |
+|[AttributesInitializable::ClassMethods.attr_writer init](#attributesinitializableclassmethodsattr_writer_init)     |generate attr_writer + initializer                                                                                   |
+|[Ghostable module](#ghostable)                                                                                     |help to create ghost method(dynamic method define by ussing method_missing + pattern-method-name)                    |
+|[TbpgrUtils Kernel#bulk_define_methods](#kernelbulk_define_methods)                                                |define methods to classes. methods have simple return value.                                                         |
+|[TestToolbox Kernel#capture_stdout](#kernelcapture_stdout)                                                         |capture STDOUT                                                                                                       |
+|[TestToolbox Kernel#dp_line](#kerneldp_line)                                                                       |debug print line for print-debugging                                                                                 |
+|[TbpgrUtils Kernel#print_eval](#kernelprint_eval)                                                                  |Print code + eval result                                                                                             |
+|[TbpgrUtils Kernel#puts_eval](#kernelputs_eval)                                                                    |Puts code + eval result                                                                                              |
+|[TbpgrUtils Kernel#bulk_puts_eval](#kernelbulk_puts_eval)                                                          |Puts each-line-code + eval result                                                                                    |
+|[TbpgrUtils Module.alias_methods](#modulealias_methods)                                                            |create alias methods                                                                                                 |
+|[TbpgrUtils Object#any_of?](#objectany_of)                                                                         |if self match any one of items, return true                                                                          |
+|[TbpgrUtils Object#boolean?](#objectboolean)                                                                       |data type check for boolean                                                                                          |
+|[TbpgrUtils Object#my_methods](#objectmy_methods)                                                                  |return public/protected/private self define methods                                                                  |
+|[TbpgrUtils Object#to_bool](#objectto_bool)                                                                        |syntax sugar of !!. convert [false, nil] => fasel, other => true.                                                    |
+|[TbpgrUtils String#justify_table](#stringjustify_table)                                                            |justify pipe format table string                                                                                     |
+|[Templatable module](#templatable)                                                                                 |get result from template + placeholder                                                                               |
+|[TemplateMethodable module](#templatemethodable)                                                                   |for Template Method Pattern                                                                                          |
 
 ### Array#together
 ~~~ruby
@@ -56,6 +57,8 @@ numbers = %w{1 2 3}
 end
 ~~~
 
+[back to list](#list)
+
 ### Array#together_concat
 ~~~ruby
 require 'tbpgr_utils'
@@ -68,6 +71,8 @@ print alpha # => ["one", "two", "three", 4, 5, 6]
 print numbers # => ["1", "2", "3", 4, 5, 6]
 ~~~
 
+[back to list](#list)
+
 ### Array#together_map(or tmap, together_collect, tcollect)
 ~~~ruby
 require 'tbpgr_utils'
@@ -88,6 +93,8 @@ ret = [alpha, numbers].together_map {|first, second|[["#{first}:ret"], ["#{secon
 print ret # => output [["one:ret", "two:ret", "three:ret"],["1:ret", "2:ret", "3:ret"]]
 ~~~
 
+[back to list](#list)
+
 ### Array#together_reduce(or :treduce, :together_inject, :tinject)
 * if you want to single return
 
@@ -134,6 +141,8 @@ ret = [firsts, seconds].together_reduce({}){|memo, first, second|memo[first] = s
 print ret # => output {1=>4, 2=>2, 3=>3, 4=>1}
 ~~~
 
+[back to list](#list)
+
 ### Array#together_select(or tselect, together_find_all, tfindall)
 ~~~ruby
 require 'tbpgr_utils'
@@ -154,6 +163,8 @@ ret = [firsts, seconds].together_select{|first, second|[first.odd?, second.even?
 print ret # => output  [[1, 3], [4, 2]]
 ~~~
 
+[back to list](#list)
+
 ### Array#together_with_index
 ~~~ruby
 require 'tbpgr_utils'
@@ -165,6 +176,32 @@ numbers = %w{1 2 3}
 end
 ~~~
 
+[back to list](#list)
+
+### AttributesHashable.to_hash
+~~~ruby
+require 'attributes_initializable'
+require 'attributes_hashable'
+
+class Hoge
+  include AttributesInitializable
+  attr_accessor_init :hoge, :hige
+  include AttributesHashable
+end
+
+hoge = Hoge.new do |h|
+  h.hoge = 'hoge'
+  h.hige = 'hige'
+end
+
+hoge.to_hash # => {:hoge=>"hoge", :hige=>"hige"}
+
+# After include AttributesHashable, you can use Hash.try_convert.
+Hash.try_convert hoge # => {:hoge=>"hoge", :hige=>"hige"}
+~~~
+
+[back to list](#list)
+
 ### AttributesInitializable::ClassMethods.attr_accessor_init
 ~~~ruby
 require 'attributes_initializable'
@@ -210,6 +247,8 @@ p atr_sample2.atr1 # => atr1
 p atr_sample2.atr2 # => atr2
 ~~~
 
+[back to list](#list)
+
 ### AttributesInitializable::ClassMethods.attr_reader_init
 ~~~ruby
 require 'attributes_initializable'
@@ -253,6 +292,8 @@ p atr_sample1.atr2 # => atr2
 # end
 ~~~
 
+[back to list](#list)
+
 ### AttributesInitializable::ClassMethods.attr_writer_init
 ~~~ruby
 require 'attributes_initializable'
@@ -311,6 +352,8 @@ atr_sample2.instance_variable_get "@atr1" # => atr1
 atr_sample2.instance_variable_get "@atr2" # => atr2
 ~~~
 
+[back to list](#list)
+
 ### Ghostable
 * include Ghostable
 * create ghost method by using Ghostable::ghost_method
@@ -358,6 +401,8 @@ sample.contain_hoge? "test_hige_test" # => return false
 sample.contain_hige? "test_hige_test" # => return true
 ~~~
 
+[back to list](#list)
+
 ### Kernel#capture_stdout
 capture STDOUT to String. This method can use in STDOUT contents test.
 
@@ -370,6 +415,8 @@ result = capture_stdout {puts "test"} # => "test"
 result = capture_stdout {sleep 0.1} # => ""(empty)
 ~~~
 
+[back to list](#list)
+
 ### Kernel#dp_line
 debug print line for print-debugging.
 
@@ -392,6 +439,8 @@ dp_line __LINE__, filename: __FILE__, char: '@'
 # => @@@@@@@@@@@@@@@@@@@@|filename=xx|line=yy$|@@@@@@@@@@@@@@@@@@@@\n
 ~~~
 
+[back to list](#list)
+
 ### Kernel#bulk_define_methods
 Define methods to classes. Methods have simple return value.
 
@@ -441,6 +490,8 @@ class FalseClass
 end
 ~~~
 
+[back to list](#list)
+
 ### Kernel#print_eval
 This method for sample code. for manual, for blog-entry's-snippet  ...etc.
 
@@ -456,6 +507,8 @@ output
 8/4 # => 2"hoge-#{message}" # => "hoge-msg"
 ~~~
 
+[back to list](#list)
+
 ### Kernel#puts_eval
 This method for sample code. for manual, for blog-entry's-snippet  ...etc.
 
@@ -472,6 +525,8 @@ output
 "hoge-#{message}" # => "hoge-msg"
 ~~~
 
+[back to list](#list)
+
 ### Kernel#bulk_puts_eval
 multi line version of puts_eval.
 
@@ -489,6 +544,8 @@ output
 "hoge-hige2" + "add" + message # => "hoge-hige2addmsg"
 ~~~
 
+[back to list](#list)
+
 ### Module.alias_methods
 create alias methods.
 
@@ -522,6 +579,8 @@ class Hoge
 end
 ~~~
 
+[back to list](#list)
+
 ### Object#any_of?
 ~~~ruby
 require 'tbpgr_utils'
@@ -534,6 +593,8 @@ p 1.any_of? 1, 2, 3                # =>true
 p 4.any_of? 1, 2, 3                # =>false
 ~~~
 
+[back to list](#list)
+
 ### Object#boolean?
 ~~~ruby
 require 'tbpgr_utils'
@@ -545,6 +606,8 @@ p "".boolean?      # =>false
 p "true".boolean?  # =>false
 ~~~
 
+[back to list](#list)
+
 ### Object#my_methods
 ~~~ruby
 require 'tbpgr_utils'
@@ -565,6 +628,8 @@ end
 p Hoge.new.my_methods # =>[:hoge, :hige, :hege]
 ~~~
 
+[back to list](#list)
+
 ### Object#to_bool
 ~~~ruby
 require 'tbpgr_utils'
@@ -577,6 +642,8 @@ p nil.to_bool # => false
 p 0.to_bool # => true
 ~~~
 
+[back to list](#list)
+
 ### String#justify_table
 ~~~ruby
 require 'tbpgr_utils'
@@ -597,6 +664,8 @@ output
 |test          |tester|aaaaaaaaaaaaaaaaaaaaaaatestest|
 ~~~
 
+[back to list](#list)
+
 ### Templatable
 * include Templatable
 * set template by here-document
@@ -633,6 +702,8 @@ line1:hoge-sample
 line2:hige-sample
 ~~~
 
+[back to list](#list)
+
 ## TemplateMethodable
 sample usage
 
@@ -695,6 +766,7 @@ if you are Sublime Text2 user, you can use snippet for TbpgrUtils.
 https://github.com/tbpgr/tbpgr_utils_snippets
 
 ## History
+* version 0.0.19 : add AttributesHashable module.
 * version 0.0.18 : add Array#together_concat.  together_concat has alias :tconcat
 * version 0.0.17 : add Array#together_reduce(or :treduce, :together_inject, :tinject)
 * version 0.0.16 : add Array#together_select(or tselect, together_find_all, tfindall)

data/lib/attributes_hashable.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+# implement to_hash(instance_variable_name => key, instance_variable_value => value)
+module AttributesHashable
+  # create hash(instance_variable_name => key, instance_variable_value => value)
+  #
+  # class Hoge have two_attributes(:hoge, :hige)
+  #   class Hoge
+  #     include AttributesInitializable
+  #     attr_accessor_init :hoge, :hige
+  #     include AttributesHashable
+  #   end
+  #
+  #   hoge = Hoge.new do |h|
+  #     h.hoge = 'hoge'
+  #     h.hige = 'hige'
+  #   end
+  #
+  #   hoge.to_hash # => {:hoge=>"hoge", :hige=>"hige"}
+  #
+  # After include AttributesHashable, you can use Hash.try_convert.
+  #   Hash.try_convert hoge # => {:hoge=>"hoge", :hige=>"hige"}
+  def to_hash
+    instance_variables.reduce({}) do |hash, var|
+      hash[var.to_s.delete('@').to_sym] = instance_variable_get(var)
+      hash
+    end
+  end
+end

data/lib/attributes_initializable.rb

@@ -56,7 +56,6 @@ module AttributesInitializable
       instance_eval do
         define_method :initialize do |values = nil, &block|
           return block.call self if block
-          # symbols.each { |symbol|send("#{symbol.to_s}=", values[symbol]) }
           symbols.each { |symbol|instance_variable_set("@#{symbol.to_s}", values[symbol]) }
         end
       end

data/lib/tbpgr_utils/version.rb

@@ -2,5 +2,5 @@
 
 # Tbpgr Utilities
 module TbpgrUtils
-  VERSION = '0.0.18'
+  VERSION = '0.0.19'
 end

data/spec/attributes_hashable_spec.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'attributes_hashable'
+require 'attributes_initializable'
+
+describe AttributesHashable do
+  context :to_hash do
+    class AttributesHashableHoge
+      include AttributesInitializable
+      attr_accessor_init :hoge, :hige
+      include AttributesHashable
+    end
+
+    class NoAttributeHoge
+      include AttributesHashable
+    end
+
+    cases = [
+      {
+        case_no: 1,
+        case_title: '2 attributes case',
+        klass: AttributesHashableHoge,
+        expected: { hoge: 'hoge', hige: 'hige' }
+      },
+      {
+        case_no: 2,
+        case_title: 'no attribute case',
+        klass: NoAttributeHoge,
+        expected: {}
+      },
+    ]
+
+    cases.each do |c|
+      it "|case_no=#{c[:case_no]}|case_title=#{c[:case_title]}" do
+        begin
+          case_before c
+
+          # -- given --
+          instance = c[:klass].new do |k|
+            k.hoge = 'hoge'
+            k.hige = 'hige'
+          end
+
+          # -- when --
+          actual = instance.to_hash
+
+          # -- then --
+          expect(actual).to eq(c[:expected])
+        ensure
+          case_after c
+        end
+      end
+
+      def case_before(c)
+        # implement each case before
+      end
+
+      def case_after(c)
+        # implement each case after
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tbpgr_utils
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-25 00:00:00.000000000 Z
+date: 2014-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &28417764 !ruby/object:Gem::Requirement
+  requirement: &21860136 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 4.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *28417764
+  version_requirements: *21860136
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &28414692 !ruby/object:Gem::Requirement
+  requirement: &21859524 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *28414692
+  version_requirements: *21859524
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &28414140 !ruby/object:Gem::Requirement
+  requirement: &21859044 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *28414140
+  version_requirements: *21859044
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &28434732 !ruby/object:Gem::Requirement
+  requirement: &21858420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 2.14.1
   type: :development
   prerelease: false
-  version_requirements: *28434732
+  version_requirements: *21858420
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &28432356 !ruby/object:Gem::Requirement
+  requirement: &21857544 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: 0.8.2
   type: :development
   prerelease: false
-  version_requirements: *28432356
+  version_requirements: *21857544
 description: Utilities
 email:
 - tbpgr@tbpgr.jp
@@ -79,6 +79,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/attributes_hashable.rb
 - lib/attributes_initializable.rb
 - lib/ghostable.rb
 - lib/open_classes/array.rb
@@ -92,6 +93,7 @@ files:
 - lib/template_methodable.rb
 - lib/test_toolbox.rb
 - lib/test_toolbox/kernel.rb
+- spec/attributes_hashable_spec.rb
 - spec/attributes_initializable_spec.rb
 - spec/ghostable_spec.rb
 - spec/open_classes/array_spec.rb
@@ -130,6 +132,7 @@ signing_key:
 specification_version: 3
 summary: Utilities
 test_files:
+- spec/attributes_hashable_spec.rb
 - spec/attributes_initializable_spec.rb
 - spec/ghostable_spec.rb
 - spec/open_classes/array_spec.rb