inquirer.rb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0f63e9bf358de3b79f5c60ccad3b272a6d7dc80d
+  data.tar.gz: d09700b350451f94f2961a7d327c9b59b7fdcd42
+SHA512:
+  metadata.gz: 6c7de1dd06980bed7ccd599ad8554352a152b5b46959020211f04693f9fad08a8799d77c4c0191b9939a97b66f044aa40ddddd5bc28618bda15a68053968692d
+  data.tar.gz: 9e10b66b41f0f913ba9594d98bca9b313875df9ca32061a2a8f4f4368d42b65f5588a40188712796bc8260f65696bffb11f522710208c050f131ee2f8f6e405f

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# 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

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,197 @@
+# Inquirer
+
+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).
+
+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'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install inquirer
+
+## 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
+- `: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
+- `: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] `: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)
+- [ ] `: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).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/examples/checkbox.rb

@@ -0,0 +1,203 @@
+lib = File.expand_path('../../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'inquirer'
+
+questions = [
+  {
+    name:    :invitation,
+    type:    :checkbox,
+    message: 'Who should get invited?',
+    choices: [
+      {
+        name:  'Karl',
+        short: 'Kalli',
+      },
+      {
+        name:  'Bert',
+        value: "It's Bert!"
+      },
+      {
+        name:  'Berta',
+        value: :love
+      },
+      {
+        name: 'Manfred',
+      },
+    ],
+  },
+  {
+    name:    :invitation_default,
+    type:    :checkbox,
+    message: 'Who should get invited?',
+    choices: [
+      {
+        name:  'Karl',
+        short: 'Kalli',
+      },
+      {
+        name:  'Bert',
+        value: "It's Bert!"
+      },
+      {
+        name:  'Berta',
+        value: :love
+      },
+      {
+        name: 'Manfred',
+      },
+    ],
+    default:  [
+      "It's Bert!",
+      :love,
+      'Manfred',
+    ],
+  },
+  {
+    name:    :invitation_never,
+    type:    :checkbox,
+    message: 'Who should get invited?',
+    choices: [
+      {
+        name:  'Karl',
+        short: 'Kalli',
+      },
+      {
+        name:  'Bert',
+        value: "It's Bert!"
+      },
+      {
+        name:  'Berta',
+        value: :love
+      },
+      {
+        name: 'Manfred',
+      },
+    ],
+    when: false,
+  },
+  {
+    name:    :invitation_never_lambda,
+    type:    :checkbox,
+    message: 'Who should get invited?',
+    choices: [
+      {
+        name:  'Karl',
+        short: 'Kalli',
+      },
+      {
+        name:  'Bert',
+        value: "It's Bert!"
+      },
+      {
+        name:  'Berta',
+        value: :love
+      },
+      {
+        name: 'Manfred',
+      },
+    ],
+    when:    lambda { |answers| true },
+  },
+  {
+    name:    :invitation_when_previous,
+    type:    :checkbox,
+    message: 'Who should get invited?',
+    choices: [
+      {
+        name:  'Karl',
+        short: 'Kalli',
+      },
+      {
+        name:  'Bert',
+        value: "It's Bert!"
+      },
+      {
+        name:  'Berta',
+        value: :love
+      },
+      {
+        name: 'Manfred',
+      },
+    ],
+    when: lambda { |answers| answers[:invitation_default].size > 1 },
+  },
+  {
+    name:     :invitation_validate_size,
+    type:     :checkbox,
+    message:  'Who should get invited?',
+    choices: [
+      {
+        name:  'Karl',
+        short: 'Kalli',
+      },
+      {
+        name:  'Bert',
+        value: "It's Bert!"
+      },
+      {
+        name:  'Berta',
+        value: :love
+      },
+      {
+        name: 'Manfred',
+      },
+    ],
+    validate: lambda { |answer| answer.size == 2 },
+  },
+  {
+    name:     :invitation_validate_tyler_message,
+    type:     :checkbox,
+    message:  'Who should get invited?',
+    choices: [
+      {
+        name:  'Karl',
+        short: 'Kalli',
+      },
+      {
+        name:  'Bert',
+        value: "It's Bert!"
+      },
+      {
+        name:  'Berta',
+        value: :love
+      },
+      {
+        name: 'Manfred',
+      },
+    ],
+    validate: lambda { |answer|
+        return true if answer.include? 'Tyler'
+        'Only Tyler!'
+      },
+  },
+  {
+    name:    :invitation_filter_tyler,
+    type:    :checkbox,
+    message: 'Who should get invited?',
+    choices: [
+      {
+        name:  'Karl',
+        short: 'Kalli',
+      },
+      {
+        name:  'Bert',
+        value: "It's Bert!"
+      },
+      {
+        name:  'Berta',
+        value: :love
+      },
+      {
+        name: 'Manfred',
+      },
+    ],
+    filter:  lambda { |answer|
+        ['Tyler']
+      },
+  },
+]
+
+answers = Inquirer.prompt(questions)
+
+p answers