fullscreen_tui 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e18910035ac6cba870a3a6e75c5b1a2d44a711481c4af6de6da68ab151e0a801
+  data.tar.gz: 5876fb56e1136f720eaca08841cb61c90625949d6e9677b7fac659be9a0527ac
+SHA512:
+  metadata.gz: 8b50cf1d96d88510c4a6d0702fcf6e366abbbaa847cf227acc86c72987e0d8eab1c2c348d7deb5f93297acf714e547c0402439654e21f769c9fa29861849d94a
+  data.tar.gz: c5b5c1ffe1325d60bb535c6c2c3f5245e1a4830fb2c8ca6b40472f9833c3ba01d46b344560d78882c478cf3e3b9dcbd5e4bbf6ee9f54f3a31b9fb18a4d74b9f8

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/vendor/bundle
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.gitlab-ci.yml

@@ -0,0 +1,11 @@
+image: ruby:2.5.1
+
+before_script:
+  - bundle install --path /cache
+
+cache:
+  paths:
+    - /cache
+
+rubocop:
+  script: bundle exec rubocop

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_gem:
+  ThunderKey-rubocop: rubocop.yml

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at nicolas@keltec.ch. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in fullscreen_tui.gemspec
+gemspec
+
+gem 'ThunderKey-rubocop'

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    fullscreen_tui (0.1.0)
+      colorize (~> 0.8)
+      ruby-terminfo (~> 0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ThunderKey-rubocop (0.0.9)
+      rubocop (~> 0.59)
+      rubocop-rspec (~> 1.30)
+    ast (2.4.0)
+    colorize (0.8.1)
+    jaro_winkler (1.5.1)
+    parallel (1.12.1)
+    parser (2.5.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rubocop (0.61.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    rubocop-rspec (1.30.1)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.0)
+    ruby-terminfo (0.1.1)
+    unicode-display_width (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ThunderKey-rubocop
+  bundler (~> 1.16)
+  fullscreen_tui!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Nicolas Ganz
+
+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,43 @@
+# FullscreenTui
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/fullscreen_tui`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fullscreen_tui'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fullscreen_tui
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fullscreen_tui. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the FullscreenTui project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/fullscreen_tui/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'fullscreen_tui'
+
+# 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/example

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'fullscreen_tui'
+
+class Example < FullscreenTui
+  def initialize
+    @lines = (1..40).map {|i| "some test #{i} " * 10 }
+    super headers: [] # ['Example', 'For FullscreenTui']
+  end
+
+  def key_press key
+    case key
+    when 'a' then @footer.message += "you've pressed a"
+    else super
+    end
+  end
+end
+
+Example.new.run

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/fullscreen_tui.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fullscreen_tui/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fullscreen_tui'
+  spec.version       = FullscreenTui::VERSION
+  spec.authors       = ['Nicolas Ganz']
+  spec.email         = ['nicolas@keltec.ch']
+
+  spec.summary       = 'A simple fullscreen wrapper for terminal uis'
+  spec.homepage      = 'https://gitlab.com/ThunderKey/fullscreen_tui'
+  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_dependency 'colorize', '~> 0.8'
+  spec.add_dependency 'ruby-terminfo', '~> 0.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/fullscreen_tui.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require 'terminfo'
+require 'io/console'
+require 'English'
+require_relative 'fullscreen_tui/header'
+require_relative 'fullscreen_tui/footer'
+require_relative 'fullscreen_tui/renderer'
+
+class FullscreenTui
+  def initialize headers:, renderer: nil
+    @header = Header.new headers
+    @footer = Footer.new
+    @selection = 0
+    @renderer = renderer || Renderer.new
+  end
+
+  def run
+    catch :quit do
+      loop do
+        print_screen
+        react
+      end
+    end
+  end
+
+  def print_screen
+    clear
+
+    lines, columns = TermInfo.screen_size
+
+    header = @header.output
+    lines -= required_lines header, columns
+    footer = @footer.output width: columns, lines: @lines.size, current_line: @selection
+    lines -= required_lines footer, columns
+
+    @renderer.header header unless header.empty?
+
+    print_lines lines, columns
+
+    @renderer.footer footer
+  end
+
+  def key_press key
+    case key
+    when :arrow_up then go_up
+    when :arrow_down then go_down
+    when 'q', "\u0004" then throw :quit # ctrl-d
+    else @footer.message = "Unknown key: #{key.inspect}"
+    end
+  end
+
+  def selected_line
+    @lines[@selection]
+  end
+
+  ARROWS = {
+    'A' => :arrow_up,
+    'B' => :arrow_down,
+    'C' => :arrow_right,
+    'D' => :arrow_left,
+  }.freeze
+
+  def react
+    key = case char = STDIN.getch
+    when "\u0003" then exit 1
+    when "\e"
+      case subchar = STDIN.getch
+      when '['
+        ARROWS.fetch(STDIN.getch) {|k| "\e[#{k}" }
+      else "\e#{subchar}"
+      end
+    else char
+    end
+    key_press key
+  end
+
+  def go_up
+    @footer.message = ''
+    return if @selection.zero?
+
+    @selection -= 1
+  end
+
+  def go_down
+    @footer.message = ''
+    return if @selection >= @lines.size - 1
+
+    @selection += 1
+  end
+
+  def read_full_line message
+    puts message
+    gets
+  end
+
+  private
+
+  def print_lines lines, columns
+    used_lines = 0
+    offset = [@selection - 5, 0].max
+    @lines[offset..-1].each.with_index do |l, i|
+      selected = i + offset == @selection
+      line = l.to_s
+      used_lines += (line.size.to_f / columns).ceil
+      if used_lines > lines
+        @renderer.line '...', selected: selected
+        break
+      end
+
+      @renderer.line line, selected: selected
+      break if used_lines == lines
+    end
+
+    (lines - used_lines).times { @renderer.line '~', selected: false }
+  end
+
+  def required_lines text, columns
+    text.split($INPUT_RECORD_SEPARATOR)
+      .inject(0) {|sum, line| sum + (line.size.to_f / columns).ceil }
+  end
+
+  def clear
+    system(Gem.win_platform? ? 'cls' : 'clear')
+  end
+end

data/lib/fullscreen_tui/footer.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class FullscreenTui
+  class Footer
+    attr_accessor :message
+    SEPERATOR = ' | '
+
+    def initialize
+      self.message = ''
+    end
+
+    def output width:, lines:, current_line:
+      parts = [
+        message,
+        "#{(current_line + 1).to_s.rjust lines.to_s.size}/#{lines}",
+      ]
+      part_width = width - parts[1].size - SEPERATOR.size
+      parts[0] = if parts[0].size > part_width
+        "#{parts[0][0...part_width - 3]}..."
+      else
+        parts[0].ljust part_width
+      end
+      parts.join SEPERATOR
+    end
+  end
+end

data/lib/fullscreen_tui/header.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class FullscreenTui
+  class Header
+    attr_accessor :parts
+    SEPERATOR = $INPUT_RECORD_SEPARATOR
+
+    def initialize parts = nil
+      self.parts = parts.nil? ? [] : parts
+    end
+
+    def output
+      parts.join SEPERATOR
+    end
+  end
+end

data/lib/fullscreen_tui/renderer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'colorize'
+
+class FullscreenTui
+  class Renderer
+    def header line
+      puts line
+    end
+
+    def line line, selected:
+      puts(selected ? line.underline : line)
+    end
+
+    def footer line
+      print line
+    end
+  end
+end

data/lib/fullscreen_tui/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class FullscreenTui
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: fullscreen_tui
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicolas Ganz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: ruby-terminfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !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: 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'
+description: 
+email:
+- nicolas@keltec.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/example
+- bin/setup
+- fullscreen_tui.gemspec
+- lib/fullscreen_tui.rb
+- lib/fullscreen_tui/footer.rb
+- lib/fullscreen_tui/header.rb
+- lib/fullscreen_tui/renderer.rb
+- lib/fullscreen_tui/version.rb
+homepage: https://gitlab.com/ThunderKey/fullscreen_tui
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A simple fullscreen wrapper for terminal uis
+test_files: []