indented_io 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7d7b56c7e800172496c55f99f9dc03636488bf6c4129443a68529863dc6a172
-  data.tar.gz: 10d967b887989eced95e9fc7f3799d59219e4a76ca926556badf8ebb7e1c49b6
+  metadata.gz: 1ca4010d40987e7fcf41ef261e382d9c4dbd46aedf28b14b1b492e2d89514e69
+  data.tar.gz: 9ecb56b410ed532c145b438f1f08ab380ebd6f4003f38c9c851cfeba27c9f4f1
 SHA512:
-  metadata.gz: 0cb712cf0d9926b09d385db2a37a3d0cb6e136a36f5cbd164dccf49954b93098a4b23b0f4c60548a79267697bbdeb9adf19efd07123762f79ca43ea77860797a
-  data.tar.gz: a0986342ecbc58afb912146b30aefbaed2c186df34b4df5dfe8a838cdc631db51eba5524797e101471c1cfd8c5388f42a4a482bc7bbab4fd85cc0bbb765405a5
+  metadata.gz: 1f3b9df5ccba732b79eefac135faa6a79a580e50bd954e7a1cea46d6a8f97adb2a116c4d63eb38f33cce17d096b35a008ac3b0e5c9f7bdc674615ea4b7951017
+  data.tar.gz: 5f54172ed68dfa74eea22303f283dce696d40db0f33fb21719e38c06d93db70626596571ff89822fed4e0ac59351d06bfb1a748a5434a94ae5104a238a0c747e

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,7 +6,7 @@ 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})
@@ -137,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 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 first 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,4 +1,4 @@
-require 'indented_io/indented_io_interface'
+require_relative 'indented_io_interface'
 
 module Kernel
   @@INDENT_STACK = []

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.10.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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: indented_io
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Claus Rasmussen