inkscape_cli 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ae27b1a9b4ac0dc176a208e9d920be8cd546b8bf7d5d1b1acbcee201723f7c65
+  data.tar.gz: 5e7dff339cef1addadb37e8dcac4f536fd5b611b60d9542bbe79e0bb61df0ac7
+SHA512:
+  metadata.gz: bdea31313fbbe64747e9f7240dbf40c4a92d4a8061fae0c4bb77aff810d342c273128556e1a97ca07754ebe7230d905b66f52c35f8c41cdef01e54a377b4cb8e
+  data.tar.gz: 3b5b9fbd1f333f508f2ea8837bf58c40f231f446221326a96389fb45cfd4ab0da16ef4efeeb5ce61b940904499eb047b460f79b6f00a1b76c76d2f03458b3098

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [1.0.0] - 2023-04-17
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in inkscape_cli.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '~> 1.21'

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    inkscape_cli (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    parallel (1.22.1)
+    parser (3.2.1.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.48.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  inkscape_cli!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.3.20

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Marco Adkins
+
+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,52 @@
+# InkscapeCLI
+Simple ruby wrapper for inkscape cli
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add inkscape_cli
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install inkscape_cli
+
+## Usage
+```ruby
+require 'inkscape_cli'
+
+command = InkscapeCLI::Command.new
+command.input_file = 'input.svg'
+command.export_width(500)
+command.export_filename('out.png')
+command.execute
+
+InkscapeCLI::Command.new.input_file('input.svg').export_filename('out.png').execute
+
+InkscapeCLI::Command.new do |command|
+  command.input_file = 'input.svg'
+  command.export_filename = 'out.png'
+end
+```
+
+## Configuration
+```ruby
+InkscapeCLI.configure do |config|
+  config.executable = 'inkscape'
+  config.timeout = 300
+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 the created tag, 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/marcoadkins/inkscape_cli.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/inkscape_cli/command.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module InkscapeCLI
+  class Command
+    attr_reader :executable, :args, :timeout
+
+    def self.new(*args)
+      instance = super(*args)
+
+      if block_given?
+        yield instance
+        instance.execute
+      else
+        instance
+      end
+    end
+
+    def initialize(executable: InkscapeCLI.executable, timeout: InkscapeCLI.timeout)
+      @executable = executable
+      @args = []
+      @timeout = timeout
+    end
+
+    def execute
+      Open3.popen3(executable, *args) do |_stdin, stdout, stderr, thread|
+        [stdout, stderr].each(&:binmode)
+        stdout_reader = Thread.new { stdout.read }
+        stderr_reader = Thread.new { stderr.read }
+
+        unless thread.join(timeout)
+          Process.kill("TERM", thread.pid) rescue nil
+          Process.waitpid(thread.pid) rescue nil
+          raise Timeout::Error, "Inkscape command timed out..."
+        end
+
+        exit_status = thread.value.exitstatus
+        if exit_status != 0
+          raise InkscapeCLI::Error,
+                "Inkscape command failed with status: #{exit_status} and error: #{stderr_reader.value}"
+        end
+
+        [stdout_reader.value, stderr_reader.value, exit_status]
+      end
+    end
+
+    def input_file(file)
+      self << file
+      self
+    end
+
+    alias_method :input_file=, :input_file
+
+    def <<(arg)
+      args << arg.to_s
+      self
+    end
+
+    def method_missing(name, *args)
+      option = "--#{name.to_s.tr('_', '-').gsub('=', '')}"
+      self.args << option
+      args.each do |arg|
+        self.args << arg.to_s
+      end
+      self
+    end
+  end
+end

data/lib/inkscape_cli/configuration.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module InkscapeCLI
+  module Configuration
+    def configure
+      yield self
+    end
+
+    def define_setting(name, default = nil)
+      instance_variable_set("@#{name}", default)
+
+      define_singleton_method "#{name}=" do |value|
+        instance_variable_set("@#{name}", value)
+      end
+
+      define_singleton_method name do
+        instance_variable_get("@#{name}")
+      end
+    end
+  end
+end

data/lib/inkscape_cli/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module InkscapeCLI
+  VERSION = '1.0.0'
+end

data/lib/inkscape_cli.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'inkscape_cli/version'
+require_relative 'inkscape_cli/command'
+require 'inkscape_cli/configuration'
+require 'open3'
+require 'timeout'
+
+module InkscapeCLI
+  extend InkscapeCLI::Configuration
+
+  define_setting :executable, 'inkscape'
+  define_setting :timeout, 300
+
+  class Error < StandardError; end
+end

data/sig/inkscape_cli/command.rbs

@@ -0,0 +1,15 @@
+module InkscapeCLI
+  class Command
+    attr_reader args: Array[String]
+    attr_reader executable: String
+    attr_reader timeout: Integer
+
+    def self.new: -> Command
+    def initialize: (?executable:String, ?timeout:Integer) -> Command
+    def <<: (String) -> Command
+    def execute: -> Command
+    def input_file: (String) -> Command
+    def input_file=: (String) -> Command
+    def method_missing: -> Command
+  end
+end

data/sig/inkscape_cli/configuration.rbs

@@ -0,0 +1,7 @@
+module InkscapeCLI
+  module Configuration
+    def configure: -> Configuration
+
+    def define_setting: (Symbol | String, ?untyped) -> Symbol
+  end
+end

data/sig/inkscape_cli.rbs

@@ -0,0 +1,4 @@
+module InkscapeCLI
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: inkscape_cli
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Marco Adkins
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-17 00:00:00.000000000 Z
+dependencies: []
+description: Handles escaping and preventing malicious commands while shelling out
+  to inkscape.
+email:
+- marcoadkins88@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/inkscape_cli.rb
+- lib/inkscape_cli/command.rb
+- lib/inkscape_cli/configuration.rb
+- lib/inkscape_cli/version.rb
+- sig/inkscape_cli.rbs
+- sig/inkscape_cli/command.rbs
+- sig/inkscape_cli/configuration.rbs
+homepage: https://github.com/eezyinc/inkscape_cli
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/eezyinc/inkscape_cli
+  source_code_uri: https://github.com/eezyinc/inkscape_cli
+  changelog_uri: https://github.com/eezyinc/inkscape_cli/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Safe inkscape command line interface
+test_files: []