lbq-cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4e54c16efe2254003565d861182a5d37dae35965946f4733c62046a787b04a18
+  data.tar.gz: 96c52f3aca838207f4bb31e10ef4ce6bae4e8e79c9133e1f930687dcd87a062d
+SHA512:
+  metadata.gz: fd8c677ecd62d3ccc3a5eefd6a23dea7f261b0ffda2cedcaede5dc984e685a1c8078a307d06b82bb1187afac88e57001d40bb198e98c8e25aefc9818c091f5a8
+  data.tar.gz: fdff1013211b2cf020f4d49d9021df739fff644bddc415cb9189e03a1ad55d3597783e87837092a7c83c4522520a103aa9b215d5506134ea21a3b3ca19b75624

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in lbq-cli.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    lbq-cli (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.5.0)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  lbq-cli!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 hyrious
+
+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,40 @@
+# Lbq::Cli
+
+Simple command line task runner.
+
+## Installation
+
+    $ gem install lbq-cli
+    $ lbq # create folder and example scripts, show help
+
+## Usage
+
+Put scripts in your `~/lbq/` folder, say `cmd.rb`.
+
+**Note:** on Windows, the home folder is `%UserProfile%`.
+
+    $ lbq cmd [...args]
+
+See example scripts for quick getting started.
+
+See [the doc](https://hyrious.me/lbq-cli) for more scripts.
+
+## 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/hyrious/lbq-cli.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## ChangeLog
+
+#### 0.1.0
+
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lbq/cli"
+
+# 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/docs/index.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>LBQ CLI</title>
+</head>
+<body>
+    Lorem ipsum dolor sit amet, consectetur adipisicing elit. Quidem quas qui voluptatem beatae nostrum delectus ea similique deserunt molestiae! Maxime qui sapiente debitis enim voluptate, quae accusantium recusandae placeat similique.
+</body>
+</html>

data/examples/argv.rb

@@ -0,0 +1,37 @@
+
+params do
+  # switch/option([long_names][, short_names][, description][, options])
+  # the program simply recognizes them by prefix '-'s
+  switch('--switch', '--alias-switch', '-s', 'description', default: false)
+
+  # if specified 'index:', you may pass this argument without '--name=',
+  # $ lbq argv --arg=val
+  # is the same as
+  # $ lbq argv val
+  option('--arg', 'line 1', 'line 2', index: 0)
+
+  # options can have types
+  # "Integer/Float/String" will result in calling Integer(value), etc.
+  # or you can specify a proc to transform string input:
+  # type: -> str { Date.parse str }
+  option('--number', '-n', type: Integer)
+
+  # unknown options/unexpected inputs will be passed to the missing block
+  missing do |raw_str|
+    puts "unknown input: #{raw_str}"
+    (params[:unknown] ||= []) << raw_str
+  end
+end
+
+main do
+  pp params
+  # -s --arg=1 -n=42 -v => {
+  #   switch: true,
+  #   alias_switch: true,
+  #   s: true,
+  #   arg: '1',
+  #   number: 42,
+  #   n: 42,
+  #   unknown: ['-v']
+  # }
+end

data/examples/echo.rb

@@ -0,0 +1,10 @@
+
+params do
+  missing do |raw_str|
+    @word = "#{@word} #{raw_str}"
+  end
+end
+
+main do
+  puts @word.reverse if @word
+end

data/examples/help.rb

@@ -0,0 +1,67 @@
+# lbq help [cmd]
+
+params do
+  option('--command', '--cmd', '-c', 'the command name', index: 0)
+end
+
+main do
+  script_files = Dir.glob(File.expand_path '*.rb', __dir__)
+  commands = script_files.map { |e| File.basename e, '.rb' }
+  if params[:command].nil?
+    puts <<~HINT
+      Run "lbq #{File.basename __FILE__, '.rb'} [cmd]" to see script arguments' descriptions.
+      Valid commands are:
+
+      #{commands.map { |e| "    #{e}" }.join("\n")}
+    HINT
+  else
+    cmd = params[:command]
+    file = File.expand_path "#{cmd}.rb", __dir__
+    if File.exist? file
+      script = <<~RUBY
+        def params
+          puts
+          yield if block_given?
+        end
+
+        def switch *args, default: false
+          args = { '-' => [], '--' => [], '' => [] }.merge args.group_by { |s| s[/^-*/] }
+          args[''].unshift "(default: \#{default})"
+          until args.values.all?(&:empty?)
+            first = args['-'].shift
+            first = "\#{first}," if first
+            printf "%5s %-22s %s\n", first, args['--'].shift, args[''].shift
+          end
+        end
+
+        def option *args, default: nil, index: nil, type: String
+          args = { '-' => [], '--' => [], '' => [] }.merge args.group_by { |s| s[/^-*/] }
+          desc = []
+          desc << "default: \#{default}" if default
+          desc << "index: \#{index}"     if index
+          desc << "type: \#{type}"       if type
+          args[''].unshift "(\#{desc.join(', ')})"
+          until args.values.all?(&:empty?)
+            first = args['-'].shift
+            first = "\#{first}," if first
+            printf "%5s %-22s %s\n", first, args['--'].shift, args[''].shift
+          end
+        end
+
+        def missing
+        end
+
+        def main
+        end
+      RUBY
+      eval <<~RUBY, TOPLEVEL_BINDING.dup, file, -script.lines.size
+        #{script}
+        #{File.read file}
+      RUBY
+    else
+      puts <<~NOTFOUND
+        Not found command "#{cmd}".
+      NOTFOUND
+    end
+  end
+end

data/exe/lbq

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "lbq/cli"
+
+Lbq::Cli.execute *ARGV

data/lbq-cli.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "lbq/cli/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "lbq-cli"
+  spec.version       = Lbq::Cli::VERSION
+  spec.authors       = ["hyrious"]
+  spec.email         = ["hyrious@outlook.com"]
+
+  spec.summary       = %q{lbq cmd --arg -abc --opt=val}
+  spec.description   = %q{Simple command line task runner.}
+  spec.homepage      = "https://hyrious.me/lbq-cli"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/hyrious/lbq-cli"
+  spec.metadata["changelog_uri"] = "https://github.com/hyrious/lbq-cli#changelog"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/lbq/cli/version.rb

@@ -0,0 +1,5 @@
+module Lbq
+  module Cli
+    VERSION = "0.1.0"
+  end
+end

data/lib/lbq/cli.rb

@@ -0,0 +1,224 @@
+# require "lbq/cli/version"
+
+module Lbq
+  module Cli
+    class NotFoundError < StandardError
+      attr_reader :cmd
+      def initialize cmd=nil
+        @cmd = cmd
+        msg = "Not found #{cmd ? "\"#{cmd}\"" : "such command"}"
+        super msg
+      end
+    end
+
+    module Vocab
+      module_function
+
+      def win?
+        Gem.win_platform?
+      end
+
+      def touch
+        win? ? 'type nul >>' : 'touch'
+      end
+
+      def prompt
+        win? ? "#{backslash Dir.home}>" : '$ '
+      end
+
+      def path str
+        ret = File.expand_path str
+        ret = backslash ret if win?
+        ret
+      end
+
+      def paths
+        ret = ENV['PATH']
+        ret = ret && ret.split(File::PATH_SEPARATOR)
+        ret = ret || %w[/usr/local/bin /usr/ucb /usr/bin /bin]
+        ret.select { |path| Dir.exist? path }
+      end
+
+      def exts
+        ret = ENV['PATHEXT']
+        ret = ret && ret.split(File::PATH_SEPARATOR)
+        ret || ['']
+      end
+
+      def which cmd
+        paths.each do |path|
+          exts.each do |ext|
+            exe = File.join(path, "#{cmd}#{ext}")
+            if File.executable? exe
+              return self.path exe
+            end
+          end
+        end
+        nil
+      end
+
+      def editor
+        editors = win? ? %w[subl code notepad] : %w[vim vi emacs nano]
+        editors.each do |exe|
+          return exe if which exe
+        end
+        'EDITOR'
+      end
+
+      def backslash str
+        str.tr '/', '\\'
+      end
+    end
+
+    V = Vocab
+
+    module_function
+
+    def need_init?
+      !Dir.exist? V.path '~/lbq'
+    end
+
+    def copy_file from, to
+      File.open from do |f|
+        File.open to, 'wb', f.stat.mode do |t|
+          IO.copy_stream f, t
+        end
+      end
+    end
+
+    def init_example_scripts
+      files = Dir.glob File.expand_path '../../examples/*', __dir__
+      dist = File.expand_path '~/lbq'
+      Dir.mkdir dist unless Dir.exist? dist
+      files.each do |file|
+        copy_file file, File.join(dist, File.basename(file))
+      end
+      puts <<~HINT
+        Example scripts are placed at #{V.path '~/lbq'},
+        check them for quick getting started.
+
+      HINT
+    end
+
+    # execute 'cmd', '--arg=42', '-a', '--switch'
+    def execute cmd='help', *args
+      init_example_scripts if need_init?
+      raise NotFoundError, cmd unless exist? cmd
+      load_script cmd, *args
+    rescue NotFoundError => e
+      puts <<~HINT
+        Run command below to create [#{e.cmd}],
+
+            #{V.prompt}#{V.touch} #{V.path "~/lbq/#{e.cmd}.rb"}
+            #{V.prompt}#{V.editor} #{V.path "~/lbq/#{e.cmd}.rb"}
+
+        Notice "#{V.prompt}" is the prompt and you don't have to type it.
+      HINT
+    end
+
+    def exist? cmd
+      File.exist? File.expand_path "~/lbq/#{cmd}.rb"
+    end
+
+    def load_script cmd, *argv
+      filename = File.expand_path "~/lbq/#{cmd}.rb"
+      script = <<~RUBY
+        ARGV.clear.push *#{argv.inspect}
+
+        def arg2key arg
+          (arg.start_with?('--') ? arg[2..-1].tr('-', '_') : arg[1..-1]).to_sym
+        end
+
+        def typed value, type=String
+          case
+          when type == String
+            String(value)
+          when type == Integer
+            Integer(value)
+          when type == Float
+            Float(value)
+          when type.respond_to?(:call)
+            type.call(value)
+          else
+            # unknown type
+            value
+          end
+        end
+
+        def params
+          @params ||= {}
+          if block_given?
+            yield
+            @default_options.each do |index, (args, type)|
+              if value = ARGV[index]
+                value = typed value, type
+                args.each do |arg|
+                  key = arg2key arg
+                  params[key] = value
+                end
+                ARGV[index] = nil
+              end
+            end if @default_options
+            ARGV.compact!
+            ARGV.each { |arg| @missing.call arg } if @missing.respond_to? :call
+          end
+          @params
+        end
+
+        def switch *args, default: false
+          args = args.select { |arg| arg.start_with? '-' }
+          if args.any? { |arg| (i = ARGV.index arg) and (ARGV.delete_at i) }
+            args.each do |arg|
+              key = arg2key arg
+              params[key] = !default
+            end
+            !default
+          else
+            default
+          end
+        end
+
+        def option *args, default: nil, index: nil, type: String
+          raw_str = ''
+          args = args.select { |arg| arg.start_with? '-' }
+          args.each do |arg|
+            key = arg2key arg
+            params[key] = default
+          end if default
+          if args.any? { |arg| (i = ARGV.index { |a| a.start_with? "\#{arg}=" }) and (raw_str = ARGV.delete_at i) }
+            value = typed (raw_str.split('=')[1] || default), type
+            args.each do |arg|
+              key = arg2key arg
+              params[key] = value
+            end
+            value
+          elsif args.any? { |arg| (i = ARGV.index arg) and ARGV[i + 1] and ARGV[i + 1][0] != '-' and (ARGV.delete_at i) and (raw_str = ARGV.delete_at i) }
+            value = typed (raw_str || default), type
+            args.each do |arg|
+              key = arg2key arg
+              params[key] = value
+            end
+            value
+          elsif index
+            @default_options ||= {}
+            @default_options[index] = [args, type]
+          else
+            nil
+          end
+        end
+
+        def missing &blk
+          @missing = blk
+        end
+
+        def main
+          yield
+        end
+      RUBY
+      eval <<~RUBY, TOPLEVEL_BINDING.dup, filename, -script.lines.size
+        #{script}
+        #{File.read filename}
+      RUBY
+    end
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: lbq-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hyrious
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: Simple command line task runner.
+email:
+- hyrious@outlook.com
+executables:
+- lbq
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docs/index.html
+- examples/argv.rb
+- examples/echo.rb
+- examples/help.rb
+- exe/lbq
+- lbq-cli.gemspec
+- lib/lbq/cli.rb
+- lib/lbq/cli/version.rb
+homepage: https://hyrious.me/lbq-cli
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://hyrious.me/lbq-cli
+  source_code_uri: https://github.com/hyrious/lbq-cli
+  changelog_uri: https://github.com/hyrious/lbq-cli#changelog
+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.0.4
+signing_key: 
+specification_version: 4
+summary: lbq cmd --arg -abc --opt=val
+test_files: []