tiny_png_checker 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 304e6a5733b8d3b668fa5aaabbcb82a9715c4385b6e0bac579d83d7cfa93bec3
-  data.tar.gz: 1312e4a35a32bd0e618b5d5dd5ad42c3f0dabccf16e2ada2a7d25829aabd70fa
+  metadata.gz: ca9a7b7016aed1349fd019297ef691347fb165279ad43a29e1bf723d353cc828
+  data.tar.gz: e354da683db83a618d8c063717afda45290df44458112a000372f8f77fa49da9
 SHA512:
-  metadata.gz: a8a9f08853da21ec98e0c7065598fb74e7cfa3f8cbc3dc347f1ca345ad21fdae758d61450972554ce75be0b9a71d0e18b03b2cb45b0d0d23448dfe16d75f4124
-  data.tar.gz: e533a8ed0ea8c2bc20b0c0c6e2a8d7a8818bcd1127fec8e9cb693b6812ef732f0a4d5142e479738b185bed21a4e12d29b4f834b1547257bbeca5ade7c428c44b
+  metadata.gz: cb8371052ac769f1ef052c2e383937e55f70a4128a73ee9cfaa13cca565fcaf2ac7839260a50b7cbde71a7a86e011c503e6f7f1e982ca1b9fcb1bf90a35f9084
+  data.tar.gz: f96ce51770273358a8d4b4c0c387b27853f6edfadaa72b56b4ca831933aa4f6a195699268494fa09e0e6941b39d3a25db315e162904c77381f903de0c01fed64

data/Gemfile.lock

@@ -1,15 +1,17 @@
 PATH
   remote: .
   specs:
-    tiny_png_checker (0.1.1)
+    tiny_png_checker (0.1.2)
       chunky_png (~> 1.3, >= 1.3.10)
       commander (~> 4.4, >= 4.4.6)
       figaro (~> 1.1, >= 1.1.1)
