brigadier 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 431da2466bfb9ba4a5fe0a707750c53ac4ea72b1
+  data.tar.gz: a17acb0890b983e00f53d844c5fb772ac04b6913
+SHA512:
+  metadata.gz: b3db515f7c16e7a5aed234fe5a3347ec843df2415bdd3cb0c1457860de2930624d6d478fd7dc24297607943bab1643b17c7e746012474095b07d6dfd9b460e01
+  data.tar.gz: 1409c9d0a8dee921bff68854025fba1e27f210fa46ff5a00c336b968ad81a038290d7155af5eb49b1338a9db4853020c4f80eaf515fefa58aa742794c28388b8

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,20 @@
+Style/SpaceInsideBrackets:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/IndentationConsistency:
+  Enabled: false
+
+Style/FormatString:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Style/GlobalVars:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at ash@the-rebellion.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'pry-byebug'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ash McKenzie
+
+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,83 @@
+# Brigadier
+
+Brigadier - Take control of your command line
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'brigadier'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install brigadier
+
+## Usage
+
+Add the following to `basic.rb`:
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'brigadier'
+
+class BasicCommand
+  extend Brigadier
+
+  toggle 'debug', 'Debugging toggle'
+  toggle 'verbose', 'Verbose mode', default: true
+
+  execute do
+    puts "Inside \#execute - debug?: #{debug?}, verbose?: #{verbose?}"
+  end
+end
+
+Brigadier::Runner.new(ARGV).run(BasicCommand)
+```
+
+Get some help:
+
+```shell
+$ ruby basic.rb --help
+
+Toggle(s)
+    --debug                      Debugging toggle (default: false)
+    --verbose                    Verbose mode (default: true)
+
+$ ruby basic.rb --debug  --help
+
+Toggle(s)
+    --debug                      Debugging toggle (default: false, current: true)
+    --verbose                    Verbose mode (default: true)
+```
+
+Run it:
+
+```shell
+$ ruby basic.rb
+Inside #execute - debug?: false, verbose?: true
+
+$ ruby basic.rb --debug --not-verbose
+Inside #execute - debug?: true, verbose?: false
+```
+
+Check out the [examples](./examples) directory for more examples.
+
+## Contributing
+
+1. Fork it ( https://github.com/ashmckenzie/brigadier/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Run `bundle exec rake test`
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: [ :rubocop, :spec ]

data/brigadier.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'brigadier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'brigadier'
+  spec.version       = Brigadier::VERSION
+  spec.authors       = ['Ash McKenzie']
+  spec.email         = ['ash@the-rebellion.net']
+
+  spec.summary       = 'Brigadier - Take control of your command line'
+  spec.description   = 'Brigadier is a DSL that provides the ability to create complex command line tools with support for - sub commands, arguments, options and toggles'
+  spec.homepage      = 'https://github.com/ashmckenzie'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split("\n").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.37'
+  spec.add_development_dependency 'simplecov', '~> 0.11'
+end

data/examples/advanced.rb

@@ -0,0 +1,109 @@
+require 'brigadier'
+
+# You can run like so:
+#
+# ruby advanced.rb --help
+# ruby advanced.rb
+# ruby advanced.rb --debug
+# ruby advanced.rb admin --help
+# ruby advanced.rb admin
+# ruby advanced.rb admin 'Poopy McPoopy'
+# ruby advanced.rb admin 'John Smith'
+# ruby advanced.rb admin --age 27 'John Smith'
+# ruby advanced.rb admin --age 200 'John Smith' 'john@smith.com'
+# ruby advanced.rb admin --important 'John Smith' 'john@smith.com'
+# ruby advanced.rb admin --not-sensitive 'John Smith' 'john@smith.com'
+
+module CustomValidations
+  class AntiPooper
+    include Brigadier::Validators::Base
+
+    def failure_message
+      "Please don't mention poop."
+    end
+
+    def valid?
+      !value.match(/poop/i)
+    end
+  end
+
+  class SensibleAge
+    include Brigadier::Validators::Base
+
+    VALID_AGE_START = 20
+    VALID_AGE_END = 100
+
+    def failure_message
+      '%s is not a sensible age (needs to be between %s and %s)' % [ value, VALID_AGE_START, VALID_AGE_END ]
+    end
+
+    def value
+      obj.value.to_i
+    end
+
+    def valid?
+      value >= VALID_AGE_START && value <= VALID_AGE_END
+    end
+  end
+end
+
+module Commands
+  class Default
+    extend Brigadier
+
+    toggle 'debug', 'Debugging toggle'
+    toggle 'verbose', 'Verbose mode', default: true
+    argument 'name', 'Name of person'
+
+    execute do
+      puts "Inside \#execute: name: #{name}, debug?: #{debug?}, verbose?: #{verbose?}"
+    end
+  end
+end
+
+module SubCommands
+  class GuestAndAdmin
+    extend Brigadier
+
+    DAYS_IN_A_YEAR = 365
+
+    toggle 'debug', 'Debugging'
+
+    sub_command 'guest', 'Guest sub command' do
+      argument 'name', 'Name of guest', validators: [ CustomValidations::AntiPooper ]
+
+      execute do
+        puts "Inside guest sub command's \#execute: name: #{name} debug?: #{debug?}"
+      end
+    end
+
+    sub_command 'admin', 'Admin sub command' do
+      toggle 'important', 'Important'
+      toggle 'sensitive', 'Sensitive', default: true
+
+      argument 'name', 'Name of admin', validators: [ CustomValidations::AntiPooper ]
+      argument 'email', 'Email of admin', validators: [ Brigadier::Validators::Email ]
+
+      option 'age', 'Age', default: 25, validators: [ CustomValidations::SensibleAge ] { |age| age.to_i }
+
+      def age_in_days
+        age * DAYS_IN_A_YEAR
+      end
+
+      execute do
+        puts <<-EOS
+Inside admin sub command's \#execute:
+  name: #{name}
+  email: #{email}
+  age: #{age}
+  age in days: #{age_in_days}
+  debug?: #{debug?}
+  important?: #{important?}
+  sensitive?: #{sensitive?}
+EOS
+      end
+    end
+  end
+end
+
+Brigadier::Runner.new(ARGV).run(Commands::Default, SubCommands::GuestAndAdmin)

data/examples/basic.rb

@@ -0,0 +1,19 @@
+require 'brigadier'
+
+# You can run like so:
+#
+# ruby basic.rb --help
+# ruby basic.rb
+
+class BasicCommand
+  extend Brigadier
+
+  toggle 'debug', 'Debugging toggle'
+  toggle 'verbose', 'Verbose mode', default: true
+
+  execute do
+    puts "Inside \#execute - debug?: #{debug?}, verbose?: #{verbose?}"
+  end
+end
+
+Brigadier::Runner.new(ARGV).run(BasicCommand)

data/examples/intermediate.rb

@@ -0,0 +1,28 @@
+require 'brigadier'
+
+# You can run like so:
+#
+# ruby intermediate.rb
+# ruby intermediate.rb --help
+# ruby intermediate.rb guest
+# ruby intermediate.rb guest --help
+# ruby intermediate.rb guest --debug 'John Smith'
+
+module Commands
+  class Intermediate
+    extend Brigadier
+
+    toggle 'debug', 'Debugging toggle'
+    toggle 'verbose', 'Verbose mode', default: true
+
+    sub_command 'guest', 'Guest sub command' do
+      argument 'name', 'Name of guest', required: true
+
+      execute do
+        puts "Inside guest sub command's \#execute: name: #{name}, debug?: #{debug?}, verbose?: #{verbose?}"
+      end
+    end
+  end
+end
+
+Brigadier::Runner.new(ARGV).run(Commands::Intermediate)

data/lib/brigadier/commands/base.rb

@@ -0,0 +1,117 @@
+module Brigadier
+  module Commands
+    module Base
+      include Helper
+
+      def process_args(args, obj)
+        args_to_keep = []
+        until args.empty?
+          arg = args.shift
+          if option_or_toggle?(arg)
+            next if set_options_for(arg, args, obj.options) || set_toggles_for(arg, obj.toggles)
+          elsif set_argument_for(arg, obj.arguments)
+            next
+          end
+        end
+        args = args_to_keep
+      end
+
+      def sub_command?
+        false
+      end
+
+      def hidden?
+        false
+      end
+
+      def assign_toggles_from(toggles)
+        toggles.each do |toggle|
+          name = toggle.normalised_attribute_name.to_sym
+          method_name = "#{name}?"
+          instance.instance_variable_set(:"@#{name}", toggle.value)
+          $stderr.puts "WARN: Overwrting existing method '#{name}'.." if instance.respond_to?(name)
+          instance.define_singleton_method(method_name) { toggle.value }
+        end
+      end
+
+      def assign_options_from(parameters)
+        create_variable_and_method_from(parameters)
+      end
+
+      def assign_arguments_from(parameters)
+        create_variable_and_method_from(parameters)
+      end
+
+      def create_variable_and_method_from(parameters)
+        parameters.each do |param|
+          name = param.normalised_attribute_name.to_sym
+          instance.instance_variable_set(:"@#{name}", param.value)
+          $stderr.puts "WARN: Overwrting existing method '#{name}'.." if instance.respond_to?(name)
+          instance.define_singleton_method(name) { param.value }
+        end
+      end
+
+      def ensure_parameters_defined!(*parameters)
+        captured_errors = validate_parameters!(parameters)
+        unless captured_errors.empty?
+          captured_errors.each { |e| $stderr.puts "ERROR: #{e}" }
+          exit(Exceptions::ERROR_EXIT_CODE)
+        end
+      end
+
+      private
+
+        def validate_parameters!(parameters)
+          captured_errors = []
+          parameters.flatten.each do |parameter|
+            begin
+              parameter.validate!
+            rescue Exceptions::Base => e
+              captured_errors << e.as_str
+            end
+          end
+          captured_errors
+        end
+
+        def set_toggles_for(arg, obj)
+          obj.each do |names, toggle|
+            next unless names.include?(arg)
+            action = inverse_toggle_arg?(arg) ? :disable! : :enable!
+            toggle.public_send(action)
+            return true
+          end
+          false
+        end
+
+        def set_options_for(arg, args, obj)
+          obj.each do |names, option|
+            next unless names.include?(arg)
+            option.value = args.shift
+            return true
+          end
+          false
+        end
+
+        def set_argument_for(value, obj)
+          obj.each do |_, argument|
+            next if argument.value
+            argument.value = value
+            return true
+          end
+          false
+        end
+
+        def available_toggles
+          klass.toggles.values.uniq(&:name)
+        end
+
+        def available_options
+          klass.options.values.uniq(&:name)
+        end
+
+        def available_arguments
+          klass.arguments.values.uniq(&:name)
+        end
+    end
+  end
+end

data/lib/brigadier/commands/command.rb

@@ -0,0 +1,40 @@
+module Brigadier
+  module Commands
+    class Command
+      include Base
+
+      attr_reader :instance
+
+      def initialize(instance, block)
+        @instance = instance
+        @block = block
+      end
+
+      def execute(args, full_args, klasses)
+        process_args(args, instance)
+
+        assign_toggles_from(available_toggles)
+        assign_options_from(available_options)
+        assign_arguments_from(available_arguments)
+
+        # FIXME
+        objs = (full_args.count == 1) ? klasses : klass
+        return if display_help_if_requested(objs, full_args)
+
+        ensure_parameters_defined!(available_options, available_arguments)
+
+        instance.instance_eval(&block)
+      end
+
+      private
+
+        attr_reader :block
+
+        # FIXME
+        def klass
+          @klass ||= instance
+        end
+
+    end
+  end
+end

data/lib/brigadier/commands/sub_command.rb

@@ -0,0 +1,63 @@
+module Brigadier
+  module Commands
+    class SubCommand
+      include Base
+
+      attr_reader :name, :description
+
+      def initialize(name, description, instance, args, block)
+        @name = name
+        @description = description
+        @instance = instance
+        @args = args
+        @block = block
+      end
+
+      def display_name
+        aliases.join(', ')
+      end
+
+      def display_description
+        description
+      end
+
+      def execute(args, full_args)
+        block.call
+
+        process_args(args.dup, klass)
+
+        assign_toggles_from(available_toggles)
+        assign_options_from(available_options)
+        assign_arguments_from(available_arguments)
+
+        return if display_help_if_requested(klass, full_args)
+
+        ensure_parameters_defined!(available_options, available_arguments)
+
+        if (execute = klass.instance_variable_get('@execute_proc'))
+          instance.instance_eval(&execute)
+        else
+          raise Exceptions::ExecuteBlockMissing.new(self), 'There is no execute {} block defined'
+        end
+      end
+
+      def sub_command?
+        true
+      end
+
+      private
+
+        attr_reader :instance, :args, :block
+
+        def aliases
+          @aliases ||= args.fetch(:aliases, [])
+        end
+
+        # FIXME
+        def klass
+          @klass ||= instance.class
+        end
+
+    end
+  end
+end

data/lib/brigadier/commands.rb

@@ -0,0 +1,8 @@
+require 'brigadier/commands/base'
+require 'brigadier/commands/command'
+require 'brigadier/commands/sub_command'
+
+module Brigadier
+  module Commands
+  end
+end

data/lib/brigadier/exceptions/base.rb

@@ -0,0 +1,21 @@
+module Brigadier
+  module Exceptions
+    class Base < StandardError
+      attr_reader :obj
+
+      def initialize(obj)
+        @obj = obj
+      end
+
+      def as_str
+        "%s '%s': %s" % [ parameter_type, obj.name, message ]
+      end
+
+      private
+
+        def parameter_type
+          obj.class.to_s.to_s.gsub(/^.*::/, '')
+        end
+    end
+  end
+end

data/lib/brigadier/exceptions/execute_block_missing.rb

@@ -0,0 +1,5 @@
+module Brigadier
+  module Exceptions
+    class ExecuteBlockMissing < StandardError; end
+  end
+end

data/lib/brigadier/exceptions/value_invalid.rb

@@ -0,0 +1,5 @@
+module Brigadier
+  module Exceptions
+    class ValueInvalid < Base; end
+  end
+end

data/lib/brigadier/exceptions/value_missing.rb

@@ -0,0 +1,5 @@
+module Brigadier
+  module Exceptions
+    class ValueMissing < Base; end
+  end
+end

data/lib/brigadier/exceptions.rb

@@ -0,0 +1,10 @@
+require 'brigadier/exceptions/base'
+require 'brigadier/exceptions/value_invalid'
+require 'brigadier/exceptions/value_missing'
+require 'brigadier/exceptions/execute_block_missing'
+
+module Brigadier
+  module Exceptions
+    ERROR_EXIT_CODE = 1
+  end
+end