indentation 0.0.7 → 0.1.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDFlODVkZWY2ZTI0ZDA0NzJiN2M4MWJlM2JlZTViYzY4NGExY2QxZg==
+  data.tar.gz: !binary |-
+    Y2E4YTVkNDNlMTQyNTUzNTA5NDlkY2EzYTIzNTUxZmE2N2FkOGVjMw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NjQwNTAyN2Y1OGZjZTVkNWQ5MzZiYmFjNTY0NGY4MWViZmFmODRkYTMyZWRm
+    YWZhN2ViNTg2ZGYwMDkzOTQxMGE3YjA5ODExYjAxZmJmNTVjMGVlNTA2OTJj
+    NTE4Y2I1NjAwODlkZTEyNThhYTAyY2Q5NjgxMTczMDY1ZTNmZDQ=
+  data.tar.gz: !binary |-
+    OTNkMTViZWVmMDU2MmEyNzMzYzIzZTIxY2E3ZjhlYzI4NjdkNzQxNzJlODg2
+    ZTQ2NTI4NjI1ZGI4NmVkZGMwOTJkNTI0ZjQ0MWM5YTAzMDhmMmUxNzhmNDgy
+    N2RlYWU2MzUyMGI4MjZkYWY2NTY3MWVkMzE5ZWFkNjg4YmM0NWM=

data/README.rdoc

@@ -6,7 +6,7 @@
 
 A small library of extensions to Ruby's Array and String classes that allow indentation manipulation of Strings and Arrays of Strings. Has the capability of working with multi-line strings. If you frequently use String arrays to manipulate text, see synopsis (In README.rdoc) for examples of how indentation can make your life easier.
 
-== SYNOPSIS:
+== EXAMPLES:
   
 === Indent
 
@@ -53,7 +53,7 @@ A small library of extensions to Ruby's Array and String classes that allow inde
 
   # Accepts an indentation modifier
     " one\n  two".reset_indentation(1) # => " one\n  two"
-    "   one\n  two".reset_indentation(0) # => " one\ntwo" - Default behavior
+    "   one\n  two".reset_indentation(0) # => " one\ntwo" # Default behavior
     " one\n  two".reset_indentation(-1) # => "one\ntwo"
   
   
@@ -111,12 +111,29 @@ A small library of extensions to Ruby's Array and String classes that allow inde
     "   three\n".find_least_indentation(:ignore_blank_lines => false) # => 0
   
   # Option to ignore both blank lines (no characters whatsoever) and empty lines (whitespace-only)
-  # Default => true    
+  # Implies :ignore_blank_lines => true when enabled
+  # Default => true
     "   three\n ".find_least_indentation # => 3
     "   three\n ".find_least_indentation(:ignore_empty_lines => false) # => 1
-    "   three\n".find_least_indentation(:ignore_empty_lines => false) # => 3
-    "   three\n".find_least_indentation(:ignore_empty_lines => false, :ignore_blank_lines => false) # => 0
+    "   three\n".find_least_indentation # => 3
+    "   three\n".find_least_indentation(:ignore_empty_lines => false) # => 0
+  
+  # To ignore blank, but not empty, lines:
+    "   three\n ".find_least_indentation(:ignore_blank_lines => true, :ignore_empty_lines => false) # => 1
+    "   three\n".find_least_indentation(:ignore_blank_lines => true, :ignore_empty_lines => false) # => 3
+    
+=== English Array Join
+
+  # Given an Array of Strings and an optional conjunction, joins them using English list punctuation
+  # to find the least indentation within a multi-line String
+  ['one', 'two'].english_join # => "one and two"
+  ['one', 'two', 'three'].english_join # => "one, two, and three"
+  
+  # Different conjunction
+  ['one', 'two', 'three'].english_join('or') # => "one, two, or three"
   
+  # Different separator
+  ['one', 'two', 'three'].english_join('or', ' ') # => "one two or three"
   
 == REQUIREMENTS:
 

data/lib/indentation.rb

@@ -1,5 +1,2 @@
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-
 require 'indentation/string_mod.rb'
 require 'indentation/array_mod.rb'

data/lib/indentation/array_mod.rb

@@ -71,4 +71,25 @@ class Array
     indent!(-find_least_indentation + modifier)
   end
   
+  # Join an array of strings using English list punctuation.
+  def english_join(conjunction = 'and', separator = ', ', oxford_comma = true)
+    len = self.length
+    return '' if len == 0
+    return self[0].to_s if len == 1
+    return "#{self[0].to_s} #{conjunction} #{self[1].to_s}" if len == 2
+    join_str = ''
+    self.each_with_index{|ele, i|
+      str = if !oxford_comma && i == len - 2
+          "#{ele} #{conjunction} "
+        elsif i == len - 2
+          "#{ele}#{separator}#{conjunction} "
+        elsif i == len - 1
+          "#{ele}"
+        else
+          "#{ele}#{separator}"
+        end
+      join_str << str
+    }
+    join_str
+  end
 end

