tty-reader 0.1.0

data/lib/tty/reader/mode.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require 'io/console'
+
+module TTY
+  class Reader
+    class Mode
+      # Initialize a Terminal
+      #
+      # @api public
+      def initialize(input = $stdin)
+        @input = input
+      end
+
+      # Echo given block
+      #
+      # @param [Boolean] is_on
+      #
+      # @api public
+      def echo(is_on = true, &block)
+        if is_on || !@input.tty?
+          yield
+        else
+          @input.noecho(&block)
+        end
+      end
+
+      # Use raw mode in the given block
+      #
+      # @param [Boolean] is_on
+      #
+      # @api public
+      def raw(is_on = true, &block)
+        if is_on && @input.tty?
+          @input.raw(&block)
+        else
+          yield
+        end
+      end
+    end # Mode
+  end # Reader
+end # TTY

data/lib/tty/reader/version.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+module TTY
+  class Reader
+    VERSION = "0.1.0"
+  end # Reader
+end # TTY

data/lib/tty/reader/win_api.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require 'fiddle'
+
+module TTY
+  class Reader
+    module WinAPI
+      include Fiddle
+
+      Handle = RUBY_VERSION >= "2.0.0" ? Fiddle::Handle : DL::Handle
+
+      CRT_HANDLE = Handle.new("msvcrt") rescue Handle.new("crtdll")
+
+      # Get a character from the console without echo.
+      #
+      # @return [String]
+      #   return the character read
+      #
+      # @api public
+      def getch
+        @@getch ||= Fiddle::Function.new(CRT_HANDLE["_getch"], [], TYPE_INT)
+        @@getch.call
+      end
+      module_function :getch
+
+      # Gets a character from the console with echo.
+      #
+      # @return [String]
+      #   return the character read
+      #
+      # @api public
+      def getche
+        @@getche ||= Fiddle::Function.new(CRT_HANDLE["_getche"], [], TYPE_INT)
+        @@getche.call
+      end
+      module_function :getche
+
+      # Check the console for recent keystroke. If the function
+      # returns a nonzero value, a keystroke is waiting in the buffer.
+      #
+      # @return [Integer]
+      #   return a nonzero value if a key has been pressed. Otherwirse,
+      #   it returns 0.
+      #
+      # @api public
+      def kbhit
+        @@kbhit ||= Fiddle::Function.new(CRT_HANDLE["_kbhit"], [], TYPE_INT)
+        @@kbhit.call
+      end
+      module_function :kbhit
+    end # WinAPI
+  end # Reader
+end # TTY

data/lib/tty/reader/win_console.rb

@@ -0,0 +1,90 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require_relative 'codes'
+
+module TTY
+  class Reader
+    class WinConsole
+      ESC     = "\e".freeze
+      NUL_HEX = "\x00".freeze
+      EXT_HEX = "\xE0".freeze
+
+      # Key codes
+      #
+      # @return [Hash[Symbol]]
+      #
+      # @api public
+      attr_reader :keys
+
+      # Escape codes
+      #
+      # @return [Array[Integer]]
+      #
+      # @api public
+      attr_reader :escape_codes
+
+      def initialize(input)
+        require_relative 'win_api'
+        @input = input
+        @keys = Codes.win_keys
+        @escape_codes = [[NUL_HEX.ord], [ESC.ord], EXT_HEX.bytes.to_a]
+      end
+
+      # Get a character from console blocking for input
+      #
+      # @param [Hash[Symbol]] options
+      # @option options [Symbol] :echo
+      #   the echo mode toggle
+      # @option options [Symbol] :raw
+      #   the raw mode toggle
+      #
+      # @return [String]
+      #
+      # @api private
+      def get_char(options)
+        if options[:raw] && options[:echo]
+          if options[:nonblock]
+            get_char_echo_non_blocking
+          else
+            get_char_echo_blocking
+          end
+        elsif options[:raw] && !options[:echo]
+          options[:nonblock] ? get_char_non_blocking : get_char_blocking
+        elsif !options[:raw] && !options[:echo]
+          options[:nonblock] ? get_char_non_blocking : get_char_blocking
+        else
+          @input.getc
+        end
+      end
+
+      # Get the char for last key pressed, or if no keypress return nil
+      #
+      # @api private
+      def get_char_non_blocking
+        input_ready? ? get_char_blocking : nil
+      end
+
+      def get_char_echo_non_blocking
+        input_ready? ? get_char_echo_blocking : nil
+      end
+
+      def get_char_blocking
+        WinAPI.getch.chr
+      end
+
+      def get_char_echo_blocking
+        WinAPI.getche.chr
+      end
+
+      # Check if IO has user input
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def input_ready?
+        !WinAPI.kbhit.zero?
+      end
+    end # Console
+  end # Reader
+end # TTY

