obstinately 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f481d9f4061627a0e41e969ed4f2a48462a25eeaff0ba033369c5f04d6b6a315
+  data.tar.gz: 4aca9520d85281b487732c2f0dcfec1776a71318b67f2d48d75b14e5156c3560
+SHA512:
+  metadata.gz: e581d5e77b2b40e319ce7a2b240ca85526c7caf29217827cf8956588e7e1c0038ad5988b28eeae0cc272c796768b0f5590e32237bf1169f0a68a8194a4212c47
+  data.tar.gz: eddaffc7ebd4ad57730235fdebbb4a7626646977f362fe851ff52148b2357f04e878b69d31d3c7d4b12d7eea2e5ff87c9ae7b6fa58538ee56a254a2637f4d207

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# `obstinately` changes
+
+## 0.1.0
+
+* Initial implementation.  
+  [Samuel Giddins](https://github.com/segiddins)

data/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 segiddins@squareup.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/

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Samuel Giddins
+
+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,43 @@
+# Obstinately
+
+A small command-line utility to retry shell invocations with exponential backoff.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'obstinately'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install obstinately
+
+## Usage
+
+```shell
+obstinately --backoff=1.5 --retries=3 -- ping -c 1 google.com
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rake` 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 `bin/rake install`. To release a new version, update the version number in `VERSION`, and then run `bin/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/segiddins/obstinately. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Obstinately project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/segiddins/obstinately/blob/master/CODE_OF_CONDUCT.md).

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/exe/obstinately

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'obstinately'
+require 'obstinately/command'
+
+Obstinately::Command.run(ARGV)

data/lib/obstinately.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Obstinately
+  class Error < StandardError; end
+end
+
+require 'obstinately/version'

data/lib/obstinately/command.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require 'claide'
+require 'English'
+require 'shellwords'
+
+module Obstinately
+  class Command < CLAide::Command
+    self.command = 'obstinately'
+    self.version = VERSION
+
+    class MissingExecutableError < Error
+      include CLAide::InformativeError
+    end
+
+    self.summary = <<-EOS
+      A small command-line utility to retry shell invocations with exponential backoff.
+    EOS
+
+    self.arguments = [
+      CLAide::Argument.new('COMMAND', true, true)
+    ]
+
+    DEFAULT_RETRIES = '3'
+    DEFAULT_BACKOFF = '1.5'
+
+    def self.options
+      super.concat([
+                     ['--retries=RETRIES', "The number of retries. Defaults to #{DEFAULT_RETRIES}"],
+                     ['--backoff=BACKOFF', "The number of seconds to wait after the first failure. Doubles after each subsequent failure. Defaults to #{DEFAULT_BACKOFF}"]
+                   ]).reject { |name, _| name == '--no-ansi' }
+    end
+
+    def initialize(argv)
+      @retries = argv.option('retries', DEFAULT_RETRIES)
+      @backoff = argv.option('backoff', DEFAULT_BACKOFF)
+      @command = argv.arguments!
+      super
+    end
+
+    def run
+      backoff = @backoff
+      @retries.succ.times do |i|
+        message { "Running `#{@command.shelljoin}`" }
+        exe, *args = *@command
+
+        begin
+          subprocess = spawn([exe, exe], *args)
+        rescue SystemCallError => e
+          raise MissingExecutableError, "Unable to find executable `#{exe}`#{" (#{e.class})" if verbose?}"
+        else
+          Process.wait(subprocess)
+          status = $CHILD_STATUS
+        end
+
+        break if status.success?
+
+        if i == @retries
+          message { "Running `#{@command.shelljoin}` failed #{i.succ} times" }
+          exit status.exitstatus
+        end
+
+        message { "Running `#{@command.shelljoin}` failed#{", sleeping #{backoff} seconds, then" if backoff > 0} retrying (#{i.succ}/#{@retries.succ})" }
+
+        sleep backoff
+        backoff *= 2
+      end
+    end
+
+    def validate!
+      super
+
+      help! "Must specify a positive number of retries, not #{@retries}" unless @retries =~ /\A\d+\z/ && (@retries = @retries.to_i) && (@retries >= 0)
+
+      help! "Must specify a positive number of seconds for backoff, not #{@backoff}" unless @backoff =~ /\A(\d+)?\.?\d+\z/ && (@backoff = @backoff.to_f) && (@backoff >= 0)
+
+      help! 'Must specify a command to run' if @command.empty?
+    end
+
+    def message
+      return unless verbose?
+
+      warn yield
+    end
+  end
+end

data/lib/obstinately/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Obstinately
+  VERSION = File.read(File.expand_path('../../VERSION', __dir__)).strip.freeze
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: obstinately
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Giddins
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: claide
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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'
+description: 
+email:
+- segiddins@squareup.com
+executables:
+- obstinately
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- VERSION
+- exe/obstinately
+- lib/obstinately.rb
+- lib/obstinately/command.rb
+- lib/obstinately/version.rb
+homepage: https://github.com/segiddins/obstinately
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/segiddins/obstinately
+  source_code_uri: https://github.com/segiddins/obstinately
+  changelog_uri: https://github.com/segiddins/obstinately/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: A small command-line utility to retry shell invocations with exponential
+  backoff.
+test_files: []