jruby-lint 0.1

data/lib/jruby/lint/checkers/thread_critical.rb

@@ -0,0 +1,26 @@
+module JRuby::Lint
+  module Checkers
+    class ThreadCritical
+      include Checker
+
+      METHODS = %w(critical critical=)
+
+      def visitCallNode(node)
+        if METHODS.include?(node.name)
+          begin
+            if node.receiver_node.node_type.to_s == "CONSTNODE" && node.receiver_node.name == "Thread"
+              add_finding(collector, node)
+            end
+          rescue
+          end
+        end
+      end
+      alias visitAttrAssignNode visitCallNode
+
+      def add_finding(collector, node)
+        collector.findings << Finding.new("Use of Thread.critical is discouraged. Use a Mutex instead.",
+                                          [:threads, :warning], node.position)
+      end
+    end
+  end
+end

data/lib/jruby/lint/cli.rb

@@ -0,0 +1,61 @@
+module JRuby
+  module Lint
+    class CLI
+      def initialize(args)
+        process_options(args)
+      end
+
+      def process_options(args)
+        require 'optparse'
+        require 'ostruct'
+        @options = OpenStruct.new
+        OptionParser.new do |opts|
+          opts.banner = "Usage: jrlint [options] [files]"
+          opts.separator ""
+          opts.separator "Options:"
+
+          opts.on('-C', '--chdir DIRECTORY', "Change working directory") do |v|
+            Dir.chdir(v)
+          end
+
+          opts.on("-e", '--eval SCRIPT', "Lint an inline script") do |v|
+            @options.eval ||= []
+            @options.eval << v
+          end
+
+          opts.on_tail("-v", "--version", "Print version and exit") do
+            require 'jruby/lint/version'
+            puts "JRuby-Lint version #{VERSION}"
+            exit
+          end
+
+          opts.on_tail("-h", "--help", "This message") do
+            puts opts
+            exit
+          end
+        end.parse!(args)
+
+        @options.files = args.empty? ? nil : args
+      end
+
+      def run
+        require 'jruby/lint'
+        require 'benchmark'
+        project = JRuby::Lint::Project.new(@options)
+
+        puts "JRuby-Lint version #{JRuby::Lint::VERSION}"
+        time = Benchmark.realtime { project.run }
+        term = @options.eval ? 'expression' : 'file'
+        puts "Processed #{project.files.size} #{term}#{project.files.size == 1 ? '' : 's'} in #{'%0.02f' % time} seconds"
+
+        if project.findings.empty?
+          puts "OK"
+          exit
+        else
+          puts "Found #{project.findings.size} items"
+          exit 1
+        end
+      end
+    end
+  end
+end

data/lib/jruby/lint/collectors.rb

@@ -0,0 +1,75 @@
+module JRuby::Lint
+  class Collector
+    attr_accessor :checkers, :findings, :project, :contents, :file
+
+    def initialize(project = nil, file = nil)
+      @checkers = Checker.loaded_checkers.map(&:new)
+      @checkers.each {|c| c.collector = self }
+      @findings = []
+      @project, @file = project, file || '<inline-script>'
+    end
+
+    class CheckersVisitor < AST::Visitor
+      attr_reader :checkers
+
+      def initialize(ast, checkers)
+        super(ast)
+        @checkers = checkers
+      end
+
+      def visit(method, node)
+        after_hooks = []
+        checkers.each do |ch|
+          begin
+            if ch.respond_to?(method)
+              res = ch.send(method, node)
+              after_hooks << res if res.respond_to?(:call)
+            end
+          rescue => e
+            ch.collector.findings << Finding.new("Exception while traversing: #{e.message}",
+                                                 [:internal, :debug], node.position)
+          end
+        end
+        super
+      ensure
+        begin
+          after_hooks.each {|h| h.call }
+        rescue
+        end
+      end
+    end
+
+    def run
+      begin
+        CheckersVisitor.new(ast, checkers).traverse
+      rescue SyntaxError => e
+        file, line, message = e.message.split(/:\s*/, 3)
+        findings << Finding.new(message, [:syntax, :error], file, line)
+      end
+    end
+
+    def ast
+      @ast ||= JRuby.parse(contents, file, true)
+    end
+
+    def contents
+      @contents || File.read(@file)
+    end
+
+    def self.inherited(base)
+      self.all << base
+    end
+
+    def self.all
+      @collectors ||= []
+    end
+  end
+
+  module Collectors
+  end
+end
+
+require 'jruby/lint/collectors/ruby'
+require 'jruby/lint/collectors/bundler'
+require 'jruby/lint/collectors/rake'
+require 'jruby/lint/collectors/gemspec'

data/lib/jruby/lint/collectors/bundler.rb

@@ -0,0 +1,9 @@
+module JRuby::Lint
+  module Collectors
+    class Bundler < Collector
+      def self.detect?(f)
+        File.basename(f) == 'Gemfile'
+      end
+    end
+  end
+end

data/lib/jruby/lint/collectors/gemspec.rb

@@ -0,0 +1,9 @@
+module JRuby::Lint
+  module Collectors
+    class Gemspec < Collector
+      def self.detect?(f)
+        File.extname(f) == '.gemspec'
+      end
+    end
+  end
+end

data/lib/jruby/lint/collectors/rake.rb

@@ -0,0 +1,9 @@
+module JRuby::Lint
+  module Collectors
+    class Rake < Collector
+      def self.detect?(f)
+        File.basename(f) == 'Rakefile' || File.extname(f) == '.rake'
+      end
+    end
+  end
+end

data/lib/jruby/lint/collectors/ruby.rb

@@ -0,0 +1,14 @@
+module JRuby::Lint
+  module Collectors
+    class Ruby < Collector
+      def initialize(project, file, contents = nil)
+        super(project, file)
+        @contents = contents
+      end
+
+      def self.detect?(f)
+        File.extname(f) == '.rb'
+      end
+    end
+  end
+end

data/lib/jruby/lint/finding.rb

@@ -0,0 +1,15 @@
+module JRuby::Lint
+  class Finding < Struct.new(:message, :tags, :file, :line)
+    def initialize(*args)
+      args[1].map! {|x| x.to_s } if args.size > 1
+      if args.size > 2 && args[2].respond_to?(:file) && args[2].respond_to?(:line)
+        args = [args[0], args[1], args[2].file, (args[2].line + 1)]
+      end
+      super
+    end
+
+    def to_s
+      "#{file}:#{line}: [#{tags.join(', ')}] #{message}"
+    end
+  end
+end

data/lib/jruby/lint/github.crt

