simple-printer 0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8d89abf8ff83bbe41f913625df7dad960f6514d2687ef46a74430fbe77a2e661
+  data.tar.gz: bca76d47d03b09f140acf897b55f62c8d97a8a4edeb77a524ab1e3ecff073224
+SHA512:
+  metadata.gz: 2aa0b274470e167818a93d7d3bef82adebed21662ee057a9b8fc2b57cc864f288e87aa9890b47eee681c0031205cc3461bf8abd2c96ac7c916d3eeaeec04c91a
+  data.tar.gz: 62b74812de8b3f78fc7a1ee79117c3e5fa8525a9b403617c4eaae56db0237ff4bed4c59debd041f4c2748b25acdcccabbab8e9d3f9c17e2ce39a7de2e8936141

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+Gemfile.lock
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1 @@
+FIXME

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+Bundler.require
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/*_test.rb']
+end
+
+task :default => :test

data/lib/simple-printer.rb

@@ -0,0 +1,103 @@
+require 'stringio'
+
+module Simple
+
+  class Printer
+
+    def self.print(*fields, **params)
+      new(fields).print(**params)
+    end
+
+    def initialize(fields)
+      @fields = fields.map { |s| Field.make(spec: s) }
+    end
+
+    def print(output: STDOUT, indent: 0)
+      output ||= StringIO.new
+      max_label_width = @fields.map { |f| f.label.length }.max
+      @fields.each do |field|
+        output.puts '%s%*s:%s' % [
+          ' ' * indent,
+          max_label_width,
+          field.label,
+          field.value.nil? ? '' : " #{field.value}",
+        ]
+        if field.children
+          field.children.each_with_index do |o, i|
+            output.puts if i > 0
+            o.print(output: output, indent: indent + 2 + max_label_width)
+          end
+        end
+      end
+      if output.kind_of?(StringIO)
+        output.rewind
+        output.read
+      else
+        nil
+      end
+    end
+
+    class Field
+
+      attr_accessor :key
+      attr_accessor :label
+      attr_accessor :value
+      attr_accessor :children
+
+      def self.make(spec:, object: nil)
+        return spec if spec.kind_of?(Field)
+        Field.new.tap do |field|
+          case spec
+          when Symbol
+            field.key = spec
+          when Array
+            spec = spec.dup
+            field.key = spec.shift if spec.first.kind_of?(Symbol)
+            field.label = spec.shift if spec.first.kind_of?(String)
+            case (v = spec.shift)
+            when Array
+              field.children = v
+            else
+              field.value = v
+            end
+          when Hash
+            field.key, field.label, field.value, field.children = spec[:key], spec[:label], spec[:value], spec[:children]
+          else
+            raise "Unknown field specification: #{spec.inspect}"
+          end
+          if field.key
+            field.label ||= field.key.to_s.tr('_', ' ').capitalize
+            if field.value.nil?
+              raise "No object specified" unless object
+              v = object.send(field.key)
+              if v.kind_of?(Array)
+                field.children = v
+              else
+                field.value = v
+              end
+            end
+          end
+        end
+      end
+
+      def initialize(params={})
+        params.each { |k, v| send("#{k}=", v) }
+      end
+
+    end
+
+    module Printable
+
+      def printable
+        []
+      end
+
+      def print(**params)
+        Printer.new(printable.map { |s| Field.make(spec: s, object: self) }).print(**params)
+      end
+
+    end
+
+  end
+
+end

data/simple-printer.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name          = 'simple-printer'
+  s.version       = '0.3'
+  s.summary       = 'Print objects easier'
+  s.author        = 'John Labovitz'
+  s.email         = 'johnl@johnlabovitz.com'
+  s.description   = %q{
+    Simple::Printer makes it easier to print objects.
+  }.strip
+  s.license       = 'MIT'
+  s.homepage      = 'http://github.com/jslabovitz/simple-printer'
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_path  = 'lib'
+
+  s.add_development_dependency 'bundler', '~> 2.5'
+  s.add_development_dependency 'minitest', '~> 5.22'
+  s.add_development_dependency 'minitest-power_assert', '~> 0.3'
+  s.add_development_dependency 'rake', '~> 13.2'
+
+end

data/test/printer_test.rb

@@ -0,0 +1,128 @@
+require 'minitest/autorun'
+require 'minitest/power_assert'
+
+require 'simple-printer'
+
+class Test < Minitest::Test
+
+  class A
+
+    attr_accessor :x
+    attr_accessor :y
+
+    include Simple::Printer::Printable
+
+    def initialize
+      @x = 'x'
+      @y = 'y'
+    end
+
+    def printable
+      [
+        :x,
+        [:y, 'Y', @y],
+      ]
+    end
+
+  end
+
+  class B < A
+
+    attr_accessor :z
+
+    def initialize
+      super
+      @z = 'z'
+    end
+
+    def printable
+      super + [
+        Simple::Printer::Field.new(key: :z, label: 'Z', value: @z),
+      ]
+    end
+
+  end
+
+  class D
+
+    attr_accessor :d
+
+    include Simple::Printer::Printable
+
+    def initialize
+      @d = 'd'
+    end
+
+    def printable
+      [
+        :d,
+      ]
+    end
+
+  end
+
+  class C < A
+
+    attr_accessor :d
+
+    def initialize
+      super
+      @d = 3.times.map { D.new }
+    end
+
+    def printable
+      super + [:d]
+    end
+
+  end
+
+  def test_simple
+    a = A.new
+    output = a.print(output: nil)
+    expected_output = <<~END
+      X: x
+      Y: y
+    END
+    assert { output == expected_output }
+  end
+
+  def test_inherited
+    b = B.new
+    output = b.print(output: nil)
+    expected_output = <<~END
+      X: x
+      Y: y
+      Z: z
+    END
+    assert { output == expected_output }
+  end
+
+  def test_nested
+    c = C.new
+    output = c.print(output: nil)
+    expected_output = <<~END
+      X: x
+      Y: y
+      D:
+         D: d
+
+         D: d
+
+         D: d
+    END
+    assert { output == expected_output }
+  end
+
+  def test_standalone
+    output = Simple::Printer.print(
+      ['Foo', 'foo'],
+      ['Bar', 2],
+      output: nil)
+    expected_output = <<~END
+      Foo: foo
+      Bar: 2
+    END
+    assert { output == expected_output }
+  end
+
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: simple-printer
+version: !ruby/object:Gem::Version
+  version: '0.3'
+platform: ruby
+authors:
+- John Labovitz
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.22'
+- !ruby/object:Gem::Dependency
+  name: minitest-power_assert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+description: Simple::Printer makes it easier to print objects.
+email: johnl@johnlabovitz.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- lib/simple-printer.rb
+- simple-printer.gemspec
+- test/printer_test.rb
+homepage: http://github.com/jslabovitz/simple-printer
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.10
+signing_key:
+specification_version: 4
+summary: Print objects easier
+test_files:
+- test/printer_test.rb