simple_console 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56350eea932e0e3c637b90edc4159c14df177b82
+  data.tar.gz: 09e4971c3c20e63aa661b792afc265a6197ce5e5
+SHA512:
+  metadata.gz: 12dcba42f32c6284b3fab823595bdf5bae940be2ddcb9b8810fa2e0ca33ff5930da0451027e5e60b0db40b6d694f37698ff61ecfe5a44c8f3504c0200e175d8a
+  data.tar.gz: d4717557c086c2d01bec5338e9ecf1a8fa99cb9bcf16495b5bc63bd3eb7df2ff406b20bda146265d7568996ceea32db2fac9036af98e1a067905fffa0699dca5

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 jiangzhi.xie
+
+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,59 @@
+# Console
+
+Simple console
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'console', github: 'xjz19901211/console'
+```
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+
+See examples/demo.rb
+
+```
+# my_console.rb
+class MyConsole
+  include Console
+
+  define_cmd(:rand, "puts random number") do |max = 100|
+    puts rand(max.to_i)
+  end
+end
+
+MyConsole.new.start("my-console > ", "Use 'help' show all commands")
+```
+
+```
+$ ruby my_console.rb
+Use 'help' show all commands
+my-console > help
+  help: show all commands
+  exit: exit console
+  rand: puts random number
+my-console > rand
+23
+my-console > rand 10
+4
+my-console > rand 10100
+2492
+my-console > exit
+$ 
+
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/xjz19901211/console/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`)
+5. Create a new Pull Request

data/Rakefile

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

data/console.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'console/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_console"
+  spec.version       = Console::VERSION
+  spec.authors       = ["jiangzhi.xie"]
+  spec.email         = ["xiejiangzhi@gmail.com"]
+  spec.summary       = %q{Simple console}
+  spec.description   = %q{create belong to your console}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/examples/demo.rb

@@ -0,0 +1,18 @@
+
+require 'bundler/setup'
+require 'console'
+
+class Demo
+  include Console
+
+  define_cmd(:hello, "print hello") do
+    puts "hello #{`whoami`}"
+  end
+
+  define_cmd(:rand, "output rand number") do |max = 100|
+    puts rand(max.to_i)
+  end
+end
+
+Demo.new.start("demo > ")
+

data/lib/console/version.rb

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

data/lib/console.rb

@@ -0,0 +1,58 @@
+require "console/version"
+
+require 'readline'
+
+module Console
+  def self.included(cls)
+    cls.extend(ClassMethods)
+
+    ### default commands ###
+    cls.instance_eval do
+      define_cmd(:help, "show commands") do
+        @commands.each do |key, val|
+          puts "  #{key}: #{val[:desc]}"
+        end
+      end
+
+      define_cmd(:exit, "quit client") do
+        puts 'good bye!'
+        exit
+      end
+    end
+  end
+
+
+  module ClassMethods
+    def define_cmd(name, desc, &block)
+      @commands ||= {}
+      @commands[name.to_s] = {desc: desc, block: block}
+    end
+
+    def run_cmd(cmd_name, args)
+      if @commands[cmd_name]
+        @commands[cmd_name][:block].call(*args)
+      else
+        puts "Invalid command '#{cmd_name}'"
+      end
+    rescue => e
+      puts e.message
+    end
+  end
+
+
+  def start(prompt = '> ', hello = nil)
+    puts (hello || "use 'help' command show all commands")
+
+    loop do
+      cmd_name, *cmd_args = Readline.readline(prompt, true).split
+
+      unless cmd_name
+        puts
+        next
+      else
+        self.class.run_cmd(cmd_name, cmd_args)
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: simple_console
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- jiangzhi.xie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: create belong to your console
+email:
+- xiejiangzhi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- console.gemspec
+- examples/demo.rb
+- lib/console.rb
+- lib/console/version.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Simple console
+test_files: []