klaxon 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4d22bb6a0018d690618f4a543b2e8e10607e7c8fac0b035bdf9425397b5e3fbc
+  data.tar.gz: dce9a140888d4ce002d2985b92a5a051175fe9ddc53364d8dcd968f5a3ea12ce
+SHA512:
+  metadata.gz: 05d7d11b5327f4ee6903ce18a31160babb31cef4167017e8f15c83c47e6c4ee16fd18dc80d9ae0fb7931d0e8069a8421a3b093dc78ffdda5c2e0311ca627a15c
+  data.tar.gz: 4e5f9d00a9326936fcb7e8844b3a12d3d1b5e4cf9461b19d7537be703fe39355679138e1aa69a0916ddde4753ecb0960556d5a467bb4c66037cfeef76a220c54

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Ryan Calhoun
+
+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,55 @@
+# klaxson
+Insert a programmable interactive warning prompt for developers
+before taking dangerous or destructive action.
+
+Example:
+```ruby
+Klaxon.alert banner: 'Delete', description: 'About to delete files!' do
+  system "rm -rf"
+end
+```
+
+Prints to `STDERR`
+```
+    _____       _      _
+   |  __ \     | |    | |
+   | |  | | ___| | ___| |_ ___
+   | |  | |/ _ \ |/ _ \ __/ _ \
+   | |__| |  __/ |  __/ |_  __/
+   |_____/ \___|_|\___|\__\___|
+
+
+About to delete files!
+To continue, press ENTER. To abort, press Ctrl+C...
+```
+
+### Using with YAML
+The keyword args in the `alert` method work well with YAML symbol keys, and
+can be mixed with existing YAML-based build configurations if desired.
+
+Given a config like:
+```yaml
+---
+dev:
+    :alert:
+        :banner: Development
+        :description: |
+            You are deploying to the dev environment
+            outside the CI pipleine.
+        :color: :yellow
+prod:
+    :alert:
+        :banner: Production
+        :description: |
+            DANGER! You are deploying directly to
+            production outside the CI pipeline. This
+            is highly unusual and dangerous!
+        :color: :red
+```
+
+The args for `alert` can be passed like:
+```ruby
+Klaxon.alert YAML.load_file('config.yml').dig ENV['ENV'], :alert do
+   # deploy files...
+end
+```

data/lib/klaxon.rb

@@ -0,0 +1,114 @@
+require 'artii'
+require 'colorize'
+require 'securerandom'
+require 'terminfo'
+
+# Insert a programmable interactive warning prompt for developers
+# before taking dangerous or destructive action.
+#
+# Example:
+#   Klaxon.alert banner: 'Delete', description: 'About to delete files!' do
+#     system "rm -rf"
+#   end
+#
+#   # prints to STDERR...
+#    _____       _      _       
+#   |  __ \     | |    | |      
+#   | |  | | ___| | ___| |_ ___ 
+#   | |  | |/ _ \ |/ _ \ __/ _ \
+#   | |__| |  __/ |  __/ |_  __/
+#   |_____/ \___|_|\___|\__\___|
+#                                 
+#
+#   About to delete files!
+#   To continue, press ENTER. To abort, press Ctrl+C...
+module Klaxon
+
+  YESNO = :yesno
+  ENTER = :enter
+  RANDOM = :random
+
+  # Issues the alert prompt, unless running in a CI environment. The prompt is always
+  # to STDERR.
+  #
+  # When run with a block, denying the prompt will simply not call the block. When
+  # run without a block, denying will cause a system exit.
+  #
+  # * +:banner:+ - A large block banner displayed figlet-style
+  # * +:description:+ - Paragraph text for the prompt, with line feeds preserved
+  # * +:color:+ - A symbol like :red or :yellow which will color the whole prompt
+  # * +:type:+ - Either :enter (the default), :yesno, :random, or literal text
+  # * +:ci:+ - If nil, auto-detect a CI environment from the ENV; if true, behave like a CI environment; if false, halt if it is a CI environment
+  #
+  def self.alert(banner: nil, description: nil, color: nil, type: nil, ci: nil, &dangerous)
+    execute = proc do
+      if dangerous
+        return dangerous.call
+      else
+        return true
+      end
+    end
+
+    halt = proc do
+      if dangerous
+        STDERR.puts "\nSkipping.".colorize color
+        return false
+      else
+        STDERR.puts "\nExiting."
+        exit 1
+      end
+    end
+
+    prompt = proc do |msg,&ok|
+      STDERR.print msg
+      begin
+        if ok[STDIN.gets.chomp.downcase]
+          execute.call
+        end
+      rescue Interrupt
+      end
+
+      halt.call
+    end
+
+    if ci == true
+      execute.call
+    elsif !STDIN.isatty && (ENV['CI'] || ENV['JENKINS_URL'])
+      if ci != false
+        execute.call
+      else
+        halt.call
+      end
+    end
+
+    if banner
+      STDERR.puts
+      STDERR.puts Artii::Base.new.asciify(banner).each_line.map {|line| "    " + line[0..TermInfo.screen_width-4] }.join.colorize color
+      STDERR.puts
+    end
+
+    if description
+      STDERR.puts description.colorize color
+    end
+
+    case type
+    when ENTER, nil
+      prompt.call "To continue, press ENTER. To abort, press Ctrl+C..." do
+        true
+      end
+    when YESNO
+      prompt.call "Continue? [y/N]: " do |val|
+        ['y', 'yes'].include?(val)
+      end
+    when RANDOM
+      digits = SecureRandom.hex(2)
+      prompt.call "To continue, type #{digits.upcase.split(//).join(" ")}\n> " do |val|
+        val.gsub(/\s+/, '') == digits
+      end
+    else
+      prompt.call "To continue, type \"#{type}\"\n> " do |val|
+        val == type
+      end
+    end
+  end
+end

data/lib/klaxon/version.rb

@@ -0,0 +1,3 @@
+module Klaxon
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: klaxon
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryan Calhoun
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: artii
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-terminfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Before a potentially dangerous or destructive action, issue a programmable
+  warning prompt.
+email:
+- ryanjamescalhoun@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/klaxon.rb
+- lib/klaxon/version.rb
+homepage: https://github.com/ryancalhoun/klaxon
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: An interactive warning prompt for the command-line
+test_files: []