mini_cli 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea711692c0f25baafc371451a02dbe2dbbe9b614
+  data.tar.gz: 1ebaa4205176286a479a8d9e466fb6a76240cda4
+SHA512:
+  metadata.gz: cd18091197c638be75652bf314754ad35045d50b4a84501c893bddbfffe5ffc144caf24f14239586dd230b727aa632708ba60048f51f0904b62a570febf71c64
+  data.tar.gz: 8ede5324662a3523139ea07b98c3605de469b9df890c63facdeda59dba23fc1839f7bc04fa0360be0113b43d21d5fdf35f6c62a1c4c2c366d13d182153b4330c

data/.gitignore

@@ -0,0 +1 @@
+tags

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test, :development do
+  gem 'mini_check', require: false
+  gem 'rspec', require: false
+  gem 'pry', require: false
+  gem 'rack-test', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    mini_cli (0.0.1)
+      puma
+      rerun
+      thor (~> 0.19)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    ffi (1.9.6)
+    hitimes (1.2.2)
+    json (1.8.1)
+    listen (2.8.3)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    method_source (0.8.2)
+    mini_check (0.2.0)
+      json
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    puma (2.10.2)
+      rack (>= 1.1, < 2.0)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.4.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rerun (0.10.0)
+      listen (~> 2.7, >= 2.7.3)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    slop (3.6.0)
+    thor (0.19.1)
+    timers (4.0.1)
+      hitimes
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  mini_check
+  mini_cli!
+  pry
+  rack-test
+  rake
+  rspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Manuel Morales, Workshare ltd., et al.
+
+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 @@
+# MiniCli
+
+Simple command line interface for microservices built using Thor.
+It provides basic commands:
+
+```
+Commands:
+  cli auto [COMMAND]  # Re-runs the given command on any file change
+  cli console         # Pry console with the app available
+  cli help [COMMAND]  # Describe available commands or one specific command
+  cli start           # Starts the Puma and any other required thread
+  cli test            # Run the test suite
+```
+
+
+## Usage
+
+Inherit from MiniCli::Base to provide the basic commands:
+
+```ruby
+require 'mini_cli'
+
+class Cli < MiniCli::Base
+end
+```
+
+Invoke it as a regular Thor class:
+
+```ruby
+#!/usr/bin/env ruby
+
+require_relative 'cli'
+PatioSessions::Cli.start
+```
+
+
+## Contributing
+
+Do not forget to run the tests with:
+
+```bash
+rake
+```
+
+And bump the version with any of:
+
+```bash
+$ gem bump --version 1.1.1       # Bump the gem version to the given version number
+$ gem bump --version major       # Bump the gem version to the next major level (e.g. 0.0.1 to 1.0.0)
+$ gem bump --version minor       # Bump the gem version to the next minor level (e.g. 0.0.1 to 0.1.0)
+$ gem bump --version patch       # Bump the gem version to the next patch level (e.g. 0.0.1 to 0.0.2)
+```
+
+
+## License
+
+Released under the MIT License.
+See the [LICENSE](LICENSE.txt) file for further details.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake'
+
+require 'rspec/core/rake_task'
+task :default => :spec
+task :test => :spec
+desc 'Run all specs'
+RSpec::Core::RakeTask.new('spec') do |spec|
+  spec.rspec_opts = %w{}
+end

data/lib/mini_cli/base.rb

@@ -0,0 +1,57 @@
+require 'thor'
+
+module MiniCli
+  # The base class to inherit from to provide the basic commands of a microservice
+  class Base < Thor
+
+    # Shows execution time to the end of the run
+    def self.start
+      require 'benchmark'
+      bm = Benchmark.measure { |x| super }
+      puts "\n#{bm.total.round(3)}s task run time"
+    end
+
+    desc 'test', 'Run the test suite'
+    def test *args
+      args = ['spec'] if args.empty?
+
+      require 'spec/spec_helper'
+
+      RSpec::Core::Runner.run(args)
+    end
+
+    desc 'console', 'Pry console with the app available'
+    def console
+      require'pry'
+      Pry.start
+    end
+
+    desc 'auto [COMMAND]', 'Re-runs the given command on any file change'
+    long_desc 'Re-runs the given command on any file change.' +
+      " I. e. \"#{$0} auto test\" will run the tests on each file save."
+    def auto *args
+      require 'rerun'
+
+      options = Rerun::Options.parse [
+        '--background', 
+        '--name', "./cli #{args.first}",
+        '--signal', 'ABRT',
+      ]
+
+      Rerun::Runner.keep_running("./cli #{args.join " "}", options)
+    end
+
+    desc 'start', 'Starts the Puma and any other required thread'
+    def start
+      require 'puma/cli'
+      Puma::CLI.new(puma_args).run
+    end
+
+    private
+
+    def puma_args
+      %w{-p 22000}
+    end
+  end
+end
+

