debug_helper 1.0.0

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "debug_helper"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/debug_helper.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "debug_helper/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "debug_helper"
+  spec.version       = DebugHelper::VERSION
+  spec.authors       = ["burdettelamar"]
+  spec.email         = ["burdettelamar@yahoo.com"]
+
+  spec.summary       = %q{Help for printf-style debugging.}
+  spec.homepage      = "https://github.com/BurdetteLamar/debug_helper"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/debug_helper.rb

@@ -0,0 +1,154 @@
+require 'yaml'
+
+require 'debug_helper/version'
+
+class DebugHelper
+
+  attr_accessor \
+      :obj,
+      :name,
+      :object_ids
+
+  def self.show(obj, name = obj.class)
+    debug_helper = DebugHelper.new(obj, name)
+    x = debug_helper.send(:_show, obj, name, info = {})
+    puts x.to_yaml
+  end
+
+  private
+
+  def initialize(obj, name)
+    self.obj = obj
+    self.name = name
+    self.object_ids = []
+  end
+
+  def _show(obj, name, info)
+    if object_ids.include?(obj.object_id)
+      s = show_object(obj, name, info)
+    else
+      object_ids.push(obj.object_id)
+      s = case
+            when obj.kind_of?(Array)
+              show_array(obj, name, info)
+            when obj.kind_of?(Hash)
+              show_hash(obj, name, info)
+            when obj.kind_of?(String)
+              show_string(obj, name, info)
+            when obj.kind_of?(Struct)
+              show_struct(obj, name, info)
+            when obj.kind_of?(Symbol)
+              show_symbol(obj, name, info)
+            # when obj.kind_of?(Range)
+            # when obj.kind_of?(Set)
+            else
+              show_object(obj, name, info)
+          end
+    end
+    object_ids.pop
+    s
+  end
+
+  def show_array(obj, name, info)
+    content = {}
+    obj.each_with_index do |item, i|
+      content.store("Element #{i}", _show(item, nil, {}))
+    end
+    attrs = {
+        :name => name,
+        :size => obj.size,
+    }
+    _show_item(obj.class.name, content, attrs, info)
+  end
+
+  def show_hash(obj, name, info)
+    content = {}
+    obj.each_with_index do |pair, i|
+      key, value = *pair
+      pair = {'Key' => _show(key, nil, {}), 'Value' => _show(value, nil, {})}
+      content.store("Pair #{i}", pair)
+    end
+    attrs = {
+        :size => obj.size,
+        :default => obj.default,
+        :default_proc => obj.default_proc,
+        :name => name,
+    }
+    _show_item(obj.class.name, content, attrs, info)
+  end
+
+  def show_object(obj, name, info)
+    name_info = name.nil? ? '' : " (name='#{name}')"
+    "#{obj.class.name}#{name_info} #{obj}"
+  end
+
+  def show_string(obj, name, info)
+    attrs = {
+        :name => name,
+        :size => obj.size,
+        :encoding => obj.encoding,
+        :ascii_only => obj.ascii_only?,
+        :bytesize => obj.bytesize,
+    }
+    _show_item(obj.class.name, [obj], attrs, info)
+  end
+
+  def show_struct(obj, name, info)
+    content = {}
+    i = 0
+    obj.each_pair do |member|
+      member_name, value = *member
+      pair = {'Name' => member_name, 'Value' => _show(value, nil, {})}
+      content.store("Member #{i}", pair)
+      i += 1
+    end
+    attrs = {
+        :name => name,
+        :size => obj.size,
+    }
+    _show_item(obj.class.name, content, attrs, info)
+  end
+
+  def show_symbol(obj, name, info)
+    attrs = {
+        :name => name,
+        :size => obj.size,
+        :encoding => obj.encoding,
+    }
+    _show_item(obj.class.name, obj, attrs, info)
+  end
+
+  def _show_item(class_name, content, attrs, info)
+    name = attrs[:name]
+    unless name.nil?
+      attrs[:name] = "'#{name}'"
+    end
+    label = label(class_name, attrs)
+    info.store(label, content)
+    info
+  end
+
+  def label(class_name, attrs)
+    a = []
+    attrs.each_pair do |key, value|
+      a.push("#{key}=#{value}") unless value.nil?
+    end
+    attrs_s = a.join(' ')
+    "#{class_name} (#{attrs_s})"
+  end
+
+  # def respond_to!(obj, method)
+  #   unless obj.respond_to?(method)
+  #     message = "Instance of #{obj.class.name} does not respond to :#{method}"
+  #     raise ArgumentError.new(message)
+  #   end
+  # end
+  #
+  # def kind_of!(obj, klass)
+  #   unless obj.kind_of?(klass)
+  #     message = "Instance of #{obj.class.name} is not a kind of #{klass}"
+  #     raise ArgumentError.new(message)
+  #   end
+  # end
+
+end

data/lib/debug_helper/version.rb

@@ -0,0 +1,3 @@
+class DebugHelper
+  VERSION = "1.0.0"
+end

data/markdown/readme/Rakefile