data/lib/indentation/meta_info.rb

@@ -8,7 +8,7 @@ module Indentation
   # Required String
   GEM_NAME = "indentation"
   # Required String
-  VERSION = '0.0.7'
+  VERSION = '0.1.1'
   # Optional String or Array of Strings
   AUTHORS = ["Sam Dana"]
   # Optional String or Array of Strings

data/spec/indentation_spec.rb

@@ -279,104 +279,25 @@ describe "Reset Indentation function" do
     array.reset_indentation!.should == ["This", "  is", "a test"]
     array.should == ["This", "  is", "a test"]
   end
-  
 end
 
-describe "README.rdoc" do
-  it "should have correct examples for indent" do
-
-    # Default indentation is 2 spaces
-      "test".indent.should == "  test"
-
-    # Amount of indentation can be changed
-      "test".indent(3).should == "   test"
-
-    # Indentation character (or string) is set as the second parameter of indent.
-      "test".indent(2, "\t").should == "\t\ttest"
-
-    # Operates on multi-line strings
-      "this\nis\na\ntest".indent.should == "  this\n  is\n  a\n  test"
-
-    # Indent method accepts negative values (Removes tabs, spaces, and supplied indentation string)
-      "  test".indent(-1).should == " test"
-      "\t test".indent(-5).should == "test"
-      "\t--     Test".indent(-10).should == "--     Test"
-      "\t--     Test".indent(-10, '-').should == "Test"
-      "--- Test".indent(-2, '--').should == "- Test"
-
-    # Operates on arrays
-      ["one", "two"].indent.should == ["  one", "  two"]
-      [["one", "  two"], ["uno", "\t\tdos"]].indent.should == [["  one", "    two"], ["  uno", "  \t\tdos"]]
-
+describe "English Join function" do
+  it "should use the given conjunction to join the words with comma separation" do
+    [].english_join.should == ''
+    ['one'].english_join.should == 'one'
+    ['one', 'two'].english_join.should == 'one and two'
+    ['one', 'two', 'three'].english_join.should == 'one, two, and three'
   end
   
-  it "should have correct examples for reset indentation" do  
-
-    # 'resets' the indentation of a string by finding the least amount of indentation in the String/Array, and
-    # removing that amount from every line.
-      "  def method_name\n    # Do stuff\n  end".reset_indentation.should == "def method_name\n  # Do stuff\nend"
-
-    # Operates on arrays
-      ["  def method_name", "    # Do stuff", "  end"].reset_indentation.should == ["def method_name", "  # Do stuff", "end"]
-
-    # Useful for heredocs - must chomp to remove trailing newline
-      my_string = <<-EOS.chomp.reset_indentation
-        def method_name
-          # Do stuff
-        end
-        EOS
-      my_string.should == "def method_name\n  # Do stuff\nend"
-
-    # Accepts an indentation modifier
-      " one\n  two".reset_indentation(1).should == " one\n  two"
-      "   one\n  two".reset_indentation(0).should == " one\ntwo" # Default behavior
-      " one\n  two".reset_indentation(-1).should == "one\ntwo"
+  it "should override the default conjunction with the passed conjunction" do
+    ['one', 'two', 'three'].english_join('or').should == 'one, two, or three'
   end
   
-  it "should have correct examples for append separator" do
-    
-    # Given an Array of Arrays or an Array of Strings, appends a separator object to all but the last element in the Array.
-    # NOTE: For an Array of Strings the separator object must be a String, since it is appended to other Strings
-      ["arg1", "arg2", "arg3"].append_separator("!").should == ["arg1!", "arg2!", "arg3"]
-      [["line1"], ["line2"], ["line3"]].append_separator("").should == [["line1", ""], ["line2", ""], ["line3"]]
-      [["line1", "line2"], ["line3", "line4"]].append_separator("").should == [["line1", "line2", ""], ["line3", "line4"]]
-
-    # Useful combined with indent and join
-      vars = ["var1", "var2", "var3", "var4"]
-      method_def = ["def add_up(#{vars.join(', ')})"]
-      method_body = vars.append_separator(" + ")
-      method_def += method_body.indent
-      method_def << "end"
-      method_def.join("\n").should == "def add_up(var1, var2, var3, var4)\n  var1 + \n  var2 + \n  var3 + \n  var4\nend"
-
-    # Handy for separating arrays of string arrays
-      test_array = [["this", "is", "a", "test"], ["quick", "brown", "fox"], ["lazy", "typist"]]
-      test_array.append_separator("").join("\n").should == "this\nis\na\ntest\n\nquick\nbrown\nfox\n\nlazy\ntypist"
+  it "should override the default separator with the passed separator" do
+    ['one', 'two', 'three'].english_join('or', ' ').should == 'one two or three'
   end
   
