downup 0.11.6 → 0.11.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63d7f26b086ddbde4f3a21cb2ec9c81303669b04
-  data.tar.gz: af8cb68e73047c496b68980eacfe67e1f778bbf8
+  metadata.gz: c5dcc699aa5f695e20cd7407d0ea1272bce09e34
+  data.tar.gz: 5df54c1da0dac4ac741a685102e183d002e0a095
 SHA512:
-  metadata.gz: 9ac0ce0d0356e55f869e258902b864e065b62dae42bc570fd54ba4adde9fc9b71621beba1e7b28177a01ab343407e134f7e0b6a3ad30842edfe5b26f235fb42d
-  data.tar.gz: 37220a831740dc68870a37ae1610c26403c35009a31b98a70ab677a895b8fa38508c7c2c7fffb1992f15e6fd6e4efbba92db4f3a1d737bccbf123d99aff0b90a
+  metadata.gz: fc083cbe7e1ed78dc8d665fb8de6fe1d25594b3380b1bf23004cdc35406f62edd5a85fb8028697ac54ba6e86a6b72a07b155c6d61172ef83de98a05ac7544ffe
+  data.tar.gz: f5b60fd68df24f004dfdf858d0cc8d8f45b0a9416c30291363c4d6b5c31ef7bb640c16c7c72455daa997a329d932641de2b1dffa75272fe5366d6297e0594940

data/.codeclimate.yml

@@ -0,0 +1,37 @@
+# This is a sample .codeclimate.yml configured for Engine analysis on Code
+# Climate Platform. For an overview of the Code Climate Platform, see here:
+# http://docs.codeclimate.com/article/300-the-codeclimate-platform
+
+# Under the engines key, you can configure which engines will analyze your repo.
+# Each key is an engine name. For each value, you need to specify enabled: true
+# to enable the engine as well as any other engines-specific configuration.
+
+# For more details, see here:
+# http://docs.codeclimate.com/article/289-configuring-your-repository-via-codeclimate-yml#platform
+
+# For a list of all available engines, see here:
+# http://docs.codeclimate.com/article/296-engines-available-engines
+
+engines:
+# to turn on an engine, add it here and set enabled to `true`
+# to turn off an engine, set enabled to `false` or remove it
+  rubocop:
+    enabled: true
+
+# Engines can analyze files and report issues on them, but you can separately
+# decide which files will receive ratings based on those issues. This is
+# specified by path patterns under the ratings key.
+
+# For more details see here:
+# http://docs.codeclimate.com/article/289-configuring-your-repository-via-codeclimate-yml#platform
+
+ratings:
+  paths:
+  - lib/**
+
+# You can globally exclude files from being analyzed by any engine using the
+# exclude_paths key.
+
+#exclude_paths:
+#- spec/**/*
+#- vendor/**/*

data/.travis.yml

@@ -1,3 +1,6 @@
 language: ruby
 rvm:
   - 2.1.3
+addons:
+  code_climate:
+    repo_token: 11dbcc5ff92f8c6d6d1c9d0d5e5ec35c6025153ac02da45067841b60b431a6f7

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## 0.11.7
+
+  * Moved all code into lib directory
+
+  * Added Gem Version, Build Status, Test Coverage, Code Climate, Dependency Status,
+    and Inline docs badges to README
+
+  * Started to Document Base class

data/Gemfile

@@ -3,4 +3,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in downup.gemspec
 gemspec
 
+gem "minitest"
 gem "minitest-focus"
+gem "minitest-reporters"
+gem "codeclimate-test-reporter", group: :test, require: nil

data/README.md

@@ -1,5 +1,9 @@
 # Downup
 
