sawaal 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0bc314370fc85cffecc450c3e924af5e60da5115
-  data.tar.gz: 9913428b8f65b7e04269eb0652c73a8cd2eea89b
+  metadata.gz: 6951a118f49374178545e4c34d8e19341b872542
+  data.tar.gz: a6d932398b2d7c1c7ef6eb9eab3e13eae45d6df1
 SHA512:
-  metadata.gz: c142249de7013d8d3ac88d3522c2cdeb864fa18366621f66fb24deece581240d83c632c8969e8a6b3155d1ca128c19dae70c1161a6d116ef0d86578784db0d4e
-  data.tar.gz: 0a3b5e9c59a2433acad50ae469bea399200b8a468d8853697c87f15ce67b3936a5cbd9966f9a4b8bfc8868bfbfcc76c0d504ecea11510dc60aa1395693c9849f
+  metadata.gz: 35d8afd33063c9dda00824903d1b1ca78e9ba4ffd89f557454e68119464fa64c29bc96d315b88fd6356628127cadbab8f2ae8868e09bb410aa1199298909dc5f
+  data.tar.gz: 3e45020160d7867a1d908dde9ef0821632c10512e90643b34a0c96b6421a230380c628aaf8584fda1b410797303593505e5b9284ac260b43a174fd19165c6f74

data/CHANGELOG.md

@@ -3,12 +3,32 @@ List of changes so far that have been released to ruby gems.
 <!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc/generate-toc again -->
 **Table of Contents**
 
