inquirer.rb 0.0.1

data/lib/inquirer/prompts/password.rb

@@ -0,0 +1,15 @@
+require 'inquirer/prompts/input'
+require 'inquirer/style/password'
+
+module Password
+
+  extend Input
+  extend self
+
+  # this function is necessary to reduce code
+  # duplication of the password promt engine
+  # to a minimum
+  def display_value
+    Inquirer::Style::Password.placeholder_char * @value.size
+  end
+end

data/lib/inquirer/style.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+require 'term/ansicolor'
+
+module Inquirer
+  class Style
+
+    @@color = Term::ANSIColor
+
+    @@question_prefix = @@color.green('?') + ' '
+    @@seperator       = '--------'
+
+    @@question = '%s '
+    @@response = @@color.cyan('%s')
+
+    @@selector     = @@color.cyan('‣')
+    @@checkbox_on  = @@color.green('◉')
+    @@checkbox_off = '◯'
+
+    @@pagiator_text = '(Move up and down to reveal more choices)'
+
+    @@error_message               = @@color.red('>>') + ' %s'
+    @@error_message_invalid_value = 'The entered value is not valid'
+
+    @@endless_repeat = @@color.yellow('#%s')
+    @@limited_repeat = @@color.yellow('#%s of %s')
+
+    # http://blog.marc-seeger.de/2011/04/06/attr_reader-for-class-variables-in-ruby/
+    def self.activate_getter_setter
+      # this creates the methods when the class is loaded
+      self.class_variables.each{ |sym|
+
+        # build the meta syntax
+        class_variable_getter_and_setter = <<EVALME
+
+    # getter
+    def self.#{sym.to_s.gsub('@@','')}
+      #{sym}
+    end
+
+    # setter
+    def self.#{sym.to_s.gsub('@@','')}=(value)
+      #{sym} = value
+    end;
+EVALME
+        class_eval(class_variable_getter_and_setter)
+      }
+    end
+
+    self.activate_getter_setter
+  end
+end

data/lib/inquirer/style/checkbox.rb

@@ -0,0 +1,16 @@
+require 'inquirer/utils/iochar'
+require 'inquirer/style'
+
+module Inquirer
+  class Style
+    class Checkbox < Inquirer::Style
+
+      @@item         = "%s#{IOChar.newline}"
+      @@checked_item = "%s#{IOChar.newline}"
+
+      @@selection_help = '(Press <space> to select)'
+
+      self.activate_getter_setter
+    end
+  end
+end

data/lib/inquirer/style/confirm.rb

@@ -0,0 +1,15 @@
+require 'inquirer/utils/iochar'
+require 'inquirer/style'
+
+module Inquirer
+  class Style
+    class Confirm < Inquirer::Style
+
+      @@options      = '(%s/%s)'
+      @@option_true  = 'Yes'
+      @@option_false = 'No'
+
+      self.activate_getter_setter
+    end
+  end
+end

data/lib/inquirer/style/input.rb

@@ -0,0 +1,13 @@
+require 'inquirer/style'
+
+module Inquirer
+  class Style
+    class Input < Inquirer::Style
+
+      @@default  = '(%s) '
+      @@value    = '%s'
+
+      self.activate_getter_setter
+    end
+  end
+end

data/lib/inquirer/style/list.rb

@@ -0,0 +1,16 @@
+require 'inquirer/utils/iochar'
+require 'inquirer/style'
+
+module Inquirer
+  class Style
+    class List < Inquirer::Style
+
+      @@item          = "%s#{IOChar.newline}"
+      @@selected_item = @@color.cyan('%s') + IOChar.newline
+
+      @@selection_help = '(Use arrow keys)'
+
+      self.activate_getter_setter
+    end
+  end
+end

data/lib/inquirer/style/password.rb

@@ -0,0 +1,12 @@
+require 'inquirer/style'
+
+module Inquirer
+  class Style
+    class Password < Inquirer::Style::Input
+
+      @@placeholder_char = '*'
+
+      self.activate_getter_setter
+    end
+  end
+end

data/lib/inquirer/utils/iochar.rb

@@ -0,0 +1,32 @@
+require 'io/console'
+
+module IOChar
+  extend self
+
+  KEYS = {
+    ' '    => 'space',
+    "\t"   => 'tab',
+    "\r"   => 'return',
+    "\n"   => 'linefeed',
+    "\e"   => 'escape',
+    "\e[A" => 'up',
+    "\e[B" => 'down',
+    "\e[C" => 'right',
+    "\e[D" => 'left',
+    "\177" => 'backspace',
+    "\003" => 'ctrl-c',
+    "\004" => 'ctrl-d',
+  }
+
+  def char_to_key char
+    KEYS.fetch char, char
+  end
+
+  def newline;         "\n"    end
+  def carriage_return; "\r"    end
+  def cursor_up;       "\e[A"  end
+  def cursor_down;     "\e[B"  end
+  def cursor_right;    "\e[C"  end
+  def cursor_left;     "\e[D"  end
+  def clear_line;      "\e[0K" end
+end

data/lib/inquirer/utils/iohelper.rb

@@ -0,0 +1,123 @@
+require 'io/console'
+require 'inquirer/utils/iochar'
+
+module IOHelper
+  extend self
+
+  @rendered   = ''
+  @bottomline = nil
+
+  # Get each key the user presses and hand it one by one to the block. Do this
+  # as long as the block returns truthy
+  # Params:
+  # +&block+:: +Proc+ a block that receives a user key and returns truthy or falsy
+  def read_char &block
+    STDIN.noecho do
+      # as long as the block doen't return falsy,
+      # read the user input key and sned it to the block
+      while block.( IOHelper.get_char )
+      end
+    end
+  end
+
+  # read a character the user enters on console. This call is synchronous blocking.
+  # this is taken from: http://www.alecjacobson.com/weblog/?p=75
+  # and: https://gist.github.com/acook/4190379
+  def get_char
+    begin
+      # save previous state of stty
+      old_state = `stty -g`
+      # disable echoing and enable raw (not having to press enter)
+      system 'stty raw -echo'
+      char = STDIN.getc.chr
+      # gather next two characters of special keys
+      if char == "\e"
+        char << STDIN.read_nonblock(3) rescue nil
+        char << STDIN.read_nonblock(2) rescue nil
+      end
+
+      # restore previous state of stty
+      system "stty #{old_state}"
+    end
+
+    key = IOChar.char_to_key(char)
+
+    if key == 'ctrl-c' or key == 'ctrl-d'
+      raise Interrupt
+    end
+
+    char
+  end
+
+  def winsize
+    STDIN.winsize
+  end
+
+  # render a text to the prompt
+  def render prompt, bottomline = nil
+    @rendered   = wrap(prompt)
+    @bottomline = bottomline
+
+    # determine how many lines to move up
+    lines = @rendered.scan(/\n/).size + 1
+
+    if @bottomline
+      print IOChar.newline * lines + @bottomline + IOChar.cursor_left * @bottomline.size + IOChar.cursor_up * lines
+    end
+    print @rendered
+  end
+
+  # clear the console based on the last text rendered
+  def clear
+    # determine how many lines to move up
+    lines = @rendered.scan(/\n/).length
+
+    if @bottomline
+      print IOChar.cursor_down + IOChar.carriage_return + IOChar.clear_line + IOChar.cursor_up
+    end
+
+    # jump back to the first position and clear the line
+    print IOChar.cursor_down + IOChar.carriage_return + IOChar.clear_line + IOChar.cursor_up + IOChar.clear_line + IOChar.carriage_return + ( IOChar.cursor_up + IOChar.clear_line ) * lines + IOChar.clear_line
+  end
+
+  # hides the cursor and ensure the curso be visible at the end
+  def without_cursor
+    # tell the terminal to hide the cursor
+    print `tput civis`
+    begin
+      # run the block
+      yield
+    ensure
+      # tell the terminal to show the cursor
+      print `tput cnorm`
+    end
+  end
+
+  # inspired by http://apidock.com/rails/ActionView/Helpers/TextHelper/word_wrap
+  # maybe interesting: https://www.safaribooksonline.com/library/view/ruby-cookbook/0596523696/ch01s15.html
+  def wrap(string)
+
+    height, width = IOHelper.winsize
+
+    keep_trailing_newline = false
+    if string[-1, 1] == IOChar.newline
+      keep_trailing_newline = true
+    end
+
+    result = string.split(IOChar.newline).collect! do |line|
+      if line.length > width
+        line.gsub(/(.{1,#{width}})(\s+|$)/, "\\1#{ IOChar.newline }")
+      else
+        line
+      end
+    end * IOChar.newline
+
+    if keep_trailing_newline
+      result += IOChar.newline
+    else
+      result.chomp!
+    end
+
+    result + IOChar.clear_line
+  end
+end

data/lib/inquirer/utils/paginator.rb

@@ -0,0 +1,37 @@
+require 'inquirer/utils/iochar'
+
+class Paginator
+
+  def initialize
+    @pointer    = 0
+    @last_index = 0
+    @page_size  = 7
+  end
+
+  def paginate(content, current_position)
+
+    lines_list = content.lines
+
+    # Make sure there's enough lines to paginate
+    return content if lines_list.count < (@page_size + 2)
+
+    promt_question = lines_list.shift
+    lines_count    = lines_list.count
+    infinite       = lines_list * 3
+
+    # Move the pos only when the user go down and limit it to 3
+    if @pointer < 3 && @last_index < current_position && current_position - @last_index < 9
+      @pointer = [3, @pointer + current_position - @last_index].min
+    end
+    @last_index = current_position
+
+    top_index = [0, current_position + lines_count - @pointer].max
+    section   = infinite.slice(top_index, @page_size).join
+
+    [
+      promt_question,
+      section,
+      Inquirer::Style.pagiator_text + IOChar.newline
+    ].join(IOChar.newline)
+  end
+end

data/lib/inquirer/version.rb

@@ -0,0 +1,3 @@
+module Inquirer
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: inquirer.rb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Thorsten Eckel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: term-ansicolor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: A collection of common interactive command line user interfaces. A (not
+  yet compleded) clone of the great Inquirer.js (https://github.com/SBoudrias/Inquirer.js)
+  and strongly inspired by the similar inquirer.rb (https://github.com/arlimus/inquirer.rb).
+email:
+- te@znuny.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/checkbox.rb
+- examples/confirm.rb
+- examples/input.rb
+- examples/list.rb
+- examples/password.rb
+- inquirer.gemspec
+- lib/inquirer.rb
+- lib/inquirer/prompts/checkbox.rb
+- lib/inquirer/prompts/confirm.rb
+- lib/inquirer/prompts/input.rb
+- lib/inquirer/prompts/list.rb
+- lib/inquirer/prompts/password.rb
+- lib/inquirer/style.rb
+- lib/inquirer/style/checkbox.rb
+- lib/inquirer/style/confirm.rb
+- lib/inquirer/style/input.rb
+- lib/inquirer/style/list.rb
+- lib/inquirer/style/password.rb
+- lib/inquirer/utils/iochar.rb
+- lib/inquirer/utils/iohelper.rb
+- lib/inquirer/utils/paginator.rb
+- lib/inquirer/version.rb
+- screenshots/checkbox.png
+- screenshots/confirm.png
+- screenshots/input.png
+- screenshots/list.png
+- screenshots/password.png
+homepage: https://github.com/thorsteneckel/inquirer
+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.8
+signing_key: 
+specification_version: 4
+summary: A collection of common interactive command line user interfaces.
+test_files: []