gem_menu 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d346c0711ba4ef34c9ff357c59b36180c7ebf99a7132e0c0ecbec47d5f3172ad
+  data.tar.gz: b774e987187c5077ec14de74c7baf3793bd98f2faabf955d6dcc50ce963f9a06
+SHA512:
+  metadata.gz: 0b406daedbb730f48b93acf8e2dcdd6512ea420682a3ee257aa59de4ce7e78f27e387a68903eab636a5e761ddbeb508d3bc3a93903733112387b1a8657186c15
+  data.tar.gz: 9a95165f4b937d625e995d682117d4b1abbd81e23dfc04fd57ba11f65086ba9dc7e767f7f0d2a43fd1213e7720be6750db1f9f27b4a720bf095c55ac7c90761f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.17.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at brad.schrag@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in gem_menu.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    gem_menu (0.1.0)
+      colorize (~> 0.8.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colorize (0.8.1)
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  gem_menu!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 brad schrag
+
+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,43 @@
+# GemMenu
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/gem_menu`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gem_menu'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gem_menu
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gem_menu. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the GemMenu project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/gem_menu/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gem_menu"
+
+# 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(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/demo/demo_environment.rb

@@ -0,0 +1,3 @@
+require_relative "methods"
+require "./lib/gem_menu"
+require_relative "menus"

data/demo/menu_demo.rb

@@ -0,0 +1,28 @@
+require_relative "demo_environment"
+
+# This is an example of a potential CLI interface using GemMenu. In the CLI, 
+# menus are created within methods. When these methods are called, they return
+# their respective menus. Menus are created by first creating the Entry classes
+# that populate the menu. Each Entry object has it's display text, a reference
+# to it's next method or menu, and optionally parameters to be passed on.
+
+# The Menu class is defined with the menu title text, an array of Entry objects,
+# and optional arguments of previous_menu (should always be used except for the 
+# initial menu, unless using some other method to navigate backwards) and
+# parameters. All menus will display with an (x) to exit and a (b) to go back,
+# only if the menu was given a :previous_menu.
+
+# To see how menus are created, check the menus.rb file, which has been required
+
+# To see how the methods that are called should be construced, see the methods.rb
+# file.
+
+# Here we initiate our first menu, then loop setting menu equal to whatever is
+# returned based on the user selection. This is why it's important that the 
+# methods within this file that are called from an Entry all return the menu 
+# object that is appropraite for the user to return to
+menu = main_menu
+while true
+  menu = menu.retreive_selection
+end
+

data/demo/menus.rb

@@ -0,0 +1,82 @@
+require_relative 'demo_environment'
+FAVORITE_FOODS = []
+
+puts 'hello'
+# Creating the main menu #
+def main_menu
+
+#  Step 1, create the entries with (display text, method(:to_be_called), optional_args)
+
+  hello = GemMenu::Entry.new('hello', method(:hello_world))
+  world = GemMenu::Entry.new('world', method(:counting_world))
+  second_menu = GemMenu::Entry.new('2nd level', method(:menu_2))
+  food_menu = GemMenu::Entry.new('food menu', method(:menu_favorite_foods))
+
+# Step 2, once entries are created, create the Menu object and return it with
+#                   (title text, array_of_Entries, optional_args)
+  GemMenu::Menu.new('main menu', [hello, world, second_menu, food_menu])
+end
+
+def menu_2
+
+# Similar to above but note the optional_args hash that is created below
+  bar = GemMenu::Entry.new('bar', method(:bar))
+  foo = GemMenu::Entry.new('foo', method(:foo))
+  optional_args = {:previous_menu => method(:main_menu)}
+
+# optional_args can track the :previous_menu or :parameters to be passed on
+  GemMenu::Menu.new('my 2nd menu', [foo,bar], optional_args)
+end
+
+def menu_favorite_foods
+
+# Here we are using a global array to track favorite foods. The first .each loop
+# creates menu entries for each item in the FAVORITE_FOODS array. It also passes
+# the food string on as a parameter in the optional_args hash. Also note, the
+# method being called, :say_fav_food, is not a menu.
+  menu_entries = []
+  FAVORITE_FOODS.each do |food|
+    optional_args = {parameters: food}
+    menu_entries << GemMenu::Entry.new(food, method(:say_fav_food), optional_args)
+  end
+
+# After creating the list of foods, it adds an option to add foods to the list.
+# This Entry didn't need a :parameter passed on to it.
+  menu_entries << GemMenu::Entry.new('add food', method(:add_fav_food))
+
+# Finally, create and return the Menu object, giving it a reference to the 
+# previous menu
+  optional_args = {previous_menu: method(:main_menu)}
+  GemMenu::Menu.new('my favorite foods', menu_entries, optional_args)
+end
+
+def say_fav_food(food)
+  puts "One of your favorite foods is #{food}"
+  menu_favorite_foods
+end
+
+def add_fav_food
+  puts "Enter one of your favorite foods: "
+  new_food = gets.strip
+  FAVORITE_FOODS << new_food
+  puts "#{new_food} added to the list"
+  menu_favorite_foods
+end
+
+def hello_world
+  puts 'hello world'
+  main_menu
+end
+
+def counting_world
+  (1..10).each do |i|
+    puts i
+  end
+  main_menu
+end
+
+menu = main_menu
+while true
+  menu = menu.retreive_selection
+end
+

data/demo/methods.rb

@@ -0,0 +1,43 @@
+# From here down are the various methods that get called by the Entries from
+# the menus above. The key to the methods that are called from the Entry class
+# is that they need to return a menu method that represents which menu the user
+# should be returned to when finished. If not, it will crash. To launch the CLI
+# see the last few lines of the file.
+
+def say_fav_food(food)
+  puts "One of your favorite foods is #{food}"
+  menu_favorite_foods
+end
+
+def add_fav_food
+  puts "Enter one of your favorite foods: "
+  new_food = gets.strip
+  FAVORITE_FOODS << new_food
+  puts "#{new_food} added to the list"
+  menu_favorite_foods
+end
+
+def hello_world
+  puts 'hello world'
+  main_menu
+end
+
+def counting_world
+  (1..10).each do |i|
+    puts i
+  end
+  main_menu
+end
+
+def foo
+  puts 'foo'
+  menu_2
+end
+
+# Notice below, even though :bar is launched from menu 2, it is sending
+# main_menu as it's return. Occasionally it might not make sense for the user to
+# return to the menu they left from. This is one advantage to explicitly calling the menu to return to.
+def bar
+  puts 'bar'
+  main_menu
+end

data/gem_menu.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gem_menu/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gem_menu"
+  spec.version       = GemMenu::VERSION
+  spec.authors       = ["brad schrag"]
+  spec.email         = ["brad.schrag@gmail.com"]
+
+  spec.summary       = %q{A RubyGem for creating simple, text based, nested menus.}
+  spec.description   = %q{GemMenu allows a user to easily create a menu interface for a CLI or other text based app.}
+  spec.homepage      = "https://github.com/bschrag620/gem_menu"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/bschrag620/gem_menu"
+    spec.metadata["changelog_uri"] = "https://github.com/bschrag620/gem_menu"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency 'colorize', '~> 0.8.1'
+end

data/lib/gem_menu/version.rb

@@ -0,0 +1,3 @@
+module GemMenu
+  VERSION = "0.2.1"
+end

data/lib/gem_menu.rb

@@ -0,0 +1,110 @@
+require_relative "./gem_menu/version"
+require "colorize"
+
+module GemMenu
+    class Error < StandardError; end
+
+    class Entry
+        attr_accessor :name, :next_method, :parameters, :previous
+    
+        def initialize(name, next_method, optional_args=nil)
+            self.name = name
+            self.next_method = next_method
+            if optional_args
+                optional_args.each do |key, value|
+                    self.send("#{key}=", value)
+                end
+            end
+        end
+
+        def to_s
+            self.name
+        end
+
+        def execute_selection(method)
+            if self.parameters
+                method.call(self.parameters)
+            else
+                method.call
+            end
+        end
+
+        def next_selection
+            execute_selection(self.next_method)
+        end
+
+        def previous_selection
+            self.previous.call
+        end
+    end
+
+    class Menu
+        attr_accessor :title, :entries, :previous_menu, :parameter, :menu_hash
+
+        @@exit = Entry.new('exit', method(:exit))
+        @@menu_char_begin = "<==  ".colorize(:light_blue)
+        @@menu_char_end = "  ==>".colorize(:light_blue)
+    
+        def initialize(title, entries, optional_args=nil)
+            self.title = title
+            self.entries = entries
+            if optional_args
+                optional_args.each do |key, value|
+                    self.send("#{key}=", value)
+                end
+            end
+            self.menu_hash = {"x" => self.exit_method}
+            self.set_choices
+        end
+    
+        def exit_method
+            @@exit
+        end
+    
+        def menu_char_begin
+            @@menu_char_begin
+        end
+    
+        def menu_char_end
+            @@menu_char_end
+        end
+
+        def set_choices
+            self.entries.each.with_index(1) do |entry, i|
+                self.menu_hash[i.to_s] = entry
+            end
+            if self.previous_menu
+                self.menu_hash['b'] = GemMenu::Entry.new('back', self.previous_menu)
+            end
+        end
+
+        def retreive_selection
+            display_menu
+            puts "Please make your selection:".colorize(:light_green)
+            receive_input
+        end
+
+        def display_menu
+            puts
+            puts "#{self.menu_char_begin}#{self.title}#{self.menu_char_end}"
+            menu_hash.sort.to_h.each do |user_choice, description|
+              puts "#{user_choice.colorize(:light_yellow)}) #{description}"
+            end
+        end
+
+        def receive_input
+            selection = nil
+            while !self.menu_hash.include?(selection)
+              selection = gets.strip.downcase
+              if !self.menu_hash.include?(selection)
+                puts "Invalid selection"
+              end
+            end
+            launch_selection(selection)
+        end
+
+        def launch_selection(selection)
+            self.menu_hash[selection].next_selection
+        end
+    end    
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: gem_menu
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- brad schrag
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+description: GemMenu allows a user to easily create a menu interface for a CLI or
+  other text based app.
+email:
+- brad.schrag@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- demo/demo_environment.rb
+- demo/menu_demo.rb
+- demo/menus.rb
+- demo/methods.rb
+- gem_menu.gemspec
+- lib/gem_menu.rb
+- lib/gem_menu/version.rb
+homepage: https://github.com/bschrag620/gem_menu
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/bschrag620/gem_menu
+  source_code_uri: https://github.com/bschrag620/gem_menu
+  changelog_uri: https://github.com/bschrag620/gem_menu
+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.7.8
+signing_key: 
+specification_version: 4
+summary: A RubyGem for creating simple, text based, nested menus.
+test_files: []