debug_helper 1.7.0 → 1.8.0

data/lib/debug_helper/hash_handler.rb

@@ -0,0 +1,19 @@
+class DebugHelper
+
+  class HashHandler < EachPairHandler
+
+    def calls_for_instance
+      [
+          [:size],
+          [:default],
+          [:default_proc],
+      ]
+    end
+    def show
+      self.pair_names = %w/Pair Key Value/
+      super
+    end
+
+  end
+
+end

data/lib/debug_helper/io_handler.rb

@@ -0,0 +1,15 @@
+class DebugHelper
+
+  class IOHandler < Handler
+
+    def calls_for_instance
+      [
+          [:autoclose?],
+          [:binmode?],
+          [:closed?],
+          [:tty?],
+      ]
+    end
+  end
+
+end

data/lib/debug_helper/match_data_handler.rb

@@ -0,0 +1,17 @@
+class DebugHelper
+
+  class MatchDataHandler < Handler
+
+    def calls_for_instance
+      [
+          [:size],
+          [:regexp],
+          [:to_a],
+          [:captures],
+          [:names],
+      ]
+    end
+
+  end
+
+end

data/lib/debug_helper/object_handler.rb

@@ -0,0 +1,13 @@
+class DebugHelper
+
+  class ObjectHandler < Handler
+
+    def calls_for_instance
+      [
+          [:object_id],
+      ]
+    end
+
+  end
+
+end

data/lib/debug_helper/open_struct_handler.rb

@@ -0,0 +1,16 @@
+class DebugHelper
+
+  class OpenStructHandler < EachPairHandler
+
+    def show
+      self.pair_names = %w/Member Name Value/
+      super
+    end
+
+    def each_pair?
+      true
+    end
+
+  end
+
+end

data/lib/debug_helper/range_handler.rb

@@ -0,0 +1,14 @@
+class DebugHelper
+
+  class RangeHandler < Handler
+
+    def calls_for_instance
+      [
+          [:first],
+          [:last],
+          [:exclude_end?],
+      ]
+    end
+
+  end
+end

data/lib/debug_helper/regexp_handler.rb

@@ -0,0 +1,16 @@
+class DebugHelper
+
+  class RegexpHandler < Handler
+
+    def calls_for_instance
+      [
+          [:to_s],
+          [:casefold?],
+          [:named_captures],
+          [:encoding],
+          [:fixed_encoding?],
+      ]
+    end
+
+  end
+end

data/lib/debug_helper/set_handler.rb

@@ -0,0 +1,12 @@
+class DebugHelper
+
+  class SetHandler < EachWithIndexHandler
+
+    def calls_for_instance
+      [
+          [:size],
+      ]
+    end
+
+  end
+end

data/lib/debug_helper/string_handler.rb

@@ -0,0 +1,17 @@
+class DebugHelper
+
+  class StringHandler < Handler
+
+    def calls_for_instance
+      [
+          [:to_s],
+          [:size],
+          [:encoding],
+          [:ascii_only?],
+          [:bytesize],
+      ]
+    end
+
+  end
+
+end

data/lib/debug_helper/struct_handler.rb

@@ -0,0 +1,18 @@
+class DebugHelper
+
+  class StructHandler < EachPairHandler
+
+    def calls_for_instance
+      [
+          [:size],
+      ]
+    end
+
+    def show
+      self.pair_names = %w/Member Name Value/
+      super
+    end
+
+  end
+
+end

data/lib/debug_helper/symbol_handler.rb

@@ -0,0 +1,15 @@
+class DebugHelper
+
+  class SymbolHandler < Handler
+
+    def calls_for_instance
+      [
+          [:to_s],
+          [:size],
+          [:encoding],
+      ]
+    end
+
+  end
+
+end

data/lib/debug_helper/version.rb

@@ -1,3 +1,3 @@
-class DebugHelper
-  VERSION = "1.7.0"
-end
+class DebugHelper
+  VERSION = "1.8.0"
+end

