mini_cli 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea711692c0f25baafc371451a02dbe2dbbe9b614
-  data.tar.gz: 1ebaa4205176286a479a8d9e466fb6a76240cda4
+  metadata.gz: 88b867e88d34b469c42cd338e2634d1f29f71549
+  data.tar.gz: e0ebeb0d82502d788aefd68909b5a22bd335ef7f
 SHA512:
-  metadata.gz: cd18091197c638be75652bf314754ad35045d50b4a84501c893bddbfffe5ffc144caf24f14239586dd230b727aa632708ba60048f51f0904b62a570febf71c64
-  data.tar.gz: 8ede5324662a3523139ea07b98c3605de469b9df890c63facdeda59dba23fc1839f7bc04fa0360be0113b43d21d5fdf35f6c62a1c4c2c366d13d182153b4330c
+  metadata.gz: acf496d09953f5970961130dfa7bf406fa1f1988b49007a84f507a11bab8f35c4b60c90add5cc5f1547f8d1c263f733bcb23f8ec676243b3efc64d019c9ef2ad
+  data.tar.gz: f3683878236374c43037d3e397b2b08b9b72e40ce4797bf6b72eb669f5c82a96c37c4beaf2ada6b79a97cc99b33e447424c920cbf71797adab02ffbdff7599d5

data/.gitignore

@@ -1 +1,2 @@
 tags
+*.gem

data/Gemfile

@@ -3,6 +3,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :test, :development do
+  gem 'gem-release'
   gem 'mini_check', require: false
   gem 'rspec', require: false
   gem 'pry', require: false

data/Gemfile.lock

@@ -2,8 +2,8 @@ PATH
   remote: .
   specs:
     mini_cli (0.0.1)
-      puma
-      rerun
+      puma (~> 2.10)
+      rerun (~> 0.10)
       thor (~> 0.19)
 
 GEM
@@ -14,9 +14,10 @@ GEM
     coderay (1.1.0)
     diff-lcs (1.2.5)
     ffi (1.9.6)
+    gem-release (0.7.3)
     hitimes (1.2.2)
     json (1.8.1)
-    listen (2.8.3)
+    listen (2.8.5)
       celluloid (>= 0.15.2)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9)
@@ -27,7 +28,7 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    puma (2.10.2)
+    puma (2.11.1)
       rack (>= 1.1, < 2.0)
     rack (1.5.2)
     rack-test (0.6.2)
@@ -60,9 +61,10 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.3)
+  gem-release
   mini_check
   mini_cli!
   pry
   rack-test
-  rake
+  rake (~> 10.4)
   rspec

data/README.md

@@ -1,9 +1,13 @@
 # MiniCli
 
-Simple command line interface for microservices built using Thor.
-It provides basic commands:
+The idea behind MiniCli is that apps should provide a common entry point that is self-explanatory.
+A single executable script that lists all you can do with the app and some help about it.
+This makes it very easy for new developers to use your app.
+I. e:
 
 ```
+> ./cli
+
 Commands:
   cli auto [COMMAND]  # Re-runs the given command on any file change
   cli console         # Pry console with the app available
@@ -12,15 +16,20 @@ Commands:
   cli test            # Run the test suite
 ```
 
-
-## Usage
-
-Inherit from MiniCli::Base to provide the basic commands:
+MiniCli it provides a set of easy to include ready-made Thor commands to help achieve that.
+Ideally, libraries that provides their own commands would also provide this easy to include commands:
 
 ```ruby
 require 'mini_cli'
 
-class Cli < MiniCli::Base
+class CLI < Thor
+  include MiniCli::BaseModule
+
+  add_startup_benchmark
+  add_start_puma puma_args: %w{-p 22000}
+  add_console_pry
+  add_test_rspec
+  add_auto_rerun
 end
 ```
 
@@ -30,7 +39,7 @@ Invoke it as a regular Thor class:
 #!/usr/bin/env ruby
 
 require_relative 'cli'
-PatioSessions::Cli.start
+CLI.start
 ```
 
 

data/cli

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'bundler'
+Bundler.require(:test, :default, :development)
+
+require 'thor'
+require_relative 'lib/mini_cli'
+
+class CLI < Thor
+  include MiniCli::BaseModule
+  add_test_rspec
+end
+
+CLI.start
+

data/lib/mini_cli/base.rb

@@ -3,55 +3,12 @@ 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
+    include BaseModule
+    add_startup_benchmark
+    add_start_puma puma_args: %w{-p 22000}
+    add_console_pry
+    add_test_rspec
+    add_auto_rerun
   end
 end
 

data/lib/mini_cli/base_module.rb

@@ -0,0 +1,66 @@
+module MiniCli
+  # Provides class methods for individual definition of ready-made commands
+  module BaseModule
+    module ClassMethods
+      def add_console_pry
+        desc 'console', 'Pry console with the app available'
+        define_method :console do
+          require'pry'
+          Pry.start
+        end
+      end
+
+      def add_test_rspec
+        desc 'test', 'Run the test suite'
+        define_method :test do |*args|
+          args = ['spec'] if args.empty?
+          require 'rspec'
+          RSpec::Core::Runner.run(args)
+        end
+      end
+
+      def add_auto_rerun
+        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."
+        define_method :auto do |*args|
+          require 'rerun'
+
+          options = Rerun::Options.parse [
+            '--background', 
+            '--name', "./cli #{args.first}",
+            '--signal', 'ABRT',
+          ]
+
+          Rerun::Runner.keep_running("./cli #{args.join " "}", options)
+        end
+      end
+
+      def add_start_puma opts = {}
+        opts = opts.dup
+        puma_args = opts.delete(:puma_args) || []
+        raise("Unrecognized options #{opts.inspect}") if opts.keys.any?
+
+        desc 'start', 'Starts the Puma and any other required thread'
+        define_method :start do
+          require 'puma/cli'
+          Puma::CLI.new(puma_args).run
+        end
+      end
+
+      def add_startup_benchmark
+        # 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
+      end
+    end
+
+    def self.included klass
+      klass.extend ClassMethods
+    end
+  end
+end
+

data/lib/mini_cli/version.rb

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

data/lib/mini_cli.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_cli
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Manuel Morales
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-13 00:00:00.000000000 Z
+date: 2015-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -93,8 +93,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- cli
 - lib/mini_cli.rb
 - lib/mini_cli/base.rb
+- lib/mini_cli/base_module.rb
 - lib/mini_cli/version.rb
 - mini_cli.gemspec
 - spec/mini_cli/base_spec.rb