completely 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd3ae4ec92d7318bd4ef32fdd465d9bff3341931f5f965d2db8f263c1b95e38b
-  data.tar.gz: 01ccb2fa2e1f050b7a45944b552590fad6aab9bafc90ef4cb98b8d6284200392
+  metadata.gz: ba5123d5b0bf95ed7ea2140188a6079e0510456a754d5fd93830df1382862274
+  data.tar.gz: 0f98b90e1515d753b94817932916aad966b8b3f81ede79f1bbb40a898b82662e
 SHA512:
-  metadata.gz: fd06256b9cb4c42364d118ea1392b180ef662e98b2ea9c6b24ca815f5fa5cf1f16d6c0a6792090c9bc5f376ab7dfb04e9b8c732cb83292140acb59676d6090a9
-  data.tar.gz: b1985849259627803ebe3f7c56b4adc98137456b172fb36cbf1379b4677257dca6cc671d85a12106596fb246de02aad07c5e9d51c5dd0abc7301518d9b7529b2
+  metadata.gz: e3618affd00e4a624b288ae7c37fd0d857fd9cf0672d6bcc8c558eb7870e2e3001e86a1c6997bc177def3b245bdc1142287539d99423dc175f6e208a9bf8a3b9
+  data.tar.gz: a34bc567cbf492e437168afeb0a509f392eb1600a49622136d50728a936c024ad90e757d3a3ede18b0b7204302b09e08567054c73f75ea03fd3cdea9d39074e3

data/README.md

@@ -2,13 +2,14 @@
 
 [![Gem Version](https://badge.fury.io/rb/completely.svg)](https://badge.fury.io/rb/completely)
 [![Build Status](https://github.com/DannyBen/completely/workflows/Test/badge.svg)](https://github.com/DannyBen/completely/actions?query=workflow%3ATest)
+[![Maintainability](https://api.codeclimate.com/v1/badges/6c021b8309ac796c3919/maintainability)](https://codeclimate.com/github/DannyBen/completely/maintainability)
 
 ---
 
 Completely is a command line utility and a Ruby library that lets you generate
 bash completion scripts from simple YAML configuration.
 
-This tool is for you it:
+This tool is for you if:
 
 1. You develop your own command line tools.
 2. Your life feels empty without bash completions.
@@ -19,11 +20,11 @@ This tool is for you it:
 
 ## Install
 
-```
+```bash
 $ gem install completely
 ```
 
-## Usage
+## Using the `completely` command line
 
 The `completely` command line works with a simple YAML configuration file as
 input, and generates a bash completions script as output.
@@ -78,7 +79,7 @@ follows it will be suggested as completions.
 
 To generate the bash script, simply run:
 
-```
+```bash
 $ completely generate
 
 # or, to just preview it without saving:
@@ -87,7 +88,7 @@ $ completely preview
 
 For more options (like setting input/output path), run
 
-```
+```bash
 $ completely --help
 ```
 
@@ -107,17 +108,36 @@ simply be added using the [`compgen -A action`][compgen] function, so you can
 in fact use any of its supported arguments.
 
 
-### Using the generated completion scripts
+## Using the generated completion scripts
 
 In order to enable the completions, simply source the generated script:
 
-```
+```bash
 $ source completely.bash
 ```
 
 You may wish to add this to your `~/.bashrc` file to enable this for future
 sessions (just be sure to use absolute path).
 
+## Using from within Ruby code
+
+```ruby
+require 'completely'
+
+# Load from file
+completions = Completely::Completions.load "input.yaml"
+
+# Or, from a hash
+input = {
+  "mygit" => %w[--help --version status init commit],
+  "mygit status" => %w[--help --verbose --branch]
+}
+completions = Completely::Completions.new input
+
+# Generate the script
+puts completions.script
+```
+
 
 ## Contributing / Support
 

data/lib/completely.rb

@@ -1,5 +1,3 @@
-require 'requires'
-
 if ENV['BYEBUG']
   require 'byebug'
   require 'lp'

data/lib/completely/cli.rb

@@ -1,6 +1,6 @@
 require 'mister_bin'
-require 'completely/command'
 require 'completely/version'
+require 'completely/command'
 
 module Completely
   class CLI

data/lib/completely/version.rb

@@ -1,3 +1,3 @@
 module Completely
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: completely
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
-- !ruby/object:Gem::Dependency
-  name: requires
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
 description: Generate bash completion scripts using simple YAML configuration
 email: db@dannyben.com
 executables: