imgkit 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a763d2e0efa23649b3a27dbe8875dca656775ac
-  data.tar.gz: 35bf192ce0d2216784edc1bcba4f450e39209472
+  metadata.gz: b6db8c1811095b219f1f7a4fabf5c8cd17f1185e
+  data.tar.gz: 934d7ca922cf72789af64fb78c13e82721c8f8ed
 SHA512:
-  metadata.gz: d71932100236761f8aca8e4096a5ff82c64843c9a0e99af73d60662d1b6ba2f36788471b4891dc03bc68bbd5f9b564a3908e9605090bbdef3acd59a84220b7dc
-  data.tar.gz: b1af40d621be98930de9643ca70875c4cba298defc211c9acabe5a93ac00c6d648360060c1befc6fa64f459dcaeac77d0cbb071d9657d124e60c0f41c770d5d0
+  metadata.gz: 85fd2c927e505b17de2dd6d5f965fdf02e27d6a330a14fa2504e9518f46c5dbb7d5b595140557eb1da587bce7263d13d6b2a2a7a1d9d6f783d13053d2b303e46
+  data.tar.gz: 7eb58a359bbbe0ed8e7e8833f025f9a51a5d4b2bad9082ad12237dc75a64982e1757739fef9e675fb24a2b0af73c10323ed2f2236d9bee50cf2d5105e74ff786

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - "2.1.5"
+  - "2.1.4"
+  - "2.1.3"
+  - "2.1.2"
+  - "1.9.3"

data/Gemfile

@@ -8,6 +8,5 @@ group :test do
   gem "rspec-core", "~> 2"
   gem "mocha"
   gem "rack"
-  gem "ruby-debug19", :platforms => :mri_19
-  gem "ruby-debug", :platforms => :mri_18
+  gem 'wkhtmltoimage-binary'
 end

data/Gemfile.lock

@@ -1,22 +1,15 @@
 PATH
   remote: .
   specs:
-    imgkit (1.5.0)
+    imgkit (1.6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    archive-tar-minitar (0.5.2)
-    columnize (0.3.4)
     diff-lcs (1.1.2)
-    linecache (0.46)
-      rbx-require-relative (> 0.0.4)
-    linecache19 (0.5.12)
-      ruby_core_source (>= 0.1.4)
     mocha (0.9.12)
     rack (1.3.0)
     rake (0.9.2.2)
-    rbx-require-relative (0.0.5)
     rspec (2.6.0)
       rspec-core (~> 2.6.0)
       rspec-expectations (~> 2.6.0)
@@ -25,21 +18,7 @@ GEM
     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)
+    wkhtmltoimage-binary (0.12.1)
 
 PLATFORMS
   ruby
@@ -51,5 +30,4 @@ DEPENDENCIES
   rake
   rspec (~> 2)
   rspec-core (~> 2)
-  ruby-debug
-  ruby-debug19
+  wkhtmltoimage-binary

data/README.md

@@ -1,5 +1,7 @@
 # IMGKit
 
