gemfilelint 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08f43710d45876141d5a462ef860d5d52f3b782af673be0f8cf5bde39ea269bc'
-  data.tar.gz: a81951955e4d2a60b4771ebc45f7adbd9a6150f14de2f34f162497ef7fbb2d00
+  metadata.gz: ed679ee045c3d39a031c54a7bc7b17a5912920975a46fbf4d8919a99c6216008
+  data.tar.gz: cdfd4a5b93dc1c6c2eee7917b11f3000e82f5604223cde31c067b5b433a33729
 SHA512:
-  metadata.gz: fb7f7ebdd672f505a5a1dbb91cc36dfc2ddafabfa470101931b05253f51a3e33df82175a5f0c06789d93455aefdce3cff1cbc839178b0a27f2c9c83354442237
-  data.tar.gz: 6aac9050ccf83d666dc9f640e0f0bc95fbd56ecec061d90f7da8ef2b8ae958406ec41b4e7bcc3de3df787046e68c596750225895fd86f96dc7ae181ca37c6578
+  metadata.gz: be1de4b80eee06591d4bd0b85faf0ed50208f5d7f8de04f8dc7a95a339202629ce0bd5b0c81bee750581025bcdbabab1768afc307ac036c8e30c06f04ee2a433
+  data.tar.gz: 694bf077b0ef17a588bccb615ddce0ce865d6e1131fe01d20589a7098748d41c4fe170b22b83b532b2f3fce453b7eeefc535330c2468f8398c1f4eca8337924d

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.2.0] - 2020-02-20
+
+### Added
+
+- Allow linting multiple Gemfile paths in one command.
+
+## [0.1.0] - 2020-02-20
+
+### Added
+
+- 🎉 Initial release.
+
+[unreleased]: https://github.com/kddeisz/gemfilelint/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/kddeisz/gemfilelint/compare/935da5...v0.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gemfilelint (0.1.0)
+    gemfilelint (0.2.0)
       bundler
 
 GEM

data/exe/gemfilelint

@@ -4,4 +4,12 @@
 $LOAD_PATH.unshift(File.expand_path(File.join('..', 'lib'), __dir__))
 require 'gemfilelint'
 
-exit Gemfilelint.lint(ARGV[0] || 'Gemfile')
+gemfiles = ARGV.any? ? ARGV : './Gemfile'
+
+invalid = gemfiles.reject { |gemfile| File.file?(gemfile) }
+if invalid.any?
+  warn("Could not find a gemfile at: #{invalid.join(', ')}")
+  exit 2
+end
+
+exit Gemfilelint.lint(*gemfiles) ? 0 : 1

data/lib/gemfilelint.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'delegate'
 require 'logger'
 
 require 'bundler'
@@ -8,8 +9,23 @@ require 'bundler/similarity_detector'
 require 'gemfilelint/version'
 
 module Gemfilelint
+  class SpellChecker
+    attr_reader :detector, :haystack
+
+    def initialize(haystack)
+      @detector = Bundler::SimilarityDetector.new(haystack)
+      @haystack = haystack
+    end
+
+    def correct(needle)
+      return [] if haystack.include?(needle)
+
+      detector.similar_words(needle)
+    end
+  end
+
   module Offenses
-    class Dependency < Struct.new(:name, :suggestions)
+    class Dependency < Struct.new(:path, :name, :suggestions)
       def to_s
         <<~ERR
           Gem \"#{name}\" is possibly misspelled, suggestions:
@@ -18,7 +34,13 @@ module Gemfilelint
       end
     end
 
-    class Remote < Struct.new(:name, :suggestions)
+    class InvalidGemfile < Struct.new(:path)
+      def to_s
+        "Gemfile at \"#{path}\" is invalid."
+      end
+    end
+
+    class Remote < Struct.new(:path, :name, :suggestions)
       def to_s
         <<~ERR
           Source \"#{name}\" is possibly misspelled, suggestions:
@@ -28,24 +50,64 @@ module Gemfilelint
     end
   end
 
-  class Linter
-    class SpellChecker
-      attr_reader :detector, :haystack
+  module Parser
+    class Valid < Struct.new(:path, :dsl)
+      def each_offense
+        dependencies.each do |dependency|
+          yield dependency_offense_for(dependency)
+        end
+
+        remotes.each do |remote|
+          yield remote_offense_for(remote)
+        end
+      end
+
+      private
+
+      def dependencies
+        dsl.dependencies.map(&:name)
+      end
+
+      def dependency_offense_for(name)
+        corrections = Gemfilelint.dependencies.correct(name)
+        return if corrections.empty?
+
+        Offenses::Dependency.new(path, name, corrections.first(5))
+      end
 
-      def initialize(haystack)
-        @detector = Bundler::SimilarityDetector.new(haystack)
-        @haystack = haystack
+      # Lol wut, there has got to be a better way to do this
+      def remotes
+        dsl
+          .instance_variable_get(:@sources)
+          .instance_variable_get(:@rubygems_aggregate)
+          .remotes
+          .map(&:to_s)
       end
 