-  it "should have correct examples for find_least_indentation" do
-    
-    # Given a String or Array of Strings, finds the least indentation on any line. Splits on newlines found within strings
-    # to find the least indentation within a multi-line String
-      "  test".find_least_indentation # => 2
-      "   three\n  two \n one".find_least_indentation # => 1
-      ["  two", "   three", "    four"].find_least_indentation # => 2
-      ["  two", "   three", ["    four", "     five\n one"]].find_least_indentation # => 1
-
-    # Option to ignore blank (no characters whatsoever) lines. 
-    # Note, disabling this option will automatically disable :ignore_empty_lines
-    # Default => true
-      "   three\n".find_least_indentation # => 3
-      "   three\n".find_least_indentation(:ignore_blank_lines => false) # => 0
-    
-    # Option to not only ignore both blank lines (no characters whatsoever) and empty lines (whitespace-only)
-    # Default => true    
-      "   three\n ".find_least_indentation # => 3
-      "   three\n ".find_least_indentation(:ignore_empty_lines => false) # => 1
-      "   three\n".find_least_indentation(:ignore_empty_lines => false) # => 3
-      "   three\n".find_least_indentation(:ignore_empty_lines => false, :ignore_blank_lines => false) # => 0
-  end
-      
-      
-    
-end
+  it "should allow turning off the oxford comma" do
+    ['one', 'two', 'three'].english_join('and', ', ', false).should == 'one, two and three'
+  end
+end

data/spec/rdoc_examples_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe "Readme Rdoc examples" do
+  rdoc_examples.each do |example_name, example_code|
+    it "should pass the #{example_name} example from the README" do
+      eval(example_code)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -8,3 +8,50 @@ end
 
 $:.unshift(File.dirname(__FILE__) + '/../lib')
 require 'indentation'
+
+def rdoc_examples(examples_header = /^Examples:/i)
+  readme_rdoc = File.join(File.dirname(__FILE__), '../README.rdoc')
+  rdoc_content = File.read(readme_rdoc)
+  example_content = rdoc_content.split(/^== /).select{|p| p =~ examples_header}.first
+  raise "Couldn't find Examples header matching: #{examples_header}" unless example_content
+  examples_content = example_content.split('=== ')
+  examples = {}
+  # Skipping first 'example' since it is "Examples:\n"
+  examples_content[1..-1].each do |excon|
+    lines = excon.split("\n")
+    example_name = lines.shift.delete(':')
+    example_code = []
+    example_code << "$stdout = StringIO.new"
+    lines.each do |line|
+      l = line
+      if l =~ / # => /
+        code, check = line.split(/ # => /)
+        # Could make this more sophisticated, but just going with ==
+        l = code + ".should == " + check
+      elsif l =~ /(.*) ?# :([^ ]*) => (.*)$/
+        code = $~[1]
+        var = $~[2].to_sym
+        value = $~[3]
+        case var
+        when :stdout
+          l = "#{code}\n $stdout.string.chomp.split(%!\n!).last.should == %!#{value}!"
+        else
+          raise "Unkown variable type: #{var}"
+        end
+      end
+      example_code << l
+    end
+    # Debugging to show all of stdout during example
+    #example_code << "stdoutput = $stdout.string"
+    example_code << "$stdout = STDOUT"
+    #example_code << "puts stdoutput"
+    examples[example_name.to_sym] = example_code.join("\n")
+  end
+  examples
+end
+
+def time
+  t = Time.now
+  yield
+  Time.now - t
+end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: indentation
 version: !ruby/object:Gem::Version
-  version: 0.0.7
-  prerelease: 
+  version: 0.1.1
 platform: ruby
 authors:
 - Sam Dana
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-30 00:00:00.000000000 Z
+date: 2013-10-09 00:00:00.000000000 Z
 dependencies: []
 description: A library of extensions to Ruby's Array and String classes that allow
   indentation manipulation of Strings and Arrays of Strings.
@@ -27,33 +26,34 @@ files:
 - lib/indentation/string_mod.rb
 - spec/.rspec
 - spec/indentation_spec.rb
+- spec/rdoc_examples_spec.rb
 - spec/spec_helper.rb
 homepage: http://samueldana.github.com/indentation/
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A library of extensions to Ruby's Array and String classes that allow indentation
   manipulation of Strings and Arrays of Strings.
 test_files:
 - spec/indentation_spec.rb
+- spec/rdoc_examples_spec.rb
 - spec/spec_helper.rb
 has_rdoc: