inquirer.rb 0.0.2 → 0.0.4

data/lib/inquirer/style.rb

@@ -1,28 +1,26 @@
 # encoding: utf-8
-require 'term/ansicolor'
+require 'rainbow'
 
 module Inquirer
   class Style
 
-    @@color = Term::ANSIColor
-
-    @@question_prefix = @@color.green('?') + ' '
+    @@question_prefix = Rainbow('?').green + ' '
     @@seperator       = '--------'
 
     @@question = '%s '
-    @@response = @@color.cyan('%s')
+    @@response = Rainbow('%s').cyan
 
-    @@selector     = @@color.cyan('‣')
-    @@checkbox_on  = @@color.green('◉')
+    @@selector     = Rainbow('‣').cyan
+    @@checkbox_on  = Rainbow('◉').green
     @@checkbox_off = '◯'
 
     @@pagiator_text = '(Move up and down to reveal more choices)'
 
-    @@error_message               = @@color.red('>>') + ' %s'
+    @@error_message               = Rainbow('>>').red + ' %s'
     @@error_message_invalid_value = 'The entered value is not valid'
 
-    @@endless_repeat = @@color.yellow('#%s')
-    @@limited_repeat = @@color.yellow('#%s of %s')
+    @@endless_repeat = Rainbow('#%s').yellow
+    @@limited_repeat = Rainbow('#%s of %s').yellow
 
     # http://blog.marc-seeger.de/2011/04/06/attr_reader-for-class-variables-in-ruby/
     def self.activate_getter_setter

data/lib/inquirer/style/checkbox_filterable.rb

@@ -0,0 +1,14 @@
+require 'inquirer/utils/iochar'
+require 'inquirer/style'
+
+module Inquirer
+  class Style
+    class CheckboxFilterable < Inquirer::Style::Checkbox
+
+      @@filter        = '%s'
+      @@filter_prefix = Rainbow('>').cyan + ' '
+
+      self.activate_getter_setter
+    end
+  end
+end

data/lib/inquirer/style/list.rb

@@ -6,7 +6,7 @@ module Inquirer
     class List < Inquirer::Style
 
       @@item          = "%s#{IOChar.newline}"
-      @@selected_item = @@color.cyan('%s') + IOChar.newline
+      @@selected_item = Rainbow('%s').cyan + IOChar.newline
 
       @@selection_help = '(Use arrow keys)'
 

data/lib/inquirer/style/list_filterable.rb

@@ -0,0 +1,14 @@
+require 'inquirer/utils/iochar'
+require 'inquirer/style'
+
+module Inquirer
+  class Style
+    class ListFilterable < Inquirer::Style::List
+
+      @@filter        = '%s'
+      @@filter_prefix = Rainbow('>').cyan + ' '
+
+      self.activate_getter_setter
+    end
+  end
+end

data/lib/inquirer/utils/iochar.rb

@@ -18,10 +18,14 @@ module IOChar
     "\004" => 'ctrl-d',
   }
 
-  def char_to_key char
+  def char_to_key(char)
     KEYS.fetch char, char
   end
 
+  def key_to_char(key)
+    KEYS.invert.fetch key, key
+  end
+
   def newline;         "\n"    end
   def carriage_return; "\r"    end
   def cursor_up;       "\e[A"  end

data/lib/inquirer/utils/iohelper.rb

@@ -54,20 +54,11 @@ module IOHelper
   end
 
   # render a text to the prompt
-  def render prompt, bottomline = nil
+  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
-
-    plain_last_line = plain_chars(@rendered.lines.last)
-    print IOChar.newline + IOChar.cursor_up + IOChar.cursor_right * plain_last_line.length
+    print rendered_output
   end
 
   # clear the console based on the last text rendered
@@ -87,7 +78,7 @@ module IOHelper
     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
+  # hides the cursor and ensure the cursor be visible at the end
   def without_cursor
     # tell the terminal to hide the cursor
     print `tput civis`
@@ -131,4 +122,23 @@ module IOHelper
   def plain_chars(string)
     string.gsub(/\e\[([;\dA-Z]+)?m?/, '')
   end
+
+  private
+
+  def rendered_output
+
+    output = ''
+
+    if @bottomline
+      # determine how many lines to move up
+      lines   = @rendered.scan(/\n/).size + 1
+      output += IOChar.newline * lines + @bottomline + IOChar.cursor_left * @bottomline.size + IOChar.cursor_up * lines
+    end
+    output += @rendered
+
+    plain_last_line = plain_chars(@rendered.lines.last)
+    output += IOChar.newline + IOChar.cursor_up + IOChar.cursor_right * plain_last_line.length
+
+    output
+  end
 end

data/lib/inquirer/version.rb

@@ -1,3 +1,3 @@
 module Inquirer
-  VERSION = '0.0.2'
+  VERSION = '0.0.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inquirer.rb
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Thorsten Eckel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-20 00:00:00.000000000 Z
+date: 2016-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -39,61 +39,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: term-ansicolor
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :runtime
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.1'
 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)
+  yet completed) 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
+email: 
 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/checkbox_filterable.rb
 - lib/inquirer/prompts/confirm.rb
 - lib/inquirer/prompts/input.rb
 - lib/inquirer/prompts/list.rb
+- lib/inquirer/prompts/list_filterable.rb
 - lib/inquirer/prompts/password.rb
 - lib/inquirer/style.rb
 - lib/inquirer/style/checkbox.rb
+- lib/inquirer/style/checkbox_filterable.rb
 - lib/inquirer/style/confirm.rb
 - lib/inquirer/style/input.rb
 - lib/inquirer/style/list.rb
+- lib/inquirer/style/list_filterable.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

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -1,49 +0,0 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, and in the interest of
-fostering an open and welcoming community, 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, religion, or nationality.
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
-* Public or private harassment
-* Publishing other's private information, such as physical or electronic
-  addresses, without explicit permission
-* Other unethical or 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, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-By adopting this Code of Conduct, project maintainers commit themselves to
-fairly and consistently applying these principles to every aspect of managing
-this project. Project maintainers who do not follow or enforce the Code of
-Conduct may be permanently removed from the project team.
-
-This code of conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at te@znuny.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. Maintainers are
-obligated to maintain confidentiality with regard to the reporter of an
-incident.
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 1.3.0, available at
-[http://contributor-covenant.org/version/1/3/0/][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2016 Thorsten Eckel
-
-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

@@ -1,203 +0,0 @@
-# inquirer.rb
-
-A collection of common interactive command line user interfaces. A (not yet completed) 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).
-
-Started as a fork of [inquirer.rb](https://github.com/arlimus/inquirer.rb) the changes become to fundamental to keep it that way.
-
-## Goals
-
-- [Inquirer.js](https://github.com/SBoudrias/Inquirer.js) API conform as possible
-- Extended functionality API similar as possible
-- Slim dependencies
-- Easy integration
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'inquirer.rb'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install inquirer.rb
-
-## Usage
-
-```ruby
-require 'inquirer'
-
-questions = [
-  {
-    name:    :user_name,
-    type:    :input,  # optional - default ':input', others see below
-    message: 'What is your name?',
-  }
-]
-
-answers = Inquirer.prompt(questions)
-
-p answers[:user_name]
-
-# => Tyler
-```
-
-See the `examples` folder for more examples.
-
-Basically it's:
-- `Inquirer.prompt` takes an Array as parameter, containing question Hashes
-- Each question Hash has to contain the parameters required for the given `:type` parameter
-- If no `:type` paramter is given `:input` is used as default
-- `Inquirer.prompt` returns a Hash with the question `:name` parameter as key and the user input as value
-
-### Prompt types
-
-There parameters are valid for all prompt types:
-
-- `:message` (String) The question to print.
-- `:filter` (Proc) (optional) Receive the user input and return the filtered value to be used inside the program. The value returned will be added to the answers Hash.
-- `:when` (Proc|Boolean) (optional) Receive the current user answers Hash and should return true or false depending on whether or not this question should be asked. The value can also be a simple boolean.
-
-#### Input (`type: :input`)
-
-![:input](screenshots/input.png ":input")
-
-- `:default` (String) (optional) Default value to use if nothing is entered.
-- `:validate` (Proc) (optional) Receive the user input and should return true if the value is valid, and an error message (String) otherwise. If false is returned, a default error message is provided.
-
-#### Password (`type: :password`)
-
-![:password](screenshots/password.png ":password")
-
-- `:default` (String) (optional) Default value to use if nothing is entered.
-- `:validate` (Proc) (optional) Receive the user input and should return true if the value is valid, and an error message (String) otherwise. If false is returned, a default error message is provided.
-
-#### List (`type: :list`)
-
-![:list](screenshots/list.png ":list")
-
-- `:choices` (Array) Has to contain Hashes with the following parameters:
-  - `:name` (String) The display value
-  - `:short` (String) (optional) To display after selection
-  - `:value` (String|Symbol) To save in the answers Hash
-  - `:when` (Proc|Boolean) (optional) Should return true or false depending on whether or not this question should be asked. The value can also be a simple boolean.
-- `:default` (Integer|String|Symbol) (optional) Must be the choice index (Integer) in the Array or a choice `:value` parameters value (String|Symbol).
-
-#### Checkbox (`type: :checkbox`)
-
-![:checkbox](screenshots/checkbox.png ":checkbox")
-
-- `:choices` (Array) Has to contain Hashes with the following parameters:
-  - `:name` (String) The display value
-  - `:short` (String) (optional) To display after selection
-  - `:value` (String|Symbol) To save in the answers Hash
-  - `:checked` (Boolean) (optional) True choices will be checked by default
-  - `:when` (Proc|Boolean) (optional) Should return true or false depending on whether or not this question should be asked. The value can also be a simple boolean.
-- `:default` (Array) (optional) An Array of choices `:value` parameters values (String|Symbol).
-- `:validate` (Proc) (optional) Receive the user input and should return true if the value is valid, and an error message (String) otherwise. If false is returned, a default error message is provided.
-
-#### Confirm (`type: :confirm`)
-
-![:confirm](screenshots/confirm.png ":confirm")
-
-- `:default` (Boolean) (optional) Default value to use if nothing is entered is expected to be a boolean.
-
-## Development
-
-### General
-
-- [x] `:type` parameter (InquirerJS conform)
-- [x] no `:type` parameter provided results in `:input` (InquirerJS conform)
-- [x] `:name` parameter (InquirerJS conform)
-- [x] `:message` (String) parameter (InquirerJS conform)
-- [ ] `:message` (Proc) parameter (InquirerJS conform)
-- [x] `:default` (String) parameter (optional) (InquirerJS conform)
-- [ ] `:default` (Proc) parameter (optional) (InquirerJS conform)
-- [x] `:when`  (Proc) parameter (optional) (InquirerJS conform)
-- [x] `:when`  (Boolean) parameter (optional) (InquirerJS conform)
-- [x] `:filter` (Proc) parameter (optional)
-- [x] `:validate` (Proc) parameter (optional) (InquirerJS conform)
-- [x] colored formatting (InquirerJS conform)
-- [x] easy styling / formatting of all output components (question, result, items, password....)
-
-### Input
-
-- [x] Backend
-- [x] `:validate` (Proc) parameter (optional) (InquirerJS conform)
-- [ ] Tests
-
-### Password
-
-- [x] Backend
-- [x] `:validate` (Proc) parameter (optional) (InquirerJS conform)
-- [ ] Tests
-
-### List
-
-- [x] Backend
-- [x] `:choices` (Array) parameter (InquirerJS conform)
-- [ ] `:choices` (Proc) parameter (InquirerJS conform)
-- [x] `:choices` `:name` parameter (InquirerJS conform)
-- [x] `:choices` `:value` parameter (InquirerJS conform)
-- [x] `:choices` `:short` parameter (InquirerJS conform)
-- [x] `:choices` `:when` (Proc) parameter
-- [x] `:choices` `:when` (Boolean) parameter
-- [x] `:validate` (Proc) parameter (optional) (InquirerJS conform)
-- [ ] Tests
-
-### Checkbox
-
-- [x] Backend
-- [x] `:choices` (Array) parameter (InquirerJS conform)
-- [ ] `:choices` (Proc) parameter (InquirerJS conform)
-- [x] `:choices` `:name` parameter (InquirerJS conform)
-- [x] `:choices` `:value` parameter (InquirerJS conform)
-- [x] `:choices` `:checked` parameter (InquirerJS conform)
-- [x] `:choices` `:when` (Proc) parameter
-- [x] `:choices` `:when` (Boolean) parameter
-- [ ] `:choices` `:disabled` (String) parameter (InquirerJS conform)
-- [ ] `:choices` `:disabled` (Boolean) parameter (InquirerJS conform)
-- [ ] `:choices` `:disabled` (Proc) parameter (InquirerJS conform)
-- [x] `:choices` `:short` parameter
-- [ ] Tests
-
-### Confirm
-
-- [x] Backend
-- [ ] Tests
-
-### Raw List
-
-- [ ] Backend
-- [ ] `:choices` parameter (InquirerJS conform)
-- [ ] Tests
-
-### Expand
-
-- [ ] Backend
-- [ ] `:choices` parameter (InquirerJS conform)
-- [ ] Tests
-
-### Seperator
-
-- [ ] constructor takes a facultative String value that'll be use as the separator (InquirerJS conform)
-- [ ] default separator `--------` (InquirerJS conform)
-- [ ] Tests
-
-### BottomBar
-
-- [ ] fixed text at the bottom of a free text zone (InquirerJS conform)
-- [ ] Tests
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/thorsteneckel/inquirer. 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](http://opensource.org/licenses/MIT).