img-lint 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c40d6bbcc1ec9690a2d4ca2a41d1e814838dbd11
-  data.tar.gz: e14e808b66b8dfb712a99e66a88a368c244cbbdc
+  metadata.gz: 59e8ea52589642c88577a1c2ed8448884c17cb79
+  data.tar.gz: f0afc1f20220878d0fe98c7c0ca134826b1eab63
 SHA512:
-  metadata.gz: 6c5ff65e4f72daeae5c723f1a5c4f0c96fa78d261fe39bbfdc7de1ad93fbc34e8aca35f6a89fd339c52e0333e62886e529ca79ad7925a0f6f48a8558cfadaab7
-  data.tar.gz: 8b45ddbfecd0337696f450a48ecce58db87bbc5074fd192bcc99cef8a721a6a94ce7db8dac3714b6ff5732fea24f5851c3225e5d9b60720b35a26b56ecbc7721
+  metadata.gz: 01b30b58d3bb1cfdfac948121b3217c698210eebd20c242fb5799b698714e7ad6e99398b0e62c2a82381919c93f5d926e7a052ce8ef5ab1c053faed774764faf
+  data.tar.gz: 02a5c48975b61013fce63ace7a5736ef62578b9c7ae2c57cec49ebdedf8f5c424177a31078eb0470b71c10f01cc06adef1cc990739bb2969ab67a62c1151455d

data/lib/img_lint/cli.rb

@@ -7,7 +7,13 @@ require "optparse"
 $LOAD_PATH << File.expand_path(__dir__)
 
 module IMGLint
-  # CLI class
+  # CLI class is responsible for handling command-line arguments.
+  #
+  # If the first argument is an "install" command, then we just copying
+  # default config to project's root folder and exit.
+  #
+  # Otherwise we'd extract path/max image size/image format arguments and run
+  # linter.
   #
   class CLI
     def run(args = [])
@@ -29,14 +35,18 @@ module IMGLint
         path = config.delete("path")
 
         linter = IMGLint::Linter.new(config: config)
-        fat_images = linter.lint(path: path)
+        heavy_images = linter.lint(path: path)
 
-        fat_images.empty? ? 0 : 2
+        heavy_images.empty? ? 0 : 2
       end
     end
 
     private
 
+    # This method is needed to unindent
+    # ["here document"](https://en.wikibooks.org/wiki/Ruby_Programming/Here_documents)
+    # help description.
+    #
     def unindent(str)
       str.gsub(/^#{str.scan(/^[ \t]+(?=\S)/).min}/, "")
     end

data/lib/img_lint/constants.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+# This is a module to keep constants like a path to the gem's directory
+# to easily reference a default config file.
+#
 module IMGLint
   IMG_LINT_HOME = File.realpath(File.join(__dir__, "..", ".."))
 end

data/lib/img_lint/linter.rb

@@ -4,6 +4,7 @@ module IMGLint
   # Linter class is responsible for checking images (only formats specified
   # in config) if they exceed a curtain size. It also prints out list of
   # suspicious images.
+  #
   class Linter
     attr_accessor :config
 
@@ -14,16 +15,16 @@ module IMGLint
     def lint(path: Dir.pwd, verbose: true)
       path ||= Dir.pwd
 
-      fat_images = find_fat_images(path, verbose)
+      heavy_images = find_heavy_images(path, verbose)
 
-      print_report(path, fat_images, verbose)
+      print_report(path, heavy_images, verbose)
 
-      fat_images
+      heavy_images
     end
 
     private
 
-    def find_fat_images(path, verbose)
+    def find_heavy_images(path, verbose)
       images = Dir.glob(%(#{path}/**/*.{#{config['image_formats']}}))
 
       puts "No images found in #{path}" if verbose && images.empty?
@@ -53,15 +54,15 @@ module IMGLint
       end
     end
 
-    def print_report(path, fat_images, verbose)
-      return if fat_images.empty? || !verbose
+    def print_report(path, heavy_images, verbose)
+      return if heavy_images.empty? || !verbose
 
       puts "Suspicious images:"
 
-      longest_image_path = fat_images.keys.max { |k| k.size }.size
-      longest_file_size = fat_images.values.max { |v| v.to_s.size }.size
+      longest_image_path = heavy_images.keys.max { |k| k.size }.size
+      longest_file_size = heavy_images.values.max { |v| v.to_s.size }.size
 
-      fat_images.sort_by(&:last).reverse.each do |image, file_size|
+      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")

data/lib/img_lint/rake_task.rb

@@ -5,7 +5,8 @@ require "rake/tasklib"
 require "img_lint/cli"
 
 module IMGLint
-  # Rake task
+  # Simple rake task to either add "rake img_lint" to the project's Rake tasks
+  # and use in CI for example.
   #
   class RakeTask < Rake::TaskLib
     def initialize(name = :img_lint)

data/lib/img_lint/version.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Module to keep the gem's version in. Make sure to bump it before release.
+#
 module IMGLint
-  VERSION = "0.0.16".freeze
+  VERSION = "0.0.17".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: img-lint
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
 platform: ruby
 authors:
 - Anatoli Makarevich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-20 00:00:00.000000000 Z
+date: 2018-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -104,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: IMG linter