tiny_png 1.0.0 → 1.1.0

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-Edge
+1.1.0 - October 12, 2012
+
+- Create TinyPng::Path class to allow for blacklisting
+
+1.0.0 - October 11, 2012
 
 - Capistrano recipe to shrink images on deploy
 

data/README.md

@@ -4,6 +4,7 @@
 - [What Does This Gem Do?] (#what-does-this-gem-do)
 - [Installation] (#installation)
 - [Usage] (#usage)
+	- [Using Blacklists](#using-blacklists)
 	- [Using From Rake](#using-from-rake)
 	- [Using With Capistrano](#using-with-capistrano)
 
@@ -99,6 +100,25 @@ For each image path analyzed (whether sent in directly or picked out of a folder
 - That file must be readable and writeable
 - The file name *must* end in `.png`
 
+### Using Blacklists
+
+There might be times where you want to shrink an entire directory, but exclude certain files.  To do this, you'll need
+pass a `TinyPng::Path` object to `@client.shrink`.
+
+```ruby
+@paths = TinyPng::Path.new '/images/path'
+@paths.blacklist '/images/path/blacklist.png'
+@client.shrink @paths
+```
+
+The blacklist array takes precedence over anything else inputted into this TinyPng::Path object.
+
+**NOTE:** TinyPng::Path objects are independent of each other.  If you send in multiple path objects to the `shrink` method,
+the blacklist from one path object will not impact the other path object.
+
+You can send in TinyPng::Path objects, directories, and full image paths to the shrink method, but each will
+be analyzed by itself and the blacklist from any path object will be self-contained.
+
 ### Using From Rake
 
 Create a Rakefile in your app's root (or add this to an existing Rakefile):
@@ -144,6 +164,13 @@ Combining directories and specific image files:
 SHRINK=/image/directory,/path/to/image.png rake tiny_png:shrink
 ```
 
+The Rake task uses the [blacklist method](#using-blacklists) in building out the full paths.  This method allows you
+to also specify blacklisted paths:
+
+```ruby
+SHRINK=/image/directory BLACKLIST=/image/directory/blacklist.png rake tiny_png:shrink
+```
+
 By default, this rake task will use the settings in config/tiny_png.yml.  You can overwrite specific settings by passing
 environment variables.  For example, if I do not suppress exceptions in my base config, but want
 to when running a rake task, all I would need to do is set the `SUPPRESS_EXCEPTIONS` environment variable to true:
@@ -161,10 +188,10 @@ API_KEY=my_api_key SHRINK=/some/image.png rake tiny_png:shrink
 Naturally, these can all be combined in any fashion:
 
 ```ruby
-SUPPRESS_EXCEPTIONS=true API_KEY=my_api_key SHRINK=/image/directory,/some/image.png rake tiny_png:shrink
+SUPPRESS_EXCEPTIONS=true API_KEY=my_api_key SHRINK=/image/directory,/some/image.png BLACKLIST=/image/directory/blacklist.png rake tiny_png:shrink
 ```
 
-### Using In Capistrano
+### Using With Capistrano
 
 Since Photoshop doesn't support indexed PNGs with alpha transparency, you might not want to convert the
 images on your local box.  With the included Capistrano recipe, you can automatically shrink all files
@@ -183,6 +210,9 @@ the assets are precompiled so that it isn't run multiple times per image:
 before 'deploy:assets:precompile', 'tiny_png:shrink'
 ```
 
+Ultimately, the Capistrano recipe will build and run a Rake task on the server, so you need to have the
+[Rakefile setup correctly](#using-from-rake).
+
 By default, this script uses the settings found in config/tiny_png.yml.  It also runs through the entire
 release directory.  Each option can be overwritten by setting Capistrano variables.  These variables will
 be sent directly to a Rake task, so the expected format of these variables is the same as listed above:
@@ -191,6 +221,7 @@ be sent directly to a Rake task, so the expected format of these variables is th
 set :tiny_png_shrink, '/image/directory,/some/image.png'
 set :tiny_png_api_key, 'my_api_key'
 set :tiny_png_suppress_exceptions, true
+set :tiny_png_blacklist, '/image/directory/blacklist.png'
 ```
 
 Also by default, the task is only run on web servers.  This can be modified by setting the `tiny_png_server_role`

data/lib/tiny_png.rb

@@ -1,5 +1,11 @@
 module TinyPng
 end
 
+require 'base64'
+require 'httparty'
 require 'tiny_png/client'
-require 'tiny_png/version'
+require 'tiny_png/version'
+require 'tiny_png/exceptions'
+require 'tiny_png/shrink'
+require 'tiny_png/exception_handling'
+require 'tiny_png/path'

data/lib/tiny_png/client.rb

@@ -1,9 +1,3 @@
-require 'base64'
-require 'httparty'
-require 'tiny_png/exceptions'
-require 'tiny_png/shrink'
-require 'tiny_png/exception_handling'
-
 module TinyPng
   class Client
     include TinyPng::ExceptionHandling

data/lib/tiny_png/exceptions.rb

@@ -1,6 +1,3 @@
-class InvalidFileType < Exception
-end
-
 class FileDoesntExist < Exception
 end
 

data/lib/tiny_png/path.rb

@@ -0,0 +1,66 @@
+module TinyPng
+  class Path
+    #
+    # Create a TinyPng::Path object and optionally add .png paths to the
+    # show list (also transverses directories).
+    #
+    def initialize *show
+      @show = TinyPng::Path.get_all show
+      @blacklist = []
+    end
+    
+    #
+    # Add paths to the list (also transverses directories).
+    #
+    def add *list
+      @show = (@show + TinyPng::Path.get_all(list)).uniq
+    end
+    
+    #
+    # Add paths to the list (also transverses directories). The blacklist
+    # supercedes the add list, such that any path added to the blacklist will
+    # not show up in the final compilation.
+    #
+    def blacklist *list
+      @blacklist = (@blacklist + TinyPng::Path.get_all(list)).uniq
+    end
+    
+    #
+    # Remove paths from the list (also transverses directories).
+    #
+    def remove_from_list *list
+      @show = @show - TinyPng::Path.get_all(list)
+    end
+    
+    #
+    # Remove paths from the blacklist (also transverses directories).
+    #
+    def remove_from_blacklist *list
+      @blacklist = @blacklist - TinyPng::Path.get_all(list)
+    end
+    
+    #
+    # Return the full list of paths, minus anything in the blacklist.
+    #
+    def list
+      @show.uniq - @blacklist
+    end
+    
+    #
+    # Get all .png path names from the passed-in files and directories.
+    #
+    def self.get_all *list
+      list.flatten.uniq.collect do |path|
+        if path.is_a?(TinyPng::Path)
+          path.list
+        else
+          if File.directory?(path)
+            Dir.glob("#{path.gsub(/\/$/,'')}/**/*.png")
+          else
+            path.downcase.match(/\.png$/) ? path : nil
+          end
+        end
+      end.flatten.uniq.compact
+    end
+  end
+end

data/lib/tiny_png/recipes.rb

@@ -17,6 +17,7 @@ Capistrano::Configuration.instance(:must_exist).load do
       env.push "API_KEY=#{self[:tiny_png_api_key]}" unless self[:tiny_png_api_key].nil?
       env.push "API_USER=#{self[:tiny_png_api_user]}" unless self[:tiny_png_api_user].nil?
       env.push "SUPPRESS_EXCEPTIONS=#{self[:tiny_png_suppress_exceptions]}" unless self[:tiny_png_suppress_exceptions].nil?
+      env.push "BLACKLIST=#{self[:tiny_png_blacklist]}" unless self[:tiny_png_blacklist].nil?
       env
     end
 

data/lib/tiny_png/shrink.rb

@@ -18,18 +18,11 @@ module TinyPng::Shrink
   # Returns: Hash { :success => [Array, Of, Paths, Successfully, Overwrittern], :failure => [Array, Of, Paths, Left, Unchanged] }
   #
   
-  def shrink *shrinkwrap
+  def shrink *paths
     results = { :success => [], :failure => [] }
-    [shrinkwrap].flatten.each do |shrinkable|
-      if File.directory? shrinkable
-        Dir.glob("#{shrinkable.gsub(/\/$/,'')}/**/*.png") do |image_path|
-          key = self.shrink_in_place(image_path) ? :success : :failure
-          results[key].push image_path
-        end
-      else
-        key = shrink_in_place(shrinkable) ? :success : :failure
-        results[key].push shrinkable
-      end
+    TinyPng::Path.get_all(paths).each do |path|
+      key = shrink_in_place(path) ? :success : :failure
+      results[key].push path
     end
     results
   end
@@ -38,7 +31,6 @@ module TinyPng::Shrink
   
   def shrink_in_place image_path
     # check to make sure everything looks kosher before sending data to TinyPNG
-    return raise_exception InvalidFileType, 'The file must be a PNG' unless image_path.downcase.match(/\.png$/)
     return raise_exception FileDoesntExist, "Can't find a file at the specified path" unless File.exists? image_path
     return raise_exception FileNotReadable, "Can't read the requested file" unless File.readable? image_path
     return raise_exception FileNotWriteable, "Can't write to the specifed file" unless File.writable? image_path

data/lib/tiny_png/tasks.rb

@@ -16,6 +16,9 @@ namespace :tiny_png do
       options[:suppress_exceptions] = ENV['SUPPRESS_EXCEPTIONS'].downcase == 'true'
     end
     
-    TinyPng::Client.new(options).shrink ENV['SHRINK'].split(',')
+    paths = TinyPng::Path.new ENV['SHRINK'].split(',')
+    paths.blacklist ENV['BLACKLIST'].split(',') unless ENV['BLACKLIST'].nil?
+    
+    TinyPng::Client.new(options).shrink paths
   end
 end

data/lib/tiny_png/version.rb

@@ -1,3 +1,3 @@
 module TinyPng
-  Version = VERSION = '1.0.0'
+  Version = VERSION = '1.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tiny_png
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-11 00:00:00.000000000 Z
+date: 2012-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &2156392360 !ruby/object:Gem::Requirement
+  requirement: &2168794500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156392360
+  version_requirements: *2168794500
 description: Use the TinyPNG service to minimize the size of your image files.
 email: chris@thesturgills.com
 executables: []
@@ -38,6 +38,7 @@ files:
 - lib/tiny_png/client.rb
 - lib/tiny_png/exception_handling.rb
 - lib/tiny_png/exceptions.rb
+- lib/tiny_png/path.rb
 - lib/tiny_png/recipes.rb
 - lib/tiny_png/shrink.rb
 - lib/tiny_png/tasks.rb