phantomrb 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b54fa3a557ec73d390581fcf4febfb2ed1f4b5c
+  data.tar.gz: c45cc805ec80e938b75e992d8288e48c31d8db00
+SHA512:
+  metadata.gz: fda6335854d7d49aa24c25fb1fa399e30cf72d6fd78f4d93c76d5a6c66cbd2309a3ec7f6feb7d1dc0593649e6bfeba4f975a586d9371de22c9492f47addb9777
+  data.tar.gz: c7a06efe3caf53ea840d2c19a41920bce354bf51703f371757754d457bf3f3f8eecb0bea513033e59019265eb91726954eb39bfa78bfa120290dadfcf2c5f91d

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg
+.idea
+.DS_Store
+doc
+.yardoc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in phantomrb.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andrei Gladkyi
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,95 @@
+# Phantomrb
+
+An interface with PhantomJS for Ruby.
+
+## Dependencies
+
+[PhantomJS](http://phantomjs.org) must be installed on your system.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'phantomrb'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install phantomrb
+
+## Usage
+
+### Simple
+
+    Phantomrb.run('/path/to/script', arg1, arg2, ...)
+
+### With block
+
+    Phantomrb.run('/path/to/script', arg1, arg2, ...) { |line| ... }
+
+### Notes
+
+* Path can be absolute or relative to app directory.
+* All arguments are optional.
+* If block is specified it will be called with each line from PhantomJS stdout.
+
+### Example
+
+    // echo.js
+    for (var i = 0; i < phantom.args.length; i++) {
+        console.log(phantom.args[i]);
+    }
+
+In your ruby code:
+
+    Phantomrb.run('echo.js', 'line one', 'line two') { |line| puts line }
+
+Will output:
+
+    test1
+    test2
+
+### Return value
+
+Phantomrb returns an OpenStruct object with following data:
+
+* `output` - full stdout from PhantomJS
+* `exit_status` - exit status code
+* `command_line` - full command line for PhantomJS
+
+## Configuration
+
+Phantomrb provides a way to define a list of command line options for PhantomJS.
+Create an initializer `config/initializers/phantomrb.rb` with following code:
+
+    Phantomrb.configure do
+      option '<parameter name>', <parameter value>
+    end
+
+### Example
+    # config/initializers/phantomrb.rb
+    Phantomrb.configure do
+      option 'load-images', false
+      option 'ignore-ssl-errors', true
+    end
+
+    Phantomrb.run('myscript.js', 'arg1', 'arg2')
+
+will run `phantomjs --load-images=false --ignore-ssl-errors=true /absolute/path/to/myscript.js arg1 arg2`
+
+More info about PhantomJS command line options you can found in [wiki](https://github.com/ariya/phantomjs/wiki/API-Reference#command-line-options).
+
+## License
+
+Licensed under the MIT license.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/phantomrb.rb

@@ -0,0 +1,46 @@
+require 'phantomrb/version'
+require 'phantomrb/errors'
+require 'phantomrb/configuration'
+require 'phantomrb/runner'
+
+module Phantomrb
+  class << self
+    # Returns the global configuration.
+    # @return [Object] configuration
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Yields the global configuration to a block.
+    # @yield global configuration
+    #
+    # @example
+    #     Phantomrb.configure do
+    #       parameter 'ignore-ssl-errors', true
+    #     end
+    def configure(&block)
+      configuration.instance_eval(&block) if block_given?
+    end
+
+    # Runs JavaScript file.
+    # @param script [String] path for a script
+    # @param args [String] script arguments
+    # @yieldparam line [String] line from stdout
+    # @return [OpenStruct] data
+    #   * <b>output</b> (String) --- full stdout from PhantomJS
+    #   * <b>exit_status</b> (Integer) --- exit status code
+    #   * <b>command_line</b> (String) --- full command line
+    #
+    # @example Simple output
+    #   puts Phantomrb.run('echo.js', 'test').output #=> "test"
+    #
+    # @example Each line separate output
+    #   Phantomrb.run('echo.js', 'test') do |line|
+    #     puts line #=> "test"
+    #   end
+    def run(script, *args, &block)
+      @runner ||= Runner.new
+      @runner.run(script, args, &block)
+    end
+  end
+end

data/lib/phantomrb/configuration.rb

@@ -0,0 +1,14 @@
+module Phantomrb
+  class Configuration
+    attr_reader :options, :executable
+
+    def initialize
+      @options = {}
+      @executable = 'phantomjs'
+    end
+
+    def option(key, value)
+      @options[key] = value
+    end
+  end
+end

data/lib/phantomrb/errors.rb

@@ -0,0 +1,7 @@
+module Phantomrb
+  class ExecutableLoadError < StandardError
+  end
+
+  class ScriptLoadError < StandardError
+  end
+end

data/lib/phantomrb/runner.rb

@@ -0,0 +1,48 @@
+require 'ostruct'
+
+module Phantomrb
+  class Runner
+    def initialize
+      config = Phantomrb.configuration
+      @command = config.options.reduce(config.executable) do |memo, (key, value)|
+        "#{memo} --#{key}=#{value}"
+      end
+    end
+
+    def run(script, *arguments, &block)
+      command_line = "#{@command} #{full_script_path(script)} #{arguments.join(' ')}"
+      begin
+        process = IO.popen(command_line)
+      rescue => e
+        raise ExecutableLoadError.new(e)
+      end
+      output = capture_output(process, &block)
+      process.close
+      OpenStruct.new(output: output, exit_status: $?.exitstatus, command_line: command_line)
+    end
+
+    private
+
+    def full_script_path(script)
+      full_script_path = File.expand_path(script)
+      if File.file?(full_script_path)
+        full_script_path
+      else
+        raise ScriptLoadError.new("#{full_script_path} not found")
+      end
+    end
+
+    def capture_output(process)
+      if block_given?
+        output = ''
+        process.each_line do |output_line|
+          output << output_line
+          yield(output_line)
+        end
+        output
+      else
+        process.read
+      end
+    end
+  end
+end

data/lib/phantomrb/version.rb

@@ -0,0 +1,3 @@
+module Phantomrb
+  VERSION = '1.0.0'
+end

data/phantomrb.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'phantomrb/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'phantomrb'
+  spec.version = Phantomrb::VERSION
+  spec.authors = ['Andrei Gladkyi']
+  spec.email = ['arg@arglabs.net']
+  spec.description = 'An interface with PhantomJS for Ruby.'
+  spec.summary = 'An interface with PhantomJS for Ruby.'
+  spec.homepage = 'https://github.com/agladkyi/phantomrb'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files`.split($/)
+  spec.test_files = spec.files.grep(/^spec\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '>= 2.0.0'
+end

data/spec/phantomrb_spec.rb

@@ -0,0 +1,73 @@
+describe Phantomrb do
+  let(:js_test_script) { 'spec/test.js' }
+
+  describe '::configure' do
+    before :all do
+      Phantomrb.configure do
+        option('ignore-ssl-errors', true)
+      end
+    end
+
+    it 'has the correct executable command' do
+      expect(Phantomrb.configuration.executable).to eq('phantomjs')
+    end
+
+    it 'allows to set parameters' do
+      expect(Phantomrb.configuration.options).to eq({ 'ignore-ssl-errors' => true })
+    end
+  end
+
+  describe '::run' do
+    describe Phantomrb::ExecutableLoadError do
+      before do
+        Phantomrb.configuration.instance_variable_set(:'@executable', 'sjmotnahp')
+        Phantomrb.instance_variable_set(:'@runner', nil)
+      end
+
+      after do
+        Phantomrb.configuration.instance_variable_set(:'@executable', 'phantomjs')
+        Phantomrb.instance_variable_set(:'@runner', nil)
+      end
+
+      it 'raises an exception if PhantomJS not found' do
+        expect { Phantomrb.run(js_test_script) }.to raise_exception(Phantomrb::ExecutableLoadError)
+      end
+    end
+
+    describe Phantomrb::ScriptLoadError do
+      it 'raises an exception if script file not found' do
+        expect { Phantomrb.run('none.js') }.to raise_exception(Phantomrb::ScriptLoadError)
+      end
+    end
+
+    describe 'Result object' do
+      subject { Phantomrb.run(js_test_script) }
+
+      it 'has correct type' do
+        expect(subject).to be_an(OpenStruct)
+      end
+
+      it 'contains the correct exit status code' do
+        expect(subject.exit_status).to eq(123)
+      end
+
+      it 'contains output string' do
+        expect(subject.output).to eq("test\n")
+      end
+
+      it 'contains command line string' do
+        expect(subject.command_line).to_not be_empty
+      end
+    end
+
+    it 'passes parameters to a script' do
+      expect(Phantomrb.run(js_test_script, 1, 2, 3).output).to eq("test\n1\n2\n3\n")
+    end
+
+    it 'invokes a block on each output line' do
+      output = ''
+      Phantomrb.run(js_test_script, 1, 2, 3) { |line| output << line }
+      expect(output).to eq("test\n1\n2\n3\n")
+    end
+  end
+end

data/spec/runner_spec.rb

@@ -0,0 +1,17 @@
+describe Phantomrb::Runner do
+  before :all do
+    Phantomrb.configure do
+      option('load-images', false)
+    end
+  end
+
+  it 'sets the correct executable command' do
+    runner = Phantomrb::Runner.new
+    expect(runner.instance_variable_get(:'@command')).to include('phantomjs')
+  end
+
+  it 'sets the correct command line parameters' do
+    runner = Phantomrb::Runner.new
+    expect(runner.instance_variable_get(:'@command')).to include('--load-images=false')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'phantomrb'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/test.js

@@ -0,0 +1,7 @@
+console.log('test');
+
+for (var i = 0; i < phantom.args.length; i++) {
+   console.log(phantom.args[i]);
+}
+
+phantom.exit(123);

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: phantomrb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andrei Gladkyi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: An interface with PhantomJS for Ruby.
+email:
+- arg@arglabs.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/phantomrb.rb
+- lib/phantomrb/configuration.rb
+- lib/phantomrb/errors.rb
+- lib/phantomrb/runner.rb
+- lib/phantomrb/version.rb
+- phantomrb.gemspec
+- spec/phantomrb_spec.rb
+- spec/runner_spec.rb
+- spec/spec_helper.rb
+- spec/test.js
+homepage: https://github.com/agladkyi/phantomrb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: 
+rubygems_version: 2.1.3
+signing_key: 
+specification_version: 4
+summary: An interface with PhantomJS for Ruby.
+test_files:
+- spec/phantomrb_spec.rb
+- spec/runner_spec.rb
+- spec/spec_helper.rb
+- spec/test.js