simple_console 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56350eea932e0e3c637b90edc4159c14df177b82
-  data.tar.gz: 09e4971c3c20e63aa661b792afc265a6197ce5e5
+  metadata.gz: 5c732548976f9a9abed280b2feb3e4794852a850
+  data.tar.gz: 6ca5f7cb9937abc5f952f6ad1f3f756a5a076e63
 SHA512:
-  metadata.gz: 12dcba42f32c6284b3fab823595bdf5bae940be2ddcb9b8810fa2e0ca33ff5930da0451027e5e60b0db40b6d694f37698ff61ecfe5a44c8f3504c0200e175d8a
-  data.tar.gz: d4717557c086c2d01bec5338e9ecf1a8fa99cb9bcf16495b5bc63bd3eb7df2ff406b20bda146265d7568996ceea32db2fac9036af98e1a067905fffa0699dca5
+  metadata.gz: 9ff0209a9c1218d621c87fa4be33972ba468a4a948a0c566cfd06e00fd36cea6c1a368ee535c41da5279a9c505c8d9f2704ea9f384f1fe28c53dcaf83e95dbeb
+  data.tar.gz: c32129efd3f8e6a9429575e0f32cd96d4f0ef60a4c1728865a6ae8fe107a86cf015030efb3a3dca2a955f1c91fd8077624bb905643f47b3c84d64f329599ef1b

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require gem_helper

data/console.gemspec

@@ -20,4 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
 end

data/examples/demo.rb

@@ -1,4 +1,5 @@
-
+#! /usr/bin/env ruby
+#
 require 'bundler/setup'
 require 'console'
 
@@ -12,6 +13,11 @@ class Demo
   define_cmd(:rand, "output rand number") do |max = 100|
     puts rand(max.to_i)
   end
+
+  define_cmd(:incr, "increment number") do |i = 1|
+    @incr_number ||= 0
+    puts @incr_number += i.to_i
+  end
 end
 
 Demo.new.start("demo > ")

data/lib/console/default_commands.rb

@@ -0,0 +1,19 @@
+module Console; module DefaultCommands
+  def self.included(cls)
+    cls.instance_eval do
+
+      define_cmd(:help, "show commands") do
+        self.class.commands.each do |key, val|
+          puts "  #{key}: #{val[:desc]}"
+        end
+      end
+
+      define_cmd(:exit, "quit client") do
+        puts 'good bye!'
+        exit
+      end
+
+    end
+  end
+end; end
+

data/lib/console/version.rb

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

data/lib/console.rb

@@ -2,46 +2,51 @@ require "console/version"
 
 require 'readline'
 
+require 'console/default_commands'
+
+
 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
+    cls.include(Console::DefaultCommands)
   end
 
 
   module ClassMethods
     def define_cmd(name, desc, &block)
-      @commands ||= {}
-      @commands[name.to_s] = {desc: desc, block: block}
+      commands[name.to_s] = {desc: desc, block: block}
+
+      define_method(command_method_name(name), &block)
     end
 
-    def run_cmd(cmd_name, args)
-      if @commands[cmd_name]
-        @commands[cmd_name][:block].call(*args)
+    def run_cmd(instance, cmd_name, args = [])
+      cmd_name = cmd_name.to_s
+
+      if commands[cmd_name]
+        instance.send(command_method_name(cmd_name), *args)
       else
         puts "Invalid command '#{cmd_name}'"
       end
     rescue => e
       puts e.message
     end
+
+    def commands
+      @commands ||= {}
+    end
+
+
+    private
+
+    def command_method_name(cmd_name)
+      "_cmd_#{cmd_name}"
+    end
+
   end
 
 
-  def start(prompt = '> ', hello = nil)
-    puts (hello || "use 'help' command show all commands")
+  def start(prompt = '> ', options = {})
+    puts (options[:hello] || options['hello'] || "use 'help' command show all commands")
 
     loop do
       cmd_name, *cmd_args = Readline.readline(prompt, true).split
@@ -50,9 +55,9 @@ module Console
         puts
         next
       else
-        self.class.run_cmd(cmd_name, cmd_args)
+        self.class.run_cmd(self, cmd_name, cmd_args)
       end
     end
   end
-
 end
+

data/spec/gem_helper.rb

@@ -0,0 +1,11 @@
+
+require 'bundler/setup'
+require 'pry'
+
+require 'spec_helper'
+require 'console'
+
+
+RSpec.configure do |config|
+end
+

data/spec/lib/console_spec.rb

@@ -0,0 +1,91 @@
+RSpec.describe Console do
+  let(:cls) { Class.new { include Console } }
+
+
+  describe 'include console' do
+    it 'should create start method' do
+      expect(cls.new).to be_respond_to(:start)
+    end
+  end
+
+
+  describe '#start' do
+    it 'should run cmd' do
+      a = cls.new
+      allow(Readline).to receive(:readline).and_return('help')
+      # 'and_raise': stop loop
+      expect(cls).to receive(:run_cmd).with(a, 'help', []).and_raise
+
+      thread = Thread.new { a.start }
+      sleep 0.1
+      thread.kill
+    end
+
+    it 'should print hello' do
+      expect {
+        thread = Thread.new { cls.new.start('>', hello: 'hehe') }
+        sleep 0.1
+        thread.kill
+      }.to output("hehe\n").to_stdout
+    end
+
+    it 'empty cmd, should not exec' do
+      allow(Readline).to receive(:readline).and_return(nil, '', '  ')
+      expect(cls).to_not receive(:run_cmd)
+
+      thread = Thread.new { cls.new.start(nil, hello: '') }
+      sleep 0.1
+      thread.kill
+    end
+
+    it 'should call readline with prompt' do
+      expect(Readline).to receive(:readline).with(' ===> ', true)
+      thread = Thread.new { cls.new.start(' ===> ') }
+      sleep 0.1
+      thread.kill
+    end
+  end
+
+
+  describe '.define_cmd' do
+    it 'should create instance method' do
+      expect {
+        cls.define_cmd(:add, "desc") { |a, b| puts a + b }
+      }.to change { cls.instance_methods.include?(:_cmd_add) }.to(true)
+    end
+  end
+
+
+  describe '.run_cmd' do
+    it 'should call command' do
+      cls.define_cmd(:incr, 'incr') { @a ||=0; @a += 1 }
+      a, b = cls.new, cls.new
+      expect(cls.run_cmd(a, :incr)).to eq(1)
+      expect(cls.run_cmd(a, :incr)).to eq(2)
+      expect(cls.run_cmd(b, :incr)).to eq(1)
+    end
+
+    it 'should exec proc via console instance' do
+      a = cls.new
+      cls.define_cmd(:self, 'self') { self }
+      expect(cls.run_cmd(a, :self)).to eq(a)
+    end
+
+    it 'invalid command, should print error' do
+      a = cls.new
+      expect {
+        expect(cls.run_cmd(a, :aaa)).to eq(nil)
+      }.to output("Invalid command 'aaa'\n").to_stdout
+    end
+
+    it 'command raise error, should print error' do
+      a = cls.new
+      cls.define_cmd(:error, 'error') { raise 'raise error' }
+
+      expect {
+        expect(cls.run_cmd(a, :error)).to eq(nil)
+      }.to output("raise error\n").to_stdout
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,87 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_console
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - jiangzhi.xie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-24 00:00:00.000000000 Z
+date: 2015-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !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: pry
+  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: create belong to your console
 email:
 - xiejiangzhi@gmail.com
@@ -46,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -53,7 +82,11 @@ files:
 - console.gemspec
 - examples/demo.rb
 - lib/console.rb
+- lib/console/default_commands.rb
 - lib/console/version.rb
+- spec/gem_helper.rb
+- spec/lib/console_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -78,4 +111,7 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Simple console
-test_files: []
+test_files:
+- spec/gem_helper.rb
+- spec/lib/console_spec.rb
+- spec/spec_helper.rb