Initial commit

.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

.rspec

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

CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at rene.klacan@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in scallop.gemspec
+gemspec

Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    scallop (0.1.0)
+      hashie (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    hashie (3.6.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  scallop!
+
+BUNDLED WITH
+   1.17.2

LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Rene Klacan
+
+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.

README.md

@@ -0,0 +1,23 @@
+# Scallop
+
+Simple shell wrapper
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'scallop'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scallop
+
+## Usage
+
+(See specs)[./spec/scallop_spec.rb]

Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "scallop"
+
+# 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(__FILE__)

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

lib/scallop.rb

@@ -0,0 +1,80 @@
+require "hashie"
+require "open3"
+
+require "scallop/version"
+
+class Scallop
+  module Errors
+    class CommandFailed < StandardError
+      attr_reader :result
+
+      def initialize(message, result)
+        @result = result
+        super(message)
+      end
+    end
+
+    class ValidationFailed < StandardError
+    end
+  end
+
+  class Result < Hashie::Dash
+    property :stdout
+    property :stderr
+    property :status
+
+    def self.from_capture3(result)
+      stdout, stderr, status = result
+      new(stdout: stdout, stderr: stderr, status: status)
+    end
+
+    def success?
+      status.success?
+    end
+  end
+
+  class << self
+    DSL_METHODS = %i{ cmd run run! sudo }
+
+    DSL_METHODS.each do |method|
+      define_method(method) do |*args|
+        new.public_send(method, *args)
+      end
+    end
+  end
+
+  def sudo(sudo = true)
+    @sudo = sudo
+    self
+  end
+
+  def cmd(cmd)
+    @cmd = cmd.to_s
+    self
+  end
+
+  def to_command
+    raise ValidationFailed.new("cmd missing") if @cmd.nil?
+
+    prefix =
+      case @sudo
+      when true then "sudo"
+      when String, Symbol then "sudo -u #{@sudo}"
+      else nil
+      end
+
+    [prefix, @cmd].compact.join(" ")
+  end
+
+  def run
+    to_command
+      .yield_self(&Open3.method(:capture3))
+      .yield_self(&Result.method(:from_capture3))
+  end
+
+  def run!
+    run.tap do |result|
+      raise Errors::CommandFailed.new(result.stderr, result) unless result.success?
+    end
+  end
+end

lib/scallop/version.rb

@@ -0,0 +1,3 @@
+class Scallop
+  VERSION = "0.1.0"
+end

scallop.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "scallop/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "scallop"
+  spec.version       = Scallop::VERSION
+  spec.authors       = ["FetLife"]
+  spec.email         = ["dev@fetlife.com"]
+
+  spec.summary       = "Simple shell wrapper"
+  spec.description   = "Simple shell wrapper"
+  spec.homepage      = "https://github.com/fetlife/scallop"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "bin"
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.add_dependency "hashie", "~> 3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

spec/fixtures/lorem.txt

@@ -0,0 +1 @@
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc posuere ex nec nunc sagittis lobortis. Aenean est mauris, lacinia eu odio quis, pellentesque pharetra nisi. Ut tristique tincidunt pellentesque. In lobortis pulvinar risus, in consequat lectus aliquet vitae. Duis aliquam eget dui sed sollicitudin. Nulla facilisi. Vestibulum finibus nunc sed sodales porttitor. Sed at lacus diam. Donec luctus sapien ut tempus laoreet. Phasellus eu libero ac erat maximus euismod et et arcu. Nulla in felis nulla.

spec/scallop_spec.rb

@@ -0,0 +1,62 @@
+require "scallop"
+
+RSpec.describe Scallop do
+  describe "#to_command & #cmd & #sudo" do
+    specify "command building" do
+      expect(Scallop.cmd(:ls).to_command).to eq "ls"
+      expect(Scallop.cmd("ls /home/scallop").to_command).to eq "ls /home/scallop"
+      expect(Scallop.sudo(:chucknorris).cmd("rm -rf /").to_command).to eq "sudo -u chucknorris rm -rf /"
+      expect(Scallop.sudo.cmd("ls").to_command).to eq "sudo ls"
+    end
+  end
+
+  describe "#run" do
+    specify "successful command" do
+      result = Scallop.cmd("grep Lorem #{fixture_path('lorem.txt')}").run
+
+      expect(result.stdout).to include("Lorem ipsum")
+      expect(result.stderr).to be_empty
+      expect(result.success?).to eq true
+    end
+
+    specify "failed command without stderr" do
+      result = Scallop.cmd("grep bollocks #{fixture_path('lorem.txt')}").run
+
+      expect(result.stdout).to be_empty
+      expect(result.stderr).to be_empty
+      expect(result.success?).to eq false
+    end
+
+
+    specify "failed command with stderr" do
+      result = Scallop.cmd("grep bollocks bollocks.txt").run
+
+      expect(result.stdout).to be_empty
+      expect(result.stderr).to include("No such file or directory")
+      expect(result.success?).to eq false
+    end
+  end
+
+  describe "#run!" do
+    specify "successful command" do
+      result = Scallop.cmd("grep Lorem #{fixture_path('lorem.txt')}").run!
+
+      expect(result.stdout).to include("Lorem ipsum")
+      expect(result.stderr).to be_empty
+      expect(result.success?).to eq true
+    end
+
+    specify "failed command with stderr" do
+      expect do
+        Scallop.cmd("grep bollocks bollocks.txt").run! 
+      end.to raise_error do |error|
+        expect(error).to be_a(Scallop::Errors::CommandFailed)
+        expect(error).to respond_to(:result)
+
+        expect(error.result.stdout).to be_empty
+        expect(error.result.stderr).to include("No such file or directory")
+        expect(error.result.success?).to eq false
+      end
+    end
+  end
+end