yawpa/spec/yawpa_spec.rb

describe Yawpa do
  describe ".parse" do
    it "returns everything as arguments when no options present" do
      options = { }
      params = ['one', 'two', 'three', 'four']
      opts, args = Yawpa.parse(params, options)
      expect(opts).to eq({})
      expect(args).to eq(params)
    end

    it "raises an exception when an invalid option is passed" do
      options = { }
      params = ['one', '--option', 'two']
      expect { Yawpa.parse(params, options) }.to raise_error(Yawpa::ArgumentParsingException, /Unknown option/)
    end

    it "returns boolean options which are set" do
      options = {
        one: {},
        two: nil,
        three: {},
      }
      params = ['--one', 'arg', '--two', 'arg2']
      opts, args = Yawpa.parse(params, options)
      expect(opts.include?(:one)).to be_truthy
      expect(opts.include?(:two)).to be_truthy
      expect(opts.include?(:three)).to be_falsey
      expect(args).to eq(['arg', 'arg2'])
    end

    it "returns an option's value when nargs = 1" do
      options = {
        opt: {nargs: 1},
      }
      params = ['--opt', 'val', 'arg']
      opts, args = Yawpa.parse(params, options)
      expect(opts[:opt]).to eq('val')
      expect(args).to eq(['arg'])
    end

    it "returns an option's values when nargs = 2" do
      options = {
        opt: {nargs: 2},
      }
      params = ['--opt', 'val1', 'val2']
      opts, args = Yawpa.parse(params, options)
      expect(opts[:opt]).to eq(['val1', 'val2'])
      expect(args).to be_empty
    end

    it "raises an exception when not enough arguments for an option are given" do
      options = {
        opt: {nargs: 2},
      }
      params = ['--opt', 'val']
      expect { Yawpa.parse(params, options) }.to raise_error(Yawpa::ArgumentParsingException, /Not enough arguments supplied/)
    end

    it "uses --opt=val syntax for an option's value" do
      options = {
        opt: {nargs: 1},
      }
      params = ['--opt=thevalue', 'arg']
      opts, args = Yawpa.parse(params, options)
      expect(opts[:opt]).to eq('thevalue')
      expect(args).to eq(['arg'])
    end

    it "uses --opt=val for the first option argument when nargs > 1" do
      options = {
        opt: {nargs: 2},
      }
      params = ['--opt=val1', 'val2', 'arg']
      opts, args = Yawpa.parse(params, options)
      expect(opts[:opt]).to eq(['val1', 'val2'])
      expect(args).to eq(['arg'])
    end

    it "returns the last set value when an option is passed twice" do
      options = {
        opt: {nargs: 1},
      }
      params = ['--opt', 'val1', 'arg1', '--opt', 'val2', 'arg2']
      opts, args = Yawpa.parse(params, options)
      expect(opts[:opt]).to eq('val2')
      expect(args).to eq(['arg1', 'arg2'])
    end

    it "accepts strings as keys for option configuration" do
      options = {
        'crazy-option' => {nargs: 1},
      }
      params = ['xxx', '--crazy-option', 'yyy', 'zzz']
      opts, args = Yawpa.parse(params, options)
      expect(opts['crazy-option']).to eq('yyy')
      expect(args).to eq(['xxx', 'zzz'])
    end

    it "accepts short options corresponding to a long option" do
      options = {
        option: {short: 'o'},
      }
      params = ['-o', 'qqq']
      opts, args = Yawpa.parse(params, options)
      expect(opts[:option]).to be_truthy
      expect(args).to eq(['qqq'])
    end

    it "returns option argument at next position for a short option" do
      options = {
        option: {nargs: 1, short: 'o'},
      }
      params = ['-o', 'val', 'rrr']
      opts, args = Yawpa.parse(params, options)
      expect(opts[:option]).to eq('val')
      expect(args).to eq(['rrr'])
    end

    it "returns option argument immediately following short option" do
      options = {
        option: {nargs: 1, short: 'o'},
      }
      params = ['-oval', 'rrr']
      opts, args = Yawpa.parse(params, options)
      expect(opts[:option]).to eq('val')
      expect(args).to eq(['rrr'])
    end

    it "handles globbed-together short options" do
      options = {
        a: {short: 'a'},
        b: {short: 'b'},
        c: {short: 'c'},
        d: {short: 'd'},
      }
      params = ['-abc', 'xyz']
      opts, args = Yawpa.parse(params, options)
      expect(opts[:a]).to be_truthy
      expect(opts[:b]).to be_truthy
      expect(opts[:c]).to be_truthy
      expect(opts[:d]).to be_nil
      expect(args).to eq(['xyz'])
    end

    it "handles globbed-together short options with values following" do
      options = {
        a: {short: 'a'},
        b: {short: 'b'},
        c: {nargs: 1, short: 'c'},
        d: {short: 'd'},
      }
      params = ['-abcfoo', 'bar']
      opts, args = Yawpa.parse(params, options)
      expect(opts[:a]).to be_truthy
      expect(opts[:b]).to be_truthy
      expect(opts[:c]).to eq('foo')
      expect(opts[:d]).to be_nil
      expect(args).to eq(['bar'])
    end

    it "handles globbed-together short options with multiple values following" do
      options = {
        a: {short: 'a'},
        b: {short: 'b'},
        c: {nargs: 3, short: 'c'},
        d: {short: 'd'},
      }
      params = ['-abcfoo', 'bar', 'baz']
      opts, args = Yawpa.parse(params, options)
      expect(opts[:a]).to be_truthy
      expect(opts[:b]).to be_truthy
      expect(opts[:c]).to eq(['foo', 'bar', 'baz'])
      expect(opts[:d]).to be_nil
      expect(args).to be_empty
    end

    it "raises an error on an unknown short option" do
      options = {
        a: {short: 'a'},
      }
      params = ['-ab']
      expect { Yawpa.parse(params, options) }.to raise_error(Yawpa::ArgumentParsingException, /Unknown option/)
    end

    it "raises an error when not enough arguments are given to short option" do
      options = {
        a: {nargs: 1, short: 'a'},
      }
      params = ['-a']
      expect { Yawpa.parse(params, options) }.to raise_error(Yawpa::ArgumentParsingException, /Not enough arguments supplied/)
    end

    it "overwrites option value when short option used after long" do
      options = {
        option: {nargs: 1, short: 'o'},
      }
      params = ['--option', 'VALUE', '-o', 'NEW_VALUE']
      opts, args = Yawpa.parse(params, options)
      expect(opts[:option]).to eq('NEW_VALUE')
      expect(args).to be_empty
    end

    it "ignores options after arguments in posix_order mode" do
      options = {
        one: {},
        two: nil,
      }
      params = ['--one', 'arg', '--two']
      opts, args = Yawpa.parse(params, options, posix_order: true)
      expect(opts[:one]).to be_truthy
      expect(opts[:two]).to be_falsey
      expect(args).to eq(['arg', '--two'])
    end

    it "supports :boolean option flag" do
      options = {
        push: :boolean,
        pull: {boolean: true},
      }

      opts, args = Yawpa.parse(%w[hi], options)
      expect(opts).to eq({})
      expect(args).to eq(%w[hi])

      opts, args = Yawpa.parse(%w[--push one two], options)
      expect(opts).to eq(push: true)
      expect(args).to eq(%w[one two])

      opts, args = Yawpa.parse(%w[arg --nopush --pull], options)
      expect(opts).to eq(push: false, pull: true)
      expect(args).to eq(%w[arg])
    end
  end
end