@@ -0,0 +1,76 @@
+-----BEGIN CERTIFICATE-----
+MIIE3jCCA8agAwIBAgICAwEwDQYJKoZIhvcNAQEFBQAwYzELMAkGA1UEBhMCVVMx
+ITAfBgNVBAoTGFRoZSBHbyBEYWRkeSBHcm91cCwgSW5jLjExMC8GA1UECxMoR28g
+RGFkZHkgQ2xhc3MgMiBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eTAeFw0wNjExMTYw
+MTU0MzdaFw0yNjExMTYwMTU0MzdaMIHKMQswCQYDVQQGEwJVUzEQMA4GA1UECBMH
+QXJpem9uYTETMBEGA1UEBxMKU2NvdHRzZGFsZTEaMBgGA1UEChMRR29EYWRkeS5j
+b20sIEluYy4xMzAxBgNVBAsTKmh0dHA6Ly9jZXJ0aWZpY2F0ZXMuZ29kYWRkeS5j
+b20vcmVwb3NpdG9yeTEwMC4GA1UEAxMnR28gRGFkZHkgU2VjdXJlIENlcnRpZmlj
+YXRpb24gQXV0aG9yaXR5MREwDwYDVQQFEwgwNzk2OTI4NzCCASIwDQYJKoZIhvcN
+AQEBBQADggEPADCCAQoCggEBAMQt1RWMnCZM7DI161+4WQFapmGBWTtwY6vj3D3H
+KrjJM9N55DrtPDAjhI6zMBS2sofDPZVUBJ7fmd0LJR4h3mUpfjWoqVTr9vcyOdQm
+VZWt7/v+WIbXnvQAjYwqDL1CBM6nPwT27oDyqu9SoWlm2r4arV3aLGbqGmu75RpR
+SgAvSMeYddi5Kcju+GZtCpyz8/x4fKL4o/K1w/O5epHBp+YlLpyo7RJlbmr2EkRT
+cDCVw5wrWCs9CHRK8r5RsL+H0EwnWGu1NcWdrxcx+AuP7q2BNgWJCJjPOq8lh8BJ
+6qf9Z/dFjpfMFDniNoW1fho3/Rb2cRGadDAW/hOUoz+EDU8CAwEAAaOCATIwggEu
+MB0GA1UdDgQWBBT9rGEyk2xF1uLuhV+auud2mWjM5zAfBgNVHSMEGDAWgBTSxLDS
+kdRMEXGzYcs9of7dqGrU4zASBgNVHRMBAf8ECDAGAQH/AgEAMDMGCCsGAQUFBwEB
+BCcwJTAjBggrBgEFBQcwAYYXaHR0cDovL29jc3AuZ29kYWRkeS5jb20wRgYDVR0f
+BD8wPTA7oDmgN4Y1aHR0cDovL2NlcnRpZmljYXRlcy5nb2RhZGR5LmNvbS9yZXBv
+c2l0b3J5L2dkcm9vdC5jcmwwSwYDVR0gBEQwQjBABgRVHSAAMDgwNgYIKwYBBQUH
+AgEWKmh0dHA6Ly9jZXJ0aWZpY2F0ZXMuZ29kYWRkeS5jb20vcmVwb3NpdG9yeTAO
+BgNVHQ8BAf8EBAMCAQYwDQYJKoZIhvcNAQEFBQADggEBANKGwOy9+aG2Z+5mC6IG
+OgRQjhVyrEp0lVPLN8tESe8HkGsz2ZbwlFalEzAFPIUyIXvJxwqoJKSQ3kbTJSMU
+A2fCENZvD117esyfxVgqwcSeIaha86ykRvOe5GPLL5CkKSkB2XIsKd83ASe8T+5o
+0yGPwLPk9Qnt0hCqU7S+8MxZC9Y7lhyVJEnfzuz9p0iRFEUOOjZv2kWzRaJBydTX
+RE4+uXR21aITVSzGh6O1mawGhId/dQb8vxRMDsxuxN89txJx9OjxUUAiKEngHUuH
+qDTMBqLdElrRhjZkAzVvb3du6/KFUJheqwNTrZEjYx8WnM25sgVjOuH0aBsXBTWV
+U+4=
+-----END CERTIFICATE-----
+-----BEGIN CERTIFICATE-----
+MIIE+zCCBGSgAwIBAgICAQ0wDQYJKoZIhvcNAQEFBQAwgbsxJDAiBgNVBAcTG1Zh
+bGlDZXJ0IFZhbGlkYXRpb24gTmV0d29yazEXMBUGA1UEChMOVmFsaUNlcnQsIElu
+Yy4xNTAzBgNVBAsTLFZhbGlDZXJ0IENsYXNzIDIgUG9saWN5IFZhbGlkYXRpb24g
+QXV0aG9yaXR5MSEwHwYDVQQDExhodHRwOi8vd3d3LnZhbGljZXJ0LmNvbS8xIDAe
+BgkqhkiG9w0BCQEWEWluZm9AdmFsaWNlcnQuY29tMB4XDTA0MDYyOTE3MDYyMFoX
+DTI0MDYyOTE3MDYyMFowYzELMAkGA1UEBhMCVVMxITAfBgNVBAoTGFRoZSBHbyBE
+YWRkeSBHcm91cCwgSW5jLjExMC8GA1UECxMoR28gRGFkZHkgQ2xhc3MgMiBDZXJ0
+aWZpY2F0aW9uIEF1dGhvcml0eTCCASAwDQYJKoZIhvcNAQEBBQADggENADCCAQgC
+ggEBAN6d1+pXGEmhW+vXX0iG6r7d/+TvZxz0ZWizV3GgXne77ZtJ6XCAPVYYYwhv
+2vLM0D9/AlQiVBDYsoHUwHU9S3/Hd8M+eKsaA7Ugay9qK7HFiH7Eux6wwdhFJ2+q
+N1j3hybX2C32qRe3H3I2TqYXP2WYktsqbl2i/ojgC95/5Y0V4evLOtXiEqITLdiO
+r18SPaAIBQi2XKVlOARFmR6jYGB0xUGlcmIbYsUfb18aQr4CUWWoriMYavx4A6lN
+f4DD+qta/KFApMoZFv6yyO9ecw3ud72a9nmYvLEHZ6IVDd2gWMZEewo+YihfukEH
+U1jPEX44dMX4/7VpkI+EdOqXG68CAQOjggHhMIIB3TAdBgNVHQ4EFgQU0sSw0pHU
+TBFxs2HLPaH+3ahq1OMwgdIGA1UdIwSByjCBx6GBwaSBvjCBuzEkMCIGA1UEBxMb
+VmFsaUNlcnQgVmFsaWRhdGlvbiBOZXR3b3JrMRcwFQYDVQQKEw5WYWxpQ2VydCwg
+SW5jLjE1MDMGA1UECxMsVmFsaUNlcnQgQ2xhc3MgMiBQb2xpY3kgVmFsaWRhdGlv
+biBBdXRob3JpdHkxITAfBgNVBAMTGGh0dHA6Ly93d3cudmFsaWNlcnQuY29tLzEg
+MB4GCSqGSIb3DQEJARYRaW5mb0B2YWxpY2VydC5jb22CAQEwDwYDVR0TAQH/BAUw
+AwEB/zAzBggrBgEFBQcBAQQnMCUwIwYIKwYBBQUHMAGGF2h0dHA6Ly9vY3NwLmdv
+ZGFkZHkuY29tMEQGA1UdHwQ9MDswOaA3oDWGM2h0dHA6Ly9jZXJ0aWZpY2F0ZXMu
+Z29kYWRkeS5jb20vcmVwb3NpdG9yeS9yb290LmNybDBLBgNVHSAERDBCMEAGBFUd
+IAAwODA2BggrBgEFBQcCARYqaHR0cDovL2NlcnRpZmljYXRlcy5nb2RhZGR5LmNv
+bS9yZXBvc2l0b3J5MA4GA1UdDwEB/wQEAwIBBjANBgkqhkiG9w0BAQUFAAOBgQC1
+QPmnHfbq/qQaQlpE9xXUhUaJwL6e4+PrxeNYiY+Sn1eocSxI0YGyeR+sBjUZsE4O
+WBsUs5iB0QQeyAfJg594RAoYC5jcdnplDQ1tgMQLARzLrUc+cb53S8wGd9D0Vmsf
+SxOaFIqII6hR8INMqzW/Rn453HWkrugp++85j09VZw==
+-----END CERTIFICATE-----
+-----BEGIN CERTIFICATE-----
+MIIC5zCCAlACAQEwDQYJKoZIhvcNAQEFBQAwgbsxJDAiBgNVBAcTG1ZhbGlDZXJ0
+IFZhbGlkYXRpb24gTmV0d29yazEXMBUGA1UEChMOVmFsaUNlcnQsIEluYy4xNTAz
+BgNVBAsTLFZhbGlDZXJ0IENsYXNzIDIgUG9saWN5IFZhbGlkYXRpb24gQXV0aG9y
+aXR5MSEwHwYDVQQDExhodHRwOi8vd3d3LnZhbGljZXJ0LmNvbS8xIDAeBgkqhkiG
+9w0BCQEWEWluZm9AdmFsaWNlcnQuY29tMB4XDTk5MDYyNjAwMTk1NFoXDTE5MDYy
+NjAwMTk1NFowgbsxJDAiBgNVBAcTG1ZhbGlDZXJ0IFZhbGlkYXRpb24gTmV0d29y
+azEXMBUGA1UEChMOVmFsaUNlcnQsIEluYy4xNTAzBgNVBAsTLFZhbGlDZXJ0IENs
+YXNzIDIgUG9saWN5IFZhbGlkYXRpb24gQXV0aG9yaXR5MSEwHwYDVQQDExhodHRw
+Oi8vd3d3LnZhbGljZXJ0LmNvbS8xIDAeBgkqhkiG9w0BCQEWEWluZm9AdmFsaWNl
+cnQuY29tMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDOOnHK5avIWZJV16vY
+dA757tn2VUdZZUcOBVXc65g2PFxTXdMwzzjsvUGJ7SVCCSRrCl6zfN1SLUzm1NZ9
+WlmpZdRJEy0kTRxQb7XBhVQ7/nHk01xC+YDgkRoKWzk2Z/M/VXwbP7RfZHM047QS
+v4dk+NoS/zcnwbNDu+97bi5p9wIDAQABMA0GCSqGSIb3DQEBBQUAA4GBADt/UG9v
+UJSZSWI4OB9L+KXIPqeCgfYrx+jFzug6EILLGACOTb2oWH+heQC1u+mNr0HZDzTu
+IYEZoDJJKPTEjlbVUjP9UNV+mWwD5MlM/Mtsq2azSiGM5bUMMj4QssxsodyamEwC
+W/POuZ6lcg5Ktz885hZo+L7tdEy8W9ViH0Pd
+-----END CERTIFICATE-----

