tailor 0.0.2

data/History.txt

@@ -0,0 +1,19 @@
+=== 0.0.2 2010-04-23
+
+* Renamed project from ruby_style_checker to Tailor
+* Added check for lines > 80 characters
+
+=== 0.0.1 2010-04-22
+
+* Initial release!
+* Command-line executable takes a directory and checks all files, recursively.
+* Checks for:
+  * Indentation
+    * Hard-tabs in indentation
+  * Name cases
+    * Snake case class & module names
+    * Camel case method names
+  * Extra whitespace
+    * At the end of lines
+    * On empty lines
+    * After commas

data/Manifest.txt

@@ -0,0 +1,36 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+bin/tailor
+features/case_checking.feature
+features/development.feature
+features/spacing.feature
+features/step_definitions/case_checking_steps.rb
+features/step_definitions/common_steps.rb
+features/step_definitions/spacing_steps.rb
+features/support/1_file_with_camel_case_class/camel_case_class.rb
+features/support/1_file_with_camel_case_method/camel_case_method.rb
+features/support/1_file_with_hard_tabs/hard_tab.rb
+features/support/1_file_with_long_lines/long_lines.rb
+features/support/1_file_with_snake_case_class/snake_case_class.rb
+features/support/1_file_with_snake_case_method/snake_case_method.rb
+features/support/1_file_with_trailing_whitespace/trailing_whitespace.rb
+features/support/1_good_simple_file/my_project.rb
+features/support/common.rb
+features/support/env.rb
+features/support/matchers.rb
+features/support/world.rb
+lib/tailor.rb
+lib/tailor/file_line.rb
+lib/tailor/indentation_checker.rb
+ruby-style-checker.rb
+script/console
+script/destroy
+script/generate
+spec/file_line_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+spec/tailor_spec.rb
+tasks/rspec.rake

data/PostInstall.txt

@@ -0,0 +1,2 @@
+
+For more information on tailor, see http://github.com/turboladen/tailor

data/README.rdoc

@@ -0,0 +1,62 @@
+= tailor
+
+* http://github.com/turboladen/tailor
+
+== DESCRIPTION:
+
+tailor is an executable that recursively parses Ruby files in a 
+directory and checks them for bad style.  Rules for judging style are based on 
+a number of style guides that are popular in the Ruby community.  More on this
+here http://wiki.github.com/turboladen/tailor.
+
+== FEATURES/PROBLEMS:
+
+* Recursively checks for bad style in Ruby files in a directory 
+* Checks for:
+  * Indentation
+    * Hard-tabs in indentation
+  * Name cases
+    * Snake case class & module names
+    * Camel case method names
+  * Extra whitespace
+    * At the end of lines
+    * On empty lines
+  * Line length
+    * Should be <= 80 characters
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* None yet!
+
+== INSTALL:
+
+* (sudo) gem install tailor
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Steve Loveless
+
+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.

data/Rakefile

@@ -0,0 +1,78 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/tailor'
+
+Hoe.plugin :newgem
+Hoe.plugin :yard
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Gets the description from the main README file
+def get_descr_from_readme
+  paragraph_count = 0
+  File.readlines('README.rdoc', '').each do |paragraph|
+    paragraph_count += 1
+    if paragraph_count == 2
+      return paragraph
+    end
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'tailor' do
+  self.summary      = "Utility for checking style of Ruby files."
+  self.developer('Steve Loveless', 'steve.loveless@gmail.com')
+  self.post_install_message = File.readlines 'PostInstall.txt'
+  self.rubyforge_name = self.name
+  self.version        = Tailor::VERSION
+  self.url            = 'http://github.com/turboladen/tailor'
+  self.description    = get_descr_from_readme
+  self.readme_file    = 'README.rdoc'
+  self.history_file   = 'History.txt'
+  self.rspec_options  += ['--color', '--format', 'specdoc']
+  self.extra_dev_deps += [
+    ['rspec'],
+    ['yard', '>=0.5.3'],
+    ['hoe-yard', '>=0.1.2'],
+    ['cucumber', '>=0.6.3']
+  ]
+
+  self.test_globs   = 'spec/*.rb'
+
+  # Extra Yard options
+  self.yard_title   = "#{self.name} Documentation (#{self.version})"
+  self.yard_markup  = :rdoc
+  self.yard_opts    += ['--main', self.readme_file]
+  self.yard_opts    += ['--output-dir', 'doc']
+  self.yard_opts    += ['--private']
+  self.yard_opts    += ['--protected']
+  self.yard_opts    += ['--verbose']
+  self.yard_opts    += ['--files', 
+    ['Manifest.txt', 'History.txt']
+  ]
+end
+
+#-------------------------------------------------------------------------------
+# Overwrite the :clobber_docs Rake task so that it doesn't destroy our docs
+#   directory.
+#-------------------------------------------------------------------------------
+class Rake::Task
+  def overwrite(&block)
+    @actions.clear
+    enhance(&block)
+  end
+end
+
+Rake::Task[:clobber_docs].overwrite do
+end
+
+# Now define the tasks
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/bin/tailor

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib/')
+
+require 'tailor'
+
+def usage
+  puts "Usage: #{__FILE__} [path to validate files from]"
+end
+
+if ARGV[0].nil?
+  puts usage
+else
+  path_to_check = ARGV[0]
+  files_and_problems = Tailor.check path_to_check
+  Tailor.print_report files_and_problems
+end
+

data/features/case_checking.feature

@@ -0,0 +1,38 @@
+Feature: Case checking
+  In order to make sure certain words are upper or lower case as they should be
+  As a Ruby developer
+  I want to find out which files have words that aren't in the proper case
+  
+  Scenario: Method names that are camel-cased are detected
+    Given I have a project directory "1_file_with_camel_case_method"
+      And I have "1" file in my project
+      And that file does not contain any "class" statements
+      And the file contains only "1" "def" statement
+      And the file contains a "method" that has a camel-cased name
+    When I run the checker on the project
+    Then the checker should tell me I have a camel-cased method name  
+
+  Scenario: Method names that are snake-cased are not reported
+    Given I have a project directory "1_file_with_snake_case_method"
+      And I have "1" file in my project
+      And that file does not contain any "class" statements
+      And the file contains only "1" "def" statement
+      And the file contains a "method" that has a snake-cased name
+    When I run the checker on the project
+    Then the checker shouldn't tell me the method name is camel-case
+
+  Scenario: Class names that are camel-cased are not reported
+    Given I have a project directory "1_file_with_camel_case_class"
+      And I have "1" file in my project
+      And the file contains only "1" "class" statement
+      And the file contains a "class" that has a camel-cased name
+    When I run the checker on the project
+    Then the checker shouldn't tell me the class name is camel-case 
+
+  Scenario: Class names that are snake-cased are detected
+    Given I have a project directory "1_file_with_snake_case_class"
+      And I have "1" file in my project
+      And the file contains only "1" "class" statement
+      And the file contains a "class" that has a snake-cased name
+    When I run the checker on the project
+    Then the checker should tell me the class name is not camel-case 

data/features/development.feature

@@ -0,0 +1,13 @@
+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/spacing.feature

@@ -0,0 +1,40 @@
+Feature: Indentation
+  In order to determine if my Ruby file is indented according to 
+    2-space standards
+  As a Ruby developer
+  I want to find out which files have indentation problems,
+    which lines those problems occur on,
+    and how much indentation they're missing
+
+  Scenario: A single class-less file in a project; 1 method, indented properly
+    Given I have a project directory "1_good_simple_file"
+      And I have "1" file in my project
+      And that file does not contain any "class" statements
+      And the file contains only "1" "def" statement
+      And that file is indented properly
+    When I run the checker on the project
+    Then the checker should tell me my indentation is OK
+  
+  Scenario: A single class-less file with hard tabs
+    Given I have a project directory "1_file_with_hard_tabs"
+      And I have "1" file in my project
+      And that file does not contain any "class" statements
+      And the file contains only "1" "def" statement
+      And that file contains lines with hard tabs
+    When I run the checker on the project
+    Then the checker should tell me each line that has a hard tab
+
+  Scenario: A single file that has all lines with trailing whitespace
+    Given I have a project directory "1_file_with_trailing_whitespace"
+      And I have "1" file in my project
+      And that file contains lines with trailing whitespace
+    When I run the checker on the project
+    Then the checker should tell me each line has trailing whitespace
+
+  Scenario: A single file that has a comment and a code line 90 characters long
+    Given I have a project directory "1_file_with_long_lines"
+      And I have "1" file in my project
+      And that file contains lines longer than 80 characters
+    When I run the checker on the project
+    Then the checker should tell me each line is too long
+  

data/features/step_definitions/case_checking_steps.rb

@@ -0,0 +1,42 @@
+require 'tailor/file_line'
+
+def contains_camel_case? keyword
+  @ruby_source = File.open(@file_list[0], 'r')
+
+  contains_camel_case = false
+  @ruby_source.each_line do |source_line|
+    line = FileLine.new source_line
+
+    if keyword.eql? "method"
+      line.camel_case_method? ? (return true) : (return false)
+    elsif keyword.eql? "class"
+      line.camel_case_class? ? (return true) : (return false)
+    end
+  end
+end
+
+Given /^the file contains a "([^\"]*)" that has a camel\-cased name$/ do
+  |keyword|
+  contains_camel_case?(keyword).should be_true
+end
+
+Given /^the file contains a "([^\"]*)" that has a snake\-cased name$/ do
+  |keyword|
+  contains_camel_case?(keyword).should be_false
+end
+
+Then /^the checker should tell me I have a camel\-cased method name$/ do
+  @result.should include("Method name uses camel case")
+end
+
+Then /^the checker shouldn't tell me the method name is camel\-case$/ do
+  @result.should_not include("Method name uses camel case")
+end
+
+Then /^the checker shouldn't tell me the class name is camel\-case$/ do
+  @result.should_not include("Class name uses camel case")
+end
+
+Then /^the checker should tell me the class name is not camel\-case$/ do
+  @result.should include("Class name does NOT use camel case")
+end

data/features/step_definitions/common_steps.rb

@@ -0,0 +1,175 @@
+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