easy_opt_parser 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ce72f2ad37b1490e7f3225cb470a37af46c6bd57
+  data.tar.gz: e2077864a2df0cf8931eb084752676a5011fde6d
+SHA512:
+  metadata.gz: d005fb16b91e6948a015ec47a37dc4b571b7afee87a00edb380d4c92570c26a82279432174d8a49ed929686f0a777c54a2bb007cdd5a5d4fba053d1007c7a8cd
+  data.tar.gz: 1b19697c3d209d37d784086ceafc751767e6aa8173c0df71a4417b671f9ee492a73fe92c929fc222b8ae893f02f19ad8af8109e0e27ce5f3ea7666b95a49e6a2

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at martin.gonzalez@etermax.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in easy_opt_parser.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Martin Gonzalez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# EasyOptParser
+
+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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'easy_opt_parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install easy_opt_parser
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+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).
+
+## 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the EasyOptParser project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/easy_opt_parser/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/easy_opt_parser.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "easy_opt_parser/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "easy_opt_parser"
+  spec.version       = EasyOptParser::VERSION
+  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.homepage      = "https://gitlab.com/gonzalez.martin90/easy-option-parser"
+  spec.license       = "MIT"
+
+  # # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  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.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'minitest'
+end

data/lib/easy_opt_parser/domain/cli_option.rb

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

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

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

data/lib/easy_opt_parser/version.rb

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

data/lib/easy_opt_parser.rb

@@ -0,0 +1,51 @@
+require 'optparse'
+
+class EasyOptionParser
+  attr_reader :options, :title
+
+  def initialize(title, arguments)
+    @options = {}
+    @title = title
+    assert_valid_arguments!(arguments, symbol: :name)
+    assert_valid_arguments!(arguments, symbol: :short)
+    assert_valid_arguments!(arguments, symbol: :long)
+    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
+    end
+    parser.parse!
+  end
+
+  def contains?(name)
+    @options.include?(name.to_sym)
+  end
+
+  private
+
+  def assert_valid_arguments!(arguments, symbol:)
+    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
+
+  def populate_with_default_values(arguments)
+    arguments.each do |argument|
+      @options[argument.name.to_sym] = argument.default_value
+    end
+  end
+end

data/tests/test_easy_options_parser.rb

@@ -0,0 +1,66 @@
+require 'minitest/autorun'
+require_relative './test_helper'
+
+class TestEasyOptionParser < MiniTest::Test
+  def test_contains_a_title
+    title = 'My title'
+    options = given_options
+    parser = EasyOptionParser.new(title, options)
+
+    assert_equal(parser.title, title)
+  end
+
+  def test_options_cannot_be_nil
+    assert_raises do
+      EasyOptionParser.new('title', nil)
+    end
+  end
+
+  def test_options_cannot_be_empty
+    assert_raises do
+      EasyOptionParser.new('title', [])
+    end
+  end
+
+  def test_options_cannot_be_a_hash
+    assert_raises do
+      EasyOptionParser.new('title', {name: 'path'})
+    end
+  end
+
+  def test_contains_an_option
+    options = given_options
+    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
+
+    assert_raises do
+      EasyOptionParser.new('title', options)
+    end
+  end
+
+  def test_raise_error_when_options_has_duplicated_short
+    options = given_duplicated_options_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
+
+    assert_raises do
+      EasyOptionParser.new('title', options)
+    end
+  end
+
+  def test_required_option_contains_required_mark
+    required_option = given_a_required_option
+    assert_includes(required_option.description, '*')
+  end
+end

data/tests/test_helper.rb

@@ -0,0 +1,55 @@
+require 'easy_opt_parser/domain/no_required_option'
+require 'easy_opt_parser/domain/required_option'
+require 'easy_opt_parser'
+
+def given_a_required_option
+  EOP::RequiredOption.new(name: 'path', short: '-p', long: '--path', description: 'Some description here')
+end
+
+def given_options
+  [
+     EOP::RequiredOption.new(name: 'path',
+                         short: '-p',
+                         long: '--path',
+                         description: 'Some description here')
+  ]
+end
+
+def given_duplicated_options_by_name
+  [
+      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')
+  ]
+end
+
+def given_duplicated_options_by_short
+  [
+      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')
+  ]
+end
+
+def given_duplicated_options_by_long
+  [
+      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')
+  ]
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: easy_opt_parser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Martin Gonzalez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An easy way to create cli options
+email:
+- gonzalez.martin90@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- 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/version.rb
+- tests/test_easy_options_parser.rb
+- tests/test_helper.rb
+homepage: https://gitlab.com/gonzalez.martin90/easy-option-parser
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: An easy way to create cli options
+test_files: []