clin 0.2.0 → 0.3.0

data/spec/clin/option_spec.rb

@@ -137,4 +137,44 @@ RSpec.describe Clin::Option do
       it { expect(subject.argument).to eq(nil) }
     end
   end
+
+  describe '.parse' do
+    let(:name) { Faker::Lorem.name }
+    context 'when no argument' do
+      subject { Clin::Option.parse(name, '-e --eko') }
+
+      it { expect(subject.name).to eq(name) }
+      it { expect(subject.short).to eq('-e') }
+      it { expect(subject.long).to eq('--eko') }
+      it { expect(subject.argument).to be nil }
+    end
+
+    context 'when argument' do
+      subject { Clin::Option.parse(name, '-e --eko=message') }
+
+      it { expect(subject.name).to eq(name) }
+      it { expect(subject.short).to eq('-e') }
+      it { expect(subject.long).to eq('--eko') }
+      it { expect(subject.argument).to eq('message') }
+    end
+
+    context 'when argument method 2' do
+      subject { Clin::Option.parse(name, '-e --eko=<message>') }
+
+      it { expect(subject.name).to eq(name) }
+      it { expect(subject.short).to eq('-e') }
+      it { expect(subject.long).to eq('--eko') }
+      it { expect(subject.argument).to eq('message') }
+    end
+
+    context 'when optional argument' do
+      subject { Clin::Option.parse(name, '-e --eko=[message]') }
+
+      it { expect(subject.name).to eq(name) }
+      it { expect(subject.short).to eq('-e') }
+      it { expect(subject.long).to eq('--eko') }
+      it { expect(subject.argument).to eq('message') }
+      it { expect(subject.optional_argument).to be true }
+    end
+  end
 end

data/spec/clin/shell_interaction/choose_spec.rb

@@ -0,0 +1,54 @@
+require 'clin'
+
+RSpec.describe Clin::ShellInteraction::Choose do
+  let(:shell) { Clin::Shell.new }
+  subject { Clin::ShellInteraction::Choose.new(shell) }
+
+  def expects_scan(message, *outputs)
+    expect(shell)
+      .to receive(:scan).with(message, any_args).and_return(*outputs).exactly(outputs.size).times
+  end
+
+  describe '#choice_message' do
+    let(:options) { {yes: '', no: '', maybe: ''} }
+    it { expect(subject.send(:choice_message, options)).to eq('[yes,no,maybe]') }
+    it { expect(subject.send(:choice_message, options, default: :yes)).to eq('[YES,no,maybe]') }
+    it { expect(subject.send(:choice_message, options, default: :no)).to eq('[yes,NO,maybe]') }
+    it { expect(subject.send(:choice_message, options, initials: true)).to eq('[ynm]') }
+    it { expect(subject.send(:choice_message, options, default: :yes, initials: true)).to eq('[Ynm]') }
+    it { expect(subject.send(:choice_message, options, default: :maybe, initials: true)).to eq('[ynM]') }
+  end
+
+  describe '#prepare_question' do
+    let(:options) { {yes: '', no: '', maybe: ''} }
+    it do
+      expect(subject.send(:prepare_question, 'Is it true?', options))
+        .to eq('Is it true? [yes,no,maybe]')
+    end
+  end
+
+  describe '#run' do
+    let(:countries) { %w(usa france germany italy) }
+
+    it 'ask for a choice and return the user reply' do
+      expects_scan('Where are you from? [usa,france,germany,italy]', 'France')
+      expect(subject.run('Where are you from?', countries)).to eq('france')
+    end
+
+    it 'ask for a choice and return the default' do
+      expects_scan('Where are you from? [usa,france,GERMANY,italy]', '')
+      expect(subject.run('Where are you from?', countries, default: 'germany')).to eq('germany')
+    end
+
+    it 'ask for a choice and user can reply with initials' do
+      expects_scan('Where are you from? [ufgi]', 'i')
+      expect(subject.run('Where are you from?', countries, allow_initials: true)).to eq('italy')
+    end
+
+    it 'keep asking until the answer is valid' do
+      expects_scan('Where are you from? [usa,france,germany,italy]', 'spain', 'russia', 'france')
+      expect(subject).to receive(:print_choices_help).twice
+      expect(subject.run('Where are you from?', countries)).to eq('france')
+    end
+  end
+end

data/spec/clin/shell_spec.rb

@@ -0,0 +1,147 @@
+require 'clin'
+
+RSpec.describe Clin::Shell do
+  def expects_scan(message, *outputs)
+    expect(subject).to receive(:scan).with(message, any_args).and_return(*outputs).exactly(outputs.size).times
+  end
+
+  describe '#ask' do
+    it 'ask for a question and return user reply' do
+      expects_scan('What is your name?', 'Smith')
+      expect(subject.ask('What is your name?')).to eq('Smith')
+    end
+
+    it 'ask for a question and return default' do
+      expects_scan('What is your name?', '')
+      expect(subject.ask('What is your name?', default: 'Brown')).to eq('Brown')
+    end
+  end
+
+  describe '#choose' do
+    let(:countries) { %w(usa france germany italy) }
+
+    it 'ask for a choice and return the user reply' do
+      expects_scan('Where are you from? [usa,france,germany,italy]', 'France')
+      expect(subject.choose('Where are you from?', countries)).to eq('france')
+    end
+
+    it 'ask for a choice and return the default' do
+      expects_scan('Where are you from? [usa,france,GERMANY,italy]', '')
+      expect(subject.choose('Where are you from?', countries, default: 'germany')).to eq('germany')
+    end
+
+    it 'ask for a choice and user can reply with initials' do
+      expects_scan('Where are you from? [ufgi]', 'i')
+      expect(subject.choose('Where are you from?', countries, allow_initials: true)).to eq('italy')
+    end
+  end
+
+  describe '#yes_or_no' do
+    it 'asks the user and returns true if the user replies y' do
+      expects_scan('Is earth round? [yn]', 'y')
+      expect(subject.yes_or_no('Is earth round?')).to be true
+    end
+
+    it 'asks the user and returns true if the user replies yes' do
+      expects_scan('Is earth round? [yn]', 'yes')
+      expect(subject.yes_or_no('Is earth round?')).to be true
+    end
+
+    it 'asks the user and returns false if the user replies n' do
+      expects_scan('Is earth flat? [yn]', 'n')
+      expect(subject.yes_or_no('Is earth flat?')).to be false
+    end
+
+    it 'asks the user and returns false if the user replies no' do
+      expects_scan('Is earth flat? [yn]', 'no')
+      expect(subject.yes_or_no('Is earth flat?')).to be false
+    end
+
+    it 'asks the user and returns true if the user replies nothing' do
+      expects_scan('Is earth round? [Yn]', '')
+      expect(subject.yes_or_no('Is earth round?', default: 'yes')).to be true
+    end
+
+    it 'ask the user only once when he reply always' do
+      expects_scan('Is earth round? [yna]', 'a')
+      expect(subject.yes_or_no('Is earth round?', persist: true)).to be true
+      expect(subject.yes_or_no('Is earth round?', persist: true)).to be true
+      expect(subject.yes_or_no('Is earth round?', persist: true)).to be true
+    end
+  end
+
+  describe '#yes?' do
+    it 'asks the user and returns true if the user replies yes' do
+      expects_scan('Is earth round? [Yn]', 'y')
+      expect(subject.yes?('Is earth round?')).to be true
+    end
+
+    it 'asks the user and returns false if the user replies no' do
+      expects_scan('Is earth flat? [Yn]', 'n')
+      expect(subject.yes?('Is earth flat?')).to be false
+    end
+
+    it 'ask the user and return true if the user replies nothing' do
+      expects_scan('Is the earth not flat? [Yn]', '')
+      expect(subject.yes?('Is the earth not flat?')).to be true
+    end
+  end
+
+  describe '#no?' do
+    it 'asks the user and returns true if the user replies yes' do
+      expects_scan('Is earth round? [yN]', 'y')
+      expect(subject.no?('Is earth round?')).to be true
+    end
+
+    it 'asks the user and returns false if the user replies no' do
+      expects_scan('Is earth flat? [yN]', 'n')
+      expect(subject.no?('Is earth flat?')).to be false
+    end
+
+    it 'ask the user and return false if the user replies nothing' do
+      expects_scan('Is the earth flat? [yN]', '')
+      expect(subject.no?('Is the earth flat?')).to be false
+    end
+  end
+
+  describe '#overwrite?' do
+    it 'ask the user and return true when he reply yes' do
+      expects_scan("Overwrite 'some.txt'? [Ynaqh]", 'y')
+      expect(subject.overwrite?('some.txt')).to be true
+    end
+
+    it 'ask the user and return false when he reply false' do
+      expects_scan("Overwrite 'some.txt'? [Ynaqh]", 'n')
+      expect(subject.overwrite?('some.txt')).to be false
+    end
+
+    it 'ask the user only once when he reply always' do
+      expects_scan("Overwrite 'some1.txt'? [Ynaqh]", 'a')
+      expect(subject.overwrite?('some1.txt')).to be true
+      expect(subject.overwrite?('some2.txt')).to be true
+      expect(subject.overwrite?('some3.txt')).to be true
+    end
+
+    it 'ask the user and quit when he reply quit' do
+      expects_scan("Overwrite 'some.txt'? [Ynaqh]", 'q')
+      expect { subject.overwrite?('some.txt') }.to raise_error(SystemExit)
+    end
+
+    it 'ask the user and show diff when he reply diff' do
+      expects_scan("Overwrite 'some.txt'? [Ynaqdh]", 'd', 'y')
+      expect_any_instance_of(Clin::ShellInteraction::FileConflict)
+        .to receive(:show_diff).with('some.txt', 'new_text')
+      result = subject.overwrite?('some.txt') do
+        'new_text'
+      end
+      expect(result).to be true
+    end
+  end
+
+  describe '#keep?' do
+    it 'ask the user and return true when he reply yes' do
+      expects_scan("Overwrite 'some.txt'? [yNaqh]", '')
+      expect(subject.keep?('some.txt')).to be false
+    end
+  end
+end

data/spec/examples/auto_option_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+require 'examples/auto_option'
+
+RSpec.describe 'auto_option.rb' do
+  suppress_puts
+  it { expect(AutoOptionCommand.parse('-e Lorem').params).to eq(echo: 'Lorem') }
+  it { expect(AutoOptionCommand.parse('--eko Lorem').params).to eq(echo: 'Lorem') }
+  it { expect(AutoOptionCommand.parse('--eko="Lorem ipsum"').params).to eq(echo: 'Lorem ipsum') }
+
+  it { expect { AutoOptionCommand.parse('--echo Value').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.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Timothee Guerin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-28 00:00:00.000000000 Z
+date: 2015-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -111,6 +111,7 @@ files:
 - README.md
 - Rakefile
 - clin.gemspec
+- examples/auto_option.rb
 - examples/dispatcher.rb
 - examples/list_option.rb
 - examples/nested_dispatcher.rb
@@ -121,23 +122,35 @@ files:
 - lib/clin/argument.rb
 - lib/clin/command.rb
 - lib/clin/command_dispatcher.rb
-- lib/clin/command_options_mixin.rb
+- lib/clin/command_mixin.rb
+- lib/clin/command_mixin/core.rb
+- lib/clin/command_mixin/dispatcher.rb
+- lib/clin/command_mixin/options.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/shell.rb
+- lib/clin/shell_interaction.rb
+- lib/clin/shell_interaction/choose.rb
+- lib/clin/shell_interaction/file_conflict.rb
+- lib/clin/shell_interaction/yes_or_no.rb
 - lib/clin/version.rb
 - spec/clin/argument_spec.rb
 - spec/clin/command_dispacher_spec.rb
-- spec/clin/command_options_mixin_spec.rb
+- spec/clin/command_mixin/core_spec.rb
+- spec/clin/command_mixin/options_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/clin/shell_interaction/choose_spec.rb
+- spec/clin/shell_spec.rb
 - spec/errors_spec.rb
+- spec/examples/auto_option_spec.rb
 - spec/examples/list_option_spec.rb
 - spec/examples/nested_dispatcher_spec.rb
 - spec/examples/simple_spec.rb
@@ -169,13 +182,17 @@ summary: Clin provide an advance way to define complex command line interface.
 test_files:
 - spec/clin/argument_spec.rb
 - spec/clin/command_dispacher_spec.rb
-- spec/clin/command_options_mixin_spec.rb
+- spec/clin/command_mixin/core_spec.rb
+- spec/clin/command_mixin/options_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/clin/shell_interaction/choose_spec.rb
+- spec/clin/shell_spec.rb
 - spec/errors_spec.rb
+- spec/examples/auto_option_spec.rb
 - spec/examples/list_option_spec.rb
 - spec/examples/nested_dispatcher_spec.rb
 - spec/examples/simple_spec.rb

data/lib/clin/command_options_mixin.rb

@@ -1,118 +0,0 @@
-require 'clin'
-require 'clin/option'
-require 'clin/option_list'
-
-# Template class for reusable options and commands
-# It provide the method to add options to a command
-class Clin::CommandOptionsMixin
-  class_attribute :options
-  class_attribute :general_options
-  self.options = []
-  self.general_options = {}
-
-  # Add an option
-  # @param args list of arguments.
-  #   * First argument must be the name if no block is given.
-  #     It will set automatically read the value into the hash with  +name+ as key
-  #   * The remaining arguments are OptionsParser#on arguments
-  # ```
-  #   option :require, '-r', '--require [LIBRARY]', 'Require the library'
-  #   option '-h', '--helper', 'Show the help' do
-  #     puts opts
-  #     exit
-  #   end
-  # ```
-  def self.opt_option(*args, &block)
-    add_option Clin::Option.new(*args, &block)
-  end
-
-  # Add an option.
-  # Helper method that just create a new Clin::Option with the argument then call add_option
-  # ```
-  #   option :show, 'Show some message'
-  #   # => -s --show              SHOW Show some message
-  #   option :require, 'Require a library', short: false, optional: true, argument: 'LIBRARY'
-  #   # => --require [LIBRARY]    Require a library
-  #   option :help, 'Show the help', argument: false do
-  #     puts opts
-  #     exit
-  #   end
-  #   # => -h --help              Show the help
-  # ```
-  def self.option(name, description, **config, &block)
-    add_option Clin::Option.new(name, description, **config, &block)
-  end
-
-  # For an option that does not have an argument
-  # Same as .option except it will default argument to false
-  # ```
-  #   option :verbose, 'Use verbose' #=> -v --verbose will be added to the option of this command
-  # ```
-  def self.flag_option(name, description, **config, &block)
-    add_option Clin::Option.new(name, description, **config.merge(argument: false), &block)
-  end
-
-  # Add a list option.
-  # @see Clin::OptionList#initialize
-  def self.list_option(name, description, **config)
-    add_option Clin::OptionList.new(name, description, **config)
-  end
-
-  # Add a list options that don't take arguments
-  # Same as .list_option but set +argument+ to false
-  # @see Clin::OptionList#initialize
-  def self.list_flag_option(name, description, **config)
-    add_option Clin::OptionList.new(name, description, **config.merge(argument: false))
-  end
-
-  # Add a new option.
-  # @param option [Clin::Option] option to add.
-  def self.add_option(option)
-    # Need to use += instead of << otherwise the parent class will also be changed
-    self.options += [option]
-  end
-
-  # Add a general option
-  # @param option_cls [Class<GeneralOption>] Class inherited from GeneralOption
-  # @param config [Hash] General option config. Check the general option config.
-  def self.general_option(option_cls, config = {})
-    option_cls = option_cls.constantize if option_cls.is_a? String
-    self.general_options = general_options.merge(option_cls => option_cls.new(config))
-  end
-
-  # Remove a general option
-  # Might be useful if a parent added the option but is not needed in this child.
-  def self.remove_general_option(option_cls)
-    option_cls = option_cls.constantize if option_cls.is_a? String
-    self.general_options = general_options.except(option_cls)
-  end
-
-  # To be called inside OptionParser block
-  # Extract the option in the command line using the OptionParser and map it to the out map.
-  # @param opts [OptionParser]
-  # @param out [Hash] Where the options shall be extracted
-  def self.register_options(opts, out)
-    options.each do |option|
-      option.register(opts, out)
-    end
-
-    general_options.each do |_cls, option|
-      option.class.register_options(opts, out)
-    end
-  end
-
-  # Call #execute on each of the general options.
-  # This is called during the command initialization
-  # e.g. A verbose general option execute would be:
-  # ```
-  # def execute(params)
-  #  MyApp.verbose = true if params[:verbose]
-  # end
-  # ```
-  def self.execute_general_options(options)
-    general_options.each do |_cls, gopts|
-      gopts.execute(options)
-    end
-  end
-
-end