thumbkit 0.0.2 → 0.0.3

data/README.md

@@ -1,14 +1,14 @@
 # Thumbkit
 
+Thumbkit makes thumbnails from a variety of media types.
+Thumbkit is designed to work with carrierwave but does not require it.
+
 > it's like quicklook for carrierwave :)
 >
 > -- <cite>[Emmanuel Gomez][1]</cite>
 
  [1]:https://github.com/emmanuel
 
-Thumbkit makes thumbnails from a variety of media types.
-Thumbkit is designed to work with carrierwave but does not require it.
-
 ## Synopsis
 
 ```ruby
@@ -23,14 +23,18 @@ See [Usage](#usage) below for more examples
 
 Add this line to your application's Gemfile:
 
-    gem 'thumbkit'
-    gem 'mini_magick' # For text or image thumbnails
-    gem 'waveform' # For audio thumbnails
-    gem 'oily_png' # Optional, for presumably faster audio thumbnails
+```ruby
+gem 'thumbkit'
+gem 'mini_magick' # For text or image thumbnails
+gem 'waveform' # For audio thumbnails
+gem 'oily_png' # Optional, for presumably faster audio thumbnails
+```
 
 And then execute:
 
-    $ bundle
+```shell
+$ bundle
+```
 
 Please see [Requirements](#requirements) for more information about each
 thumbnail type.
@@ -72,8 +76,11 @@ other than .wav files.
 
 See https://github.com/benalavi/waveform for more on requirements.
 
-NOTE: As of 0.0.3 waveform fails on mono files (benalavi/waveform#4,
-benalavi/waveform#5. I've forked and fixed (see benalavi/waveform#6). Until my
+NOTE: As of 0.0.3 waveform fails on mono files
+([benalavi/waveform#4](https://github.com/benalavi/waveform/issues/4),
+[benalavi/waveform#5](https://github.com/benalavi/waveform/issues/5)).
+I've forked and fixed the issue (see
+[benalavi/waveform#6](https://github.com/benalavi/waveform/pull/6)). Until my
 fix gets merged in you can use https://github.com/amiel/waveform/tree/thumbkit.
 Like so:
 
@@ -89,49 +96,13 @@ Thumbkit takes a path to a file, and saves a thumbnail for that file regardless
 of type. Certain types require different gems, but none are dependencies so
 you'll have to install them yourself.
 
-All settings can be set globally. These are the defaults:
-
-### Configuration
-
-```ruby
-  Thumbkit.defaults = {
-    width: 200, height: 200,
-    gravity: 'Center',
-    colors: { foreground: '#888888', background: '#eeeeee' },
-    font: {
-      family: 'Arial-Regular',
-      pointsize: '18',
-      direction: :auto,
-    },
-  }
-```
-
-Setting `Thumbkit.defaults=` will deep merge. So setting one option is possible
-with:
-
-```ruby
-  Thumbkit.defaults = { colors: { foreground: '#FF69B4' } } # HOT PINK
-```
-
-#### Font options
-
-The list of fonts available to imagemagick can be found with
-`identify -list Font`
-
-#### Gravity Options
-
-A list of gravity options can be found with `identify -list Gravity`
-
-See http://www.imagemagick.org/script/command-line-options.php#gravity for more
-information.
-
 ### Image thumbnails
 
 ```ruby
   Thumbkit.new('path/to/image.jpg').write_thumbnail # => 'path/to/image.jpg'
 ```
 
-Will write a 60x60 cropped image to `path/to/image.jpg`.
+Will write a 200x200 cropped image to `path/to/image.jpg`.
 
 The format of the output file will depend on the extension of the output path
 and defaults to the same as the input file.
@@ -142,13 +113,13 @@ and defaults to the same as the input file.
   text = Thumbkit.new('path/to/text_file.txt')
 
   text.write_thumbnail(nil, {
-    width: 200, height: 200,
+    width: 160, height: 160,
     colors: { foreground: '#663854' },
     font: { pointsize: '18' },
   }) # => 'path/to/text_file.png'
 ```
 
-Will write a 200x200 cropped image to `path/to/text_file.png`.
+Will write a 160x160 cropped image to `path/to/text_file.png`.
 
 The format of output will depend on the extension of the output path provided
 but defaults to .png.
@@ -176,7 +147,7 @@ but defaults to .png.
   }) # => 'path/to/output.png'
 ```
 
-Will write a 60x60 cropped image to `path/to/output.png`.
+Will write a 200x200 cropped image to `path/to/output.png`.
 
 Note that while imagemagick supports most color specification formats, waveform
 only takes 6 digit hex values. However, there is one special case for the symbol
@@ -196,22 +167,93 @@ NOT YET IMPLEMENTED
 
 ### CarrierWave usage
 
-NOT YET IMPLEMENTED
-
 ```ruby
   class MyUploader < CarrierWave::Uploader::Base
-    include CarrierWave::Thumbkit
+    include Thumbkit::Adapters::CarrierWave
 
     version :thumbnail do
-      process :thumbkit => [200, 200, { colors: { foreground: '#cccccc' } }]
+      # See Configuration below for more about options.
+      process thumbkit: [200, 200, { colors: { foreground: '#cccccc' } }]
+
+      # This tells CarrierWave where the version file can be found since
+      # thumbkit can write a to a file with a different extension than the
+      # original.
+      #
+      # See https://github.com/jnicklas/carrierwave/wiki/How-to%3A-Customize-your-version-file-names
+      # for more about
+      def full_filename(for_file = model.file.file)
+        [version_name, thumbkit_filename(for_file)].join('_')
+      end
     end
   end
 ```
 
+## Configuration
+
+All settings can be set globally. These are the defaults:
+
+```ruby
+  Thumbkit.defaults = {
+    width: 200, height: 200,
+    gravity: 'Center',
+    colors: { foreground: '#888888', background: '#eeeeee' },
+    font: {
+      family: 'Arial-Regular',
+      pointsize: '18',
+      direction: :auto,
+    },
+  }
+```
+
+Setting `Thumbkit.defaults=` will deep merge. So setting one option is possible
+with:
+
+```ruby
+  Thumbkit.defaults = { colors: { foreground: '#FF69B4' } } # HOT PINK
+```
+
+#### Font options
+
+The list of fonts available to imagemagick can be found with
+`identify -list Font`
+
+#### Gravity Options
+
+A list of gravity options can be found with `identify -list Gravity`
+
+See http://www.imagemagick.org/script/command-line-options.php#gravity for more
+information.
+
+#### Processors
+
+Built-in processors can be found in `lib/thumbkit/processor`.
+
+Adding a processor mapping:
+
+```ruby
+Thumbkit.processors['jpeg'] = 'Image'
+```
+
+Adding a processor:
+
+```ruby
+class Thumbkit::Processors::Doc
+  def write
+    # use `path` to generate `outfile`
+
+    # always return the generated filename
+    outfile
+  end
+end
+
+Thumbkit.processors['doc'] = 'Doc'
+```
+
 ## Other plans
 
-* Accept a StringIO instead of a pathname
-* Maybe use filemagic if available
+* Optionally accept a StringIO instead of a pathname
+* Maybe use filemagic/mime-type if available
+* Paperclip processor
 * Processors:
   * Composite
   * HTML

data/lib/thumbkit/adapters/carrierwave.rb

@@ -0,0 +1,36 @@
+# Example usage:
+#
+#   class MyUploader < CarrierWave::Uploader::Base
+#     include Thumbkit::Adapters::CarrierWave
+#
+#     version :thumbnail do
+#       # See [Configuration](#configuration) below for more about options.
+#       process thumbkit: [200, 200, { colors: { foreground: '#cccccc' } }]
+#
+#       # This tells CarrierWave where the version file can be found since
+#       # thumbkit can write a to a file with a different extension than the
+#       # original.
+#       #
+#       # See https://github.com/jnicklas/carrierwave/wiki/How-to%3A-Customize-your-version-file-names
+#       # for more about
+#       def full_filename(for_file = model.file.file)
+#         [version_name, thumbkit_filename(for_file)].join('_')
+#       end
+#     end
+#   end
+#
+module Thumbkit::Adapters::CarrierWave
+  def thumbkit(width, height, options = {})
+    options.merge!(width: width, height: height)
+    cache_stored_file! if !cached?
+    thumbkit = Thumbkit.new(current_path)
+    result = thumbkit.write_thumbnail(nil, options)
+    @file = CarrierWave::SanitizedFile.new(result)
+  end
+
+  # Given a filename, return the filename that Thumbkit would generate.
+  # This should not do any processing.
+  def thumbkit_filename(for_file)
+    File.basename(Thumbkit.new(for_file).processor_instance.outfile)
+  end
+end

data/lib/thumbkit/adapters.rb

@@ -0,0 +1,3 @@
+module Thumbkit::Adapters
+  autoload :CarrierWave, 'thumbkit/adapters/carrierwave'
+end

data/lib/thumbkit/processor/image.rb

@@ -34,7 +34,7 @@ class Thumbkit::Processor::Image < Thumbkit::Processor
         rows = (scale * (rows + 0.5)).round
         cmd.resize "#{ cols }x#{ rows }"
       end
-      cmd.gravity options[:gravity].to_s
+      cmd.gravity options[:gravity].to_s if options[:gravity]
       cmd.background options[:colors][:background].to_s
 
       if cols != options[:width] || rows != options[:height]

data/lib/thumbkit/processor/text.rb

@@ -59,7 +59,8 @@ class Thumbkit::Processor::Text < Thumbkit::Processor
       mogrify.antialias
       mogrify.font options[:font][:family]
       mogrify.direction direction if direction
-      mogrify.gravity options[:gravity].to_s
+      mogrify.gravity options[:gravity].to_s if options[:gravity]
+
       # While we convert to png, imagemagick will still output the format given
       # by the extension. This allows users to costumize the output with the
       # outfile extension.
@@ -70,6 +71,8 @@ class Thumbkit::Processor::Text < Thumbkit::Processor
       mogrify.crop "#{ options[:width] }x#{ options[:height] }+0+0"
       mogrify.extent "#{ options[:width] }x#{ options[:height] }"
       mogrify << '+repage'
+      # This extra gravity call prevents left-to-right text from rendering centered
+      mogrify.gravity 'NorthWest'
       mogrify.write outfile
       mogrify << "label:@#{path}"
     end

data/lib/thumbkit/processor.rb

@@ -7,6 +7,7 @@ class Thumbkit::Processor
     @processors ||= {
       'png' => 'Image',
       'jpg' => 'Image',
+      'gif' => 'Image',
       'txt' => 'Text',
       'md'  => 'Text',
       'mp3' => 'Audio',

data/lib/thumbkit/version.rb

@@ -1,3 +1,3 @@
 class Thumbkit
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/thumbkit.rb

@@ -3,6 +3,7 @@ require "thumbkit/version"
 class Thumbkit
   autoload :Processor, 'thumbkit/processor'
   autoload :Options, 'thumbkit/options'
+  autoload :Adapters, 'thumbkit/adapters'
 
   attr_accessor :path, :filename, :type
 
@@ -10,7 +11,7 @@ class Thumbkit
     @defaults ||= Thumbkit::Options.new({
       width: 200,
       height: 200,
-      # Try `identify -list Gravity` for a list of available options
+      # Run `identify -list Gravity` for a list of available options
       gravity: 'Center',
       colors: {
         # Colors must be 6-digit hex
@@ -18,7 +19,7 @@ class Thumbkit
         foreground: '#888888',
       },
       font: {
-        # Try `identify -list Font` for available font options
+        # Run `identify -list Font` for available font options
         family: 'Arial-Regular',
         size: '18', # In points
         direction: :auto, # nil, :auto, 'right-to-left', or 'left-to-right'
@@ -26,17 +27,25 @@ class Thumbkit
     })
   end
 
+  def self.processors
+    Thumbkit::Processor.processors
+  end
+
   def initialize(path)
     @path = File.expand_path(path)
     @filename = File.basename(@path)
-    @type = File.extname(filename)[1..-1]
+    @type = File.extname(@filename)[1..-1]
   end
 
   def processor
     @processor ||= Thumbkit::Processor.processor_for(type)
   end
 
+  def processor_instance(outfile = nil, options = {})
+    processor.new(path, outfile, options)
+  end
+
   def write_thumbnail(outfile = nil, options = {})
-    processor.new(path, outfile, options).write
+    processor_instance(outfile, options).write
   end
 end

data/spec/thumbkit/processor/text_spec.rb

@@ -68,10 +68,11 @@ describe Thumbkit::Processor::Text do
 
     context 'with some greek letters' do
       let(:fixture) { 'greek.txt' }
+      let(:options) { { width: 400, height: 400 } }
       let(:outfile) { path_for_output('greek.png').to_s }
       it('writes a file') { File.should exist(subject) }
       it('autodetects left-to-right') { processor.__send__(:direction).should == 'left-to-right' }
-      its_size_should_be('200x200')
+      its_size_should_be('400x400')
       its_mimetype_should_be('image/png')
       # Manually check the file to verify unicode stuff worked
     end

data/thumbkit.gemspec

@@ -5,13 +5,13 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Amiel Martin"]
   gem.email         = ["amiel@carnesmedia.com"]
   gem.description   = %q{Thumbkit makes thumbnails!}
-  gem.summary       = %q{Thumbkit makes thumbnails from a variety of media types. Planned: Audio, Text, Image, and Video.}
+  gem.summary       = %q{Thumbkit makes thumbnails from a variety of media types.}
   gem.homepage      = "http://github.com/carnesmedia/thumbkit"
 
   # TODO: Remove dependency on git
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.test_files    = gem.files.grep(%r{^(spec)/})
   gem.name          = "thumbkit"
   gem.require_paths = ["lib"]
   gem.version       = Thumbkit::VERSION

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thumbkit
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-01 00:00:00.000000000 Z
+date: 2012-05-02 00:00:00.000000000 Z
 dependencies: []
 description: Thumbkit makes thumbnails!
 email:
@@ -25,6 +25,8 @@ files:
 - README.md
 - Rakefile
 - lib/thumbkit.rb
+- lib/thumbkit/adapters.rb
+- lib/thumbkit/adapters/carrierwave.rb
 - lib/thumbkit/options.rb
 - lib/thumbkit/processor.rb
 - lib/thumbkit/processor/audio.rb
@@ -69,8 +71,7 @@ rubyforge_project:
 rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
-summary: ! 'Thumbkit makes thumbnails from a variety of media types. Planned: Audio,
-  Text, Image, and Video.'
+summary: Thumbkit makes thumbnails from a variety of media types.
 test_files:
 - spec/fixtures/16Hz-20kHz-Exp-1f-5sec.mp3
 - spec/fixtures/arabic.txt