command_mapper-gen 0.1.0.pre1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a2eb2af7ffecbe7da0c31bf20a00c712c24a2e9400e12ed825104fcaadd6f020
+  data.tar.gz: 2a2ffc1f78ba1070a1edfd46be101b4af14892b970827509bdf472db1025945c
+SHA512:
+  metadata.gz: 243a76faebe6ec05dd7c1ca71cc6325b1f59226e6c3003244972af1e2bcd4433d6b057b1f9e1d194bebda4b4086e423fdeed79359b669f93894fab343a127603
+  data.tar.gz: d8e47e0b6f97a7d19bbfe06c133bb52cb9003970a3823ab9e15124c5715dcaa2ee3d1410f9ad9335722ef40bff4fac82348f76dd08a52ed4962841ccc845dc0d

data/.github/workflows/ruby.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on: [ push, pull_request ]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 2.6
+          - 2.7
+          - 3.0
+          - jruby
+          - truffleruby
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run tests
+        run: bundle exec rake test

data/.gitignore

@@ -0,0 +1,10 @@
+/Gemfile.lock
+/coverage/
+/doc/
+/pkg/
+/vendor/bundle/
+.DS_Store
+.yardoc
+*.log
+*.swp
+*~

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "CommandMapper::Gen Documentation" --protected --quiet

data/ChangeLog.md

@@ -0,0 +1,20 @@
+### 0.1.0 / 2021-11-22
+
+* Initial release:
+  * Added {CommandMapper::Gen::Types::Str}.
+  * Added {CommandMapper::Gen::Types::Num}.
+  * Added {CommandMapper::Gen::Types::Map}.
+  * Added {CommandMapper::Gen::Types::Enum}.
+  * Added {CommandMapper::Gen::Types::KeyValue}.
+  * Added {CommandMapper::Gen::Types::List}.
+  * Added {CommandMapper::Gen::Arg}.
+  * Added {CommandMapper::Gen::Argument}.
+  * Added {CommandMapper::Gen::OptionValue}.
+  * Added {CommandMapper::Gen::Option}.
+  * Added {CommandMapper::Gen::Command}.
+  * Added {CommandMapper::Gen::Parsers::Common}.
+  * Added {CommandMapper::Gen::Parsers::Usage}.
+  * Added {CommandMapper::Gen::Parsers::Options}.
+  * Added {CommandMapper::Gen::Parsers::Help}.
+  * Added {CommandMapper::Gen::Parsers::Man}.
+  * Added {CommandMapper::Gen::CLI}.

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rubygems-tasks', '~> 0.2'
+
+  gem 'rspec',          '~> 3.0'
+  gem 'simplecov',      '~> 0.20', require: false
+
+  gem 'kramdown'
+  gem 'yard',           '~> 0.9'
+  gem 'yard-spellcheck'
+
+  gem 'dead_end'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2021 Hal Brodigan
+
+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,145 @@
+# command_mapper-gen
+
+[![CI](https://github.com/postmodern/command_mapper-gen.rb/actions/workflows/ruby.yml/badge.svg)](https://github.com/postmodern/command_mapper-gen.rb/actions/workflows/ruby.yml)
+
+* [Source](https://github.com/postmodern/command_mapper-gen)
+* [Issues](https://github.com/postmodern/command_mapper-gen/issues)
+
+## Description
+  
+`command_mapper-gen` parses a command's `--help` output and man-page
+and generates the [command_mapper] Ruby class for the command.
+
+## Features
+
+* Parses `--help` output.
+* Parses man pages.
+* Provides the `command_mapper-gen` command.
+* Provides a Rake task.
+
+## Synopsis
+
+```shell
+$ command_mapper-gen grep
+```
+
+Outputs:
+
+```
+Failed to parse line in `grep --help`:
+
+    -NUM                      same as --context=NUM
+
+Failed to match sequence (('	' / SPACES) OPTION ','? ([ \\t]{1, } OPTION_SUMMARY)? !.) at line 1 char 5.
+
+require 'command_mapper/command'
+
+#
+# Represents the `grep` command
+#
+class Grep < CommandMapper::Command
+
+  command "grep" do
+    option "--extended-regexp"
+    option "--fixed-strings"
+    option "--basic-regexp"
+    option "--perl-regexp"
+    option "--regexp", equals: true, value: true
+    option "--file", equals: true, value: true
+    option "--ignore-case"
+    option "--no-ignore-case"
+    option "--word-regexp"
+    option "--line-regexp"
+    option "--null-data"
+    option "--no-messages"
+    option "--invert-match"
+    option "--version"
+    option "--help"
+    option "--max-count", equals: true, value: {type: Num.new}
+    option "--byte-offset"
+    option "--line-number"
+    option "--line-buffered"
+    option "--with-filename"
+    option "--no-filename"
+    option "--label", equals: true, value: true
+    option "--only-matching"
+    option "--quiet"
+    option "--binary-files", equals: true, value: true
+    option "--text"
+    option "-I", name: 	# FIXME: name
+    option "--directories", equals: true, value: true
+    option "--devices", equals: true, value: true
+    option "--recursive"
+    option "--dereference-recursive"
+    option "--include", equals: true, value: true
+    option "--exclude", equals: true, value: true
+    option "--exclude-from", equals: true, value: true
+    option "--exclude-dir", equals: true, value: true
+    option "--files-without-match", value: true
+    option "--files-with-matches"
+    option "--count"
+    option "--initial-tab"
+    option "--null"
+    option "--before-context", equals: true, value: {type: Num.new}
+    option "--after-context", equals: true, value: {type: Num.new}
+    option "--context", equals: true, value: {type: Num.new}
+    option "--group-separator", equals: true, value: true
+    option "--no-group-separator"
+    option "--color", equals: :optional, value: {required: false}
+    option "--colour", equals: :optional, value: {required: false}
+    option "--binary"
+
+    argument :patterns
+    argument :file, required: false, repeats: true
+  end
+
+end
+```
+
+Output can also be written to a file:
+
+```shell
+$ command_mapper-gen -o lib/path/to/grep.rb grep
+```
+
+## Examples
+
+### Rake Task
+
+In `Rakefile`:
+
+```ruby
+require 'command_mapper/gen/task'
+CommandMapper::Gen::Task.new('grep','lib/path/to/grep.rb')
+```
+
+## Requirements
+
+* [ruby] >= 2.0.0
+* [parslet] ~> 2.0
+
+## Install
+
+```shell
+$ gem install command_mapper-gen
+```
+
+### Gemfile
+
+```ruby
+group :development do
+  # ...
+
+  gem 'command_mapper-gen', '~> 0.1', require: false
+end
+```
+
+## License
+
+Copyright (c) 2021 Hal Brodigan
+
+See {file:LICENSE.txt} for license information.
+
+[command_mapper]: https://github.com/postmodern/command_mapper.rb#readme
+[ruby]: htt[s://www.ruby-lang.org/
+[parslet]: https://github.com/kschiess/parslet#readme

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+task :test    => :spec
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new
+
+require 'command_mapper/gen/task'
+CommandMapper::Gen::Task.new('grep', 'examples/grep.rb')

data/bin/command_mapper-gen

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+lib_dir = File.expand_path('../lib',__dir__)
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'command_mapper/gen/cli'
+exit CommandMapper::Gen::CLI.run

data/commnad_mapper-gen.gemspec

@@ -0,0 +1,61 @@
+# encoding: utf-8
+
+require 'yaml'
+
+Gem::Specification.new do |gem|
+  gemspec = YAML.load_file('gemspec.yml')
+
+  gem.name    = gemspec.fetch('name')
+  gem.version = gemspec.fetch('version') do
+                  lib_dir = File.join(File.dirname(__FILE__),'lib')
+                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+                  require 'command_mapper/gen/version'
+                  CommandMapper::Gen::VERSION
+                end
+
+  gem.summary     = gemspec['summary']
+  gem.description = gemspec['description']
+  gem.licenses    = Array(gemspec['license'])
+  gem.authors     = Array(gemspec['authors'])
+  gem.email       = gemspec['email']
+  gem.homepage    = gemspec['homepage']
+  gem.metadata    = gemspec['metadata'] if gemspec['metadata']
+
+  glob = lambda { |patterns| gem.files & Dir[*patterns] }
+
+  gem.files = `git ls-files`.split($/)
+  gem.files = glob[gemspec['files']] if gemspec['files']
+
+  gem.executables = gemspec.fetch('executables') do
+    glob['bin/*'].map { |path| File.basename(path) }
+  end
+  gem.default_executable = gem.executables.first if Gem::VERSION < '1.7.'
+
+  gem.extensions       = glob[gemspec['extensions'] || 'ext/**/extconf.rb']
+  gem.test_files       = glob[gemspec['test_files'] || '{test/{**/}*_test.rb']
+  gem.extra_rdoc_files = glob[gemspec['extra_doc_files'] || '*.{txt,md}']
+
+  gem.require_paths = Array(gemspec.fetch('require_paths') {
+    %w[ext lib].select { |dir| File.directory?(dir) }
+  })
+
+  gem.requirements              = gemspec['requirements']
+  gem.required_ruby_version     = gemspec['required_ruby_version']
+  gem.required_rubygems_version = gemspec['required_rubygems_version']
+  gem.post_install_message      = gemspec['post_install_message']
+
+  split = lambda { |string| string.split(/,\s*/) }
+
+  if gemspec['dependencies']
+    gemspec['dependencies'].each do |name,versions|
+      gem.add_dependency(name,split[versions])
+    end
+  end
+
+  if gemspec['development_dependencies']
+    gemspec['development_dependencies'].each do |name,versions|
+      gem.add_development_dependency(name,split[versions])
+    end
+  end
+end

data/examples/grep.rb

@@ -0,0 +1,63 @@
+require 'command_mapper/command'
+
+#
+# Represents the `grep` command
+#
+class Grep < CommandMapper::Command
+
+  command "grep"
+
+  option "--extended-regexp"
+  option "--fixed-strings"
+  option "--basic-regexp"
+  option "--perl-regexp"
+  option "--regexp", equals: true, value: true
+  option "--file", equals: true, value: true
+  option "--ignore-case"
+  option "--no-ignore-case"
+  option "--word-regexp"
+  option "--line-regexp"
+  option "--null-data"
+  option "--no-messages"
+  option "--invert-match"
+  option "--version"
+  option "--help"
+  option "--max-count", equals: true, value: true
+  option "--byte-offset"
+  option "--line-number"
+  option "--line-buffered"
+  option "--with-filename"
+  option "--no-filename"
+  option "--label", equals: true, value: true
+  option "--only-matching"
+  option "--quiet"
+  option "--binary-files", equals: true, value: true
+  option "--text"
+  option "-I", name: 	# FIXME: name
+  option "--directories", equals: true, value: true
+  option "--devices", equals: true, value: true
+  option "--recursive"
+  option "--dereference-recursive"
+  option "--include", equals: true, value: true
+  option "--exclude", equals: true, value: true
+  option "--exclude-from", equals: true, value: true
+  option "--exclude-dir", equals: true, value: true
+  option "--files-without-match", value: true
+  option "--files-with-matches"
+  option "--count"
+  option "--initial-tab"
+  option "--null"
+  option "--before-context", equals: true, value: true
+  option "--after-context", equals: true, value: true
+  option "--context", equals: true, value: true
+  option "-NUM"
+  option "--group-separator", equals: true, value: true
+  option "--no-group-separator"
+  option "--color", equals: :optional, value: {required: false}
+  option "--colour", equals: :optional, value: {required: false}
+  option "--binary"
+
+  argument :patterns
+  argument :file, repeats: true, required: false
+
+end

data/gemspec.yml

@@ -0,0 +1,26 @@
+name: command_mapper-gen
+summary: Generates command_mapper Ruby classes for a given command
+description:
+  command_mapper-gen parses a command's --help output and man-page, then
+  generates the command_mapper Ruby class for the command.
+
+license: MIT
+authors: Postmodern
+email: postmodern.mod3@gmail.com
+homepage: https://github.com/postmodern/command_mapper-gen.rb#readme
+has_yard: true
+
+metadata:
+  documentation_uri: https://rubydoc.info/gems/command_mapper-gen
+  source_code_uri:   https://github.com/postmodern/command_mapper-gen.rb
+  bug_tracker_uri:   https://github.com/postmodern/command_mapper-gen.rb/issues
+  changelog_uri:     https://github.com/postmodern/command_mapper-gen.rb/blob/master/ChangeLog.md
+  rubygems_mfa_required: 'true'
+
+required_ruby_version: ">= 2.0.0"
+
+dependencies:
+  parslet: ~> 2.0
+
+development_dependencies:
+  bundler: ~> 2.0

data/lib/command_mapper/gen/arg.rb

@@ -0,0 +1,43 @@
+module CommandMapper
+  module Gen
+    class Arg
+
+      # @return [Boolean]
+      attr_reader :required
+
+      # The value configuration for the argument.
+      #
+      # @return [Types::Type, nil]
+      attr_reader :type
+
+      #
+      # Initializes the parsed argument.
+      #
+      # @param [Boolean, nil] required
+      #
+      # @param [Types::Type, nil] type
+      #
+      def initialize(required: nil, type: nil)
+        @required = required
+        @type     = type
+      end
+
+      #
+      # Converts the parsed argument to Ruby source code.
+      #
+      # @return [String]
+      #
+      def to_ruby
+        ruby = []
+        ruby << "required: #{@required.inspect}" if @required == false
+
+        if (@type && (type = @type.to_ruby))
+          ruby << "type: #{type}"
+        end
+
+        ruby.join(', ')
+      end
+
+    end
+  end
+end

data/lib/command_mapper/gen/argument.rb

@@ -0,0 +1,53 @@
+require 'command_mapper/gen/arg'
+
+module CommandMapper
+  module Gen
+    #
+    # Represents a mock `CommandMapper::Argument` class.
+    #
+    class Argument < Arg
+
+      # The name of the argument.
+      #
+      # @return [Symbol]
+      attr_reader :name
+
+      # @return [Boolean, nil]
+      attr_reader :repeats
+
+      #
+      # Initializes the parsed argument.
+      #
+      # @param [Symbol] name
+      #   The argument name.
+      #
+      # @param [Boolean, nil] repeats
+      #
+      # @param [Hash{Symbol => Object}] kwargs
+      #   Additional keyword arguments.
+      #
+      def initialize(name, repeats: nil, **kwargs)
+        super(**kwargs)
+
+        @name    = name
+        @repeats = repeats
+      end
+
+      #
+      # Converts the parsed argument to Ruby source code.
+      #
+      # @return [String]
+      #
+      def to_ruby
+        ruby = "argument #{@name.inspect}"
+
+        keywords = super()
+        ruby << ", #{keywords}" unless keywords.empty?
+
+        ruby << ", repeats: #{@repeats.inspect}" unless @repeats.nil?
+        ruby
+      end
+
+    end
+  end
+end