data/lib/jruby/lint/libraries.rb

@@ -0,0 +1,107 @@
+require 'net/https'
+require 'nokogiri'
+require 'tempfile'
+require 'fileutils'
+
+module JRuby::Lint
+  class Libraries
+    class Cache
+      def initialize(cache_dir = nil)
+        @cache_dir = cache_dir || ENV['JRUBY_LINT_CACHE'] ||
+          (defined?(Gem.user_dir) && File.join(Gem.user_dir, 'lint')) || Dir::tmpdir
+        FileUtils.mkdir_p(@cache_dir) unless File.directory?(@cache_dir)
+      end
+
+      def fetch(name)
+        filename = filename_for(name)
+        if File.file?(filename) && !stale?(filename)
+          File.read(filename)
+        else
+          read_from_wiki(name, filename)
+        end
+      end
+
+      def store(name, content)
+        File.open(filename_for(name), "w") {|f| f << content }
+      end
+
+      def filename_for(name)
+        name = File.basename(name)
+        File.join(@cache_dir, File.extname(name).empty? ? "#{name}.html" : name)
+      end
+
+      def stale?(filename)
+        File.mtime(filename) < Time.now - 24 * 60 * 60
+      end
+
+      def read_from_wiki(name, filename)
+        content = nil
+        uri = Net::HTTP.start('wiki.jruby.org', 80) do |http|
+          URI.parse http.head(name =~ %r{^/} ? name : "/#{name}")['Location']
+        end
+        if uri.host == "github.com"
+          Net::HTTP.new(uri.host, uri.port).tap do |http|
+            if uri.scheme == "https"
+              http.use_ssl = true
+              http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+              # gd_bundle.crt from https://certs.godaddy.com/anonymous/repository.seam
+              http.ca_file = File.expand_path('../github.crt', __FILE__)
+            end
+            http.start do
+              response = http.get(uri.path)
+              content = response.body
+              File.open(filename, "w") do |f|
+                f << content
+              end
+            end
+          end
+        end
+        raise "Unknown location '#{uri}' for page '#{name}'" unless content
+        content
+      rescue => e
+        raise "Error while reading from wiki: #{e.message}\nPlease try again later."
+      end
+    end
+
+    class CExtensions
+      attr_reader :gems
+
+      def initialize(cache)
+        @cache = cache
+      end
+
+      def load
+        @gems = {}
+        content = @cache.fetch('C-Extension-Alternatives')
+        doc = Nokogiri::HTML(content)
+        doc.css('#wiki-body ul li').each do |li|
+          key, message = li.text.split(/[ -]+/, 2)
+          @gems[key.downcase] = message
+        end
+      rescue => e
+        @error = "Unable to load C Extension alternatives list: #{e.message}"
+      end
+    end
+
+    SOURCES = [CExtensions]
+
+    attr_reader :gems
+
+    def initialize(cache)
+      @sources = SOURCES.map {|s| s.new(cache) }
+    end
+
+    def load
+      @gems = {}.tap do |gems|
+        @sources.each do |s|
+          s.load
+          gems.update(s.gems)
+        end
+      end
+    end
+
+    def gems
+      @gems ||= load
+    end
+  end
+end

