interactive 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ff5d5591031e2228dd4f07ed37081474cb1fb92
-  data.tar.gz: 0ef086b79a0b7d5cbf3c3053b3239a443a8c9414
+  metadata.gz: f2c6959fba0126e77b3a9147f7f23435a19064cf
+  data.tar.gz: 7418c32a98aacddb6df983502f09abdf738f2d5c
 SHA512:
-  metadata.gz: 7d838a2550a4560dc1e63543a8bcb58108ebca75ea3c9b8c38f10bf5cf8cc3fdbde9979c555db23b398034aa5d92b369c87fceefeb2b21b7b2e83500ecc70a5f
-  data.tar.gz: 15c8b7095256e042bd2d882f7f2f1ad43165e590cb1fe60dd1eaaa6f40789e49db849d78b16b99a3f6b5b264dbee0578555c9cb08dbddb28ed1780828a681917
+  metadata.gz: 4fe3a14aa9871323c85e1045d9eb0341422ec9489f49484d30756555e053eb1b7ec1c93a431c407b7294f87c9bd302936b7ddac18ef0a6cde98c816def50a0b1
+  data.tar.gz: a3144758369854cbf2790e558147f2a6bcd2f7f3269920e98c37cc08c67519b496fc3a3ff813cdb0534ee09709684eece520276616662b24cf4a9478f9b74d64

data/.travis.yml

@@ -1,3 +1,5 @@
 language: ruby
 rvm:
+  - 2.0.0
+  - 2.1.0
   - 2.2.0

data/CHANGELOG.markdown

@@ -0,0 +1,6 @@
+v0.1.0 -- Mon Mar 16 07:17:53 EDT 2015
+--------------------------------------
+- Added support for handling ranges.
+- Useful for processing responses of questions like "Which item do you want to
+  use?", where whole number responses such as "1", "2", etc. makes sense.
+- Refactored, DRY'er.

data/README.md

@@ -1,4 +1,8 @@
 # Interactive