data/markdown/readme/Rakefile

@@ -1,3 +1,4 @@
+require 'debug_helper'
 require 'markdown_helper'
 
 namespace :build do
@@ -15,15 +16,35 @@ namespace :build do
     Dir.chdir('classes') do
       class_names = %w/
         Array
+        Dir
+        Exception
+        File
         Hash
-        Struct
+        IO
+        MatchData
+        OpenStruct
+        Range
+        Regexp
+        Set
         String
+        Struct
         Symbol
-        File
-        Set
         Object
       /
-      class_dir_names = class_names.collect {|x| x.downcase}
+      class_dir_names = []
+      correct_dir_names = {
+          :IO => 'io',
+          :MatchData => 'match_data',
+          :OpenStruct => 'open_struct',
+      }
+      class_names.each do |class_name|
+        if correct_dir_names.include?(class_name.to_sym)
+          class_dir_name = correct_dir_names.fetch(class_name.to_sym)
+        else
+          class_dir_name = class_name.downcase
+        end
+        class_dir_names.push(class_dir_name)
+      end
       class_dir_names.each do |class_dir_name|
         Dir.chdir(class_dir_name) do
           case_dir_names = Dir.glob('*').select {|f| File.directory? f}
@@ -40,10 +61,19 @@ namespace :build do
     end
     # Make list of links to class sections.
     File.open('class_links.md', 'w') do |file|
+      correct_class_names = {
+          :io => 'IO',
+          :match_data => 'MatchData',
+          :open_struct => 'OpenStruct',
+      }
       class_dir_names.each do |class_dir_name|
         next if class_dir_name == 'object'
-        proper_class_name = class_dir_name.capitalize
-        link_line = "- [#{proper_class_name}](##{class_dir_name})"
+        if correct_class_names.include?(class_dir_name.to_sym)
+          class_name = correct_class_names.fetch(class_dir_name.to_sym)
+        else
+          class_name = class_dir_name.capitalize
+        end
+        link_line = "- [#{class_name}](##{class_name.downcase})"
         file.puts(link_line)
       end
     end

data/markdown/readme/class_inclusions.md

@@ -1,8 +1,15 @@
 @[:markdown](classes/array/template.md)
+@[:markdown](classes/dir/template.md)
+@[:markdown](classes/exception/template.md)
+@[:markdown](classes/file/template.md)
 @[:markdown](classes/hash/template.md)
-@[:markdown](classes/struct/template.md)
+@[:markdown](classes/io/template.md)
+@[:markdown](classes/match_data/template.md)
+@[:markdown](classes/open_struct/template.md)
+@[:markdown](classes/range/template.md)
+@[:markdown](classes/regexp/template.md)
+@[:markdown](classes/set/template.md)
 @[:markdown](classes/string/template.md)
+@[:markdown](classes/struct/template.md)
 @[:markdown](classes/symbol/template.md)
-@[:markdown](classes/file/template.md)
-@[:markdown](classes/set/template.md)
 @[:markdown](classes/object/template.md)

data/markdown/readme/class_links.md