data/lib/jruby/lint/project.rb

@@ -0,0 +1,56 @@
+require 'set'
+require 'ostruct'
+
+module JRuby::Lint
+  class Project
+    DEFAULT_TAGS = %w(error warning info)
+
+    attr_reader :collectors, :reporters, :findings, :files, :tags, :libraries
+
+    def initialize(options = OpenStruct.new)
+      @tags = DEFAULT_TAGS
+      @collectors = []
+      @files = Set.new
+
+      if options.eval
+        options.eval.each {|e| @collectors << JRuby::Lint::Collectors::Ruby.new(self, '-e', e) }
+        @files += @collectors
+      end
+
+      @sources = options.files || (options.eval ? [] : Dir['./**/*'])
+      load_collectors
+      load_reporters
+      load_libraries
+    end
+
+    def run
+      @findings = []
+      collectors.each do |c|
+        c.run
+        reporters.each {|r| r.report(c.findings)}
+        @findings += c.findings
+      end
+    end
+
+    private
+    def load_collectors
+      @sources.each do |f|
+        next unless File.file?(f)
+        Collector.all.each do |c|
+          if c.detect?(f)
+            @collectors << c.new(self, f)
+            @files << f
+          end
+        end
+      end
+    end
+
+    def load_reporters
+      @reporters = [(STDOUT.tty? ? Reporters::ANSIColor : Reporters::Text).new(self, STDOUT)]
+    end
+
+    def load_libraries
+      @libraries = Libraries.new(Libraries::Cache.new)
+    end
+  end
+end