indentation 0.0.3 → 0.0.4

data/History.txt

@@ -1,3 +1,10 @@
+=== 0.0.4 2011-02-17
+* Fixed documentation to include find_least_indentation function
+* Added options hash to find_least_indentation function with options to:
+  * Ignore blank lines (zero-length lines)
+  * Ignore empty lines (whitespace-only lines)
+* Modified specs to use rspec >= 2.0
+
 === 0.0.3 2010-05-07
 * Fixed documentation regarding installation and summary
 

data/Manifest.txt

@@ -3,11 +3,6 @@ Manifest.txt
 PostInstall.txt
 README.rdoc
 Rakefile
-features/development.feature
-features/step_definitions/common_steps.rb
-features/support/common.rb
-features/support/env.rb
-features/support/matchers.rb
 lib/indentation.rb
 lib/indentation/array_mod.rb
 lib/indentation/string_mod.rb

data/README.rdoc

@@ -93,6 +93,30 @@ A small library of extensions to Ruby's Array and String classes that allow inde
       # 
       # lazy
       # typist
+
+
+=== Find Least Indentation
+
+  # 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 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
+  
   
 == REQUIREMENTS:
 

data/Rakefile

@@ -6,7 +6,6 @@ require './lib/indentation'
 
 Hoe.plugin :newgem
 # Hoe.plugin :website
-Hoe.plugin :cucumberfeatures
 
 # Generate all the Rake tasks
 # Run 'rake -T' to see list of generated tasks (from gem root directory)

data/lib/indentation.rb

@@ -5,5 +5,5 @@ require 'indentation/string_mod.rb'
 require 'indentation/array_mod.rb'
 
 module Indentation
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/lib/indentation/array_mod.rb

@@ -55,7 +55,7 @@ class Array
   end
   
   # Get the least indentation of all elements
-  def find_least_indentation
+  def find_least_indentation(options = {:ignore_blank_lines => true, :ignore_empty_lines => true})
     self.collect{|array_element| array_element.find_least_indentation }.min
   end
   

data/lib/indentation/string_mod.rb

@@ -22,8 +22,18 @@ class String
   end
   
   # Split across newlines and return the fewest number of indentation characters found on each line
-  def find_least_indentation
-    empty? ? 0 : split("\n", -1).collect{|substr| substr.match(/^[ \t]*/).to_s.length}.min
+  def find_least_indentation(options = {:ignore_blank_lines => true, :ignore_empty_lines => true})
+    # Cannot ignore empty lines unless we're also ignoring blank lines
+    options[:ignore_blank_lines] = options[:ignore_empty_lines] ? true : options[:ignore_blank_lines]
+    empty? ? 0 : split("\n", -1).reject{|line|
+                                        if options[:ignore_empty_lines]
+                                          line.strip.empty?
+                                        elsif options[:ignore_blank_lines]
+                                          line.empty?
+                                        else
+                                          false
+                                        end
+                                      }.collect{|substr| substr.match(/^[ \t]*/).to_s.length}.min
   end
   
   # Find the least indentation of all lines within this string and remove that amount (if any)

data/spec/indentation_spec.rb

@@ -353,4 +353,30 @@ describe "README.rdoc" do
       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"
   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

data/spec/spec.opts

@@ -1 +1 @@
---colour
+-c -fd

data/spec/spec_helper.rb

@@ -1,9 +1,9 @@
 begin
-  require 'spec'
+  require 'rspec'
 rescue LoadError
   require 'rubygems' unless ENV['NO_RUBYGEMS']
   gem 'rspec'
-  require 'spec'
+  require 'rspec'
 end
 
 $:.unshift(File.dirname(__FILE__) + '/../lib')

data/tasks/rspec.rake

@@ -1,11 +1,11 @@
 begin
-  require 'spec'
+  require 'rspec'
 rescue LoadError
   require 'rubygems' unless ENV['NO_RUBYGEMS']
-  require 'spec'
+  require 'rspec'
 end
 begin
-  require 'spec/rake/spectask'
+  require 'rspec/core/rake_task'
 rescue LoadError
   puts <<-EOS
 To use rspec for testing you must install rspec gem:
@@ -15,7 +15,7 @@ EOS
 end
 
 desc "Run the specs under spec/models"
-Spec::Rake::SpecTask.new do |t|
-  t.spec_opts = ['--options', "spec/spec.opts"]
-  t.spec_files = FileList['spec/**/*_spec.rb']
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ['--options', "spec/spec.opts"]
+#  t.files = FileList['spec/**/*_spec.rb']
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: indentation
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Samuel Dana
@@ -14,37 +15,25 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-07 00:00:00 -04:00
+date: 2011-02-17 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rubyforge
+  name: hoe
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 41
         segments: 
         - 2
-        - 0
-        - 4
-        version: 2.0.4
+        - 9
+        - 1
+        version: 2.9.1
   type: :development
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 6
-        - 0
-        version: 2.6.0
-  type: :development
-  version_requirements: *id002
 description: 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.
 email: 
 - s.dana@prometheuscomputing.com
