particlecmd 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ed67116073b359825b4b1d0c4c80e2d62c35f3f2e3a11eb6e8264b0f155d49c0
+  data.tar.gz: 04c06d7534433e1418507c7580863c910e1171ea0499fe351c4eef78388c10a5
+SHA512:
+  metadata.gz: 8d00f5eb8831d37a62e01dd2226267c1ce570b13c3c86187cb5f2b1062fc92e7880d7b6b3b3e2d1b348590ca506417f5a5c0c086eac53c001dc4d4d9bfaa9a09
+  data.tar.gz: aad30fab5a877f750981f2e9c8454fd8ffc020fabcc214bb4e686c79ab39f03712d4059fc1f8bb58597a1361eec11e4cbae196534eac8cf10d40746910eedfa0

data/.gitignore

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

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 particlecmd.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    particlecmd (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  particlecmd!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Nickolay Ilyushin
+
+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,55 @@
+# Particlecmd
+
+A simple command parser for CLI utils and/or bots/whatever
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'particlecmd'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install particlecmd
+
+## Usage
+
+```ruby
+require 'particlecmd'
+
+sample = ParticleCMD::Definition.new 'add' do |d|
+  d.positional 'a', description: 'First value'
+  d.positional 'b', description: 'Second value'
+  
+  d.collect_extra
+
+  d.flag 'multiply', description: 'Multiply instead of adding'
+
+  d.option 'divide', argname: 'X', description: 'Divide the result by X'
+end
+
+require 'shellwords'
+puts (sample.match ParticleCMD::Info.new Shellwords.split '1 2 3 \\\' 4 5 "6 7\' 8" --multiply --divide=123').inspect
+# #<ParticleCMD::Result:0x000056286c6ab630 @extra=["3", "'", "4", "5", "6 7' 8"], @positionals={"a"=>"1", "b"=>"2"}, @flags={"multiply"=>true}, @options={"divide"=>"123"}>
+# returns nil if definition and info do not match
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/handicraftsman/particlecmd.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'particlecmd'
+
+$sample = ParticleCMD::Definition.new 'add' do |d|
+  d.positional 'a', description: 'First value'
+  d.positional 'b', description: 'Second value'
+  
+  d.collect_extra
+
+  d.flag 'multiply', description: 'Multiply instead of adding'
+
+  d.option 'divide', argname: 'X', description: 'Divide the result by X'
+end
+
+require 'shellwords'
+puts ($sample.match ParticleCMD::Info.new Shellwords.split '1 2 3 \\\' 4 5 "6 7\' 8" --multiply --divide=123').inspect
+
+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/lib/particlecmd/definition.rb

@@ -0,0 +1,154 @@
+class ParticleCMD::Definition
+  attr_accessor :name
+  
+  def initialize(name)
+    @name        = name
+    @positionals = []
+    @flags       = []
+    @options     = []
+    @collecting  = false
+    yield self
+  end
+
+  def self.from_string(name, string)
+    d = new name do end
+    string.split.each do |word|
+      if word[0] == '-'
+        i = word.match(/-+(.+?)(=(.+))?$/)
+        if i[3]
+          d.option i[1], argname: i[3]
+        else
+          d.flag i[1]
+        end
+      else
+        d.positional word
+      end
+    end
+    d
+  end
+
+  def description(type, name, desc)
+    case type
+      when :positional
+        @positionals
+      when :flag
+        @flags
+      when :option
+        @options
+      else
+        raise RuntimeError.new "Invalid argument type: #{type}"
+    end.find { |i| i[:name] == name }[:description] = desc
+  end
+
+  def collect_extra
+    @collecting = true
+  end
+
+  def positional(name, **_opts)
+    opts = {
+      name: name,
+      description: ''
+    }.merge _opts
+    @positionals << opts
+  end
+
+  def flag(name, **_opts)
+    opts = {
+      name: name,
+      description: ''
+    }.merge _opts
+    @flags << opts
+  end
+
+  def option(name, **_opts)
+    opts = {
+      name: name,
+      description: '',
+      argname: 'VALUE',
+      default: nil
+    }.merge _opts
+    @options << opts
+  end
+
+  def command_signature(include_name = true)
+    s = ''
+    s << "#{@name} " if include_name
+    @positionals.each do |p|
+      s << "#{p[:name]} "
+    end
+    @flags.each do |f|
+      s << "[--#{f[:name]}] "
+    end
+    @options.each do |o|
+      s << "[--#{o[:name]}=#{o[:argname]}] "
+    end
+    s
+  end
+
+  def command_description
+    s = ''
+
+    nm = [
+      (@positionals.map { |p| p[:name].length }.max or 0),
+      (@flags.map { |f| f[:name].length + 2 }.max or 0),
+      (@options.map { |o| o[:name].length + o[:argname].length + 3 }.max or 0)
+    ].max
+
+    @positionals.each do |p|
+      s << (sprintf "    %*s  %s\n", nm, p[:name], p[:description])
+    end
+    @flags.each do |f|
+      s << (sprintf "    %*s  %s\n", nm, "--#{f[:name]}", f[:description])
+    end
+    @options.each do |o|
+      s << (sprintf "    %*s=%s  %s", nm-2, "--#{o[:name]}", o[:argname], o[:description])
+    end
+    s
+  end
+
+  def help_message
+    'Usage: ' + command_signature + "\nArguments:\n" + command_description
+  end
+
+  def match(info)
+    if @collecting
+      return nil if @positionals.length > info.positionals.length
+    else
+      return nil if @positionals.length != info.positionals.length
+    end
+    return nil if @flags.length < info.flags.length
+    return nil if @options.length < info.options.length
+    return nil unless (info.flags - @flags.map { |f| f[:name] }).empty?
+    return nil unless (info.options.keys - @options.map { |o| o[:name] }).empty?
+    
+    res = ParticleCMD::Result.new
+
+    for i in 0..(@positionals.length - 1) do
+      res.positionals[@positionals[i][:name]] = info.positionals[i]
+    end
+
+    for i in 0..(@flags.length - 1) do
+      n = @flags[i][:name]
+      res.flags[n] = if info.flags.include? n
+        true
+      else
+        false
+      end
+    end
+
+    for i in 0..(@options.length - 1) do
+      n = @options[i][:name]
+      res.options[n] = if info.options.include? n
+        info.options[n]
+      else
+        nil
+      end
+    end
+
+    if @collecting && @positionals.length < info.positionals.length
+      res.extra = info.positionals[@positionals.length, info.positionals.length]
+    end
+
+    res
+  end
+end

data/lib/particlecmd/info.rb

@@ -0,0 +1,21 @@
+class ParticleCMD::Info
+  attr_accessor :positionals, :flags, :options
+  
+  def initialize(argv)
+    @positionals = []
+    @flags       = []
+    @options     = {}
+    argv.each do |word|
+      if word[0] == '-'
+        i = word.match(/-+(.+?)(=(.+))?$/)
+        if i[3]
+          @options[i[1]] = i[3]
+        else
+          @flags << i[1]
+        end
+      else
+        @positionals << word
+      end
+    end
+  end
+end

data/lib/particlecmd/result.rb

@@ -0,0 +1,10 @@
+class ParticleCMD::Result
+  attr_accessor :extra, :positionals, :flags, :options
+  
+  def initialize
+    @extra       = []
+    @positionals = {}
+    @flags       = {}
+    @options     = {}
+  end
+end

data/lib/particlecmd/version.rb

@@ -0,0 +1,3 @@
+module ParticleCMD
+  VERSION = '0.1.0'
+end

data/lib/particlecmd.rb

@@ -0,0 +1,8 @@
+require 'particlecmd/version'
+
+module ParticleCMD
+end
+
+require 'particlecmd/definition'
+require 'particlecmd/info'
+require 'particlecmd/result'

data/particlecmd.gemspec

@@ -0,0 +1,26 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'particlecmd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'particlecmd'
+  spec.version       = ParticleCMD::VERSION
+  spec.authors       = ['Nickolay Ilyushin']
+  spec.email         = ['nickolay02@inbox.ru']
+
+  spec.summary       = 'A command parser'
+  spec.description   = 'A command parser'
+  spec.homepage      = 'https://github.com/handicraftsman/particlecmd'
+  spec.license       = 'MIT'
+
+  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.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: particlecmd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nickolay Ilyushin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: A command parser
+email:
+- nickolay02@inbox.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/particlecmd.rb
+- lib/particlecmd/definition.rb
+- lib/particlecmd/info.rb
+- lib/particlecmd/result.rb
+- lib/particlecmd/version.rb
+- particlecmd.gemspec
+homepage: https://github.com/handicraftsman/particlecmd
+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.7.3
+signing_key: 
+specification_version: 4
+summary: A command parser
+test_files: []