gem_lint 0.0.1

data/CHANGELOG

@@ -0,0 +1,2 @@
+v0.0.1 (29th November 2010)
+* initial release

data/README.rdoc

@@ -0,0 +1,56 @@
+= GemLint
+
+Sanity check your rubygems for common issues. Missing readmes, bundled pkg
+directories, encoding issues in the gemspec, etc.
+
+Each test is classified as an error or warning. Errors are issues that (by my
+reading) violate the documented gem specs. Warnings are either best practices
+recommended by members of the community or arbitrary things that annoy me
+personally.
+
+== Usage
+
+  gem install gem-lint
+  gem lint somefile-0.0.1.gem
+
+=== API
+
+To check a gem programmatically:
+
+  require "gem_lint"
+
+  runner = GemLint::Runner.new("widgets-1.0.gem")
+  puts runner.name
+  puts runner.version
+  puts runner.email
+  puts runner.tags
+
+== Status
+
+This a spike. It has few tests and is a proof of concept. Most of it was written at
+a Railscamp and therefore is probably of suspect quality.
+
+== Compatability
+
+Rubygems 1.3.2 or greater is required, otherwise it's pure ruby should run on most
+ruby VMs.
+
+== Developing
+
+To add new checks, create a new strategy in lib/gem_lint/strategies with a matching
+spec in spec/strategies.
+
+View other strategies for an idea of the required contract. There are existing
+specs to ensure all strategies confirm to the contract, so keep the full spec
+suit (using "rake") green.
+
+Full source is on github at https://github.com/yob/gem-lint
+
+== Ideas
+
+* command for users to display extra info on a tag a gem failed
+
+== Further Reading
+
+* http://chneukirchen.github.com/rps/
+* http://blog.segment7.net/articles/2010/11/15/how-to-name-gems

data/lib/gem_lint/runner.rb

@@ -0,0 +1,123 @@
+# coding: utf-8
+
+module GemLint
+  class Runner
+
+    attr_reader :tags, :tags_with_level, :email, :name, :version
+
+    def initialize(filename)
+      raise ArgumentError, "'#{filename}' does not exist" unless File.file?(filename.to_s)
+
+      @filename = filename
+      init_vars
+    end
+
+    private
+
+    def init_vars
+      unpack_gem
+      @tags    = collect_tags
+      @tags_with_level = collect_tags_with_level
+      @email   = spec ? spec.email : nil
+      @name    = spec ? spec.name : nil
+      @version = spec ? spec.version.to_s : nil
+      cleanup
+    end
+
+    # returns an array of symbols, each one indicating a test the provided gem
+    # failed. Unpacks the gem to a temporary location and cleans up after
+    # itself.
+    #
+    def collect_tags
+      if unpack_successful?
+        failed_strategies.map { |s|
+          s.tag
+        }
+      else
+        ["unpack-failed"]
+      end
+    end
+
+    def collect_tags_with_level
+      if unpack_successful?
+        failed_strategies.map { |s|
+          "#{s.level_char}: #{s.tag}"
+        }.sort
+      else
+        ["E: unpack-failed"]
+      end
+    end
+
+    def failed_strategies
+      if unpack_successful?
+        @failed_strategies ||= GemLint.strategies.map { |s|
+          s.new(visitor_args)
+        }.select { |s|
+          s.fail?
+        }
+      else
+        @failed_strategies ||= []
+      end
+    end
+
+    def visitor_args
+      @visitor_args ||= {
+        :filename      => @filename,
+        :data_path     => data_path,
+        :metadata_path => metadata_file
+      }
+    end
+
+    def unpack_successful?
+      File.directory?(data_path) && File.file?(metadata_file)
+    end
+
+    def data_path
+      @data_path ||= File.join(unpack_path, "data")
+    end
+
+    def data_file
+      @data_file ||= File.join(unpack_path, "data.tar.gz")
+    end
+
+    def metadata_gz_file
+      @metadata_gz_file ||= File.join(unpack_path, "metadata.gz")
+    end
+
+    def metadata_file
+      @metadata_file ||= File.join(unpack_path, "metadata")
+    end
+
+    def spec
+      if @spec || File.file?(metadata_file)
+        @spec ||= YAML.load_file(metadata_file)
+      else
+        nil
+      end
+    end
+
+    def unpack_path
+      @unpack_path ||= File.join(Dir.tmpdir, rand(100000).to_s)
+    end
+
+    # TODO: update this to use native ruby untar
+    def unpack_gem
+      Dir.mkdir(unpack_path)
+      Dir.mkdir(data_path)
+
+      `tar -xkC #{unpack_path} -f #{@filename} > /dev/null 2>&1`
+      `tar -xzkC #{data_path} -f #{data_file} > /dev/null 2>&1`
+      `gunzip #{metadata_file} > /dev/null 2>&1`
+
+      FileUtils.remove_entry_secure(data_file) if File.file?(data_file)
+
+      true
+    end
+
+    def cleanup
+      return unless File.directory?(unpack_path)
+
+      FileUtils.remove_entry_secure(unpack_path)
+    end
+  end
+end