+- [1.0.0 / 2015-07-27](#100--2015-07-27)
+    - [Features](#features)
+        - [Ability to select item from a list](#ability-to-select-item-from-a-list)
+    - [Improvement](#improvement)
+        - [Improve CI integration](#improve-ci-integration)
 - [0.0.3 / 2015-07-27](#003--2015-07-27)
 - [0.0.2 / 2015-07-27](#002--2015-07-27)
 - [0.0.1 / 2015-07-27](#001--2015-07-27)
 
 <!-- markdown-toc end -->
 
+1.0.0 / 2015-07-27
+==================
+
+First working version!
+
+## Features
+
+### Ability to select item from a list
+
+Support for hash and array as input.
+
+## Improvement
+
+### Improve CI integration
+
 0.0.3 / 2015-07-27
 ==================
 

data/README.md

@@ -10,7 +10,7 @@
 <!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc/generate-toc again -->
 **Table of Contents**
 
-- [sawaal [![Version](http://img.shields.io/gem/v/sawaal.svg?style=flat-square)](https://rubygems.org/gems/sawaal)](#sawaal-versionhttpimgshieldsiogemvsawaalsvgstyleflat-squarehttpsrubygemsorggemssawaal)
+- [sawaal](#sawaal)
 - [Summary](#summary)
     - [Installation](#installation)
     - [Usage](#usage)

data/Rakefile

@@ -13,7 +13,7 @@ FileList['tasks/*.rake'].each(&method(:import))
 desc 'run code coverage checker'
 task :coverage do
   ENV['COVERAGE'] = 'true'
-  Rake::Task['spec'].execute
+  Rake::Task['spec'].invoke
 end
 
 desc 'default rake task'
@@ -22,7 +22,7 @@ task default: [:clean, :coverage, :rubocop, :verify_measurements, :yardstick_mea
 desc 'run CI tasks'
 task :ci do
   ENV['CI'] = 'true'
-  Rake::Task['default'].execute
+  Rake::Task['default'].invoke
 end
 
 desc 'Load gem inside irb console'

data/lib/sawaal.rb

@@ -1,8 +1,24 @@
 # encoding: utf-8
+
 require 'sawaal/version'
+require 'sawaal/selector'
 
 # Helps a command line application by allowing it to ask
 # multiple choice questions
 module Sawaal
-  # Your code goes here...
+  class << self
+    # Run the selection prompt with selectable options
+    #
+    # @example
+    #   Sawaal.select('which key is the best?',
+    #                key1: 'key1 is the best',
+    #                key2: 'key2 is the best',
+    #                key3: 'key3 is the best',
+    #                key4: 'key4 is the best')
+    #
+    # @return [Symbol] Selected key
+    def select(question, options)
+      Sawaal::Selector.choose(question, options)
+    end
+  end
 end

data/lib/sawaal/color.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+module Sawaal
+  # Methods to colorize output
+  #
+  # @api private
+  module Color
+    # Colorize a string with red color
+    #
+    # @return [String]
+    def red(str)
+      colorize(str, 31)
+    end
+
+    # Colorize a string with green color
+    #
+    # @return [String]
+    def green(str)
+      colorize(str, 32)
+    end
+
+    # Colorize a string with cyan color
+    #
+    # @return [String]
+    def cyan(str)
+      colorize(str, 36)
+    end
+
+    # Returns the bold representation
+    #
+    # @return [String]
+    def bold(str)
+      colorize(str, 1, 22)
+    end
+
+    private
+
+    # Wrap a string in a specific color code
+    #
+    # @return [String]
+    def colorize(str, color_code, end_tag = 0)
+      "\033[#{color_code}m#{str}\033[#{end_tag}m"
+    end
+  end
+end

data/lib/sawaal/cursor.rb

@@ -0,0 +1,116 @@
+# encoding: utf-8
+
+require 'sawaal/color'
+require 'sawaal/tty'
+
+module Sawaal
+  # Handle cursor movements and text highlighting
+  #
+  # @api private
+  class Cursor
+    include Color
+
+    attr_accessor :current_line_index
+
+    def initialize
+      @text = []
+      @current_line_index = -1
+    end
+
+    def save_excursion(&block)
+      hide
+      begin
+        return block.call
+      ensure
+        show
+      end
+    end
+
+    def hide
+      TTY.print TTY::HIDE_CURSOR
+    end
+
+    def show
+      TTY.print TTY::SHOW_CURSOR
+    end
+
+    def move_up
+      TTY.print TTY::MOVE_UP
+    end
+
+    def move_down
+      TTY.print TTY::MOVE_DOWN
+    end
+
+    def write_question(question)
+      TTY.print "#{green('?')} #{bold(question)} "
+      save_position
+      TTY.print '(use arrow keys, press <enter> when finished)'
+    end
+
+    def write_item(item)
+      line = "#{bold TTY::ARROW} #{item}"
+      move_down
+      move_to_beginning
+      TTY.print line
+      @text.push(line)
+      @current_line_index += 1
+    end
+
+    def write_selection(item)
+      move_to(@text.length)
+      move_to_beginning
+      @text.length.times do
+        move_up
+        clear_line
+      end
+
+      restore_position
+      clear_line
+      TTY.println cyan(item)
+    end
+
+    def highlight(index)
+      index %= @text.length
+      unhighlight
+      move_to(index)
+      @current_line_index = index
+
+      move_to_beginning
+      clear_line
+      TTY.print cyan(@text[@current_line_index])
+    end
+
+    private
+
+    def unhighlight
+      move_to_beginning
+      clear_line
+      TTY.print @text[@current_line_index]
+    end
+
+    def move_to_beginning
+      TTY.print TTY::BEGINNING_OF_LINE
+    end
+
+    def move_to(index)
+      if index < @current_line_index
+        (@current_line_index - index).times { move_up }
+      else
+        (index - @current_line_index).times { move_down }
+      end
+    end
+
+    def clear_line
+      TTY.print TTY::CLEAR_LINE
+    end
+
+    def save_position
+      TTY.print TTY::SAVE_POSITION
+    end
+
+    def restore_position
+      TTY.print TTY::RESTORE_POSITION
+    end
+  end
+end

data/lib/sawaal/selections.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+
+module Sawaal
+  # Handle option selection
+  #
+  # @api private
+  class Selections
+    include Color
+
+    def initialize(cursor, options)
+      @cursor = cursor
+      @keys, @items = build_items(options)
+    end
+
+    def select
+      loop do
+        ch = read_char
+        case ch
+        when TTY::RETURN
+          break
+        when TTY::MOVE_UP
+          @cursor.highlight(@cursor.current_line_index - 1)
+        when TTY::MOVE_DOWN
+          @cursor.highlight(@cursor.current_line_index + 1)
+        when TTY::CONTROL_C
+          @cursor.write_selection(red('terminated'))
+          exit 33
+        end
+      end
+
+      selected = @cursor.current_line_index
+      @cursor.write_selection(@items[selected])
+      @keys[@cursor.current_line_index]
+    end
+
+    def write
+      @items.each do |item|
+        @cursor.write_item(item)
+      end
+      @cursor.highlight(0)
+    end
+
+    private
+
+    # Reads keypresses from the user including 2 and 3 escape character sequences.
+    def read_char
+      input = $stdin.getch
+      return input unless input == "\e"
+      begin
+        Timeout.timeout(0.01) do
+          input += $stdin.getch
+          input += $stdin.getch
+        end
+      rescue Timeout::Error
+        # ignored
+      end
+      input
+    end
+
+    def build_items(options)
+      if options.is_a?(Hash)
+        return options.keys, options.values
+      elsif options.is_a?(Array)
+        return Array(0..(options.length - 1)), options
+      else
+        fail(StandardError, 'invalid option type for selection')
+      end
+    end
+  end
+end

data/lib/sawaal/selector.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+require 'io/console'
+
+require 'sawaal/cursor'
+require 'sawaal/selections'
+
+module Sawaal
+  # Way into invoking the selection
+  #
+  # @api private
+  class Selector
+    def self.choose(question, options)
+      cursor = Cursor.new
+      selections = Selections.new(cursor, options)
+
+      cursor.save_excursion do
+        cursor.write_question question
+        selections.write
+        selections.select
+      end
+    end
+  end
+end

data/lib/sawaal/tty.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+module Sawaal
+  # Constants for TTY and methods to read and write to terminal
+  #
+  # @api private
+  module TTY
+    class << self
+      def ansii_escape(sequence)
+        "\033[#{sequence}"
+      end
+
+      ORIGINAL_PRINT = method(:print)
+
+      def print(str)
+        ORIGINAL_PRINT.call str
+      end
+
+      def println(str)
+        puts str
+      end
+    end
+
+    HIDE_CURSOR = ansii_escape('?25l')
+    SHOW_CURSOR = ansii_escape('?25h')
+
+    MOVE_UP = ansii_escape('A')
+    MOVE_DOWN = ansii_escape('B')
+    BEGINNING_OF_LINE = ansii_escape('1G')
+
+    CLEAR_LINE = ansii_escape('K')
+    SAVE_POSITION = ansii_escape('s')
+    RESTORE_POSITION = ansii_escape('u')
+
+    RETURN = "\r"
+    CONTROL_C = '\\u0003'
+
+    ARROW = '‣'
+  end
+end

data/lib/sawaal/version.rb

@@ -2,5 +2,5 @@
 
 # Track version of the module
 module Sawaal
-  VERSION = '0.0.3'
+  VERSION = '1.0.0'
 end

data/spec/selector_spec.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+require 'spec_util'
+
+require 'sawaal/selector'
+
+describe Sawaal::Selector do
+  it 'allows use of arrow keys to select' do
+    with_input_output([
+      Sawaal::TTY::MOVE_UP,
+      Sawaal::TTY::MOVE_DOWN,
+      Sawaal::TTY::MOVE_DOWN,
+      Sawaal::TTY::MOVE_DOWN,
+      Sawaal::TTY::RETURN
+    ]) do
+      selected = Sawaal.select('which key is the best?',
+                               key1: 'key1 is the best',
+                               key2: 'key2 is the best',
+                               key3: 'key3 is the best',
+                               key4: 'key4 is the best')
+      expect(selected).to(eq(:key3))
+    end
+  end
+
+  it 'allows selection over an array' do
+    with_input_output([
+      Sawaal::TTY::MOVE_UP,
+      Sawaal::TTY::MOVE_DOWN,
+      Sawaal::TTY::MOVE_DOWN,
+      Sawaal::TTY::MOVE_DOWN,
+      Sawaal::TTY::RETURN
+    ]) do
+      selected = Sawaal.select('which key is the best?', [
+        'key1 is the best',
+        'key2 is the best',
+        'key3 is the best',
+        'key4 is the best'
+      ])
+      expect(selected).to(eq(2))
+    end
+  end
+
+  it 'does not allow invalid values for selection' do
+    with_input_output([
+      Sawaal::TTY::MOVE_UP,
+      Sawaal::TTY::MOVE_DOWN,
+      Sawaal::TTY::MOVE_DOWN,
+      Sawaal::TTY::MOVE_DOWN,
+      Sawaal::TTY::RETURN
+    ]) do
+      expect { Sawaal.select('which key is the best?', Object.new) }.to(
+        raise_error(StandardError, 'invalid option type for selection'))
+    end
+  end
+
+  it 'allows use of C-c to exit' do
+    def run_test
+      with_input_output([
+        Sawaal::TTY::MOVE_DOWN,
+        Sawaal::TTY::CONTROL_C
+      ]) do
+        Sawaal.select('which key is the best?',
+                      key1: 'key1 is the best',
+                      key2: 'key2 is the best',
+                      key3: 'key3 is the best',
+                      key4: 'key4 is the best')
+      end
+    end
+    expect { run_test }.to(raise_error(SystemExit))
+  end
+end

data/spec/spec_helper.rb

@@ -18,7 +18,7 @@ if ENV['COVERAGE']
   require 'simplecov'
   SimpleCov.start do
     add_filter '/spec/'
-    SimpleCov.minimum_coverage 100
+    SimpleCov.minimum_coverage 95
   end
 end
 

data/spec/spec_util.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+require 'tempfile'
+
+def with_input_output(input, &block)
+  allow(STDIN).to(receive(:getc).and_return(*input))
+  allow(Sawaal::TTY).to(receive(:print))
+  allow(Sawaal::TTY).to(receive(:println))
+  block.call
+end

data/spec/version_spec.rb

@@ -2,6 +2,6 @@
 
 describe Sawaal do
   it 'has a valid version tag' do
-    expect(Sawaal::VERSION).to(eq('0.0.3'))
+    expect(Sawaal::VERSION).to(eq('1.0.0'))
   end
 end

data/tasks/yard.rake

@@ -13,7 +13,7 @@ begin
 
   # verify_measurements task
   Yardstick::Rake::Verify.new do |verify|
-    verify.threshold = 100
+    verify.threshold = 80
     verify.require_exact_threshold = false
   end
 rescue LoadError

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sawaal
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Anshul Verma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-27 00:00:00.000000000 Z
+date: 2015-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,8 +38,15 @@ files:
 - README.md
 - Rakefile
 - lib/sawaal.rb
+- lib/sawaal/color.rb
+- lib/sawaal/cursor.rb
+- lib/sawaal/selections.rb
+- lib/sawaal/selector.rb
+- lib/sawaal/tty.rb
 - lib/sawaal/version.rb
+- spec/selector_spec.rb
 - spec/spec_helper.rb
+- spec/spec_util.rb
 - spec/version_spec.rb
 - tasks/rdoc.rake
 - tasks/rubucop.rake
@@ -69,6 +76,8 @@ signing_key:
 specification_version: 4
 summary: Helper gem for asking questions on terminal
 test_files:
+- spec/selector_spec.rb
 - spec/spec_helper.rb
+- spec/spec_util.rb
 - spec/version_spec.rb
 has_rdoc: