heredoc_unindent 1.0.0 → 1.0.1

data.tar.gz.sig

@@ -0,0 +1,2 @@
+p���x[ΙXh��I�3$�ku;#.�^�&�9i{{�uc4�nN����>�S�{�MN����Д���I�?�]�"���}���,8�"ȉT}�����h��4<�+~���<š��AB�c񀜏1%Kг�CT�#J�E}թ�?}�5.5�N
+>?�B'/Z�5)BP�+k?zP/��h�n��eBS8�����

data/History.rdoc

@@ -0,0 +1,21 @@
+=== 1.0.1 / 2011-01-26
+
+* 7 minor enhancements
+
+  * One test added for 100% code coverage
+  * Changed extension of History and Wishlist from _txt_ to _rdoc_ so
+    that GitHub parses them accordingly
+  * Added History and Wishlist to the RDoc documentation (extra_rdoc_files)
+  * Minor additions/editions to README
+  * Refactored HeredocUnindent module into CoreExt::String::HeredocUnindent
+  * Moved version information from VERSION constant in HeredocUnindent module
+    to <tt>self.version = 'x.x.x'</tt> in Rakefile
+  * Removed irrelevant Rakefile comments
+  
+
+=== 1.0.0 / 2011-01-16
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -1,6 +1,7 @@
-History.txt
+History.rdoc
 Manifest.txt
 README.rdoc
 Rakefile
+Wishlist.rdoc
 lib/heredoc_unindent.rb
 test/test_heredoc_unindent.rb

data/README.rdoc

@@ -8,28 +8,35 @@ Removes common margin from indented strings such as the ones produced by
 heredocs, i.e., strips out leading whitespace chars at the beggining of
 each line (but only as much as the line with the smallest margin).
 
+It is acknowledged that many strings defined in heredocs contain nothing but
+code to be read exclusively by parsers (e.g., Kernel#eval or web browser's),
+which are basically insensitive to extra indentation. Nevertheless, in cases
+when the string is printed or displayed, the unintended indentation is rarely
+innocuous -- and thus the reason for this gem.
+
 == SYNOPSIS:
 
   if true
     puts <<-EOS.unindent
-      How wonderful it is
+      "How wonderful it is
         to be able
-      to unindent heredocs
+      to unindent heredocs"
     EOS
   end
 
 produces
 
-  How wonderful it is
+  "How wonderful it is
     to be able
-  to unindent heredocs
+  to unindent heredocs"
 
 instead of
 
-        How wonderful it is
+        "How wonderful it is
           to be able
-        to unindent heredocs
-      
+        to unindent heredocs"
+
+which would result without #unindent.
 
 == REQUIREMENTS:
 

data/Rakefile

@@ -3,25 +3,14 @@
 require 'rubygems'
 require 'hoe'
 
-# Hoe.plugin :compiler
-# Hoe.plugin :cucumberfeatures
-# Hoe.plugin :gem_prelude_sucks
-# Hoe.plugin :inline
-# Hoe.plugin :manifest
-# Hoe.plugin :newgem
-# Hoe.plugin :racc
-# Hoe.plugin :rubyforge
-# Hoe.plugin :website
-
 Hoe.spec 'heredoc_unindent' do
-  # HEY! If you fill these out in ~/.hoe_template/Rakefile.erb then
-  # you'll never have to touch them again!
-  # (delete this comment too, of course)
-
   developer('Adriano Mitre', 'adriano.mitre@gmail.com')
   
+  self.version = '1.0.1'
+  
   self.readme_file = 'README.rdoc'
-  self.extra_rdoc_files << 'README.rdoc'
+  self.history_file = 'History.rdoc'
+  self.extra_rdoc_files += ['README.rdoc', 'History.rdoc', 'Wishlist.rdoc']
 
   # self.rubyforge_name = 'heredoc_unindentx' # if different than 'heredoc_unindent'
 end
@@ -31,4 +20,3 @@ end
 task :tests => [:test] do
   # aliasing :test with :tests for RVM ('rvm tests')
 end
-

data/Wishlist.rdoc

@@ -0,0 +1,10 @@
+== SUGGESTIONS
+
+* Benchmark heredoc_unindent against alternatives:
+  * outdent
+  * unindent
+  * the code posted by Rene Saarsoo in his answer in StackOverflow.
+  and then
+  * if there are significant performance differences, contact the other authors
+    and suggest unifying gems, keeping the fastest implementation
+  * mention the results in README (table?)

data/lib/heredoc_unindent.rb

@@ -1,42 +1,41 @@
-# This module, which is included in String, define the heredoc unindentation method
-# +heredoc_unindent+ and alias it as +unindent+.
-#
-module HeredocUnindent
+module CoreExt
+  module String
+    module HeredocUnindent
+    #
+    # This module, which is included in String, define the heredoc unindentation method
+    # +heredoc_unindent+ and alias it as +unindent+.
+    ##
+     
+      # Removes common margin from indented strings such as the ones produced by
+      # heredocs, i.e., strips out leading whitespace chars at the beggining of
+      # each line (but only as much as the line with the smallest margin).
+      #
+      # Unless the optional argument +warn_first_dif_min+ is set to false or nil, a
+      # warning is produced when the margin of the first line differs from the minimum.
+      #
+      def heredoc_unindent(warn_first_dif_min=true)
+        min_margin = self.scan(/^\s*/).map(&:size).min
+        if warn_first_dif_min
+          first_margin = self[/^\s*/].size
+          if first_margin != min_margin
+            puts "warning: margin of the first line differs from minimum margin"
+          end
+        end
+        re = Regexp.new('^\s{0,' + min_margin.to_s + '}'  ) # omitting the lower limit produces warnings and wrong behavior in ruby-1.8.7-p330 and ree-1.8.7-2010.02
+        self.gsub(re, '')
+      end
+      alias unindent heredoc_unindent
 
-  VERSION = '1.0.0'
- 
-  # Removes common margin from indented strings such as the ones produced by
-  # heredocs, i.e., strips out leading whitespace chars at the beggining of
-  # each line (but only as much as the line with the smallest margin).
-  #
-  # Unless the optional argument +warn_first_dif_min+ is set to false or nil, a
-  # warning is produced when the margin of the first line differs from the minimum.
-  #
-  def heredoc_unindent(warn_first_dif_min=true)
-    min_margin = self.scan(/^\s*/).map(&:size).min
-    if warn_first_dif_min
-      first_margin = self[/^\s*/].size
-      if first_margin != min_margin
-        puts "warning: margin of the first line differs from minimum margin"
+      # Performs HeredocUnindent#heredoc_unindent in place, returning self, or nil if no changes were made
+      #
+      def  heredoc_unindent!(warn_first_dif_min=true)
+        orig = self.dup
+        self.replace(self.heredoc_unindent(warn_first_dif_min))
+        self != orig ? self : nil
       end
+      alias unindent! heredoc_unindent!
     end
-    re = Regexp.new('^\s{0,' + min_margin.to_s + '}'  ) # omitting the lower limit produces warnings and wrong behavior in ruby-1.8.7-p330 and ree-1.8.7-2010.02
-    self.gsub(re, '')
-  end
-  alias unindent heredoc_unindent
-
-  # Performs HeredocUnindent#heredoc_unindent in place, returning self, or nil if no changes were made
-  #
-  def  heredoc_unindent!(warn_first_dif_min=true)
-    orig = self.dup
-    self.replace(self.heredoc_unindent(warn_first_dif_min))
-    self != orig ? self : nil
+    
+    ::String.class_eval { include ::CoreExt::String::HeredocUnindent }
   end
-  alias unindent! heredoc_unindent!
-  
 end
-
-class String # :nodoc:
-  include HeredocUnindent
-end
-

data/test/test_heredoc_unindent.rb

@@ -83,4 +83,16 @@ EOS
     assert_equal nil, ugly.unindent!(false)
   end
   
+  def test_warning
+    ugly, pretty = prep_sing1
+    filename = "/tmp/#{rand(2**64)}"
+    File.open(filename, "w") do |f|
+      $stdout = f
+      ugly.unindent(true)
+      $stdout = STDOUT
+    end
+    assert File.exist?(filename), "file should exist"
+    assert_equal File.read(filename).chomp, "warning: margin of the first line differs from minimum margin"
+  end
+  
 end

metadata

@@ -1,21 +1,41 @@
 --- !ruby/object:Gem::Specification 
 name: heredoc_unindent
 version: !ruby/object:Gem::Version 
-  hash: 23
   prerelease: false
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Adriano Mitre
 autorequire: 
 bindir: bin
-cert_chain: []
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDPDCCAiSgAwIBAgIBADANBgkqhkiG9w0BAQUFADBEMRYwFAYDVQQDDA1hZHJp
+  YW5vLm1pdHJlMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZ
+  FgNjb20wHhcNMTEwMTE3MDYxMzM3WhcNMTIwMTE3MDYxMzM3WjBEMRYwFAYDVQQD
+  DA1hZHJpYW5vLm1pdHJlMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJ
+  k/IsZAEZFgNjb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC0jjDX
+  O0FdShLgTHub1H7nzZEM/6V26DwJwAn9J8SsLP2tPMO3m0whJF1/cCsy7kofevpo
+  uoJVhLC3W8FxQ30Kue9CpMTBGLeHkGlB9hqIRSuHUPtG49nqCSbtew3/uZb7NTYk
+  i4guvx/AKwVIJkvgzoxp+BVdmslylZW8kf6xvM6TI+lI3b1oISJRnZaJ5wSG1e62
+  A0jJ6rCWowdBhfV2Lc3GvqGWKpFkZiujRWEjf3DuyRJALUjRFt3og5S1LFTC/E8k
+  22l7fNhFtQQWIQ0bvWgr1CVjaC+Mj7Yd/dH1YjFjNSGjeVC70uvwcpa+GAHUTvW+
+  3MJwcABAEx3/k1dVAgMBAAGjOTA3MAkGA1UdEwQCMAAwHQYDVR0OBBYEFCe5ttae
+  SfcWo9+mP1ZzFzPfo2N1MAsGA1UdDwQEAwIEsDANBgkqhkiG9w0BAQUFAAOCAQEA
+  NWDEWS5ZRu2tDbMmAHsNqjxQmdbICp0GiUa4LT5ihdRpaObHp9r+DbcHXmshYiTg
+  rJmflLzpoUvuNYkvgMOXtu7zzLlrm7RsY2r0Z/BbHkxSdX0dpg6s0PcROUnUCdbZ
+  CLiXywPX9ZUvOcF35Cz/HZkWo1zSBz5WtUjSodH9L0ASMboQIIWM8aNd80aV+qYC
+  3UBBz1sni91YXPxf7FQxJtIXlNO04DAAHy9J7M22zWpUFRZOJynnDZWsOx3lifKX
+  1PyL4lke+kXB8DF3QA2RqMPmEZp/FgDqYZy1VT1ROlxyatgDgcFBmrsyjnb9hi9N
+  9u8N6mQNneIVRh6Xfdko/Q==
+  -----END CERTIFICATE-----
 
-date: 2011-01-17 00:00:00 -02:00
+date: 2011-01-26 00:00:00 -02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +46,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 47
         segments: 
         - 2
         - 8
@@ -38,6 +57,12 @@ description: |-
   Removes common margin from indented strings such as the ones produced by
   heredocs, i.e., strips out leading whitespace chars at the beggining of
   each line (but only as much as the line with the smallest margin).
+  
+  It is acknowledged that many strings defined in heredocs contain nothing but
+  code to be read exclusively by parsers (e.g., Kernel#eval or web browser's),
+  which are basically insensitive to extra indentation. Nevertheless, in cases
+  when the string is printed or displayed, the unintended indentation is rarely
+  innocuous -- and thus the reason for this gem.
 email: 
 - adriano.mitre@gmail.com
 executables: []
@@ -45,14 +70,16 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
 - Manifest.txt
 - README.rdoc
+- History.rdoc
+- Wishlist.rdoc
 files: 
-- History.txt
+- History.rdoc
 - Manifest.txt
 - README.rdoc
 - Rakefile
+- Wishlist.rdoc
 - lib/heredoc_unindent.rb
 - test/test_heredoc_unindent.rb
 has_rdoc: true
@@ -70,7 +97,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -79,7 +105,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -89,6 +114,6 @@ rubyforge_project: heredoc_unindent
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Removes common margin from indented strings such as the ones produced by heredocs, i.e., strips out leading whitespace chars at the beggining of each line (but only as much as the line with the smallest margin).
+summary: Removes common margin from indented strings such as the ones produced by heredocs, i.e., strips out leading whitespace chars at the beggining of each line (but only as much as the line with the smallest margin)
 test_files: 
 - test/test_heredoc_unindent.rb

data/History.txt

@@ -1,6 +0,0 @@
-=== 1.0.0 / 2011-01-16
-
-* 1 major enhancement
-
-  * Birthday!
-