+[![Gem Version](https://badge.fury.io/rb/downup.svg)](http://badge.fury.io/rb/downup) [![Build Status](https://travis-ci.org/presidentJFK/downup.svg?branch=master)](https://travis-ci.org/presidentJFK/downup) [![Test Coverage](https://codeclimate.com/github/presidentJFK/downup/badges/coverage.svg)](https://codeclimate.com/github/presidentJFK/downup/coverage) [![Code Climate](https://codeclimate.com/github/presidentJFK/downup/badges/gpa.svg)](https://codeclimate.com/github/presidentJFK/downup) [![Dependency Status](https://gemnasium.com/presidentJFK/downup.svg)](https://gemnasium.com/presidentJFK/downup) [![Inline docs](http://inch-ci.org/github/presidentJFK/downup.svg?branch=master)](http://inch-ci.org/github/presidentJFK/downup)
+
+### \*\*WARNING THIS GEM IS PRE 1.0 AND STILL UNSTABLE\*\*
+
 A simple gem for creating command line menus you can use the arrows
 to move through.
 
@@ -115,17 +119,12 @@ Downup::Base.new(
 
 ## Inspired By
 
-This gist
+This Gist
 https://gist.github.com/acook/4190379
 
-and this SO article
+and this Stack Overflow article
 http://stackoverflow.com/questions/1489183/colorized-ruby-output
 
-
-## Development
-
-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).
-
 To run specs
 
 ```ruby

data/Rakefile

@@ -1,5 +1,7 @@
 require "bundler/gem_tasks"
 
+task :default => "test"
+
 task :test do
   Dir.glob("test/test*").map do |file|
     require_relative file

data/downup.gemspec

@@ -18,6 +18,6 @@ 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 "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
 end

data/lib/downup.rb

@@ -1,184 +1,2 @@
 require_relative "downup/version"
-require_relative "downup/options_printer"
-require_relative "downup/colors"
-require "io/console"
-
-module Downup
-  using Colors
-
-  class Base
-    attr_reader :selected_position
-
-    def initialize(options:,
-                   flash_message: nil,
-                   flash_color: :green,
-                   default_color: :brown,
-                   selected_color: :magenta,
-                   multi_select_selector: "√",
-                   selector: "‣",
-                   type: :default,
-                   stdin: $stdin,
-                   stdout: $stdout,
-                   header_proc: Proc.new {})
-
-      @options               = options
-      @flash_color           = flash_color
-      @flash_message         = flash_message
-      @default_color         = default_color
-      @selected_color        = selected_color
-      @selector              = selector
-      @type                  = type
-      @header_proc           = header_proc
-      @stdin                 = stdin
-      @stdout                = stdout
-      @colonel               = Kernel
-      @multi_select_selector = multi_select_selector
-
-      @multi_selected_positions = []
-    end
-
-    def prompt(position = 0)
-      @selected_position = position_selector(position)
-      colonel.system("clear")
-      header_proc.call
-      print_flash
-      Downup::OptionsPrinter.new(
-        options: options,
-        selected_position: @selected_position,
-        multi_selected_positions: @multi_selected_positions,
-        multi_select_selector: multi_select_selector,
-        default_color: default_color,
-        selected_color: selected_color,
-        selector: selector,
-        stdin: stdin,
-        stdout: stdout,
-      ).print_options
-      stdout.print "\n> "
-      input = read_char
-      process_input input
-    end
-
-    private
-
-    def options
-      @_options ||=
-        begin
-          if multi_select?
-            @options.merge({"z" => "ENTER"})
-          else
-            @options
-          end
-        end
-    end
-
-    attr_reader :flash_message,
-                :flash_color,
-                :header_proc,
-                :selected_color,
-                :selector,
-                :type,
-                :default_color,
-                :stdin,
-                :stdout,
-                :multi_select_selector,
-                :colonel
-
-    def process_input(input)
-      case input
-      when "\e[A", "k"
-        prompt(selected_position - 1)
-      when "\e[B", "j"
-        prompt(selected_position + 1)
-      when *option_keys
-        prompt(option_keys.index(input))
-      when "\r"
-        if multi_select?
-          manage_multi_select
-          if selected_value == "ENTER"
-            execute_selection(input)
-          else
-            prompt(selected_position)
-          end
-        else
-          execute_selection(input)
-        end
-      when "\u0003" then exit
-      else prompt(selected_position); end
-    end
-
-    def selected_value
-      options.values[selected_position]
-    end
-
-    def manage_multi_select
-      if @multi_selected_positions.include?(selected_position)
-        @multi_selected_positions.delete(selected_position)
-      else
-        return if selected_position == @options.length
-        @multi_selected_positions << selected_position
-      end
-    end
-
-    def multi_select?
-      type == :multi_select
-    end
-
-    def execute_selection(input)
-      case options
-      when Array
-        options[selected_position]
-      when Hash
-        if options_has_value_and_display?
-          options.fetch(option_keys[selected_position]).fetch("value")
-        else
-          if multi_select?
-            @multi_selected_positions.map do |p|
-              options.fetch(option_keys[p]) 
-            end
-          else
-            options.fetch(option_keys[selected_position])
-          end
-        end
-      end
-    end
-
-    def options_has_value_and_display?
-      options.values.all? { |option|
-        option.is_a?(Hash) && option.has_key?("value")
-      } && options.values.all? { |option|
-        option.is_a?(Hash) && option.has_key?("display")
-      }
-    end
-
-    def option_keys
-      options.is_a?(Array) ? [] : options.keys
-    end
-
-    def position_selector(position)
-      case position
-      when -1 then options.count - 1
-      when options.count then 0
-      else position; end
-    end
-
-    def print_flash
-      return if flash_message.nil?
-      colored_flash = "\"#{flash_message}\".#{flash_color}"
-      stdout.puts eval(colored_flash)
-    end
-
-    def read_char
-      stdin.echo = false
-      stdin.raw!
-      input = stdin.getc.chr
-      if input == "\e" then
-        input << stdin.read_nonblock(3) rescue nil
-        input << stdin.read_nonblock(2) rescue nil
-      end
-    ensure
-      stdin.echo = true
-      stdin.cooked!
-      return input
-    end
-  end
-end
+require_relative "downup/base"

data/lib/downup/base.rb

@@ -0,0 +1,213 @@
+require_relative "version"
+require_relative "options_printer"
+require_relative "colors"
+require "io/console"
+
+module Downup
+  using Colors
+
+  ##
+  # The main interface to use Downup
+  #
+  # initialize a Downup::Base object with all your desired options
+  # and call +#prompt+ to retrieve the user selection.
+  class Base
+    attr_reader :selected_position
+
+    # @param options [Hash|Array] collection of options to choose from
+    # @param flash_message [String] A message to be displayed above the downup menu
+    # @param flash_color [Symbol] color of flash message
+    # @param default_color [Symbol] The color an unchoosen item
+    # @param selected_color [Symbol] The color a choosen item
+    # @param multi_select_selector [String] The charactor for selected items in multi mode
+    # @param selector [String] The charactor for the moving selector in non-multi mode
+    # @param type [Symbol] single select/default or multi select mode, `:default` or `:multi_select`
+    # @param header_proc [Proc] a proc that will called before each render of option selection
+    #
+    # @example array of options
+    #   Downup::Base.new(options: ["option 1", "option 2"])
+    #
+    # @example hash of options
+    #   Downup::Base.new(options: {"a" => "option 1", "b" => "option 2"})
+    #
+    # @example hash with "value" and "display" keys
+    #   Downup::Base.new(options: {"a" => {"value" => "option 1", "display" => "Option 1"}})
+    #
+    # @example header_proc example
+    #   Downup::Base.new(options: [], header_proc: Proc.new {puts "Hello"})
+    def initialize(options:,
+                   flash_message:         nil,
+                   flash_color:           :green,
+                   default_color:         :brown,
+                   selected_color:        :magenta,
+                   multi_select_selector: "√",
+                   selector:              "‣",
+                   type:                  :default,
+                   stdin:                 $stdin,
+                   stdout:                $stdout,
+                   header_proc:           Proc.new{})
+
+      @options                  = options
+      @flash_color              = flash_color
+      @flash_message            = flash_message
+      @default_color            = default_color
+      @selected_color           = selected_color
+      @selector                 = selector
+      @type                     = type
+      @header_proc              = header_proc
+      @stdin                    = stdin
+      @stdout                   = stdout
+      @colonel                  = Kernel
+      @multi_select_selector    = multi_select_selector
+      @multi_selected_positions = []
+    end
+
+    # Prompts the user to make selection from the options
+    # the object with initialized with.
+    # @param position [Integer] where the selector will start at
+    # @return [String] a string of the user's selection
+    def prompt(position = 0)
+      @selected_position = position_selector(position)
+      colonel.system("clear")
+      header_proc.call
+      print_flash
+      Downup::OptionsPrinter.new(
+        options: options,
+        selected_position: @selected_position,
+        multi_selected_positions: @multi_selected_positions,
+        multi_select_selector: multi_select_selector,
+        default_color: default_color,
+        selected_color: selected_color,
+        selector: selector,
+        stdin: stdin,
+        stdout: stdout,
+      ).print_options
+      stdout.print "\n> "
+      input = read_char
+      process_input input
+    end
+
+    private
+
+    def options
+      @_options ||=
+        begin
+          if multi_select?
+            @options.merge({"z" => "ENTER"})
+          else
+            @options
+          end
+        end
+    end
+
+    attr_reader :flash_message,
+                :flash_color,
+                :header_proc,
+                :selected_color,
+                :selector,
+                :type,
+                :default_color,
+                :stdin,
+                :stdout,
+                :multi_select_selector,
+                :colonel
+
+    def process_input(input)
+      case input
+      when "\e[A", "k"
+        prompt(selected_position - 1)
+      when "\e[B", "j"
+        prompt(selected_position + 1)
+      when *option_keys
+        prompt(option_keys.index(input))
+      when "\r"
+        if multi_select?
+          manage_multi_select
+          if selected_value == "ENTER"
+            execute_selection(input)
+          else
+            prompt(selected_position)
+          end
+        else
+          execute_selection(input)
+        end
+      when "\u0003" then exit
+      else prompt(selected_position); end
+    end
+
+    def selected_value
+      options.values[selected_position]
+    end
+
+    def manage_multi_select
+      if @multi_selected_positions.include?(selected_position)
+        @multi_selected_positions.delete(selected_position)
+      else
+        return if selected_position == @options.length
+        @multi_selected_positions << selected_position
+      end
+    end
+
+    def multi_select?
+      type == :multi_select
+    end
+
+    def execute_selection(input)
+      case options
+      when Array
+        options[selected_position]
+      when Hash
+        if options_has_value_and_display?
+          options.fetch(option_keys[selected_position]).fetch("value")
+        else
+          if multi_select?
+            @multi_selected_positions.map do |p|
+              options.fetch(option_keys[p]) 
+            end
+          else
+            options.fetch(option_keys[selected_position])
+          end
+        end
+      end
+    end
+
+    def options_has_value_and_display?
+      options.values.all? { |option|
+        option.is_a?(Hash) && option.has_key?("value")
+      } && options.values.all? { |option|
+        option.is_a?(Hash) && option.has_key?("display")
+      }
+    end
+
+    def option_keys
+      options.is_a?(Array) ? [] : options.keys
+    end
+
+    def position_selector(position)
+      case position
+      when -1 then options.count - 1
+      when options.count then 0
+      else position; end
+    end
+
+    def print_flash
+      return if flash_message.nil?
+      colored_flash = "\"#{flash_message}\".#{flash_color}"
+      stdout.puts eval(colored_flash)
+    end
+
+    def read_char
+      stdin.echo = false
+      stdin.raw!
+      input = stdin.getc.chr
+      if input == "\e" then
+        input << stdin.read_nonblock(3) rescue nil
+        input << stdin.read_nonblock(2) rescue nil
+      end
+    ensure
+      stdin.echo = true
+      stdin.cooked!
+      return input
+    end
+  end
+end

data/lib/downup/version.rb

@@ -1,3 +1,3 @@
 module Downup
-  VERSION = "0.11.6"
+  VERSION = "0.11.7"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: downup
 version: !ruby/object:Gem::Version
-  version: 0.11.6
+  version: 0.11.7
 platform: ruby
 authors:
 - David Begin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-29 00:00:00.000000000 Z
+date: 2015-09-13 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'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -45,9 +45,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -58,6 +60,7 @@ files:
 - downup.gemspec
 - examples/basic.rb
 - lib/downup.rb
+- lib/downup/base.rb
 - lib/downup/colors.rb
 - lib/downup/options_printer.rb
 - lib/downup/version.rb
@@ -81,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: a Gem for creating menus that you can easily navigate through