gs-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 710d42cff4fab03289dec94206bb93fa01e1cc95
+  data.tar.gz: 5852d0e75787dc52e2b0adc69abb2e2ab1ccbdd7
+SHA512:
+  metadata.gz: 4641486100cf060cea46ab15848f9765284c9bd23f74dcccb1f5fd324a0173395eb28e1360121cb10e5485c05960a17fae29642958503430a7bed3ae1b9f2e08
+  data.tar.gz: dffd54e534ded3783bbcc776b73a5879618a762265c9efc7845f3fae6d1f0c0ad73a7f0a8351c141d284a7a16c20cbcaf712a095f4281a1098402bbf5042a491

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/FileName:
+  Exclude:
+    - 'lib/gs-ruby.rb'
+    - 'spec/gs-ruby_spec.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.13.7

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+ruby '2.4.0'
+
+# Specify your gem's dependencies in gs-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Lawrance Shepstone
+
+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,81 @@
+# GS Ruby
+
+Simple wrapper for the [Ghostscript](https://www.ghostscript.com/) command – it's assumed that you have the `gs` command installed.
+
+**Note:** This was developed against version _9.20_ of the Ghostscript command and is a work-in-progress. No doubt there are some issues (perhaps even major ones – namespacing, for instance?).
+
+For more detailed documentation, take a look at the source docs – http://www.rubydoc.info/github/lshepstone/gs-ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gs-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gs-ruby
+
+## Usage
+
+Typical usage might look like:
+
+```ruby
+GS.run('input.ps', GS::OUTPUT_FILE => 'output.pdf')
+```
+
+Or using a block to work with the command before it's run:
+
+```ruby
+GS.run('input.ps') do |command|
+  command.option(GS::OUTPUT_FILE, 'output.pdf')
+end
+```
+
+#### Configuration
+
+Global configuration is possible:
+
+```ruby
+GS.configure do |config|
+  # ...
+end
+```
+
+#### Logging
+
+By default all output is logged to `$stdout`, but the logger can be configured:
+
+```ruby
+# For a single command instance.
+GS.run('input.ps') do |command|
+  # command.logger =
+end
+
+# For all command instances.
+GS.configure do |config|
+  # config.logger =
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lshepstone/gs-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+Copyright (c) 2017 Lawrance Shepstone

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'gs-ruby'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/rake

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gs-ruby.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gs-ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gs-ruby'
+  spec.version       = GS::VERSION
+  spec.authors       = ['Lawrance Shepstone']
+  spec.email         = ['lawrance.shepstone@gmail.com']
+
+  spec.summary       = 'GS-Ruby'
+  spec.description   = 'Simple wrapper for the Ghostscript command'
+  spec.homepage      = 'https://github.com/lshepstone/gs-ruby'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 0'
+end

data/lib/gs-ruby.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+require 'gs-ruby/command'
+require 'gs-ruby/configuration'
+require 'gs-ruby/options'
+require 'gs-ruby/version'
+
+# GS Ruby is a simple wrapper for the Ghostscript command - it's assumed
+# that you have the +gs+ command already installed.
+#
+# == Usage
+#
+# Typical usage might look like:
+#
+#    GS.run('input.ps', GS::OUTPUT_FILE => 'output.pdf')
+#
+# Or using a block to work with the command before it's run:
+#
+#    GS.run('input.ps') do |command|
+#      command.option(GS::OUTPUT_FILE, 'output.pdf')
+#    end
+#
+# == Configuration
+#
+# Global configuration is possible:
+#
+#    GS.configure do |config|
+#      config.bin_path = '/path/to/gs'
+#    end
+#
+# == Logging
+#
+# By default all output is logged to +$stdout+, but the logger can be
+# configured:
+#
+#    # For a single command instance.
+#    GS.run('input.ps') do |command|
+#      command.logger = # ...
+#    end
+#
+#    # For all command instances.
+#    GS.configure do |config|
+#      config.logger = # ...
+#    end
+#
+# @see GS.run
+# @see GS.configure
+module GS
+  include Options
+
+  module_function
+
+  # Gets the configuration object.
+  #
+  # If none was set, a new configuration object is instantiated and returned.
+  #
+  # @return [Configuration] the configuration object
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+  # Allows for configuring the library using a block.
+  #
+  # @example Configuration using a block
+  #   GS.configure do |config|
+  #     # ...
+  #   end
+  def configure
+    yield(configuration) if block_given?
+  end
+
+  # Instantiates a new command object with any provided options and runs it
+  # with the provided input.
+  #
+  # @example Run a new command with options
+  #   GS.run('input.ps', GS::OUTPUT_FILE => 'output.pdf')
+  #
+  # @example Configure and run a new command
+  #   GS.run('path/to/input/file.ps') do |command|
+  #     command.option(GS::OUTPUT_FILE, 'output.pdf')
+  #   end
+  #
+  # @return [Process::Status] describing the result of running the command
+  #
+  # @see Command#option
+  # @see Command#run
+  def run(input, options = {})
+    command = Command.new(options: options)
+    yield(command) if block_given?
+    command.run(input)
+  end
+end

data/lib/gs-ruby/command.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+require 'open3'
+
+module GS
+  # Command object for running a command with various options.
+  #
+  # * This is usually not instantiated directly, but rather by way of
+  #   calling +GS.run+.
+  class Command
+    attr_reader :configuration,
+                :options
+
+    attr_accessor :logger
+
+    # Initializes a new command instance.
+    #
+    # * If no configuration object is passed or is +nil+, the value of
+    #   +GS.configuration+ is used as the configuration object
+    #
+    # * Any options passed are merged with +GS.configuration.default_options+
+    #   so that any option can be deleted if necessary
+    #
+    # * If no logger object is passed or is +nil+, the value of
+    #   +GS.configuration.logger+ is used as the logger object
+    #
+    # @param [Configuration] configuration the configuration object
+    # @param [Hash] options the key-value pairs of command options
+    # @param [Logger] logger the logger object
+    def initialize(configuration: nil, options: {}, logger: nil)
+      @configuration = configuration || GS.configuration
+      @options = @configuration.default_options.merge(options)
+      @logger = logger || @configuration.logger
+    end
+
+    # Sets a command option with an optional value.
+    #
+    # * If a value is passed, the resulting switch will be in the form
+    #   +-sName=Value+. If no value is passed, the resulting switch will be
+    #   in the form +-dName+.
+    #
+    # @param name [String] the name of the option
+    # @param value [Object] the value of the option
+    def option(name, value = nil)
+      options[name] = value
+    end
+
+    # Executes the command with the specified input.
+    #
+    # @param [String] inputs the input arguments to the command
+    #
+    # @return [Process::Status] describing the result of running the command
+    def run(inputs)
+      command = "#{configuration.bin_path} #{build_switches} #{inputs}"
+
+      status = nil
+      logger.info(command)
+      Open3.popen2e(command) do |_, stdout_and_stderr, wait_thr|
+        logger.info(stdout_and_stderr.read)
+        status = wait_thr.value
+      end
+
+      status
+    end
+
+    private
+
+    def build_switches
+      options
+        .map { |(n, v)| v ? "-s#{n}=#{v}" : "-d#{n}" }
+        .join(' ')
+    end
+  end
+end

data/lib/gs-ruby/configuration.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+require 'logger'
+
+module GS
+  # A configuration object used to define the path to the Ghostscript command,
+  # any default options and the logger that should be used.
+  #
+  # * This is usually not instantiated directly, but rather by way of
+  #   calling +GS.configure+.
+  class Configuration
+    attr_writer :bin_path,
+                :default_options,
+                :logger
+
+    # Gets the bin path to the Ghostscript command.
+    #
+    # * If no path has been set, it returns +'gs'+ as the default.
+    #
+    # @return [String] the path to the Ghostscript command
+    def bin_path
+      @bin_path ||= 'gs'
+    end
+
+    # Gets the default options.
+    #
+    # * If no default options have been set, it returns a set of options
+    #   where +GS::BATCH+ is set by default.
+    #
+    # @example Configuring a default option that requires a value
+    #   GS.configure do |config|
+    #     # Results in the switch -sProcessColorModel=DeviceCMYK
+    #     config.default_options[GS::PROCESS_COLOR_MODEL] = 'DeviceCMYK'
+    #   end
+    #
+    # @example Configuring a default option that does not require a value
+    #   GS.configure do |config|
+    #     # Results in the switch -dNOPAUSE
+    #     config.default_options[GS::NO_PAUSE] = nil
+    #   end
+    #
+    # @example Removing a default option that already exists
+    #   GS.configure do |config|
+    #     # Currently, GS::BATCH is the only option configured by default.
+    #     # Not sure why you might want to remove it, but if you do, simply
+    #     # delete it from the options Hash - same goes for any other option.
+    #     config.default_options.delete(GS::BATCH)
+    #   end
+    #
+    # @return [Hash] the default options and their values
+    #
+    # @see Command#option
+    def default_options
+      @default_options ||= { GS::BATCH => nil }
+    end
+
+    # Gets the logger object.
+    #
+    # * If no logger has been set, it instantiates and returns a new logger
+    #   configured to log to +$stdout+.
+    #
+    # @return [Logger] the logger instance used for logging
+    def logger
+      @logger ||= Logger.new($stdout).tap do |logger|
+        logger.progname = bin_path
+      end
+    end
+  end
+end

data/lib/gs-ruby/options.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module GS
+  module Options
+    PDFA                      = 'PDFA'
+    BATCH                     = 'BATCH'
+    NO_PAUSE                  = 'NOPAUSE'
+    DEVICE                    = 'DEVICE'
+    PROCESS_COLOR_MODEL       = 'ProcessColorModel'
+    PDFA_COMPATIBILITY_POLICY = 'PDFACompatibilityPolicy'
+    OUTPUT_FILE               = 'OutputFile'
+  end
+end

data/lib/gs-ruby/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module GS
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: gs-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lawrance Shepstone
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: rubocop-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'
+description: Simple wrapper for the Ghostscript command
+email:
+- lawrance.shepstone@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/rspec
+- bin/setup
+- gs-ruby.gemspec
+- lib/gs-ruby.rb
+- lib/gs-ruby/command.rb
+- lib/gs-ruby/configuration.rb
+- lib/gs-ruby/options.rb
+- lib/gs-ruby/version.rb
+homepage: https://github.com/lshepstone/gs-ruby
+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.6.8
+signing_key: 
+specification_version: 4
+summary: GS-Ruby
+test_files: []