heredoc_unindent 1.1.2 → 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41c021e05c7d7bb60f8054d3e6a11737018c0023
+  data.tar.gz: 3af02278e9f69a68cbee27098483010f5a345da9
+SHA512:
+  metadata.gz: 780ebd1db7ee9e65ccfb58442492e66192806c112f711bda413e4ca86a7364d65aa92e6a2ec439e696562d4986e058ede65baecab3df5302addbbea98debfdb4
+  data.tar.gz: 03537bbacb8caebeac8c2495d6158485313284e18dd330b7e31f0eaae77eeb8ad3e5ef7bd298b9c76502f67b666035a97ce7b0e310f567034d1a3b87854abf8d

data/History.rdoc

@@ -1,3 +1,10 @@
+=== 1.2.0 / 2015-04-15
+
+* 1 major enhancements
+
+  * new boolean flags ignore_{empty,blank} to tailor minimum margin calculation
+    * new functionality is disabled by default for backwards compatibility
+
 === 1.1.2 / 2011-02-07
 
 * 1 minor bugfixes

data/Manifest.txt

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

data/README.rdoc

@@ -37,6 +37,11 @@ will probably be an issue and hence this gem.
   s.unindent!   #=>  nil
   s             #=>  "foo"
 
+  u = "  1\n \n\n"
+  u.unindent == u #=> true
+  u.unindent(ignore_empty: true) #=> " 1\n\n\n"
+  u.unindent(ignore_blank: true) #=> "1\n\n\n"
+
 == FEATURES:
 
 * Tested on all major Ruby interpreters (100% coverage, 0% failure):

data/Rakefile

@@ -6,11 +6,11 @@ require 'hoe'
 Hoe.spec 'heredoc_unindent' do
   developer('Adriano Mitre', 'adriano.mitre@gmail.com')
   
-  self.version = '1.1.2'
+  self.version = '1.2.0'
   
   self.readme_file = 'README.rdoc'
   self.history_file = 'History.rdoc'
-  self.extra_rdoc_files += ['README.rdoc', 'History.rdoc', 'Wishlist.rdoc']
+  self.extra_rdoc_files += ['README.rdoc', 'History.rdoc']
 
   # self.rubyforge_name = 'heredoc_unindentx' # if different than 'heredoc_unindent'
 end

data/lib/heredoc_unindent.rb

@@ -8,6 +8,11 @@ module CoreExt
      
       private
       
+      # Good for compatibility with older Ruby versions, bad for YARD/RDoc.
+      DefaultUnindentBaseNewArgs = {
+        :ignore_empty => false,
+        :ignore_blank => false
+      }
       # Actual implementations of the unindentation mechanism,
       # both for in and out-of-place processing.
       #
@@ -18,25 +23,39 @@ module CoreExt
       #
       # @param [Boolean] warn_first_not_min 
       # @param [Boolean] in_place
+      # @param [Hash] args Optional flags: ignore_empty and ignore_blank (the
+      #                                    latter imply the former).
       # @return [String, nil]
       #
-      
       # 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)
+      def unindent_base_new(in_place, warn_first_not_min, args)
+        args = DefaultUnindentBaseNewArgs.merge(args)
         m_first = nil
         m_min = nil
-        self.scan(/^[ \t]*/) 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
+        if args[:ignore_empty] || args[:ignore_blank]
+          rl = self.lines # relevant lines
+          if args[:ignore_blank]
+            rl.reject! {|l| l[/^[ \t]*$/] }
+          elsif
+            rl.reject! {|l| l.chomp.empty? }
+          end
+          margins = rl.map {|l| l.gsub(/(\s*)\S?.*\n/,'\1').size }
+          m_first = margins.first
+          m_min = margins.min
+        else
+          self.scan(/^[ \t]*/) 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
         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 + '}'  )
+        re = Regexp.new('^[ \t]{,' + m_min.to_s + '}'  )
         in_place ? gsub!(re, '') : gsub(re, '')
       end
       
@@ -53,10 +72,12 @@ module CoreExt
         in_place ? gsub!(re, '') : gsub(re, '')
       end
 
-      if RUBY_VERSION >= '1.9' || defined?(RUBY_DESCRIPTION) && RUBY_DESCRIPTION =~ /jruby|rubinius/i
-        alias unindent_base unindent_base_new
-      else
-        alias unindent_base unindent_base_old
+      def unindent_base(in_place, warn_first_not_min, args)
+        if !args.empty? || RUBY_VERSION >= '1.9' || defined?(RUBY_DESCRIPTION) && RUBY_DESCRIPTION =~ /jruby|rubinius/i
+          unindent_base_new(in_place, warn_first_not_min, args)
+        else
+          unindent_base_old(in_place, warn_first_not_min)
+        end
       end
       
       public
@@ -87,8 +108,9 @@ module CoreExt
       # @param  [Boolean] warn_first_not_min toggle warning if the margin of the first line differs from minimum margin
       # @return [::String] unindented string
       #
-      def heredoc_unindent(warn_first_not_min=true)
-        unindent_base(false, warn_first_not_min)
+      def heredoc_unindent(warn_first_not_min=true, args={})
+        args, warn_first_not_min = warn_first_not_min, true if warn_first_not_min.is_a? Hash
+        unindent_base(false, warn_first_not_min, args)
       end
       alias unindent heredoc_unindent
 
@@ -115,8 +137,8 @@ module CoreExt
       # @param  [Boolean] warn_first_dif_min toggle warning if the margin of the first line differs from minimum margin
       # @return [::String, NilClass] unindented self, or nil if no changes were made
       #
-      def  heredoc_unindent!(warn_first_not_min=true)
-        unindent_base(true, warn_first_not_min)
+      def  heredoc_unindent!(warn_first_not_min=true, args={})
+        unindent_base(true, warn_first_not_min, args)
       end
       alias unindent! heredoc_unindent!
     end

data/test/test_heredoc_unindent.rb

@@ -64,6 +64,39 @@ EOS
     return ugly, pretty
   end
 
+  # Test new flags.
+  #
+  def test_ignore_empty_and_ignore_blank
+    ugly = <<-EOS
+      foo
+
+        bar
+
+  
+      baz
+EOS
+    pretty_e1b0 = <<EOS
+    foo
+
+      bar
+
+
+    baz
+EOS
+    pretty_e0b1 = ugly.clone
+    pretty_e1b1 = <<EOS
+foo
+
+  bar
+
+
+baz
+EOS
+    assert_equal pretty_e1b0, ugly.unindent(false, ignore_empty: true, ignore_blank: false)
+    assert_equal pretty_e0b1, ugly.unindent(false, ignore_empty: false, ignore_blank: false)
+    assert_equal pretty_e1b1, ugly.unindent(false, ignore_empty: true, ignore_blank: true)
+  end
+
   def prep_mult
     ugly = <<-BEGIN + "      <--- middle --->\n" + <<-END
       This is the beginning:
@@ -77,7 +110,7 @@ This is the beginning:
 EOS
     return ugly, pretty
   end
-  
+
   def test_unindent
     1.upto(4) do |n|
       m = method "prep_sing#{n}"

metadata

@@ -1,107 +1,94 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: heredoc_unindent
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 1.1.2
+version: !ruby/object:Gem::Version
+  version: 1.2.0
 platform: ruby
-authors: 
+authors:
 - Adriano Mitre
 autorequire: 
 bindir: bin
-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-02-07 00:00:00 -02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
+cert_chain: []
+date: 2015-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.8.0
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
   type: :development
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
 description: |-
   This gem removes common margin from indented strings, such as the ones
   produced by indented heredocs. In other words, it 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 by heredocs are just code and fact
   is that most parsers are insensitive to indentation. If, however, the strings
   are to be used otherwise, be it for printing or testing, the extra indentation
   will probably be an issue and hence this gem.
-email: 
+email:
 - adriano.mitre@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
+- History.rdoc
 - Manifest.txt
 - README.rdoc
-- History.rdoc
-- Wishlist.rdoc
-files: 
+files:
+- ".gemtest"
 - History.rdoc
 - Manifest.txt
 - README.rdoc
 - Rakefile
-- Wishlist.rdoc
 - lib/heredoc_unindent.rb
 - test/test_heredoc_unindent.rb
-has_rdoc: true
 homepage: https://github.com/adrianomitre/heredoc_unindent
-licenses: []
-
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
-rdoc_options: 
-- --main
+rdoc_options:
+- "--main"
 - README.rdoc
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: heredoc_unindent
-rubygems_version: 1.5.0
+rubyforge_project: 
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
-summary: This gem removes common margin from indented strings, such as the ones produced by indented heredocs
-test_files: 
-- test/test_heredoc_unindent.rb
+specification_version: 4
+summary: This gem removes common margin from indented strings, such as the ones produced
+  by indented heredocs
+test_files: []

data.tar.gz.sig

@@ -1,2 +0,0 @@
-m���/�yeI�Pq
-�K{�`�9��\w�����|'O1��I�%RL�[5�?g@{Яx�z��ͥM�h�9p��ř�$���

data/Wishlist.rdoc

@@ -1,13 +0,0 @@
-== SUGGESTIONS
-
-* added a mechanism for "ignoring" blank lines, i.e.,
-  * not include the margin of blank lines in the minimum calculation
-  * let them untouched (i.e., unprocessed)
-  * possible implementation:
-      re = Regexp.new '^\s{' + n.to_s + '}(\S+)$'
-      s.gsub(re,'\1')
-    instead of
-      re = Regexp.new '^\s{' + n.to_s + '}'
-      s.gsub(re, '')
-  * re-benchmark to make sure it does not hurt performance and performance
-    figures in README are still valid