interactive 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ff5d5591031e2228dd4f07ed37081474cb1fb92
+  data.tar.gz: 0ef086b79a0b7d5cbf3c3053b3239a443a8c9414
+SHA512:
+  metadata.gz: 7d838a2550a4560dc1e63543a8bcb58108ebca75ea3c9b8c38f10bf5cf8cc3fdbde9979c555db23b398034aa5d92b369c87fceefeb2b21b7b2e83500ecc70a5f
+  data.tar.gz: 15c8b7095256e042bd2d882f7f2f1ad43165e590cb1fe60dd1eaaa6f40789e49db849d78b16b99a3f6b5b264dbee0578555c9cb08dbddb28ed1780828a681917

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.un~

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

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 interactive.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Edderic Ugaddan
+
+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,75 @@
+# Interactive
+This is a helper module to assist in interactive question-answering events in the command line.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'interactive_question'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install interactive_question
+
+## Usage
+
+If you want to ask a user a question expecting certain answers:
+
+```ruby
+question = Interactive::Question.new do |ques|
+  ques.question = "What do you want to do?"
+  ques.options = [:add, :edit, :update, :remove]
+end
+```
+
+You can run the loop and wait for a valid response:
+
+```ruby
+question.ask_and_wait_for_valid_response do |response|
+  if response.add?
+    # add the thingymajigger
+  elsif response.edit?
+    # edit the thingymajigger
+  elsif response.update?
+    # etc...
+  end
+end
+```
+
+That will ask the question appended by the shortcuts:
+
+```ruby
+# => What do you want to do? [a/e/u/r]
+```
+
+If the response is invalid, it prints out the question and goes into detail as
+to what the shortcuts stand for:
+
+```ruby
+$ bad-response
+# => What do you want to do? [a/e/u/r]
+# =>   a -- add
+# =>   e -- edit
+# =>   u -- update
+# =>   r -- remove
+```
+
+## 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]/interactive_question/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 "interactive"
+
+# 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/interactive.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'interactive/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "interactive"
+  spec.version       = Interactive::VERSION
+  spec.authors       = ["Edderic Ugaddan"]
+  spec.email         = ["edderic@gmail.com"]
+
+  spec.summary       = %q{command-line helper, prints out questions and waits for valid responses}
+  spec.homepage      = "http://github.com/Edderic/interactive"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  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"
+end

data/lib/interactive/question.rb

@@ -0,0 +1,49 @@
+module Interactive
+  class Question
+    attr_accessor :question, :options
+
+    def initialize(&block)
+      yield self
+    end
+
+    def ask_and_wait_for_valid_response(&block)
+      resp = NullResponse.new
+
+      while resp.invalid? do
+        puts "#{question} #{shortcuts_string}"
+        resp = Interactive::Response.new(options)
+        puts shortcuts_meanings if resp.invalid?
+
+        yield resp
+      end
+    end
+
+    class NullResponse
+      def invalid?
+        true
+      end
+    end
+
+    private
+
+    def response
+      STDIN.gets.chomp
+    end
+
+    def shortcuts_meanings
+      options.inject("") { |accum, opt| "#{accum}  #{opt[0]} -- #{opt}\n"}
+    end
+
+    def options_first_chars
+      options.inject("") { |accum, opt| "#{accum}#{opt[0]}/" }
+    end
+
+    def shortcuts_string
+      "[#{options_first_chars_without_last_slash(options_first_chars)}]"
+    end
+
+    def options_first_chars_without_last_slash(options_first_chars)
+      options_first_chars[0..options_first_chars.length-2]
+    end
+  end
+end

data/lib/interactive/response.rb

@@ -0,0 +1,26 @@
+module Interactive
+  class Response
+    def initialize(*args)
+      if args.first.class.ancestors.include?(Enumerable)
+        @args = args.first
+      else
+        @args = args
+      end
+
+      raise ArgumentError, "wrong number of arguments (need at least two arguments)" if @args.length == 1
+      raise ArgumentError, "may not use :invalid or 'invalid' as an argument. May not overwrite Interactive::Response#invalid" if @args.map(&:to_s).include?('invalid')
+
+      @_response = STDIN.gets.chomp
+
+      @args.each do |arg|
+        define_singleton_method "#{arg}?" do
+          @_response.match(/^#{arg[0]}$/i) ? true : false
+        end
+      end
+
+      define_singleton_method "invalid?" do
+        methods(false).reject {|m| m == :invalid? }.none? {|m| send(m) }
+      end
+    end
+  end
+end

data/lib/interactive/version.rb

@@ -0,0 +1,3 @@
+module Interactive
+  VERSION = "0.0.0"
+end

data/lib/interactive.rb

@@ -0,0 +1,4 @@
+require "interactive/version"
+require 'interactive/question'
+require 'interactive/response'
+

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: interactive
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Edderic Ugaddan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-14 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'
+description: 
+email:
+- edderic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- interactive.gemspec
+- lib/interactive.rb
+- lib/interactive/question.rb
+- lib/interactive/response.rb
+- lib/interactive/version.rb
+homepage: http://github.com/Edderic/interactive
+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.5
+signing_key: 
+specification_version: 4
+summary: command-line helper, prints out questions and waits for valid responses
+test_files: []