mister_bin 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f1363a49f614a04f932d61c6e52efbb9266a7c68605d3c232e95eb8b75fec9f7
+  data.tar.gz: dc34308fd4e779d20488e365895a4e3ef64c87290a20e1874fb1583687dcd8eb
+SHA512:
+  metadata.gz: d2e2f3a8fe7799258c4995c36f9bef36a92c69977ed46e36537e53a9b0db40f402aece3fad632e1acd0827f12be086603fe55785809eeeaf323e4fda5cc44e4e
+  data.tar.gz: 786af8b7fe27061c2232166ba49d656c3c7972039bd3303f81a7b63a0b242496820c1f8b0f37c8ad739e74d9e6828446090339c55d45a528dfbcf12f4c380ef2

data/README.md

@@ -0,0 +1,33 @@
+Mister Bin
+==================================================
+
+[![Gem](https://img.shields.io/gem/v/mister_bin.svg?style=flat-square)](https://rubygems.org/gems/mister_bin)
+[![Build](https://img.shields.io/travis/DannyBen/mister_bin.svg?style=flat-square)](https://travis-ci.org/DannyBen/mister_bin)
+[![Maintainability](https://img.shields.io/codeclimate/maintainability/DannyBen/mister_bin.svg?style=flat-square)](https://codeclimate.com/github/DannyBen/mister_bin)
+
+---
+
+Build modular command line utilities.
+
+---
+
+Installation
+--------------------------------------------------
+
+    $ gem install mister_bin
+
+
+
+Design Goals
+--------------------------------------------------
+
+- Provide an easy and minimalistic DSL for building command line utilities.
+- Provide a mechanism for separating each subcommand to its separate file.
+- Support the ability to extend a given command from different sources.
+
+
+
+Usage
+--------------------------------------------------
+
+Soon

data/lib/mister_bin/command.rb

@@ -0,0 +1,21 @@
+module MisterBin
+  class Command
+    attr_reader :command, :file, :type
+
+    def initialize(command, file)
+      @command = command
+      @file = file
+      @type = command =~ / / ? :secondary : :primary
+    end
+
+    def run(argv=[])
+      script = Script.new file
+      script.build_docopt
+      script.execute argv
+    end
+
+    def argv
+      command.split ' '
+    end
+  end
+end

data/lib/mister_bin/commands.rb

@@ -0,0 +1,52 @@
+module MisterBin
+
+  # This class handles listing and finding command files
+  class Commands
+    attr_reader :basename, :basedir
+
+    def initialize(basename, basedir='.')
+      @basename = basename
+      @basedir = basedir
+    end
+
+    def all
+      @all ||= all!
+    end
+
+    def names
+      all.keys
+    end
+
+    def find(query)
+      query = [query] unless query.is_a? Array
+      query_regex = /^#{query.join '.* '}/
+      keys = names.select { |k| k =~ /^#{query_regex}/ }
+      keys = names.select { |k| k =~ /^#{query.first}/ } if keys.empty?
+      keys.map { |k| [k, all[k]] }.to_h
+    end
+
+    def find_one(query)
+      result = find query
+      result.size == 1 ? result.values.first : false
+    end
+
+    private
+
+    def all!
+      result = {}
+      files.map do |file|
+        if file =~ /#{basename}-(.+)-(.+)\.rb/
+          command = "#{$1} #{$2}"
+        elsif file =~ /#{basename}-(.+)\.rb/
+          command = $1
+        end
+        result[command] = Command.new command, file
+      end
+      result
+    end
+
+    def files
+      @files ||= Dir["#{basedir}/#{basename}-*.rb"]
+    end
+  end
+end

data/lib/mister_bin/docopt_maker.rb

@@ -0,0 +1,66 @@
+require 'singleton'
+require 'colsole'
+
+module MisterBin
+
+  # This singleton class is responsible for generating a text string ready to be used
+  # by Docopt. 
+  class DocoptMaker
+    include Singleton
+    include Colsole
+
+    attr_reader :usages, :options, :examples
+    attr_accessor :help, :version
+
+    def initialize
+      reset
+    end
+
+    def reset
+      @usages = []
+      @options = []
+      @examples = []
+      @version = '0.0.0'
+      @help = nil
+    end
+
+    def docopt
+      [help_string, usage_string, options_string, examples_string].join "\n"
+    end
+
+    private
+
+    def help_string
+      word_wrap help
+    end
+
+    def usage_string
+      result = ["", "Usage:"]
+      usages.each { |text| result << word_wrap("  #{text}") }
+      result.join "\n"
+    end
+
+    def options_string
+      result = ["", "Options:"]
+      options.each do |option|
+        result << "  #{option[0]}"
+        result << word_wrap("    #{option[1]}")
+        result << ""
+      end
+
+      result << "  -h --help"
+      result << "    Show this help\n"
+      result << "  --version"
+      result << "    Show version number"
+      result.join "\n"
+    end
+
+    def examples_string
+      return '' if examples.empty?
+
+      result = ["", "Examples:"]
+      examples.each { |text| result << word_wrap("  #{text}") }
+      result.join "\n"
+    end
+  end
+end

data/lib/mister_bin/runner.rb

@@ -0,0 +1,66 @@
+module MisterBin
+  class Runner
+    attr_reader :basefile, :basedir, :name
+
+    def self.run(basefile, argv=[])
+      new(basefile).run argv
+    end
+
+    def initialize(basefile)
+      @basefile = basefile
+      @basedir = File.dirname basefile
+      @name = File.basename basefile
+    end
+
+    def run(argv=[])
+      if argv.empty?
+        show_subs
+      else
+        execute argv
+      end
+    end
+
+    private
+
+    def execute(argv)
+      argv = expand_argv argv
+      command = commands.find_one argv[0..1]
+
+      if command
+        execute_command command, argv
+      else
+        puts "Unknown command: #{argv[0]}"
+        return 1
+      end
+    end
+
+    def execute_command(command, argv)
+      command.run argv
+    end
+
+    def show_subs
+      if commands.all.empty?
+        puts "No subcommands found"
+      else
+        puts "Usage:"
+        commands.names.each { |command| puts "  #{name} #{command}" }
+      end
+
+      return 1
+    end
+
+    def commands
+      @commands ||= Commands.new name, basedir
+    end
+
+    def expand_argv(argv)
+      command = commands.find_one argv[0..1]
+      if command
+        argv.shift command.argv.size
+        command.argv + argv
+      else
+        argv
+      end
+    end
+  end
+end

data/lib/mister_bin/script.rb

@@ -0,0 +1,62 @@
+require 'docopt'
+
+module MisterBin
+  class Script
+    attr_reader :file, :action_block
+
+    def initialize(file)
+      @file = file
+    end
+
+    def build_docopt
+      DocoptMaker.instance.reset
+      instance_eval script
+      docopt
+    end
+
+    def execute(argv=[])
+      args = Docopt.docopt docopt, version: DocoptMaker.instance.version, argv: argv
+      exitcode = action_block.call args if action_block
+      exitcode.is_a?(Numeric) ? exitcode : 0
+    rescue Docopt::Exit => e
+      puts e.message
+      1
+    end
+
+    def docopt
+      DocoptMaker.instance.docopt
+    end
+
+    # DSL
+
+    def help(text)
+      DocoptMaker.instance.help = text
+    end
+
+    def usage(text)
+      DocoptMaker.instance.usages << text
+    end
+
+    def option(flags, text)
+      DocoptMaker.instance.options << [flags, text]
+    end
+
+    def example(text)
+      DocoptMaker.instance.examples << text
+    end
+
+    def version(text)
+      DocoptMaker.instance.version = text
+    end
+
+    def action(&block)
+      @action_block = block
+    end
+
+    private
+
+    def script
+      @script ||= File.read file
+    end
+  end
+end

data/lib/mister_bin/version.rb

@@ -0,0 +1,3 @@
+module MisterBin
+  VERSION = "0.0.1"
+end

data/lib/mister_bin.rb

@@ -0,0 +1,8 @@
+require 'mister_bin/commands'
+require 'mister_bin/command'
+require 'mister_bin/runner'
+
+require 'mister_bin/script'
+require 'mister_bin/docopt_maker'
+
+require 'byebug' if ENV['BYEBUG']

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: mister_bin
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Danny Ben Shitrit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colsole
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: docopt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rspec_fixtures
+  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: runfile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: runfile-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+description: Build pluggable and modular command line tools with subcommands
+email: db@dannyben.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/mister_bin.rb
+- lib/mister_bin/command.rb
+- lib/mister_bin/commands.rb
+- lib/mister_bin/docopt_maker.rb
+- lib/mister_bin/runner.rb
+- lib/mister_bin/script.rb
+- lib/mister_bin/version.rb
+homepage: https://github.com/dannyben/mister_bin
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+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: Modular command line framefowk
+test_files: []