RubyGems - imgkit - Versions diffs - 1.2.1 → 1.3.0 - Mend

imgkit 1.2.1 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (11) hide show

data/.gitignore CHANGED

@@ -1,3 +1,4 @@
 pkg/*
 *.gem
 .bundle
+test.sh

data/Gemfile CHANGED

@@ -1,9 +1,10 @@
 source :rubygems
-group :development do
-  gem "rspec", "~> 2.0.0.beta.8"
-  gem "rspec-core", "~> 2.0.0.beta.8"
+group :test do
+  gem "rspec", "~> 2"
+  gem "rspec-core", "~> 2"
   gem "mocha"
-  gem "jeweler"
   gem "rack"
-end
+  gem "ruby-debug19", :platforms => :mri_19
+  gem "ruby-debug", :platforms => :mri_18
+end

data/Gemfile.lock CHANGED

@@ -1,35 +1,45 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    archive-tar-minitar (0.5.2)
+    columnize (0.3.2)
     diff-lcs (1.1.2)
-    gemcutter (0.6.1)
-    git (1.2.5)
-    jeweler (1.4.0)
-      gemcutter (>= 0.1.0)
-      git (>= 1.2.5)
-      rubyforge (>= 2.0.0)
-    json_pure (1.4.3)
-    mocha (0.9.8)
-      rake
-    rack (1.2.1)
-    rake (0.8.7)
-    rspec (2.0.0.beta.19)
-      rspec-core (= 2.0.0.beta.19)
-      rspec-expectations (= 2.0.0.beta.19)
-      rspec-mocks (= 2.0.0.beta.19)
-    rspec-core (2.0.0.beta.19)
-    rspec-expectations (2.0.0.beta.19)
-      diff-lcs (>= 1.1.2)
-    rspec-mocks (2.0.0.beta.19)
-    rubyforge (2.0.4)
-      json_pure (>= 1.1.7)
+    linecache (0.45)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    mocha (0.9.12)
+    rack (1.3.0)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
 PLATFORMS
   ruby
 DEPENDENCIES
-  jeweler
   mocha
   rack
-  rspec (~> 2.0.0.beta.8)
-  rspec-core (~> 2.0.0.beta.8)
+  rspec (~> 2)
+  rspec-core (~> 2)
+  ruby-debug
+  ruby-debug19

data/README.md CHANGED

@@ -25,9 +25,17 @@ Heavily based on [PDFKit](http://github.com/jdpace/pdfkit/).
     # Get the image BLOB
     img = kit.to_img
-    # Save the JPG to a file
+    # New in 1.3!
+    img = kit.to_img(:jpg)      #default
+    img = kit.to_img(:jpeg)
+    img = kit.to_img(:png)
+    img = kit.to_img(:tif)
+    img = kit.to_img(:tiff)
+    # Save the image to a file
     file = kit.to_file('/path/to/save/file.jpg')
+    file = kit.to_file('/path/to/save/file.png')
     # IMGKit.new can optionally accept a URL or a File.
     # Stylesheets can not be added when source is provided as a URL of File.
@@ -35,11 +43,18 @@ Heavily based on [PDFKit](http://github.com/jdpace/pdfkit/).
     kit = IMGKit.new(File.new('/path/to/html'))
     # Add any kind of option through meta tags
-    IMGKit.new('<html><head><meta name="imgkit-quality" content="75")
+    IMGKit.new('<html><head><meta name="imgkit-quality" content="75"...
+    # Format shortcuts - New in 1.3!
+    IMGKit.new("hello").to_jpg
+    IMGKit.new("hello").to_jpeg
+    IMGKit.new("hello").to_png
+    IMGKit.new("hello").to_tif
+    IMGKit.new("hello").to_tiff
 ## Configuration
-If you're on Windows or you installed wkhtmltoimage by hand to a location other than /usr/local/bin you will need to tell PDFKit where the binary is. You can configure PDFKit like so:
+If you're on Windows or you installed wkhtmltoimage by hand to a location other than /usr/local/bin you will need to tell IMGKit where the binary is. You can configure IMGKit like so:
     # config/initializers/imgkit.rb
     IMGKit.configure do |config|
@@ -47,9 +62,9 @@ If you're on Windows or you installed wkhtmltoimage by hand to a location other
       config.default_options = {
         :quality => 60
       }
+      config.default_format = :png
     end
 ## Rails
 ### Mime Types
@@ -58,11 +73,31 @@ register a .jpg mime type in:
     #config/initializers/mime_type.rb
     Mime::Type.register       "image/jpeg", :jpg
+register a .png mime type in:
+    #config/initializers/mime_type.rb
+    Mime::Type.register       "image/png", :png
 ### Controller Actions
-You can then send JPGs with
+You can respond in a controller with:
+    @kit = IMGKit.new(render_as_string)
     format.jpg do
-      send_data(@kit.to_img, :type => "image/jpeg", :disposition => 'inline')
+      send_data(@kit.to_jpg, :type => "image/jpeg", :disposition => 'inline')
+    end
+    - or -
+    format.png do
+      send_data(@kit.to_png, :type => "image/png", :disposition => 'inline')
+    end
+    - or -
+    respond_to do |format|
+      send_data(@kit.to_img(format.to_sym),
+                :type => "image/png", :disposition => 'inline')
     end
 This allows you to take advantage of rails page caching so you only generate the

data/Rakefile CHANGED

@@ -1,2 +1,15 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+Bundler.require
+require 'rspec/core/rake_task'
+desc 'Default: run specs.'
+task :default => :spec
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
+end
+task :specs => :spec

data/lib/imgkit/configuration.rb CHANGED

@@ -1,11 +1,12 @@
 class IMGKit
   class Configuration
-    attr_accessor :meta_tag_prefix, :wkhtmltoimage, :default_options
+    attr_accessor :meta_tag_prefix, :wkhtmltoimage, :default_options, :default_format
     def initialize
       @meta_tag_prefix = 'imgkit-'
-      @wkhtmltoimage = '/usr/local/bin/wkhtmltoimage'
+      @wkhtmltoimage   = '/usr/local/bin/wkhtmltoimage'
       @default_options = {}
+      @default_format  = :jpg
     end
   end

data/lib/imgkit/imgkit.rb CHANGED

@@ -1,4 +1,5 @@
 class IMGKit
+  KNOWN_FORMATS = [:jpg, :jpeg, :png, :tiff, :tif]
   class NoExecutableError < StandardError
     def initialize
@@ -22,6 +23,12 @@ class IMGKit
       super("Command failed: #{command}: #{stderr}")
     end
   end
+  class UnknownFormatError < StandardError
+    def initialize(format)
+      super("Unknown Format: #{format}")
+    end
+  end
   attr_accessor :source, :stylesheets
   attr_reader :options
@@ -33,14 +40,13 @@ class IMGKit
     @options = IMGKit.configuration.default_options.merge(options)
     @options.merge! find_options_in_meta(url_file_or_html) unless source.url?
-    @options = normalize_options(@options)
     raise NoExecutableError.new unless File.exists?(IMGKit.configuration.wkhtmltoimage)
   end
   def command
     args = [executable]
-    args += @options.to_a.flatten.compact
+    args += normalize_options(@options).to_a.flatten.compact
     if @source.html?
       args << '-' # Get HTML from stdin
@@ -62,8 +68,9 @@ class IMGKit
     end
   end
-  def to_img
+  def to_img(format = nil)
     append_stylesheets
+    set_format(format)
     result = nil
     stderr_output = nil
@@ -71,6 +78,7 @@ class IMGKit
       stdin << (@source.to_s) if @source.html?
       stdin.close
       result = stdout.gets(nil)
+      result.force_encoding("ASCII-8BIT") if result.respond_to? :force_encoding
       stderr_output = stderr.readlines.join
       stdout.close
       stderr.close
@@ -81,7 +89,17 @@ class IMGKit
   end
   def to_file(path)
-    File.open(path,'w') {|file| file << self.to_img}
+    format = File.extname(path).gsub(/^\./,'').to_sym
+    set_format(format)
+    File.open(path,'w:ASCII-8BIT') {|file| file << self.to_img}
+  end
+  def method_missing(name, *args, &block)
+    if(m = name.to_s.match(/^to_(\w+)/))
+      self.send(:to_img, m[1].to_sym)
+    else
+      super
+    end
   end
   protected
@@ -146,5 +164,10 @@ class IMGKit
         value.to_s
       end
     end
+    def set_format(format)
+      format = IMGKit.configuration.default_format unless format
+      @options.merge!(:format => format.to_s) unless @options[:format]
+      raise UnknownFormatError.new(format) unless KNOWN_FORMATS.include?(@options[:format].to_sym)
+    end
 end

data/lib/imgkit/version.rb CHANGED

@@ -1,3 +1,3 @@
 class IMGKit
-  VERSION = "1.2.1"
+  VERSION = "1.3.0"
 end

data/spec/imgkit_spec.rb CHANGED

@@ -21,11 +21,6 @@ describe IMGKit do
       imgkit.source.to_s.should == file_path
     end
-    it "should parse the options into a cmd line friedly format" do
-      imgkit = IMGKit.new('html', :quality => 75)
-      imgkit.options.should have_key('--quality')
-    end
     it "should provide no default options" do
       imgkit = IMGKit.new('<h1>Oh Hai</h1>')
       imgkit.options.should be_empty
@@ -49,13 +44,17 @@ describe IMGKit do
       imgkit.command[0].should include('wkhtmltoimage')
       imgkit.command.should include('-')
     end
+    it "should parse the options into a cmd line friedly format" do
+      imgkit = IMGKit.new('html', :quality => 75)
+      imgkit.command.should include('--quality')
+    end
     it "will not include default options it is told to omit" do
       imgkit = IMGKit.new('html')
       imgkit = IMGKit.new('html', :disable_smart_shrinking => false)
       imgkit.command.should_not include('--disable-smart-shrinking')
     end
     it "should encapsulate string arguments in quotes" do
       imgkit = IMGKit.new('html', :header_center => "foo [page]")
       imgkit.command[imgkit.command.index('--header-center') + 1].should == 'foo [page]'
@@ -98,7 +97,7 @@ describe IMGKit do
     end
   end
-  context "#to_img" do
+  context "#to_img(format = nil)" do
     def filetype_of(img)
       result = nil
       tmpfile = Tempfile.new('imgkit')
@@ -150,9 +149,71 @@ describe IMGKit do
     end
     it "should throw an error if the wkhtmltoimage command fails" do
-      imgkit = IMGKit.new('http://www.hopefully.this.site.never.exists.asjdhjkalshgflkahfsglkahfdlg11.com')
+                                    #stdin        #stdout       #stderr
+      Open3.stub(:popen3).and_yield(StringIO.new, StringIO.new, StringIO.new("This failed, dude"))
+      imgkit = IMGKit.new('http://www.example.com')
       lambda { imgkit.to_img }.should raise_error(IMGKit::CommandFailedError)
     end
+    context "when there is no format" do
+      it "should fallback to jpg" do
+        IMGKit.new("Hello, world").to_img.should be_a(:jpg)
+      end
+      context "when a default_format has been configured" do
+        before do
+          IMGKit.configure do |config|
+            config.default_format = :png
+          end
+        end
+        after do
+          IMGKit.configure do |config|
+            config.default_format = :jpg
+          end
+        end
+        it "should use the configured format" do
+          IMGKit.new("Oh hai!").to_img.should be_a(:png)
+        end
+      end
+    end
+    context "when format = :jpg" do
+      it "should create a jpg" do
+        IMGKit.new("Hello, world").to_img(:jpg).should be_a(:jpg)
+      end
+    end
+    context "when format is a known format" do
+      it "should create an image with that format" do
+        IMGKit::KNOWN_FORMATS.each do |format|
+          IMGKit.new("Hello, world").to_img(format).should be_a(format)
+        end
+      end
+    end
+    context "when format is unknown" do
+      it "should raise an UnknownFormatError" do
+        lambda { IMGKit.new("Hello, world").to_img(:blah) }.should raise_error(IMGKit::UnknownFormatError)
+      end
+    end
+  end
+  context "#to_<known_format>" do
+    IMGKit::KNOWN_FORMATS.each do |format|
+      describe "#to_#{format}" do
+        it "should create a #{format}" do
+          IMGKit.new("Hello").send("to_#{format}").should be_a(format)
+        end
+      end
+    end
+  end
+  context "#to_<unkown_format>" do
+    it "should raise and UnknownFormatError" do
+      lambda { IMGKit.new("Hello, world").to_blah }.should raise_error(IMGKit::UnknownFormatError)
+    end
   end
   context "#to_file" do
@@ -162,7 +223,7 @@ describe IMGKit do
     end
     after do
-      File.delete(@file_path)
+      File.delete(@file_path) if File.exist?(@file_path)
     end
     it "should create a file with the result of :to_img  as content" do
@@ -172,6 +233,29 @@ describe IMGKit do
       file.should be_instance_of(File)
       File.read(file.path).should == 'CONTENT'
     end
+    IMGKit::KNOWN_FORMATS.each do |format|
+      it "should use the extension #{format} as the format" do
+        @file_path = File.join(SPEC_ROOT,'fixtures',"test.#{format}")
+        imgkit = IMGKit.new('html', :quality => 50)
+        file = imgkit.to_file(@file_path)
+        file.should be_instance_of(File)
+        File.open(file.path, "r:ASCII-8BIT") { |f| f.read.should be_a(format) }
+      end
+    end
+    it "should raise UnknownFormatError when format is unknown" do
+      kit = IMGKit.new("html")
+      lambda {
+        kit.to_file("file.bad_format")
+      }.should raise_error(IMGKit::UnknownFormatError)
+    end
+    it "should not create the file if format is unknown" do
+      kit = IMGKit.new("html")
+      kit.to_file("file.bad_format") rescue nil
+      File.exist?("file.bad_format").should be_false
+    end
   end
   context "security" do

data/spec/spec_helper.rb CHANGED

@@ -9,11 +9,40 @@ require 'rack'
 require 'tempfile'
 RSpec.configure do |config|
   config.before do
     IMGKit.any_instance.stubs(:wkhtmltoimage).returns(
       File.join(SPEC_ROOT,'..','bin','wkhtmltoimage-proxy')
     )
   end
+end
+module MagicNumber
+  extend self
+  JPG  = "\xFF\xD8\xFF\xE0"
+  JPEG = JPG
+  PNG  = "\x89\x50\x4e\x47"
+  TIFF = "\x49\x49\x2a\x00"
+  TIF  = TIFF
+  GIF  = "\x47\x49\x46\x38"
+  if "".respond_to?(:force_encoding)
+    constants.each { |c| const_get(c).force_encoding("ASCII-8BIT")  }
+  end
+  def read(string)
+    string[0,4]
+  end
+end
+RSpec::Matchers.define :be_a do |expected|
+  match do |actual|
+    @expected = MagicNumber.const_get(expected.to_s.upcase)
+    MagicNumber.read(actual) == @expected
+  end
+  failure_message_for_should do |actual|
+    actual = MagicNumber.read(actual)
+    "expctected #{actual.inspect},#{actual.encoding} to equal #{@expected.inspect},#{@expected.encoding}"
+  end
 end

metadata CHANGED

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: imgkit
 version: !ruby/object:Gem::Version
-  prerelease: false
-  segments:
-  - 1
-  - 2
-  - 1
-  version: 1.2.1
+  prerelease:
+  version: 1.3.0
 platform: ruby
 authors:
 - csquared
@@ -14,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-05-20 00:00:00 -05:00
-default_executable:
+date: 2011-06-21 00:00:00 Z
 dependencies: []
 description: Uses wkhtmltoimage to create Images using HTML
@@ -49,7 +44,6 @@ files:
 - spec/imgkit_spec.rb
 - spec/source_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://rubygems.org/gems/imgkit
 licenses: []
@@ -72,6 +66,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
+      hash: 2095953912074654249
       segments:
       - 0
       version: "0"
@@ -80,13 +75,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      segments:
-      - 0
       version: "0"
 requirements: []
 rubyforge_project: imgkit
-rubygems_version: 1.3.7
+rubygems_version: 1.8.4
 signing_key:
 specification_version: 3
 summary: HTML+CSS -> JPG