dev-ui 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e7b92fe38bc670b2bb8081569bcbe455d77fdbe
+  data.tar.gz: 92af92c2bf2a12df2024c45c34815d796fe9d46d
+SHA512:
+  metadata.gz: 2f895bdd2ed2abb4803a03a575688fef49799797a3242b2a9b9449a71832c329f899f68d200254849824e76b9db9f23f8c42b258d83afbe1b059a9a9c40c72bb
+  data.tar.gz: 51e15314102eb1d5dbd1a9c2e959a88369d26617b9a4a91682b80dd627dc2dd3736d20156b467a2639d069d5662e31c235c85614ac4a3e0678c8c0d4a9623f26

data/.gitignore

@@ -0,0 +1,14 @@
+*.gem
+build
+.vagrant
+.DS_Store
+.bundle
+
+.starscope.db
+cscope.out
+tags
+
+.byebug_history
+
+.rubocop-*
+doc

data/.rubocop.yml

@@ -0,0 +1,23 @@
+inherit_from:
+  - http://shopify.github.io/ruby-style-guide/rubocop.yml
+
+AllCops:
+  Exclude:
+    - 'vendor/**/*'
+  TargetRubyVersion: 2.0
+
+# This doesn't understand that <<~ doesn't exist in 2.0
+Style/IndentHeredoc:
+  Enabled: false
+
+# This doesn't take into account retrying from an exception
+Lint/HandleExceptions:
+  Enabled: false
+
+# allow String.new to create mutable strings
+Style/EmptyLiteral:
+  Enabled: false
+
+# allow the use of globals which makes sense in a CLI app like this
+Style/GlobalVars:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.15.0

data/Gemfile

@@ -0,0 +1,14 @@
+# NOTE: These are development-only dependencies
+source "https://rubygems.org"
+
+group :development, :test do
+  gem 'rubocop'
+  gem 'byebug'
+  gem 'method_source'
+end
+
+group :test do
+  gem 'mocha', require: false
+  gem 'minitest', '>= 5.0.0', require: false
+  gem 'minitest-reporters', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,47 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.3.0)
+    builder (3.2.3)
+    byebug (9.0.6)
+    metaclass (0.0.4)
+    method_source (0.8.2)
+    minitest (5.10.2)
+    minitest-reporters (1.1.14)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    mocha (1.2.1)
+      metaclass (~> 0.0.1)
+    parallel (1.11.2)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.2.2)
+      rake
+    rake (12.0.0)
+    rubocop (0.49.1)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    unicode-display_width (1.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  method_source
+  minitest (>= 5.0.0)
+  minitest-reporters
+  mocha
+  rubocop
+
+BUNDLED WITH
+   1.15.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Burke Libbey
+
+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,20 @@
+```ruby
+require 'dev/ui'
+
+Dev::UI::Frame.open('{{*}} {{bold:a}}', color: :green) do
+  Dev::UI::Frame.open('{{i}} b', color: :magenta) do
+    Dev::UI::Frame.open('{{?}} c', color: :cyan) do
+      sg = Dev::UI::SpinGroup.new
+      sg.add('wow') { sleep(2.5) }
+      sg.add('such spin') { sleep(1.6) }
+      sg.add('many glyph') { sleep(2.0) }
+      sg.wait
+    end
+  end
+  Dev::UI::Frame.divider('{{v}} lol')
+  puts 'words'
+  sg = Dev::UI::SpinGroup.new
+  sg.add('more spins') { sleep(0.5) ; raise 'oh no' }
+  sg.wait
+end
+```

data/bin/console

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

data/bin/testunit

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby --disable-gems
+
+root = File.expand_path('../..', __FILE__)
+DEV_TEST_ROOT = root + '/test'
+
+$LOAD_PATH.unshift(DEV_TEST_ROOT)
+
+def test_files
+  Dir.glob(DEV_TEST_ROOT + "/**/*_test.rb")
+end
+
+if ARGV.empty?
+  test_files.each { |f| require(f) }
+  exit 0
+end
+
+# A list of files is presumed to be specified
+ARGV.each do |a|
+  require a.sub(%r{^test/}, '').sub(%r{^misc/gatekeeper/test/}, '')
+end

data/dev-ui.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dev/ui/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dev-ui"
+  spec.version       = Dev::UI::VERSION
+  spec.authors       = ["Burke Libbey"]
+  spec.email         = ["burke@libbey.me"]
+
+  spec.summary       = %q{Terminal UI framework}
+  spec.description   = %q{Terminal UI framework}
+  spec.homepage      = "https://github.com/shopify/dev-ui"
+  spec.license       = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/dev.yml

@@ -0,0 +1,8 @@
+up:
+  - homebrew:
+  - ruby: 2.3.3
+  - bundler
+
+commands:
+  test: bin/testunit
+  style: "bundle exec rubocop -D"

data/lib/dev/ui.rb

@@ -0,0 +1,85 @@
+module Dev
+  module UI
+    autoload :ANSI,               'dev/ui/ansi'
+    autoload :Glyph,              'dev/ui/glyph'
+    autoload :Color,              'dev/ui/color'
+    autoload :Box,                'dev/ui/box'
+    autoload :Frame,              'dev/ui/frame'
+    autoload :InteractivePrompt,  'dev/ui/interactive_prompt'
+    autoload :Progress,           'dev/ui/progress'
+    autoload :Prompt,             'dev/ui/prompt'
+    autoload :Terminal,           'dev/ui/terminal'
+    autoload :Formatter,          'dev/ui/formatter'
+    autoload :Spinner,            'dev/ui/spinner'
+
+
+    # TODO: this, better
+    SpinGroup = Spinner::SpinGroup
+
+    # TODO: test
+    def self.glyph(handle)
+      Dev::UI::Glyph.lookup(handle)
+    end
+
+    # TODO: test
+    def self.resolve_color(input)
+      case input
+      when Symbol
+        Dev::UI::Color.lookup(input)
+      else
+        input
+      end
+    end
+
+    def self.confirm(question)
+      Dev::UI::Prompt.confirm(question)
+    end
+
+    def self.ask(question, **kwargs)
+      Dev::UI::Prompt.ask(question, **kwargs)
+    end
+
+    def self.resolve_text(input)
+      return input if input.nil?
+      Dev::UI::Formatter.new(input).format
+    end
+
+    def self.fmt(input, enable_color: true)
+      Dev::UI::Formatter.new(input).format(enable_color: enable_color)
+    end
+
+    def self.frame(*args, &block)
+      Dev::UI::Frame.open(*args, &block)
+    end
+
+    def self.spinner(*args, &block)
+      Dev::UI::Spinner.spin(*args, &block)
+    end
+
+    def self.with_frame_color(color, &block)
+      Dev::UI::Frame.with_frame_color_override(color, &block)
+    end
+
+    def self.log_output_to(path)
+      if Dev::UI::StdoutRouter.duplicate_output_to
+        raise "multiple logs not allowed"
+      end
+      Dev::UI::StdoutRouter.duplicate_output_to = File.open(path, 'w')
+      yield
+    ensure
+      f = Dev::UI::StdoutRouter.duplicate_output_to
+      f.close
+      Dev::UI::StdoutRouter.duplicate_output_to = nil
+    end
+
+    def self.raw
+      prev = Thread.current[:no_devui_frame_inset]
+      Thread.current[:no_devui_frame_inset] = true
+      yield
+    ensure
+      Thread.current[:no_devui_frame_inset] = prev
+    end
+  end
+end
+
+require 'dev/ui/stdout_router'

data/lib/dev/ui/ansi.rb

@@ -0,0 +1,74 @@
+require 'dev/ui'
+
+module Dev
+  module UI
+    module ANSI
+      ESC = "\x1b"
+
+      # ANSI escape sequences (like \x1b[31m) have zero width.
+      # when calculating the padding width, we must exclude them.
+      def self.printing_width(str)
+        strip_codes(str).size
+      end
+
+      def self.strip_codes(str)
+        str.gsub(/\x1b\[[\d;]+[A-z]|\r/, '')
+      end
+
+      def self.control(args, cmd)
+        ESC + "[" + args + cmd
+      end
+
+      # https://en.wikipedia.org/wiki/ANSI_escape_code#graphics
+      def self.sgr(params)
+        control(params.to_s, 'm')
+      end
+
+      # Cursor Movement
+
+      def self.cursor_up(n = 1)
+        return '' if n.zero?
+        control(n.to_s, 'A')
+      end
+
+      def self.cursor_down(n = 1)
+        return '' if n.zero?
+        control(n.to_s, 'B')
+      end
+
+      def self.cursor_forward(n = 1)
+        return '' if n.zero?
+        control(n.to_s, 'C')
+      end
+
+      def self.cursor_back(n = 1)
+        return '' if n.zero?
+        control(n.to_s, 'D')
+      end
+
+      # Cursor Visibility
+
+      def self.show_cursor
+        control('', "?25h")
+      end
+
+      def self.hide_cursor
+        control('', "?25l")
+      end
+
+      # Line Handling
+
+      def self.next_line
+        cursor_down + control('1', 'G')
+      end
+
+      def self.previous_line
+        cursor_up + control('1', 'G')
+      end
+
+      def self.end_of_line
+        control("\033[", 'C')
+      end
+    end
+  end
+end

data/lib/dev/ui/box.rb

@@ -0,0 +1,15 @@
+require 'dev/ui'
+
+module Dev
+  module UI
+    module Box
+      module Heavy
+        VERT = '┃'
+        HORZ = '━'
+        DIV  = "┣"
+        TL   = '┏'
+        BL   = '┗'
+      end
+    end
+  end
+end

data/lib/dev/ui/color.rb

@@ -0,0 +1,58 @@
+require 'dev/ui'
+
+module Dev
+  module UI
+    class Color
+      attr_reader :sgr, :name, :code
+      def initialize(sgr, name)
+        @sgr  = sgr
+        @code = Dev::UI::ANSI.sgr(sgr)
+        @name = name
+      end
+
+      RED     = new('31', :red)
+      GREEN   = new('32', :green)
+      YELLOW  = new('33', :yellow)
+      # default blue is low-contrast against black in some default terminal color scheme
+      BLUE    = new('94', :blue) # 9x = high-intensity fg color x
+      MAGENTA = new('35', :magenta)
+      CYAN    = new('36', :cyan)
+      RESET   = new('0',  :reset)
+      BOLD    = new('1',  :bold)
+      WHITE   = new('97', :white)
+
+      MAP = {
+        red:     RED,
+        green:   GREEN,
+        yellow:  YELLOW,
+        blue:    BLUE,
+        magenta: MAGENTA,
+        cyan:    CYAN,
+        reset:   RESET,
+        bold:    BOLD,
+      }.freeze
+
+      class InvalidColorName < ArgumentError
+        def initialize(name)
+          @name = name
+        end
+
+        def message
+          keys = Color.available.map(&:inspect).join(',')
+          "invalid color: #{@name.inspect} " \
+            "-- must be one of Dev::UI::Color.available (#{keys})"
+        end
+      end
+
+      def self.lookup(name)
+        MAP.fetch(name)
+      rescue KeyError
+        raise InvalidColorName, name
+      end
+
+      def self.available
+        MAP.keys
+      end
+    end
+  end
+end