unindentable 0.0.4 → 0.1.0

data/Gemfile.lock

@@ -1,23 +1,23 @@
 PATH
   remote: .
   specs:
-    unindentable (0.0.4)
+    unindentable (0.1.0)
 
 GEM
   specs:
     diff-lcs (1.1.2)
-    rspec (2.3.0)
-      rspec-core (~> 2.3.0)
-      rspec-expectations (~> 2.3.0)
-      rspec-mocks (~> 2.3.0)
-    rspec-core (2.3.1)
-    rspec-expectations (2.3.0)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.3.0)
+    rspec-mocks (2.4.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  rspec (~> 2.3)
+  rspec (~> 2.4)
   unindentable!

data/README.md

@@ -66,3 +66,7 @@ Here are some examples from the Interwebs where people discuss potential solutio
 * http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-core/19111
 * http://www.ruby-forum.com/topic/167227
 * http://www.ruby-forum.com/topic/95472
+
+## Alternatives
+
+* http://rubygems.org/gems/unindent

data/lib/unindentable.rb

@@ -1,34 +1,26 @@
-module Unindentable
+class String
 
   # Removes common indentation from each line of a string
-  def unindent(string)
-    left_trim(string, find_minimum_indent(string))
+  def unindent
+    drop_from_each_line(find_minimum_indent)
   end
-  
-  protected
-  
-  # Returns the indent level of a string (with multiple lines)
-  def find_minimum_indent(string)
-    indents = []
-    string.each_line do |line|
-      unless line == "\n"
-        indents << line.index(/[^ ]/)
-      end
-    end
-    indents.min
+
+  # Drops n characters from the start of each line, but will not drop a line
+  # entirely; in other words, it will not drop a newline.
+  def drop_from_each_line(n)
+    self.lines.map do |line|
+      k = 0
+      line.chars.drop_while do |x|
+        k += 1
+        k <= n && x != "\n"
+      end.join("")
+    end.join("")
   end
-  
-  # Trims the leftmost n characters from each line of a string
-  def left_trim(string, n)
-    new_string = ""
-    string.each_line do |line|
-      new_string << if line == "\n"
-        "\n"
-      else
-        line.slice(n, line.length)
-      end
-    end
-    new_string
+
+  # Returns the indent level (number of spaces at the start of a string) with
+  # multiple lines
+  def find_minimum_indent
+    self.lines.map { |s| s.index(/[^\s]/) unless s.empty? }.compact.min
   end
-  
+
 end

data/spec/drop_from_each_line_spec.rb

@@ -0,0 +1,43 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+S = <<-BLOCK
+  X
+    y
+  ZZ
+BLOCK
+
+describe "drop_from_each_line" do
+  describe "example with 2 space indent, 2 indent levels" do
+    it "-" do
+      S.should == "  X\n    y\n  ZZ\n"
+    end
+
+    it "0" do
+      S.drop_from_each_line(0).should == "  X\n    y\n  ZZ\n"
+    end
+
+    it "1" do
+      S.drop_from_each_line(1).should == " X\n   y\n ZZ\n"
+    end
+
+    it "2" do
+      S.drop_from_each_line(2).should == "X\n  y\nZZ\n"
+    end
+
+    it "3" do
+      S.drop_from_each_line(3).should == "\n y\nZ\n"
+    end
+
+    it "4" do
+      S.drop_from_each_line(4).should == "\ny\n\n"
+    end
+
+    it "5" do
+      S.drop_from_each_line(5).should == "\n\n\n"
+    end
+
+    it "6" do
+      S.drop_from_each_line(6).should == "\n\n\n"
+    end
+  end
+end

data/spec/find_minimum_indent_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "find_minimum_indent" do
+
+  it "should handle an example with 3 indent levels" do
+    s = <<-BLOCK
+          A
+        B
+      C
+        D
+    BLOCK
+    s.find_minimum_indent.should == 6
+  end
+
+  it "should not let blank lines break the indent" do
+    s = <<-BLOCK
+      The first line
+
+      The third line
+    BLOCK
+    s.find_minimum_indent.should == 6
+  end
+
+end

data/spec/{unindentable_spec.rb → unindent_spec.rb}

@@ -1,30 +1,28 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe "Unindentable" do
-  include Unindentable
-
+describe "unindent" do
   it "should handle the README example" do
-    html = unindent <<-BLOCK
+    x = <<-BLOCK.unindent
       <html>
         <body>
           <p>Hello</p>
         </body>
       </html>
     BLOCK
-    html.should == "<html>\n  <body>\n    <p>Hello</p>\n  </body>\n</html>\n"
+    x.should == "<html>\n  <body>\n    <p>Hello</p>\n  </body>\n</html>\n"
   end
 
   it "should handle ugly heredoc against left margin" do
-    x = unindent <<-BLOCK
+    x = <<-BLOCK.unindent
 a
 b
 c
     BLOCK
-    x.should == "a\nb\nc\n"
+    x.unindent.should == "a\nb\nc\n"
   end
 
   it "should handle a basic example" do
-    x = unindent <<-BLOCK
+    x = <<-BLOCK.unindent
       a
       b
       c
@@ -33,7 +31,7 @@ c
   end
 
   it "should handle an example with 2 indent levels" do
-    x = unindent <<-BLOCK
+    x = <<-BLOCK.unindent
       X 1 2
         yada yada
       Z Z Z
@@ -42,7 +40,7 @@ c
   end
 
   it "should handle an example with 3 indent levels" do
-    x = unindent <<-BLOCK
+    x = <<-BLOCK.unindent
           A
         B
       C
@@ -52,7 +50,7 @@ c
   end
 
   it "should preserve varying indent levels a blank line" do
-    x = unindent <<-BLOCK
+    x = <<-BLOCK.unindent
       The first line
         The second line
         
@@ -62,7 +60,7 @@ c
   end
 
   it "should not let blank lines break the indent" do
-    x = unindent <<-BLOCK
+    x = <<-BLOCK.unindent
       The first line
 
       The third line

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 4
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors: 
 - David James
@@ -27,8 +27,8 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 2
-        - 3
-        version: "2.3"
+        - 4
+        version: "2.4"
   type: :development
   version_requirements: *id001
 description: Unindent strings, especially heredocs.
@@ -47,8 +47,10 @@ files:
 - LICENSE
 - README.md
 - lib/unindentable.rb
-- spec/unindentable_spec.rb
+- spec/drop_from_each_line_spec.rb
+- spec/find_minimum_indent_spec.rb
 - spec/spec_helper.rb
+- spec/unindent_spec.rb
 has_rdoc: true
 homepage: http://github.com/sunlightlabs/ruby-unindentable
 licenses: []
@@ -72,15 +74,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version 
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      version: "1.3"
 requirements: []
 
 rubyforge_project: 
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: With Unindentable, you can write heredocs without worry of wonky indentation.
+summary: Write heredocs without the unwanted extra indentation.
 test_files: 
-- spec/unindentable_spec.rb
+- spec/drop_from_each_line_spec.rb
+- spec/find_minimum_indent_spec.rb
 - spec/spec_helper.rb
+- spec/unindent_spec.rb