lstrip-on-steroids 1.0.1 → 1.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in lstrip-on-steroids.gemspec
+gemspec

data/Rakefile

@@ -1,17 +1,2 @@
-require "rake/gempackagetask"
-
-spec = Gem::Specification.new do |s| 
-  s.name = "lstrip-on-steroids"
-  s.version = "1.0.1"
-  s.authors = ["Caius Durling", "Ash Moran"]
-  s.email = %w[dev@caius.name ash.moran@patchspace.co.uk]
-  s.homepage = "http://github.com/caius/lstrip-on-steroids"
-  s.platform = Gem::Platform::RUBY
-  s.summary = "Intelligently strips leading whitespace from a multiline string"
-  s.files = FileList["lib/**/*.rb", "spec/**/*.rb", "[A-Z]*"].to_a
-  s.has_rdoc = false
-end
- 
-Rake::GemPackageTask.new(spec) do |pkg| 
-  pkg.need_tar = true 
-end 
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/lstrip-on-steroids.rb

@@ -1 +1 @@
-require 'lstrip_on_steroids'
+require 'lstrip_on_steroids'

data/lib/lstrip_on_steroids.rb

@@ -1,3 +1,5 @@
+require File.expand_path("lstrip_on_steroids/version", File.dirname(__FILE__))
+
 module LStripOnSteroids
   class JuicedStripper
     def initialize lines

data/lib/lstrip_on_steroids/version.rb

@@ -0,0 +1,3 @@
+module LStripOnSteroids
+  VERSION = "1.0.2"
+end

data/lstrip-on-steroids.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/lstrip_on_steroids/version", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Caius Durling", "Ash Moran"]
+  gem.email         = %w[dev@caius.name ash.moran@patchspace.co.uk]
+  gem.description   = %q{Sane indent-aware multiline strings}
+  gem.summary       = "Intelligently strips leading whitespace from a multiline string"
+  gem.homepage      = "http://github.com/caius/lstrip-on-steroids"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "lstrip-on-steroids"
+  gem.require_paths = ["lib"]
+  gem.version       = LStripOnSteroids::VERSION
+  gem.has_rdoc      = false
+end

data/readme.md

@@ -0,0 +1,92 @@
+# lstrip-on-steroids
+
+In [another][engorge] late night discussion in the [#nwrug][] IRC room, [Ash Moran][AM] was after sane indent-aware multiline strings for his cucumber scenarios.
+
+[engorge]: http://github.com/caius/engorge-ostruct
+[#nwrug]: http://nwrug.org/
+[AM]: https://github.com/ashmoran/
+
+As of v0.9.5 you can use either Strings (`''`, `""`, `%{}`, etc) or HEREDOCs (`<<-EOF\nEOF`) with the leading `-` to have the shitespace stripped. *('Shitespace' was coined by Caius in [this tweet][shitespace].)*
+
+[shitespace]: https://twitter.com/Caius/status/21600277885
+
+## Installation
+
+	$ sudo gem install lstrip-on-steroids
+
+And then in your code:
+
+	require "lstrip-on-steroids"
+
+## Examples & Usage
+
+Actually, I think my original scenario was RSpec :-) /Ash
+
+For example, the following story reads ok, but you end up with extra shitespace at the start of each line:
+
+	Scenario: Fake thing happens
+	  When I do something
+	  Then I should see %{
+	    someone
+	    did
+	    something
+	  }
+
+The problem is, this gets an extra two spaces at the start of each line. You want it to be the string `"  someone\n  did\n  something"`, but you end up with `"\n    someone\n    did\n    something\n  "`.
+
+The current solution is to delete the indent in the string:
+
+	Scenario: Fake thing happens
+	  When I do something
+	  Then I should see %{
+	someone
+	did
+	something
+	}
+
+But that just looks horrible, and you've amended your story to fit the code (kinda.)
+
+Luckily, you can automatically work out just the right amount of whitespace you want to be removed from each line, so with a bit of jiggery pokery, you can have your cake and eat it too. (The cake is not a lie.)
+
+Seeing as `String#-@` isn't defined already, this gem defines that for it, so you just prepend your multiline string with `-` to have it automagically strip the shitespace and leave the rest of your whitespace a-ok. So you end up with:
+
+	Scenario: Fake thing happens
+	  When I do something
+	  Then I should see -%{
+	    someone
+	    did
+	    something
+	  }
+
+which gives you back `"  someone\n  did\n  something"`, exactly what we want!
+
+*If you've not used to see `%{}` used to create strings, check out the [Ruby Shortcuts][rs] post on [CaiusTheory][ct] for an explanation of it and more!*
+
+[rs]: http://caiustheory.com/ruby-shortcuts
+[ct]: http://caiustheory.com/
+
+## Licence
+
+> The MIT License
+> 
+> Copyright (c) 2010 Caius Durling <dev@caius.name>  
+> Contributions by Ash Moran <ash.moran@patchspace.co.uk>
+> 
+> Permission is hereby granted, free of charge, to any person obtaining a copy
+> of this software and associated documentation files (the "Software"), to deal
+> in the Software without restriction, including without limitation the rights
+> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+> copies of the Software, and to permit persons to whom the Software is
+> furnished to do so, subject to the following conditions:
+> 
+> The above copyright notice and this permission notice shall be included in
+> all copies or substantial portions of the Software.
+> 
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+> THE SOFTWARE.
+

metadata

@@ -1,51 +1,73 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: lstrip-on-steroids
-version: !ruby/object:Gem::Version
-  version: 1.0.1
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 2
+  version: 1.0.2
 platform: ruby
-authors:
+authors: 
 - Caius Durling
 - Ash Moran
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-13 00:00:00.000000000Z
+
+date: 2011-11-17 00:00:00 +00:00
+default_executable: 
 dependencies: []
-description: 
-email:
+
+description: Sane indent-aware multiline strings
+email: 
 - dev@caius.name
 - ash.moran@patchspace.co.uk
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
 - lib/lstrip-on-steroids.rb
 - lib/lstrip_on_steroids.rb
+- lib/lstrip_on_steroids/version.rb
+- lstrip-on-steroids.gemspec
+- readme.md
 - spec/lstrip_on_steroids_spec.rb
-- Rakefile
+has_rdoc: true
 homepage: http://github.com/caius/lstrip-on-steroids
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+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'
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Intelligently strips leading whitespace from a multiline string
-test_files: []
+test_files: 
+- spec/lstrip_on_steroids_spec.rb