kittikrb-cursor 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MmNlYmQ1YTNkYWY0YmNhMTVjMGRkOTdjN2ZlZTgxYmFhZmRjMTliNg==
+  data.tar.gz: !binary |-
+    MDg2ODQ1ZTUyMDU2Mjk3ODIwMGJiZGNjOTU1MjJmZjQ3NWMzN2MyZQ==
+SHA512:
+  metadata.gz: !binary |-
+    ODUyZjI5YjQ1MjZlNmVmMWQ2NTJhM2JiYTI2MzA1YTk4Y2RmZGM5OGQ5OGU1
+    NDhmYThlZmUzNGQ2MDVlMGNiNDJkOWFiNmRhYmU5Njc5ZTkxMTBkMDBiNzBj
+    MmMxMDMxZTBmNTA4YTMwMDk2ZTFkYWQzMDNmNDM4YmFhMDAwZjc=
+  data.tar.gz: !binary |-
+    ZjIwMTk1YzFjNmI5NzEzNDIyNjFmYmJlMDNiNTg4MzI4OTFjZGJhZDcxYzkw
+    Yzg2OGFmZWQ3MDUzNDAyMGU5YzdjZjVkOThjMmIxZDVkNTI3YjIyOTIwNTEz
+    NjkzYjE0MWM5MThjZTE1ZmM5ODNiOWRiNzA0MzZkMWUyODhmYzE=

data/.editorconfig