@@ -1,7 +1,14 @@
 - [Array](#array)
+- [Dir](#dir)
+- [Exception](#exception)
+- [File](#file)
 - [Hash](#hash)
-- [Struct](#struct)
+- [IO](#io)
+- [MatchData](#matchdata)
+- [OpenStruct](#openstruct)
+- [Range](#range)
+- [Regexp](#regexp)
+- [Set](#set)
 - [String](#string)
+- [Struct](#struct)
 - [Symbol](#symbol)
-- [File](#file)
-- [Set](#set)

data/markdown/readme/classes/array/circular/show.md

@@ -20,8 +20,10 @@ The circular reference is not followed.
 ```show.yaml```:
 ```yaml
 ---
-Array (message='My circular arrays' size=1):
+Array (message='My circular arrays'):
+  size: 1
   Element 0:
-    Array (size=1):
+    Array:
+      size: 1
       Element 0: Array [[[...]]]
 ```

data/markdown/readme/classes/array/circular/show.yaml

@@ -1,5 +1,7 @@
 ---
-Array (message='My circular arrays' size=1):
+Array (message='My circular arrays'):
+  size: 1
   Element 0:
-    Array (size=1):
+    Array:
+      size: 1
       Element 0: Array [[[...]]]

data/markdown/readme/classes/array/mixed/show.md

@@ -15,16 +15,19 @@ The output shows details of the array.
 ```show.yaml```:
 ```yaml
 ---
-Array (message='My mixed array' size=3):
+Array (message='My mixed array'):
+  size: 3
   Element 0: Fixnum 0
   Element 1:
-    String (size=3):
+    String:
       to_s: one
+      size: 3
       encoding: !ruby/encoding UTF-8
       ascii_only?: true
       bytesize: 3
   Element 2:
-    Symbol (size=3):
+    Symbol:
       to_s: two
+      size: 3
       encoding: !ruby/encoding US-ASCII
 ```

data/markdown/readme/classes/array/mixed/show.yaml

@@ -1,13 +1,16 @@
 ---
-Array (message='My mixed array' size=3):
+Array (message='My mixed array'):
+  size: 3
   Element 0: Fixnum 0
   Element 1:
-    String (size=3):
+    String:
       to_s: one
+      size: 3
       encoding: !ruby/encoding UTF-8
       ascii_only?: true
       bytesize: 3
   Element 2:
-    Symbol (size=3):
+    Symbol:
       to_s: two
+      size: 3
       encoding: !ruby/encoding US-ASCII

data/markdown/readme/classes/array/nested/show.md

@@ -15,14 +15,17 @@ The output shows details of the arrays.
 ```show.yaml```:
 ```yaml
 ---
-Array (message='My nested arrays' size=3):
+Array (message='My nested arrays'):
+  size: 3
   Element 0: Fixnum 0
   Element 1:
-    Array (size=2):
+    Array:
+      size: 2
       Element 0: Fixnum 1
       Element 1: Fixnum 2
   Element 2:
-    Array (size=2):
+    Array:
+      size: 2
       Element 0: Fixnum 3
       Element 1: Fixnum 4
 ```

data/markdown/readme/classes/array/nested/show.yaml

@@ -1,11 +1,14 @@
 ---
-Array (message='My nested arrays' size=3):
+Array (message='My nested arrays'):
+  size: 3
   Element 0: Fixnum 0
   Element 1:
-    Array (size=2):
+    Array:
+      size: 2
       Element 0: Fixnum 1
       Element 1: Fixnum 2
   Element 2:
-    Array (size=2):
+    Array:
+      size: 2
       Element 0: Fixnum 3
       Element 1: Fixnum 4

data/markdown/readme/classes/array/simple/show.md

@@ -15,7 +15,8 @@ The output shows details of the array.
 ```show.yaml```:
 ```yaml
 ---
-Array (message='My simple array' size=3):
+Array (message='My simple array'):
+  size: 3
   Element 0: Fixnum 5
   Element 1: Fixnum 10
   Element 2: Fixnum 15

data/markdown/readme/classes/array/simple/show.yaml

@@ -1,5 +1,6 @@
 ---
-Array (message='My simple array' size=3):
+Array (message='My simple array'):
+  size: 3
   Element 0: Fixnum 5
   Element 1: Fixnum 10
   Element 2: Fixnum 15

data/markdown/readme/classes/dir/simple/show.md

@@ -0,0 +1,28 @@
+#### Simple Dir
+
+This example shows a simple ```Dir```.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+dir = Dir.new(File.dirname(__FILE__))
+DebugHelper.show(dir, 'My simple dir')
+```
+
+The output shows details of the ```Dir```.
+
+```show.yaml```:
+```yaml
+---
+Dir (message='My simple dir'):
+  path: "."
+  entries:
+  - "."
+  - ".."
+  - show.md
+  - show.rb
+  - show.yaml
+  - template.md
+  exist?: true
+```