dumps 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1a4b720e24a2952ef166ad9407bdc99f918af21b5388511f910f925868a4595b
+  data.tar.gz: c072c9f8dbd1f541ed9a1f9a5505bba2835a4b8d865014738f66bd54fd6877b8
+SHA512:
+  metadata.gz: 923e4d7998498c73e8307b69e5b4281e676821e0518d98d899dbe05fd3c9caddf75308b0796b39bd5afa0e2b043a2ab74d80603cc1238af642f3a2925428eada
+  data.tar.gz: cfaa9a583c2d4a833accb900315a8e5f741e93775ea82cb5475d4cd88db38a3e34aaf0cee1168682e323c65b51959da8f10e49a6ff6cbbc13c3ffe8cf246f12c

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.1.2

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in dump.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Claus Rasmussen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# Dump
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/dump`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/dump.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/TODO

@@ -0,0 +1,10 @@
+
+o Allow "*" or :* as an exclude/DUMP_EXCLUDE argument that wipes the inherited
+  list of attributes. Then remove DUMP_NEW
+o Allow multi-level attribute lists: ":a, { b: [:c] }, :d"
+o Have class included in a: { sub: { subsub: { ... } }:
+    a: (Klass)
+      a: (SubKlass)
+        a: (SubSubKlass)
+o Consider switching to using StringIO everywhere. Can cost a lot of
+  performance but simplifies the implementation

data/lib/dumps/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Dumps
+  VERSION = "1.0.0"
+end

data/lib/dumps.rb

@@ -0,0 +1,261 @@
+# frozen_string_literal: true
+
+require_relative "dumps/version"
+
+require 'indented_io'
+require 'constrain'
+include Constrain
+
+module Dumps
+  def self.dp(object) = $stderr.puts object.inspect
+  def self.dputs(object = "") = $stderr.puts object
+
+  # Enable/disable time zone in timestamps. Default is disabled
+  def self.timezone=(b)
+    constrain b, TrueClass, FalseClass
+    @@timezone = b
+  end
+
+  # Returns the current time
+  def self.timezone? = @@timezone
+
+  # The eponymic method of the Dumps module. It is actually just a method for
+  # the lazy developer in the tcase where dumps should be seperated by a blank
+  # line to enhance readability
+  def self.dumps(...) dump(...); puts end
+
+  # :call-seq:
+  #   dump(object, label|ident|index|range..., new: false, exclude: nil)
+  #
+  # ::dump also supports an :index option but it is only meant to be used
+  # internally
+  #
+  def self.dump(object, *args, **opts)
+    constrain args, [String, Symbol, Integer, Range, nil]
+    constrain object.is_a?(Dumps) || opts.slice(:new, :exclude).empty?, true
+    label = args.select { |arg| arg.nil? || arg.is_a?(String) }.last
+    idents = args.select { |arg| arg.is_a?(Symbol) }
+    indexes = args.select { |arg| arg.is_a?(Integer) || arg.is_a?(Range) }
+    idents.empty? || indexes.empty? or raise ArgumentError, "Symbols and Integers can't be combined"
+    
+    # Register if this is an anonymous top-level call to ::dump (ie. the first
+    # #dump method to be called from the application)
+    self.anonymous = label.nil? if empty?
+
+    case object
+      when Array; dump_array(object, label, *indexes)
+      when Hash; dump_hash(object, label, *idents)
+      when Dumps; dump_object(object, label, *idents, **opts)
+    else
+      idents.empty? or raise ArgumentError
+      Dumps.dump_label(label, false); dump_value(object)
+    end
+  end
+
+  def self.dump_label(label, newline = true)
+    constrain label, String, nil
+    print "#{label}:#{newline ? "\n" : " "}" if label
+  end
+
+  def self.dump_array(array, label, *indexes, **opts)
+    constrain array, Array
+    constrain indexes, [Integer, Range]
+    indexes = 
+        if indexes.empty?
+          array.each_index
+        else
+          indexes.map { |e|
+            e.is_a?(Range) ? e.each.to_a : e
+          }.flatten
+        end
+    context(array, label, **opts) {
+      dump_label(label)
+      level = label ? 1 : 0
+      indent(level) { 
+        indexes.each { |i| print "- "; indent(bol: false) { dump(array[i], index: i) } }
+      }
+    }
+  end
+
+  def self.dump_hash(hash, label, *idents, **opts)
+    constrain hash, Hash
+    constrain idents, [Symbol]
+    keys = idents.empty? ? hash.keys : idents
+    context(hash, label, **opts) {
+      dump_label(label)
+      level = label ? 1 : 0
+      indent(level) { 
+        keys.each { |key| dump(hash[key], key.to_s) }
+      }
+    }
+  end
+
+  def self.dump_object(object, label, *idents, new: false, exclude: nil, **opts)
+    constrain object, Dumps
+    constrain label, String, nil
+    constrain idents, [Symbol]
+    constrain new, false, true
+    constrain exclude, nil, [Symbol]
+    idents = (new ? [] : object.class.dump_identifiers) \
+           + idents \
+           - (exclude.nil? ? [] : exclude)
+    idents.uniq!
+    if idents.empty?
+      context(object, label, **opts) { dump_label(label, false); dump_id(object) }
+    else
+      context(object, label, **opts) {
+        dump_label(label)
+        level = label ? 1 : 0
+        indent(level) {
+          idents.each { |ident|
+            attr_method = :"dump_attr_#{ident}"
+            value_method = :"dump_value_#{ident}"
+
+            if overrides?(object, attr_method)
+              object.send(attr_method)
+            elsif overrides?(object, :dump_attr)
+              object.send(:dump_attr, ident)
+            elsif overrides?(object, value_method)
+              value = capture { object.send(value_method) }
+              newline = value =~ /\n./
+              dump_label(ident.to_s, newline)
+              print value
+            elsif overrides?(object, :dump_value)
+              value = capture { object.send(:dump_value, ident) }
+              newline = value =~ /\n./
+              dump_label(ident.to_s, newline)
+              print value
+            else
+              dump(object.send(ident), ident.to_s)
+            end
+          } 
+        }
+      }
+    end    
+  end
+
+  def self.dump_value(value)
+    case value
+      when Time; puts value.strftime(timezone? ? "%F %T (%z)" : "%F %T")
+      when Date; puts value.strftime("%F")
+    else
+      puts value.inspect
+    end
+  end
+
+  def self.dump_id(object)
+    if object.class.to_s.start_with?("#")
+      puts "<#{object.object_id}> (Class@<#{object.class.object_id}>)"
+    else
+      puts "<#{object.object_id}> (#{object.class})"
+    end
+  end
+
+  def self.dump_reference(object) = puts reference(object)
+
+  # Object-level versions of the class methods
+  def dump(...) = Dumps.dump(self, ...)
+  def dumps(...) = Dumps.dumps(self, ...)
+
+  # def dump_attr <- doesn't exist here, can be defined in derived classes
+  def dump_value(ident) = Dumps.dump_value(self.send(ident))
+  def dump_id(...) = Dumps.dump_id(self, ...)
+  def dump_reference(...) = Dumps.dump_reference(self, ...)
+
+  def self.overrides?(object, method)
+    object.respond_to?(method) && object.method(method).owner != Dumps
+  end
+
+private
+  def self.capture(&block)
+    s = StringIO.new
+    saved_stdout = $stdout
+    begin
+      $stdout = s
+      yield
+    ensure
+      $stdout = saved_stdout
+    end
+    s.string
+  end
+
+  # Include time zone in timestamps
+  @@timezone = false
+
+  # Stack of values begin processed
+  @@dump_stack = []
+
+  # Map from all known objects to ref. It is cleared at the beginning of the
+  # top-level object's #dump method. This allows test programs to check the 
+  # when @@dump_stack becomes
+  # empty (this happens when the top-level #dump call terminates)
+  @@references = {}
+
+  @@anonymous = true
+
+  def self.anonymous? = @@anonymous
+  def self.anonymous=(b) @@anonymous = b end
+
+  # Stack and ref methods. These are used to avoid endless recursion when the
+  # dump objects contain circular references. It is somewhat expensive, though
+  def self.top = @@dump_stack.last
+  def self.push(elem) = @@dump_stack.push(elem)
+  def self.pop(elem) = @@dump_stack.pop
+  def self.empty? = @@dump_stack.empty?
+  def self.reset
+    @@references = {}
+    @@anonymous = true
+  end
+  def self.reference(object) = @@references[object]
+  def self.registered?(object) = @@references.key?(object)
+
+  # Compute reference and register the object in @@references
+  def self.register(object, label, index: nil)
+    if empty?
+      ref = "*#{label}"
+    elsif index
+      ref = "#{reference(top)}[#{index}]"
+    else
+      ref = "#{reference(top)}.#{label || object.object_id.to_s}"
+    end
+    @@references[object] = ref
+  end
+
+  # Register object and execute block with object on the top of the stack. If
+  # the object is already registered a reference is written and the block is
+  # not called
+  def self.context(object, label, index: nil, &block)
+    reset if empty?
+    if registered?(object)
+      dump_label(label, false); dump_reference(object)
+    else
+      register object, label, index: index
+      begin
+        push object
+        yield
+      ensure
+        pop object
+      end
+    end
+  end
+
+  module Dump__ClassMethods
+    def dump_identifiers
+      @dump_identifiers ||=
+          if const_defined?(:DUMP_NEW, false)
+            const_get(:DUMP_NEW)
+          else
+            (superclass.include?(Dumps) ? superclass.dump_identifiers : []) +
+            (const_defined?(:DUMP, false) ? const_get(:DUMP) : []) -
+            (const_defined?(:DUMP_EXCLUDE, false) ? const_get(:DUMP_EXCLUDE) : [])
+          end.map(&:to_sym)
+      @dump_identifiers
+    end
+  end
+
+  def self.included(klass)
+    super
+    klass.extend Dump__ClassMethods # Add class method to the including klass
+  end
+end
+

data/sig/dump.rbs

@@ -0,0 +1,4 @@
+module Dump
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: dumps
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Claus Rasmussen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: indented_io
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: constrain
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem dumps
+email:
+- claus.l.rasmussen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- TODO
+- lib/dumps.rb
+- lib/dumps/version.rb
+- sig/dump.rbs
+homepage: http://www.nowhere.com/
+licenses: []
+metadata:
+  homepage_uri: http://www.nowhere.com/
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.18
+signing_key:
+specification_version: 4
+summary: Gem dumps
+test_files: []