RubyGems - outdent - Versions diffs - 0.2.0 - Mend

outdent 0.2.0

Files changed (10) hide show

data/Gemfile +1 -0
data/Gemfile.lock +23 -0
data/LICENSE +10 -0
data/README.md +77 -0
data/lib/outdent.rb +26 -0
data/spec/drop_from_each_line_spec.rb +43 -0
data/spec/find_minimum_indent_spec.rb +24 -0
data/spec/outdent_spec.rb +71 -0
data/spec/spec_helper.rb +8 -0
metadata +91 -0

data/Gemfile ADDED

	@@ -0,0 +1 @@
1	+ gemspec

data/Gemfile.lock ADDED

@@ -0,0 +1,23 @@
+PATH
+  remote: .
+  specs:
+    outdent (0.2.0)
+GEM
+  specs:
+    diff-lcs (1.1.2)
+    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.4.0)
+PLATFORMS
+  ruby
+DEPENDENCIES
+  outdent!
+  rspec (~> 2.4)

data/LICENSE ADDED

@@ -0,0 +1,10 @@
+Copyright (c) 2009, Sunlight Foundation
+All rights reserved.
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+  * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+  * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+  * Neither the name of Sunlight Foundation nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md ADDED

@@ -0,0 +1,77 @@
+# Outdent
+With Outdent, you can write heredocs without worry of wonky indentation.
+## Motivation
+Heredocs are convenient.  But the indentation can bite you.  For example:
+    def hello
+      html = <<-BLOCK
+        <html>
+          <body>
+            <p>Hello</p>
+          </body>
+        </html>
+      BLOCK
+    end
+The problem is that you get extra indentation you probably don't want:
+    irb> hello
+    => "    <html>\n      <body>\n        <p>Hello</p>\n      </body>\n    </html>\n"
+One solution is to move your heredoc to the left margin:
+    def hello
+      html = <<-BLOCK
+    <html>
+      <body>
+        <p>Hello</p>
+      </body>
+    </html>
+      BLOCK
+    end
+So that you get the result you expect:
+    > hello
+    => "<html>\n  <body>\n    <p>Hello</p>\n  </body>\n</html>\n"
+But this doesn't look good in your source.  With Outdent, you can write:
+    def hello
+      html = <<-BLOCK.outdent
+        <html>
+          <body>
+            <p>Hello</p>
+          </body>
+        </html>
+      BLOCK
+    end
+And get the nice outdented result you want:
+    > hello
+    => "<html>\n  <body>\n    <p>Hello</p>\n  </body>\n</html>\n"
+That's it.
+## The Backstory
+Here are some examples from the Interwebs where people discuss potential solutions:
+* http://oldrcrs.rubypal.com/rcr/show/188
+* 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
+## History
+* 2011-01-05 - Renamed project from Unindentable to Outdent
+* 2011-01-04 - Borrowed (stole?) API from [Unindent](http://rubygems.org/gems/unindent) project
+* 2009-07-09 - First version

data/lib/outdent.rb ADDED

@@ -0,0 +1,26 @@
+class String
+  # Unindent. Removes common indentation from each line of a string.
+  def outdent
+    drop_from_each_line(find_minimum_indent)
+  end
+  # 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
+  # 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 ADDED

@@ -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 ADDED

@@ -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/outdent_spec.rb ADDED

@@ -0,0 +1,71 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+describe "outdent" do
+  it "should handle the README example" do
+    x = <<-BLOCK.outdent
+      <html>
+        <body>
+          <p>Hello</p>
+        </body>
+      </html>
+    BLOCK
+    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 = <<-BLOCK.outdent
+a
+b
+c
+    BLOCK
+    x.outdent.should == "a\nb\nc\n"
+  end
+  it "should handle a basic example" do
+    x = <<-BLOCK.outdent
+      a
+      b
+      c
+    BLOCK
+    x.should == "a\nb\nc\n"
+  end
+  it "should handle an example with 2 indent levels" do
+    x = <<-BLOCK.outdent
+      X 1 2
+        yada yada
+      Z Z Z
+    BLOCK
+    x.should == "X 1 2\n  yada yada\nZ Z Z\n"
+  end
+  it "should handle an example with 3 indent levels" do
+    x = <<-BLOCK.outdent
+          A
+        B
+      C
+        D
+    BLOCK
+    x.should == "    A\n  B\nC\n  D\n"
+  end
+  it "should preserve varying indent levels a blank line" do
+    x = <<-BLOCK.outdent
+      The first line
+        The second line
+      The fourth line
+    BLOCK
+    x.should == "The first line\n  The second line\n  \nThe fourth line\n"
+  end
+  it "should not let blank lines break the indent" do
+    x = <<-BLOCK.outdent
+      The first line
+      The third line
+    BLOCK
+    x.should == "The first line\n\nThe third line\n"
+  end
+end

data/spec/spec_helper.rb ADDED

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+require File.expand_path('../../lib/outdent', __FILE__)
+Rspec.configure do |c|
+  c.mock_with :rspec
+end

metadata ADDED

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: outdent
+version: !ruby/object:Gem::Version
+  prerelease: false
+  segments:
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors:
+- David James
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2011-05-11 00:00:00 -04:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        segments:
+        - 2
+        - 4
+        version: "2.4"
+  type: :development
+  version_requirements: *id001
+description: Unindent strings, especially heredocs.
+email:
+- djames at sunlightfoundation.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- lib/outdent.rb
+- spec/drop_from_each_line_spec.rb
+- spec/find_minimum_indent_spec.rb
+- spec/spec_helper.rb
+- spec/outdent_spec.rb
+has_rdoc: true
+homepage: http://github.com/sunlightlabs/ruby-outdent
+licenses: []
+post_install_message:
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 1
+      - 3
+      version: "1.3"
+requirements: []
+rubyforge_project:
+rubygems_version: 1.3.7
+signing_key:
+specification_version: 3
+summary: Write heredocs without the unwanted extra indentation.
+test_files:
+- spec/drop_from_each_line_spec.rb
+- spec/find_minimum_indent_spec.rb
+- spec/spec_helper.rb
+- spec/outdent_spec.rb