menuboy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6daaa783e679485f80b584a273146322315d12cf
+  data.tar.gz: d1d1cc315345f157d3639011da1cb9cdfc9099bc
+SHA512:
+  metadata.gz: 308cbb2003854e7403cc49da964fc14b841472b8a38deff70a856aa7e8da54775b7766ec3bd6543167c4464f37ac22f5aacce3d4553db6df25ddbcdec5a974e8
+  data.tar.gz: 1d4cb5b6672ba7a116203a0c58b34a55b205db540b39381e2b26bb013782710442141a88ab8dc56645e7e48ef3fab0952af343f499134a53c2721edf431ca4b4

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in menuboy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Keyvan Fatehi
+
+MIT License
+
+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,91 @@
+# Menuboy
+
+Ultrasimple command-line menu/submenu DSL
+
+WARNING: I didn't use TDD to develop this -- it is an extraction out of
+a custom script I developed for the non-backend-coders to use for
+managing our node.js/mongodb/redis stack in a super simple way. You can
+see the basic idea of that in test/example.rb, which was used to develop
+menuboy.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'menuboy'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install menuboy
+
+## Usage
+
+Say you write a menuboy script like this:
+
+```ruby
+require 'menuboy'
+
+include Menuboy::DSL
+
+mainmenu "Main Menu" do
+  option "say cheese!" do
+    puts "CHEESE!"
+  end
+
+  submenu "animal sounds" do
+    submenu "duck sounds" do
+      option "loud quack" do
+        puts "QUACK!!!"
+      end
+
+      option "soft quack" do
+        puts "quack!"
+      end
+    end
+  end
+end
+```
+
+You can then run the script and have such an interaction:
+
+```
+$prompt> ruby simple.rb
+1 - say cheese!
+2 - animal sounds
+q - quit / go back
+(Main Menu)> 1
+CHEESE!
+(Main Menu)> 2
+1 - duck sounds
+q - quit / go back
+(animal sounds)> h
+1 - duck sounds
+q - quit / go back
+(animal sounds)> 1
+1 - loud quack
+2 - soft quack
+q - quit / go back
+(duck sounds)> 1
+QUACK!!!
+(duck sounds)> 2
+quack!
+(duck sounds)> q
+(animal sounds)> h
+1 - duck sounds
+q - quit / go back
+(animal sounds)> q
+(Main Menu)> q
+$prompt>
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/menuboy/version.rb

@@ -0,0 +1,3 @@
+module Menuboy
+  VERSION = "0.0.1"
+end

data/lib/menuboy.rb

@@ -0,0 +1,82 @@
+require "menuboy/version"
+
+module Menuboy
+  module DSL
+    def option name, &block
+      opt_count = @target.options.count
+      key = (opt_count+1).to_s
+      if key.size > 1
+        raise StandardError, "You can only define 9 options per menu"
+      end
+      opt = Option.new(key, name, block)
+      @target.options.push opt
+    end
+
+    def submenu name="Submenu"
+      option(name) do
+        @target = Menu.new(name)
+        yield
+        @target.start
+      end
+    end
+
+    def mainmenu(name="Main menu")
+      if @mainmenu
+        raise StandardError, "You can only define one main menu"
+      else
+        @mainmenu = Menu.new(name)
+        @target = @mainmenu
+        yield
+        @mainmenu.start
+      end
+    end
+  end
+
+  class Option < Struct.new(:key, :name, :proc)
+  end
+
+  class Menu
+    include DSL
+    attr_accessor :name, :options
+
+    CTRL_C = "\u0003"
+
+    def initialize name
+      self.name = name
+      self.options = []
+    end
+
+    def print_help
+      self.options.each do |opt|
+        puts "#{opt.key} - #{opt.name}"
+      end
+      puts "p - jump into a Pry repl" if defined? Pry
+      puts "q - quit / go back"
+    end
+
+    def option_match? input
+      matches = self.options.select{|o| o.key == input}
+      matches.length == 1 ? matches.last : false
+    end
+
+    def start
+      print_help
+      loop do
+        print "(#{@name})> "
+        input = STDIN.getch
+        puts input
+        if input == CTRL_C || input == "q"
+          break
+        elsif input == "h"
+          print_help
+        elsif input == "p" && defined? Pry
+          binding.pry
+        elsif option = option_match?(input)
+          option.proc.call
+        else
+          puts "Unassigned input"
+        end
+      end
+    end
+  end
+end

data/menuboy.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'menuboy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "menuboy"
+  spec.version       = Menuboy::VERSION
+  spec.authors       = ["Keyvan Fatehi"]
+  spec.email         = ["keyvanfatehi@gmail.com"]
+  spec.description   = %q{Simple CLI-based menu building DSL}
+  spec.summary       = %q{Simple CLI-based menu building DSL}
+  spec.homepage      = "https://github.com/keyvanfatehi/menuboy"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/test/example.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+require 'pry'
+require 'menuboy'
+
+@current_db = "identity"
+
+include Menuboy::DSL
+
+mainmenu "Main Menu" do
+  option "start the stack" do
+    if @started
+      puts "Already started"
+    else
+      @started = true
+      puts "Started!"
+    end
+  end
+
+  submenu "database options" do
+    puts "using #{@current_db}"
+
+    submenu "change database" do
+      option "identity" do
+        @current_db = "identity"
+        puts "using identity"
+      end
+
+      option "storage" do
+        @current_db = "storage"
+        puts "using storage"
+      end
+    end
+
+    option "drop database" do
+      puts "#{@current_db} dropped!"
+    end
+
+    option "seed database" do
+      puts "#{@current_db} seeded!"
+    end
+  end
+end

data/test/simpler.rb

@@ -0,0 +1,21 @@
+require 'menuboy'
+
+include Menuboy::DSL
+
+mainmenu "Main Menu" do
+  option "say cheese!" do
+    puts "CHEESE!"
+  end
+
+  submenu "animal sounds" do
+    submenu "duck sounds" do
+      option "loud quack" do
+        puts "QUACK!!!"
+      end
+
+      option "soft quack" do
+        puts "quack!"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: menuboy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Keyvan Fatehi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Simple CLI-based menu building DSL
+email:
+- keyvanfatehi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/menuboy.rb
+- lib/menuboy/version.rb
+- menuboy.gemspec
+- test/example.rb
+- test/simpler.rb
+homepage: https://github.com/keyvanfatehi/menuboy
+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.0.6
+signing_key: 
+specification_version: 4
+summary: Simple CLI-based menu building DSL
+test_files:
+- test/example.rb
+- test/simpler.rb