simple-command-parser 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ff2103f8c893eedfe024caec1c2a7af520cf36fbff06a9eab200c84b0c281941
+  data.tar.gz: 1f215bccf6ce68216112926a0acb986ebde70f0f2bca56062d7b073f82622e58
+SHA512:
+  metadata.gz: 33f2987956cbc688cb663913cf1d684f889974f3bb1efda5844c3f7bf39565b199b986ff8d8f6316363535b6d8ffa13277316b12997898dd2e5f3e0bcd0a208c
+  data.tar.gz: 05c27c24e72139def6a2c3074f964b8788fb985e4d590b8ee8c2ac42297ced1195a08635f21dc38201147ff63f4cd5eef63956cef65cd7adb131de1912c918f9

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+Gemfile.lock
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1 @@
+FIXME

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+Bundler.require
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/*test.rb']
+end
+
+task :default => :test

data/lib/simple-command-parser.rb

@@ -0,0 +1,54 @@
+require 'simple_option_parser'
+
+module Simple
+
+  class CommandParser
+
+    class UsageError < StandardError; end
+
+    def self.run(*args)
+      new.run(*args)
+    end
+
+    def run(args=ARGV, **defaults)
+      cmd_name = args.shift or raise UsageError, "No command given"
+      cmd_class = Command.find_command(cmd_name) or raise UsageError, "Unknown command: #{cmd_name.inspect}"
+      options = defaults.merge(cmd_class.defaults.merge(SimpleOptionParser.parse(args)))
+      cmd_class.new(options).tap { |cmd| cmd.run(args) }
+    end
+
+    class Command
+
+      def self.inherited(klass)
+        @@command_classes ||= []
+        @@command_classes << klass
+      end
+
+      def self.find_command(name)
+        map = @@command_classes.select { |k| k.subclasses.empty? }.map { |k| [k.command_name, k] }.to_h
+        map[name]
+      end
+
+      def self.command_name
+        name.to_s.
+          split('::').last.
+          gsub(/([a-z])([A-Z])/, '\1-\2').
+          downcase
+      end
+
+      def self.defaults
+        {}
+      end
+
+      def initialize(options={})
+        options.each do |key, value|
+          raise CommandParser::UsageError, "Unknown option: #{key.inspect}" unless respond_to?(key)
+          send("#{key}=", value)
+        end
+      end
+
+    end
+
+  end
+
+end

data/simple-command-parser.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name          = 'simple-command-parser'
+  s.version       = '1.0'
+  s.summary       = 'A simple command parser.'
+  s.author        = 'John Labovitz'
+  s.email         = 'johnl@johnlabovitz.com'
+  s.description   = %q{
+    Simple::CommandParser is a simple command parser.
+  }.strip
+  s.license       = 'MIT'
+  s.homepage      = 'http://github.com/jslabovitz/simple-command-parser'
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_path  = 'lib'
+
+  s.add_dependency 'simple_option_parser', '~> 0.8'
+
+  s.add_development_dependency 'bundler', '~> 2.5'
+  s.add_development_dependency 'minitest', '~> 5.22'
+  s.add_development_dependency 'minitest-power_assert', '~> 0.3'
+  s.add_development_dependency 'rake', '~> 13.2'
+end

data/test/command_test.rb

@@ -0,0 +1,72 @@
+require 'minitest/autorun'
+require 'minitest/power_assert'
+
+require 'simple-command-parser'
+
+class Test < Minitest::Test
+
+  class Command < Simple::CommandParser::Command
+
+    attr_accessor :scale
+    attr_accessor :result
+
+    def self.defaults
+      super.merge(
+        scale: 1,
+      )
+    end
+
+  end
+
+  class Add < Command
+
+    attr_accessor :format
+    attr_accessor :offset
+
+    def self.defaults
+      super.merge(
+        format: 'd',
+        offset: 0,
+      )
+    end
+
+    def run(args)
+      @result = "%#{@format}" % ((@offset + args.map(&:to_i).inject(&:+)) * @scale)
+    end
+
+  end
+
+  def setup
+    @parser = Simple::CommandParser.new
+  end
+
+  def test_simple
+    result = @parser.run(%w{add 1 2 3}).result
+    assert { result == '6' }
+  end
+
+  def test_offset
+    result = @parser.run(%w{add --offset=10 1 2 3}).result
+    assert { result == '16' }
+  end
+
+  def test_format
+    result = @parser.run(%w{add --offset=10 --format=x 1 2 3}).result
+    assert { result == '10' }
+  end
+
+  def test_global
+    result = @parser.run(%w{add --scale=2 1 2 3}).result
+    assert { result == '12' }
+  end
+
+  def test_usage
+    begin
+      result = @parser.run(%w{bad})&.result
+    rescue Simple::CommandParser::UsageError
+      nil
+    end
+    assert { result == nil }
+  end
+
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: simple-command-parser
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- John Labovitz
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simple_option_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.22'
+- !ruby/object:Gem::Dependency
+  name: minitest-power_assert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+description: Simple::CommandParser is a simple command parser.
+email: johnl@johnlabovitz.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- lib/simple-command-parser.rb
+- simple-command-parser.gemspec
+- test/command_test.rb
+homepage: http://github.com/jslabovitz/simple-command-parser
+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: []
+rubygems_version: 3.5.10
+signing_key:
+specification_version: 4
+summary: A simple command parser.
+test_files:
+- test/command_test.rb