+[![Gem Version](https://badge.fury.io/rb/interactive.svg)](http://badge.fury.io/rb/interactive)
+[![Build Status](https://travis-ci.org/Edderic/interactive.svg)](https://travis-ci.org/Edderic/interactive)
+[![Code Climate](https://codeclimate.com/github/Edderic/interactive/badges/gpa.svg)](https://codeclimate.com/github/Edderic/interactive)
+
 This is a helper module to assist in interactive question-answering events in the command line.
 
 ## Installation
@@ -6,7 +10,7 @@ This is a helper module to assist in interactive question-answering events in th
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'interactive_question'
+gem 'interactive'
 ```
 
 And then execute:
@@ -15,7 +19,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install interactive_question
+    $ gem install interactive
 
 ## Usage
 
@@ -23,21 +27,24 @@ 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]
+  ques.question = "Which item do you want to use?"
+  ques.options = [1..3, :cancel, :quit]
 end
 ```
 
-You can run the loop and wait for a valid response:
+You can run the loop and wait for a valid response and do query methods on the
+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...
+  if response.whole_num_1?
+    # do stuff if user responded with "1"
+  elsif response.whole_num?
+    # do stuff if user responded with "1", "2", or "3"
+  elsif response.cancel?
+    # do stuff if user responded with "c", etc.
+  elsif response.quit?
+    # do stuff if user responded with "q", etc.
   end
 end
 ```
@@ -45,7 +52,14 @@ end
 That will ask the question appended by the shortcuts:
 
 ```ruby
-# => What do you want to do? [a/e/u/r]
+# => "Which item do you want to use? [1/2/3/c/q]"
+```
+
+If the response is valid:
+
+```ruby
+$ a
+# => response.add? will return true
 ```
 
 If the response is invalid, it prints out the question and goes into detail as
@@ -53,11 +67,12 @@ 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
+# => Which item do you want to use? [1/2/3/c/q]
+# =>   1 -- 1
+# =>   2 -- 2
+# =>   3 -- 3
+# =>   c -- cancel
+# =>   q -- quit
 ```
 
 ## Development
@@ -68,7 +83,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/interactive_question/fork )
+1. Fork it ( https://github.com/edderic/interactive/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`)

data/Rakefile

@@ -1,2 +1,6 @@
 require "bundler/gem_tasks"
 
+desc 'Run specs'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+task :default => [:spec]

data/interactive.gemspec

@@ -17,6 +17,8 @@ Gem::Specification.new do |spec|
   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 'rspec', '~> 3.1'
+  spec.add_development_dependency 'byebug', '~> 3.5'
+  spec.add_development_dependency 'bundler'
 end

data/lib/interactive.rb

@@ -1,4 +1,6 @@
 require "interactive/version"
+require "interactive/option"
+require "interactive/options"
 require 'interactive/question'
 require 'interactive/response'
 

data/lib/interactive/option.rb

@@ -0,0 +1,45 @@
+require 'delegate'
+
+module Interactive
+  module_function
+
+  def Option(option)
+    if option.to_s.match(/^\d+$/)
+      @option = WholeNumberOption.new(option)
+    else
+      @option = WordOption.new(option)
+    end
+
+    @option
+  end
+
+  class WholeNumberOption < SimpleDelegator
+    def initialize(option)
+      @option = option
+      super(@option)
+    end
+
+    def shortcut_value
+      @option
+    end
+
+    def query_method_name
+      "whole_number_#{shortcut_value}?"
+    end
+  end
+
+  class WordOption < SimpleDelegator
+    def initialize(option)
+      @option = option
+      super(@option)
+    end
+
+    def shortcut_value
+      @option.to_s[0]
+    end
+
+    def query_method_name
+      "#{@option}?"
+    end
+  end
+end

data/lib/interactive/options.rb

@@ -0,0 +1,40 @@
+require 'delegate'
+
+module Interactive
+  class Options < SimpleDelegator
+    include Interactive
+    attr_accessor :options
+
+    def initialize(options)
+      flatten_ranges(options)
+      wrap_each_option
+      super(@options)
+    end
+
+    def shortcuts_string
+      "[#{first_chars_without_last_slash(first_chars)}]"
+    end
+
+    def shortcuts_meanings
+      options.inject("") { |accum, opt| "#{accum}  #{opt.shortcut_value} -- #{opt}\n"}
+    end
+
+    private
+
+    def flatten_ranges(options)
+      @options = options.inject([]) {|accum, opt| opt.respond_to?(:to_a) ? accum | opt.to_a : accum << opt}
+    end
+
+    def wrap_each_option
+      @options.map! {|option| Option(option) }
+    end
+
+    def first_chars
+      options.inject("") { |accum, opt| "#{accum}#{ opt.shortcut_value}/" }
+    end
+
+    def first_chars_without_last_slash(first_chars)
+      first_chars[0..first_chars.length-2]
+    end
+  end
+end

data/lib/interactive/question.rb

@@ -4,23 +4,21 @@ module Interactive
 
     def initialize(&block)
       yield self
+
+      @options = Interactive::Options.new(Array(@options))
+
+      raise ArgumentError, "question cannot be nil nor empty." if question.nil? || question.empty?
+      raise ArgumentError, "options cannot be empty." if options.empty?
     end
 
     def ask_and_wait_for_valid_response(&block)
-      resp = NullResponse.new
-
-      while resp.invalid? do
-        puts "#{question} #{shortcuts_string}"
+      loop do
+        puts "#{question} #{options.shortcuts_string}"
         resp = Interactive::Response.new(options)
-        puts shortcuts_meanings if resp.invalid?
+        puts options.shortcuts_meanings if resp.invalid?
 
         yield resp
-      end
-    end
-
-    class NullResponse
-      def invalid?
-        true
+        break unless resp.invalid?
       end
     end
 
@@ -29,21 +27,5 @@ module Interactive
     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

@@ -1,26 +1,49 @@
+require 'interactive'
+
 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')
+      @args = Array(args).flatten
+      check_validity
 
       @_response = STDIN.gets.chomp
 
+      define_methods
+      define_invalid
+      define_whole_number
+    end
+
+    private
+
+    def check_validity
+      raise ArgumentError, "may not use :invalid or 'invalid' as an argument. Private method." if @args.map(&:to_s).include?('invalid')
+      raise ArgumentError, "may not use :whole_number or 'whole_number' as an argument. Private method." if @args.map(&:to_s).include?('whole_number')
+      raise ArgumentError, "may not have keyword options that have the same first letter." if first_chars_not_unique
+      raise ArgumentError, "wrong number of arguments (need at least two arguments)." if @args.length < 2
+    end
+
+    def define_methods
       @args.each do |arg|
-        define_singleton_method "#{arg}?" do
-          @_response.match(/^#{arg[0]}$/i) ? true : false
+        define_singleton_method arg.query_method_name do
+          @_response.strip.match(/^#{arg.shortcut_value}$/i) ? true : false
         end
       end
+    end
 
+    def define_invalid
       define_singleton_method "invalid?" do
         methods(false).reject {|m| m == :invalid? }.none? {|m| send(m) }
       end
     end
+
+    def define_whole_number
+      define_singleton_method "whole_number?" do
+        methods(false).select {|m| m.to_s.match(/whole_number_\d+/)}.any? {|m| send(m) }
+      end
+    end
+
+    def first_chars_not_unique
+      @args.map{|arg| arg.shortcut_value }.uniq.length != @args.length
+    end
   end
 end

data/lib/interactive/version.rb

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

metadata

@@ -1,43 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: interactive
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Edderic Ugaddan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-14 00:00:00.000000000 Z
+date: 2015-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: '3.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 
 email:
 - edderic@gmail.com
@@ -48,6 +76,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.markdown
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -57,6 +86,8 @@ files:
 - bin/setup
 - interactive.gemspec
 - lib/interactive.rb
+- lib/interactive/option.rb
+- lib/interactive/options.rb
 - lib/interactive/question.rb
 - lib/interactive/response.rb
 - lib/interactive/version.rb