cmdline_arg_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9359a93f712f7d228c5d1dbab3c551a1b86f471a
+  data.tar.gz: 900cf435687f0a00d7f43c72ccfc54e66ecccacf
+SHA512:
+  metadata.gz: 0de95ecb7c9e83d4f1deaa4a58d5692bf4adf88008fcbacd1f162051afa9bfa5c09b6633330a307c06e791d1ec0e4c2aa93ecf65d0eef023ee6c09a98d6b122c
+  data.tar.gz: c270e607d5da96b94ba6e148be2e3534093ebc8386d2317bc9e6c3aff21d09c29263465cb73c5cad73fb22760f5cd4180a0a05c6b7ef0931583c33d366610486

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.0
+before_install: gem install bundler -v 1.15.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 cmdline_arg_parser.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,58 @@
+# Command-line argument parser
+
+A small library for parsing command-line arguments in Ruby.
+
+Designed to be used with command-line tools like `git` which have a set of subcommands that each have different options and switches.
+
+## Sample
+
+```ruby
+require "cmdline_arg_parser"
+
+# Define a parser using the DSL
+class ParserFromDsl
+  extend CmdlineArgParser::Dsl
+
+  subcommand "merge" do
+    option "branch", short_key: "b"
+    option("from-step") { |value| value.to_i }
+    switch "dry-run"
+  end
+
+  subcommand "version"
+end
+
+# Have some ARGV
+ARGV = ["merge", "--dry-run", "--from-step", "10", "-b", "release-branch"]
+
+args = ParserFromDsl.parse(ARGV)
+
+# Accessing the parsed data
+args.subcommand # => "merge"
+args.options # => { "branch" => "release-branch", "from-step" => 10 }
+args.switches # => Set.new(["dry-run"])
+```
+
+If you don't want to use the DSL, the above parser can also be written as:
+
+```ruby
+parser = CmdlineArgParser::Parser.new(
+  subcommands: [
+    CmdlineArgParser::Parser::Subcommand.new(
+      "merge",
+      options: [
+        CmdlineArgParser::Parser::Option.new("branch", short_key: "b"),
+        CmdlineArgParser::Parser::Option.new("from-step") { |value| value.to_i },
+      ],
+      switches: [
+        CmdlineArgParser::Parser::Switch.new("dry-run"),
+      ],
+    ),
+    CmdlineArgParser::Parser::Subcommand.new("version"),
+  ]
+)
+```
+
+## Built by
+
+[@davidpdrsn](https://twitter.com/davidpdrsn)

data/README.md

@@ -0,0 +1,35 @@
+# CmdlineArgParser
+
+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/cmdline_arg_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 'cmdline_arg_parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cmdline_arg_parser
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 `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/davidpdrsn/cmdline_arg_parser.

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 "cmdline_arg_parser"
+
+# 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(__FILE__)

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/cmdline_arg_parser.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cmdline_arg_parser/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cmdline_arg_parser"
+  spec.version       = CmdlineArgParser::VERSION
+  spec.authors       = ["David Pedersen"]
+  spec.email         = ["david@tonsser.com"]
+
+  spec.summary       = %q{Simple command line argument parsing}
+  spec.homepage      = "https://github.com/tonsser/cmdline_arg_parser"
+
+  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.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/cmdline_arg_parser/dsl.rb

@@ -0,0 +1,44 @@
+module CmdlineArgParser
+  module Dsl
+    def subcommand(name, &block)
+      @subcommands ||= []
+
+      subcommand_dsl = SubcommandDsl.new
+      if block
+        subcommand_dsl.instance_eval(&block)
+      end
+
+      @subcommands << Parser::Subcommand.new(
+        name,
+        options: subcommand_dsl.options,
+        switches: subcommand_dsl.switches,
+      )
+    end
+
+    def parse(argv)
+      parser.parse(argv)
+    end
+
+    def parser
+      @subcommands ||= []
+      @parser ||= Parser.new(subcommands: @subcommands)
+    end
+
+    class SubcommandDsl
+      def initialize
+        @options = []
+        @switches = []
+      end
+
+      attr_reader :options, :switches
+
+      def option(name, short_key: nil, &block)
+        @options << Parser::Option.new(name, short_key: short_key, &block)
+      end
+
+      def switch(name, short_key: nil)
+        @switches << Parser::Switch.new(name, short_key: short_key)
+      end
+    end
+  end
+end

data/lib/cmdline_arg_parser/readme_builder.rb

@@ -0,0 +1,81 @@
+module CmdlineArgParser
+  class ReadmeBuilder
+    def initialize(parser:, specifics:)
+      @parser = parser
+      @specifics = specifics
+    end
+
+    def build
+      output = <<-EOS
+# #{@specifics.title}
+
+#{@specifics.description}
+
+## Subcommands
+
+    EOS
+
+      subcommand_descriptions = @parser.subcommands.map do |subcommand|
+        subcommand_description = <<-EOS
+$ #{@specifics.script_name} #{subcommand.command}
+  #{@specifics.description_for_subcommand(subcommand.command)}
+        EOS
+
+        if subcommand.options != [] || subcommand.switches != []
+          subcommand_description += indent("\n## Options\n", 2)
+
+          option_descriptions = subcommand.options.map do |option|
+            option_label = @specifics.option_label_for(
+              subcommand: subcommand.command,
+              option_key: option.long_key,
+            )
+
+            lines = []
+            lines << "--#{option.long_key} #{option_label}"
+
+            if option.short_key
+              lines << "-#{option.short_key} #{option_label}"
+            end
+
+            option_description = @specifics.option_description(
+              subcommand: subcommand.command,
+              option_key: option.long_key,
+            )
+            lines << indent("#{option_description}\n", 2)
+
+            lines.join("\n")
+          end
+
+          switch_descriptions = subcommand.switches.map do |switch|
+            lines = []
+            lines << "--#{switch.long_key}"
+            if switch.short_key
+              lines << "-#{short_key.long_key}"
+            end
+            lines << @specifics.switch_label(
+              subcommand: subcommand.command,
+              switch_key: switch.long_key,
+            )
+            lines.join("\n")
+          end
+
+          subcommand_description += indent(option_descriptions.join("\n"), 4)
+          subcommand_description += indent(switch_descriptions.join("\n"), 4)
+        end
+
+        indent(subcommand_description, 2)
+      end
+      output += subcommand_descriptions.join("\n")
+
+      output.chomp
+    end
+
+    private
+
+    def indent(str, amount)
+      str.lines.map do |line|
+        "#{' ' * amount}#{line}"
+      end.join
+    end
+  end
+end

data/lib/cmdline_arg_parser/version.rb

@@ -0,0 +1,3 @@
+module CmdlineArgParser
+  VERSION = "0.1.0"
+end

data/lib/cmdline_arg_parser.rb

@@ -0,0 +1,128 @@
+require "cmdline_arg_parser/version"
+require "cmdline_arg_parser/readme_builder"
+require "cmdline_arg_parser/dsl"
+
+module CmdlineArgParser
+  class Parser
+    class ParseError < RuntimeError; end
+
+    def initialize(subcommands:)
+      @subcommands = subcommands
+    end
+
+    attr_reader :subcommands
+
+    def parse(argv)
+      parsed_args = ParsedArgs.new
+
+      @subcommands.each do |subcommand|
+        subcommand.try_parse(argv, parsed_args)
+      end
+
+      unless argv == []
+        raise ParseError, "Expected end of input, but got \"#{argv.join(' ')}\""
+      end
+
+      parsed_args
+    end
+
+    def build_readme(builder)
+      ReadmeBuilder.new(parser: self, specifics: builder).build
+    end
+
+    class Subcommand
+      def initialize(command, options: [], switches: [])
+        @command = command
+        @options = options
+        @switches = switches
+      end
+
+      attr_reader :command, :options, :switches
+
+      def try_parse(argv, out)
+        return unless argv[0] == @command
+
+        out.subcommand = argv.shift
+        @options.each { |option| option.parse(argv, out) }
+        @switches.each { |switch| switch.parse(argv, out) }
+      end
+    end
+
+    class Option
+      def initialize(long_key, short_key: nil, &block)
+        @long_key = long_key
+        @short_key = short_key
+        @block = block
+      end
+
+      attr_reader :short_key, :long_key
+
+      def parse(argv, out)
+        index_of_key = argv.find_index do |word|
+          word == "--#{@long_key}" || word == "-#{@short_key}"
+        end
+        index_of_value = index_of_key + 1
+
+        value = argv[index_of_value]
+        if @block
+          value = @block.call(value)
+        end
+        out.set_option(@long_key, value)
+
+        argv.delete_at(index_of_key)
+        argv.delete_at(index_of_value - 1)
+      end
+    end
+
+    class Switch
+      def initialize(long_key, short_key: nil)
+        @long_key = long_key
+        @short_key = short_key
+      end
+
+      attr_reader :long_key, :short_key
+
+      def parse(argv, out)
+        index_of_key = argv.find_index do |word|
+          word == "--#{@long_key}" || word == "-#{@short_key}"
+        end
+
+        if index_of_key
+          out.set_switch(@long_key)
+        end
+
+        argv.delete_at(index_of_key)
+      end
+    end
+  end
+
+  class ParsedArgs
+    attr_reader(
+      :subcommand,
+    )
+
+    attr_writer(
+      :subcommand,
+      :options,
+      :switches,
+    )
+
+    def options
+      @options ||= {}
+    end
+
+    def switches
+      @switches ||= Set.new
+    end
+
+    def set_option(key, value)
+      @options ||= {}
+      @options[key] = value
+    end
+
+    def set_switch(key)
+      @switches ||= Set.new
+      @switches << key
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: cmdline_arg_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Pedersen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: 
+email:
+- david@tonsser.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.markdown
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cmdline_arg_parser.gemspec
+- lib/cmdline_arg_parser.rb
+- lib/cmdline_arg_parser/dsl.rb
+- lib/cmdline_arg_parser/readme_builder.rb
+- lib/cmdline_arg_parser/version.rb
+homepage: https://github.com/tonsser/cmdline_arg_parser
+licenses: []
+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: Simple command line argument parsing
+test_files: []