data/lib/gem_lint/strategies/abstract_strategy.rb

@@ -0,0 +1,40 @@
+# coding: utf-8
+
+module GemLint
+  module Strategies
+    class AbstractStrategy
+      attr_reader :filename, :path, :metadata_path
+
+      def initialize(args = {})
+        @filename = args[:filename]
+        @path     = args[:data_path]
+        @metadata_path = args[:metadata_path]
+
+        raise ArgumentError, "#{@path} is not a directory" unless File.directory?(@path)
+        raise ArgumentError, "#{@metadata_path} is not a file" unless File.file?(@metadata_path)
+        raise ArgumentError, ":filename must be a filename ending in gem" unless @filename.to_s[-4,4] == ".gem"
+      end
+
+      def level_char
+        self.level.to_s[0,1].upcase
+      end
+
+      def description
+        raise "this should be implemented by concrete subclasses"
+      end
+
+      def fail?
+        raise "this should be implemented by concrete subclasses"
+      end
+
+      def level
+        raise "this should be implemented by concrete subclasses"
+      end
+
+      def tag
+        raise "this should be implemented by concrete subclasses"
+      end
+
+    end
+  end
+end

data/lib/gem_lint/strategies/bin_ends_with_rb_strategy.rb

@@ -0,0 +1,39 @@
+module GemLint
+  module Strategies
+    class BinEndsWithRbStrategy < AbstractStrategy
+
+      def description
+        "A file in bin/ ends in .rb"
+      end
+
+      def tag
+        :"bin-ends-with-rb"
+      end
+
+      def level
+        :warning
+      end
+
+      def fail?
+        bin_files.any? { |path| path[-3,3] == ".rb" }
+      end
+
+      private
+
+      def bin_files
+        all_files.select { |path|
+          path[0,4] == "bin/" && File.file?(self.path + "/" + path)
+        }
+      end
+
+      def all_files
+        paths = []
+        Find.find(self.path) { |path| paths << path }
+        paths.map { |path|
+          path.gsub(self.path + "/","")
+        }
+      end
+
+    end
+  end
+end

data/lib/gem_lint/strategies/bin_without_shebang_strategy.rb

@@ -0,0 +1,43 @@
+module GemLint
+  module Strategies
+    class BinWithoutShebangStrategy < AbstractStrategy
+
+      def description
+        "A file in bin/ doesn't have a shebang on the first line"
+      end
+
+      def tag
+        :"bin-without-shebang"
+      end
+
+      def level
+        :warning
+      end
+
+      def fail?
+        bin_files.any? { |path|
+          data = File.open(self.path + "/" + path) { |f| f.read }
+          first_line = data.split("\n")[0]
+          !first_line.to_s.include?("env ruby")
+        }
+      end
+
+      private
+
+      def bin_files
+        all_files.select { |path| 
+          path[0,4] == "bin/" && File.file?(self.path + "/" + path)
+        }
+      end
+
+      def all_files
+        paths = []
+        Find.find(self.path) { |path| paths << path }
+        paths.map { |path|
+          path.gsub(self.path + "/","")
+        }
+      end
+
+    end
+  end
+end

data/lib/gem_lint/strategies/capitals_in_name_strategy.rb

@@ -0,0 +1,32 @@
+require 'find'
+
+module GemLint
+  module Strategies
+    class CapitalsInNameStrategy < AbstractStrategy
+
+      def description
+        "It's strongly recommended that your gem name be all lower case"
+      end
+
+      def tag
+        :"capitals-in-name"
+      end
+
+      def level
+        :warning
+      end
+
+      def fail?
+        spec.name.match(/[A-Z]/)
+      end
+
+      private
+
+      def spec
+        @spec ||= YAML.load(File.read(@metadata_path))
+      end
+
+    end
+  end
+end
+

