heredoc_unindent 1.0.0

data/History.txt

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

data/Manifest.txt

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

data/README.rdoc

@@ -0,0 +1,90 @@
+= heredoc_unindent
+
+* https://github.com/adrianomitre/heredoc_unindent
+
+== 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).
+
+== SYNOPSIS:
+
+  if true
+    puts <<-EOS.unindent
+      How wonderful it is
+        to be able
+      to unindent heredocs
+    EOS
+  end
+
+produces
+
+  How wonderful it is
+    to be able
+  to unindent heredocs
+
+instead of
+
+        How wonderful it is
+          to be able
+        to unindent heredocs
+      
+
+== REQUIREMENTS:
+
+* None: this gem does not depend on any other gem.
+
+== INSTALL:
+
+* sudo gem install heredoc_unindent
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+== ACKNOWLEDGEMENTS
+
+Based on the answer by Rene Saarsoo to the question
+{how do i remove leading whitespace chars from ruby heredoc}[http://stackoverflow.com/questions/3772864/how-do-i-remove-leading-whitespace-chars-from-ruby-heredoc].
+
+== 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
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 Adriano Mitre
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,34 @@
+# -*- ruby -*-
+
+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.readme_file = 'README.rdoc'
+  self.extra_rdoc_files << 'README.rdoc'
+
+  # self.rubyforge_name = 'heredoc_unindentx' # if different than 'heredoc_unindent'
+end
+
+# vim: syntax=ruby
+
+task :tests => [:test] do
+  # aliasing :test with :tests for RVM ('rvm tests')
+end
+

data/lib/heredoc_unindent.rb

@@ -0,0 +1,42 @@
+# This module, which is included in String, define the heredoc unindentation method
+# +heredoc_unindent+ and alias it as +unindent+.
+#
+module HeredocUnindent
+
+  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"
+      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
+
+  # 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
+
+class String # :nodoc:
+  include HeredocUnindent
+end
+

data/test/test_heredoc_unindent.rb

@@ -0,0 +1,86 @@
+require "rubygems"
+require "test/unit"
+require File.expand_path("../../lib/heredoc_unindent", __FILE__)
+
+class TestHeredocUnindent < Test::Unit::TestCase
+
+  def prep_sing1
+    ugly = <<-EOS
+      that
+    is
+      weird
+    EOS
+    
+    pretty  = <<EOS
+  that
+is
+  weird
+EOS
+    return ugly, pretty
+  end
+  
+  def prep_sing2
+    ugly = <<-EOS
+      for k in 1 .. 10
+        puts k
+      end
+    EOS
+    
+    pretty  = <<EOS
+for k in 1 .. 10
+  puts k
+end
+EOS
+    return ugly, pretty
+  end
+    
+  def prep_sing3
+    ugly = <<-EOS
+      The first line
+  
+      The third line    
+    EOS
+    
+    pretty  = <<EOS
+The first line
+
+The third line    
+EOS
+    return ugly, pretty
+  end
+
+  def prep_mult
+    ugly = <<-BEGIN + "      <--- middle --->\n" + <<-END
+      This is the beginning:
+      BEGIN
+        And now it is over!
+    END
+    pretty = <<EOS
+This is the beginning:
+<--- middle --->
+  And now it is over!
+EOS
+    return ugly, pretty
+  end
+  
+  def test_unindent
+    perform_tests(*prep_sing1)
+    perform_tests(*prep_sing2)
+    perform_tests(*prep_mult)
+  end
+
+  def perform_tests(ugly, pretty)
+    ugly_bak = ugly.dup
+    assert_equal pretty, ugly.unindent(false)
+    assert_equal pretty, ugly.heredoc_unindent(false)
+    assert_equal ugly_bak, ugly, '#unindent should have no side-effects'
+    assert_equal pretty, ugly.heredoc_unindent!(false)
+    assert_equal pretty, ugly
+    assert_equal nil, ugly.heredoc_unindent!(false)
+    ugly = ugly_bak.dup
+    assert_equal pretty, ugly.unindent!(false)
+    assert_equal pretty, ugly
+    assert_equal nil, ugly.unindent!(false)
+  end
+  
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: heredoc_unindent
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Adriano Mitre
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-17 00:00:00 -02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 2
+        - 8
+        - 0
+        version: 2.8.0
+  type: :development
+  version_requirements: *id001
+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).
+email: 
+- adriano.mitre@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/heredoc_unindent.rb
+- test/test_heredoc_unindent.rb
+has_rdoc: true
+homepage: https://github.com/adrianomitre/heredoc_unindent
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+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).
+test_files: 
+- test/test_heredoc_unindent.rb