argsy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 88526113ba2dd53ad74e38032ff79b7779e1aed1d45f7717405e850cc4b5ba83
+  data.tar.gz: a4a5fc03b8c24c355cd8dd9b59db891b4c90d36846f07602742f1ed46fa072ac
+SHA512:
+  metadata.gz: 2f64292c7aea41e91ba44eb0cde25aab733282aba5744e2b396a9e907b1501d892385d4dda3244fdc5c88a2f033b1c2de6016f2be10ecc840b2615615b60ab1e
+  data.tar.gz: '0789bbc4c7047c9e696f913b1868d1d7dd9ca1b77bbbcfe9d04b911f49bdee3a1524a85b6ff6ebbdab08eeda2320b6182538952cfd57ce557a10cd72e2b0e944'

data/LICENSE.txt

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org>

data/README.md

@@ -0,0 +1,111 @@
+# Argsy
+
+Tiny helper snippet you can paste into your CLI script(s) to obtain "commands + options" DSL without
+external dependencies.
+
+[![Build](https://travis-ci.org/kolotaev/argsy.svg?branch=master)](https://travis-ci.org/kolotaev/argsy)
+[![License](https://upload.wikimedia.org/wikipedia/commons/e/ee/Unlicense_Blue_Badge.svg)](https://raw.githubusercontent.com/kolotaev/argsy/master/LICENSE.txt)
+
+## Rationale
+
+As you already know, Ruby is awesome for scripting and any sort of CLI tools: it gives you a superb OS commands 
+interaction interface, JSON/YAML parsing, HTTP tools, etc... All out of the box! But built-in `OptionParser` doesn't
+provide easy-to-write functionality to create CLIs like `./script command --option 1`. The problem here is: how to
+declare command, action and options conveniently?
+
+> Sometimes, for any imaginable reason, you do not want you script to be dependent on external gems (say, you want to
+> pass a script that "just works!" to your co-workers without telling them "Hey, you also need to install this or that 
+> gem")
+
+`Argsy` gives you such possibility. It's [just 17 lines of code](lib/argsy.rb), published under `The Unlicense`, 
+so you can just copy-paste it inside your script and have a nice 
+tiny DSL. You can of course use it as a gem as well, if you want to.
+
+**Disclaimer**: `Argsy` doesn't claim itself as a profound CLI DSL like `Thor` and the company, 
+thus for complex scripts, please, opt for those gems instead.
+
+## Usage
+
+```ruby
+Argsy.new '1.0.0' do
+  command :list, 'List all files' do
+    action do |o|
+      puts %w(. .. .hidden.py).join("\n") if o[:all]
+      puts %w(todos.txt recipes.doc).join("\n")
+      puts "me.#{o[:extension]}" if o[:extension]
+    end
+    options do
+      on '-a', '--all', 'Show all, even hidden files'
+      on '-e', '--extension EXTENSION', 'List available files with extension'
+    end
+  end
+  
+  command 'print', 'Print all given options' do
+    action &method(:puts)
+    options do
+      on '-a', '--A', 'A option'
+      on '-b', 'B option'
+    end
+  end
+  
+  command 'hello:world', 'Greet the World group without options' do
+    action { puts 'Hello world!' }
+  end
+  
+  command :post do |c|
+    action do |opts|
+      puts "I'm a command without description"
+      puts "Posting to facebook: #{opts[:message]}" if opts[:facebook]
+      puts "Posting to twitter: You're Tearing Me Apart, Lisa!" if opts[:twitter]
+      puts "Date and time posted: #{opts[:date]}"
+    end
+    options do
+      require 'optparse/time'
+      on_tail '-d', '--date=DATE', Time, 'Date when message was posted'
+      on '-f', '--facebook' do
+        c.opts[:message] = 'Oh, Hi Mark'
+      end
+      on '-t', '--twitter'
+    end
+  end
+end.run
+```
+
+In console:
+```
+$ ./example
+Usage: playground CMD [--help] [--version]
+    list                             List all files
+    print                            Print all given options
+    hello                            Greet the World without options
+    post                             
+
+$ ./example post --help
+Usage: playground post [options] [--help]
+    -f, --facebook
+    -t, --twitter
+    -d, --date=DATE                  Date when message was posted
+
+$ ./example post -f -d 12-8-2016
+I'm a command without description
+Posting to facebook: Oh, Hi Mark
+Date and time posted: 2016-08-12 00:00:00 +0300
+
+
+$ ./example post --version
+example version 1.0.0
+```
+
+## FAQ
+
+| Q:       | A:          |
+| ------------- |-------------|
+| Does it support groups/subcommands?      | Only in a way of declaring commands as `'group:subcommand'`      |
+| What can I do inside options block?      | Anything that is possible inside a stdlib's `OptionParser`      |
+| Why not Thor, Commander, etc.?     | See rationale |
+| Can I use it as a gem?    | Yes. `gem install argsy` |
+| Why does it look like a minified jQuery?      | Yes, it's not an idiomatic Ruby formatting. I wanted to make it terse, still readable |
+| Copy-pasting is bad. It's not DRY!      | Absolutely agree with you |
+
+## License
+The Unlicense

data/argsy.gemspec

@@ -0,0 +1,17 @@
+lib = 'lib/argsy.rb'
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.authors = ['Egor Kolotaev']
+  spec.summary = 'Tiny "commands & options" DSL for your CLI scripts'
+  spec.email = %w(ekolotaev@gmail.com)
+  spec.homepage = 'https://github.com/kolotaev/argsy'
+  spec.license = 'The Unlicense'
+  spec.name = 'argsy'
+  spec.require_paths = [lib]
+  spec.required_ruby_version = '>= 2.4.5'
+  spec.description = spec.summary
+  spec.files = %w(LICENSE.txt README.md argsy.gemspec) + Dir[lib]
+  spec.version = '0.1.0'
+end

data/lib/argsy.rb

@@ -0,0 +1,17 @@
+require 'optparse'
+class Argsy
+  class Command
+    attr_reader :name, :desc, :do_it, :op, :opts
+    def initialize(name, desc, &bl) @name, @desc, @op, @opts = name, desc, OptionParser.new, {}; instance_eval(&bl) end
+    def options(&bl) @op.banner = "Usage: #{op.program_name} #{@name} [options] [--help]"; @op.instance_eval(&bl) end
+    def action(&block) @do_it = block end
+    def to_s() ' ' * 4 + @name + ' ' * (33 - @name.length).abs + @desc end
+  end
+  def initialize(ver='0.0.1', &bl) @name = File.basename($0, '.*'); @ver = ver; @cmds = {}; instance_eval(&bl) end
+  def command(name, desc='', &bl) @cmds[name.to_s] = Command.new(name.to_s, desc, &bl) end
+  def run(a=ARGV)
+    (puts "#{@name} version #{@ver}"; exit) if a == ['--version']
+    (puts "Usage: #{@name} CMD [--help] [--version]\n" + @cmds.values.map(&:to_s).join("\n"); exit) if !@cmds.key?(a[0])
+    c = @cmds[a[0]]; c.op.parse(a, into: c.opts); c.do_it.call(c.opts)
+  end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: argsy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Egor Kolotaev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-08 00:00:00.000000000 Z
+dependencies: []
+description: Tiny "commands & options" DSL for your CLI scripts
+email:
+- ekolotaev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- argsy.gemspec
+- lib/argsy.rb
+homepage: https://github.com/kolotaev/argsy
+licenses:
+- The Unlicense
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib/argsy.rb
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.5
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Tiny "commands & options" DSL for your CLI scripts
+test_files: []