data/lib/gem_lint/strategies/changelog_strategy.rb

@@ -0,0 +1,32 @@
+module GemLint
+  module Strategies
+    class ChangelogStrategy < AbstractStrategy
+
+      def description
+        "Gem contains no changelog or history file"
+      end
+
+      def tag
+        :"no-changelog-or-history"
+      end
+
+      def level
+        :warning
+      end
+
+      def fail?
+        root_files.none? do |filename|
+          dfile = filename.downcase
+          dfile.include?("changelog") || dfile.include?("history")
+        end
+      end
+
+      private
+
+      def root_files
+        Dir.entries(self.path)
+      end
+
+    end
+  end
+end

data/lib/gem_lint/strategies/contains_gem_file_strategy.rb

@@ -0,0 +1,31 @@
+module GemLint
+  module Strategies
+    class ContainsGemFileStrategy < AbstractStrategy
+
+      def description
+        "Gem contains at least 1 other gem file"
+      end
+
+      def tag
+        :"contains-gem-file"
+      end
+
+      def level
+        :warning
+      end
+
+      def fail?
+        spec.files.any? { |filename|
+          filename.match(/\A.*\.gem\Z/)
+        }
+      end
+
+      private
+
+      def spec
+        @spec ||= YAML.load(File.read(@metadata_path))
+      end
+
+    end
+  end
+end

data/lib/gem_lint/strategies/csv_authors_strategy.rb

@@ -0,0 +1,30 @@
+module GemLint
+  module Strategies
+    class CsvAuthorsStrategy < AbstractStrategy
+
+      def description
+        "Authors field in spec uses a comma or semicolon to specify multiple authors instead of an array"
+      end
+
+      def tag
+        :"csv-authors"
+      end
+
+      def level
+        :error
+      end
+
+      def fail?
+        yaml.authors.is_a?(Array) &&
+          (yaml.authors.first.include?(",") || yaml.authors.first.include?(";"))
+      end
+
+      private
+
+      def yaml
+        @yaml ||= YAML.load(File.read(@metadata_path))
+      end
+
+    end
+  end
+end

data/lib/gem_lint/strategies/csv_email_strategy.rb

@@ -0,0 +1,30 @@
+module GemLint
+  module Strategies
+    class CsvEmailStrategy < AbstractStrategy
+
+      def description
+        "Email field in spec uses CSV to specify multiple emails instead of an array"
+      end
+
+      def tag
+        :"csv-email"
+      end
+
+      def level
+        :error
+      end
+
+      def fail?
+        (yaml.email.is_a?(String) && (yaml.email.include?(",") || yaml.email.include?(";"))) ||
+          (yaml.email.is_a?(Array) && (yaml.email.first.include?(",") || yaml.email.first.include?(";")))
+      end
+
+      private
+
+      def yaml
+        @yaml ||= YAML.load(File.read(@metadata_path))
+      end
+
+    end
+  end
+end

data/lib/gem_lint/strategies/duplicate_authors_strategy.rb

@@ -0,0 +1,29 @@
+module GemLint
+  module Strategies
+    class DuplicateAuthorsStrategy < AbstractStrategy
+
+      def description
+        "Authors field in spec should have no duplicate values"
+      end
+
+      def tag
+        :"duplicate-authors"
+      end
+
+      def level
+        :warning
+      end
+
+      def fail?
+        yaml.authors.is_a?(Array) && yaml.authors.uniq.size != yaml.authors.size
+      end
+
+      private
+
+      def yaml
+        @yaml ||= YAML.load(File.read(@metadata_path))
+      end
+
+    end
+  end
+end

data/lib/gem_lint/strategies/duplicate_email_strategy.rb

@@ -0,0 +1,29 @@
+module GemLint
+  module Strategies
+    class DuplicateEmailStrategy < AbstractStrategy
+
+      def description
+        "Email field in spec should have no duplicate values"
+      end
+
+      def tag
+        :"csv-email"
+      end
+
+      def level
+        :warning
+      end
+
+      def fail?
+        yaml.email.is_a?(Array) && yaml.email.uniq.size != yaml.email.size
+      end
+
+      private
+
+      def yaml
+        @yaml ||= YAML.load(File.read(@metadata_path))
+      end
+
+    end
+  end
+end

data/lib/gem_lint/strategies/pkg_dir_strategy.rb

@@ -0,0 +1,31 @@
+module GemLint
+  module Strategies
+    class PkgDirStrategy < AbstractStrategy
+
+      def description
+        "Gem contains a directory in the root called pkg"
+      end
+
+      def tag
+        :"pkg-dir"
+      end
+
+      def level
+        :warning
+      end
+
+      def fail?
+        root_files.any? { |filename|
+          filename.match(/pkg.*/)
+        }
+      end
+
+      private
+
+      def root_files
+        Dir.entries(self.path)
+      end
+
+    end
+  end
+end

data/lib/gem_lint/strategies/readme_strategy.rb

@@ -0,0 +1,31 @@
+module GemLint
+  module Strategies
+    class ReadmeStrategy < AbstractStrategy
+
+      def description
+        "Gem contains no readme file"
+      end
+
+      def tag
+        :"no-readme"
+      end
+
+      def level
+        :warning
+      end
+
+      def fail?
+        root_files.none? do |filename|
+          filename.downcase.include?("readme")
+        end
+      end
+
+      private
+
+      def root_files
+        Dir.entries(self.path)
+      end
+
+    end
+  end
+end

data/lib/gem_lint/strategies/require_matches_gemname_strategy.rb

@@ -0,0 +1,42 @@
+require 'find'
+
+module GemLint
+  module Strategies
+    class RequireMatchesGemnameStrategy < AbstractStrategy
+
+      def description
+        "Gem cannot be loaded by require '#{preferred_basename}'"
+      end
+
+      def tag
+        :"require-doesnt-match-gemname"
+      end
+
+      def level
+        :warning
+      end
+
+      # TODO: does thi need to be beefed up to recognise extensions
+      #
+      def fail?
+        !spec.files.include?(preferred_filename)
+      end
+
+      private
+
+      def preferred_basename
+        "lib/" + spec.name.tr("-","/")
+      end
+
+      def preferred_filename
+        preferred_basename + ".rb"
+      end
+
+      def spec
+        @spec ||= YAML.load(File.read(@metadata_path))
+      end
+
+    end
+  end
+end
+

data/lib/gem_lint/strategies/ruby_file_location_strategy.rb

@@ -0,0 +1,38 @@
+require 'find'
+
+module GemLint
+  module Strategies
+    class RubyFileLocationStrategy < AbstractStrategy
+
+      def description
+        "Gem contains ruby files outside of lib, test and spec"
+      end
+
+      def tag
+        :"ruby-files-outside-lib-test-spec"
+      end
+
+      def level
+        :warning
+      end
+
+      def fail?
+        all_files.any? do |filename|
+          filename[0,3] != "lib" && filename[0,4] != "spec" &&
+            filename[0,4] != "test" && filename[-3,3] == ".rb"
+        end
+      end
+
+      private
+
+      def all_files
+        paths = []
+        Find.find(self.path) { |path| paths << path }
+        paths.map { |path|
+          path.gsub(self.path + "/","")
+        }
+      end
+
+    end
+  end
+end

data/lib/gem_lint/strategies/string_email_strategy.rb

@@ -0,0 +1,29 @@
+module GemLint
+  module Strategies
+    class StringEmailStrategy < AbstractStrategy
+
+      def description
+        "Email field in spec is a String instead of an Array"
+      end
+
+      def tag
+        :"string-email"
+      end
+
+      def level
+        :error
+      end
+
+      def fail?
+        yaml.email.is_a?(String)
+      end
+
+      private
+
+      def yaml
+        @yaml ||= YAML.load(File.read(@metadata_path))
+      end
+
+    end
+  end
+end

data/lib/gem_lint/strategies/test_files_in_files_attribute_strategy.rb

@@ -0,0 +1,37 @@
+require 'find'
+
+module GemLint
+  module Strategies
+    class TestFilesInFilesAttributeStrategy < AbstractStrategy
+
+      def description
+        "Gem metadata includes test files in files attribute. Use test_files instead"
+      end
+
+      def tag
+        :"test-files-in-files-attribute"
+      end
+
+      def level
+        :warning
+      end
+
+      def fail?
+        orig_files.any? { |filename|
+          filename[-8,8] == "_spec.rb" || filename[-8,8] == "_test.rb"
+        }
+      end
+
+      private
+
+      def orig_files
+        @orig_files ||= yaml.files - yaml.test_files
+      end
+
+      def yaml
+        @yaml ||= YAML.load(File.read(@metadata_path))
+      end
+
+    end
+  end
+end

data/lib/gem_lint/strategies/utf8_metadata_strategy.rb

@@ -0,0 +1,26 @@
+module GemLint
+  module Strategies
+    class Utf8MetadataStrategy < AbstractStrategy
+
+      def description
+        "Ensure the gem metadata is all utf8 encoded"
+      end
+
+      def tag
+        :"utf8-metadata"
+      end
+
+      def level
+        :error
+      end
+
+      def fail?
+        File.read(@metadata_path).unpack("U*")
+        false
+      rescue
+        true
+      end
+
+    end
+  end
+end

data/lib/gem_lint.rb

@@ -0,0 +1,25 @@
+# coding: utf-8
+
+# stdlib
+require 'tmpdir'
+require 'fileutils'
+
+# our own code
+require 'gem_lint/runner'
+
+# dynamically load all available strategies
+strategies_path = File.dirname(__FILE__) + "/gem_lint/strategies/**/*.rb"
+Dir[strategies_path].sort.each {|f| require f }
+
+module GemLint
+
+  # return an array of all strategy classes
+  #
+  def self.strategies
+    GemLint::Strategies.constants.sort.select { |class_name|
+      class_name != "AbstractStrategy"
+    }.map { |class_name|
+      GemLint::Strategies.const_get(class_name)
+    }
+  end
+end

data/lib/rubygems/commands/lint_command.rb

@@ -0,0 +1,35 @@
+require 'rubygems/command'
+require 'gem_lint'
+
+class Gem::Commands::LintCommand < Gem::Command
+  def description # :nodoc:
+    'Check a gem file for common mistakes and errors'
+  end
+
+  def arguments # :nodoc:
+    "GEM       built gem to check"
+  end
+
+  def usage # :nodoc:
+    "#{program_name} GEM"
+  end
+
+  def initialize
+    super 'lint', description
+  end
+
+  def execute
+    runner = GemLint::Runner.new(get_one_gem_name)
+    if runner.tags.empty?
+      puts "No test failures!"
+      puts
+    else
+      runner.tags_with_level.each do |tag|
+        puts "- #{tag}"
+      end
+      puts
+      exit 1
+    end
+  end
+
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,3 @@
+require 'rubygems/command_manager'
+
+Gem::CommandManager.instance.register_command :lint

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification 
+name: gem_lint
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- James Healy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-29 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: roodi
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :development
+  version_requirements: *id004
+description: Adds a 'lint' command rubygems that will pront a list of possible errors in a gem
+email: 
+- james@yob.id.au
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/gem_lint.rb
+- lib/rubygems_plugin.rb
+- lib/rubygems/commands/lint_command.rb
+- lib/gem_lint/runner.rb
+- lib/gem_lint/strategies/require_matches_gemname_strategy.rb
+- lib/gem_lint/strategies/utf8_metadata_strategy.rb
+- lib/gem_lint/strategies/readme_strategy.rb
+- lib/gem_lint/strategies/changelog_strategy.rb
+- lib/gem_lint/strategies/duplicate_authors_strategy.rb
+- lib/gem_lint/strategies/bin_ends_with_rb_strategy.rb
+- lib/gem_lint/strategies/bin_without_shebang_strategy.rb
+- lib/gem_lint/strategies/csv_email_strategy.rb
+- lib/gem_lint/strategies/abstract_strategy.rb
+- lib/gem_lint/strategies/pkg_dir_strategy.rb
+- lib/gem_lint/strategies/capitals_in_name_strategy.rb
+- lib/gem_lint/strategies/test_files_in_files_attribute_strategy.rb
+- lib/gem_lint/strategies/string_email_strategy.rb
+- lib/gem_lint/strategies/contains_gem_file_strategy.rb
+- lib/gem_lint/strategies/ruby_file_location_strategy.rb
+- lib/gem_lint/strategies/duplicate_email_strategy.rb
+- lib/gem_lint/strategies/csv_authors_strategy.rb
+- README.rdoc
+- CHANGELOG
+has_rdoc: true
+homepage: http://github.com/yob/gem-lint
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --title
+- Gem Lint
+- --line-numbers
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 31
+      segments: 
+      - 1
+      - 3
+      - 2
+      version: 1.3.2
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Check rubygem files for common mistakes and errors
+test_files: []
+