@@ -0,0 +1,53 @@
+require 'markdown_helper'
+
+namespace :build do
+
+  desc 'Build README.md'
+  task :readme do
+    # Make output files.
+    class_dir_names = nil
+    Dir.chdir('classes') do
+      class_names = %w/
+        Array
+        Hash
+        Struct
+        String
+        Symbol
+        Object
+      /
+      class_dir_names = class_names.collect {|x| x.downcase}
+      class_dir_names.each do |class_dir_name|
+        Dir.chdir(class_dir_name) do
+          case_dir_names = Dir.glob('*').select {|f| File.directory? f}
+          case_dir_names.each do |case_dir_name|
+            Dir.chdir(case_dir_name) do
+              command = "ruby show.rb > show.yaml"
+              system(command)
+              command = "markdown_helper include --pristine template.md show.md"
+              system(command)
+            end
+          end
+        end
+      end
+    end
+    # Make list of links to class sections.
+    File.open('class_links.md', 'w') do |file|
+      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})"
+        file.puts(link_line)
+      end
+    end
+    # Make inclusions for class sections.
+    File.open('class_inclusions.md', 'w') do |file|
+      class_dir_names.each do |class_name|
+        inclusion_line = "@[:markdown](classes/#{class_name}/template.md)"
+        file.puts(inclusion_line)
+      end
+    end
+    # Make the README markdown.
+    command = "markdown_helper include --pristine template.md ../../README.md"
+    system(command)
+  end
+end

data/markdown/readme/class_inclusions.md

@@ -0,0 +1,6 @@
+@[:markdown](classes/array/template.md)
+@[:markdown](classes/hash/template.md)
+@[:markdown](classes/struct/template.md)
+@[:markdown](classes/string/template.md)
+@[:markdown](classes/symbol/template.md)
+@[:markdown](classes/object/template.md)

data/markdown/readme/class_links.md

@@ -0,0 +1,5 @@
+- [Array](#array)
+- [Hash](#hash)
+- [Struct](#struct)
+- [String](#string)
+- [Symbol](#symbol)

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

@@ -0,0 +1,27 @@
+#### Circular Arrays
+
+This example shows arrays that make a circular reference.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+ary_0 = []
+ary_1 = []
+ary_0.push(ary_1)
+ary_1.push(ary_0)
+DebugHelper.show(ary_0, 'My circular arrays')
+```
+
+The output shows details of the arrays.
+
+The circular reference is not followed.
+
+```show.yaml```:
+```yaml
+---
+Array (name='My circular arrays' size=1):
+  Element 0:
+    Array (size=1):
+      Element 0: Array [[[...]]]
+```

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

@@ -0,0 +1,7 @@
+require 'debug_helper'
+
+ary_0 = []
+ary_1 = []
+ary_0.push(ary_1)
+ary_1.push(ary_0)
+DebugHelper.show(ary_0, 'My circular arrays')

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

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

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

@@ -0,0 +1,11 @@
+#### Circular Arrays
+
+This example shows arrays that make a circular reference.
+
+@[ruby](show.rb)
+
+The output shows details of the arrays.
+
+The circular reference is not followed.
+
+@[yaml](show.yaml)

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

@@ -0,0 +1,25 @@
+#### Mixed Array
+
+This example shows an array of mixed values.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+ary = [0, 'one', :two]
+DebugHelper.show(ary, 'My mixed array')
+```
+
+The output shows details of the array.
+
+```show.yaml```:
+```yaml
+---
+Array (name='My mixed array' size=3):
+  Element 0: Fixnum 0
+  Element 1:
+    String (size=3 encoding=UTF-8 ascii_only=true bytesize=3):
+    - one
+  Element 2:
+    Symbol (size=3 encoding=US-ASCII): :two
+```

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

@@ -0,0 +1,4 @@
+require 'debug_helper'
+
+ary = [0, 'one', :two]
+DebugHelper.show(ary, 'My mixed array')

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

@@ -0,0 +1,8 @@
+---
+Array (name='My mixed array' size=3):
+  Element 0: Fixnum 0
+  Element 1:
+    String (size=3 encoding=UTF-8 ascii_only=true bytesize=3):
+    - one
+  Element 2:
+    Symbol (size=3 encoding=US-ASCII): :two

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

@@ -0,0 +1,9 @@
+#### Mixed Array
+
+This example shows an array of mixed values.
+
+@[ruby](show.rb)
+
+The output shows details of the array.
+
+@[yaml](show.yaml)

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

@@ -0,0 +1,28 @@
+#### Nested Arrays
+
+This example shows nested arrays.
+
+```show.rb```:
+```ruby
+require 'debug_helper'
+
+ary = [0, [1, 2], [3, 4]]
+DebugHelper.show(ary, 'My nested arrays')
+```
+
+The output shows details of the arrays.
+
+```show.yaml```:
+```yaml
+---
+Array (name='My nested arrays' size=3):
+  Element 0: Fixnum 0
+  Element 1:
+    Array (size=2):
+      Element 0: Fixnum 1
+      Element 1: Fixnum 2
+  Element 2:
+    Array (size=2):
+      Element 0: Fixnum 3
+      Element 1: Fixnum 4
+```