indented_io 0.8.6 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfc1de7e7ffda4d1fa37cd2979367b91b105cc43bc83a18d67816d14c3abd334
-  data.tar.gz: b54b5d64a8af0ca25cb333a2aa94599fba21be53063bd8fe1953d48bb8e4e3c1
+  metadata.gz: ab6498e0cafc5162dbe8f021e5abe01d1782b103581ee6f506ad419e8d945ad7
+  data.tar.gz: 986de84134945946db538335c1a850805a022676b9f67b7bfdcbc888a0d2f680
 SHA512:
-  metadata.gz: 84b4b34e808dd75d2fbf8d6c2e581448352d0c4d1c0f4bcf363b43e4b3b550a7619d80418fde9a5e8968e97b8c973b73ec9bb391b25c7967454061c9b39e824a
-  data.tar.gz: f9041fd50c2f791c95b896e34b61b22050d792c938e83af9b89d48c81fb3e49b56d60b012d32c7cbdbc70a4e43d6e50ad651b7a12e13777da7178ab59cd01895
+  metadata.gz: 3b5e24b28007050283cd1c2f2903bc19524d2abaa4f9c120d7b8c48c827a5e8ac0a4a2406258743553bfa673dd298c0937cc75ea5c0b2f162bfc33ffeedd9154
+  data.tar.gz: 660976e3894125018aaa7968a331144670d2e071e852f48702f4de4f5fc4bd5ea97df95fc6b2df91bc38ec5f77b880dea33576363a1733ed79f66a67a02099fa

data/.ruby-version

@@ -1 +1 @@
-ruby-2.7.1
+ruby-3.1.2

data/Gemfile

@@ -4,3 +4,6 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in indented_io.gemspec
 gemspec
+
+gem "rake", "~>12.0"
+gem "rspec", "~>3.0"

data/TODO

@@ -1,11 +1,27 @@
 
 TODO
+  o Make the folowing wotk
+        # Shorthand for
+        #   puts "Header"
+        #   indent { puts content }
+        #
+        puts "Header", indent, content
+
+        # Shorthand for
+        #   puts "Header"
+        #   indent { recurse }
+        puts "Header", indent { recurse }
+
+  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

@@ -1,7 +1,4 @@
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "indented_io/version"
+require_relative 'lib/indented_io/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "indented_io"
@@ -20,23 +17,12 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/clrgit/indented_io"
   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"] = "https://rubygems.org"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
-  end
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+  # 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        = "exe"
   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 "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/version.rb

@@ -1,4 +1,4 @@
 module IndentedIO
   # Version number
-  VERSION = '0.8.6'
+  VERSION = '0.9.0'
 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,57 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: indented_io
 version: !ruby/object:Gem::Version
-  version: 0.8.6
+  version: 0.9.0
 platform: ruby
 authors:
 - Claus Rasmussen
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-23 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
+date: 2022-07-20 00:00:00.000000000 Z
+dependencies: []
 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
@@ -88,9 +46,8 @@ files:
 homepage: https://github.com/clrgit/indented_io
 licenses:
 - MIT
-metadata:
-  allowed_push_host: https://rubygems.org
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -105,8 +62,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.3.18
+signing_key:
 specification_version: 4
 summary: Print indented text
 test_files: []