simple_commander 0.0.1 → 0.1.0

data/dir_glob.rb

@@ -4,13 +4,12 @@ require 'fileutils'
 FileUtils.rm('Manifest')
 
 def glob(path)
-	return if !File.directory?(path) && path != "**"
-	path = "#{path}/*"
-	Dir.glob(path) do |file|
-		File.open("Manifest", 'a') {|f| f.write("#{file}\n") }
-		glob(file)
-	end
+  return if !File.directory?(path) && path != '**'
+  path = "#{path}/*"
+  Dir.glob(path) do |file|
+    File.open('Manifest', 'a') { |f| f.write("#{file}\n") }
+    glob(file)
+  end
 end
 
-glob("**")
-
+glob('**')

data/ember_c

@@ -1,54 +1,23 @@
 #!/usr/bin/env ruby
-require 'byebug'
-require 'simple_commander/import'
+$LOAD_PATH.unshift File.expand_path './lib'
 
+require 'simple_commander/import'
+require './helpers/http_helper'
 
 program :name, 'ember-c'
 program :version, '0.0.1'
 program :description, 'implementing ember with modified commander'
+helpers 'IO', 'HTTP'
 
 command :new do
 	syntax = 'ember-c new <name>'
 	summary = 'create a new ember project'
 	description = 'Create a new ember project'
 	action do |args, options|
-		puts args[0]
-		global
-	end
-end
-
-
-command :this do
-	command :is do
-		command :ok do
-			command :dont do
-				command :worry do
-					action do
-						puts "this is ok dont worry"
-					end
-				end
-			end
-
-			command :also do
-				action do
-					puts "this is ok also"
-				end
-			end
+		run_cmd(File.expand_path './') do
+			say `ls`
 		end
-	end
-end
-
-command :parent do
-	command :child do
-		action do |args, options|
-			puts 'nested child'	
-		end
-	end	
-end
-
-command 'do this' do
-	action do |args, options|
-		puts "do this!"
+		http_get
 	end
 end
 

data/helper.rb

@@ -0,0 +1,5 @@
+module Helper
+	def testing
+		say 'testing!!!'
+	end
+end

data/helpers/http_helper.rb

@@ -0,0 +1,5 @@
+module HTTP_helper
+	def http_get
+		say "HTTP GET"
+	end
+end

data/lib/simple_commander/command.rb

@@ -1,6 +1,6 @@
 require 'optparse'
 
-module Commander
+module SimpleCommander
   class Command
     attr_accessor :name, :examples, :syntax, :description, :super_self
     attr_accessor :summary, :proxy_options, :options
@@ -28,7 +28,7 @@ module Commander
       end
 
       def inspect
-        "<Commander::Command::Options #{ __hash__.map { |k, v| "#{k}=#{v.inspect}" }.join(', ') }>"
+        "<SimpleCommander::Command::Options #{ __hash__.map { |k, v| "#{k}=#{v.inspect}" }.join(', ') }>"
       end
     end
 
@@ -218,7 +218,7 @@ module Commander
     end
 
     def inspect
-      "<Commander::Command:#{name}>"
+      "<SimpleCommander::Command:#{name}>"
     end
   end
 end

data/lib/simple_commander/configure.rb

@@ -1,7 +1,7 @@
-module Commander
+module SimpleCommander
   def configure(*configuration_opts, &configuration_block)
     configuration_module = Module.new
-    configuration_module.extend Commander::Methods
+    configuration_module.extend SimpleCommander::Methods
 
     configuration_module.class_exec(*configuration_opts, &configuration_block)
 

data/lib/simple_commander/core_ext.rb

@@ -1,2 +1,2 @@
-require 'commander/core_ext/array'
-require 'commander/core_ext/object'
+require 'simple_commander/core_ext/array'
+require 'simple_commander/core_ext/object'

data/lib/simple_commander/delegates.rb

@@ -1,9 +1,10 @@
-module Commander
+module SimpleCommander
   module Delegates
     %w(
       add_command
       command
       program
+			helpers
       run!
       global_option
       alias_command
@@ -13,13 +14,13 @@ module Commander
     ).each do |meth|
       eval <<-END, binding, __FILE__, __LINE__
         def #{meth}(*args, &block)
-          ::Commander::Runner.instance.#{meth}(*args, &block)
+          ::SimpleCommander::Runner.instance.#{meth}(*args, &block)
         end
       END
     end
 
     def defined_commands(*args, &block)
-      ::Commander::Runner.instance.commands(*args, &block)
+      ::SimpleCommander::Runner.instance.commands(*args, &block)
     end
   end
 end

data/lib/simple_commander/help_formatters/base.rb

@@ -1,4 +1,4 @@
-module Commander
+module SimpleCommander
   ##
   # = Help Formatter
   #

data/lib/simple_commander/help_formatters/terminal.rb

@@ -1,6 +1,6 @@
 require 'erb'
 
-module Commander
+module SimpleCommander
   module HelpFormatter
     class Terminal < Base
       def render

data/lib/simple_commander/help_formatters/terminal_compact.rb

@@ -1,6 +1,6 @@
 require 'erb'
 
-module Commander
+module SimpleCommander
   module HelpFormatter
     class TerminalCompact < Terminal
       def template(name)

data/lib/simple_commander/help_formatters.rb

@@ -1,8 +1,8 @@
-module Commander
+module SimpleCommander
   module HelpFormatter
-    autoload :Base, 'commander/help_formatters/base'
-    autoload :Terminal, 'commander/help_formatters/terminal'
-    autoload :TerminalCompact, 'commander/help_formatters/terminal_compact'
+    autoload :Base, 'simple_commander/help_formatters/base'
+    autoload :Terminal, 'simple_commander/help_formatters/terminal'
+    autoload :TerminalCompact, 'simple_commander/help_formatters/terminal_compact'
 
     class Context
       def initialize(target)

data/lib/simple_commander/helpers/io.rb

@@ -0,0 +1,128 @@
+require 'erb'
+
+module IO_helper
+	def run_cmd(path)
+		FileUtils.cd(path) do
+			yield
+		end
+	end
+
+	def mkdir(dest)
+		if(File.directory?(dest))
+			puts "#{dest} already exist!"
+			return 0
+		end
+		FileUtils.mkdir(dest)
+	end
+
+	def copy(src, dest)
+		FileUtils.cp(src, dest)
+	end
+
+	def copy_dir(src, dest)
+		FileUtils.copy_entry(src, dest)
+	end
+
+	def template(src, dest, replace=false)
+		if(File.file?(dest) and !replace)
+			puts "#{dest} already exist!"
+			return 0
+		end
+		template = File.open(src, 'r')
+		file_contents = template.read
+		template.close
+		renderer = ERB.new(file_contents)
+		result = renderer.result(binding)
+		output = File.open(dest, 'w+')
+		output.write(result)
+		output.close
+	end
+
+	def rm_file(path)
+		FileUtils.remove_file path
+	end
+
+	def rm_dir(path)
+		FileUtils.rmdir path 
+	end
+
+	def in_file?(string, path)
+		regexp, content = Regexp.new string
+		File.open(path, 'r'){|f| content = f.read }
+		content =~ regexp
+	end
+
+	def write_start(string, path)
+		lines = []
+		File.open(path, 'r'){|f| lines = f.readlines }
+		lines.unshift("#{string}\n")
+		File.open(path, 'w+'){|f| f.write(lines.join)}
+	end
+	
+	def write_end(string, path)
+		lines = []
+		File.open(path, 'r'){|f| lines = f.readlines }
+		lines << "#{string}\n"
+		File.open(path, 'w+'){|f| f.write(lines.join)}
+	end
+
+	def write_after(id, string, path)
+		lines = []
+		File.open(path, 'r'){|f| lines = f.readlines }
+		new_lines = lines.inject([]) do |result, value|
+			if value.include? id
+				result << value
+				result << "#{string}\n"
+			else
+				result << value
+			end
+		end
+		File.open(path, 'w+'){|f| f.write(new_lines.join)}
+	end
+
+	def rm_string(string, path)
+		regexp = Regexp.new string
+		lines = []
+		File.open(path, 'r'){|f| lines = f.readlines }
+		new_lines = lines.reject{|line| line =~ regexp }
+		File.open(path, 'w+'){|f| f.write(new_lines.join)}
+	end
+
+	def rm_block(start_id, end_id, path)
+		start_regexp = Regexp.new start_id
+		end_regexp = Regexp.new end_id
+		lines, new_lines, result = [], [], true
+		File.open(path, 'r'){|f| lines = f.readlines }
+		lines.chunk { |line|
+			if line =~ start_regexp
+				result = false
+			elsif line =~ end_regexp
+				result = true
+			end
+			result
+		}.each{ |result, arr| 
+			if result
+				arr[0] =~ end_regexp ? arr.shift : arr
+				new_lines << arr
+			end
+		}
+		File.open(path, 'w+'){|f| f.write(new_lines.join)}
+	end
+
+	def cli_exist?(path, cli)
+		File.directory?("#{path}/#{cli}")
+	end
+
+	def command_exist?(path, command)
+		File.file?("#{path}/subcommands/#{command}.rb")
+	end
+
+	def subcommand_exist?(path, command, subcommand)
+		File.file?("#{path}/subcommands/#{command}/#{command}_#{subcommand}.rb")
+	end
+
+	def have_subcommands?(path, cli, command)
+		in_file? /register/, 
+			"#{path}/#{cli}/subcommands/#{command}.rb"	
+	end
+end

data/lib/simple_commander/helpers.rb

@@ -0,0 +1 @@
+require 'simple_commander/helpers/io'

data/lib/simple_commander/import.rb

@@ -1,5 +1,5 @@
 require 'simple_commander'
 
-include Commander::Methods
+include SimpleCommander::Methods
 
 at_exit { run! }

data/lib/simple_commander/methods.rb

@@ -1,8 +1,8 @@
-module Commander
+module SimpleCommander
   module Methods
-    include Commander::UI
-    include Commander::UI::AskForClass
-    include Commander::Delegates
+    include SimpleCommander::UI
+    include SimpleCommander::UI::AskForClass
+    include SimpleCommander::Delegates
 
     if $stdin.tty? && (cols = $terminal.output_cols) >= 40
       $terminal.wrap_at = cols - 5

data/lib/simple_commander/platform.rb

@@ -1,4 +1,4 @@
-module Commander
+module SimpleCommander
   module Platform
     def self.jruby?
       defined?(RUBY_ENGINE) && (RUBY_ENGINE == 'jruby')

data/lib/simple_commander/runner.rb

@@ -1,6 +1,6 @@
 require 'optparse'
 
-module Commander
+module SimpleCommander
   class Runner
     #--
     # Exceptions
@@ -8,6 +8,7 @@ module Commander
 
     class CommandError < StandardError; end
     class InvalidCommandError < CommandError; end
+		class UndefinedHelperError < StandardError; end
 
     ##
     # Array of commands.
@@ -36,6 +37,28 @@ module Commander
       @never_trace = false
       create_default_commands
     end
+		
+		## 
+		# search in the helpers folders for the helpers module
+		# and include in the runner
+		
+		def helpers(*args)
+			args.each do |h|
+				helper_name = "#{h}_helper"
+				fail UndefinedHelperError, "Invalid helper #{helper_name}", 
+					caller if !helper_exist? helper_name
+				SimpleCommander::Runner.send(:include, 
+																		 Object.const_get(helper_name))	
+			end
+		end
+
+		##
+		# check if the helper exist 
+
+		def helper_exist?(helper)
+			Object.const_defined?(helper) && 
+			Object.const_get(helper).instance_of?(::Module)
+		end
 
     ##
     # Return singleton Runner instance.
@@ -64,11 +87,11 @@ module Commander
       global_option('-t', '--trace', 'Display backtrace when an error occurs') { trace = true } unless @never_trace || @always_trace
       parse_global_options
       remove_global_options options, @args
-			have_action?
       if trace
         run_active_command
       else
         begin
+					have_action?
           run_active_command
         rescue InvalidCommandError => e
           abort "#{e}. Use --help for more information"
@@ -91,6 +114,7 @@ module Commander
 		# tests if the current active command have an action block
 
 		def have_action?
+			require_valid_command
 			goto_child_command if active_command.has_no_action?
 		end
 
@@ -187,14 +211,12 @@ module Commander
     #
 
     def command(name, &block)
-			Commander::Command.new(name).tap do |cmd|
+			SimpleCommander::Command.new(name).tap do |cmd|
 				add_command(cmd) if block
 				cmd.super_self = self
 				cmd.instance_eval &block if block
 			end
-			#add_command(Commander::Command.new(name)) if block
-      #yield add_command(Commander::Command.new(name)) if block
-      @commands[name.to_s]
+			@commands[name.to_s]
     end
 
     ##

data/lib/simple_commander/user_interaction.rb

@@ -1,7 +1,7 @@
 require 'tempfile'
 require 'shellwords'
 
-module Commander
+module SimpleCommander
   ##
   # = User Interaction
   #
@@ -257,7 +257,7 @@ module Commander
 
     def ask_editor(input = nil, preferred_editor = nil)
       editor = available_editor preferred_editor
-      program = Commander::Runner.instance.program(:name).downcase rescue 'commander'
+      program = SimpleCommander::Runner.instance.program(:name).downcase rescue 'commander'
       tmpfile = Tempfile.new program
       begin
         tmpfile.write input if input

data/lib/simple_commander/version.rb

@@ -1,3 +1,3 @@
-module Commander
-  VERSION = '0.0.1'
+module SimpleCommander
+  VERSION = '0.1.0'
 end

data/lib/simple_commander.rb

@@ -32,4 +32,5 @@ require 'simple_commander/help_formatters'
 require 'simple_commander/platform'
 require 'simple_commander/delegates'
 require 'simple_commander/methods'
+require 'simple_commander/helpers'
 require 'simple_commander/configure'

data/simple_commander.gemspec

@@ -4,7 +4,7 @@ require 'simple_commander/version'
 
 Gem::Specification.new do |s|
 	s.name        = 'simple_commander'
-  s.version     = Commander::VERSION
+  s.version     = SimpleCommander::VERSION
   s.authors     = ['Marcell Monteiro Cruz']
   s.email       = ['0000marcell@gmail.com']
   s.license     = 'MIT'
@@ -15,6 +15,7 @@ Gem::Specification.new do |s|
 	s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
 	s.require_paths = ['lib'] 
 	s.license     = 'MIT'
+	s.add_runtime_dependency('highline', '~> 1.7.2')
 	s.add_development_dependency('rspec', '~> 3.2')
   s.add_development_dependency('rake')
   s.add_development_dependency('simplecov')

data/spec/command_spec.rb

@@ -0,0 +1,157 @@
+require 'spec_helper'
+
+describe SimpleCommander::Command do
+  include SimpleCommander::Methods
+
+  before :each do
+    mock_terminal
+    create_test_command
+  end
+
+  describe 'Options' do
+    before :each do
+      @options = SimpleCommander::Command::Options.new
+    end
+
+    it 'should act like an open struct' do
+      @options.send = 'mail'
+      @options.call = true
+      expect(@options.send).to eq('mail')
+      expect(@options.call).to eq(true)
+    end
+
+    it 'should allow __send__ to function as always' do
+      @options.send = 'foo'
+      expect(@options.__send__(:send)).to eq('foo')
+    end
+  end
+
+  describe '#option' do
+    it 'should add options' do
+      expect { @command.option '--recursive' }.to change(@command.options, :length).from(1).to(2)
+    end
+
+    it 'should allow procs as option handlers' do
+      @command.option('--recursive') { |recursive| expect(recursive).to be true }
+      @command.run '--recursive'
+    end
+
+    it 'should allow usage of common method names' do
+      @command.option '--open file'
+      @command.when_called { |_, options| expect(options.open).to eq('foo') }
+      @command.run '--open', 'foo'
+    end
+  end
+
+  describe '#run' do
+    describe 'should invoke #when_called' do
+      it 'with arguments seperated from options' do
+        @command.when_called { |args, _options| expect(args.join(' ')).to eq('just some args') }
+        @command.run '--verbose', 'just', 'some', 'args'
+      end
+
+      it 'calling the #call method by default when an object is called' do
+        object = double 'Object'
+        expect(object).to receive(:call).once
+        @command.when_called object
+        @command.run 'foo'
+      end
+
+      it 'should allow #action as an alias to #when_called' do
+        object = double 'Object'
+        expect(object).to receive(:call).once
+        @command.action object
+        @command.run 'foo'
+      end
+
+      it 'calling an arbitrary method when an object is called' do
+        object = double 'Object'
+        expect(object).to receive(:foo).once
+        @command.when_called object, :foo
+        @command.run 'foo'
+      end
+
+      it 'should raise an error when no handler is present' do
+        expect { @command.when_called }.to raise_error(ArgumentError)
+      end
+    end
+
+    describe 'should populate options with' do
+      it 'boolean values' do
+        @command.option '--[no-]toggle'
+        @command.when_called { |_, options| expect(options.toggle).to be true }
+        @command.run '--toggle'
+        @command.when_called { |_, options| expect(options.toggle).to be false }
+        @command.run '--no-toggle'
+      end
+
+      it 'mandatory arguments' do
+        @command.option '--file FILE'
+        @command.when_called { |_, options| expect(options.file).to eq('foo') }
+        @command.run '--file', 'foo'
+        expect { @command.run '--file' }.to raise_error(OptionParser::MissingArgument)
+      end
+
+      describe 'optional arguments' do
+        before do
+          @command.option '--use-config [file] '
+        end
+
+        it 'should return the argument when provided' do
+          @command.when_called { |_, options| expect(options.use_config).to eq('foo') }
+          @command.run '--use-config', 'foo'
+        end
+
+        it 'should return true when present without an argument' do
+          @command.when_called { |_, options| expect(options.use_config).to be true }
+          @command.run '--use-config'
+        end
+
+        it 'should return nil when not present' do
+          @command.when_called { |_, options| expect(options.use_config).to be_nil }
+          @command.run
+        end
+      end
+
+      describe 'typed arguments' do
+        before do
+          @command.option '--interval N', Integer
+        end
+
+        it 'should parse valid values' do
+          @command.when_called { |_, options| expect(options.interval).to eq(5) }
+          @command.run '--interval', '5'
+        end
+
+        it 'should reject invalid values' do
+          expect { @command.run '--interval', 'invalid' }.to raise_error(OptionParser::InvalidArgument)
+        end
+      end
+
+      it 'lists' do
+        @command.option '--fav COLORS', Array
+        @command.when_called { |_, options| expect(options.fav).to eq(%w(red green blue)) }
+        @command.run '--fav', 'red,green,blue'
+      end
+
+      it 'lists with multi-word items' do
+        @command.option '--fav MOVIES', Array
+        @command.when_called { |_, options| expect(options.fav).to eq(['super\ bad', 'nightmare']) }
+        @command.run '--fav', 'super\ bad,nightmare'
+      end
+
+      it 'defaults' do
+        @command.option '--files LIST', Array
+        @command.option '--interval N', Integer
+        @command.when_called do |_, options|
+          options.default \
+            files: %w(foo bar),
+            interval: 5
+          expect(options.files).to eq(%w(foo bar))
+          expect(options.interval).to eq(15)
+        end
+        @command.run '--interval', '15'
+      end
+    end
+  end
+end