indented_io 0.8.8 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b429449b90ca605dbcf4f07abaee53a8f2eece7a3131024649c0c2b55775f962
-  data.tar.gz: eccb5276e5d1356e58809d674a27dc64651bb885c03000e1ac3150b50f989206
+  metadata.gz: e7d7b56c7e800172496c55f99f9dc03636488bf6c4129443a68529863dc6a172
+  data.tar.gz: 10d967b887989eced95e9fc7f3799d59219e4a76ca926556badf8ebb7e1c49b6
 SHA512:
-  metadata.gz: 93fc65e925cad892a1f8cb716ee5064d4a23112930e14ed184072108550e5470834fc97e400011465de1e48a645dbeee3f65883f14e2242fa6a57913bdba51d5
-  data.tar.gz: 40161650518478d5ad566ceade2274b9900dd651f89bff44246cbd066bdd96d3a5d8cb9da5258d046d324deb1d06feaa608528d46815cce2aa0ed278bdbeeb68
+  metadata.gz: 0cb712cf0d9926b09d385db2a37a3d0cb6e136a36f5cbd164dccf49954b93098a4b23b0f4c60548a79267697bbdeb9adf19efd07123762f79ca43ea77860797a
+  data.tar.gz: a0986342ecbc58afb912146b30aefbaed2c186df34b4df5dfe8a838cdc631db51eba5524797e101471c1cfd8c5388f42a4a482bc7bbab4fd85cc0bbb765405a5

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,5 +1,17 @@
 
 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

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"
@@ -13,30 +10,22 @@ 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
                        }
   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", "~> 2.2.10"
-  spec.add_development_dependency "rake", ">= 12.3.3"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "string-text"
+
 end

data/lib/indented_io/indented_io.rb

@@ -13,7 +13,7 @@ module IndentedIO
   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

data/lib/indented_io/indented_io_interface.rb

@@ -22,13 +22,13 @@ module IndentedIO
     # will pass-through all methods to the underlying device except #print,
     # #printf, #puts, and #p
     #
-    # +level+ is the number of leves to indent and +string+ is the string used
+    # +level+ is the number of levels 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
+    # it will only indent after the first newline. Default is true
     #
     # If +level+ is negative, #indent will outdent text instead
     #

data/lib/indented_io/kernel.rb

@@ -1,6 +1,8 @@
 require 'indented_io/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/version.rb

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

metadata

@@ -1,61 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: indented_io
 version: !ruby/object:Gem::Version
-  version: 0.8.8
+  version: 0.10.0
 platform: ruby
 authors:
 - Claus Rasmussen
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.2.10
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.2.10
-- !ruby/object:Gem::Dependency
-  name: rake
+  name: string-text
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '0'
   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'
+        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
@@ -88,9 +59,7 @@ files:
 homepage: https://github.com/clrgit/indented_io
 licenses:
 - MIT
-metadata:
-  allowed_push_host: https://rubygems.org
-post_install_message: 
+metadata: {}
 rdoc_options: []
 require_paths:
 - lib
@@ -105,8 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Print indented text
 test_files: []