gem_lint 0.0.3 → 0.0.4

data/CHANGELOG

@@ -1,3 +1,8 @@
+v0.0.4 (21st December 2010)
+* change output format to be easily machine parsable
+* ruby 1.9.2 compat
+* various new checks
+
 v0.0.3 (10th December 2010)
 * use pure ruby to unpack gems
 

data/lib/gem_lint.rb

@@ -18,7 +18,7 @@ module GemLint
   #
   def self.strategies
     GemLint::Strategies.constants.sort.select { |class_name|
-      class_name != "AbstractStrategy"
+      class_name.to_s != "AbstractStrategy"
     }.map { |class_name|
       GemLint::Strategies.const_get(class_name)
     }

data/lib/gem_lint/runner.rb

@@ -3,8 +3,8 @@
 module GemLint
   class Runner
 
-    attr_reader :tags, :tags_with_desc, :tags_with_level
-    attr_reader :email, :name, :version
+    attr_reader :tags
+    attr_reader :email, :name, :platform, :version
 
     def initialize(filename)
       raise ArgumentError, "'#{filename}' does not exist" unless File.file?(filename.to_s)
@@ -13,19 +13,39 @@ module GemLint
       init_vars
     end
 
+    def to_s(type = :simple)
+      if type == :simple
+        @tags.map { |t| "- #{t}"}.join("\n")
+      else
+        lines.join("\n")
+      end
+    end
+
     private
 
     def init_vars
       unpack_gem
-      @tags    = collect_tags
-      @tags_with_level = collect_tags_with_level
-      @tags_with_desc  = collect_tags_with_desc
-      @email   = spec ? spec.email : nil
-      @name    = spec ? spec.name : nil
-      @version = spec ? spec.version.to_s : nil
+      @tags     = collect_tags
+      @email    = spec ? spec.email : nil
+      @name     = spec ? spec.name : nil
+      @version  = spec ? spec.version.to_s : nil
+      @platform = spec ? spec.platform.to_s : nil
+      lines
       cleanup
     end
 
+    def lines
+      if unpack_successful?
+        @lines ||= failed_strategies.map { |s|
+          [s.level_char, self.name, self.version, self.platform, s.tag, s.description].join(": ")
+        }.sort
+      else
+        @lines ||= [
+          ["E", self.name, self.version, self.platform, "unpack-failed", "There was an error unpacking the gem file"].join(": ")
+        ]
+      end
+    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.
@@ -40,28 +60,6 @@ module GemLint
       end
     end
 
-    def collect_tags_with_desc
-      if unpack_successful?
-        failed_strategies.map { |s|
-          ["#{s.level_char}: #{s.tag}", s.description]
-        }.sort_by { |arr|
-          arr.first
-        }
-      else
-        ["E: unpack-failed", "There was an error unpacking the gem file"]
-      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|
@@ -83,7 +81,7 @@ module GemLint
     end
 
     def unpack_successful?
-      File.directory?(data_path) && File.file?(metadata_file)
+      File.directory?(data_path) && File.file?(metadata_file) && File.size(metadata_file) > 0
     end
 
     def data_path
@@ -107,11 +105,15 @@ module GemLint
     end
 
     def unpack_path
-      @unpack_path ||= File.join(Dir.tmpdir, rand(100000).to_s)
+      return @unpack_path if @unpack_path
+      while @unpack_path.nil? || File.directory?(@unpack_path)
+        @unpack_path = File.join(Dir.tmpdir, rand(100000).to_s)
+      end
+      Dir.mkdir(@unpack_path)
+      @unpack_path
     end
 
     def unpack_gem
-      Dir.mkdir(unpack_path)
       Dir.mkdir(data_path)
 
       format = Gem::Format.from_file_by_path(@filename)
@@ -119,12 +121,14 @@ module GemLint
       format.file_entries.each do |entry, file_data|
         path = entry['path']
         path = File.expand_path File.join(data_path, path)
-        raise "Can't install files there" unless path[0, data_path.size] == data_path
+        return false unless path[0, data_path.size] == data_path
         FileUtils.mkdir_p File.dirname(path)
         File.open(path, "wb") { |out| out.write file_data }
       end
 
       true
+    rescue
+      false
     end
 
     def cleanup

data/lib/gem_lint/strategies/csv_authors_strategy.rb

@@ -16,7 +16,7 @@ module GemLint
 
       def fail?
         yaml.authors.is_a?(Array) &&
-          (yaml.authors.first.include?(",") || yaml.authors.first.include?(";"))
+          (yaml.authors.first.to_s.include?(",") || yaml.authors.first.to_s.include?(";"))
       end
 
       private

data/lib/gem_lint/strategies/csv_email_strategy.rb

@@ -16,7 +16,7 @@ module GemLint
 
       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?(";")))
+          (yaml.email.is_a?(Array) && (yaml.email.first.to_s.include?(",") || yaml.email.first.to_s.include?(";")))
       end
 
       private

data/lib/gem_lint/strategies/empty_authors_strategy.rb

@@ -0,0 +1,29 @@
+module GemLint
+  module Strategies
+    class EmptyAuthorsStrategy < AbstractStrategy
+
+      def description
+        "Authors field is empty"
+      end
+
+      def tag
+        :"empty-authors"
+      end
+
+      def level
+        :warning
+      end
+
+      def fail?
+        yaml.authors.is_a?(Array) && yaml.authors.empty?
+      end
+
+      private
+
+      def yaml
+        @yaml ||= YAML.load(File.read(@metadata_path))
+      end
+
+    end
+  end
+end

data/lib/gem_lint/strategies/empty_email_strategy.rb

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

data/lib/gem_lint/strategies/no_files_strategy.rb

@@ -0,0 +1,29 @@
+module GemLint
+  module Strategies
+    class NoFilesStrategy < AbstractStrategy
+
+      def description
+        "Gem containts no files"
+      end
+
+      def tag
+        :"no-files"
+      end
+
+      def level
+        :warning
+      end
+
+      def fail?
+        yaml.files.empty?
+      end
+
+      private
+
+      def yaml
+        @yaml ||= YAML.load(File.read(@metadata_path))
+      end
+
+    end
+  end
+end

data/lib/gem_lint/strategies/require_matches_gemname_strategy.rb

@@ -5,7 +5,7 @@ module GemLint
     class RequireMatchesGemnameStrategy < AbstractStrategy
 
       def description
-        "Gem cannot be loaded by require '#{preferred_basename}'"
+        "Gem cannot be loaded by require '#{preferred_basename.gsub(/^lib\//,'')}'"
       end
 
       def tag

data/lib/rubygems/commands/lint_command.rb

@@ -28,7 +28,7 @@ class Gem::Commands::LintCommand < Gem::Command
     if options[:detailed]
       detailed_output(runner)
     else
-      short_output(runner)
+      simple_output(runner)
     end
   end
 
@@ -39,23 +39,18 @@ class Gem::Commands::LintCommand < Gem::Command
       puts "No test failures!"
       puts
     else
-      runner.tags_with_desc.each do |tag, desc|
-        puts "- #{tag}"
-        puts "  #{desc}"
-      end
+      puts runner.to_s(:detailed)
       puts
       exit 1
     end
   end
 
-  def short_output(runner)
+  def simple_output(runner)
     if runner.tags.empty?
       puts "No test failures!"
       puts
     else
-      runner.tags_with_level.each do |tag|
-        puts "- #{tag}"
-      end
+      puts runner.to_s(:simple)
       puts
       exit 1
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gem_lint
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - James Healy
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-10 00:00:00 +11:00
+date: 2010-12-21 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,7 +33,7 @@ dependencies:
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rcov
+  name: roodi
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -46,24 +46,10 @@ dependencies:
         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 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -74,7 +60,7 @@ dependencies:
         - 0
         version: "2.0"
   type: :development
-  version_requirements: *id004
+  version_requirements: *id003
 description: Adds a 'lint' command rubygems that will print a list of possible errors in a gem
 email: 
 - james@yob.id.au
@@ -93,12 +79,15 @@ files:
 - 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/empty_authors_strategy.rb
 - lib/gem_lint/strategies/duplicate_authors_strategy.rb
+- lib/gem_lint/strategies/empty_email_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/no_files_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