dialog_tui 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cb44c246b8c595d9080d02a941e937f1c0929aff
+  data.tar.gz: d1b788e3a2b8a96db07fa135dae71f123e2128a3
+SHA512:
+  metadata.gz: 3a158b405922118529c6e6df886c7ff4404dd24a64904173d4c18526511bd77378e785f10df146d3f59c6259e081317207f8d9b7660dc533bb8162fc66119b21
+  data.tar.gz: ceb0862cfce4131c7b5e93136ca34064a6b3fedaf703ee9c42d41ee7af1605b4e1fca678e76092e18a1c3a47b4a8a2b8da67fa9569fb3b9d1eebc359dccf8094

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

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, 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 dialog_tui.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Alexander K
+
+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,39 @@
+# DialogTui
+
+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/dialog_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 'dialog_tui'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dialog_tui
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/dialog_tui/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

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

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

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dialog_tui/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dialog_tui"
+  spec.version       = DialogTui::VERSION
+  spec.authors       = ["Alexander K"]
+  spec.email         = ["xpyro@ya.ru"]
+
+  spec.summary       = %q{
+    menu for terminal ui
+  }.gsub("\n",' ').squeeze ' '
+
+  spec.description   = %q{
+    dsl for simple dialogs/menus
+    for simple terminal ui apps
+    with no other deps currently
+  }.gsub("\n",' ').squeeze ' '  # NOTE: deps in desc
+
+  spec.homepage      = 'https://github.com/sowcow/dialog_tui'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_development_dependency 'maxitest' #, '~> 2.4.6'
+                                    # ↑ NOTE: should be ok
+
+end

data/lib/dialog_tui/neighbors.rb

@@ -0,0 +1,105 @@
+module DialogTui
+
+  class Neighbors
+    def initialize array
+      neighbors =\
+        array.zip( array.rotate, array.rotate(-1) )
+
+      keys_values =\
+        neighbors.map { |entry, nexxt, prev|
+          [
+            entry,  # key
+            { next: nexxt, prev: prev }  # value
+          ]
+        }
+
+      @neighbors_of = Hash[keys_values]
+    end
+
+    def next from
+      neighbors(from)[:next]
+    end
+
+    def prev from
+      neighbors(from)[:prev]
+    end
+
+    private
+    def neighbors entry
+      @neighbors_of.fetch entry
+    end
+  end
+
+end
+
+
+# too much tests for one-liners class :)
+# (that was written first btw)
+# (upd: initialize is not a one-liner after refactoring,
+#  but private method is simpler now and others
+#  are more readable!)
+#
+# but I guess confidence and ability to rely on something
+# costs it, and this simple one
+# is a good point to start
+#
+# not that simple effect of tests
+# is that I can write more complex code under them...
+# hm...
+# - so refactor wizely! and freely!
+
+
+if __FILE__ == $0
+  require 'maxitest/autorun'
+  include DialogTui
+
+  describe Neighbors do
+    def subj
+      Neighbors
+    end
+
+    describe 'constructor' do
+      def call array
+        subj.new array
+      end
+
+      it 'takes an array' do
+        call [1,2,3]
+      end
+    end
+
+    describe '#next' do
+      def call array, entry
+        subj.new(array).next entry
+      end
+
+      it 'takes an entry and returns next to it' do
+        call([1,2,3], 1).must_equal 2
+        call([1,2,3], 2).must_equal 3
+      end
+
+      it 'the next after the last is the first' do
+        call([1,2,3], 3).must_equal 1
+      end
+
+      #it 'react in some way on unknown entry...'
+      # not sure what behavior will be default
+      # and not going to fix with tests that first
+      # that came to my mind (Hash#fetch currently)
+    end
+
+    describe '#prev' do
+      def call array, entry
+        subj.new(array).prev entry
+      end
+
+      it 'is reverse of #next' do
+        call([1,2,3], 1).must_equal 3
+        call([1,2,3], 2).must_equal 1
+        call([1,2,3], 3).must_equal 2
+      end
+    end
+
+  end
+
+end

data/lib/dialog_tui/user_action/action.rb

@@ -0,0 +1,114 @@
+module DialogTui
+  module UserAction
+
+    class Action
+      def initialize name, mapping=CHARS, &block
+        @matches = mapping.fetch name.to_sym
+        @block = block
+      end
+
+      attr_reader :matches
+      private     :matches
+
+      def match? input
+        matches == input
+      end
+
+      alias matches? match?
+
+      def call
+        @block.call
+      end
+
+      # any other mapping can be passed into constructor!
+      # sounds odd to pass it here,
+      # builder is a better idea,
+      # anyway strange class + builder here...
+      #
+      CHARS = {
+        ctrl_c: "\u0003",
+        space:  ' ',
+
+        esc:     "\e",
+        escape:  "\e",
+
+        enter:  "\r",
+        return: "\r",
+
+        up:    "\e[A",
+        down:  "\e[B",
+        right: "\e[C",
+        left:  "\e[D",
+      }
+    end
+
+  end
+end
+
+
+if __FILE__ == $0
+  require 'maxitest/autorun'
+
+  describe DialogTui::UserAction::Action do
+    def subj
+      DialogTui::UserAction::Action
+    end
+
+    describe 'constructor' do
+      def call *a, &b
+        subj.new *a, &b
+      end
+
+      # FIXME user-actions sounds more abstract
+      #       but it is coupled to keys...
+      #
+      it 'takes a key name and action block' do
+        call :enter do  puts :hey  end
+      end
+
+      it 'optionally takes a mapping of actions' do
+        mapping = {
+          :any => '*'
+        }
+        call(:any, mapping).match?('*').must_equal true
+        # odd test?
+        # even if to ignore it uses other methods
+        # (not certain about that yet)
+      end
+    end
+
+
+    describe '#matches?' do
+
+      it 'is aliased with #match?' do
+        action = subj.new :enter do end
+
+        action.method(:matches?).must_equal\
+          action.method(:match?)
+      end
+
+      it 'checks if a given key is handled by the action' do
+        action = subj.new :enter do end
+        action.matches?("\r").must_equal true
+        action.matches?(" ").must_equal false
+        action.matches?("\n").must_equal false
+        # the last one looks non-intuitive
+      end
+
+    end
+
+
+    describe '#call' do
+      it 'calls an action block' do
+        called = false
+        action = subj.new :enter do
+          called = true
+        end
+        called.must_equal false
+        action.call
+        called.must_equal true
+      end
+    end
+
+  end
+end

data/lib/dialog_tui/user_action/read_char.rb

@@ -0,0 +1,76 @@
+#
+# ↓ almost copy-pasted from a gist
+#
+
+
+require 'io/console'
+ 
+
+module DialogTui
+module UserAction
+
+module_function
+
+# Reads keypresses from the user including 2 and 3 escape character sequences.
+def read_char
+  STDIN.echo = false
+  STDIN.raw!
+ 
+  input = STDIN.getc.chr
+  if input == "\e" then
+    input << STDIN.read_nonblock(3) rescue nil
+    input << STDIN.read_nonblock(2) rescue nil
+  end
+ensure
+  STDIN.echo = true
+  STDIN.cooked!
+ 
+  return input
+end
+ 
+# oringal case statement from:
+# http://www.alecjacobson.com/weblog/?p=75
+def show_single_key
+  c = read_char
+ 
+  case c
+  when " "
+    puts "SPACE"
+  when "\t"
+    puts "TAB"
+  when "\r"
+    puts "RETURN"
+  when "\n"
+    puts "LINE FEED"
+  when "\e"
+    puts "ESCAPE"
+  when "\e[A"
+    puts "UP ARROW"
+  when "\e[B"
+    puts "DOWN ARROW"
+  when "\e[C"
+    puts "RIGHT ARROW"
+  when "\e[D"
+    puts "LEFT ARROW"
+  when "\177"
+    puts "BACKSPACE"
+  when "\004"
+    puts "DELETE"
+  when "\e[3~"
+    puts "ALTERNATE DELETE"
+  when "\u0003"
+    puts "CONTROL-C"
+    exit 0
+  when /^.$/
+    puts "SINGLE CHAR HIT: #{c.inspect}"
+  else
+    puts "SOMETHING ELSE: #{c.inspect}"
+  end
+end
+ 
+end
+end
+
+if __FILE__ == $0
+  DialogTui::UserAction.show_single_key while true
+end

data/lib/dialog_tui/user_action.rb

@@ -0,0 +1,130 @@
+require_relative 'user_action/action'
+require_relative 'user_action/read_char'
+
+# if it failed - needs to be killed manually
+# because ctrl+c is frozen
+# okish?
+
+module DialogTui
+  module UserAction
+    module_function
+
+    def user_action &block
+      UserActions.run &block
+    end
+    
+    class UserActions
+      def self.run &block
+        new(&block).run
+      end
+
+      def initialize
+        @actions = []
+        yield self
+      end
+
+      DSL_METHODS = %i[
+
+        ctrl_c
+
+        enter
+        esc
+
+        up
+        down
+        left
+        right
+      ]
+
+      DSL_METHODS.each { |name|
+        define_method name do |&block|
+          action = Action.new name, &block
+          @actions << action
+        end
+      }
+
+      def run
+        loop {
+          input = UserAction.read_char
+          matched = @actions.select { |x| x.matches? input }
+
+          if matched.any?
+            matched.each &:call
+            break
+          else
+            # just ignore and wait for next input
+          end
+        }
+      end
+
+    end
+  end
+end
+
+
+if __FILE__ == $0
+  require 'maxitest/autorun'
+
+  describe DialogTui::UserAction do
+    def subj
+      DialogTui::UserAction
+    end
+
+    describe 'user_action method' do
+      def this_method
+        :user_action
+      end
+
+      it 'can be included or called directly' do
+
+        subj = self.subj
+
+        _My = Class.new do
+          include subj
+        end
+
+        (_My.new.method(:non_existing) rescue :err).
+          must_equal :err
+
+        _My.new.method(this_method).
+          wont_equal nil
+
+        # actually not a deep testing of this one
+        # full testing is possible TODO maybe
+      end
+    end
+
+    it 'usage example' do
+
+      puts " = press arrows to manually test it,\
+           enter to finish,\
+           esc if test is failed = ".squeeze(' ')
+
+      finished = false
+
+      begin
+        subj.user_action { |key|
+          key.up do    p :up  end
+          key.down do  p :down  end
+          key.left do  p :left  end
+          key.right do p :right  end
+
+          key.enter do
+            finished = true
+          end
+          key.ctrl_c do
+            exit 0  # xz
+          end
+
+          key.esc do
+            'user decided the test is failed'.
+              must_equal 'user said enter if test is ok'
+            #raise 'user-driven test failed'
+          end
+        }
+      end until finished
+
+    end
+  end
+
+end

data/lib/dialog_tui/version.rb

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

data/lib/dialog_tui.rb

@@ -0,0 +1,177 @@
+require_relative 'dialog_tui/neighbors'
+require_relative 'dialog_tui/user_action'
+
+
+module DialogTui
+  module_function  # include or call explicitly
+
+
+  # preferred public interface
+  #
+  # usage example:
+  #
+  # dialog { |an|
+  #
+  #   an.option '1. first' do
+  #     puts 'hey, user just chosen this one!'
+  #   end
+  #
+  #   an.option '2. second' do
+  #   end
+  #
+  #   an.option 'you got it' do
+  #   end
+  # }
+  #
+  def dialog &block
+    Dialog.run &block
+  end
+
+
+  class Dialog
+    include UserAction
+
+    def self.run &block
+      new(&block).run
+    end
+
+
+    def initialize &block
+      @options = []
+
+      if block.arity == 0
+        instance_eval &block
+      else
+        block.call self
+      end
+
+      raise unless @options.count > 0
+      # options list is assumed to be fixed now
+
+      @current = @options.first
+      @neighbors = Neighbors.new @options
+    end
+
+    def run
+      begin
+        # print_usage  #...
+        print_options  # would be nice to have a printer...
+
+        done = false
+        
+        user_action { |key|
+
+          key.up do
+            @current = prev
+          end
+
+          key.down do
+            @current = nexxt
+          end
+
+          #key.ctrl_c do  exit 0  end
+          #key.esc do     exit 0  end
+
+          key.enter do
+            done = true
+          end
+        }
+      end until done
+
+      @current.call
+    end
+
+    def chosen? option
+      @current == option  # so current or chosen?)
+    end
+
+    private
+    def option text, &reaction
+      option = Option.new self, text, &reaction  # order?
+      @options.push option
+    end
+
+    def print_options
+      puts '-'*10
+      @options.each &:print
+      puts '-'*10
+    end
+
+    def prev
+      @neighbors.prev @current
+    end
+
+    def nexxt
+      @neighbors.next @current
+    end
+  end
+
+
+  # NOTE: not sure about perfomance implications
+  # of that chain of &block passing instead of
+  # just using variable w/o `&`
+  # but & looks very explicit and is not as annoying
+  # as additional parameter
+
+  class Option
+    def initialize dialog, text, &reaction
+      @dialog = dialog
+      @text = text.to_s
+      @reaction = reaction
+    end
+
+    def call
+      @reaction.call
+    end
+
+    def print printer=nil  # just to be here for future
+                                          # refactoring
+      if chosen?
+        puts '=> ' + @text
+      else
+        puts '   ' + @text
+      end
+    end
+
+    def chosen?
+      @dialog.chosen? self
+    end
+  end
+
+
+end
+
+
+if __FILE__ == $0
+
+  class My
+    include DialogTui
+  
+    def act
+  
+      dialog {
+  
+        option '1. hey' do
+          puts 'you choose the first one!'
+        end
+  
+        option '2. hi!' do
+          puts 'you choose the second one!'
+        end
+  
+        option '3. bye' do
+          puts '*waving*'
+        end
+      }.
+      tap { |result|
+        raise unless result.nil?
+        # because it works for effect, not for return value
+      }
+  
+    end
+  end
+  
+  puts 'manual testing here - use arrows and enter'
+  puts 'no way to fail it - just look at behavior'
+  3.times { My.new.act }
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: dialog_tui
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander K
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: maxitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: " dsl for simple dialogs/menus for simple terminal ui apps with no other
+  deps currently "
+email:
+- xpyro@ya.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dialog_tui.gemspec
+- lib/dialog_tui.rb
+- lib/dialog_tui/neighbors.rb
+- lib/dialog_tui/user_action.rb
+- lib/dialog_tui/user_action/action.rb
+- lib/dialog_tui/user_action/read_char.rb
+- lib/dialog_tui/version.rb
+homepage: https://github.com/sowcow/dialog_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.4.6
+signing_key: 
+specification_version: 4
+summary: menu for terminal ui
+test_files: []