ordu 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 45c704d10811be244289b8d3fb027cd6888725bb
+  data.tar.gz: 78c7a7d69b655afbf2cd34839d6a22e255c2f6ed
+SHA512:
+  metadata.gz: 0b38d6eb9f53b1eb20cbcb70ba9d420db96350f25c2d86f4c712b212d5195969db3c57b9d9c9b52f3973b11466256ed1197b1cc74f7022914a9a20e827ed52b1
+  data.tar.gz: 5e1d20bd648b9c895c10fcf2f0a4709c12ecad6424c7b15e4a090357815e5d42ef6bec0ebc133c67ae2e82a3959107244952f3a52b88bfdb177f55e882c43f53

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

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 jjbuckley@gmail.com. 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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ordu.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 JJ Buckley
+
+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,93 @@
+# Ordú
+
+Another command-line interface library for Ruby. This one is based entirely on
+the venerable and built-in `OptionParser` class.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ordu'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ordu
+
+## Usage
+
+Write a subclass of `Ordu`. Then use the `option`, `command` and `action` to
+define behaviour. In the background, a set of command-line parsers will be
+built up. Now, calling the `parse!` method on the class itself, and passing in
+an array of arguments will give you your CLI.
+
+Here's a simple example:
+
+```ruby
+#!/usr/bin/env ruby
+require 'ordu'
+class Sneezer < Ordu
+  # Define options much as you would with Ruby's built-in OptionParser. The
+  # difference is that blocks are evaluated within the Ordu instance's
+  # context.
+  option('-h', '--help', 'print this message') { puts(self); exit }
+  option('-V', '--version', 'print the version') { puts('0.0.1'); exit }
+  option('-v', '--[no-]verbose', 'be noisy') { |v| $verbose = v }
+  
+  # Define an action to be run after commands are processed. This is optional.
+  action do |*args|
+    puts "Leftover args: #{args}" if $verbose
+  end
+
+  # Define one or more subcommands (with a brief description). They will be
+  # turned into Ordu parsers, and given the remaining arguments to parse. The
+  # DSL within a command is exactly like that of the top-level class.
+  command 'sneeze', 'sneeze on the console' do
+    option('-h', '--help', 'you are reading it') { puts(self); exit }
+    option('-l', '--loud', 'sneeze louder') { @loud = true }
+    option('-t', '--times N', Integer, 'sneeze repeatedly') { |n| @times = n }
+
+    action do |*args|
+      (@times || 1).times { puts 'Achoo!'.tap { |s| s.upcase! if @loud } }
+      puts "After sneezing: #{args}" if $verbose
+    end
+  end
+end
+
+Sneezer.parse!(ARGV) # Processes the commands
+```
+
+This gives you a useless little tool which sneezed multiple times on demand.
+You can see it in action if you're in this project's directory, and you run
+
+    examples/sneezer.rb -h
+    examples/sneezer.rb sneeze -h
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake test` 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 `ordu.gemspec`, 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/bjjb/ordu. 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](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ordu"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ordu.rb

@@ -0,0 +1,124 @@
+require 'optparse'
+# A little class for building command-line programs. Based on OptionParser.
+#
+# You define a subclass of Ordu with the `option`, `command` and `action`
+# directives. `option` looks a lot like `OptionParser#on`, but can also accept
+# a Symbol or a String (allowing you to specify an instance method as the
+# option handler). `command` takes a block which is used as the body of the
+# command (or, again, a String/Symbol, or an Ordu class). `action` is another
+# block (or Symbol/String) which is executed if no subcommands are run.
+#
+# When the class is defined, these options, commands and action are simply
+# remembered. Then when the class is initialized, the instance is created and
+# the options applied.
+#
+# When `parse!` is called, the command-line switches are parsed. The next
+# leftover argument is checked to see if it is a command. If so, then that
+# command is built into an Ordu, and `parse!`ed with the next arguments.
+# Everything left is passed into the `action` method (which instance_execs the
+# block specified in the class definition).
+class Ordu < OptionParser
+  # Make a new Ordu instance. It will be set up with the options, commands and
+  # action specified in its class definition.
+  def initialize(options: nil, commands: nil, action: nil)
+    super()
+    options ||= self.class.options
+    commands ||= self.class.commands
+    action ||= self.class.action
+    options.each { |o| option!(*o) }
+    commands.each { |c| command!(*c) }
+    @action = action
+  end
+
+  # Parse options in order, and call commands for non-option arguments (if the
+  # command exists). This is how programs are exected.
+  def parse!(args)
+    args = order!(args)
+    unless args.empty?
+      if commands.key?(args.first)
+        return commands[args.shift].parse!(args) 
+      end
+    end
+    run(*args)
+  end
+
+  # Parses a new instance. Note that this must be the top-level, since you
+  # can't supply a name. This is convenient for starting the parser from
+  # scripts.
+  def self.parse!(args)
+    new.parse!(args)
+  end
+
+  private
+
+  def program_name
+    name || super
+  end
+
+  def name
+    @name ||= self.class.name
+  end
+
+  def self.name(name = nil)
+    name ? @name = name : @name
+  end
+
+  def self.desc(desc = nil)
+    desc ? @desc = desc : @desc
+  end
+
+  # Runs the action for this Ordu instance.
+  def run(*args)
+    return instance_exec(*args, &@action) if @action
+  end
+
+  # Gets the hash of subcommands
+  def commands
+    @commands ||= {}
+  end
+
+  # Applies a new option (using OptionParser#on). The last argument must be a
+  # block, and will be instance_exec'ed in this instance.
+  def option!(*args)
+    b = args.pop
+    on(*args) { |*x| instance_exec(*x, &b) }
+  end
+
+  # Applies a new command (i.e., a new Ordu which may be run if the command is
+  # given). name and desc are set on the new class.
+  def command!(name, desc, block)
+    command = Class.new(self.class, &block)
+    command.name [program_name, name].join(' ')
+    command.desc desc
+    commands[name] = command
+  end
+
+  # Defines a new option for instances of this Ordu class.
+  def self.option(*args, &block)
+    args.push(block) if block_given?
+    options.push(args)
+  end
+
+  # An array of the options to be applied
+  def self.options
+    @options ||= []
+  end
+
+  # Defines a new command for instances of this Ordu class. The block will be
+  # pushed in as the last element of the command array.
+  def self.command(*args, &block)
+    args.push(block) if block_given?
+    commands.push(args)
+  end
+
+  # An array of the commands available to instances of this Ordu class.
+  def self.commands
+    @commands ||= []
+  end
+
+  # Defines the action to be run once parsing is finished.
+  def self.action(&block)
+    @action = block if block_given?
+    @action ||= lambda { }
+  end
+end

data/ordu.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ordu'
+  spec.version       = '0.0.2'
+  spec.authors       = ['JJ Buckley']
+  spec.email         = ['jj@bjjb.org']
+
+  spec.summary       = 'A little CLI library based on OptionParser'
+  spec.description   = <<-EOF
+A small library to simplify writing command-line interfaces. It has no
+dependencies, and allows you to specify subcommands.
+  EOF
+  spec.homepage      = 'https://bjjb.github.io/ordu'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|examples)/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: ordu
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- JJ Buckley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: |
+  A small library to simplify writing command-line interfaces. It has no
+  dependencies, and allows you to specify subcommands.
+email:
+- jj@bjjb.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ordu.rb
+- ordu.gemspec
+homepage: https://bjjb.github.io/ordu
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A little CLI library based on OptionParser
+test_files: []