indented_io 0.7.3 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f678cdfa6edee19dad6a5256367071ceea8d1ca7ebb5dd4556330f260250e0e1
-  data.tar.gz: a2cb615747e62ca14ed25b872ae501c9f6b0dbaadd1a9ec73f3a2dbfcd519f61
+  metadata.gz: 2065a8b32b45c15d23fca5af4899cde35fefae5e1df980bfcf90423aa0884cc2
+  data.tar.gz: 83aad862d7eefe03af50b833f94579bcb67dd9a049d7827ac354949055d9fb9d
 SHA512:
-  metadata.gz: 914ca7aef4d7017fc4899c2f1cc19da8a7cf6bacc7c0937bd28033bef7cb2350f3878bd0ac9380301d4e2b0cb7df6aded579085a7a52c0f48206e80dbe6b3a7a
-  data.tar.gz: 5dcf284b39596f7faaff975d2e703125caa157c133646a1aa9a2147bb95b7c4c852de61c3bcdc872208c08d79a7d4acc42a0170d168d66e9a56199082ed5d328
+  metadata.gz: 4a3e1eef0a3a6d2807504c4d000a39d08093bb44381ed6eac0c1d1ae5c7dccf5e60a0c00fd07316c19329e5e1f49fb3b4662adbfb0df82a55c0206f2d6915f4e
+  data.tar.gz: ba4d79601f35265184d85629a57773b34cca6b7913220c629d332b2762762dc946337f21b4ce9c4b896866ef8efa99b4a9d5748f27ce93a71c31a5d9a2c0e4ed

data/README.md

@@ -11,9 +11,9 @@ adds to the previous indendation
 ```ruby
 require 'indented_io'
 
-puts "Not indented"
-indent { puts "Indented one level" }
-indent(2, "* ").puts "Indented two levels"
+puts 'Not indented'
+indent { puts 'Indented one level' }
+indent(2, '* ').puts 'Indented two levels'
 ```
 
 outputs
@@ -32,9 +32,9 @@ If given a block, the block will be called with the IndentedIO object as
 argument:
 
 ```ruby
-$stdout.puts "Not indented"
-$stdout.indent.puts "Indented"
-$stdout.indent { |f| f.puts "Indented" }
+$stdout.puts 'Not indented'
+$stdout.indent.puts 'Indented'
+$stdout.indent { |f| f.puts 'Indented' }
 
 # Not indented
 #   Indented
@@ -51,10 +51,10 @@ symbolic argument `:string`. If level is negative, the text will be outdented
 instead:
 
 ```ruby
-$stdout.puts "Not indented"
-$stdout.indent(2, "> ") do |f|
-  f.indent(string: "* ").puts "Indented three levels"
-  f.indent(-1).puts "Indented one level"
+$stdout.puts 'Not indented'
+$stdout.indent(2, '> ') do |f|
+  f.indent(string: '* ').puts 'Indented three levels'
+  f.indent(-1).puts 'Indented one level'
 end
 
 # Not indented
@@ -71,15 +71,15 @@ that `Kernel#print`, `Kernel#printf`, `Kernel#puts`, and `Kernel#p` will output
 indented within that block:
 
 ```ruby
-puts "Not indented"
+puts 'Not indented'
 indent do
-  puts "Indented one level"
+  puts 'Indented one level'
   indent do
-    puts "Indented two levels"
+    puts 'Indented two levels'
   end
-  puts "Indented one level"
+  puts 'Indented one level'
 end
-puts "Not indented"
+puts 'Not indented'
 
 # Not indented
 #   Indented one level
@@ -95,8 +95,8 @@ def legacy(phrase)
   puts phrase
 end
 
-legacy("Not indented")
-indent { legacy("Indented" }
+legacy('Not indented')
+indent { legacy('Indented' }
 
 # Not indented
 #   Indented
@@ -111,8 +111,8 @@ that specify if the output device is at the beginning of a line and that printin
 should start with an indentation string:
 
 ```ruby
-indent(1, bol: true).puts "Indented"
-indent(1, bol: false).puts "Not indented\nIndented"
+indent(1, bol: true).puts 'Indented'
+indent(1, bol: false).puts 'Not indented\nIndented'
 
 #   Indented
 # Not indented
@@ -124,7 +124,7 @@ indent(1, bol: false).puts "Not indented\nIndented"
 The default indentation string is defined in `IndentedIO`:
 
 ```ruby
-IndentedIO.default_indent = ">> "
+IndentedIO.default_indent = '>> '
 indent.puts "Indented by #{IndentedIO.default_indent.inspect}"
 
 # >> Indented by ">> "
@@ -142,19 +142,19 @@ 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 write(*args) ... end
 end
 
 my_io = MyIO.new
-my_io.puts "Not indented"
-my_io.indent.puts "It works!"
+my_io.puts 'Not indented'
+my_io.indent.puts 'It works!'
 
 # Not indented
 #   It works!
@@ -168,13 +168,13 @@ with a block without parameters manipulates `$stdout`, replacing it with an
 `IndentedIO` object for the duration of the block
 
 The implementation carries no overhead if it is not used but the core
-indentation mechanism processes characters one-by-one which is about 10-15
-times slower than a handwritten implementation (scripts/perf.rb is a script to
-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
+indentation mechanism processes characters one-by-one which is about 7-8 times
+slower than a handwritten implementation (scripts/perf.rb is a script to 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.25us to 1us while using IndentedIO slows it down to between
+2us and 8us, so IndentedIO won't cause a noticeable slow 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
 
+  + 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/indented_io.gemspec

@@ -37,6 +37,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/indented_io/indented_io.rb

@@ -20,48 +20,48 @@ module IndentedIO
       interface_indent(levels, string, bol: bol, &block)
     end
 
+    # Indent and print args to the underlying device. #write has the same semantic
+    # as IO#write
+    def write(*args)
+      str = args.join
+      return if str.empty?
+      s = (bol && str[0] != "\n" ? @combined_indent : "") + str.gsub(/\n([^\n])/m, "\n#{@combined_indent}\\1")
+      self.bol = (s[-1] == "\n")
+      @device.write(s)
+    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
-      args.join.each_char { |c|
-        if c == "\n"
-          self.bol = true
-        elsif bol
-          @device.print @combined_indent
-          self.bol = false
-        end
-        @device.print c
-      }
+      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
+    # 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
     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
@@ -69,7 +69,7 @@ module IndentedIO
     # Make IndentedIO behave like the underlying @device
     # @!visibility private 
     def respond_to?(method)
-      [:indent, :level, :print, :puts, :p].include?(method) || device.respond_to?(method)
+      [:indent, :level, :print, :printf, :puts, :p].include?(method) || device.respond_to?(method)
     end
 
     # Make IndentedIO behave like the underlying @device
@@ -85,8 +85,8 @@ module IndentedIO
     attr_reader :device
 
     # First IndentedIO object on the stack. Equal to self if self is the first
-    # indentation object. #base is used to keep track of #bol for the whole
-    # stack of IndentedIO objects
+    # 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
@@ -146,18 +146,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,13 @@
 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
@@ -18,7 +19,7 @@ module IndentedIO
   #
   module IndentedIOInterface
     # Returns a IndentedIO object that can be used for printing. The IO object
-    # will pass-through all method to the underlying device except #print,
+    # 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

data/lib/indented_io/kernel.rb

@@ -3,7 +3,7 @@ require 'indented_io/indented_io_interface'
 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:
+  # an argument. In that case it manipulates $stdout to print indented:
   #
   #   puts "Not indented
   #   indent do

data/lib/indented_io/stringio.rb

@@ -1,3 +1,4 @@
+require 'stringio' # Requiered to avoid 'superclass mismatch' errors in other modules
 require 'indented_io/indented_io_interface'
 
 # Includes the IndentedIOInterface that define the #indent method

data/lib/indented_io/version.rb

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

data/scripts/perf.rb

@@ -7,15 +7,24 @@ RUNS = 1_000_000
 saved_stdout = $stdout
 $stdout = File.open("/dev/null", "w")
 
-def timeit(&block)
+$base = 0.0
+
+def timeit_impl(&block)
   t0 = Time.now
   RUNS.times {
     yield
   }
   t1 = Time.now
-  (1000 * (t1 - t0)).round(0)
+  t1 - t0 - $base
 end
 
+$base = timeit_impl {}
+
+def timeit(&block)
+  (1000 * timeit_impl(&block)).round(0)
+end
+
+
 def report(title, wo_indent, w_indent)
   times = (w_indent / wo_indent).round(1)
   if times < 1.1
@@ -56,7 +65,7 @@ dynamic_wo_indent = timeit {
 }
 
 dynamic_w_indent = nil
-indent("  ") {
+indent(:string => "  ") {
   dynamic_w_indent = timeit { puts "Indented" }
 }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: indented_io
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.8.4
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-13 00:00:00.000000000 Z
+date: 2021-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +28,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -104,8 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Print indented text