indented_io 0.9.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab6498e0cafc5162dbe8f021e5abe01d1782b103581ee6f506ad419e8d945ad7
-  data.tar.gz: 986de84134945946db538335c1a850805a022676b9f67b7bfdcbc888a0d2f680
+  metadata.gz: 1ca4010d40987e7fcf41ef261e382d9c4dbd46aedf28b14b1b492e2d89514e69
+  data.tar.gz: 9ecb56b410ed532c145b438f1f08ab380ebd6f4003f38c9c851cfeba27c9f4f1
 SHA512:
-  metadata.gz: 3b5e24b28007050283cd1c2f2903bc19524d2abaa4f9c120d7b8c48c827a5e8ac0a4a2406258743553bfa673dd298c0937cc75ea5c0b2f162bfc33ffeedd9154
-  data.tar.gz: 660976e3894125018aaa7968a331144670d2e071e852f48702f4de4f5fc4bd5ea97df95fc6b2df91bc38ec5f77b880dea33576363a1733ed79f66a67a02099fa
+  metadata.gz: 1f3b9df5ccba732b79eefac135faa6a79a580e50bd954e7a1cea46d6a8f97adb2a116c4d63eb38f33cce17d096b35a008ac3b0e5c9f7bdc674615ea4b7951017
+  data.tar.gz: 5f54172ed68dfa74eea22303f283dce696d40db0f33fb21719e38c06d93db70626596571ff89822fed4e0ac59351d06bfb1a748a5434a94ae5104a238a0c747e

data/indented_io.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.description   = %q{
                           IndentedIO extends Kernel, IO, and StringIO with an
                           #indent method that redefines #print, printf, #puts,
-                          and #p to print their output indented. Indentations 
+                          and #p to print their output indented. Indentations
                           are stacked so that each new indentation adds to the
                           previous indendation
                        }
@@ -25,4 +25,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "string-text"
+
 end

data/lib/indented_io/indented_io.rb

@@ -1,4 +1,4 @@
-require 'indented_io/indented_io_interface'
+require_relative 'indented_io_interface'
 
 module IndentedIO
   # An IO device that writes indented text by reimplementing #write, #print,
@@ -6,14 +6,14 @@ module IndentedIO
   #
   # IndentedIO objects forms a chain that acts as a stack. The lowest element
   # in the stack is always a "pure" IO object (eg. $stdout). IndentedIO object
-  # are than moved on and off the stack as indentation levels rise or fall
+  # are then moved on and off the stack as indentation levels rise or fall
   #
   # Note that #new is private. The only way to create a IndentedIO object is to
   # call #indent on an object that supports it ({Kernel}, {IO}, or {StringIO})
   class IndentedIO
     include IndentedIOInterface
 
-    # @!visibility private 
+    # @!visibility private
     alias :interface_indent :indent
 
     # (see IndentedIO::IndentedIOInterface#indent)
@@ -21,6 +21,10 @@ module IndentedIO
       interface_indent(depth, string, bol: bol, &block)
     end
 
+    def undent
+      @parent
+    end
+
     # Indent and print args to the underlying device. #write has the same semantic
     # as IO#write
     def write(*args)
@@ -54,8 +58,10 @@ module IndentedIO
     end
 
     # Indent and print args to the underlying device. #p has the same semantic
-    # as Kernel#p. Please note that even though #p is only defined on Kernel
-    # but can be used on any IndentedIO object so you can say '$stderr.p value'
+    # as Kernel#p. Please note that even though #p is only defined on Kernel it
+    # can also be used on any IndentedIO object so you can say '$stderr.p
+    # value'. This also deviates from the standard ruby $stderr object that
+    # doesn't have a #p method defined
     def p(*args)
       if bol
         args.each { |arg| write(arg.inspect, "\n") }
@@ -70,13 +76,13 @@ module IndentedIO
     # Make IndentedIO behave like the underlying @device by only searching for
     # methods in the device
     #
-    # @!visibility private 
+    # @!visibility private
     def respond_to?(method, include_all = false)
       [:indent, :depth, :tab, :p].include?(method) || device.respond_to?(method, include_all)
     end
 
     # Make IndentedIO behave like the underlying @device
-    # @!visibility private 
+    # @!visibility private
     def method_missing(method, *args)
       device.send(method, *args)
     end
@@ -131,7 +137,7 @@ module IndentedIO
     def initialize(parent, levels, this_indent, bol)
       if levels < 0
         parent.is_a?(::IndentedIO::IndentedIO) or raise ::IndentedIO::Error.new "Negative levels argument"
-        parent.levels + levels >= 0 or raise ::IndentedIO::Error.new "levels out of range"
+        parent.levels + levels >= 0 or raise ::IndentedIO::Error.new "Levels out of range"
         sibling = parent
         while parent.is_a?(::IndentedIO::IndentedIO) && levels < 0
           levels += parent.levels

data/lib/indented_io/indented_io_interface.rb

@@ -20,19 +20,24 @@ module IndentedIO
   module IndentedIOInterface
     # Returns a IndentedIO object that can be used for printing. The IO object
     # will pass-through all methods to the underlying device except #print,
-    # #printf, #puts, and #p
+    # #printf, #puts, and #p that extends the default to output indented text
     #
