rstyle 0.0.1

data/.autotest

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

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,174 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.

data/README.md

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

data/Rakefile

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

data/bin/rstyle

@@ -0,0 +1,57 @@
+#!/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.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+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
+end
+
+gemfile = File.expand_path("/../Gemfile", base)
+
+if File.exists?(gemfile)
+  ENV["BUNDLE_GEMFILE"] = gemfile
+  require "rubygems"
+  require "bundler/setup"
+end
+
+$:.unshift(File.expand_path("../lib", base))
+require "rstyle"
+
+trap("INT") { puts "Exiting..."; exit(0) }
+
+s = Rstyle.new
+
+if ARGV.length == 0
+  files = []
+  %x{git status --short --untracked-files=no 2>&1}.split("\n").each do |line|
+    unless $? == 0
+      $stderr.puts "failed to execute 'git status'"
+      exit 2
+    end
+    if line =~ /^[MA].\s(.+)\S*$/
+      files << $1
+    end
+  end
+  s.source(files)
+else
+  s.source(ARGV)
+end
+
+exit 1 unless s.errors == 0

data/lib/rstyle/version.rb

@@ -0,0 +1,17 @@
+# 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.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Rstyle
+  VERSION = "0.0.1"
+end

data/lib/rstyle.rb

@@ -0,0 +1,111 @@
+# 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.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class Rstyle
+  attr_reader :line_count, :errors, :warnings
+
+  def initialize
+    @errors = 0
+    @warnings = 0
+  end
+
+  def source(files)
+    files.each do |file|
+      if File.directory?(file)
+        source Dir.glob("#{file}/**/*.rb")
+      elsif file =~ /\.rb/
+        read_file(file)
+      end
+    end
+  end
+
+  def read_file(file)
+    @file = file
+    File.open(file) do |f|
+      lines = []
+      begin
+        while lines << f.readline.chomp; end
+      rescue EOFError
+        # do nothing, it is expected
+      end
+      parse(lines)
+    end
+  end
+
+  def parse(lines)
+    @line_count = 0
+    lines.each_with_index do |line, i|
+      @oline = @line = line
+      @line_count += 1
+
+      # strip out text from strings
+      @line = @line.gsub(/"([^"]+)"/, "\"\"")
+
+      # strip out text from regexps
+      @line = @line.gsub(/\/([^\/]+)\//, "//")
+
+      if @oline.length > 80
+        error "line longer than 80 characters"
+      end
+
+      check "empty line contains whitespace", /^\s+$/
+
+      check "line contains tab(s)", /\t/
+
+      check "line ends with whitespace", /\S+\s+$/
+
+      check "no space after ,", /,\S+/
+
+      check "space after ( and [ or before ) and ]", /[\(\[]\s+|\s+[\)\]]/
+
+      check "use two spaces before statement modifiers",
+          /\S+( | {3,})(if|unless|until|rescue|while)/
+
+      check(/\s*def (\S+)/) do |method|
+        error "methods should be in snake_case"  if method =~ /[A-Z]/
+      end
+
+      check(/^\s*for/) do
+        warning "don't use for unless you know what you are doing"
+      end
+    end
+  end
+
+  private
+
+  def check(*args)
+    if @line =~ args[args.length - 1]
+      if block_given?
+        yield($1)
+      else
+        error(args[0])
+      end
+    end
+  end
+
+  def error(message)
+    @errors += 1
+    e(message)
+  end
+
+  def warning(message)
+    @warnings += 1
+    e "warning: #{message}"
+  end
+
+  def e(message)
+    $stderr.printf("%s: ", @file)  if @file
+    $stderr.puts "#{@line_count}: #{message}"
+  end
+end

data/rstyle.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rstyle/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rstyle"
+  s.version     = Rstyle::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Martin Englund"]
+  s.email       = ["martin@englund.nu"]
+  s.homepage    = "https://github.com/pmenglund/rstyle"
+  s.summary     = %q{Style checking for Ruby code}
+  s.description = %q{Style checking for Ruby code}
+
+  s.rubyforge_project = "rstyle"
+
+  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_runtime_dependency "highline"
+
+  s.add_development_dependency "rspec"
+end

data/spec/rstyle_spec.rb

@@ -0,0 +1,72 @@
+# 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.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'spec_helper'
+require 'rstyle'
+
+describe Rstyle do
+
+  before(:each) do
+    @s = Rstyle.new
+    @s.stub(:e)
+  end
+
+  it "should read the correct number of lines" do
+    @s.parse %w(a b c)
+    @s.line_count.should == 3
+    @s.errors.should == 0
+  end
+
+  it "should catch lines with only whitespace in them" do
+    @s.parse [" "]
+    @s.errors.should == 1
+  end
+
+  it "should catch lines with tabs" do
+    @s.parse ["\tx"]
+    @s.errors.should == 1
+  end
+
+  it "should catch whitespace at the end of a line" do
+    @s.parse ["x "]
+    @s.errors.should == 1
+  end
+
+  it "should catch methods not in snake_case" do
+    @s.parse(["def FooBar", "def foo_bar"])
+    @s.errors.should == 1
+  end
+
+  it "should catch , without spaces after" do
+    @s.parse ["func(a,b)", "func(a, b)"]
+    @s.errors.should == 1
+  end
+
+  it "should catch spaces after ( & [ and before ) & ]" do
+    @s.parse [
+        "func( x)", "func(x )", "func(x)",
+        "[ a, b]", "[a, b ]", "[a, b]"]
+    @s.errors.should == 4
+  end
+
+  it "should catch lines longer than 80 characters" do
+    @s.parse ["x" * 81, "y" * 80]
+    @s.errors.should == 1
+  end
+
+  it "should warn about the use of for" do
+    @s.parse ["  for x in @foo"]
+    @s.warnings.should == 1
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# 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.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'rspec/core'
+
+$:.unshift(File.expand_path("../../lib", __FILE__))
+
+RSpec.configure do |c|
+  c.color_enabled = true
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: rstyle
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Martin Englund
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-20 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: highline
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Style checking for Ruby code
+email: 
+- martin@englund.nu
+executables: 
+- rstyle
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .autotest
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/rstyle
+- lib/rstyle.rb
+- lib/rstyle/version.rb
+- rstyle.gemspec
+- 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: 
+- 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: rstyle
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Style checking for Ruby code
+test_files: 
+- spec/rstyle_spec.rb
+- spec/spec_helper.rb