indented_io 0.8.5 → 0.8.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b381c1136988e46a6a79848db05b1563a6704619775b4945e879c1efeb0dfc7a
-  data.tar.gz: 7296f2367c4eecb9037bf9c2f4492ee21ff3d8520c841ad95f9c06527f9cf8f8
+  metadata.gz: b429449b90ca605dbcf4f07abaee53a8f2eece7a3131024649c0c2b55775f962
+  data.tar.gz: eccb5276e5d1356e58809d674a27dc64651bb885c03000e1ac3150b50f989206
 SHA512:
-  metadata.gz: 216242b00c20a64f0a6f4394f7587bb4d663864814bfcae5ab96b76401ae9498eb0fbc9211b2aa7addbe2c2321397ad8b8cf70329eea60f8b8434346302198f3
-  data.tar.gz: d0dcd905b87f2c024137d3a862c1ae8ad9b345e38cec918a0e8d1a1b2a678edc66196d112d6608d98fbb94f462aae61c37d698b13fd533dc5f4125750ea2ddab
+  metadata.gz: 93fc65e925cad892a1f8cb716ee5064d4a23112930e14ed184072108550e5470834fc97e400011465de1e48a645dbeee3f65883f14e2242fa6a57913bdba51d5
+  data.tar.gz: 40161650518478d5ad566ceade2274b9900dd651f89bff44246cbd066bdd96d3a5d8cb9da5258d046d324deb1d06feaa608528d46815cce2aa0ed278bdbeeb68

data/TODO

@@ -1,11 +1,15 @@
 
 TODO
+  o Fix "goes wrong" in spec/indented_io_spec.rb by making
+    IndentedIOInterface#indent create a IndentedIO object for each level. This
+    may require blocks to pop-off multiple levels
+  o Fix that #indent is defined on _all_ objects!
   o Find a solution for the inclusion of StringIO and Tempfile (the last is 
     required by ruby 2.7 - see also note in lib/indented_io/tempfile.rb
   o Check if IO object is writable - no good solution ?
   o better name for @this_indent ? 'string' ?
   o Reimplement core loop in C
-  o Create BaseIndentedIO to hold bol status and remove it from IndentedIO
+  o Create InitialIndentedIO to hold bol status and remove it from IndentedIO
   o Transmogrify instances variables and protected methods in IndentedIO to 
     avoid collision with names from the underlying device
   o Explain name collision issues in the docs

data/indented_io.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "bundler", "~> 2.2.10"
   spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/indented_io/indented_io.rb

@@ -1,11 +1,12 @@
 require 'indented_io/indented_io_interface'
 
 module IndentedIO
-  # An IO device that writes indented text
+  # An IO device that writes indented text by reimplementing #write, #print,
+  # #printf, #puts, and #p
   #
   # IndentedIO objects forms a chain that acts as a stack. The lowest element
-  # in the stack is always a "pure" IO object (eg. $stdout) and as indentation
-  # levels rise or fall IndentedIO objects are moved on and off the stack
+  # 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
   #
   # 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})
@@ -16,8 +17,8 @@ module IndentedIO
     alias :interface_indent :indent
 
     # (see IndentedIO::IndentedIOInterface#indent)
-    def indent(levels=1, string_ = self.this_indent, string: string_, bol: nil, &block)
-      interface_indent(levels, string, bol: bol, &block)
+    def indent(depth=1, string_ = self.this_indent, string: string_, bol: nil, &block)
+      interface_indent(depth, string, bol: bol, &block)
     end
 
     # Indent and print args to the underlying device. #write has the same semantic
@@ -53,8 +54,8 @@ module IndentedIO
     end
 
     # Indent and print args to the underlying device. #p has the same semantic
-    # as Kernel#p. Please note that #p is only defined on Kernel in the Ruby core
-    # library but can be used on any IndentedIO object
+    # 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'
     def p(*args)
       if bol
         args.each { |arg| write(arg.inspect, "\n") }
@@ -66,10 +67,12 @@ module IndentedIO
       args.size == 1 ? args.first : args
     end
 
-    # Make IndentedIO behave like the underlying @device
+    # Make IndentedIO behave like the underlying @device by only searching for
+    # methods in the device
+    #
     # @!visibility private 
     def respond_to?(method, include_all = false)
-      [:indent, :level, :print, :printf, :puts, :p].include?(method) || device.respond_to?(method)
+      [:indent, :depth, :tab, :p].include?(method) || device.respond_to?(method, include_all)
     end
 
     # Make IndentedIO behave like the underlying @device
@@ -78,22 +81,27 @@ module IndentedIO
       device.send(method, *args)
     end
 
+    # Depth of this object. #depth is always bigger than zero for IndentedIO
+    # objects
+    attr_reader :depth
+
+    # Tabulator position for this object. The is the same as the combined
+    # length of the indentation levels
+    attr_reader :tab
+
   protected
+    # Parent object. This can be an IndentedIO, IO, or StringIO object
+    attr_reader :parent
+
     # Reference to the pure IO object at the bottom of the stack. It is used to
     # write directly to the IO object without having to recurse down the IndentedIO
     # stack
     attr_reader :device
 
     # First IndentedIO object on the stack. Equal to self if self is the first
-    # indentation object. The #base object is used to keep track of #bol for
-    # the whole stack of IndentedIO objects
-    attr_reader :base
-
-    # Parent IndentedIO or IO object
-    attr_reader :parent
-
-    # Number of indent levels
-    attr_reader :levels
+    # indentation object. The #initial object is used to store a stack-global
+    # bol flag
+    attr_reader :initial
 
     # Indent string for this device
     attr_reader :this_indent
@@ -101,28 +109,29 @@ module IndentedIO
     # The combined indent strings of previous levels plus this device's indent string
     attr_reader :combined_indent
 
-    # True iff at Beginning-Of-Line
+    # True iff at Beginning-Of-Line. Note that #bol is global for the whole
+    # indentation stack
     def bol()
-      @base == self ? @bol : @base.bol # @bol only exists in the #base object
+      @initial == self ? @bol : @initial.bol # @bol only exists in the #base object
     end
 
-    # Set Beginning-Of-Line to true or false
+    # Set Beginning-Of-Line to true or false. Note that #bol is global for the
+    # whole indentation stack
     def bol=(bol)
-      @base.instance_variable_set(:@bol, bol) # @bol only exists in the #base object
+      @initial.instance_variable_set(:@bol, bol) # @bol only exists in the #initial object
     end
 
-    # Current level
-    def level
-      @level ||= @levels + (parent.is_a?(::IndentedIO::IndentedIO) ? parent.level : 0)
-    end
+    # Number of indent levels for this IndentedIO object
+    attr_reader :levels
 
     # Hide new
     private_class_method :new
 
+    # TODO: Move multi-level functionality to ::IndentedIO.indent
     def initialize(parent, levels, this_indent, bol)
       if levels < 0
-        parent.is_a?(::IndentedIO::IndentedIO) or raise IndentedIO::Error.new "Negative levels argument"
-        parent.level + levels >= 0 or raise IndentedIO::Error.new "levels out of range"
+        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"
         sibling = parent
         while parent.is_a?(::IndentedIO::IndentedIO) && levels < 0
           levels += parent.levels
@@ -133,15 +142,17 @@ module IndentedIO
       end
       @parent = parent
       @levels = levels
+      @depth = @parent.depth + levels
+      @tab = @parent.tab + this_indent.size * @levels
       @this_indent = this_indent
       if @parent.is_a?(::IndentedIO::IndentedIO)
         @device = @parent.device
-        @base = @parent.base
+        @initial = @parent.initial
         @combined_indent = @parent.combined_indent + @this_indent * @levels
         self.bol = bol if !bol.nil?
       else
         @device = parent
-        @base = self
+        @initial = self
         @combined_indent = @this_indent * @levels
         self.bol = (bol.nil? ? true : bol)
       end

data/lib/indented_io/indented_io_interface.rb

@@ -33,9 +33,21 @@ module IndentedIO
     # If +level+ is negative, #indent will outdent text instead
     #
     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, self, levels, string, bol)
