infopark-user_io 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 09b42d53dccdd52424b6ae8eb12a6a2241199db2
+  data.tar.gz: 19de857e3bf959eef4c2c0ccd908c7c6060f0c15
+SHA512:
+  metadata.gz: 445017a230548c5f55439e5082ce7519a8385e8fae5c21786431844a6b5b887ba037422ac8c8ed10449c1e5e787ae10898829e8cf24f8a06333a822b93792af5
+  data.tar.gz: f4b865b51d53d6f212ab0982636976f0a3d4a7687f8155a0147c3b489d40ab8bb9160aeedf44d24dd60b4c1310c54f27781c65c38cff9e2a611e3626c7feca20

data/.gitignore

@@ -0,0 +1,2 @@
+/pkg
+/spec/examples.txt

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/infopark/user_io/version.rb

@@ -0,0 +1,5 @@
+module Infopark
+  class UserIO
+    VERSION = "0.0.6"
+  end
+end

data/lib/infopark/user_io.rb

@@ -0,0 +1,283 @@
+module Infopark
+
+# TODO extract into infopark base gem
+class ImplementationError < StandardError; end
+
+# TODO
+# - beep (\a) on #acknowledge, #ask or #confirm (and maybe on #listen, too)
+class UserIO
+  class Aborted < RuntimeError
+  end
+
+  class MissingEnv < RuntimeError
+  end
+
+  class Progress
+    def initialize(label, user_io)
+      @label = label
+      @user_io = user_io
+    end
+
+    def start
+      unless @started
+        user_io.tell("#{label} ", newline: false)
+        @started = true
+      end
+    end
+
+    def increment
+      raise ImplementationError, "progress not started yet" unless @started
+      user_io.tell(".", newline: false)
+    end
+
+    def finish
+      if @started
+        user_io.tell("… ", newline: false)
+        user_io.tell("OK", color: :green, bright: true)
+      end
+    end
+
+    private
+
+    attr_reader :label, :user_io
+  end
+
+  def initialize(output_prefix: nil)
+    case output_prefix
+    when String
+      @output_prefix = "[#{output_prefix}] "
+    when Proc, Method
+      @output_prefix_proc = ->() { "[#{output_prefix.call}] " }
+    when :timestamp
+      @output_prefix_proc = ->() { "[#{Time.now.strftime("%T.%L")}] " }
+    end
+    @line_pending = {}
+  end
+
+  def tell(*texts, newline: true, **line_options)
+    lines = texts.flatten.map {|text| text.to_s.split("\n", -1) }.flatten
+
+    lines[0...-1].each {|line| tell_line(line, **line_options) }
+    tell_line(lines.last, newline: newline, **line_options)
+  end
+
+  def warn(*text)
+    tell(*text, color: :yellow, bright: true)
+  end
+
+  def tell_error(e, **options)
+    tell(e, **options, color: :red, bright: true)
+  end
+
+  def acknowledge(*text)
+    tell("-" * 80)
+    tell(*text, color: :cyan, bright: true)
+    tell("-" * 80)
+    tell("Please press ENTER to continue.")
+    read_line
+  end
+
+  def ask(*text, default: nil)
+    # TODO implementation error if default not boolean or nil
+    tell("-" * 80)
+    tell(*text, color: :cyan, bright: true)
+    tell("-" * 80)
+    default_answer = default ? "yes" : "no" unless default.nil?
+    tell("(yes/no) #{default_answer && "[#{default_answer}] "}> ", newline: false)
+    until %w(yes no).include?(answer = read_line.strip.downcase)
+      if answer.empty?
+        answer = default_answer
+        break
+      end
+      tell("I couldn't understand “#{answer}”.", newline: false, color: :red, bright: true)
+      tell(" > ", newline: false)
+    end
+    answer == "yes"
+  end
+
+  def listen(prompt = nil, **options)
+    prompt << " " if prompt
+    tell("#{prompt}> ", **options, newline: false)
+    read_line.strip
+  end
+
+  def confirm(*text)
+    ask(*text) or raise Aborted
+  end
+
+  def new_progress(label)
+    Progress.new(label, self)
+  end
+
+  def start_progress(label)
+    new_progress(label).tap(&:start)
+  end
+
+  def background_other_threads
+    unless @foreground_thread
+      @background_lines = []
+      @foreground_thread = Thread.current
+    end
+  end
+
+  def foreground
+    if @foreground_thread
+      @background_lines.each(&STDOUT.method(:write))
+      @foreground_thread = nil
+      # take over line_pending from background
+      @line_pending[false] = @line_pending[true]
+      @line_pending[true] = false
+    end
+  end
+
+  def <<(msg)
+    tell(msg.chomp, newline: msg.end_with?("\n"))
+  end
+
+  def tty?
+    STDOUT.tty?
+  end
+
+  def edit_file(kind_of_data, filename = nil)
+    wait_for_foreground if background?
+
+    editor = ENV['EDITOR'] or raise MissingEnv, "No EDITOR specified."
+
+    filename ||= Tempfile.new("").path
+    tell("Start editing #{kind_of_data} using #{editor}…")
+    sleep(1.7)
+    system(editor, filename)
+
+    File.read(filename)
+  end
+
+  def select(description, items, item_describer: :to_s, default: nil)
+    return if items.empty?
+
+    describer =
+        case item_describer
+        when Method, Proc
+          item_describer
+        else
+          ->(item) { item.send(item_describer) }
+        end
+
+    choice = nil
+    if items.size == 1
+      choice = items.first
+      tell("Selected #{describer.call(choice)}.", color: :yellow)
+      return choice
+    end
+
+    items = items.sort_by(&describer)
+
+    tell("-" * 80)
+    tell("Please select #{description}:", color: :cyan, bright: true)
+    items.each_with_index do |item, i|
+      tell("#{i + 1}: #{describer.call(item)}", color: :cyan, bright: true)
+    end
+    tell("-" * 80)
+    default_index = items.index(default)
+    default_selection = "[#{default_index + 1}] " if default_index
+    until choice
+      tell("Your choice #{default_selection}> ", newline: false)
+      answer = read_line.strip
+      if answer.empty?
+        choice = default
+      else
+        int_answer = answer.to_i
+        if int_answer.to_s != answer
+          tell("Please enter a valid integer.")
+        elsif int_answer < 1 || int_answer > items.size
+          tell("Please enter a number from 1 through #{items.size}.")
+        else
+          choice = items[int_answer - 1]
+        end
+      end
+    end
+    choice
+  end
+
+  private
+
+  def background?
+    !!@foreground_thread && @foreground_thread != Thread.current
+  end
+
+  def wait_for_foreground
+    sleep 0.1 while background?
+  end
+
+  def output_prefix
+    @output_prefix || @output_prefix_proc && @output_prefix_proc.call
+  end
+
+  def read_line
+    wait_for_foreground if background?
+    @line_pending[false] = false
+    STDIN.gets.chomp
+  end
+
+  def tell_line(line, newline: true, prefix: true, **color_options)
+    if tty?
+      if line_prefix = text_color(**color_options)
+        line_postfix = text_color(color: :none, bright: false)
+      end
+    end
+
+    prefix = false if @line_pending[background?]
+
+    out_line = "#{output_prefix if prefix}#{line_prefix}#{line}#{line_postfix}#{"\n" if newline}"
+    if background?
+      @background_lines << out_line
+    else
+      STDOUT.write(out_line)
+    end
+
+    @line_pending[background?] = !newline
+  end
+
+  def control_sequence(*parameters, function)
+    "\033[#{parameters.join(";")}#{function}"
+  end
+
+  # SGR: Select Graphic Rendition … far too long for a function name ;)
+  def sgr_sequence(*parameters)
+    control_sequence(*parameters, :m)
+  end
+
+  def text_color(color: nil, bright: nil, faint: nil, italic: nil, underline: nil)
+    return if color.nil? && bright.nil?
+    sequence = []
+    unless bright.nil? && faint.nil?
+      sequence << (bright ? 1 : (faint ? 2 : 22))
+    end
+    unless italic.nil?
+      sequence << (italic ? 3 : 23)
+    end
+    unless underline.nil?
+      sequence << (underline ? 4 : 24)
+    end
+    case color
+    when :red
+      sequence << 31
+    when :green
+      sequence << 32
+    when :yellow
+      sequence << 33
+    when :blue
+      sequence << 34
+    when :purple
+      sequence << 35
+    when :cyan
+      sequence << 36
+    when :white
+      sequence << 37
+    when :none
+      sequence << 39
+    end
+    sgr_sequence(*sequence)
+  end
+end
+
+end

data/lib/infopark-user_io.rb

@@ -0,0 +1 @@
+require 'infopark/user_io'

data/spec/spec_helper.rb

@@ -0,0 +1,64 @@
+require_relative '../lib/infopark-user_io'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/user_io_spec.rb

@@ -0,0 +1,115 @@
+RSpec.describe ::Infopark::UserIO do
+  let(:options) { {} }
+
+  subject(:user_io) { ::Infopark::UserIO.new(**options) }
+
+  before do
+    allow($stdout).to receive(:puts)
+    # for debugging: .and_call_original
+    allow($stdout).to receive(:write)
+    # for debugging: .and_call_original
+  end
+
+  describe "#acknowledge" do
+    before { allow($stdin).to receive(:gets).and_return("\n") }
+
+    let(:message) { "Some important statement." }
+
+    subject(:acknowledge) { user_io.acknowledge(message) }
+
+    it "presents the message (colorized)" do
+      expect($stdout).to receive(:write).with("\e[1;36m""Some important statement.""\e[22;39m\n")
+      acknowledge
+    end
+
+    it "asks for pressing “Enter”" do
+      expect($stdout).to receive(:write).with("Please press ENTER to continue.\n")
+      acknowledge
+    end
+
+    it "requests input" do
+      expect($stdin).to receive(:gets).and_return("\n")
+      acknowledge
+    end
+  end
+
+  describe "#ask" do
+    before { allow($stdin).to receive(:gets).and_return("yes\n") }
+
+    let(:ask_options) { {} }
+    let(:question) { "do you want to?" }
+
+    subject(:ask) { user_io.ask(*Array(question), **ask_options) }
+
+    shared_examples_for "any question" do
+      # TODO
+      #it_behaves_like "handling valid answer"
+      #it_behaves_like "handling invalid input"
+      #it_behaves_like "printing prefix on every line"
+    end
+
+    context "with default" do
+      let(:ask_options) { {default: default_value} }
+
+      context "“true”" do
+        let(:default_value) { true }
+
+        it "presents default answer “yes”" do
+          expect($stdout).to receive(:write).with("(yes/no) [yes] > ")
+          ask
+        end
+
+        it "returns “true” on empty input" do
+          expect($stdin).to receive(:gets).and_return("\n")
+          expect(ask).to be true
+        end
+
+        it_behaves_like "any question"
+      end
+
+      context "“false”" do
+        let(:default_value) { false }
+
+        it "presents default answer “no”" do
+          expect($stdout).to receive(:write).with("(yes/no) [no] > ")
+          ask
+        end
+
+        it "returns “false” on empty input" do
+          expect($stdin).to receive(:gets).and_return("\n")
+          expect(ask).to be false
+        end
+
+        it_behaves_like "any question"
+      end
+
+      context "non boolean" do
+        # TODO
+      end
+    end
+  end
+
+  describe "#select" do
+    before { allow($stdin).to receive(:gets).and_return("1\n") }
+
+    let(:description) { "a thing" }
+    let(:items) { [:a, :b, :c] }
+    let(:select_options) { {} }
+
+    subject(:select) { user_io.select(description, items, **select_options) }
+
+    context "with default" do
+      let(:select_options) { {default: :b} }
+
+      it "presents the default's index as default answer" do
+        expect($stdout).to receive(:write).with("Your choice [2] > ")
+        select
+      end
+
+      it "returns the default on empty input" do
+        expect($stdin).to receive(:gets).and_return("\n")
+        expect(select).to eq(:b)
+      end
+    end
+  end
+end

data/user_io.gemspec

@@ -0,0 +1,16 @@
+require_relative 'lib/infopark/user_io/version'
+
+Gem::Specification.new do |s|
+  s.name = 'infopark-user_io'
+  s.version = Infopark::UserIO::VERSION
+  s.summary = 'A utility lib to interact with the user on the command line.'
+  s.description = s.summary
+  s.authors = ['Tilo Prütz']
+  s.email = 'tilo@infopark.de'
+  s.files = `git ls-files -z`.split("\0")
+  s.license = 'UNLICENSED'
+
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: infopark-user_io
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- Tilo Prütz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A utility lib to interact with the user on the command line.
+email: tilo@infopark.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Rakefile
+- lib/infopark-user_io.rb
+- lib/infopark/user_io.rb
+- lib/infopark/user_io/version.rb
+- spec/spec_helper.rb
+- spec/user_io_spec.rb
+- user_io.gemspec
+homepage: 
+licenses:
+- UNLICENSED
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A utility lib to interact with the user on the command line.
+test_files: []