cobi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d6d12bd06e58a43f3e29a696bc0b9aeba2f14f283dec3e6f1180fbe0d27e0477
+  data.tar.gz: 45d56facdb616525cd199b9d1cb73690db9985ca55a76f6b0d92a039c15d24fd
+SHA512:
+  metadata.gz: 39b46e162d755bb91a263cb80afa7d37692d1a884758f1ae29b7ccb665e4ba5e07777361cf76c907a9ee61ba9ff9356318f8ebd5742774c24200fe617c38a634
+  data.tar.gz: f1f7517971267974559ff9e90e41ed1ad376d241254292230f3695b86cb395cf7083d5258b4ee03db02a886b4378bd40aa8cc4f489bddfa5ee7cf06dffc3aecd

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 2.1.2

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in cobi.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "pastel"

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    cobi (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    equatable (0.6.1)
+    pastel (0.7.3)
+      equatable (~> 0.6)
+      tty-color (~> 0.5)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    tty-color (0.5.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cobi!
+  pastel
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Sean Goedecke
+
+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,32 @@
+# Cobi
+
+Cobi is a terminal menu library loosely inspired by COBOL's `SCREEN SECTION`. It aims to be (a) as simple as possible to use, and (b) to be a better user experience than the conversational menus that almost every generator uses: users should be able to see all the questions immediately, and navigate around your answers before submitting.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cobi'
+```
+
+## Usage
+
+See `bin/demo` for an example. Initialize a new `Cobi::Screen`, attach some headings or fields to it, then call `run` to display it. It's significantly less powerful than COBOL's `SCREEN SECTION` by design.
+
+```ruby
+dog_info = Cobi::Screen.new
+  .heading("Please enter the details of your dog")
+  .field("Name")
+  .field("Breed")
+  .field("Age")
+  .run
+
+puts dog_info.inspect
+```
+
+![Screenshot](/screenshot.png?raw=true)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cobi"
+
+dog_info = Cobi::Screen.new
+  .heading("Please enter the details of your dog")
+  .field("Name")
+  .field("Breed")
+  .field("Age")
+  .run
+
+puts dog_info.inspect

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cobi.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/cobi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cobi"
+  spec.version       = Cobi::VERSION
+  spec.authors       = ["Sean Goedecke"]
+  spec.email         = ["sgoedecke@zendesk.com"]
+
+  spec.summary       = %q{COBOL-inspired terminal menus}
+  spec.homepage      = "http://github.com/sgoedecke/cobi"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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"]
+end

data/lib/cobi.rb

@@ -0,0 +1,4 @@
+require 'pastel'
+require 'readline'
+require 'io/console'
+require "cobi/screen"

data/lib/cobi/field.rb

@@ -0,0 +1,21 @@
+module Cobi
+  class Field
+    attr_accessor :value, :text, :focused, :length
+    def initialize(text, length)
+      @text = text
+      @length = length
+      @focused = false
+      @value = ''
+    end
+
+    def to_s
+      pastel_ctx = focused? ? Pastel.new.on_white : Pastel.new.on_black
+      pastel_ctx.blue(text + ': ') + pastel_ctx.green(value + '_' * (length - value.length))
+    end
+
+    def focused?
+      !!focused
+    end
+  end
+end
+ 

data/lib/cobi/heading.rb

@@ -0,0 +1,16 @@
+module Cobi
+  class Heading
+    attr_reader :text
+    def initialize(text)
+      @text = text
+    end
+
+    def to_s
+      Pastel.new.on_black.white(text)
+    end
+
+    def focused?
+      false
+    end
+  end
+end

data/lib/cobi/screen.rb

@@ -0,0 +1,104 @@
+require 'pastel'
+require 'readline'
+require 'io/console'
+require "cobi/version"
+require "cobi/field"
+require "cobi/heading"
+
+module Cobi
+  class Screen
+    attr_reader :screen_height
+
+    def initialize
+      @elements = []
+      @screen_height = `tput lines`.to_i
+      @running = false
+    end
+
+    def run
+      # Focus the first field
+      @elements.find { |e| e.is_a?(Field) }.focused = true
+      @running = true
+
+      while @running
+        draw
+        get_command
+      end
+
+      values
+    end
+
+    def on_submit(&block)
+      @on_submit = block
+      self
+    end
+
+    def heading(text)
+      @elements << Heading.new(text)
+      self
+    end
+
+    def field(text, length = 10)
+      @elements << Field.new(text, length)
+      self
+    end
+
+    private
+
+    def pastel
+      @pastel ||= Pastel.new.on_black
+    end
+
+    def draw
+      # first clear the screen, in case the terminal size calculation is offset by footers/tmux separators
+      puts pastel.black("\e[H\e[2J")
+
+      @elements.each do |e|
+        puts e.to_s
+      end
+
+      puts pastel.black("\n" * (screen_height - @elements.length - 4))
+      puts pastel.green("Tab to switch fields | Enter to submit")
+    end
+
+    def get_command
+      cmd = STDIN.getch
+      exit(1) if cmd == "\u0003" # exit on Ctrl+C
+
+      if cmd == "\t" # tab
+        handle_switch_focus
+      elsif cmd == "\n" || cmd == "\r" # TODO
+        handle_submit
+      elsif cmd =~/[[:alpha:]]/ || cmd =~ /[[:digit:]]/
+        handle_character(cmd)
+      end
+    end
+
+    def handle_submit
+      @running = false
+    end
+
+    def values
+      @elements.select { |e| e.is_a?(Field) }
+        .map { |e| [e.text, e.value] }
+        .to_h
+    end
+
+    def handle_character(char)
+      @elements.find { |e| e.focused? }.value += char
+    end
+
+    def handle_switch_focus
+      focused_index = @elements.find_index { |e| e.focused? }
+
+      next_index = focused_index + 1
+      until @elements[next_index] && @elements[next_index].is_a?(Field)
+        next_index += 1
+        next_index = 0 unless @elements[next_index]
+      end
+
+      @elements[focused_index].focused = false
+      @elements[next_index].focused = true
+    end
+  end
+end

data/lib/cobi/version.rb

@@ -0,0 +1,3 @@
+module Cobi
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: cobi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sean Goedecke
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-12 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- sgoedecke@zendesk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/demo
+- bin/setup
+- cobi.gemspec
+- lib/cobi.rb
+- lib/cobi/field.rb
+- lib/cobi/heading.rb
+- lib/cobi/screen.rb
+- lib/cobi/version.rb
+- screenshot.png
+homepage: http://github.com/sgoedecke/cobi
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: http://github.com/sgoedecke/cobi
+  source_code_uri: http://github.com/sgoedecke/cobi
+  changelog_uri: http://github.com/sgoedecke/cobi
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.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: COBOL-inspired terminal menus
+test_files: []