+<img src="https://travis-ci.org/csquared/IMGKit.svg?branch=master" />
+
 Create JPGs using plain old HTML+CSS. Uses [wkhtmltoimage](http://github.com/antialize/wkhtmltopdf) on the backend which renders HTML using Webkit.
 
 Heavily based on [PDFKit](http://github.com/jdpace/pdfkit/).
@@ -11,10 +13,14 @@ Heavily based on [PDFKit](http://github.com/jdpace/pdfkit/).
     gem install imgkit
 
 ### wkhtmltoimage
- * **Automatic**: `sudo imgkit --install-wkhtmltoimage`
+ 1. Use installer: `sudo imgkit --install-wkhtmltoimage`
  install latest version into /usr/local/bin
  (overwrite defaults with e.g. ARCHITECTURE=amd64 TO=/home/foo/bin)
- * By hand: http://code.google.com/p/wkhtmltopdf/downloads/list
+ 2. Install by hand: [http://wkhtmltopdf.org/downloads.html](http://wkhtmltopdf.org/downloads.html)
+ 3. Try using the `wkhtmltoimage-binary` gem (mac + linux)
+```
+gem install wkhtmltoimage-binary
+```
 
 ## Usage
 
@@ -22,6 +28,7 @@ Heavily based on [PDFKit](http://github.com/jdpace/pdfkit/).
     # run `wkhtmltoimage --extended-help` for a full list of options
     kit = IMGKit.new(html, :quality => 50)
     kit.stylesheets << '/path/to/css/file'
+    kit.javascripts << '/path/to/js/file'
 
     # Get the image BLOB
     img = kit.to_img
@@ -36,7 +43,7 @@ Heavily based on [PDFKit](http://github.com/jdpace/pdfkit/).
     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.
+    # Stylesheets nor Javascripts can not be added when source is provided as a URL of File.
     kit = IMGKit.new('http://google.com')
     kit = IMGKit.new(File.new('/path/to/html'))
 
@@ -245,20 +252,7 @@ Contributed by @ticktricktrack
 
 ## Testing
 
-Make sure the tests pass in the following ruby versions:
-
-  - 1.8.7-p370
-  - 1.9.2-p290
-  - 1.9.3-p194
-
-You can simply
-
-    $ rbenv-install <version>
-    $ rbenv shell <version>
-    $ bundle
-    $ bundle exec rake
-
-For each version
+Travis.yml is configured for multiple rubies, so I would just test a 2.1.x version and let travis handle the rest.
 
 ## Copyright
 

data/lib/imgkit/imgkit.rb

@@ -30,13 +30,14 @@ class IMGKit
     end
   end
 
-  attr_accessor :source, :stylesheets
+  attr_accessor :source, :stylesheets, :javascripts
   attr_reader :options
 
   def initialize(url_file_or_html, options = {})
     @source = Source.new(url_file_or_html)
 
     @stylesheets = []
+    @javascripts = []
 
     @options = IMGKit.configuration.default_options.merge(options)
     @options.merge! find_options_in_meta(url_file_or_html) unless source.url?
@@ -102,6 +103,7 @@ class IMGKit
 
   def to_img(format = nil)
     append_stylesheets
+    append_javascripts
     set_format(format)
 
     opts = @source.html? ? {:stdin_data => @source.to_s} : {}
@@ -151,6 +153,14 @@ class IMGKit
       "<style>#{stylesheet.respond_to?(:read) ? stylesheet.read : File.read(stylesheet)}</style>"
     end
 
+    def script_tag_for(javascript)
+      if javascript.respond_to?(:read)
+        "<script>#{javascript.read}</script>"
+      else
+        "<script src=\"#{javascript}\" type=\"text/javascript\"></script>"
+      end
+    end
+
     def append_stylesheets
       raise ImproperSourceError.new('Stylesheets may only be added to an HTML source') if stylesheets.any? && !@source.html?
 
@@ -163,6 +173,18 @@ class IMGKit
       end
     end
 
+    def append_javascripts
+      raise ImproperSourceError.new('Javascripts may only be added to an HTML source') if javascripts.any? && !@source.html?
+
+      javascripts.each do |javascript|
+        if @source.to_s.match(/<\/head>/)
+          @source.to_s.gsub!(/(<\/head>)/, script_tag_for(javascript)+'\1')
+        else
+          @source.to_s.insert(0, script_tag_for(javascript))
+        end
+      end
+    end
+
     def normalize_options(options)
       normalized_options = {}
 

data/lib/imgkit/version.rb

@@ -1,3 +1,3 @@
 class IMGKit
-  VERSION = "1.5.0"
+  VERSION = "1.6.0"
 end

data/spec/fixtures/example.js

@@ -0,0 +1 @@
+console.log('Yay!');

data/spec/imgkit_spec.rb

@@ -163,6 +163,37 @@ describe IMGKit do
       lambda { imgkit.to_img }.should raise_error(IMGKit::ImproperSourceError)
     end
 
+    it "should have the script added to the head if it has one" do
+      imgkit = IMGKit.new("<html><head></head><body>Hai!</body></html>")
+      js = File.join(SPEC_ROOT,'fixtures','example.js')
+      imgkit.javascripts << js
+      imgkit.to_img
+      imgkit.source.to_s.should include("<script src=\"#{js}\" type=\"text/javascript\"></script>")
+    end
+
+    it "should accept script as an object which responds to #read" do
+      imgkit = IMGKit.new("<html><head></head><body>Hai!</body></html>")
+      js = StringIO.new( File.read(File.join(SPEC_ROOT,'fixtures','example.js')) )
+      imgkit.javascripts << js
+      imgkit.to_img
+      imgkit.source.to_s.should include("<script>#{js.string}</script>")
+    end
+
+    it "should prepend script tags if the HTML doesn't have a head tag" do
+      imgkit = IMGKit.new("<html><body>Hai!</body></html>")
+      js = File.join(SPEC_ROOT,'fixtures','example.js')
+      imgkit.javascripts << js
+      imgkit.to_img
+      imgkit.source.to_s.should include("<script src=\"#{js}\" type=\"text/javascript\"></script>")
+    end
+
+    it "should throw an error if the source is not html and script have been added" do
+      imgkit = IMGKit.new('http://google.com')
+      js = File.join(SPEC_ROOT,'fixtures','example.js')
+      imgkit.javascripts << js
+      lambda { imgkit.to_img }.should raise_error(IMGKit::ImproperSourceError)
+    end
+
     def set_wkhtmltoimage_binary(binary)
       spec_dir = File.dirname(__FILE__)
       IMGKit.configuration.should_receive(:wkhtmltoimage).at_least(1).times.and_return(File.join(spec_dir, binary))

data/spec/spec_helper.rb

@@ -9,9 +9,7 @@ require 'rack'
 
 RSpec.configure do |config|
   config.before do
-    IMGKit.any_instance.stubs(:wkhtmltoimage).returns(
-      File.join(SPEC_ROOT,'..','bin','wkhtmltoimage-proxy')
-    )
+    IMGKit.any_instance.stubs(:wkhtmltoimage).returns('bundle exec wkhtmltoimage')
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imgkit
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - csquared
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-07 00:00:00.000000000 Z
+date: 2014-12-17 00:00:00.000000000 Z
 dependencies: []
 description: Uses wkhtmltoimage to create Images using HTML
 email: christopher.continanza@gmail.com
@@ -21,6 +21,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rvmrc"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -38,6 +39,7 @@ files:
 - spec/error_binary
 - spec/fixtures/example.css
 - spec/fixtures/example.html
+- spec/fixtures/example.js
 - spec/imgkit_spec.rb
 - spec/source_spec.rb
 - spec/spec_helper.rb
@@ -82,6 +84,7 @@ test_files:
 - spec/error_binary
 - spec/fixtures/example.css
 - spec/fixtures/example.html
+- spec/fixtures/example.js
 - spec/imgkit_spec.rb
 - spec/source_spec.rb
 - spec/spec_helper.rb