-    # +level+ is the number of leves to indent and +string+ is the string used
-    # for indentation. The indentation string can also be given as the keyword
-    # parameter +:string+. Default is the indent string of the outer level or
-    # {::IndentedIO.default_indent} if this is the first level. +:bol+ control the
-    # beginning-of-line status: If true, #indent will begin writing with an
-    # indentation string as if it was at the beginning of the line. If false,
-    # it will only indent after the next newline. Default is true
+    # +level+ is the number of levels to indent the following text. If +level+
+    # is negative, #indent will outdent text instead.  +level' can also be true
+    # or false: true sets the level to 1 and false sets it to 0
     #
-    # If +level+ is negative, #indent will outdent text instead
+    # +string+ is the string used for indentation. The indentation string can
+    # also be given as the keyword parameter +:string+. Default is the indent
+    # string of the outer level or {::IndentedIO.default_indent} if this is the
+    # first level
+    #
+    # +:bol+ controls the beginning-of-line status: If true, #indent will begin
+    # writing with an indentation string as if it was at the beginning of the
+    # line. If false, it will only indent after the first newline. Default is
+    # true
     #
     def indent(levels = 1, string_ = ::IndentedIO.default_indent, string: string_, bol: nil, &block)
+      levels = levels.is_a?(Integer) ? levels : (levels && 1 || 0)
       block.nil? || block.arity == 1 or raise ::IndentedIO::Error.new "Wrong number of block parameters"
       @indented_io_object = ::IndentedIO::IndentedIO.send(:new, self, levels, string, bol)
       block_given? ? yield(@indented_io_object) : @indented_io_object

data/lib/indented_io/io.rb

@@ -1,4 +1,4 @@
-require 'indented_io/indented_io_interface'
+require_relative 'indented_io_interface'
 
 # Includes the IndentedIOInterface that define the #indent method
 class IO

data/lib/indented_io/kernel.rb

@@ -1,6 +1,8 @@
-require 'indented_io/indented_io_interface'
+require_relative 'indented_io_interface'
 
 module Kernel
+  @@INDENT_STACK = []
+
   # Like {IndentedIO::IndentedIOInterface#indent} except the underlying device is
   # not the receiver (Kernel) but $stdout. Kernel#indent also allows a block without
   # an argument. In that case it manipulates $stdout to print indented:
@@ -17,6 +19,9 @@ module Kernel
   #   #   Indented
   #   #     Even more indented
   #
+  # It called without a block, it indents $stdout. It should then be matched
+  # with a corresponding #undent
+  #
   def indent(levels = 1, string_ = IndentedIO.default_indent, string: string_, bol: nil, &block)
     block.nil? || block.arity <= 1 or raise IndentedIO::Error.new "Wrong number of parameters"
     obj = IndentedIO::IndentedIO.send(:new, $stdout, levels, string, bol)
@@ -32,10 +37,14 @@ module Kernel
           $stdout = saved_stdout
         end
       end
+      r
     else
-      r = obj
+      $stdout = obj
     end
-    r
+  end
+
+  def undent
+    $stdout = $stdout.send(:parent)
   end
 end
 

data/lib/indented_io/stringio.rb

@@ -1,5 +1,5 @@
-require 'stringio' # Requiered to avoid 'superclass mismatch' errors in other modules
-require 'indented_io/indented_io_interface'
+require_relative 'stringio' # Required to avoid 'superclass mismatch' errors in other modules
+require_relative 'indented_io_interface'
 
 # Includes the IndentedIOInterface that define the #indent method
 class StringIO

data/lib/indented_io/tempfile.rb

@@ -1,4 +1,4 @@
-require 'indented_io/indented_io_interface'
+require_relative 'indented_io_interface'
 
 require "tempfile"
 

data/lib/indented_io/version.rb

@@ -1,4 +1,4 @@
 module IndentedIO
   # Version number
-  VERSION = '0.9.0'
+  VERSION = '0.11.0'
 end

data/lib/indented_io.rb

@@ -1,14 +1,14 @@
 
-require 'indented_io/version'
-require 'indented_io/error'
-require 'indented_io/indented_io'
-require 'indented_io/indented_io_interface'
-require 'indented_io/kernel'
-require 'indented_io/io'
-require 'indented_io/stringio'
-require 'indented_io/tempfile'
+require_relative 'indented_io/version'
+require_relative 'indented_io/error'
+require_relative 'indented_io/indented_io'
+require_relative 'indented_io/indented_io_interface'
+require_relative 'indented_io/kernel'
+require_relative 'indented_io/io'
+require_relative 'indented_io/stringio'
+require_relative 'indented_io/tempfile'
 
-# IndentedIO module. See {IndentedIO::IndentedIO} for documentation on how to 
+# IndentedIO module. See {IndentedIO::IndentedIO} for documentation on how to
 # use this module
 #
 module IndentedIO

metadata

@@ -1,19 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: indented_io
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Claus Rasmussen
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-20 00:00:00.000000000 Z
-dependencies: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: string-text
+  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: "\n                          IndentedIO extends Kernel, IO, and StringIO
   with an\n                          #indent method that redefines #print, printf,
-  #puts,\n                          and #p to print their output indented. Indentations
-  \n                          are stacked so that each new indentation adds to the\n
+  #puts,\n                          and #p to print their output indented. Indentations\n
+  \                         are stacked so that each new indentation adds to the\n
   \                         previous indendation\n                       "
 email:
 - claus.l.rasmussen@gmail.com
@@ -47,7 +60,6 @@ homepage: https://github.com/clrgit/indented_io
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -62,8 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.18
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Print indented text
 test_files: []