tailor 0.0.2

data/lib/tailor/indentation_checker.rb

@@ -0,0 +1,27 @@
+module Tailor
+  module IndentationChecker
+    def validate_indentation file
+      results = Array.new
+
+      source = File.open(file, 'r')
+
+      # Start the line number at 1, not 0
+      line_number = 1
+
+      source.each_line do |line_of_code|
+        line = FileLine.new(line_of_code)
+
+        # Make sure the line isn't hard-tabbed
+        if line.hard_tabbed?
+          results << "Line #{line_number} is hard-tabbed."
+        end
+
+        # Check for indentation
+        #spaces = line.indented_spaces
+        #current_depth_level = spaces / 2
+
+        line_number =+ 1
+      end
+    end
+  end
+end

data/ruby-style-checker.rb

@@ -0,0 +1,136 @@
+$tabSize = 2
+$tabStr = " "
+
+# indent regexp tests
+
+$indentExp = [
+  /^module\b/,
+  /(=\s*|^)if\b/,
+  /(=\s*|^)until\b/,
+  /(=\s*|^)for\b/,
+  /(=\s*|^)unless\b/,
+  /(=\s*|^)while\b/,
+  /(=\s*|^)begin\b/,
+  /(=\s*|^)case\b/,
+  /\bthen\b/,
+  /^class\b/,
+  /^rescue\b/,
+  /^def\b/,
+  /\bdo\b/,
+  /^else\b/,
+  /^elsif\b/,
+  /^ensure\b/,
+  /\bwhen\b/,
+  /\{[^\}]*$/,
+  /\[[^\]]*$/
+]
+
+# outdent regexp tests
+
+$outdentExp = [
+  /^rescue\b/,
+  /^ensure\b/,
+  /^elsif\b/,
+  /^end\b/,
+  /^else\b/,
+  /\bwhen\b/,
+  /^[^\{]*\}/,
+  /^[^\[]*\]/
+]
+
+def makeTab(tab)
+  return (tab < 0)?"":$tabStr * $tabSize * tab
+end
+
+def addLine(line,tab)
+  line.strip!
+  line = makeTab(tab)+line if line.length > 0
+  return line + "\n"
+end
+
+def format_ruby
+  commentBlock = false
+  multiLineArray = Array.new
+  multiLineStr = ""
+  tab = 0
+  ############
+  #filename entered on command line as argument gets passed in Ruby's
+  #special argument array ARGV. The ARGV[0] zeroth element has the filename
+  ############
+  filename = ARGV[0]
+  source = File.new(filename,'r').read
+  dest = ""
+  source.split("\n").each do |line|
+    # combine continuing lines
+    if(!(line =~ /^\s*#/) && line =~ /[^\\]\\\s*$/)
+      puts "hereeeeer"
+      #multiLineArray.push line
+      #multiLineStr += line.sub(/^(.*)\\\s*$/,"\\1")
+      next
+    end
+
+    # add final line
+    if(multiLineStr.length > 0)
+      puts "HERLKJHLJKEHR"
+      #multiLineArray.push line
+      #multiLineStr += line.sub(/^(.*)\\\s*$/,"\\1")
+    end
+
+    tline = ((multiLineStr.length > 0)?multiLineStr:line).strip
+    if(tline =~ /^=begin/)
+      commentBlock = true
+    end
+    if(commentBlock)
+      # add the line unchanged
+      dest += line + "\n"
+    else
+      commentLine = (tline =~ /^#/)
+      if(!commentLine)
+        # throw out sequences that will
+        # only sow confusion
+        tline.gsub!(/\/.*?\//,"")
+        tline.gsub!(/%r\{.*?\}/,"")
+        tline.gsub!(/%r(.).*?\1/,"")
+        tline.gsub!(/\\\"/,"'")
+        tline.gsub!(/".*?"/,"\"\"")
+        tline.gsub!(/'.*?'/,"''")
+        tline.gsub!(/#\{.*?\}/,"")
+        $outdentExp.each do |re|
+          if(tline =~ re)
+            tab -= 1
+            break
+          end
+        end
+      end
+      if (multiLineArray.length > 0)
+        multiLineArray.each do |ml|
+          dest += addLine(ml,tab)
+        end
+        multiLineArray.clear
+        multiLineStr = ""
+      else
+        dest += addLine(line,tab)
+      end
+      if(!commentLine)
+        $indentExp.each do |re|
+          if(tline =~ re && !(tline =~ /\s+end\s*$/))
+            tab += 1
+            break
+          end
+        end
+      end
+    end
+    if(tline =~ /^=end/)
+      commentBlock = false
+    end
+  end
+  #STDOUT.write(dest)
+  #File.open(filename, 'w') {|fw| fw.write(dest)}
+  puts "File #{ARGV[0]} has been formatted."
+  # uncomment this to complain about mismatched blocks
+  if(tab != 0)
+    STDERR.puts "Indentation error: #{tab}"
+  end
+end
+
+format_ruby

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/tailor'}"
+puts "Loading tailor gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/file_line_spec.rb

@@ -0,0 +1,136 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+require 'tailor/file_line'
+
+include Tailor
+
+describe Tailor::FileLine do
+  context "should return the number of leading spaces in a line" do
+    it "when the line is not indented" do
+      line = FileLine.new "def do_something"
+      line.indented_spaces.should == 0
+    end
+
+    it "when the line is indented 1 space" do
+      line = FileLine.new " def do_something"
+      line.indented_spaces.should == 1
+    end
+
+    it "when the line is indented 1 space and a hard tab" do
+      line = FileLine.new " \tdef do_something"
+      line.indented_spaces.should == 1
+    end
+  end
+
+  context "should check hard tabs" do
+    it "when the line is indented 1 hard tab" do
+      line = FileLine.new "\tdef do_something"
+      line.hard_tabbed?.should be_true
+    end
+
+    it "when the line is indented with a space and 1 hard tab" do
+      line = FileLine.new " \tdef do_something"
+      line.hard_tabbed?.should be_true
+    end
+
+    it "when the line is indented with a space" do
+      line = FileLine.new " def do_something"
+      line.hard_tabbed?.should be_false
+    end
+
+    it "when the line is not indented" do
+      line = FileLine.new "def do_something"
+      line.hard_tabbed?.should be_false
+    end
+  end
+
+  context "should check for camel case when" do
+    it "is a method and the method name is camel case" do
+      line = FileLine.new "def doSomething"
+      line.camel_case_method?.should be_true
+    end
+
+    it "is a method and the method name is snake case" do
+      line = FileLine.new "def do_something"
+      line.camel_case_method?.should be_false
+    end
+
+    it "is a class and the class name is camel case" do
+      line = FileLine.new "class AClass"
+      line.camel_case_class?.should be_true
+    end
+
+    it "is a class and the class name is snake case" do
+      line = FileLine.new "class A_Class"
+      line.camel_case_class?.should be_false
+    end
+  end
+
+  it "should detect the number of trailing whitespace(s)" do
+    line = FileLine.new "  puts 'This is a line.'  \n"
+    line.trailing_whitespace_count.should == 2
+  end
+
+  # TODO: These methods should probably all be called by
+  #   line.check_comma_spacingor something.  As it stands, these tests are
+  #   going to start to get confusing, plus having one entry point for
+  #   checking commas probably makes the most sense.
+  context "spacing after a comma" do
+    it "should detect no space after a comma" do
+      line = FileLine.new "  def do_something this,that"
+      line.no_space_after_comma?.should be_true
+    end
+
+    it "should skip code that has 1 space after a comma" do
+      line = FileLine.new "  def do_something this, that"
+      line.no_space_after_comma?.should be_false
+    end
+
+    it "should detect 2 spaces after a comma" do
+      line = FileLine.new "  def do_something this,  that"
+      line.two_or_more_spaces_after_comma?.should be_true
+    end
+
+    it "should skip code that has 1 space after a comma" do
+      line = FileLine.new "  def do_something this, that"
+      line.two_or_more_spaces_after_comma?.should be_false
+    end
+  end
+
+  context "comments" do
+    it "should detect a regular full line comment" do
+      line = FileLine.new "  # This is a comment."
+      line.line_comment?.should be_true
+    end
+
+    it "should skip code that's not a full line comment" do
+      line = FileLine.new "  puts 'this is some code.'"
+      line.line_comment?.should be_false
+    end
+  end
+
+  context "line length" do
+    it "should detect greater than 80 characters" do
+      string_81_chars = '#' * 81
+      line = FileLine.new string_81_chars
+      line.too_long?.should be_true
+    end
+
+    it "should detect greater than 80 spaces" do
+      string_81_spaces = ' ' * 81
+      line = FileLine.new string_81_spaces
+      line.too_long?.should be_true
+    end
+
+    it "should be OK with 80 chars" do
+      string_80_chars = '#' * 80
+      line = FileLine.new string_80_chars
+      line.too_long?.should be_false
+    end
+
+    it "should be OK with 80 spaces" do
+      string_80_spaces  = ' ' * 80
+      line = FileLine.new string_80_spaces
+      line.too_long?.should be_false
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

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

data/spec/tailor_spec.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Kernel do
+  def self.get_requires
+    Dir.chdir '../lib'
+    filenames = Dir.glob 'Tailor/*.rb'
+    requires = filenames.each do |fn|
+      fn.chomp!(File.extname(fn))
+    end
+    return requires
+  end
+
+  # Try to require each of the files in Tailor
+  get_requires.each do |r|
+    it "should require #{r}" do
+      # A require returns true if it was required, false if it had already been
+      #   required, and nil if it couldn't require.
+      Kernel.require(r.to_s).should_not be_nil
+    end
+  end
+end
+
+describe Tailor do
+  it "should have a VERSION constant" do
+    Tailor.const_defined?('VERSION').should == true
+  end
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+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']
+end

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification 
+name: tailor
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Steve Loveless
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-23 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 4
+        version: 2.0.4
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe-yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 2
+        version: 0.1.2
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 3
+        version: 0.5.3
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: hoe-yard
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 2
+        version: 0.1.2
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 3
+        version: 0.6.3
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  version_requirements: *id007
+description: |+
+  * http://github.com/turboladen/tailor
+  
+email: 
+- steve.loveless@gmail.com
+executables: 
+- tailor
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files: 
+- 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
+has_rdoc: yard
+homepage: http://github.com/turboladen/tailor
+licenses: []
+
+post_install_message: 
+- |
+  
+
+- |
+  For more information on tailor, see http://github.com/turboladen/tailor
+
+rdoc_options: 
+- --main
+- README.rdoc
+- --output-dir
+- doc
+- --private
+- --protected
+- --verbose
+- --files
+- - Manifest.txt
+  - History.txt
+- --title
+- tailor Documentation (0.0.2)
+- --markup
+- :rdoc
+require_paths: 
+- lib
+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: tailor
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Utility for checking style of Ruby files.
+test_files: 
+- spec/file_line_spec.rb
+- spec/spec_helper.rb
+- spec/tailor_spec.rb