No commit activity in last 3 years
No release in over 3 years
This library check for PNG metadata that indicates TinyPNG is applied on files, the idea is to avoid doing double compression and make for example the CI know that the file has been compressed, so a check can be done per build
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.16
~> 5.0
~> 10.0

Runtime

>= 1.3.10, ~> 1.3
>= 4.4.6, ~> 4.4
>= 1.1.1, ~> 1.1
>= 1.12.1, ~> 1.12
~> 1.5
 Project Readme

TinyPngChecker

Tiny png checker works over 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

Add this line to your application's Gemfile:

gem 'tiny_png_checker'

And then execute:

$ bundle

Or install it yourself as:

$ gem install tiny_png_checker

Usage

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

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tiny_png_checker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the TinyPngChecker project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.