rstrip 0.0.2

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+tmp/*
+.rstrip

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+group :development do
+  gem 'rake'
+end
+# Specify your gem's dependencies in rstrip.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,33 @@
+== rstrip
+
+rstrip provides a ruby executable that removes the trailing white space in the current project directory.
+
+It also remove the last empty line if there is one.
+
+It's configurable on the file types it will operate on.
+
+== Usage
+* Install the gem: gem install rstrip
+* In your project folder run `rstrip config generate`, or run `rstrip config generate --global true` to generate the config file in your home directory
+* Modify the list of file extensions generated in the .rstrip config file
+* In your project folder run `rstrip process`
+* Example the change and commit the code
+
+== Alternatives:
+There are a lot of ways to do the similar thing:
+
+* textmate bundle
+https://github.com/mocoso/code-beautifier.tmbundle
+
+* textmate marco
+http://mjijackson.com/2009/01/textmate-macro-remove-trailing-space-and-save
+
+* bash
+http://stackoverflow.com/questions/149057/how-to-removing-trailing-whitespace-of-all-files-recursively
+
+* Use a git prehook
+http://stackoverflow.com/questions/591923/make-git-automatically-remove-trailing-whitespace-before-committing
+
+I used the textmate marco before. The problem with textmate bundle or marco is they only modify the file if you edit and save it, which makes the commits harder to read as you will remove white spaces gradually. rstrip gets it done all in once in the folder level. Then you can use the bundle or marco with a fresh start.
+
+rstrip also tries to make it as easy as possible so you don't need to remember the cryptic bash or perl commands.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/rstrip

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'rstrip/cli'
+Rstrip::CLI.start

data/feature/config.feature

@@ -0,0 +1,60 @@
+Feature: Config
+  In order to use rstrip
+  I have to have a .rstrip in the current directory or my home directory
+
+  Scenario: Generate the .rstrip in the current directory
+    When I run `rstrip config generate`
+    Then a file named ".rstrip" should exist
+      And the file ".rstrip" should contain "rb"
+      And the file ".rstrip" should contain "erb"
+
+  Scenario: Prompt to run the generator
+    When I run `rstrip config list`
+    Then the output should contain "Please run 'rstrip config generate'"
+
+  Scenario: Show the list of files that will be operated on
+    Given a file named ".rstrip" with:
+    """
+      rb
+      erb
+    """
+    Given an empty file named "lib/dummy.rb"
+    Given an empty file named "dummy.erb"
+    When I run `rstrip config list`
+    Then the output should contain "in the current directory"
+     And the stdout should contain "lib/dummy.rb"
+     And the stdout should contain "dummy.erb"
+
+   Scenario: Don't show the files that's not in .rstrip
+     Given a file named ".rstrip" with:
+     """
+       rb
+     """
+     Given an empty file named "lib/dummy.rb"
+     Given an empty file named "dummy.erb"
+     When I run `rstrip config list`
+      And the stdout should contain "lib/dummy.rb"
+      And the stdout should not contain "dummy.erb"
+
+    Scenario: Run rstrip should remove the last new lines
+      Given a file named ".rstrip" with:
+      """
+        rb
+      """
+      Given a file named "lib/dummy.rb" with:
+      """
+       def a
+         puts 'hello'
+       end
+
+
+      """
+      When I run `rstrip process`
+       Then the stdout should contain "process lib/dummy.rb"
+       And a file named "lib/dummy.rb" should exist
+       And the file "lib/dummy.rb" should contain exactly:
+       """
+        def a
+          puts 'hello'
+        end
+       """

data/feature/support/env.rb

@@ -0,0 +1 @@
+require 'aruba/cucumber'

data/lib/rstrip.rb

@@ -0,0 +1,3 @@
+module Rstrip
+  # Your code goes here...
+end

data/lib/rstrip/cli.rb

@@ -0,0 +1,41 @@
+require 'thor'
+require 'rstrip/rstrip'
+module Rstrip
+  class CLI < Thor
+
+    include Thor::Actions
+
+    desc "config", "generate: to generate a .rstrip file. list: to show the files that will be operated on"
+    long_desc <<-D
+      config can receive two arguments.
+
+      generate: Generate a .rstrip config file containing file extensions rstrip will operate on.Defaults to the current
+                directory.Use --global true to generate .rstrip to the user's home directory.\n
+      list:     Show the location of the .rstrip config file that will be used. And show a list of files that will be
+                operated on based on the .rstrip config file
+    D
+    method_option :global, :type => :boolean, :aliases => "-g", :default => false
+    def config(task)
+      case task.downcase
+      when 'generate'
+        if options[:global]
+          template("rstrip.tt.txt", "#{Dir.home}/.rstrip")
+        else
+          template("rstrip.tt.txt", "#{Dir.pwd}/.rstrip")
+        end
+      when 'list'
+        Rstrip.list
+      end
+    end
+
+    desc "process", "run rstrip in the current folder recursively"
+    def process
+      Rstrip.list.collect{ |f| Rstrip.process(f) }
+    end
+
+    def self.source_root
+      File.dirname(__FILE__) + "/templates"
+    end
+
+  end
+end

data/lib/rstrip/rstrip.rb

@@ -0,0 +1,77 @@
+module Rstrip
+
+  class Rstrip
+
+    class << self
+
+      def process(file_path)
+        if File.symlink?(file_path)
+          puts "skip symlink #{file_path}" and return
+        elsif !File.writable?(file_path)
+          puts "skip read only #{file_path}" and return
+        else
+          puts "process #{file_path}"
+        end
+        content = ""
+        File.open(file_path, 'r') do |file|
+          file.each_line do |line|
+            content << rstrip(line)
+          end
+        end
+        File.open(file_path, 'w') do |file|
+          file.write(content.rstrip)
+        end
+      end
+
+      def rstrip(line)
+        line.rstrip + "\n"
+      end
+
+      def list
+        if File.exists?("#{Dir.pwd}/.rstrip")
+          path = "#{Dir.pwd}/.rstrip"
+          puts "Using #{Dir.pwd}/.rstrip in the current directory"
+        elsif File.exists?("#{Dir.home}/.rstrip")
+          path ="#{Dir.home}/.rstrip"
+          puts "Using #{Dir.home}/.rstrip in your home directory"
+        else
+          puts %{ Can't find any .rstrip config file\n
+                  Please run 'rstrip config generate'\n
+               }
+          exit
+        end
+        extensions = get_extensions(path)
+        get_files(extensions)
+      end
+
+    private
+
+      def get_extensions(path)
+        extensions = []
+        file = File.open(path, "r")
+        file.each_line do |line|
+          line.strip!
+          unless line.empty?
+            if line.start_with?(".")
+              line = line[1..-1]
+            end
+            extensions << line
+          end
+        end
+        puts "Using the following extensions:\n #{extensions.join(', ') }\n"
+        extensions
+      end
+
+      def get_files(extensions)
+        pattern = "**/*.{#{extensions.join(",")}}"
+        files = Dir.glob(pattern)
+        puts "Files that will be operated on:"
+        files.collect{|f| puts f}
+        files
+      end
+
+    end # end class method
+
+  end
+
+end

data/lib/rstrip/templates/rstrip.tt.txt

@@ -0,0 +1,10 @@
+rb
+erb
+haml
+js
+coffee
+css
+scss
+rdoc
+feature
+yml

data/lib/rstrip/version.rb

@@ -0,0 +1,3 @@
+module Rstrip
+  VERSION = "0.0.2"
+end

data/rstrip.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rstrip/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rstrip"
+  s.version     = Rstrip::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["zhengjia"]
+  s.email       = ["jiazheng@live.com"]
+  s.homepage    = ""
+  s.summary     = %q{A ruby executable that removes the trailing white space in the current project directory}
+  s.description = %q{A ruby executable that removes the trailing white space in the current project directory. It also remove the last empty line if there is one}
+
+  s.rubyforge_project = "rstrip"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec", ">= 2.0.0"
+  s.add_development_dependency "aruba", "~> 0.4.3"
+  s.add_dependency "thor"
+end

data/spec/rstrip_spec.rb

@@ -0,0 +1,31 @@
+require 'rstrip/rstrip'
+
+describe Rstrip::Rstrip do
+
+  it "should remove right whitespace" do
+    Rstrip::Rstrip.rstrip("Lorem ipsum \n").should == "Lorem ipsum\n"
+  end
+
+  it "should remove right tab" do
+    Rstrip::Rstrip.rstrip("Lorem ipsum\t\n").should == "Lorem ipsum\n"
+  end
+
+  it "should remove right form" do
+    Rstrip::Rstrip.rstrip("Lorem ipsum\f\n").should == "Lorem ipsum\n"
+  end
+
+  it "should remove right carriage return" do
+    Rstrip::Rstrip.rstrip("Lorem ipsum\r\n").should == "Lorem ipsum\n"
+  end
+
+  it "should remove multiple whitespace" do
+    Rstrip::Rstrip.rstrip("Lorem ipsum \f\t \n").should == "Lorem ipsum\n"
+  end
+
+  it "should not remove right newline\n" do
+    Rstrip::Rstrip.rstrip("Lorem ipsum\n").should == "Lorem ipsum\n"
+    Rstrip::Rstrip.rstrip("Lorem ipsum\n\n").should == "Lorem ipsum\n"
+    Rstrip::Rstrip.rstrip("Lorem ipsum\r\n").should == "Lorem ipsum\n"
+  end
+
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: rstrip
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.2
+platform: ruby
+authors: 
+- zhengjia
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-26 00:00:00 -05: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 
+        version: 2.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: aruba
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.4.3
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: A ruby executable that removes the trailing white space in the current project directory. It also remove the last empty line if there is one
+email: 
+- jiazheng@live.com
+executables: 
+- rstrip
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- bin/rstrip
+- feature/config.feature
+- feature/support/env.rb
+- lib/rstrip.rb
+- lib/rstrip/cli.rb
+- lib/rstrip/rstrip.rb
+- lib/rstrip/templates/rstrip.tt.txt
+- lib/rstrip/version.rb
+- rstrip.gemspec
+- spec/rstrip_spec.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+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: rstrip
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A ruby executable that removes the trailing white space in the current project directory
+test_files: 
+- spec/rstrip_spec.rb