+      parallel (~> 1.12, >= 1.12.1)
       tinify (~> 1.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    benchmark_methods (0.7)
     chunky_png (1.3.10)
     commander (4.4.6)
       highline (~> 1.7.2)
@@ -18,6 +20,7 @@ GEM
     highline (1.7.10)
     httpclient (2.8.3)
     minitest (5.11.3)
+    parallel (1.12.1)
     rake (10.5.0)
     thor (0.20.0)
     tinify (1.5.0)
@@ -27,6 +30,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  benchmark_methods (~> 0.7)
   bundler (~> 1.16)
   minitest (~> 5.0)
   rake (~> 10.0)

data/README.md

@@ -1,8 +1,6 @@
 # TinyPngChecker
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tiny_png_checker`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Tiny png checker works over [tinypng.com](http://www.tinypng.com) compressor, since TinyPng converter is not deterministic and does not provide a way to know if a file was already compressed, this gem provides some tools to workaround those issues
 
 ## Installation
 
@@ -22,7 +20,28 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+  Three commands are available. All of them accept a --folders param as a comma separated string list being the folder paths to process:
+        
+    check    Checks recursively into specified folders for PNG files marked by TinyPngProcessor         
+    compress Compress recursively PNGs inside specified folders using TinyPNG and mark files with TinyPngProcessor flag         
+    help     Display global or [command] help documentation
+    
+  Example
+  
+    tiny_png_checker check --files ~/Documents,~/Images     
+
+  There are some global options:
+        
+    -h, --help 
+        Display help documentation
+        
+    -v, --version 
+        Display version information
+        
+    -t, --trace 
+        Display backtrace when an error occurs
+        
+
 
 ## Development
 

data/exe/tiny_png_checker

@@ -14,7 +14,19 @@ command :check do |c|
   c.action do |args, options|
     checker = TinyPngChecker::Checker.new
     say "Running under folders: #{options.folders}"
-    checker.check_tiny_png_on_folders(options.folders)
+    checker.process_pngs_on_folders(options.folders)
+    say "Done!"
+  end
+end
+
+command :mark do |c|
+  c.syntax = 'tiny_png_checker mark [folders]'
+  c.description = 'Mark PNGs files with TinyPngProcessor flag looking recursively in folders provided'
+  c.option '--folders FOLDERS' , Array, 'List of folders to check for PNGs to mark'
+  c.action do |args, options|
+    say "Running under folders: #{options.folders}"
+    marking = TinyPngChecker::Marker.new
+    marking.process_pngs_on_folders(options.folders)
     say "Done!"
   end
 end
@@ -26,7 +38,7 @@ command :compress do |c|
   c.action do |args, options|
     say "Running under folders: #{options.folders}"
     compressor = TinyPngChecker::Compressor.new
-    compressor.compress_pngs_on_folders(options.folders)
+    compressor.process_pngs_on_folders(options.folders)
     say "Done!"
   end
 end

data/lib/config/application.yml

@@ -1,3 +1,3 @@
 # Add configuration values here, as shown below.
 
-tinify_api_key: "e3axBwb1wgc7egz6q5IX2wOIxrW9HP6H"
+tinify_api_key: "QeOe28LwtnR5NXKYDFM0gBP9Rkn6IX3r"

data/lib/tiny_png_checker.rb

@@ -1,6 +1,7 @@
 require 'tiny_png_checker/version'
 require 'tiny_png_checker/checker'
 require 'tiny_png_checker/compressor'
+require 'tiny_png_checker/marker'
 
 require 'figaro'
 Figaro.application = Figaro::Application.new(environment: 'production', path: File.expand_path('../config/application.yml', __FILE__))

data/lib/tiny_png_checker/base_processor.rb

@@ -0,0 +1,27 @@
+
+module TinyPngChecker
+  class BaseProcessor
+
+    attr_accessor :errors, :processed
+
+    def run_process
+
+      self.errors ||= []
+      self.processed ||= []
+
+      begin
+        yield
+      rescue => e
+        $stderr.puts("Unrecoverable error #{e}")
+      end
+
+      $stdout.puts("Compressed files:")
+      $stdout.puts(processed)
+
+      if errors.any?
+        $stderr.puts(errors)
+        abort
+      end
+    end
+  end
+end

data/lib/tiny_png_checker/checker.rb

@@ -1,20 +1,24 @@
 require 'tiny_png_checker/utils/image_files_retriever'
 require 'tiny_png_checker/utils/tiny_png'
+require 'tiny_png_checker/base_processor'
 
 module TinyPngChecker
-  class Checker
+  class Checker < BaseProcessor
 
-    def check_tiny_png_on_folders(folders = [])
-      png_files = Utils::ImageFilesRetriever.get_png_files_from_folders(folders)
+    def process_pngs_on_folders(folders = [])
+      run_process do
+        png_files = Utils::ImageFilesRetriever.get_png_files_from_folders(folders)
 
-      not_processed_files = Utils::TinyPng.not_processed_files(png_files)
+        not_processed_files = Utils::TinyPng.not_processed_files(png_files)
 
-      if not_processed_files.any?
-        $stderr.puts("Files not processed by TinyPNG:")
-        $stderr.puts(not_processed_files)
-        abort
-      else
-        $stdout.puts("No files to process")
+        if not_processed_files.any?
+          $stderr.puts("Files not processed by TinyPNG:")
+          $stderr.puts(not_processed_files)
+          abort
+        else
+          $stdout.puts("No files to process")
+          exit
+        end
       end
     end
 

data/lib/tiny_png_checker/compressor.rb

@@ -1,61 +1,40 @@
 require 'tinify'
 require 'figaro'
 require 'tiny_png_checker/utils/tiny_png'
-require 'tiny_png_checker/utils/image_files_retriever'
+require 'tiny_png_checker/unmarked_files_processor'
 
 module TinyPngChecker
-  class Compressor
+  class Compressor < UnmarkedFilesProcessor
 
-    def initialize
-      @errors = []
-      @processed = []
-    end
-
-    def compress_pngs_on_folders(folders = [])
+    def setup
       begin
         Tinify.key = Figaro.env.tinify_api_key
         Tinify.validate!
       rescue Tinify::Error => e
         abort("Error: Tinify invalid api key #{e}")
       end
-
-      @errors.clear
-      @processed.clear
-
-      png_files = Utils::ImageFilesRetriever.get_png_files_from_folders(folders)
-
-      not_processed_files = Utils::TinyPng.not_processed_files(png_files)
-
-      not_processed_files.each { |not_processed_file| process_file(not_processed_file) }
-
-      $stdout.puts("Compressed files:")
-      $stdout.puts(@processed)
-
-      if @errors.any?
-        $stderr.puts(@errors)
-        abort
-      end
     end
 
     def process_file(file)
       begin
         Tinify.from_file(file).to_file(file)
         Utils::TinyPng.mark_files(file)
-        @processed << file
+        processed << file
       rescue Tinify::AccountError => e
-        @errors << "The error message is: #{e.message} with file #{file}, monthly conversion limit #{Tinify.compression_count}"
+        errors << "The error message is: #{e.message} with file #{file}, monthly conversion limit #{Tinify.compression_count}"
+        raise e
           # Verify your API key and account limit.
       rescue Tinify::ClientError => e
-        @errors << "Check your source image and request options, the error message is: #{e.message} with file #{file}"
+        errors << "Check your source image and request options, the error message is: #{e.message} with file #{file}"
           # Check your source image and request options.
       rescue Tinify::ServerError => e
-        @errors << "Temporary issue with the Tinify API, the error message is: #{e.message} with file #{file}"
+        errors << "Temporary issue with the Tinify API, the error message is: #{e.message} with file #{file}"
           # Temporary issue with the Tinify API.
       rescue Tinify::ConnectionError => e
-        @errors << "A network connection error occurred, the error message is: #{e.message} with file #{file}"
+        errors << "A network connection error occurred, the error message is: #{e.message} with file #{file}"
           # A network connection error occurred.
       rescue => e
-        @errors << "An error occurred, the error message is: #{e.message} with file #{file}"
+        errors << "An error occurred, the error message is: #{e.message} with file #{file}"
         # Something else went wrong, unrelated to the Tinify API.
       end
     end

data/lib/tiny_png_checker/marker.rb

@@ -0,0 +1,17 @@
+require 'tiny_png_checker/utils/tiny_png'
+require 'tiny_png_checker/unmarked_files_processor'
+
+module TinyPngChecker
+  class Marker < UnmarkedFilesProcessor
+
+    def process_file(file)
+      begin
+        Utils::TinyPng.mark_files(file)
+        processed << file
+      rescue => e
+        errors << "An error occurred, the error message is: #{e.message} with file #{file}"
+      end
+    end
+
+  end
+end

data/lib/tiny_png_checker/unmarked_files_processor.rb

@@ -0,0 +1,27 @@
+require 'tiny_png_checker/base_processor'
+require 'tiny_png_checker/utils/tiny_png'
+require 'tiny_png_checker/utils/image_files_retriever'
+
+module TinyPngChecker
+  class UnmarkedFilesProcessor < BaseProcessor
+
+    def process_pngs_on_folders(folders = [])
+      run_process do
+        setup
+
+        png_files = Utils::ImageFilesRetriever.get_png_files_from_folders(folders)
+
+        not_processed_files = Utils::TinyPng.not_processed_files(png_files)
+
+        not_processed_files.each { |not_processed_file| process_file(not_processed_file) }
+      end
+    end
+
+    def process_file(_)
+    end
+
+    def setup
+    end
+
+  end
+end

data/lib/tiny_png_checker/utils/tiny_png.rb

@@ -1,4 +1,5 @@
 require 'chunky_png'
+require 'parallel'
 
 module Utils
   module TinyPng
@@ -8,13 +9,28 @@ module Utils
 
     def self.not_processed_files(png_files = [])
 
-      png_files.select do |file|
-        image = ChunkyPNG::Image.from_file(file)
-        image.metadata[PNG_PROCESSED_FLAG].nil?
-      end
+      Parallel.map(png_files) do |file|
+        begin
+          # image = ChunkyPNG::Image.from_file(file)
+          # image.metadata[PNG_PROCESSED_FLAG].nil? ? file : nil
+
+          if !look_for_metadata_flag_from_io(File.open(file)) { |chunk| is_tinypng_metadata_chunk(chunk) }
+            file
+          end
+        rescue => e
+          $stdout.puts("WARNING: File is not a PNG: #{file}, error: #{e}")
+          nil
+        end
+      end.compact
 
     end
 
+    def self.is_tinypng_metadata_chunk(chunk)
+      if chunk.respond_to?(:keyword) && chunk.respond_to?(:value)
+        chunk.keyword == PNG_PROCESSED_FLAG && chunk.value.nil?
+      end
+    end
+
     def self.mark_files(*png_files)
 
       png_files.compact!
@@ -27,5 +43,24 @@ module Utils
 
     end
 
+    def self.look_for_metadata_flag_from_io(io)
+      ChunkyPNG::Datastream.verify_signature!(io)
+
+      end_chunk = false
+      found = false
+
+      while !end_chunk && !found
+        chunk = ChunkyPNG::Chunk.read(io)
+        case chunk
+        when ChunkyPNG::Chunk::End
+          end_chunk = true
+        else
+          found = !yield(chunk).nil?
+        end
+      end
+
+      found
+    end
+
   end
 end

data/lib/tiny_png_checker/version.rb

@@ -1,3 +1,3 @@
 module TinyPngChecker
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/tiny_png_checker.gemspec

@@ -38,7 +38,9 @@ CI know that the file has been compressed, so a check can be done per build}
   spec.add_dependency "tinify", "~> 1.5"
   spec.add_dependency "figaro", "~> 1.1", ">= 1.1.1"
   spec.add_dependency "commander", "~> 4.4", ">= 4.4.6"
+  spec.add_dependency "parallel", "~> 1.12", ">= 1.12.1"
 
+  spec.add_development_dependency "benchmark_methods", "~> 0.7"
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tiny_png_checker
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Damian Arrillaga
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-06 00:00:00.000000000 Z
+date: 2018-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chunky_png
@@ -84,6 +84,40 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.4.6
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+- !ruby/object:Gem::Dependency
+  name: benchmark_methods
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -150,8 +184,11 @@ files:
 - exe/tiny_png_checker
 - lib/config/application.yml
 - lib/tiny_png_checker.rb
+- lib/tiny_png_checker/base_processor.rb
 - lib/tiny_png_checker/checker.rb
 - lib/tiny_png_checker/compressor.rb
+- lib/tiny_png_checker/marker.rb
+- lib/tiny_png_checker/unmarked_files_processor.rb
 - lib/tiny_png_checker/utils/image_files_retriever.rb
 - lib/tiny_png_checker/utils/tiny_png.rb
 - lib/tiny_png_checker/version.rb