cli-pasta 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5612e4030cb2f485f5bb1a6c00b5f8f3ddfa4617d0b21f72492cbc0f1ea38397
+  data.tar.gz: 2d01a19cc92baf44ef1c80b6e0a629b27660c7410702f215eb8dab826edb5f85
+SHA512:
+  metadata.gz: 65687bfac89d2d948b2838f7af257f58ee8df94e622ba7e177077b005f709cbff2a2e396d04ce5c0d969877727262ba539317c105c778d3ac2bcae8f4f7b268f
+  data.tar.gz: 8f92137c9bb38481212aac5de6c6a350a1cd95518ce93498f962440e1c70c35baadef2113c1b0733f69b1e5a3b66d6b5e0a4d22cc5d01a9223ce31f84434588e

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 1.0.0 - 2018-03-28 19:13:58
+
+* initial release

data/LICENSE.md

@@ -0,0 +1,192 @@
+The Artistic License 2.0
+========================
+
+_Copyright © 2000-2006, The Perl Foundation._
+
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+
+### Preamble
+
+This license establishes the terms under which a given free software
+Package may be copied, modified, distributed, and/or redistributed.
+The intent is that the Copyright Holder maintains some artistic
+control over the development of that Package while still keeping the
+Package available as open source and free software.
+
+You are always permitted to make arrangements wholly outside of this
+license directly with the Copyright Holder of a given Package.  If the
+terms of this license do not permit the full use that you propose to
+make of the Package, you should contact the Copyright Holder and seek
+a different licensing arrangement.
+
+### Definitions
+
+“Copyright Holder” means the individual(s) or organization(s)
+named in the copyright notice for the entire Package.
+
+“Contributor” means any party that has contributed code or other
+material to the Package, in accordance with the Copyright Holder's
+procedures.
+
+“You” and “your” means any person who would like to copy,
+distribute, or modify the Package.
+
+“Package” means the collection of files distributed by the
+Copyright Holder, and derivatives of that collection and/or of
+those files. A given Package may consist of either the Standard
+Version, or a Modified Version.
+
+“Distribute” means providing a copy of the Package or making it
+accessible to anyone else, or in the case of a company or
+organization, to others outside of your company or organization.
+
+“Distributor Fee” means any fee that you charge for Distributing
+this Package or providing support for this Package to another
+party.  It does not mean licensing fees.
+
+“Standard Version” refers to the Package if it has not been
+modified, or has been modified only in ways explicitly requested
+by the Copyright Holder.
+
+“Modified Version” means the Package, if it has been changed, and
+such changes were not explicitly requested by the Copyright
+Holder.
+
+“Original License” means this Artistic License as Distributed with
+the Standard Version of the Package, in its current version or as
+it may be modified by The Perl Foundation in the future.
+
+“Source” form means the source code, documentation source, and
+configuration files for the Package.
+
+“Compiled” form means the compiled bytecode, object code, binary,
+or any other form resulting from mechanical transformation or
+translation of the Source form.
+
+### Permission for Use and Modification Without Distribution
+
+**(1)**  You are permitted to use the Standard Version and create and use
+Modified Versions for any purpose without restriction, provided that
+you do not Distribute the Modified Version.
+
+### Permissions for Redistribution of the Standard Version
+
+**(2)**  You may Distribute verbatim copies of the Source form of the
+Standard Version of this Package in any medium without restriction,
+either gratis or for a Distributor Fee, provided that you duplicate
+all of the original copyright notices and associated disclaimers.  At
+your discretion, such verbatim copies may or may not include a
+Compiled form of the Package.
+
+**(3)**  You may apply any bug fixes, portability changes, and other
+modifications made available from the Copyright Holder.  The resulting
+Package will still be considered the Standard Version, and as such
+will be subject to the Original License.
+
+### Distribution of Modified Versions of the Package as Source
+
+**(4)**  You may Distribute your Modified Version as Source (either gratis
+or for a Distributor Fee, and with or without a Compiled form of the
+Modified Version) provided that you clearly document how it differs
+from the Standard Version, including, but not limited to, documenting
+any non-standard features, executables, or modules, and provided that
+you do at least ONE of the following:
+
+* **(a)**  make the Modified Version available to the Copyright Holder
+of the Standard Version, under the Original License, so that the
+Copyright Holder may include your modifications in the Standard
+Version.
+* **(b)**  ensure that installation of your Modified Version does not
+prevent the user installing or running the Standard Version. In
+addition, the Modified Version must bear a name that is different
+from the name of the Standard Version.
+* **(c)**  allow anyone who receives a copy of the Modified Version to
+make the Source form of the Modified Version available to others
+under
+        * **(i)**  the Original License or
+        * **(ii)**  a license that permits the licensee to freely copy,
+        modify and redistribute the Modified Version using the same
+        licensing terms that apply to the copy that the licensee
+        received, and requires that the Source form of the Modified
+        Version, and of any works derived from it, be made freely
+        available in that license fees are prohibited but Distributor
+        Fees are allowed.
+
+### Distribution of Compiled Forms of the Standard Version
+###  or Modified Versions without the Source
+
+**(5)**  You may Distribute Compiled forms of the Standard Version without
+the Source, provided that you include complete instructions on how to
+get the Source of the Standard Version.  Such instructions must be
+valid at the time of your distribution.  If these instructions, at any
+time while you are carrying out such distribution, become invalid, you
+must provide new instructions on demand or cease further distribution.
+If you provide valid instructions or cease distribution within thirty
+days after you become aware that the instructions are invalid, then
+you do not forfeit any of your rights under this license.
+
+**(6)**  You may Distribute a Modified Version in Compiled form without
+the Source, provided that you comply with Section 4 with respect to
+the Source of the Modified Version.
+
+### Aggregating or Linking the Package
+
+**(7)**  You may aggregate the Package (either the Standard Version or
+Modified Version) with other packages and Distribute the resulting
+aggregation provided that you do not charge a licensing fee for the
+Package.  Distributor Fees are permitted, and licensing fees for other
+components in the aggregation are permitted. The terms of this license
+apply to the use and Distribution of the Standard or Modified Versions
+as included in the aggregation.
+
+**(8)** You are permitted to link Modified and Standard Versions with
+other works, to embed the Package in a larger work of your own, or to
+build stand-alone binary or bytecode versions of applications that
+include the Package, and Distribute the result without restriction,
+provided the result does not expose a direct interface to the Package.
+
+### Items That are Not Considered Part of a Modified Version
+
+**(9)** Works (including, but not limited to, modules and scripts) that
+merely extend or make use of the Package, do not, by themselves, cause
+the Package to be a Modified Version.  In addition, such works are not
+considered parts of the Package itself, and are not subject to the
+terms of this license.
+
+### General Provisions
+
+**(10)**  Any use, modification, and distribution of the Standard or
+Modified Versions is governed by this Artistic License. By using,
+modifying or distributing the Package, you accept this license. Do not
+use, modify, or distribute the Package, if you do not accept this
+license.
+
+**(11)**  If your Modified Version has been derived from a Modified
+Version made by someone other than you, you are nevertheless required
+to ensure that your Modified Version complies with the requirements of
+this license.
+
+**(12)**  This license does not grant you the right to use any trademark,
+service mark, tradename, or logo of the Copyright Holder.
+
+**(13)**  This license includes the non-exclusive, worldwide,
+free-of-charge patent license to make, have made, use, offer to sell,
+sell, import and otherwise transfer the Package with respect to any
+patent claims licensable by the Copyright Holder that are necessarily
+infringed by the Package. If you institute patent litigation
+(including a cross-claim or counterclaim) against any party alleging
+that the Package constitutes direct or contributory patent
+infringement, then this Artistic License to you shall terminate on the
+date that such litigation is filed.
+
+**(14)**  **Disclaimer of Warranty:**
+
+THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS
+IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR
+NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL
+LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL
+BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,122 @@
+# cli-pasta
+
+[![Build Status](https://travis-ci.org/chocolateboy/cli-pasta.svg)](https://travis-ci.org/chocolateboy/cli-pasta)
+[![Gem Version](https://img.shields.io/gem/v/cli-pasta.svg)](https://rubygems.org/gems/cli-pasta)
+[![License](https://img.shields.io/badge/license-artistic-blue.svg)](https://github.com/chocolateboy/cli-pasta/blob/master/LICENSE.md)
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [NAME](#name)
+- [INSTALL](#install)
+- [SYNOPSIS](#synopsis)
+- [DESCRIPTION](#description)
+  - [BACKGROUND](#background)
+- [CLASSES](#classes)
+- [VERSION](#version)
+- [SEE ALSO](#see-also)
+- [AUTHOR](#author)
+- [COPYRIGHT AND LICENSE](#copyright-and-license)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+# NAME
+
+cli-pasta - handle Ctrl-C and broken-pipe errors gracefully in Ruby command-line tools
+
+# INSTALL
+
+```ruby
+gem "cli-pasta"
+```
+
+# SYNOPSIS
+
+```ruby
+#!/usr/bin/env ruby
+
+require "cli-pasta"
+require "optparse"
+
+# ...
+
+ARGF.each do |line|
+  puts process(line)
+end
+```
+
+# DESCRIPTION
+
+cli-pasta packages boilerplate code which is commonly copied 'n' pasted into Ruby CLI scripts to perform the following tasks:
+
+* set up an `EPIPE` handler to handle broken pipes in the same way as other CLI tools
+* set up a `SIGINT` handler to handle <kbd>Ctrl-C</kbd> in the same way as other CLI tools
+
+These tasks are executed by loading the corresponding files, either separately e.g.:
+
+```ruby
+require "cli-pasta/epipe"
+require "cli-pasta/sigint"
+```
+
+Or as a group e.g.:
+
+```ruby
+require "cli-pasta"
+```
+
+## BACKGROUND
+
+By default, ruby produces an ugly error message when scripts are interrupted by <kbd>Ctrl-C</kbd> (`SIGINT`) e.g.:
+
+    $ timeout --signal INT 1 ruby -e sleep
+
+Output:
+
+    ^CTraceback (most recent call last):
+            1: from -e:1:in `<main>'
+    -e:1:in `sleep': Interrupt
+
+The same is true if a process encounters an error when trying to write to a broken pipe (`EPIPE`) e.g.:
+
+    $ ruby -e 'loop { puts "." }' | head -n0
+
+Output:
+
+    Traceback (most recent call last):
+            5: from -e:1:in `<main>'
+            4: from -e:1:in `loop'
+            3: from -e:1:in `block in <main>'
+            2: from -e:1:in `puts'
+            1: from -e:1:in `puts'
+    -e:1:in `write': Broken pipe @ io_writev - <STDOUT> (Errno::EPIPE)
+
+The snippets provided by this gem install signal handlers which handle these errors in the same way as other CLI tools e.g.:
+
+    $ timeout --signal INT 1 ruby -r cli-pasta -e sleep
+    # No output
+
+    $ ruby -r cli-pasta -e 'loop { puts "." }' | head -n0
+    # No output
+
+# CLASSES
+
+None.
+
+# VERSION
+
+1.0.0
+
+# SEE ALSO
+
+* [nice-sigint](https://github.com/xiongchiamiov/nice-sigint) - make Ruby handle SIGINTs in a less-ugly manner
+
+# AUTHOR
+
+[chocolateboy](mailto:chocolate@cpan.org)
+
+# COPYRIGHT AND LICENSE
+
+Copyright © chocolateboy, 2018.
+
+This gem is free software. It is available under the terms of the [Artistic License 2.0](http://www.opensource.org/licenses/artistic-license-2.0.php).

data/lib/cli-pasta.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# handle Ctrl-C (SIGINT) and broken-pipe errors gracefully in CLI scripts
+
+require_relative 'cli-pasta/epipe'
+require_relative 'cli-pasta/sigint'

data/lib/cli-pasta/epipe.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+# avoid ugly stack-traces on EPIPE
+Signal.trap('PIPE', 'SYSTEM_DEFAULT') if Signal.list.include?('PIPE')

data/lib/cli-pasta/sigint.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+# avoid ugly stack-traces on SIGINT
+Signal.trap('INT', 'SYSTEM_DEFAULT') if Signal.list.include?('INT')

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: cli-pasta
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- chocolateboy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: komenda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.54.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.54.0
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: tty-which
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+description: 
+email: chocolate@cpan.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- lib/cli-pasta.rb
+- lib/cli-pasta/epipe.rb
+- lib/cli-pasta/sigint.rb
+homepage: https://github.com/chocolateboy/cli-pasta
+licenses:
+- Artistic-2.0
+metadata:
+  bug_tracker_uri: https://github.com/chocolateboy/cli-pasta/issues
+  changelog_uri: https://github.com/chocolateboy/cli-pasta/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/chocolateboy/cli-pasta
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Handle Ctrl-C and broken-pipe errors gracefully in Ruby command-line tools
+test_files: []