data/lib/mini_cli/version.rb

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

data/lib/mini_cli.rb

@@ -0,0 +1,5 @@
+require "mini_cli/version"
+
+module MiniCli
+  autoload :Base, 'mini_cli/base'
+end

data/mini_cli.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+gem_name = "mini_cli" # TODO: Rename this
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "#{gem_name}/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = gem_name
+  spec.version       = MiniCli::VERSION
+  spec.authors       = ["Manuel Morales"]
+  spec.email         = ['manuelmorales@gmail.com']
+  spec.description   = "CLI for microservices"
+  spec.summary       = "A Thor based CLI for services and Ruby apps."
+  spec.homepage      = "https://github.com/manuelmorales/#{spec.name.gsub('_','-')}"
+  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_runtime_dependency 'thor', '~> 0.19'
+  spec.add_runtime_dependency 'rerun', '~> 0.10'
+  spec.add_runtime_dependency 'puma', '~> 2.10'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", '~> 10.4'
+end

data/spec/mini_cli/base_spec.rb

@@ -0,0 +1,52 @@
+require_relative '../spec_helper'
+
+describe Base do
+  let(:cli){ Base.new }
+
+  describe '#test' do
+    it 'runs the RSpec suite' do
+      expect(RSpec::Core::Runner).to receive(:run)
+      cli.test
+    end
+
+    it 'passes args to RSpec' do
+      expect(RSpec::Core::Runner).to receive(:run).with(['random','args'])
+      cli.test('random','args')
+    end
+
+    it 'passes ["spec"] if no args are specified' do
+      expect(RSpec::Core::Runner).to receive(:run).with(['spec'])
+      cli.test
+    end
+  end
+
+  describe '#console' do
+    it 'runs pry' do
+      expect(Pry).to receive(:start)
+      cli.console
+    end
+  end
+
+  describe '#start' do
+    before(:all){ require 'puma/cli' }
+
+    it 'runs a Puma server' do
+      a_puma = double('a puma')
+      expect(Puma::CLI).to receive(:new).with(['-p', '22000']).and_return a_puma
+      expect(a_puma).to receive(:run)
+      cli.start
+    end
+  end
+
+  describe '#auto' do
+    before(:all){ require 'rerun' }
+
+    it 'launches rerun with the given command' do
+      expect(Rerun::Runner).to receive(:keep_running) do |command, options|
+        expect(command).to eq './cli sample command'
+      end
+      cli.auto 'sample command'
+    end
+  end
+end
+

data/spec/mini_cli_spec.rb

@@ -0,0 +1,7 @@
+require_relative 'spec_helper'
+
+describe MiniCli do
+  it 'has a version' do
+    expect(MiniCli::VERSION).not_to be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'rspec'
+require 'pry'
+
+RSpec.configure do |config|
+   config.color = true
+   config.tty = true
+   # config.formatter = :documentation # :documentation, :progress, :html, :textmate
+end
+
+$LOAD_PATH.unshift File.expand_path('lib')
+require 'mini_cli'
+
+$LOAD_PATH.unshift File.expand_path('spec/support')
+
+include MiniCli
+

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: mini_cli
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Manuel Morales
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: rerun
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+- !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: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+description: CLI for microservices
+email:
+- manuelmorales@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mini_cli.rb
+- lib/mini_cli/base.rb
+- lib/mini_cli/version.rb
+- mini_cli.gemspec
+- spec/mini_cli/base_spec.rb
+- spec/mini_cli_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/manuelmorales/mini-cli
+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: A Thor based CLI for services and Ruby apps.
+test_files:
+- spec/mini_cli/base_spec.rb
+- spec/mini_cli_spec.rb
+- spec/spec_helper.rb
+has_rdoc: