clin 0.1.0 → 0.2.0

data/spec/clin/option_list_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+RSpec.describe Clin::OptionList do
+  describe '#on' do
+    let(:name) { Faker::Lorem.word }
+    let(:description) { Faker::Lorem.sentence }
+    let(:out) { Hash.new }
+    context 'when normal list option' do
+      subject { Clin::OptionList.new(name, description) }
+      before do
+        subject.on('val1', out)
+        subject.on('val2', out)
+      end
+
+      it { expect(out[name]).to be_a Array }
+      it { expect(out[name].size).to be 2 }
+      it { expect(out[name]).to include('val1') }
+      it { expect(out[name]).to include('val2') }
+    end
+
+    context 'when flag list option' do
+      subject { Clin::OptionList.new(name, description, argument: false) }
+      before do
+        subject.on(true, out)
+        subject.on(true, out)
+      end
+
+      it { expect(out[name]).to be_a Integer }
+      it { expect(out[name]).to be 2 }
+    end
+  end
+end

data/spec/{cli → clin}/option_spec.rb

@@ -68,9 +68,17 @@ RSpec.describe Clin::Option do
   end
 
   describe '#default_long' do
-    subject { Clin::Option.new(:echo, Faker::Lorem.sentence) }
+    context 'simple name' do
+      subject { Clin::Option.new(:echo, Faker::Lorem.sentence) }
+
+      it { expect(subject.default_long).to eq('--echo') }
+    end
+
+    context 'when name contains underscores' do
+      subject { Clin::Option.new(:echo_more, Faker::Lorem.sentence) }
 
-    it { expect(subject.default_long).to eq('--echo') }
+      it { expect(subject.default_long.to_s).to eq('--echo-more') }
+    end
   end
 
   describe '#default_argument' do

data/spec/examples/list_option_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'examples/list_option'
+
+RSpec.describe 'list_option.rb' do
+  suppress_puts
+  it { expect(ListCommand.parse('').params).to eq(echo: [], line: 0) }
+  it { expect(ListCommand.parse('--echo msg').params).to eq(echo: ['msg'], line: 0) }
+  it { expect(ListCommand.parse('--line').params).to eq(echo: [], line: 1) }
+  it { expect(ListCommand.parse('--line --line').params).to eq(echo: [], line: 2) }
+  it { expect(ListCommand.parse('-lll').params).to eq(echo: [], line: 3) }
+  it do
+    expect(ListCommand.parse('--echo msg1 --echo msg2').params)
+      .to eq(echo: %w(msg1 msg2), line: 0)
+  end
+
+  it do
+    expect(ListCommand.parse('--echo msg1 --line --echo msg2 -ll').params)
+      .to eq(echo: %w(msg1 msg2), line: 3)
+  end
+end

data/spec/examples/nested_dispatcher_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'examples/nested_dispatcher'
+
+RSpec.describe 'nested_dispatcher.rb' do
+  suppress_puts
+  it { expect(DispatchCommand.parse('you display Some').params).
+    to eq(you: 'you', display: 'display', message: 'Some') }
+
+  it { expect(DispatchCommand.parse('you display Some -e More').params).
+    to eq(you: 'you', display: 'display', message: 'Some', echo: 'More') }
+
+  it {
+    expect(DispatchCommand.parse('you display Some -e More --times 3').params).
+    to eq(you: 'you', display: 'display', message: 'Some', echo: 'More', times: 3)
+  }
+
+  it { expect(DispatchCommand.parse('you display Some -e More --times 3 -v').params).
+    to eq(you: 'you', display: 'display', message: 'Some', echo: 'More', times: 3) }
+
+  it { expect(DispatchCommand.parse('you display Some --verbose -e More --times 3').params).
+    to eq(you: 'you', display: 'display', message: 'Some', echo: 'More', times: 3) }
+
+  it {
+    expect(DispatchCommand.parse('you  --verbose display Some -e More --times 3').params).
+      to eq(you: 'you', display: 'display', message: 'Some', echo: 'More', times: 3) }
+  it { expect { DispatchCommand.parse('').params }.to raise_error(Clin::HelpError) }
+  it { expect { DispatchCommand.parse('-h').params }.to raise_error(Clin::HelpError) }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clin
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Timothee Guerin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-27 00:00:00.000000000 Z
+date: 2015-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -105,12 +105,14 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - clin.gemspec
 - examples/dispatcher.rb
+- examples/list_option.rb
 - examples/nested_dispatcher.rb
 - examples/optional_argument.rb
 - examples/simple.rb
@@ -120,18 +122,24 @@ files:
 - lib/clin/command.rb
 - lib/clin/command_dispatcher.rb
 - lib/clin/command_options_mixin.rb
+- lib/clin/command_parser.rb
 - lib/clin/common/help_options.rb
 - lib/clin/errors.rb
 - lib/clin/general_option.rb
 - lib/clin/option.rb
+- lib/clin/option_list.rb
 - lib/clin/version.rb
-- spec/cli/argument_spec.rb
-- spec/cli/command_dispacher_spec.rb
-- spec/cli/command_options_mixin_spec.rb
-- spec/cli/command_spec.rb
-- spec/cli/common/help_options_spec.rb
-- spec/cli/option_spec.rb
+- spec/clin/argument_spec.rb
+- spec/clin/command_dispacher_spec.rb
+- spec/clin/command_options_mixin_spec.rb
+- spec/clin/command_parser_spec.rb
+- spec/clin/command_spec.rb
+- spec/clin/common/help_options_spec.rb
+- spec/clin/option_list_spec.rb
+- spec/clin/option_spec.rb
 - spec/errors_spec.rb
+- spec/examples/list_option_spec.rb
+- spec/examples/nested_dispatcher_spec.rb
 - spec/examples/simple_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -159,13 +167,17 @@ signing_key:
 specification_version: 4
 summary: Clin provide an advance way to define complex command line interface.
 test_files:
-- spec/cli/argument_spec.rb
-- spec/cli/command_dispacher_spec.rb
-- spec/cli/command_options_mixin_spec.rb
-- spec/cli/command_spec.rb
-- spec/cli/common/help_options_spec.rb
-- spec/cli/option_spec.rb
+- spec/clin/argument_spec.rb
+- spec/clin/command_dispacher_spec.rb
+- spec/clin/command_options_mixin_spec.rb
+- spec/clin/command_parser_spec.rb
+- spec/clin/command_spec.rb
+- spec/clin/common/help_options_spec.rb
+- spec/clin/option_list_spec.rb
+- spec/clin/option_spec.rb
 - spec/errors_spec.rb
+- spec/examples/list_option_spec.rb
+- spec/examples/nested_dispatcher_spec.rb
 - spec/examples/simple_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/spec/cli/command_spec.rb

@@ -1,225 +0,0 @@
-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