img-lint 0.0.17 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59e8ea52589642c88577a1c2ed8448884c17cb79
-  data.tar.gz: f0afc1f20220878d0fe98c7c0ca134826b1eab63
+  metadata.gz: a93c829cbe2459dea77322211cf9adc461ca4bdc
+  data.tar.gz: 36c447665a022f2a6458a9c742dadae0192f5c7c
 SHA512:
-  metadata.gz: 01b30b58d3bb1cfdfac948121b3217c698210eebd20c242fb5799b698714e7ad6e99398b0e62c2a82381919c93f5d926e7a052ce8ef5ab1c053faed774764faf
-  data.tar.gz: 02a5c48975b61013fce63ace7a5736ef62578b9c7ae2c57cec49ebdedf8f5c424177a31078eb0470b71c10f01cc06adef1cc990739bb2969ab67a62c1151455d
+  metadata.gz: 957cefd40b9658c95bbb86ddcc91119c397a44d4df36390370467325f7ea8169b5d1a5bfe78c6db3060432ac1107dca9a577d3dfd377368df74272f532e6ba91
+  data.tar.gz: 00d00af5d27de640793fb5bf8df1ca38a0c90df7faaf8764ede44065fecf37abeb4dae4e007fb6eb90252e479db545c97639519de39d909c7b9440a52a13b092

data/lib/img_lint/cli.rb

@@ -16,6 +16,12 @@ module IMGLint
   # linter.
   #
   class CLI
+    # CLI is used when running img-lint from command line (check bin/img-lint) file
+    # or from a Raketask (check lib/img_lint/rake_task file).
+    #
+    # In Raketask CLI#run is called without arguments (expected that config file is there)
+    # and in bin/img-lint ARGV is passed in.
+    #
     def run(args = [])
       if args.first == "install"
         require "fileutils"

data/lib/img_lint/config.rb

@@ -6,11 +6,16 @@ require "img_lint/constants"
 module IMGLint
   # Config class is responsible to load img-lint either a user defined config
   # or a default one (config/default.yml)
+  #
   class Config
     FILE_NAME = ".img-lint.yml".freeze
     DEFAULT_FILE = File.join(IMG_LINT_HOME, "config", "default.yml")
 
     class << self
+      # Be default gem will try to load config file in user's project folder.
+      # Then user's config (or empty object) will be merge with the default config
+      # from gem's folder.
+      #
       def load
         user_config = File.exist?(user_file) ? YAML.safe_load(File.read(user_file)) : {}
         default_config = YAML.safe_load(File.read(DEFAULT_FILE))

data/lib/img_lint/linter.rb

@@ -6,12 +6,17 @@ module IMGLint
   # suspicious images.
   #
   class Linter
-    attr_accessor :config
-
+    # Be default gem will merge user-defined condif with the default one.
+    #
     def initialize(config: {})
-      self.config = IMGLint::Config.load.merge(config)
+      @config = IMGLint::Config.load.merge(config)
     end
 
+    # The gem's core method which actually goes through all images files and
+    # checks whether the image size exceeds the max size from config.
+    #
+    # Verbose attribute is there to surpress output when running specs.
+    #
     def lint(path: Dir.pwd, verbose: true)
       path ||= Dir.pwd
 
@@ -25,21 +30,21 @@ module IMGLint
     private
 
     def find_heavy_images(path, verbose)
-      images = Dir.glob(%(#{path}/**/*.{#{config['image_formats']}}))
+      images = Dir.glob(%(#{path}/**/*.{#{@config['image_formats']}}))
 
-      puts "No images found in #{path}" if verbose && images.empty?
+      puts "--> img-lint found no images in #{path}" if verbose && images.empty?
 
       images.each_with_object({}) do |file, o|
         next if excluded_file?(file)
 
         image_size = File.new(file).size / 1024
 
-        o[file] = image_size if image_size > config["max_file_size"]
+        o[file] = image_size if image_size > @config["max_file_size"]
       end
     end
 
     def exclude_patterns
-      @exclude_patterns ||= config.fetch("exclude", []).map! do |pattern|
+      @exclude_patterns ||= @config.fetch("exclude", []).map! do |pattern|
         if pattern.start_with?("/")
           pattern
         else
@@ -54,18 +59,31 @@ module IMGLint
       end
     end
 
+    def longest_path_and_file_size(path, heavy_images)
+      longest_image_path = heavy_images.keys.max { |k| k.size }
+      longest_image_path = longest_image_path.sub(Dir.pwd, "") if Dir.pwd == path
+
+      longest_file_size = heavy_images.values.max { |v| v.to_s.size }.size
+
+      [longest_image_path.size, longest_file_size]
+    end
+
     def print_report(path, heavy_images, verbose)
-      return if heavy_images.empty? || !verbose
+      return unless verbose
+
+      if heavy_images.empty?
+        puts "--> img-lint detected no heavy images"
+        return
+      end
 
-      puts "Suspicious images:"
+      puts "--> img-lint detected heavy images:"
 
-      longest_image_path = heavy_images.keys.max { |k| k.size }.size
-      longest_file_size = heavy_images.values.max { |v| v.to_s.size }.size
+      longest_image_path_size, longest_file_size = longest_path_and_file_size(path, heavy_images)
 
       heavy_images.sort_by(&:last).reverse.each do |image, file_size|
         image = image.sub(Dir.pwd, "") if Dir.pwd == path
 
-        puts [image.ljust(longest_image_path), "#{file_size}Kb".rjust(longest_file_size)].join("\t")
+        puts [image.ljust(longest_image_path_size), "#{file_size}Kb".rjust(longest_file_size)].join("\t")
       end
     end
   end

data/lib/img_lint/rake_task.rb

@@ -9,6 +9,8 @@ module IMGLint
   # and use in CI for example.
   #
   class RakeTask < Rake::TaskLib
+    # The only argument is the name of the rake task to register.
+    #
     def initialize(name = :img_lint)
       @name = name
 

data/lib/img_lint/version.rb

@@ -3,5 +3,5 @@
 # Module to keep the gem's version in. Make sure to bump it before release.
 #
 module IMGLint
-  VERSION = "0.0.17".freeze
+  VERSION = "0.0.18".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: img-lint
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.18
 platform: ruby
 authors:
 - Anatoli Makarevich