indented_io 0.8.0 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '097c526b0eeabff0b3be7d1483a6bac19232b803ddb630457c56ca4e7d180cea'
-  data.tar.gz: 0a6dc9f1bdf3dbc325ea52d06298b67dd7be389297baadc85d773e4f23edd329
+  metadata.gz: b381c1136988e46a6a79848db05b1563a6704619775b4945e879c1efeb0dfc7a
+  data.tar.gz: 7296f2367c4eecb9037bf9c2f4492ee21ff3d8520c841ad95f9c06527f9cf8f8
 SHA512:
-  metadata.gz: 516212abf50023dd89352d55f2bf2745e367cf3e0646d3f0dc1c5d6a8193cf0fdc8053beec7259e978ad7bd94791cd6e8476c9ba101e2a066b93b311d9589b84
-  data.tar.gz: 4b8ead522fa1830c8c31888cded99ae00679737dd6f3560ebe9214190b27c38b2af2ff224437cb8c7be5e2de7fe338ca06525d5d7d980eb088f5dbc996380e6b
+  metadata.gz: 216242b00c20a64f0a6f4394f7587bb4d663864814bfcae5ab96b76401ae9498eb0fbc9211b2aa7addbe2c2321397ad8b8cf70329eea60f8b8434346302198f3
+  data.tar.gz: d0dcd905b87f2c024137d3a862c1ae8ad9b345e38cec918a0e8d1a1b2a678edc66196d112d6608d98fbb94f462aae61c37d698b13fd533dc5f4125750ea2ddab

data/.ruby-version

@@ -1 +1 @@
-ruby-2.5.0
+ruby-2.7.1

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 ">> "
@@ -149,12 +149,12 @@ the class define a `#write` method with the same semantics as `IO#write`
 require 'indented_io'
 class MyIO
   include IndentedIO::IndentedIOInterface
-  def writte(*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 unless you do a lot of output
+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

@@ -1,5 +1,7 @@
 
 TODO
+  o Find a solution for the inclusion of StringIO and Tempfile (the last is 
+    required by ruby 2.7 - see also note in lib/indented_io/tempfile.rb
   o Check if IO object is writable - no good solution ?
   o better name for @this_indent ? 'string' ?
   o Reimplement core loop in C
@@ -7,8 +9,8 @@ TODO
   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
 
+  + 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:

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.rb

@@ -6,6 +6,7 @@ require 'indented_io/indented_io_interface'
 require 'indented_io/kernel'
 require 'indented_io/io'
 require 'indented_io/stringio'
+require 'indented_io/tempfile'
 
 # IndentedIO module. See {IndentedIO::IndentedIO} for documentation on how to 
 # use this module

data/lib/indented_io/indented_io.rb

@@ -23,17 +23,11 @@ module IndentedIO
     # 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
-          n_bytes += @device.write(@combined_indent)
-          self.bol = false
-        end
-        n_bytes += @device.write(c)
-      }
-      n_bytes
+      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
@@ -59,8 +53,8 @@ module IndentedIO
     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
-    # than 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| write(arg.inspect, "\n") }
@@ -74,8 +68,8 @@ 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)
+    def respond_to?(method, include_all = false)
+      [:indent, :level, :print, :printf, :puts, :p].include?(method) || device.respond_to?(method)
     end
 
     # Make IndentedIO behave like the underlying @device
@@ -91,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

data/lib/indented_io/indented_io_interface.rb

@@ -4,6 +4,7 @@ module IndentedIO
   # #write method like this:
   #
   #   require 'indented_io'
+  #
   #   class MyIO
   #     include IndentedIO::IndentedIOInterface
   #     def write(*args) ... end
@@ -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.8.0'
+  VERSION = '0.8.5'
 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: indented_io
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.5
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-13 00:00:00.000000000 Z
+date: 2021-04-15 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.1.4
 signing_key: 
 specification_version: 4
 summary: Print indented text