@@ -0,0 +1,9 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+sudo: false
+cache: bundler
+rvm:
+- 2.3.0
+- 2.2
+before_install: gem install bundler -v 1.10.6
+gemfile:
+- Gemfile
+deploy:
+  provider: rubygems
+  api_key:
+    secure: dIcDqN4zjlei9rpB227rijtPZhFAmB/SeOYnjJ8FYmPSvEOv5L51PdTCMZqk42gyQ4WPU25MPoLqSB2oYY1wIyDVoAqtGjdv482w7Ifo5uifs+eLD4nhcTKu3z2wX1upV5JtGKNNG9BgAHBSXEnpdx6QMsjCPE/pEHLZ+JD4ToepnyIo0MV+uoO/DozckAWuBiIJh33bDY51kPNYzc7T9mONsVk5RMGglXbUZPAOpmKC7SLsYngXgjomSqb1RIR6gKVEluwffykci6TttozgwWE5+NyvvCs3hhCQHuI28iUIP/e81imXDNnCDt9gkG+0B8nDS0l7l+vXs5RSOycOowLmwhs8l1JbwIpD6duwUhIBWKYEkFNJHw7OYnkyGDRlpQNbN1Y42ZB1/+QalN2BhvmOzYq9oEN2gYbYqRQTI8DKjYwav/3zZjKOrsEaDY/H+myQxuVu+Li9uxBCkkxdxDySCy5/8YOZaxvgbZxeQEoPCDb0lj2gWBFLdcfdcWt6vmtN9suDqzaqlOdvyIKg+JKM0Oo1wrJReYyu0Axx0DlgYjkaZEu5pScLz1FKG0BcV8q/bjG9Zl/SOMsIOcYQnd5hBU90L3pfRDyFXIauSTZIDkNHfiB05m7Y3jBjDHoX2tBRQujea1lsDty2w61yO/g86hwLV6/eYO6B0hM+dAo=
+  gem: kittikrb-cursor
+  on:
+    tags: true
+    repo: kittikrb/cursor

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kittikrb-cursor.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2016 Eugene Obrezkov
+Copyright (c) 2016 Vladyslav Siriniok and KittikRb contributors
+
+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,41 @@
+# KittikRb::Cursor
+
+![Build Status](https://img.shields.io/travis/kittikrb/cursor.svg)
+
+Implements low-level API for access to cursor in terminal.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kittikrb-cursor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kittikrb-cursor
+
+## Usage
+
+```ruby
+require 'kittikrb/cursor'
+
+cursor = KittikRb::Cursor.create.reset_tty!
+```
+
+See detailed usage examples in `examples` directory.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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]/kittikrb-cursor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.

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,19 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'kittikrb/cursor'
+require 'pry'
+require 'awesome_print'
+
+def reload!
+  $LOADED_FEATURES.select { |feat| feat =~ /\/kittikrb\// }.each(&method(:load))
+end
+
+def run
+  KittikRb::Cursor.create
+end
+
+AwesomePrint.defaults = { indent: -2 }
+AwesomePrint.pry!
+
+Pry.start

data/bin/setup

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

data/kittikrb-cursor.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kittikrb/cursor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kittikrb-cursor'
+  spec.version       = KittikRb::Cursor::VERSION
+  spec.date          = Date.today.to_s
+  spec.authors       = ['Vladyslav Siriniok']
+  spec.email         = ['siriniok@gmail.com']
+  spec.license       = 'MIT'
+  spec.summary       = %q{ Low-level API for cursor in terminal.' }
+  spec.description   = %q{ Implements low-level API for access to cursor in
+    terminal.' }
+  spec.homepage      = 'https://github.com/kittikjs/cursor'
+  spec.required_ruby_version = '~> 2.2'
+  spec.required_rubygems_version = '~> 2.2'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |file|
+    file.match(%r{^(test|spec|features|examples)/})
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'pry-stack_explorer', '~> 0.4'
+  spec.add_development_dependency 'pry-byebug', '~> 3.3'
+  spec.add_development_dependency 'awesome_print', '~> 1.6'
+end

data/lib/kittikrb/cursor.rb

@@ -0,0 +1,148 @@
+require 'kittikrb/cursor/core_ext/hash'
+
+require 'kittikrb/cursor/version'
+require 'kittikrb/cursor/colors'
+require 'kittikrb/cursor/display_modes'
+
+require 'set'
+require 'io/console'
+
+##
+# Cursor implements low-level API to terminal control codes.
+# See links below for details:
+# http://www.termsys.demon.co.uk/vtansi.htm
+# http://misc.flogisoft.com/bash/tip_colors_and_formatting
+# http://man7.org/linux/man-pages/man4/console_codes.4.html
+# http://www.x.org/docs/xterm/ctlseqs.pdf
+
+module KittikRb
+  module Cursor
+
+    def self.create
+      Cursor.new
+    end
+
+    class Cursor
+      include KittikRb::Cursor::Colors
+      include KittikRb::Cursor::DisplayModes
+
+      DISPLAY_CONFIG = {
+        bold: false,
+        dim: false,
+        underlined: false,
+        blink: false,
+        reverse: false,
+        hidden: false
+      }
+      ESCAPE_CHAR = "\e"
+
+      # Only for compatibility with KittikJs API
+      def self.encode_to_vt100(str)
+        ESCAPE_CHAR + str
+      end
+
+      # Wrap char with all control codes needed for rendering the cell.
+      # Returns ready to flush string with ASCII control codes
+      def self.wrap(char, options = {})
+        wrap_position(options[:x], options[:y]) <<
+          wrap_ground_colors(options.slice(:background, :foreground)) <<
+          wrap_display_modes(options[:display] || {}) <<
+          char <<
+          wrap_display_modes(reset_all: true)
+      end
+
+      def initialize
+        @height, @width = $stdout.winsize
+        @x, @y = 0, 0
+        @background, @foreground = false, false
+        @display = DISPLAY_CONFIG
+        @buffer = Array.new(@width * @height, ' ')
+        update_rendered_buffer!
+      end
+
+      # Build control sequence for each cell in data and write it to the buffer.
+      def write(data)
+        data.chars.each do |char|
+          if cursor_in_bounding_box?
+            options = { x: @x, y: @y,
+                        background: @background,
+                        foreground: @foreground,
+                        display: @display }
+            @buffer[get_pointer_from_xy] = self.class.wrap char, options
+          end
+
+          @x += 1
+        end
+
+        self
+      end
+
+      # Build difference between current buffer and rendered buffer and write
+      # it to TTY. Difference contains new control codes only, optimizing
+      # the rendering performance.
+      def flush
+        $stdout.write(@buffer.select { |c| !@rendered_buffer.include?(c) }.join)
+        update_rendered_buffer!
+
+        self
+      end
+
+      # Get index of the buffer from (x, y) coordinates.
+      def get_pointer_from_xy(x = @x, y = @y)
+        y * @width + x;
+      end
+
+      # Get (x, y) coordinate from the buffer pointer.
+      def get_xy_from_pointer(index)
+        [index - (index / @width).floor * @width, (index / @width).floor]
+      end
+
+      def move_to(x, y)
+        @x, @y = x.floor, y.floor
+
+        self
+      end
+
+      def write_control(str)
+        $stdout.write(ESCAPE_CHAR + str)
+      end
+
+      # Reset all terminal settings.
+      # Applies immediately without calling flush.
+      def reset_tty!
+        write_control 'c'
+
+        self
+      end
+
+      private
+      ########################################################################
+
+      def self.wrap_position(x, y)
+        ESCAPE_CHAR + "[#{(y + 1).floor};#{(x + 1).floor}f"
+      end
+      private_class_method :wrap_position
+
+      def self.wrap_ground_colors(foreground: nil, background: nil)
+        [(ESCAPE_CHAR + "[48;5;#{COLORS[background]}m" if background),
+         (ESCAPE_CHAR + "[38;5;#{COLORS[foreground]}m" if foreground)].join
+      end
+      private_class_method :wrap_ground_colors
+
+      def self.wrap_display_modes(options = {})
+        DISPLAY_MODES.map do |key, value|
+          ESCAPE_CHAR + "[#{DISPLAY_MODES[key]}m" if options[key]
+        end.join
+      end
+      private_class_method :wrap_display_modes
+
+      def update_rendered_buffer!
+        @rendered_buffer = Set.new(@buffer)
+      end
+
+      def cursor_in_bounding_box?
+        0 <= @x && @x < @width && 0 <= @y && @y < @height
+      end
+    end
+  end
+end

data/lib/kittikrb/cursor/colors.rb

@@ -0,0 +1,33 @@
+module KittikRb
+  module Cursor
+    module Colors
+
+      ##
+      # Now mapped only basic 16 colors.
+      # Here are the control sequences that permit you to use them.
+      # Some terminals can support 256 colors.
+      #
+      # The colors number 256 is only supported by vte (GNOME Terminal, XFCE4
+      # Terminal, Nautilus Terminal, Terminator, ...)
+
+      COLORS = {
+        black: 0,
+        maroon: 1,
+        green: 2,
+        olive: 3,
+        navy_blue: 4,
+        purple: 5,
+        teal: 6,
+        silver: 7,
+        grey: 8,
+        red: 9,
+        lime: 10,
+        yellow: 11,
+        blue: 12,
+        magenta: 13,
+        aqua: 14,
+        white: 15
+      }
+    end
+  end
+end

data/lib/kittikrb/cursor/core_ext/hash.rb

@@ -0,0 +1,7 @@
+class Hash
+  # From ActiveSupport v5.0.0.beta3
+  def slice(*keys)
+    keys.map! { |key| convert_key(key) } if respond_to?(:convert_key, true)
+    keys.each_with_object(self.class.new) { |k, hash| hash[k] = self[k] if has_key?(k) }
+  end
+end

data/lib/kittikrb/cursor/display_modes.rb

@@ -0,0 +1,27 @@
+module KittikRb
+  module Cursor
+    module DisplayModes
+
+      ##
+      # Map of the display modes that can be used in Cursor API.
+      # There are the most commonly supported control sequences for formatting
+      # text and their resetting.
+
+      DISPLAY_MODES = {
+        reset_all: 0,
+        bold: 1,
+        dim: 2,
+        underlined: 4,
+        blink: 5,
+        reverse: 7,
+        hidden: 8,
+        reset_bold: 21,
+        reset_dim: 22,
+        reset_underlined: 24,
+        reset_blink: 25,
+        reset_reverse: 27,
+        reset_hidden: 28
+      }
+    end
+  end
+end

data/lib/kittikrb/cursor/version.rb

@@ -0,0 +1,5 @@
+module KittikRb
+  module Cursor
+    VERSION = '0.1.0'
+  end
+end

data/lib/kittikrb_cursor.rb

@@ -0,0 +1,4 @@
+require 'kittikrb/cursor'
+
+module KittikRb
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: kittikrb-cursor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vladyslav Siriniok
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: ! " Implements low-level API for access to cursor in\n    terminal.' "
+email:
+- siriniok@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .editorconfig
+- .gitignore
+- .rspec
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kittikrb-cursor.gemspec
+- lib/kittikrb/cursor.rb
+- lib/kittikrb/cursor/colors.rb
+- lib/kittikrb/cursor/core_ext/hash.rb
+- lib/kittikrb/cursor/display_modes.rb
+- lib/kittikrb/cursor/version.rb
+- lib/kittikrb_cursor.rb
+homepage: https://github.com/kittikjs/cursor
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ~>
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ~>
+    - !ruby/object:Gem::Version
+      version: '2.2'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Low-level API for cursor in terminal.'
+test_files: []