rstyle 0.0.2 → 0.0.3

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+
+branches:
+  only:
+    - master
+

data/README.textile

@@ -0,0 +1,29 @@
+h1. RStyle
+
+!https://secure.travis-ci.org/pmenglund/rstyle.png?branch=master!:http://travis-ci.org/pmenglund/rstyle
+
+Implements checks for some of the "Ruby":https://github.com/chneukirchen/styleguide/blob/master/RUBY-STYLE style guide items.
+
+This tool is meant to be use as a pre-commit hook for <code>git</code>, to ensure the code is properly formatted. Run the following
+<pre>cd .git/hooks
+ln -s /path/to/bin/rstyle</pre>
+
+and you'll have to be compliant with the <code>rstyle</code> checks to be able to commit code to the repository.
+
+It can also be used to check one or more ruby files in standalone mode:
+<pre>rstyle /path/to/rubyfile.rb</pre>
+
+h1. Style checks
+
+The style checker looks for the following:
+* line longer than 80 characters
+* empty line contains whitespace
+* line contains tab(s)
+* line ends with whitespace
+* no space after ,
+* space after ( and [ or before ) and ]
+* methods should be in snake_case
+* use two spaces before statement modifiers
+
+It will also issue warnings for the following:
+* don't use <code>for/code> unless you know what you are doing

data/Rakefile

@@ -1,14 +1,9 @@
 require 'bundler'
 require 'rspec/core/rake_task'
-require 'metric_fu'
 
 Bundler::GemHelper.install_tasks
 
-RSpec::Core::RakeTask.new(:rspec) do |t|
+task :default => [:spec]
+RSpec::Core::RakeTask.new(:spec) do |t|
   t.rspec_opts = "--color"
 end
-
-desc "run autotest"
-task :autotest do
-  system "autotest"
-end

data/bin/rstyle

@@ -1,13 +1,13 @@
 #!/usr/bin/env ruby
 #
 # Copyright 2010 Code Nursery AB
-# 
+#
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
-# 
+#
 #     http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -17,10 +17,8 @@
 if File.symlink?($0) && $0 =~ /pre-commit/
   prog = %x{pwd}.chomp + "/.git/hooks/" + File.readlink($0)
   base = File.dirname File.expand_path(prog)
-elsif
-  base = File.expand_path(File.dirname($0))
 else
-  exit 2
+  base = File.expand_path(File.dirname($0))
 end
 
 gemfile = File.expand_path("/../Gemfile", base)
@@ -44,7 +42,7 @@ if File.exist?(RSTYLE_FILE)
   end
 end
 
-s = Rstyle.new([lines, ARGV].flatten)
+s = RStyle.new([lines, ARGV].flatten)
 
 if ARGV.length == 0
   files = []

data/lib/rstyle.rb

@@ -1,4 +1,4 @@
-# Copyright 2010 Code Nursery AB
+# Copyright 2010, 2011 Martin Englund
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,13 +14,14 @@
 
 require "trollop"
 
-class Rstyle
+class RStyle
   attr_reader :line_count, :errors, :warnings
 
   def initialize(options)
     @options = parse_options(options)
     @errors = 0
     @warnings = 0
+    @skip = nil
   end
 
   def parse_options(options)
@@ -68,36 +69,51 @@ class Rstyle
       @line_count += 1
 
       # strip out text from strings
+      # TODO include other forms of strings
       @line = @line.gsub(/"([^"]+)"/, "\"\"")
 
       # strip out text from regexps
+      # TODO include other regexps
       @line = @line.gsub(/\/([^\/]+)\//, "//")
 
-      if @oline.length > @options[:line_length]
-        error "line longer than #{@options[:line_length]} characters"
-      end
+      max_len = @options[:line_length]
+      begin
+        if @oline.length > max_len
+          error "line longer than #{max_len} characters (#{@oline.length})"
+        end
 
-      check :empty_line, "empty line contains whitespace", /^\s+$/
+        check :empty_line, "empty line contains whitespace", /^\s+$/
 
-      check :tabs, "line contains tab(s)", /\t/
+        check :tabs, "line contains tab(s)", /\t/
 
-      check :ends_with_whitespace, "line ends with whitespace", /\S+\s+$/
+        check :ends_with_whitespace, "line ends with whitespace", /\S+\s+$/
 
-      check :no_space_after_comma, "no space after ,", /,\S+/
+        # skip all check below if in a comment
+        next  if @line =~ /^\s*#/
 
-      check :space_after, "space after ( and [ or before ) and ]",
-            /[\(\[]\s+|\s+[\)\]]/
+        check :no_space_after_comma, "no space after ,", /,\S+/
 
-      check :two_spaces, "use two spaces before statement modifiers",
-            /\S+( | {3,})(if|unless|until|rescue|while)/
+        check :space_after, "space after ( and [ or before ) and ]",
+              /[\(\[]\s+|\s+[\)\]]/
 
-      check(:snake_case, /\s*def (\S+)/) do |method|
-        error "methods should be in snake_case"  if method =~ /[A-Z]/
-      end
+        check :two_spaces, "use two spaces before statement modifiers",
+              /\S+( | {3,})(if|unless|until|rescue|while)/
+
+        check(:snake_case, /\s*def (\S+)/) do |method|
+          error "methods should be in snake_case"  if method =~ /[A-Z]/
+        end
 
-      check(:no_for, /^\s*for/) do
-        warning "don't use for unless you know what you are doing"
+        check(:no_for, /^\s*for/) do
+          warning "don't use for unless you know what you are doing"
+        end
+      ensure
+        if @line =~ /^\s*#\s*RSTYLE:\s*(.+)$/
+          @skip = $1.to_sym
+        else
+          @skip = nil
+        end
       end
+
     end
   end
 
@@ -106,9 +122,9 @@ class Rstyle
   def check(name, *args)
     if @options[name] || @options[:all]
       if @line =~ args[args.length - 1]
-        if block_given?
+        if block_given? && name != @skip
           yield($1)
-        else
+        elsif name != @skip
           error(args[0])
         end
       end

data/lib/rstyle/version.rb

@@ -1,4 +1,4 @@
-# Copyright 2010 Code Nursery AB
+# Copyright 2010, 2011 Martin Englund
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -13,5 +13,5 @@
 # limitations under the License.
 
 module Rstyle
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/rstyle.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "trollop"
 
   s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
 end

data/spec/rstyle_spec.rb

@@ -1,4 +1,4 @@
-# Copyright 2010 Code Nursery AB
+# Copyright 2011 Martin Englund
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,10 +15,10 @@
 require 'spec_helper'
 require 'rstyle'
 
-describe Rstyle do
+describe RStyle do
 
   before(:each) do
-    @s = Rstyle.new(["--all"])
+    @s = RStyle.new(["--all"])
     @s.stub(:e)
   end
 
@@ -65,6 +65,21 @@ describe Rstyle do
     @s.errors.should == 1
   end
 
+  it "should ignore , with space in comments" do
+    @s.parse [" # x , y"]
+    @s.errors.should == 0
+  end
+
+  it "should ignore errors when overriden" do
+    @s.parse ["# RSTYLE: snake_case", "def FooBar"]
+    @s.errors.should == 0
+  end
+
+  it "should ignore errors when overriden" do
+    @s.parse ["# RSTYLE: tabs", "a\tb"]
+    @s.errors.should == 0
+  end
+
   it "should warn about the use of for" do
     @s.parse ["  for x in @foo"]
     @s.warnings.should == 1

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-# Copyright 2010 Code Nursery AB
+# Copyright 2010, 2011 Martin Englund
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

metadata

@@ -1,68 +1,75 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rstyle
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.0.3
   prerelease: 
-  version: 0.0.2
 platform: ruby
-authors: 
+authors:
 - Martin Englund
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-20 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-12-21 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: highline
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70344078853600 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: trollop
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70344078853600
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: &70344078852460 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: *70344078852460
+- !ruby/object:Gem::Dependency
   name: rspec
+  requirement: &70344078850300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70344078850300
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70344078849840 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *70344078849840
 description: Style checking for Ruby code
-email: 
+email:
 - martin@englund.nu
-executables: 
+executables:
 - rstyle
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .autotest
+files:
 - .gitignore
 - .rspec
 - .rstyle
+- .travis.yml
 - Gemfile
 - LICENSE
-- README.md
+- README.textile
 - Rakefile
 - bin/rstyle
 - lib/rstyle.rb
@@ -71,35 +78,32 @@ files:
 - spec/assets/test.rb
 - spec/rstyle_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: https://github.com/pmenglund/rstyle
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: rstyle
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Style checking for Ruby code
-test_files: 
+test_files:
 - spec/assets/test.rb
 - spec/rstyle_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/.autotest

@@ -1,2 +0,0 @@
-require 'autotest/bundler'
-

data/README.md

@@ -1,34 +0,0 @@
-README
-======
-
-Implements checks for some of the
-[Ruby](https://github.com/chneukirchen/styleguide/blob/master/RUBY-STYLE)
-style guide items.
-
-This tool is meant to be use as a pre-commit hook for git, to ensure the code
-is properly formatted. Run the following
-    cd .git/hooks
-    ln -s /path/to/bin/rstyle
-and you'll have to be compliant with the rstyle checks to be able to commit
-code to the repository.
-
-It can also be used to check one or more ruby files in standalone mode:
-    rstyle /path/to/rubyfile.rb
-
-Style checks
-============
-
-The style checker looks for the following:
-
-* line longer than 80 characters
-* empty line contains whitespace
-* line contains tab(s)
-* line ends with whitespace
-* no space after ,
-* space after ( and [ or before ) and ]
-* methods should be in snake_case
-* use two spaces before statement modifiers
-
-It will also issue warnings for the following:
-
-* don't use `for` unless you know what you are doing