-      block_given? ? yield(obj) : obj
+      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
     end
+
+    # :call-seq:
+    #   indent(levels, string = ::IndentedIO.default:_indent, bol: nil, &block)
+    #   indent(string = ::IndentedIO.default:_indent, bol: nil, &block)
+
+    # Return the accumulated number of indentation levels. An unindented device
+    # has depth equal to 0
+    def depth() 0 end
+
+    # Return current tabulator position. This is the same as the combined
+    # length of the indentations. An unindented device has depth equal to 0
+    def tab() 0 end
   end
 end

data/lib/indented_io/tempfile.rb

@@ -0,0 +1,14 @@
+require 'indented_io/indented_io_interface'
+
+require "tempfile"
+
+# Includes the IndentedIOInterface that define the #indent method
+#
+# Note that Tempfile used to be a (kind of) IO but that changed in ruby-2.7.
+# The problem is that we now have to require both StringIO and Tempfile and
+# possible other classes to inject the #indent method instead of just doing it
+# once in the IO class itself. TODO: Find a better solution - probably by
+# implementing a check in Kernel
+class Tempfile
+  include IndentedIO::IndentedIOInterface
+end

data/lib/indented_io/version.rb

@@ -1,4 +1,4 @@
 module IndentedIO
   # Version number
-  VERSION = '0.8.5'
+  VERSION = '0.8.8'
 end

data/lib/indented_io.rb

@@ -13,7 +13,7 @@ require 'indented_io/tempfile'
 #
 module IndentedIO
   # Returns default indentation. Two spaces is the default but it can be set by
-  # #default_indent
+  # #default_indent=
   def self.default_indent() @DEFAULT_INDENT end
 
   # Sets default indentation

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: indented_io
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.8.8
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-15 00:00:00.000000000 Z
+date: 2022-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.2.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.2.10
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -82,6 +82,7 @@ files:
 - lib/indented_io/io.rb
 - lib/indented_io/kernel.rb
 - lib/indented_io/stringio.rb
+- lib/indented_io/tempfile.rb
 - lib/indented_io/version.rb
 - scripts/perf.rb
 homepage: https://github.com/clrgit/indented_io