indented_io 0.7.3 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f678cdfa6edee19dad6a5256367071ceea8d1ca7ebb5dd4556330f260250e0e1
-  data.tar.gz: a2cb615747e62ca14ed25b872ae501c9f6b0dbaadd1a9ec73f3a2dbfcd519f61
+  metadata.gz: '097c526b0eeabff0b3be7d1483a6bac19232b803ddb630457c56ca4e7d180cea'
+  data.tar.gz: 0a6dc9f1bdf3dbc325ea52d06298b67dd7be389297baadc85d773e4f23edd329
 SHA512:
-  metadata.gz: 914ca7aef4d7017fc4899c2f1cc19da8a7cf6bacc7c0937bd28033bef7cb2350f3878bd0ac9380301d4e2b0cb7df6aded579085a7a52c0f48206e80dbe6b3a7a
-  data.tar.gz: 5dcf284b39596f7faaff975d2e703125caa157c133646a1aa9a2147bb95b7c4c852de61c3bcdc872208c08d79a7d4acc42a0170d168d66e9a56199082ed5d328
+  metadata.gz: 516212abf50023dd89352d55f2bf2745e367cf3e0646d3f0dc1c5d6a8193cf0fdc8053beec7259e978ad7bd94791cd6e8476c9ba101e2a066b93b311d9589b84
+  data.tar.gz: 4b8ead522fa1830c8c31888cded99ae00679737dd6f3560ebe9214190b27c38b2af2ff224437cb8c7be5e2de7fe338ca06525d5d7d980eb088f5dbc996380e6b

data/README.md

@@ -142,14 +142,14 @@ In case of errors an `IndentedIO::Error` exception is raised
 
 You can add support for your own IO objects by including
 `IndentedIO::IndentedIOInterface` in your class.  All that is required is that
-the class define a `#print` method with the same semantics as the system
-`#print`
+the class define a `#write` method with the same semantics as `IO#write`
+(convert arguments to strings and then write them)
 
 ```ruby
 require 'indented_io'
 class MyIO
   include IndentedIO::IndentedIOInterface
-  def print(*args) ... end
+  def writte(*args) ... end
 end
 
 my_io = MyIO.new
@@ -174,7 +174,7 @@ check performance). It would be much faster if the inner loop was implemented
 in C. However, we're talking micro-seconds here: Printing without using
 IndentedIO range from around 0.25ms to 1ms while using IndentedIO slows it down
 to between 4 and 12 microseconds, so IndentedIO won't cause a noticeable slow
-down of your application
+down of your application unless you do a lot of output
 
 ## Installation
 

data/TODO

@@ -2,14 +2,20 @@
 TODO
   o Check if IO object is writable - no good solution ?
   o better name for @this_indent ? 'string' ?
-  o Change dependency in IndentedIOInterface from #print to #write and bump
-    version to 0.8 as this is the last user-visible change to be made
   o Reimplement core loop in C
   o Create BaseIndentedIO 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
+  o Remove IndentedIO#dump
 
+  + Change dependency in IndentedIOInterface from #print to #write and bump
+    version to 0.8 as this is the last user-visible change to be made
+  + Oops. #print reimplemention doesn't do this:
+     If the output field separator ($,) is not nil, it is inserted between
+     objects. If the output record separator ($\) is not nil, it is appended to
+     the output 
+  + Tests for #write
   + explain bol
   + Allow a symbolic :string argument
   + #printf !

data/lib/indented_io/indented_io.rb

@@ -20,48 +20,54 @@ module IndentedIO
       interface_indent(levels, string, bol: bol, &block)
     end
 
-    # Indent and print args to the underlying device. #print has the same semantic
-    # as Kernel#print
-    def print(*args)
-      if bol
-        @device.print @combined_indent
-        self.bol = false
-      end
+    # Indent and print args to the underlying device. #write has the same semantic
+    # as IO#write
+    def write(*args)
+      n_bytes = 0
       args.join.each_char { |c|
         if c == "\n"
           self.bol = true
         elsif bol
-          @device.print @combined_indent
+          n_bytes += @device.write(@combined_indent)
           self.bol = false
         end
-        @device.print c
+        n_bytes += @device.write(c)
       }
+      n_bytes
+    end
+
+    # Indent and print args to the underlying device. #print has the same semantic
+    # as Kernel#print
+    def print(*args)
+      return nil if args.empty?
+      write(args.join($, || ''))
+      write($\) if $\
       nil
     end
 
     # Indent and print args to the underlying device. #printf has the same semantic
     # as Kernel#printf
     def printf(format, *args)
-      print format % args
+      write format % args
     end
 
     # Indent and print args to the underlying device. #puts has the same semantic
     # as Kernel#puts
     def puts(*args)
-      args.each { |arg| print(arg, "\n") }
+      write args.join("\n"), "\n"
       nil
     end
 
     # Indent and print args to the underlying device. #p has the same semantic
     # as Kernel#p. Please note that #p is usually not defined on other classes
-    # then Kernel but can be used on any IndentedIO object
+    # than Kernel but can be used on any IndentedIO object
     def p(*args)
       if bol
-        args.each { |arg| print(arg.inspect, "\n") }
+        args.each { |arg| write(arg.inspect, "\n") }
       else
-        @device.print args.first.inspect, "\n"
+        @device.write(args.first.inspect, "\n")
         bol = true
-        args[1..-1].each { |arg| print(arg.inspect, "\n") }
+        args[1..-1].each { |arg| write(arg.inspect, "\n") }
       end
       args.size == 1 ? args.first : args
     end
@@ -146,18 +152,5 @@ module IndentedIO
         self.bol = (bol.nil? ? true : bol)
       end
     end
-
-  public
-    # @!visibility private 
-    def dump
-      $stderr.puts "#{self.class} [#{self.object_id}]"
-      $stderr.puts "  device: #{device.class} [#{device.object_id}]"
-      $stderr.puts "  base  : #{base.class} [#{base.object_id}]"
-      $stderr.puts "  parent: #{parent.class} [#{parent.object_id}]"
-      $stderr.puts "  levels: #{levels}"
-      $stderr.puts "  this_indent: #{this_indent.inspect}"
-      $stderr.puts "  combined_indent: #{combined_indent.inspect}"
-      $stderr.puts "  bol: #{bol}"
-    end
   end
 end

data/lib/indented_io/indented_io_interface.rb

@@ -1,12 +1,12 @@
 module IndentedIO
   # IndentedIO interface that provides the #indent method. It is used by IO,
   # StringIO, and IndentedIO but can be included in any class that define a
-  # #print method like this:
+  # #write method like this:
   #
   #   require 'indented_io'
   #   class MyIO
   #     include IndentedIO::IndentedIOInterface
-  #     def print(*args) ... end
+  #     def write(*args) ... end
   #   end
   #
   #   my_io = MyIO.new

data/lib/indented_io/version.rb

@@ -1,4 +1,4 @@
 module IndentedIO
   # Version number
-  VERSION = "0.7.3"
+  VERSION = '0.8.0'
 end

data/scripts/perf.rb

@@ -56,7 +56,7 @@ dynamic_wo_indent = timeit {
 }
 
 dynamic_w_indent = nil
-indent("  ") {
+indent(:string => "  ") {
   dynamic_w_indent = timeit { puts "Indented" }
 }
 

metadata

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