heredoc_unindent 1.0.6 → 1.1.0

data/History.rdoc

@@ -1,3 +1,15 @@
+=== 1.1.0 / 2011-01-29
+
+* 3 minor enhancements
+
+  * Added a new #unindent_base implementation
+    * 50--62% faster on ruby-1.9.2-p136, jruby-1.5.6 and rbx-1.2.0
+    * 10--20% slower in ruby-1.8.7-p330 and ree-1.8.7-2010.02
+    * so the old one is kept and the fastest for your VM is automatically chosen on load-time
+  * Created a couple scripts to benchmark unindenting implementations
+    * available on the GitHub repository, but not included in the gem
+  * Improved ALTERNATIVES section of README with performance results extracted from benchmarking
+
 === 1.0.6 / 2011-01-27
 
 * 1 minor enhancement

data/README.rdoc

@@ -70,14 +70,28 @@ Based on the answer by Rene Saarsoo to the question
 
 == ALTERNATIVES
 
-Despite minor API differences, extra-features availability or edge-case behaviour, the
-following gems implement the same unindenting functionality and are essentially equivalent to heredoc_unindent:
-* {outdent}[http://rubygems.org/gems/outdent] (formerly {unindentable}[http://rubygems.org/gems/unindentable])
-* {unindent}[http://rubygems.org/gems/unindent]
-
-And the following gem, which has a much broader scope, also features a method
-with equivalent functionality:
-* {indentation}[http://rubygems.org/gems/indentation] -- String#reset_indentation method
+Despite minor API differences or edge-case behaviour, the following gems
+implement equivalent unindenting functionality:
+
+1. {outdent}[http://rubygems.org/gems/outdent] (formerly {unindentable}[http://rubygems.org/gems/unindentable])
+2. {unindent}[http://rubygems.org/gems/unindent]
+3. {indentation}[http://rubygems.org/gems/indentation] -- this gem has a broader scope, besides String#reset_indentation
+
+=== So why another one?
+
+Well, the Fact is that the author only found about the other gems after he had
+already implemented heredoc_unindent. And, frankly, that was fortunate:
+benchmarking revealed that heredoc_unindent is by far the most efficient, both
+in space (memory) and time (cycles).
+
+=== Efficiency!
+
+Depending on the Ruby implementation, heredoc_unindent is is about *1.6--2.4x*
+*faster* than {unindent}[http://rubygems.org/gems/unindent], *1.9--6.6x*
+*faster* than {indentation}[http://rubygems.org/gems/indentation],
+and *4--19x* *faster* than {outdent}[http://rubygems.org/gems/outdent].
+In addition, heredoc_unindent has the *lowest* *memory* *consumption*,
+requiring only between a fifth and a sixth of the competitors.
 
 == LICENSE:
 

data/Rakefile

@@ -6,7 +6,7 @@ require 'hoe'
 Hoe.spec 'heredoc_unindent' do
   developer('Adriano Mitre', 'adriano.mitre@gmail.com')
   
-  self.version = '1.0.6'
+  self.version = '1.1.0'
   
   self.readme_file = 'README.rdoc'
   self.history_file = 'History.rdoc'

data/lib/heredoc_unindent.rb

@@ -8,23 +8,56 @@ module CoreExt
      
       private
       
-      # Actual implementation of the unindentation mechanism,
+      # Actual implementations of the unindentation mechanism,
       # both for in and out-of-place processing.
       #
+      # @note The only reason there are two implementations is because the new
+      #       one is slower than the old one on MRI and REE 1.8.7. The fastest
+      #       implementation is automatically chosen based on the virtual
+      #       machine being executed.
+      #
       # @param [Boolean] warn_first_not_min 
       # @param [Boolean] in_place
       # @return [String, nil]
       #
-      def unindent_base(in_place, warn_first_not_min)
+      
+      # about 50% faster in jruby, 56% in ruby-1.9.2, 62% in rbx-1.2.0 (new vs old)
+      #
+      def unindent_base_new(in_place, warn_first_not_min)
+        m_first = nil
+        m_min = nil
+        self.scan(/^\s*/) do |m|
+          ms = m.size
+          m_first ||= ms
+          m_min = ms if !m_min || ms < m_min
+          # break if ms == 0 ## only worth if the probability of marginless line above certain threshold
+        end
+        if m_first != m_min && warn_first_not_min
+          puts "warning: margin of the first line differs from minimum margin"
+        end
+        return in_place ? nil : self.dup unless m_min > 0
+        re = Regexp.new('^\s{' + m_min.to_s + '}'  )
+        in_place ? gsub!(re, '') : gsub(re, '')
+      end
+      
+      # about 10% faster in ree, 20% in ruby-1.8.7 (old vs new)
+      #
+      def unindent_base_old(in_place, warn_first_not_min)
         margins = self.scan(/^\s*/).map(&:size)
         margins_min = margins.min
         if margins.first != margins_min && warn_first_not_min
           puts "warning: margin of the first line differs from minimum margin"
         end
         return in_place ? nil : self.dup unless margins_min != 0
-        re = Regexp.new('^\s{0,' + margins_min.to_s + '}'  ) # omitting the lower limit produces warnings and wrong behavior in ruby-1.8.7-p330 and ree-1.8.7-2010.02
+        re = Regexp.new('^\s{' + margins_min.to_s + '}'  )
         in_place ? gsub!(re, '') : gsub(re, '')
       end
+
+      if RUBY_VERSION >= '1.9' || defined?(RUBY_DESCRIPTION) && (RUBY_DESCRIPTION =~ /jruby/i || RUBY_DESCRIPTION =~ /rubinius/i)
+        alias unindent_base unindent_base_new
+      else
+        alias unindent_base unindent_base_old
+      end
       
       public
     

data/test/test_heredoc_unindent.rb

@@ -37,7 +37,7 @@ EOS
   def prep_sing3
     ugly = <<-EOS
       The first line
-  
+
       The third line    
     EOS
     

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: heredoc_unindent
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 19
+  prerelease: 
   segments: 
   - 1
+  - 1
   - 0
-  - 6
-  version: 1.0.6
+  version: 1.1.0
 platform: ruby
 authors: 
 - Adriano Mitre
@@ -35,7 +36,7 @@ cert_chain:
   9u8N6mQNneIVRh6Xfdko/Q==
   -----END CERTIFICATE-----
 
-date: 2011-01-27 00:00:00 -02:00
+date: 2011-01-29 00:00:00 -02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,6 +47,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 47
         segments: 
         - 2
         - 8
@@ -97,6 +99,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -105,13 +108,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: heredoc_unindent
-rubygems_version: 1.3.7
+rubygems_version: 1.4.1
 signing_key: 
 specification_version: 3
 summary: This gem removes common margin from indented strings, such as the ones produced by indented heredocs