-      def correct(needle)
-        return [] if haystack.include?(needle)
+      def remote_offense_for(uri)
+        corrections = Gemfilelint.remotes.correct(uri)
+        return if corrections.empty?
+
+        Offenses::Remote.new(path, uri, corrections)
+      end
+    end
 
-        detector.similar_words(needle)
+    class Invalid < Struct.new(:path)
+      def each_offense
+        yield Offenses::InvalidGemfile.new(path)
       end
     end
 
+    def self.for(path)
+      Valid.new(path, Bundler::Dsl.new.tap { |dsl| dsl.eval_gemfile(path) })
+    rescue Bundler::Dsl::DSLError
+      Invalid.new(path)
+    end
+  end
+
+  class Linter
     module ANSIColor
-      CODES = { green: 32, magenta: 35 }.freeze
+      CODES = { green: 32, magenta: 35, cyan: 36 }.freeze
 
       refine String do
         def colorize(code)
@@ -56,23 +118,19 @@ module Gemfilelint
 
     using ANSIColor
 
-    attr_reader :dependency_checker, :remote_checker, :logger
-
-    def initialize
-      common_gems = File.read(File.expand_path('gems.txt', __dir__)).split("\n")
+    attr_reader :logger
 
-      @dependency_checker = SpellChecker.new(common_gems)
-      @remote_checker = SpellChecker.new(['https://rubygems.org/'])
+    def initialize(logger: nil)
+      @logger = logger || make_logger
     end
 
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-    def lint(path, logger: nil)
-      logger ||= make_logger
+    def lint(*paths)
+      logger.info("Inspecting gemfiles at #{paths.join(', ')}\n")
 
-      logger.info("Inspecting gemfile at #{path}\n")
       offenses = []
 
-      each_offense_for(path) do |offense|
+      each_offense_for(paths) do |offense|
         if offense
           offenses << offense
           logger.info('W'.colorize(:magenta))
@@ -82,54 +140,53 @@ module Gemfilelint
       end
 
       logger.info("\n")
-      return 0 if offenses.empty?
 
-      prefix = 'W'.colorize(:magenta)
-      messages = offenses.map { |offense| "#{prefix}: #{offense}\n" }
-      logger.info("\nOffenses:\n\n#{messages.join}\n")
-
-      1
+      if offenses.empty?
+        true
+      else
+        messages = offenses.map { |offense| offense_to_message(offense) }
+        logger.info("\nOffenses:\n\n#{messages.join("\n")}\n")
+        false
+      end
     end
     # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
     private
 
-    def make_logger
-      Logger.new(STDOUT).tap do |logger|
-        logger.level = :info
-        logger.formatter = ->(*, message) { message }
+    def each_offense_for(paths)
+      paths.each do |path|
+        Parser.for(path).each_offense do |offense|
+          yield offense
+        end
       end
     end
 
-    def each_offense_for(path)
-      dsl = Bundler::Dsl.new
-      dsl.eval_gemfile(path)
-
-      # Lol wut, there has got to be a better way to do this
-      source_list = dsl.instance_variable_get(:@sources)
-      rubygems = source_list.instance_variable_get(:@rubygems_aggregate)
-
-      dsl.dependencies.each do |dependency|
-        yield dependency_offense_for(dependency.name)
+    def make_logger
+      Logger.new(STDOUT).tap do |creating|
+        creating.level = :info
+        creating.formatter = ->(*, message) { message }
       end
+    end
 
-      rubygems.remotes.each do |remote|
-        yield remote_offense_for(remote.to_s)
-      end
+    def offense_to_message(offense)
+      "#{offense.path.colorize(:cyan)}: #{'W'.colorize(:magenta)}: #{offense}"
     end
+  end
 
-    def dependency_offense_for(name)
-      corrections = dependency_checker.correct(name)
-      Offenses::Dependency.new(name, corrections.first(5)) if corrections.any?
+  class << self
+    def dependencies
+      @dependencies ||=
+        SpellChecker.new(
+          File.read(File.expand_path('gems.txt', __dir__)).split("\n")
+        )
     end
 
-    def remote_offense_for(uri)
-      corrections = remote_checker.correct(uri)
-      Offenses::Remote.new(uri, corrections) if corrections.any?
+    def remotes
+      @remotes ||= SpellChecker.new(['https://rubygems.org/'])
     end
-  end
 
-  def self.lint(path, logger: nil)
-    Linter.new.lint(path, logger: logger)
+    def lint(*paths, logger: nil)
+      Linter.new(logger: logger).lint(*paths)
+    end
   end
 end

data/lib/gemfilelint/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gemfilelint
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gemfilelint
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kevin Deisz
@@ -78,6 +78,7 @@ files:
 - ".gitignore"
 - ".mergify.yml"
 - ".rubocop.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock