indented_io 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 912e798e34c1c61e53b1cdaf9743383085503671e3ba318995a434ff1ec2fac7
-  data.tar.gz: 5ca6c729d02ff390720b3faf76adffe22a10aec20236adbafe5edcd21b364955
+  metadata.gz: ae77258c328dc98d5333e7954d3412556a1628a9ae2797885342f3efeff9c84a
+  data.tar.gz: 167ea53c4fd36d27a544c304ce72632c452641f3c2978a1c1cc15e1b844e58e7
 SHA512:
-  metadata.gz: f9b98e7f028b6386b6b2caca76690fa53e87e6d06c9a28e6967147e54abca098ed11364a54f9bc1acaf3bd489baafcb46351acbef471527d7b53f4dddad470ea
-  data.tar.gz: b2962b48817a7a5a5803484f0ff82a335d955e140b3a9b5003a91c538612842918cbaf24992e12d7ce630a1e1b866786a781290a75ccecf78af4f7fa8efd0505
+  metadata.gz: 843c6ca1105dca45e8ea3b53c47933db4e650451b29294855a80a7a84186804d7565f49309fdf2fcbdea30c43d605caea2bf1a5b65c0c6fc90501b896ee8bf23
+  data.tar.gz: 248f51b62caab9925452779161b2e910eb06aaa62b9c1e886d75bb040b1feb613d7cc9605ddad5aa0c2d2ab7fda5e92dbf0b95b398c278bd287098a351234f73

data/README.md

@@ -20,13 +20,13 @@ indent(2, "* ").puts "Indented two levels"
 
 outputs
 
-```ruby
+```
 Not indented
   Indented one level
 * * Indented two levels
 ```
 
-#### `#indent`
+#### `Kernel#indent`, `IO#indent`, and `StringIO#indent`
 
 `#indent` without a block returns an `IndentedIO` object that acts as the
 receiver but redefine `#print`, `#printf`, `#puts`, and `#p` to print indented
@@ -201,7 +201,7 @@ git commits and tags, and push the `.gem` file to
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at
-https://github.com/[USERNAME]/indented_io.
+https://github.com/clrgit/indented_io.
 
 ## License
 

data/lib/indented_io/error.rb

@@ -1,6 +1,13 @@
 
 module IndentedIO
-  # Error class
+  # Error class. To rescue errors form IndentedIO do
+  #
+  #   begin
+  #     do_some_stuff()
+  #   rescue IndentedIO::Error => ex
+  #     handle_error()
+  #   end
+  #
   class Error < RuntimeError; end
 end
 

data/lib/indented_io/indented_io.rb

@@ -8,26 +8,18 @@ module IndentedIO
   # levels rise or fall IndentedIO objects are moved on and off the stack
   #
   # Note that #new is private. The only way to create a IndentedIO object is to
-  # call #indent on a object that supports it
+  # call #indent on an object that supports it
   class IndentedIO
     include IndentedIOInterface
 
-    # :nodoc:
+    # @!visibility private 
     alias :interface_indent :indent
-    # :startdoc:
 
-    # Return a IndentedIO object
-    #
-    # See IndentedIO::IndentedIOInterface#indent for documentation
+    # (see IndentedIO::IndentedIOInterface#indent)
     def indent(levels=1, string_ = self.this_indent, string: string_, bol: nil, &block)
       interface_indent(levels, string, bol: bol, &block)
     end
 
-    # Current level
-    def level
-      @level ||= @levels + (parent.is_a?(::IndentedIO::IndentedIO) ? parent.level : 0)
-    end
-
     # Indent and print args to the underlying device. #print has the same semantic
     # as Kernel#print
     def print(*args)
@@ -74,14 +66,14 @@ module IndentedIO
       args.size == 1 ? args.first : args
     end
 
-    # :stopdoc:
-
     # Make IndentedIO behave like the underlying @device
+    # @!visibility private 
     def respond_to?(method)
       [:indent, :level, :print, :puts, :p].include?(method) || device.respond_to?(method)
     end
 
     # Make IndentedIO behave like the underlying @device
+    # @!visibility private 
     def method_missing(method, *args)
       device.send(method, *args)
     end
@@ -119,6 +111,11 @@ module IndentedIO
       @base.instance_variable_set(:@bol, bol) # @bol only exists in the #base object
     end
 
+    # Current level
+    def level
+      @level ||= @levels + (parent.is_a?(::IndentedIO::IndentedIO) ? parent.level : 0)
+    end
+
     # Hide new
     private_class_method :new
 
@@ -151,6 +148,7 @@ module IndentedIO
     end
 
   public
+    # @!visibility private 
     def dump
       $stderr.puts "#{self.class} [#{self.object_id}]"
       $stderr.puts "  device: #{device.class} [#{device.object_id}]"

data/lib/indented_io/indented_io_interface.rb

@@ -1,25 +1,36 @@
 module IndentedIO
   # IndentedIO interface that provides the #indent method. Used by IO,
   # StringIO, and IndentedIO. It can be included in any class that define a
-  # #print method
+  # #print method like this:
+  #
+  #   require 'indented_io'
+  #   class MyIO
+  #     include IndentedIO::IndentedIOInterface
+  #     def print(*args) ... end
+  #   end
+  #
+  #   my_io = MyIO.new
+  #   my_io.print "Not indented\n"
+  #   my_io.indent.puts "It works!"
+  #
+  #   # Not indented
+  #   #   It works!
+  #
   module IndentedIOInterface
     # Returns a IndentedIO object that can be used for printing. The IO object
-    # will pass-through all method calls except #print, #printf, #puts, and #p
-    # to the enclosing object
+    # will pass-through all method to the underlying device except #print,
+    # #printf, #puts, and #p
     #
-    # :call-seq:
-    #   indent(levels = 1)
-    #   indent(levels, string)
-    #   indent(levels, string: indent_string, bol: beginning_of_line)
-    #   indent(levels, string, bol: beginning_of_line)
+    # +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
+    #
+    # If +level+ is negative, #indent will outdent text instead
     #
-    # +levels+:: Number of indentation levels. Default is one level
-    # +string+:: The indentation string. Default is the indent string of the
-    #            outer level or ::IndentedIO.default_indent if this is the
-    #            first level
-    # +bol+:: Beginning of line. If true, #indent will begin writing with an
-    #         indentation string. If false, it will only indent after the next
-    #         newline. Default true
     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)

data/lib/indented_io/io.rb

@@ -1,6 +1,6 @@
 require 'indented_io/indented_io_interface'
 
-# :nodoc:
+# Includes the IndentedIOInterface that define the #indent method
 class IO
   include IndentedIO::IndentedIOInterface
 end

data/lib/indented_io/kernel.rb

@@ -1,7 +1,22 @@
 require 'indented_io/indented_io_interface'
 
-# :nodoc:
 module Kernel
+  # Like {IndentedIO::IndentedIOInterface#indent} except the underlying device is
+  # not the receiver (Kernel) but $stdout. Kernel#indent also allows a block without
+  # and argument. In that case it manipulates $stdout to print indented:
+  #
+  #   puts "Not indented
+  #   indent {
+  #     puts "Indented"
+  #     indent {
+  #       puts "Even more indented"
+  #     }
+  #   }
+  #
+  #   # Not indented
+  #   #   Indented
+  #   #     Even more indented
+  #
   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)

data/lib/indented_io/stringio.rb

@@ -1,6 +1,6 @@
 require 'indented_io/indented_io_interface'
 
-# :nodoc:
+# Includes the IndentedIOInterface that define the #indent method
 class StringIO
   include IndentedIO::IndentedIOInterface
 end

data/lib/indented_io/version.rb

@@ -1,4 +1,4 @@
 module IndentedIO
   # Version number
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

data/lib/indented_io.rb

@@ -10,11 +10,11 @@ require 'indented_io/stringio'
 # IndentedIO module
 
 module IndentedIO
-  # Returns default indentation. '  ' (two spaces) is the default but it can be
-  # set by #default_indent
+  # Returns default indentation. Two spaces is the default but it can be set by
+  # #default_indent
   def self.default_indent() @DEFAULT_INDENT end
 
-  # Set default indentation
+  # Sets default indentation
   def self.default_indent=(indent) @DEFAULT_INDENT = indent end
 
 private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: indented_io
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Claus Rasmussen