indented_io 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '097c526b0eeabff0b3be7d1483a6bac19232b803ddb630457c56ca4e7d180cea'
-  data.tar.gz: 0a6dc9f1bdf3dbc325ea52d06298b67dd7be389297baadc85d773e4f23edd329
+  metadata.gz: c36c671ed19295dbc8816818028ce7d561f572c8aacc340c5d84236ce19a1e1e
+  data.tar.gz: 87b38c79f9ccce609c0a165438f62b2dd5194e1cb00df4b98623856f134019a1
 SHA512:
-  metadata.gz: 516212abf50023dd89352d55f2bf2745e367cf3e0646d3f0dc1c5d6a8193cf0fdc8053beec7259e978ad7bd94791cd6e8476c9ba101e2a066b93b311d9589b84
-  data.tar.gz: 4b8ead522fa1830c8c31888cded99ae00679737dd6f3560ebe9214190b27c38b2af2ff224437cb8c7be5e2de7fe338ca06525d5d7d980eb088f5dbc996380e6b
+  metadata.gz: b04768c215fa7fd6baf00c6f99915dd43bcaa36db6bb3f8c140f0d43f2cd8b721c246f6cdb1e380e0f8bf718dbcc26961dff665a1163a1eccf5a0395113b9178
+  data.tar.gz: 8d689f7775d01772ece81d43cc8100d8e7e484c406e61ac84a84b0204a4708cd7436477d8af12c1c3ed3a28b8acfb6938ec24df3f7b9c8b41e9628a6ebe7396b

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 ">> "
@@ -153,8 +153,8 @@ class MyIO
 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

@@ -7,8 +7,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/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

data/lib/indented_io/version.rb

@@ -1,4 +1,4 @@
 module IndentedIO
   # Version number
-  VERSION = '0.8.0'
+  VERSION = '0.8.1'
 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.1
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-13 00:00:00.000000000 Z
+date: 2018-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler