argy 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dff9d90b687d261bae2c0820b5ea7b7f812d472d
-  data.tar.gz: 5543ca5b69b14891cbd8e1744df8b7b7480edcd0
+  metadata.gz: '01379049c1a1d66874589c09735fba37dbfbf39b'
+  data.tar.gz: fb593767af624cc2c3dc06ec32a8c2286fea7f9d
 SHA512:
-  metadata.gz: 3ee7ec946a02ce9200fbf9318d708e5ae1a652092f9891050253e34b0ad628ba1aad81e0aa1431e655ebb20a1805b79d3e0800be67e9ed881cb7ad4a5c98673e
-  data.tar.gz: 8372f49e4daca19886b4850bfd1e6f04929a81a6584af4c57babccc0a9aa561bf5eaac035147c786a555e954639fe6ad5b35b301d603514db388d91a185c21a8
+  metadata.gz: 3addec730a4dce220927c0518d52a1e2188fc27ff67de5ffddc89f0e91956b62dd31d7204968de26ff14b654e5b10cd9cc10f202a00f178e6a64819ce1f9b4f4
+  data.tar.gz: f034dc884c0b9bad616f2daedba4068cfcf1ea8adfc27862466e6afd2c80446b880e1a36e19b5a1e7bc44d588b71ce435bbf8565398da64b109dbb7942f7a381

data/Gemfile.lock

@@ -1,18 +1,14 @@
 PATH
   remote: .
   specs:
-    argy (0.1.0)
+    argy (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.2)
     diff-lcs (1.3)
-    equatable (0.6.1)
     method_source (0.9.2)
-    pastel (0.7.3)
-      equatable (~> 0.6)
-      tty-color (~> 0.5)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -30,7 +26,6 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.0)
-    tty-color (0.5.0)
 
 PLATFORMS
   ruby
@@ -38,7 +33,6 @@ PLATFORMS
 DEPENDENCIES
   argy!
   bundler (~> 2.0)
-  pastel
   pry
   rake (~> 10.0)
   rspec (~> 3.0)

data/README.md

@@ -1,8 +1,6 @@
 # Argy
 
-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/argy`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Yet another command-line option parser.
 
 ## Installation
 
@@ -22,17 +20,81 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Here's an example:
+
+```ruby
+require "argy"
+
+parser = Argy.new do |o|
+  o.description "Prints messages"
+  o.usage "example"
+  o.example "$ example hello"
+
+  o.argument :message, desc: "message to print", required: true
+
+  o.option :loud, type: :boolean, desc: "say the message loudly"
+  o.option :count, type: :integer, desc: "number of times to print", default: 1
+
+  o.on "-v", "print the verison and exit" do
+    puts Example::VERSION
+    exit
+  end
+
+  o.on "-h", "--help", "show this help and exit" do
+    puts o.help
+    puts o.help.section "SECTION"
+    puts o.help.entry "foo", desc: "bar"
+    exit
+  end
+end
+
+begin
+  options = parser.parse(ARGV)
+  message = options.message
+  message = message.upcase if options.loud?
+  options.count.times { puts message }
+rescue Argy::Error => err
+  abort err.message
+end
+```
+
+## Option Types
 
-## Development
+Argy supports the following option types:
 
-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.
+- `:string`
+- `:boolean`
+- `:integer`
+- `:float`
+- `:array`
+- `:pathname`
+
+However, Argy also supports custom option types. For example:
+
+```ruby
+class NameOption
+  def self.call(input)
+    parts = input.split(" ")
+    raise Argy::CoersionError, "Invalid name" if parts.length != 2
+    new(*parts)
+  end
+
+  def initialize(first, last)
+    @first = first
+    @last = last
+  end
+end
+
+Argy.new do |o|
+  o.option :name, type: NameOption
+end
+```
 
-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).
+An option type is anything that responds to `call`. So, your option type could just be a lambda.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/argy. 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 GitHub at https://github.com/rzane/argy. 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
 
@@ -40,4 +102,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Argy project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/argy/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Argy project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rzane/argy/blob/master/CODE_OF_CONDUCT.md).

data/bin/example

@@ -3,16 +3,30 @@
 require "bundler/setup"
 require "argy"
 
-options = Argy.parse(ARGV) do |o|
+parser = Argy.new do |o|
+  o.description "Prints messages"
   o.usage "example"
-  o.description "A cool thing that does stuff"
-  o.example "$ example foo"
-  o.argument :jint, desc: "do a thing"
-  o.option :fizz, required: true, desc: "blah"
-  o.option :foo_bar, aliases: ["-f"], default: "jawn"
+  o.example "$ example hello"
+  o.argument :message, desc: "message to print", required: true
+  o.option :loud, type: :boolean, desc: "say the message loudly"
+  o.option :times, type: :integer, desc: "number of times to print", default: 1
   o.on "-v", "print the verison and exit" do
     puts Argy::VERSION
+    exit
+  end
+  o.on "-h", "--help", "show this help and exit" do
+    puts o.help
+    puts o.help.section "SECTION"
+    puts o.help.entry "foo", desc: "bar"
+    exit
   end
 end
 
-puts options
+begin
+  options = parser.parse(ARGV)
+  message = options.message
+  message = message.upcase if options.loud?
+  options.times.times { puts message }
+rescue Argy::Error => err
+  abort err.message
+end

data/lib/argy.rb

@@ -5,13 +5,21 @@ module Argy
   Error = Class.new(StandardError)
   CoersionError = Class.new(Error)
   ValidationError = Class.new(Error)
-  MissingArgumentError = Class.new(Error)
+
+  class ParseError < Error
+    attr_reader :original
+
+    def initialize(original)
+      @original = original
+      super(original.message)
+    end
+  end
 
   def self.new(&block)
     Argy::Parser.new(&block)
   end
 
-  def self.parse(argv, &block)
+  def self.parse(argv: ARGV, &block)
     new(&block).parse(argv)
   end
 end

data/lib/argy/help.rb

@@ -19,6 +19,18 @@ module Argy
       out.join("\n") + "\n"
     end
 
+    def section(title)
+      bold "\n#{title}"
+    end
+
+    def entry(name, desc: nil, required: false, default: nil)
+      out = "  #{name.ljust(column)}"
+      out += dim("#{desc} ") if desc
+      out += dim("(required) ") if required
+      out += dim("[default: #{default.inspect}]") if default
+      out.rstrip
+    end
+
     private
 
     def description(out)
@@ -41,7 +53,7 @@ module Argy
     end
 
     def argument(a)
-      parameter(a.label, a.desc, a.required?, a.default)
+      entry(a.label, desc: a.desc, required: a.required?, default: a.default)
     end
 
     def options(out)
@@ -52,19 +64,18 @@ module Argy
     def option(o)
       label = [option_label(o.label, o.type)]
       label += o.aliases.map { |a| option_label(a, o.type) }
-      parameter(label.join(", "), o.desc, o.required?, o.default)
+      entry(label.join(", "), desc: o.desc, required: o.required?, default: o.default)
     end
 
     def flags(out)
-      out << bold("\nFLAGS")
+      out << bold("\nFLAGS") if parser.flags.any?
       out.concat parser.flags.map { |f, _| flag(f) }
-      out << parameter("--help, -h", "show this help and exit")
     end
 
     def flag(flag)
       flag = flag.dup
       desc = flag.pop unless flag.last.match?(/^-/)
-      parameter(flag.reverse.join(", "), desc)
+      entry(flag.reverse.join(", "), desc: desc)
     end
 
     def option_label(label, type)
@@ -72,14 +83,6 @@ module Argy
       label.start_with?("--") ? "#{label}=VALUE" : "#{label} VALUE"
     end
 
-    def parameter(left, right, required = false, default = nil)
-      label = "  #{left.ljust(column)}"
-      label += dim("#{right} ") if right
-      label += dim("(required) ") if required
-      label += dim("[default: #{default.inspect}]") if default
-      label.rstrip
-    end
-
     def bold(text)
       color? ? "\e[1m#{text}\e[0m" : text
     end

data/lib/argy/options.rb

@@ -0,0 +1,38 @@
+module Argy
+  class Options
+    def initialize(values)
+      @values = values
+    end
+
+    def to_h
+      @values
+    end
+
+    def [](key)
+      @values[key]
+    end
+
+    def fetch(*args, &block)
+      @values.fetch(*args, &block)
+    end
+
+    private
+
+    def respond_to_missing?(meth, *)
+      @values.key?(meth.to_s.sub(/\?$/, "").to_sym) || super
+    end
+
+    def method_missing(meth, *args)
+      query = meth[-1] == "?"
+      key = query ? meth[0..-2].to_sym : meth.to_sym
+
+      return super unless @values.key?(key)
+
+      unless args.empty?
+        raise ArgumentError, "wrong number of arguments (given #{args.length}, expected 0)"
+      end
+
+      query ? !!@values[key] : @values[key]
+    end
+  end
+end

data/lib/argy/parameter.rb

@@ -1,3 +1,4 @@
+require "pathname"
 require "argy/parameter"
 
 module Argy

data/lib/argy/parser.rb

@@ -2,6 +2,7 @@ require "optparse"
 require "argy/help"
 require "argy/option"
 require "argy/argument"
+require "argy/options"
 
 module Argy
   class Parser
@@ -52,25 +53,37 @@ module Argy
     end
 
     def default_values
-      (arguments + options).reduce(unused_arguments: []) do |acc, opt|
+      parameters.reduce(unused_args: []) do |acc, opt|
         acc[opt.name] = opt.default
         acc
       end
     end
 
-    def parse(argv)
+    def parse(argv, strategy: nil)
       argv = argv.dup
       values = default_values
-
       parser = build_parser(values)
-      parser.parse!(argv)
+
+      case strategy
+      when :order
+        parser.order!(argv)
+      when :permute
+        parser.permute!(argv)
+      else
+        parser.parse!(argv)
+      end
 
       populate_arguments(values, argv)
-      validate!(values)
+      Options.new validate!(values)
+    rescue OptionParser::ParseError => error
+      raise ParseError.new(error)
+    end
 
+    def validate!(values)
+      parameters.each do |param|
+        param.validate(values[param.name])
+      end
       values
-    rescue OptionParser::MissingArgument => error
-      raise MissingArgumentError, error.message
     end
 
     private
@@ -78,19 +91,13 @@ module Argy
     def populate_arguments(values, argv)
       argv.zip(arguments).each do |value, arg|
         if arg.nil?
-          values[:unused_arguments] << value
+          values[:unused_args] << value
         else
           values[arg.name] = arg.coerce(value)
         end
       end
     end
 
-    def validate!(values)
-      parameters.each do |param|
-        param.validate(values[param.name])
-      end
-    end
-
     def build_parser(values)
       OptionParser.new do |o|
         options.each do |opt|
@@ -102,11 +109,6 @@ module Argy
         flags.each do |flag, action|
           o.on(*flag, &action)
         end
-
-        o.on("-h", "--help") do
-          puts help
-          exit
-        end
       end
     end
   end

data/lib/argy/version.rb

@@ -1,3 +1,3 @@
 module Argy
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: argy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ray Zane
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-06 00:00:00.000000000 Z
+date: 2019-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,6 +76,7 @@ files:
 - lib/argy/argument.rb
 - lib/argy/help.rb
 - lib/argy/option.rb
+- lib/argy/options.rb
 - lib/argy/parameter.rb
 - lib/argy/parser.rb
 - lib/argy/version.rb