clin 0.1.0

data/spec/cli/command_dispacher_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+RSpec.describe Clin::CommandDispatcher do
+  describe '#initialize' do
+    before :all do
+      @cmd1 = Class.new(Clin::Command)
+      @cmd2 = Class.new(Clin::Command)
+      @cmd3 = Class.new(Clin::Command)
+    end
+
+    before do
+      allow(Clin::Command).to receive(:subclasses).and_return([@cmd1, @cmd2, @cmd3])
+    end
+
+    context 'when no argument given' do
+      subject { Clin::CommandDispatcher.new }
+      it { expect(subject.commands.size).to be 3 }
+      it { expect(subject.commands).to include(@cmd1) }
+      it { expect(subject.commands).to include(@cmd2) }
+      it { expect(subject.commands).to include(@cmd3) }
+    end
+
+    context 'when 1 command is given' do
+      subject { Clin::CommandDispatcher.new(@cmd3) }
+      it { expect(subject.commands.size).to be 1 }
+      it { expect(subject.commands).to include(@cmd3) }
+    end
+
+
+    context 'when 2 command is given' do
+      subject { Clin::CommandDispatcher.new(@cmd1, @cmd2) }
+      it { expect(subject.commands.size).to be 2 }
+      it { expect(subject.commands).to include(@cmd1) }
+      it { expect(subject.commands).to include(@cmd2) }
+    end
+
+    context 'when array of  command is given' do
+      subject { Clin::CommandDispatcher.new([@cmd1, @cmd2]) }
+      it { expect(subject.commands.size).to be 2 }
+      it { expect(subject.commands).to include(@cmd1) }
+      it { expect(subject.commands).to include(@cmd2) }
+    end
+  end
+
+  describe '#parse' do
+    let(:cmd1) { double(:command, parse: 'cmd1', usage: 'cmd1 use') }
+    let(:cmd2) { double(:command, parse: 'cmd2', usage: 'cmd1 use') }
+    let(:args) { %w(some args) }
+    subject { Clin::CommandDispatcher.new(cmd1, cmd2) }
+    context 'when first command match' do
+      before do
+        subject.parse(args)
+      end
+      it { expect(cmd1).to have_received(:parse).with(args, fallback_help: false) }
+      it { expect(subject.parse).to eq('cmd1') }
+    end
+
+    context 'when first command return FixedArgumentError' do
+      before do
+        allow(cmd1).to receive(:parse) { fail Clin::FixedArgumentError, :some }
+        subject.parse(args)
+      end
+      it { expect(cmd1).to have_received(:parse).with(args, fallback_help: false) }
+      it { expect(cmd2).to have_received(:parse).with(args, fallback_help: false) }
+      it { expect(subject.parse).to eq('cmd2') }
+    end
+
+    context 'when first command return ArgumentError' do
+      before do
+        allow(cmd1).to receive(:parse) { fail Clin::ArgumentError, :some }
+        allow(cmd2).to receive(:parse) { fail Clin::ArgumentError, :some }
+        begin
+          subject.parse(args)
+        rescue Clin::CommandLineError => e
+          @error = e
+        end
+      end
+      it { expect { subject.parse }.to raise_error(Clin::CommandLineError) }
+      it { expect(cmd1).to have_received(:parse).with(args, fallback_help: false) }
+      it { expect(cmd2).to have_received(:parse).with(args, fallback_help: false) }
+      it { expect(@error.to_s).to eq(subject.help_message) }
+    end
+  end
+end

data/spec/cli/command_options_mixin_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+require 'clin/command_options_mixin'
+
+RSpec.describe Clin::CommandOptionsMixin do
+  describe '#add_option' do
+    subject { Class.new(Clin::CommandOptionsMixin) }
+    let(:option) { Clin::Option.new(:name, '-n') }
+    before do
+      subject.add_option option
+    end
+
+    it { expect(subject.options.size).to be 1 }
+    it { expect(subject.options.first).to eq option }
+    it { expect(Clin::CommandOptionsMixin.options.size).to be 0 }
+  end
+
+  describe '#option' do
+    subject { Class.new(Clin::CommandOptionsMixin) }
+    let(:args) { [:name, '-n'] }
+    let(:option) { Clin::Option.new(*args) }
+
+    before do
+      allow(subject).to receive(:add_option)
+      subject.option(*args)
+    end
+
+    it { expect(subject).to have_received(:add_option).with(option) }
+
+  end
+
+  describe '#general_option' do
+    subject { Class.new(Clin::CommandOptionsMixin) }
+    let(:option) { double(:option, register_options: true, new: true) }
+    before do
+      subject.general_option option
+    end
+    it { expect(option).to have_received(:new) }
+    it { expect(subject.general_options.size).to be 1 }
+    it { expect(subject.general_options.values.first).to eq(true) }
+    it { expect(Clin::CommandOptionsMixin.general_options.size).to be 0 }
+  end
+
+  describe '#register_options' do
+    subject { Class.new(Clin::CommandOptionsMixin) }
+    let(:opt1) { double(:option, register: true) }
+    let(:opt2) { double(:option, register: true) }
+    let(:g_opt_cls) { double(:general_option_class, register_options: true) }
+    let(:g_opt) { double(:general_option, class: g_opt_cls) }
+    let(:opts) { double(:options) }
+    let(:out) { double(:out) }
+    before do
+      subject.add_option(opt1)
+      subject.add_option(opt2)
+      subject.general_options = {g_opt_cls => g_opt}
+
+      subject.register_options(opts, out)
+    end
+
+    it { expect(opt1).to have_received(:register).with(opts, out) }
+    it { expect(opt2).to have_received(:register).with(opts, out) }
+    it { expect(g_opt_cls).to have_received(:register_options).with(opts, out) }
+
+  end
+end

data/spec/cli/command_spec.rb

@@ -0,0 +1,225 @@
+require 'spec_helper'
+require 'clin/command'
+
+RSpec.describe Clin::Command do
+  describe '#arguments=' do
+    subject { Class.new(Clin::Command) }
+    let(:args) { %w(fix <var> [opt]) }
+    before do
+      allow(Clin::Argument).to receive(:new)
+    end
+    context 'when using string to set arguments' do
+      before do
+        subject.arguments (args.join(' '))
+      end
+      it { expect(subject.args.size).to eq(args.size) }
+      it { expect(Clin::Argument).to have_received(:new).exactly(args.size).times }
+    end
+
+    context 'when using array to set arguments' do
+      before do
+        subject.arguments (args)
+      end
+      it { expect(subject.args.size).to eq(args.size) }
+      it { expect(Clin::Argument).to have_received(:new).exactly(args.size).times }
+    end
+
+    context 'when using array that contains multiple arguments to set arguments' do
+      before do
+        subject.arguments ([args[0], args[1..-1]])
+      end
+      it { expect(subject.args.size).to eq(args.size) }
+      it { expect(Clin::Argument).to have_received(:new).exactly(args.size).times }
+    end
+
+  end
+
+  describe '#banner' do
+    subject { Class.new(Clin::Command) }
+    context 'when exe is defined' do
+      let(:exe) { Faker::Lorem.word }
+      before do
+        subject.exe_name(exe)
+      end
+
+      it { expect(subject.banner).to eq("Usage: #{exe} [Options]") }
+    end
+
+    context 'when exe is not defined' do
+      it { expect(subject.banner).to eq('Usage: command [Options]') }
+    end
+
+    context 'when arguments are defined' do
+      let(:arguments) { '<some> [Value]' }
+      before do
+        subject.arguments(arguments)
+      end
+
+      it { expect(subject.banner).to eq("Usage: #{Clin.default_exe_name} #{arguments} [Options]") }
+    end
+  end
+
+  describe '#parse_arguments' do
+    subject { Class.new(Clin::Command) }
+    let(:args) { %w(fix <var> [opt]) }
+
+    before do
+      subject.arguments(args)
+    end
+
+    it 'raise argument when fixed in different' do
+      expect { subject.parse_arguments(%w(other val opt)) }.to raise_error(Clin::CommandLineError)
+    end
+    it 'raise error when too few arguments' do
+      expect { subject.parse_arguments(['fix']) }.to raise_error(Clin::CommandLineError)
+    end
+    it 'raise error when too much argument' do
+      expect { subject.parse_arguments(%w(other val opt more)) }
+          .to raise_error(Clin::CommandLineError)
+    end
+
+    it 'map arguments' do
+      expect(subject.parse_arguments(%w(fix val opt))).to eq(fix: 'fix', var: 'val', opt: 'opt')
+    end
+
+    it 'opt argument is nil when not provided' do
+      expect(subject.parse_arguments(%w(fix val))).to eq(fix: 'fix', var: 'val')
+    end
+  end
+
+  describe '#parse_options' do
+    subject { Class.new(Clin::Command) }
+    let(:opt1) { Clin::Option.new(:name, 'Set name') }
+    let(:opt2) { Clin::Option.new(:verbose, 'Set verbose', argument: false) }
+    let(:opt3) { Clin::Option.new(:echo, 'Set name', optional_argument: true) }
+    before do
+      subject.add_option opt1
+      subject.add_option opt2
+      subject.add_option opt3
+    end
+
+    it 'raise argument when option value is missing' do
+      expect { subject.parse_options(%w(--name)) }.to raise_error(OptionParser::MissingArgument)
+    end
+    it 'raise error when unknown option' do
+      expect { subject.parse_options(%w(--other)) }.to raise_error(OptionParser::InvalidOption)
+    end
+
+    it { expect(subject.parse_options(%w(--name MyName))).to eq(name: 'MyName') }
+    it { expect(subject.parse_options(%w(--name=MyName))).to eq(name: 'MyName') }
+    it { expect(subject.parse_options(%w(-nMyName))).to eq(name: 'MyName') }
+
+
+    it { expect(subject.parse_options(%w(-v))).to eq(verbose: true) }
+
+    it { expect(subject.parse_options(%w(--echo))).to eq(echo: nil) }
+    it { expect(subject.parse_options(%w(-e EchoThis))).to eq(echo: 'EchoThis') }
+  end
+
+  describe '.handle_dispatch' do
+    subject { Class.new(Clin::Command) }
+    let(:args) { [Faker::Lorem.word, Faker::Lorem.word] }
+    before do
+      subject.arguments(%w(remote <args>...))
+    end
+
+    context 'when only dispatching arguments' do
+      before do
+        subject.dispatch :args
+        allow_any_instance_of(Clin::CommandDispatcher).to receive(:parse)
+      end
+      it 'call the command dispatcher with the right arguments' do
+        expect_any_instance_of(Clin::CommandDispatcher).to receive(:parse).once.with(args)
+        subject.handle_dispatch(remote: 'remote', args: args)
+      end
+    end
+
+    context 'when using prefix' do
+      let(:prefix) { 'remote' }
+      before do
+        subject.dispatch :args, prefix: prefix
+        allow_any_instance_of(Clin::CommandDispatcher).to receive(:parse)
+      end
+      it 'call the command dispatcher with the right arguments' do
+        expect_any_instance_of(Clin::CommandDispatcher).to receive(:parse).once.with([prefix] + args)
+        subject.handle_dispatch(remote: 'remote', args: args)
+      end
+    end
+
+    context 'when using commands' do
+      let(:cmd1) { double(:command) }
+      let(:cmd2) { double(:command) }
+      before do
+        subject.dispatch :args, commands: [cmd1, cmd2]
+        allow_any_instance_of(Clin::CommandDispatcher).to receive(:initialize)
+        allow_any_instance_of(Clin::CommandDispatcher).to receive(:parse)
+      end
+      it 'call the command dispatcher with the right arguments' do
+        expect_any_instance_of(Clin::CommandDispatcher).to receive(:initialize).once.with([cmd1, cmd2])
+        subject.handle_dispatch(remote: 'remote', args: args)
+      end
+    end
+
+    context 'when dispatcher raise HelpError' do
+      let(:new_message) { Faker::Lorem.sentence }
+      before do
+        subject.dispatch :args
+        allow_any_instance_of(Clin::CommandDispatcher).to receive(:initialize)
+        allow_any_instance_of(Clin::CommandDispatcher).to receive(:parse) do
+          fail Clin::HelpError, 'Dispatcher error'
+        end
+        allow(subject).to receive(:option_parser).and_return(new_message)
+      end
+      it { expect { subject.handle_dispatch(remote: 'remote', args: args) }.to raise_error(Clin::HelpError) }
+      it { expect { subject.handle_dispatch(remote: 'remote', args: args) }.to raise_error(new_message) }
+    end
+  end
+
+  describe '.dispatch_doc' do
+    subject { Class.new(Clin::Command) }
+    before do
+      subject.arguments(%w(remote <args>...))
+    end
+
+    let(:cmd1) { double(:command, usage: 'cmd1') }
+    let(:cmd2) { double(:command, usage: 'cmd2') }
+    let(:cmd3) { double(:command, usage: 'cmd3') }
+    let(:cmds) { [cmd1, cmd2, cmd3] }
+    let(:opts) { double(:option_parser, separator: true) }
+    before do
+      subject.dispatch :args, commands: cmds
+      allow_any_instance_of(Clin::CommandDispatcher).to receive(:initialize)
+      subject.dispatch_doc(opts)
+    end
+    it { expect(opts).to have_received(:separator).at_least(cmds.size).times }
+  end
+
+  describe '.subcommands' do
+    before do
+      @cmd1 = Class.new(Clin::Command)
+      @cmd2 = Class.new(Clin::Command)
+      @abstract_cmd = Class.new(Clin::Command) { abstract true }
+    end
+
+    it { expect(Clin::Command.subcommands).to include(@cmd1) }
+    it { expect(Clin::Command.subcommands).to include(@cmd2) }
+    it { expect(Clin::Command.subcommands).not_to include(@abstract_cmd) }
+  end
+
+  describe '.exe_name' do
+    context 'when not setting the exe_name' do
+      subject { Class.new(Clin::Command) }
+
+      it { expect(subject.exe_name).to eq(Clin.exe_name) }
+    end
+
+    context 'when setting the exe_name' do
+      let(:name) { Faker::Lorem.word }
+      subject { Class.new(Clin::Command) }
+      before do
+        subject.exe_name(name)
+      end
+      it { expect(subject.exe_name).to eq(name) }
+    end
+  end
+end

data/spec/cli/common/help_options_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+RSpec.describe Clin::HelpOptions do
+  describe 'options' do
+    let(:out) { {} }
+    it { expect(Clin::HelpOptions.options.size).to be 1 }
+    it 'call the callback' do
+      Clin::HelpOptions.options.first.block.call('opts', out, nil)
+      expect(out).to eq({help: 'opts'})
+    end
+  end
+
+  describe '#initialize' do
+    it { expect(Clin::HelpOptions.new(raise: false).instance_variable_get(:@raise)).to be false }
+    it { expect(Clin::HelpOptions.new.instance_variable_get(:@raise)).to be true }
+  end
+
+  describe '#execute' do
+    let(:help) { Faker::Lorem.sentence }
+    context 'when should raise' do
+      subject { Clin::HelpOptions.new(raise: true) }
+      it { expect { subject.execute({help: help}) }.to raise_error(Clin::HelpError) }
+    end
+    context 'when should not raise' do
+      subject { Clin::HelpOptions.new(raise: false) }
+      it { expect { subject.execute({help: help}) }.not_to raise_error }
+    end
+  end
+end

data/spec/cli/option_spec.rb

@@ -0,0 +1,132 @@
+require 'spec_helper'
+require 'clin/option'
+
+RSpec.describe Clin::Option do
+  describe '#initialize' do
+    context 'when initializing with name' do
+      subject { Clin::Option.new(:custom, 'This is my option!') }
+      it { expect(subject.name).to eq(:custom) }
+      it { expect(subject.short).to eq('-c') }
+      it { expect(subject.long).to eq('--custom') }
+      it { expect(subject.argument.to_s).to eq('CUSTOM') }
+      it { expect(subject.block).to be nil }
+    end
+
+    context 'when initializing with block' do
+      let(:block) { proc { puts 'Do stuff' } }
+      subject { Clin::Option.new(:my_option, 'This is my option!', &block) }
+      it { expect(subject.block).to eq(block) }
+    end
+  end
+
+  describe '#extract' do
+    let(:out) { Hash.new }
+    let(:opts) { double(:opts) }
+    let(:value) { 'some' }
+    before do
+      allow(opts).to receive(:on) do |*_args, &block|
+        block.call(value)
+      end
+    end
+
+    context 'when initializing with name' do
+      subject { Clin::Option.new(:my_option, 'This is my option!') }
+      before do
+        subject.register(opts, out)
+      end
+      it { expect(opts).to have_received(:on).once }
+      it { expect(out[:my_option]).to eq(value) }
+    end
+
+    context 'when initializing with block' do
+      let(:block) { proc { |_opts, out, value| out[:some] = value } }
+      subject { Clin::Option.new(:my_option, 'This is my option!', &block) }
+      before do
+        subject.register(opts, out)
+      end
+      it { expect(opts).to have_received(:on).once }
+      it { expect(out[:some]).to eq(value) }
+
+    end
+  end
+
+  describe '#on' do
+    let(:out) { Hash.new }
+    let(:value) { 'Some value' }
+    subject { Clin::Option.new(:my_option, 'This is my option!') }
+
+    before do
+      subject.on(value, out)
+    end
+    it { expect(out[:my_option]).to eq(value) }
+  end
+
+  describe '#default_short' do
+    subject { Clin::Option.new(:echo, Faker::Lorem.sentence) }
+
+    it { expect(subject.default_short).to eq('-e') }
+  end
+
+  describe '#default_long' do
+    subject { Clin::Option.new(:echo, Faker::Lorem.sentence) }
+
+    it { expect(subject.default_long).to eq('--echo') }
+  end
+
+  describe '#default_argument' do
+    subject { Clin::Option.new(:echo, Faker::Lorem.sentence) }
+
+    it { expect(subject.default_argument.to_s).to eq('ECHO') }
+  end
+
+  describe '#short' do
+    context 'when short is not specified' do
+      subject { Clin::Option.new(:echo, Faker::Lorem.sentence) }
+      it { expect(subject.short).to eq('-e') }
+    end
+
+    context 'when is set' do
+      subject { Clin::Option.new(:echo, Faker::Lorem.sentence, short: '-c') }
+      it { expect(subject.short).to eq('-c') }
+    end
+
+    context 'when short is set to false' do
+      subject { Clin::Option.new(:echo, Faker::Lorem.sentence, short: false) }
+      it { expect(subject.short).to eq(nil) }
+    end
+  end
+
+  describe '#long' do
+    context 'when long is not specified' do
+      subject { Clin::Option.new(:echo, Faker::Lorem.sentence) }
+      it { expect(subject.long).to eq('--echo') }
+    end
+
+    context 'when is set' do
+      subject { Clin::Option.new(:echo, Faker::Lorem.sentence, long: '--eko') }
+      it { expect(subject.long).to eq('--eko') }
+    end
+
+    context 'when long is set to false' do
+      subject { Clin::Option.new(:echo, Faker::Lorem.sentence, long: false) }
+      it { expect(subject.long).to eq(nil) }
+    end
+  end
+
+  describe '#argument' do
+    context 'when argument is not specified' do
+      subject { Clin::Option.new(:echo, Faker::Lorem.sentence) }
+      it { expect(subject.argument).to eq('ECHO') }
+    end
+
+    context 'when is set' do
+      subject { Clin::Option.new(:echo, Faker::Lorem.sentence, argument: 'MESSAGE') }
+      it { expect(subject.argument).to eq('MESSAGE') }
+    end
+
+    context 'when argument is set to false' do
+      subject { Clin::Option.new(:echo, Faker::Lorem.sentence, argument: false) }
+      it { expect(subject.argument).to eq(nil) }
+    end
+  end
+end

data/spec/errors_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+RSpec.describe Clin::Error do
+  describe Clin::MissingArgumentError do
+    let(:arg) { Faker::Lorem.name }
+    it { expect(Clin::MissingArgumentError.new(arg).to_s).to eq("Missing argument #{arg}") }
+  end
+end

data/spec/examples/simple_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'examples/simple'
+
+RSpec.describe 'simple_spec.rb' do
+  suppress_puts
+  it { expect(SimpleCommand.parse('display Some').params).
+      to eq(display: 'display', message: 'Some') }
+  it { expect(SimpleCommand.parse('display "Message with spaces"').params).
+      to eq(display: 'display', message: 'Message with spaces') }
+
+  it { expect(SimpleCommand.parse('display Some -e More').params).
+      to eq(display: 'display', message: 'Some', echo: 'More') }
+
+  it { expect(SimpleCommand.parse('display Some -eMore').params).
+      to eq(display: 'display', message: 'Some', echo: 'More') }
+
+  it { expect(SimpleCommand.parse('display Some -e "Even More"').params).
+      to eq(display: 'display', message: 'Some', echo: 'Even More') }
+
+  it { expect(SimpleCommand.parse('display Some --echo More').params).
+      to eq(display: 'display', message: 'Some', echo: 'More') }
+
+  it { expect(SimpleCommand.parse('display Some --echo=More').params).
+      to eq(display: 'display', message: 'Some', echo: 'More') }
+
+  it { expect(SimpleCommand.parse('display Some --echo "Even More"').params).
+      to eq(display: 'display', message: 'Some', echo: 'Even More') }
+
+  it { expect { SimpleCommand.parse('').params }.to raise_error(Clin::HelpError) }
+  it { expect { SimpleCommand.parse('-h').params }.to raise_error(Clin::HelpError) }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'coveralls'
+Coveralls.wear!
+$LOAD_PATH.push File.expand_path('../..', __FILE__)
+$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
+require 'rspec'
+require 'faker'
+require 'clin'
+
+module Clin::Rspec
+  module Helper
+
+  end
+
+  module Macro
+    def suppress_puts
+      before do
+        allow($stdout).to receive(:puts)
+      end
+    end
+  end
+end
+
+
+RSpec.configure do |config|
+  config.include Clin::Rspec::Helper
+  config.extend Clin::Rspec::Macro
+  config.order = 'random'
+end