easy_opt_parser 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce72f2ad37b1490e7f3225cb470a37af46c6bd57
-  data.tar.gz: e2077864a2df0cf8931eb084752676a5011fde6d
+  metadata.gz: 7eaa2265f68ad6db4a2272ec696fe187b05979ce
+  data.tar.gz: e9f3acf58a8765324cfee75d36e80877dcf5dc78
 SHA512:
-  metadata.gz: d005fb16b91e6948a015ec47a37dc4b571b7afee87a00edb380d4c92570c26a82279432174d8a49ed929686f0a777c54a2bb007cdd5a5d4fba053d1007c7a8cd
-  data.tar.gz: 1b19697c3d209d37d784086ceafc751767e6aa8173c0df71a4417b671f9ee492a73fe92c929fc222b8ae893f02f19ad8af8109e0e27ce5f3ea7666b95a49e6a2
+  metadata.gz: f7263bb8733a3d654574a354e8a0acc8b32c817c6a05cd13b741dc5774f55734fbdf52f1102bc190c5ff768406c421132e9ed5fafa0d6c2460fc3a0090a53744
+  data.tar.gz: 3cba661d9ff484a32f9e9dde9453e351512aedf1dc8a9f6695f3d747084dbf5b0210f0b4510ee94575503d6f11b20bdad9a81bcd2fe5feb9b81646445fc5aa1c

data/README.md

@@ -1,8 +1,8 @@
-# EasyOptParser
+# EasyOptParser (EOP)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/easy_opt_parser`. To experiment with that code, run `bin/console` for an interactive prompt.
+Easy Opt Parser is a small simplification of the class `OptParser`.
 
-TODO: Delete this and the text above, and describe your gem
+The objective of this gem is to make easier the way to create command line options for your command. This gem is using the basic of OptParser and can be expanded over time.
 
 ## Installation
 
@@ -14,7 +14,7 @@ gem 'easy_opt_parser'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -22,17 +22,154 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Let's see how it works!
+
+Create a `dir` where you want and inside create two files:
+
+`Gemfile` and `test.rb` 
+
+Inside `Gemfile`
+
+```ruby
+gem 'easy_opt_parser'
+```
+
+Then run
+
+```bash
+bundle install
+```
+
+Inside `test.rb` write this code
+
+```ruby
+require 'easy_opt_parser'
+require 'easy_opt_parser/domain/optional_argument'
+require 'easy_opt_parser/domain/required_argument'
+require 'easy_opt_parser/domain/flag_argument'
+
+def arguments
+  [
+      EOP::RequiredArgument.new(name: 'required',
+                                short_option: '-r',
+                                long_option: '--required',
+                                description: 'This is a required argument'),
+
+      EOP::OptionalArgument.new(name: 'optional',
+                                short_option: '-o',
+                                long_option: '--optional',
+                                description: 'This is an optional argument'),
+
+      EOP::FlagArgument.new(name: 'flag',
+                            short_option: '-f',
+                            long_option: '--flag',
+                            description: 'This is a flag argument'),
+  ]
+end
+
+
+parser = EasyOptionParser.new('Test Arguments', arguments)
+
+puts parser.options
+```
+
+This code shows that the only thing we need to do is to create an `Array` of `RequiredArgumen`, `OptionalArgumen` or `FlagArgument`.
+
+`RequiredArgument`: In the help description will be added a `*` symbol to determinate that is required. Also the gem will check all required arguments to be present and with values, if not an exception will be raised.
+
+`OptionalArgument`: Not necessary to be in command line, default value will be `nil`. If the argument is present but without value and error will be raised.
+
+`FlagArgument`: Not necessary to be in command line, default value will be `false`. If the flag appears the value will be `true`
+
+An extra argument is automatically added `-h` and `--help` to display the different arguments.
+
+## Examples
+
+Using the `Usage` example lets see the output the diffent outputs.
+
+`help` argument
+
+```bash
+bundle exec ruby test.rb -h
+```
+
+Output
+
+```bash
+Test Arguments
+    -r, --required required          This is a required argument *
+    -o, --optional optional          This is an optional argument
+    -f, --flag                       This is a flag argument
+    -h, --help                       Displays Help
+```
+
+`required` argument
+
+```bash
+bundle exec ruby test.rb
+```
+
+Output
+
+```bash
+ Missing Argument [required] (RuntimeError)
+```
+
+`required` is obviously a required argument, so the system will raise an error in this case 
+
+```bash
+bundle exec ruby test.rb -r myValue
+```
+
+Output
+
+```bash
+ {:required=>"myValue", :optional=>nil, :flag=>false}
+```
+
+`optional` argument
+
+```bash
+bundle exec ruby test.rb -r myValue -o myOptionalValue
+```
+
+Output
+
+```bash
+ {:required=>"myValue", :optional=>"myOptionalValue", :flag=>false}
+```
+
+`flag` argument
+
+```bash
+bundle exec ruby test.rb -r myValue -f
+```
+
+Output
+
+```bash
+ {:required=>"myValue", :optional=>nil, :flag=>true}
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repository run
+
+```bash
+bundle install
+```
+
+And then run the tests to check that everything is working as expected.
+
+```bash
+ruby tests/test_easy_options_parser.rb 
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Remember if you are contributing, create and run the tests before pull request.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/easy_opt_parser. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on Gitlab at [https://gitlab.com/gonzalez.martin90/easy-option-parser](https://gitlab.com/gonzalez.martin90/easy-option-parser). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/bin/test_arguments

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require 'easy_opt_parser'
+require 'easy_opt_parser/domain/optional_argument'
+require 'easy_opt_parser/domain/required_argument'
+require 'easy_opt_parser/domain/flag_argument'
+
+def arguments
+  [
+      EOP::RequiredArgument.new(name: 'required',
+                                short_option: '-r',
+                                long_option: '--required',
+                                description: 'This is a required argument'),
+
+      EOP::OptionalArgument.new(name: 'optional',
+                                short_option: '-o',
+                                long_option: '--optional',
+                                description: 'This is an optional argument'),
+
+      EOP::FlagArgument.new(name: 'flag',
+                            short_option: '-f',
+                            long_option: '--flag',
+                            description: 'This is a flag argument'),
+  ]
+end
+
+
+parser = EasyOptionParser.new('Test Arguments', arguments)
+
+puts parser.options

data/easy_opt_parser.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Martin Gonzalez"]
   spec.email         = ["gonzalez.martin90@gmail.com"]
 
-  spec.summary       = %q{An easy way to create cli options}
-  spec.description   = %q{An easy way to create cli options}
+  spec.summary       = %q{Easy Opt Parser is a small simplification of the class OptParser. }
+  spec.description   = %q{The objective of this gem is to make easier the way to create command line options for your command. This gem is using the basic of OptParser and can be expanded over time.}
   spec.homepage      = "https://gitlab.com/gonzalez.martin90/easy-option-parser"
   spec.license       = "MIT"
 
@@ -26,8 +26,8 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir        = "bin"
+  spec.executables   << 'test_arguments'
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.16"

data/lib/easy_opt_parser.rb

@@ -1,4 +1,5 @@
 require 'optparse'
+require 'easy_opt_parser/domain/flag_argument'
 
 class EasyOptionParser
   attr_reader :options, :title
@@ -7,26 +8,36 @@ class EasyOptionParser
     @options = {}
     @title = title
     assert_valid_arguments!(arguments, symbol: :name)
-    assert_valid_arguments!(arguments, symbol: :short)
-    assert_valid_arguments!(arguments, symbol: :long)
+    assert_valid_arguments!(arguments, symbol: :short_option)
+    assert_valid_arguments!(arguments, symbol: :long_option)
     populate_with_default_values(arguments)
 
     parser = OptionParser.new do |opts|
       opts.banner = @title
-      arguments.each do |argument|
-        long = "#{argument.long} #{argument.name}"
-        description = (argument.required) ? "#{argument.description} *" : argument.description
-        opts.on(argument.short, long, description) do |value|
-          options[argument.name.to_sym] = value
-        end
-      end
-
-      opts.on('-h', '--help', 'Displays Help') do
-        puts opts
-        exit
-      end
+      create_value_arguments(opts, arguments.reject {|arg| arg.is_a?(EOP::FlagArgument)})
+      create_flag_arguments(opts, arguments.select { |arg| arg.is_a?(EOP::FlagArgument) })
+      create_help_argument(opts)
     end
     parser.parse!
+
+    assert_required_arguments!(arguments)
+  end
+
+  def create_flag_arguments(opts, arguments)
+    arguments.each do |arg|
+      argument_with(opts, arg.name, arg.short_option, arg.long_option, arg.description)
+    end
+  end
+
+  def create_value_arguments(opts, arguments)
+    arguments.each do |arg|
+      long_option = create_long_option_from(arg)
+      argument_with(opts, arg.name, arg.short_option, long_option, arg.description)
+    end
+  end
+
+  def create_long_option_from(argument)
+    "#{argument.long_option} #{argument.name}"
   end
 
   def contains?(name)
@@ -36,9 +47,9 @@ class EasyOptionParser
   private
 
   def assert_valid_arguments!(arguments, symbol:)
+    raise 'Arguments must be an Array' unless arguments.is_a?(Array)
     raise 'Arguments cannot be nil' if arguments.nil?
     raise 'Arguments cannot be empty' if arguments.empty?
-    raise 'Arguments must be an Array' unless arguments.is_a?(Array)
     argument_names = arguments.map(&symbol)
     raise 'Duplicated value in options' if argument_names.detect{|a| argument_names.count(a) > 1}
   end
@@ -48,4 +59,24 @@ class EasyOptionParser
       @options[argument.name.to_sym] = argument.default_value
     end
   end
+
+  def argument_with(opts, name, short, long, description)
+    opts.on(short, long, description) do |value|
+      @options[name.to_sym] = value
+    end
+  end
+
+  def create_help_argument(opts)
+    opts.on('-h', '--help', 'Displays Help') do
+      puts opts
+      exit
+    end
+  end
+
+  def assert_required_arguments!(arguments)
+    required_arguments = arguments.select(&:required)
+    required_arguments.each do |arg|
+      raise "Missing Argument [#{arg.name}]" if @options[arg.name.to_sym].to_s.empty?
+    end
+  end
 end

data/lib/easy_opt_parser/domain/command_option.rb

@@ -0,0 +1,5 @@
+module EOP
+  class CommandOption
+    attr_accessor :name, :short_option, :long_option, :description, :default_value, :required
+  end
+end

data/lib/easy_opt_parser/domain/flag_argument.rb

@@ -0,0 +1,14 @@
+require 'easy_opt_parser/domain/command_option'
+
+module EOP
+  class FlagArgument < CommandOption
+    def initialize(name:, short_option:, long_option:, description:)
+      @name = name
+      @short_option = short_option
+      @long_option = long_option
+      @description = description
+      @default_value = false
+      @required = false
+    end
+  end
+end

data/lib/easy_opt_parser/domain/optional_argument.rb

@@ -0,0 +1,14 @@
+require 'easy_opt_parser/domain/command_option'
+
+module EOP
+  class OptionalArgument < CommandOption
+    def initialize(name:, short_option:, long_option:, description:, default_value: nil)
+      @name = name
+      @short_option = short_option
+      @long_option = long_option
+      @description = description
+      @default_value = default_value
+      @required = false
+    end
+  end
+end

data/lib/easy_opt_parser/domain/required_argument.rb

@@ -0,0 +1,14 @@
+require 'easy_opt_parser/domain/command_option'
+
+module EOP
+  class RequiredArgument < CommandOption
+    def initialize(name:, short_option:, long_option:, description:, default_value: '')
+      @name = name
+      @short_option = short_option
+      @long_option = long_option
+      @description = "#{description} *"
+      @default_value = default_value
+      @required = true
+    end
+  end
+end

data/lib/easy_opt_parser/version.rb

@@ -1,3 +1,3 @@
 module EasyOptParser
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/tests/test_easy_options_parser.rb

@@ -3,8 +3,10 @@ require_relative './test_helper'
 
 class TestEasyOptionParser < MiniTest::Test
   def test_contains_a_title
+    # simulate the entry of arguments
+    ARGV.concat(%w(-p ./path))
     title = 'My title'
-    options = given_options
+    options = given_arguments
     parser = EasyOptionParser.new(title, options)
 
     assert_equal(parser.title, title)
@@ -28,39 +30,71 @@ class TestEasyOptionParser < MiniTest::Test
     end
   end
 
-  def test_contains_an_option
-    options = given_options
+  def test_raise_error_when_require_arg_is_missing
+    options = given_arguments
+    assert_raises do
+      EasyOptionParser.new('title', options)
+    end
+  end
+
+  def test_optional_argument_can_be_nil
+    optional_arguments = given_an_optional_argument
+    parser = EasyOptionParser.new('Title', optional_arguments)
+    assert parser.options.include?(:optional)
+    assert parser.options[:optional].nil?
+  end
+
+  def test_contains_an_argument
+    # simulate the entry of arguments
+    ARGV.concat(%w(-p ./path))
+    options = given_arguments
     parser = EasyOptionParser.new('title', options)
 
     assert parser.contains?('path')
   end
 
-  def test_raise_error_when_options_has_duplicated_name
-    options = given_duplicated_options_by_name
+  def test_accept_flag_argument
+    # simulate the entry of arguments
+    ARGV << '-f'
+    options = given_a_flag_argument
+    parser = EasyOptionParser.new('title', options)
+
+    assert parser.options[:flag]
+  end
+
+  def test_accept_missing_flag_argument
+    options = given_a_flag_argument
+    parser = EasyOptionParser.new('title', options)
+
+    assert !parser.options[:flag]
+  end
+
+  def test_raise_error_when_arguments_has_duplicated_name
+    options = given_duplicated_arguments_by_name
 
     assert_raises do
       EasyOptionParser.new('title', options)
     end
   end
 
-  def test_raise_error_when_options_has_duplicated_short
-    options = given_duplicated_options_by_short
+  def test_raise_error_when_arguments_has_duplicated_short
+    options = given_duplicated_arguments_by_short
 
     assert_raises do
       EasyOptionParser.new('title', options)
     end
   end
 
-  def test_raise_error_when_options_has_duplicated_long
-    options = given_duplicated_options_by_long
+  def test_raise_error_when_arguments_has_duplicated_long
+    options = given_duplicated_arguments_by_long
 
     assert_raises do
       EasyOptionParser.new('title', options)
     end
   end
 
-  def test_required_option_contains_required_mark
+  def test_required_argument_contains_required_mark
     required_option = given_a_required_option
-    assert_includes(required_option.description, '*')
+    assert required_option.description.include?('*')
   end
 end

data/tests/test_helper.rb

@@ -1,55 +1,74 @@
-require 'easy_opt_parser/domain/no_required_option'
-require 'easy_opt_parser/domain/required_option'
+require 'easy_opt_parser/domain/optional_argument'
+require 'easy_opt_parser/domain/required_argument'
+require 'easy_opt_parser/domain/flag_argument'
 require 'easy_opt_parser'
 
 def given_a_required_option
-  EOP::RequiredOption.new(name: 'path', short: '-p', long: '--path', description: 'Some description here')
+  EOP::RequiredArgument.new(name: 'path', short_option: '-p', long_option: '--path', description: 'Some description here')
 end
 
-def given_options
+def given_arguments
   [
-     EOP::RequiredOption.new(name: 'path',
-                         short: '-p',
-                         long: '--path',
-                         description: 'Some description here')
+     EOP::RequiredArgument.new(name: 'path',
+                               short_option: '-p',
+                               long_option: '--path',
+                               description: 'Some description here')
   ]
 end
 
-def given_duplicated_options_by_name
+def given_a_flag_argument
   [
-      EOP::RequiredOption.new(name: 'path',
-                         short: '-p',
-                         long: '--path',
-                         description: 'Some description here'),
-      EOP::RequiredOption.new(name: 'path',
-                         short: '-o',
-                         long: '--other',
-                         description: 'Some other description here')
+      EOP::FlagArgument.new(name: 'flag',
+                            short_option: '-f',
+                            long_option: '--flag',
+                            description: 'This is a flag argument')
   ]
 end
 
-def given_duplicated_options_by_short
+def given_an_optional_argument
   [
-      EOP::RequiredOption.new(name: 'path',
-                         short: '-p',
-                         long: '--path',
-                         description: 'Some description here'),
-      EOP::RequiredOption.new(name: 'other_path',
-                         short: '-p',
-                         long: '--other',
-                         description: 'Some other description here')
+      EOP::OptionalArgument.new(name: 'optional',
+                                short_option: '-o',
+                                long_option: '--opt',
+                                description: 'Optional Value')
   ]
 end
 
-def given_duplicated_options_by_long
+def given_duplicated_arguments_by_name
   [
-      EOP::RequiredOption.new(name: 'path',
-                         short: '-p',
-                         long: '--path',
-                         description: 'Some description here'),
-      EOP::RequiredOption.new(name: 'other_path',
-                         short: '-o',
-                         long: '--path',
-                         description: 'Some other description here')
+      EOP::RequiredArgument.new(name: 'path',
+                                short_option: '-p',
+                                long_option: '--path',
+                                description: 'Some description here'),
+      EOP::RequiredArgument.new(name: 'path',
+                                short_option: '-o',
+                                long_option: '--other',
+                                description: 'Some other description here')
+  ]
+end
+
+def given_duplicated_arguments_by_short
+  [
+      EOP::RequiredArgument.new(name: 'path',
+                                short_option: '-p',
+                                long_option: '--path',
+                                description: 'Some description here'),
+      EOP::RequiredArgument.new(name: 'other_path',
+                                short_option: '-p',
+                                long_option: '--other',
+                                description: 'Some other description here')
+  ]
+end
+
+def given_duplicated_arguments_by_long
+  [
+      EOP::RequiredArgument.new(name: 'path',
+                                short_option: '-p',
+                                long_option: '--path',
+                                description: 'Some description here'),
+      EOP::RequiredArgument.new(name: 'other_path',
+                                short_option: '-o',
+                                long_option: '--path',
+                                description: 'Some other description here')
   ]
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_opt_parser
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Martin Gonzalez
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2018-03-17 00:00:00.000000000 Z
+date: 2018-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,10 +66,13 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: An easy way to create cli options
+description: The objective of this gem is to make easier the way to create command
+  line options for your command. This gem is using the basic of OptParser and can
+  be expanded over time.
 email:
 - gonzalez.martin90@gmail.com
-executables: []
+executables:
+- test_arguments
 extensions: []
 extra_rdoc_files: []
 files:
@@ -80,11 +83,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/test_arguments
 - easy_opt_parser.gemspec
 - lib/easy_opt_parser.rb
-- lib/easy_opt_parser/domain/cli_option.rb
-- lib/easy_opt_parser/domain/no_required_option.rb
-- lib/easy_opt_parser/domain/required_option.rb
+- lib/easy_opt_parser/domain/command_option.rb
+- lib/easy_opt_parser/domain/flag_argument.rb
+- lib/easy_opt_parser/domain/optional_argument.rb
+- lib/easy_opt_parser/domain/required_argument.rb
 - lib/easy_opt_parser/version.rb
 - tests/test_easy_options_parser.rb
 - tests/test_helper.rb
@@ -111,5 +116,5 @@ rubyforge_project:
 rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
-summary: An easy way to create cli options
+summary: Easy Opt Parser is a small simplification of the class OptParser.
 test_files: []

data/lib/easy_opt_parser/domain/cli_option.rb

@@ -1,5 +0,0 @@
-module EOP
-  class CLIOption
-    attr_accessor :name, :short, :long, :description, :default_value, :required
-  end
-end

data/lib/easy_opt_parser/domain/no_required_option.rb

@@ -1,14 +0,0 @@
-require 'easy_opt_parser/domain/cli_option'
-
-module EOP
-  class NoRequiredOption < CLIOption
-    def initialize(name:, short:, long:, description:, default_value: '')
-      @name = name
-      @short = short
-      @long = long
-      @description = description
-      @default_value = default_value
-      @required = false
-    end
-  end
-end

data/lib/easy_opt_parser/domain/required_option.rb

@@ -1,14 +0,0 @@
-require 'easy_opt_parser/domain/cli_option'
-
-module EOP
-  class RequiredOption < CLIOption
-    def initialize(name:, short:, long:, description:, default_value: '')
-      @name = name
-      @short = short
-      @long = long
-      @description = "#{description} *"
-      @default_value = default_value
-      @required = true
-    end
-  end
-end