phantomjs.rb 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b301765a3009c343d855a4a7fc373dbeaf1fdb1d
-  data.tar.gz: d9a337020722eb4f3d228253502668e4cc4b1f40
+  metadata.gz: 000928d55d632a0b8d414a17586f3ef38b351038
+  data.tar.gz: 8a6432fb658fe94b1488ded6e8a7d8462189a653
 SHA512:
-  metadata.gz: 765641c2ac1344df5808265990d192a25910d28240a6c8188a1cf50ab0cc1497003f27cd8cd8801f20f7dfbb43d7a70ca2da92fbc75889fcf6dbb910861ba8a6
-  data.tar.gz: 1c4d8c39817a207f91714b1039bc9db17a7b92fac2a5f30588886b313670f7e3489d29a5c896177d2ac3832c7df943f09aa7083b779eb7c39ca6c3fea29ca876
+  metadata.gz: 41f56b5d74730c4a62db1189330415a75ef2335d3dbec7ad63af30ab7c4fe6b216a0502296043f7a313f41626f8971d38a03278f255567b59281dbf547ec28bf
+  data.tar.gz: 55fad899048c39893f0a02f2e5d85e4e834a828192415ed7720b7a5dbd65937a94ab2885c2a87f957396cc375a2948fc46502baaebac81ec22bf7732c3497bf1

data/.gitignore

@@ -1,5 +1,5 @@
 .DS_Store
 *.gem
 .bundle
-Gemfile.lock
 pkg/*
+*.un~

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    phantomjs.rb (2.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.1)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  phantomjs.rb!
+  rake
+  rspec

data/README.md

@@ -18,6 +18,8 @@ gem install phantomjs.rb
 
 ### Pass a file
 
+Use `Phantomjs.run` to run the passed script file.
+
 ```js
 // my_runner.js
 var arg1 = phantom.args[0];
@@ -34,8 +36,9 @@ Phantomjs.run('my_runner.js', 'hello', 'world')
 
 ### Pass a script
 
-You can also pass a javascript string as an argument and the gem
-will create a temporary file for it and run the script.
+You can also pass a javascript string as an argument and call
+`Phantomjs.inline`. This will create a temporary file for it
+and run the script.
 
 NOTE: Just don't forget to call `phantom.exit`.
 
@@ -45,13 +48,14 @@ js = <<JS
   phantom.exit();
 JS
 
-Phantomjs.run(js, 'hello', 'world')
+Phantomjs.inline(js, 'hello', 'world')
 #=> 'hello world'
 ```
 
 ### But what about async scripts?
 
-Well it works for that too!
+Well it works for that too! Just pass a `block` to the method call and the
+argument will be whatever your script puts out on `stdout`.
 
 ```rb
 js = <<JS
@@ -74,6 +78,20 @@ end
     ctr is: 2
 ```
 
+## Configuring the path to phantomjs
+
+If you are using phantomjs in a non-typical installation path or are including the
+binary inside your application, you can configure phantomjs.rb to use a custom path.
+
+The following example is a good starting point to follow.
+
+```rb
+osx = Rails.env.development? || Rails.env.test?
+Phantomjs.configure do |config|
+  config.phantomjs_path = "#{Rails.root}/bin/phantomjs-#{osx ? 'osx' : 'x86'}"
+end
+```
+
 ## Running the tests
 
 ```

data/lib/phantomjs.rb

@@ -1,18 +1,26 @@
-require 'tempfile'
+require "tempfile"
+require "phantomjs/configuration"
 require "phantomjs/version"
-require 'phantomjs/errors'
+require "phantomjs/errors"
 
 class Phantomjs
-  EXEC = 'phantomjs'
 
-  def self.run(path, *args)
+  def self.run(path, *args, &block)
+    Phantomjs.new.run(path, *args, &block)
+  end
+
+  def run(path, *args)
     epath = File.expand_path(path)
     raise NoSuchPathError.new(epath) unless File.exist?(epath)
     block = block_given? ? Proc.new : nil
     execute(epath, args, block)
   end
 
-  def self.inline(script, *args)
+  def self.inline(script, *args, &block)
+    Phantomjs.new.inline(script, *args, &block)
+  end
+
+  def inline(script, *args)
     file = Tempfile.new('script.js')
     file.write(script)
     file.close
@@ -20,19 +28,31 @@ class Phantomjs
     execute(file.path, args, block)
   end
 
-  private
+  def self.configure(&block)
+    Configuration.configure(&block)
+  end
 
-  def self.execute(path, arguments, block)
+  private
+  
+  # Credit to github.com/alex88 for fixing the zombie process issue
+  def execute(path, arguments, block)
     begin
+      f = IO.popen([exec, path, arguments].flatten)
       if block
-        IO.popen([EXEC, path, arguments].flatten).each_line do |line|
+        result = f.each_line do |line|
           block.call(line)
         end
       else
-        IO.popen([EXEC, path, arguments].flatten).read
+        result = f.read
       end
+      f.close
+      result
     rescue Errno::ENOENT
       raise CommandNotFoundError.new('Phantomjs is not installed')
     end
   end
+
+  def exec
+    Phantomjs::Configuration.phantomjs_path
+  end
 end

data/lib/phantomjs/configuration.rb

@@ -0,0 +1,14 @@
+class Phantomjs
+  module Configuration
+    extend self
+
+    attr_accessor :phantomjs_path
+
+    Phantomjs::Configuration.phantomjs_path ||= 'phantomjs'
+
+    def configure
+      yield self
+    end
+
+  end
+end

data/lib/phantomjs/version.rb

@@ -1,3 +1,3 @@
 class Phantomjs
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/spec/configuration_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Phantomjs::Configuration do
+  describe ".configure" do
+    context "defaults" do
+      it "default path" do
+        expect(Phantomjs::Configuration.phantomjs_path).to eq('phantomjs')
+      end
+
+      context "with custom settings" do
+        before { Phantomjs.configure { |config| config.phantomjs_path = '/bin/phantomjs' } }
+
+        it "custom path" do
+          expect(Phantomjs::Configuration.phantomjs_path).to eq('/bin/phantomjs')
+        end
+      end
+    end
+  end
+end

data/spec/phantomjs_spec.rb

@@ -1,10 +1,10 @@
-require 'phantomjs'
+require 'spec_helper'
 
 describe Phantomjs do
   describe ".run" do
     describe 'when phantomjs is non installed' do
-      before { Phantomjs::EXEC = 'not_existing_phantomjs' }
-      after  { Phantomjs::EXEC = 'phantomjs' }
+      before { Phantomjs.configure { |config| config.phantomjs_path = 'not_existing_phantomjs' } }
+      after { Phantomjs.configure { |config| config.phantomjs_path = 'phantomjs' } }
 
       it "raises an error" do
         script = File.expand_path('./spec/runner.js')
@@ -24,16 +24,16 @@ describe Phantomjs do
     it "runs phantomjs binary with the correct arguments" do
       script = File.expand_path('./spec/runner.js')
       result = Phantomjs.run(script, 'foo1', 'foo2')
-      result.should eq("bar\nfoo1\nfoo2\n")
+      expect(result).to eq("bar\nfoo1\nfoo2\n")
     end
-    
+
     it "accepts a block that will get called for each line of output" do
       line = ''
       script = File.expand_path('./spec/runner.js')
       Phantomjs.run(script, 'foo1', 'foo2') do |l|
         line << l
       end
-      line.should eq("bar\nfoo1\nfoo2\n")
+      expect(line).to eq("bar\nfoo1\nfoo2\n")
     end
 
     it "accepts empty parameters" do
@@ -42,7 +42,7 @@ describe Phantomjs do
       Phantomjs.run(script, 'foo1', 'foo2', '') do |l|
         line << l
       end
-      line.should eq("bar\nfoo1\nfoo2\n\n")
+      expect(line).to eq("bar\nfoo1\nfoo2\n\n")
     end
 
     it "accepts parameters with spaces" do
@@ -51,33 +51,33 @@ describe Phantomjs do
       Phantomjs.run(script, 'foo bar', 'foo2') do |l|
         line << l
       end
-      line.should eq("bar\nfoo bar\nfoo2\n")
+      expect(line).to eq("bar\nfoo bar\nfoo2\n")
     end
 
     it "accepts empty parameters without block" do
       script = File.expand_path('./spec/runner.js')
       output = Phantomjs.run(script, 'foo1', 'foo2', '')
-      output.should eq("bar\nfoo1\nfoo2\n\n")
+      expect(output).to eq("bar\nfoo1\nfoo2\n\n")
     end
 
     it "accepts parameters with spaces without block" do
       script = File.expand_path('./spec/runner.js')
       output = Phantomjs.run(script, 'foo bar', 'foo2')
-      output.should eq("bar\nfoo bar\nfoo2\n")
+      expect(output).to eq("bar\nfoo bar\nfoo2\n")
     end
   end
 
-  describe '.inline' do
-    it 'accepts and runs a script as an argument' do
+  describe ".inline" do
+    it "accepts and runs a script as an argument" do
       js = %q(
         console.log(phantom.args[0]);
         phantom.exit();
       )
       result = Phantomjs.inline(js, 'works!')
-      result.should eq("works!\n")
+      expect(result).to eq("works!\n")
     end
 
-    it 'accepts a block as an argument' do
+    it "accepts a block as an argument" do
       js = %q(
         ctr = 0;
         setInterval(function() {
@@ -90,11 +90,11 @@ describe Phantomjs do
         console.log('running interval')
       )
       expected = "running interval\nctr is 0\nctr is 1\nctr is 2\n"
-      str = '';
-      result = Phantomjs.inline(js) do |line|
+      str = "";
+      Phantomjs.inline(js) do |line|
         str << line
       end
-      str.should eq(expected)
+      expect(str).to match(expected)
     end
   end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'phantomjs'
+
+RSpec.configure do |config|
+  config.after(:each) do
+    Phantomjs.configure { |cfg| cfg.phantomjs_path = 'phantomjs' }
+  end
+end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: phantomjs.rb
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - William Estoque
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-06 00:00:00.000000000 Z
+date: 2015-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby wrapper for phantomjs
@@ -45,20 +45,24 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .autotest
-- .gitignore
-- .travis.yml
+- ".autotest"
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG
 - Gemfile
+- Gemfile.lock
 - MIT-LICENSE
 - README.md
 - Rakefile
 - lib/phantomjs.rb
+- lib/phantomjs/configuration.rb
 - lib/phantomjs/errors.rb
 - lib/phantomjs/version.rb
 - phantomjs.rb.gemspec
+- spec/configuration_spec.rb
 - spec/phantomjs_spec.rb
 - spec/runner.js
+- spec/spec_helper.rb
 homepage: http://westoque.com
 licenses: []
 metadata: {}
@@ -68,20 +72,22 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: phantomjs.rb
-rubygems_version: 2.0.3
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for phantomjs
 test_files:
+- spec/configuration_spec.rb
 - spec/phantomjs_spec.rb
 - spec/runner.js
+- spec/spec_helper.rb