@@ -62,11 +51,6 @@ files:
 - PostInstall.txt
 - README.rdoc
 - Rakefile
-- features/development.feature
-- features/step_definitions/common_steps.rb
-- features/support/common.rb
-- features/support/env.rb
-- features/support/matchers.rb
 - lib/indentation.rb
 - lib/indentation/array_mod.rb
 - lib/indentation/string_mod.rb
@@ -77,6 +61,7 @@ files:
 - spec/spec.opts
 - spec/spec_helper.rb
 - tasks/rspec.rake
+- .gemtest
 has_rdoc: true
 homepage: http://github.com/samueldana/indentation
 licenses: []
@@ -93,23 +78,27 @@ rdoc_options:
 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: indentation
-rubygems_version: 1.3.6
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: A small library of extensions to Ruby's Array and String classes that allow indentation manipulation of Strings and Arrays of Strings

data/features/development.feature

@@ -1,13 +0,0 @@
-Feature: Development processes of newgem itself (rake tasks)
-
-  As a Newgem maintainer or contributor
-  I want rake tasks to maintain and release the gem
-  So that I can spend time on the tests and code, and not excessive time on maintenance processes
-    
-  Scenario: Generate RubyGem
-    Given this project is active project folder
-    And "pkg" folder is deleted
-    When I invoke task "rake gem"
-    Then folder "pkg" is created
-    And file with name matching "pkg/*.gem" is created else you should run "rake manifest" to fix this
-    And gem spec key "rdoc_options" contains /(--mainREADME.rdoc|\[\"--main\", \"README.rdoc\"\])/

data/features/step_definitions/common_steps.rb

@@ -1,168 +0,0 @@
-Given /^this project is active project folder/ do
-  @active_project_folder = File.expand_path(File.dirname(__FILE__) + "/../..")
-end
-
-Given /^env variable \$([\w_]+) set to "(.*)"/ do |env_var, value|
-  ENV[env_var] = value
-end
-
-Given /"(.*)" folder is deleted/ do |folder|
-  in_project_folder { FileUtils.rm_rf folder }
-end
-
-When /^I invoke "(.*)" generator with arguments "(.*)"$/ do |generator, arguments|
-  @stdout = StringIO.new
-  in_project_folder do
-    if Object.const_defined?("APP_ROOT")
-      APP_ROOT.replace(FileUtils.pwd)
-    else 
-      APP_ROOT = FileUtils.pwd
-    end
-    run_generator(generator, arguments.split(' '), SOURCES, :stdout => @stdout)
-  end
-  File.open(File.join(@tmp_root, "generator.out"), "w") do |f|
-    @stdout.rewind
-    f << @stdout.read
-  end
-end
-
-When /^I run executable "(.*)" with arguments "(.*)"/ do |executable, arguments|
-  @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
-  in_project_folder do
-    system "#{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
-  end
-end
-
-When /^I run project executable "(.*)" with arguments "(.*)"/ do |executable, arguments|
-  @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
-  in_project_folder do
-    system "ruby #{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
-  end
-end
-
-When /^I run local executable "(.*)" with arguments "(.*)"/ do |executable, arguments|
-  @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
-  executable = File.expand_path(File.join(File.dirname(__FILE__), "/../../bin", executable))
-  in_project_folder do
-    system "ruby #{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
-  end
-end
-
-When /^I invoke task "rake (.*)"/ do |task|
-  @stdout = File.expand_path(File.join(@tmp_root, "tests.out"))
-  in_project_folder do
-    system "rake #{task} --trace > #{@stdout} 2> #{@stdout}"
-  end
-end
-
-Then /^folder "(.*)" (is|is not) created/ do |folder, is|
-  in_project_folder do
-    File.exists?(folder).should(is == 'is' ? be_true : be_false)
-  end
-end
-
-Then /^file "(.*)" (is|is not) created/ do |file, is|
-  in_project_folder do
-    File.exists?(file).should(is == 'is' ? be_true : be_false)
-  end
-end
-
-Then /^file with name matching "(.*)" is created/ do |pattern|
-  in_project_folder do
-    Dir[pattern].should_not be_empty
-  end
-end
-
-Then /^file "(.*)" contents (does|does not) match \/(.*)\// do |file, does, regex|
-  in_project_folder do
-    actual_output = File.read(file)
-    (does == 'does') ?
-      actual_output.should(match(/#{regex}/)) :
-      actual_output.should_not(match(/#{regex}/))
-  end
-end
-
-Then /gem file "(.*)" and generated file "(.*)" should be the same/ do |gem_file, project_file|
-  File.exists?(gem_file).should be_true
-  File.exists?(project_file).should be_true
-  gem_file_contents = File.read(File.dirname(__FILE__) + "/../../#{gem_file}")
-  project_file_contents = File.read(File.join(@active_project_folder, project_file))
-  project_file_contents.should == gem_file_contents
-end
-
-Then /^(does|does not) invoke generator "(.*)"$/ do |does_invoke, generator|
-  actual_output = File.read(@stdout)
-  does_invoke == "does" ?
-    actual_output.should(match(/dependency\s+#{generator}/)) :
-    actual_output.should_not(match(/dependency\s+#{generator}/))
-end
-
-Then /help options "(.*)" and "(.*)" are displayed/ do |opt1, opt2|
-  actual_output = File.read(@stdout)
-  actual_output.should match(/#{opt1}/)
-  actual_output.should match(/#{opt2}/)
-end
-
-Then /^I should see "([^\"]*)"$/ do |text|
-  actual_output = File.read(@stdout)
-  actual_output.should contain(text)
-end
-
-Then /^I should see$/ do |text|
-  actual_output = File.read(@stdout)
-  actual_output.should contain(text)
-end
-
-Then /^I should not see$/ do |text|
-  actual_output = File.read(@stdout)
-  actual_output.should_not contain(text)
-end
-
-Then /^I should see exactly$/ do |text|
-  actual_output = File.read(@stdout)
-  actual_output.should == text
-end
-
-Then /^I should see all (\d+) tests pass/ do |expected_test_count|
-  expected = %r{^#{expected_test_count} tests, \d+ assertions, 0 failures, 0 errors}
-  actual_output = File.read(@stdout)
-  actual_output.should match(expected)
-end
-
-Then /^I should see all (\d+) examples pass/ do |expected_test_count|
-  expected = %r{^#{expected_test_count} examples?, 0 failures}
-  actual_output = File.read(@stdout)
-  actual_output.should match(expected)
-end
-
-Then /^yaml file "(.*)" contains (\{.*\})/ do |file, yaml|
-  in_project_folder do
-    yaml = eval yaml
-    YAML.load(File.read(file)).should == yaml
-  end
-end
-
-Then /^Rakefile can display tasks successfully/ do
-  @stdout = File.expand_path(File.join(@tmp_root, "rakefile.out"))
-  in_project_folder do
-    system "rake -T > #{@stdout} 2> #{@stdout}"
-  end
-  actual_output = File.read(@stdout)
-  actual_output.should match(/^rake\s+\w+\s+#\s.*/)
-end
-
-Then /^task "rake (.*)" is executed successfully/ do |task|
-  @stdout.should_not be_nil
-  actual_output = File.read(@stdout)
-  actual_output.should_not match(/^Don't know how to build task '#{task}'/)
-  actual_output.should_not match(/Error/i)
-end
-
-Then /^gem spec key "(.*)" contains \/(.*)\// do |key, regex|
-  in_project_folder do
-    gem_file = Dir["pkg/*.gem"].first
-    gem_spec = Gem::Specification.from_yaml(`gem spec #{gem_file}`)
-    spec_value = gem_spec.send(key.to_sym)
-    spec_value.to_s.should match(/#{regex}/)
-  end
-end

data/features/support/common.rb

@@ -1,29 +0,0 @@
-module CommonHelpers
-  def in_tmp_folder(&block)
-    FileUtils.chdir(@tmp_root, &block)
-  end
-
-  def in_project_folder(&block)
-    project_folder = @active_project_folder || @tmp_root
-    FileUtils.chdir(project_folder, &block)
-  end
-
-  def in_home_folder(&block)
-    FileUtils.chdir(@home_path, &block)
-  end
-
-  def force_local_lib_override(project_name = @project_name)
-    rakefile = File.read(File.join(project_name, 'Rakefile'))
-    File.open(File.join(project_name, 'Rakefile'), "w+") do |f|
-      f << "$:.unshift('#{@lib_path}')\n"
-      f << rakefile
-    end
-  end
-
-  def setup_active_project_folder project_name
-    @active_project_folder = File.join(@tmp_root, project_name)
-    @project_name = project_name
-  end
-end
-
-World(CommonHelpers)

data/features/support/env.rb

@@ -1,15 +0,0 @@
-require File.dirname(__FILE__) + "/../../lib/indentation"
-
-gem 'cucumber'
-require 'cucumber'
-gem 'rspec'
-require 'spec'
-
-Before do
-  @tmp_root = File.dirname(__FILE__) + "/../../tmp"
-  @home_path = File.expand_path(File.join(@tmp_root, "home"))
-  @lib_path  = File.expand_path(File.dirname(__FILE__) + "/../../lib")
-  FileUtils.rm_rf   @tmp_root
-  FileUtils.mkdir_p @home_path
-  ENV['HOME'] = @home_path
-end

data/features/support/matchers.rb

@@ -1,11 +0,0 @@
-module Matchers
-  def contain(expected)
-    simple_matcher("contain #{expected.inspect}") do |given, matcher|
-      matcher.failure_message = "expected #{given.inspect} to contain #{expected.inspect}"
-      matcher.negative_failure_message = "expected #{given.inspect} not to contain #{expected.inspect}"
-      given.index expected
-    end
-  end
-end
-
-World(Matchers)