data/tasks/console.rake

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+desc 'Load gem inside irb console'
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require File.join(__FILE__, '../../lib/tty-reader')
+  ARGV.clear
+  IRB.start
+end
+task c: %w[ console ]

data/tasks/coverage.rake

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+desc 'Measure code coverage'
+task :coverage do
+  begin
+    original, ENV['COVERAGE'] = ENV['COVERAGE'], 'true'
+    Rake::Task['spec'].invoke
+  ensure
+    ENV['COVERAGE'] = original
+  end
+end

data/tasks/spec.rake

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+begin
+  require 'rspec/core/rake_task'
+
+  desc 'Run all specs'
+  RSpec::Core::RakeTask.new(:spec) do |task|
+    task.pattern = 'spec/{unit,integration}{,/*/**}/*_spec.rb'
+  end
+
+  namespace :spec do
+    desc 'Run unit specs'
+    RSpec::Core::RakeTask.new(:unit) do |task|
+      task.pattern = 'spec/unit{,/*/**}/*_spec.rb'
+    end
+
+    desc 'Run integration specs'
+    RSpec::Core::RakeTask.new(:integration) do |task|
+      task.pattern = 'spec/integration{,/*/**}/*_spec.rb'
+    end
+  end
+
+rescue LoadError
+  %w[spec spec:unit spec:integration].each do |name|
+    task name do
+      $stderr.puts "In order to run #{name}, do `gem install rspec`"
+    end
+  end
+end

data/tty-reader.gemspec

@@ -0,0 +1,28 @@
+# encoding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "tty/reader/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "tty-reader"
+  spec.version       = TTY::Reader::VERSION
+  spec.authors       = ["Piotr Murach"]
+  spec.email         = [""]
+  spec.summary       = %q{Provides a set of methods for processing keyboard input in character, line and multiline modes.}
+  spec.description   = %q{Provides a set of methods for processing keyboard input in character, line and multiline modes. In addition it maintains history of entered input with an ability to recall and re-edit those inputs and register to listen for keystrokes.}
+  spec.homepage      = "https://piotrmurach.github.io/tty"
+  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 "wisper", "~> 2.0.0"
+
+  spec.add_development_dependency "bundler", ">= 1.5.0", "< 2.0"
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "rspec",   "~> 3.0"
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: tty-reader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Piotr Murach
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: wisper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Provides a set of methods for processing keyboard input in character,
+  line and multiline modes. In addition it maintains history of entered input with
+  an ability to recall and re-edit those inputs and register to listen for keystrokes.
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- appveyor.yml
+- bin/console
+- bin/setup
+- lib/tty-reader.rb
+- lib/tty/reader.rb
+- lib/tty/reader/codes.rb
+- lib/tty/reader/console.rb
+- lib/tty/reader/history.rb
+- lib/tty/reader/key_event.rb
+- lib/tty/reader/line.rb
+- lib/tty/reader/mode.rb
+- lib/tty/reader/version.rb
+- lib/tty/reader/win_api.rb
+- lib/tty/reader/win_console.rb
+- tasks/console.rake
+- tasks/coverage.rake
+- tasks/spec.rake
+- tty-reader.gemspec
+homepage: https://piotrmurach.github.io/tty
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Provides a set of methods for processing keyboard input in character, line
+  and multiline modes.
+test_files: []
+has_rdoc: