bashly 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4a6b6397239e1fc2b30d3f7cace59aa6bff9b305cfad97b43567dd49cd9eeb8
-  data.tar.gz: 27eb14cc3d2f833dec9e218b3affc0e5d90fc0a4cb258e769127590b501a50ac
+  metadata.gz: e4dbc588718b280b13a81c8adbd2f4f86da7ec536baf3666d58592bfb2854ac5
+  data.tar.gz: 867936a132914810eb18cfb6b3ce10d36844c1e20ed348279374d4c2f2311bc7
 SHA512:
-  metadata.gz: 0d907d581476cd66f71078319e1d1290f824d2fbbeac6315cd54988ce1068daf59c31e8ab383b498e7aae4955b7d3b2c225e3a3c701aead077527266d7e7dbe5
-  data.tar.gz: 8ca10f7db1dd3f2fb03909e60b32f858220b85fd3a961d5c8c2b19e19026238fbce5a1c99ac66b8f3949e217ebdd0cd107cb430d74ff060f4e960f511ab9c6a5
+  metadata.gz: a1d3adacfcc29c6d74a0bbaa9ff339ce6150d1035588d2641f9094c486a572111c205e1d233bd9023e44e56c1f2c8e223488d34b5c3427f67b1291c7478598f5
+  data.tar.gz: 70884518d2343dd3915f03ecd0cf46809324c1a026fc28f9245ae57bd7e2587a5fb4a9a6e7a4cd5137b9d8110a28bb415658de48c7eb63d58e3b27bd4cb64403

data/README.md

@@ -1,8 +1,14 @@
-Bashly - Bbash CLI Generator
+Bashly - Bash CLI Generator
 ==================================================
 
 Create beautiful bash scripts from simple YAML configuration.
 
+[![Gem Version](https://badge.fury.io/rb/bashly.svg)](https://badge.fury.io/rb/bashly)
+[![Build Status](https://travis-ci.com/DannyBen/bashly.svg?branch=master)](https://travis-ci.com/DannyBen/bashly)
+[![Maintainability](https://api.codeclimate.com/v1/badges/8cf89047e50ca601e431/maintainability)](https://codeclimate.com/github/DannyBen/bashly/maintainability)
+
+---
+
 ![demo](demo/cast.svg)
 
 ---
@@ -41,8 +47,196 @@ get their own file. Once you edit, run `bashly generate` again to merge the
 content from your functions back into the script.
 
 
+Examples
+--------------------------------------------------
+
+The `bashly.yml` file can be set up to generate two types of scripts:
+
+1. Script with subcommands (for example, like `docker` or `git`).
+2. Script without subcommands (for example, like `ls`)
+
+This is detected automatically by the contents of the configuration: If it
+contains a `commands` definition, it will generate a script with subcommands.
+
+
+### Sample configuraiton for a script without subcommands
+
+You can get this script by running `bashly generate --minimal`.
+
+```yaml
+name: download
+help: Sample minimal application without subcommands
+version: 0.1.0
+
+args:
+- name: source
+  required: true
+  help: URL to download from
+- name: target
+  help: "Target filename (default: same as source)"
+
+flags:
+- long: --force
+  short: -f
+  help: Overwrite existing files
+```
+
+
+### Sample configuraiton for a script with subcommands
+
+You can get this script by running `bashly generate`.
+
+```yaml
+name: cli
+help: Sample application
+version: 0.1.0
+
+commands:
+- name: download
+  short: d
+  help: Download a file
+
+  args:
+  - name: source
+    required: true
+    help: URL to download from
+  - name: target
+    help: "Target filename (default: same as source)"
+
+  flags:
+  - long: --force
+    short: -f
+    help: Overwrite existing files
+
+- name: upload
+  short: u
+  help: Upload a file
+  args:
+  - name: source
+    required: true
+    help: File to upload
+
+  flags:
+  - long: --user
+    short: -u
+    arg: user
+    help: Username to use for logging in
+    required: true
+  - long: --password
+    short: -p
+    arg: password
+    help: Password to use for logging in
+```
+
+
+Configuration Reference
+--------------------------------------------------
+
+### Command options
+
+With the exception of `version` and `commands` (shich define subcommands),
+everything else in this section is suitable both for the main script, and for
+any subcommand you define using `commands`.
+
+```yaml
+# The name of the script or subcommand
+name: myscript
+
+# The header text to display when using --help
+# This can have multiple lines. In this case, the first line will be used as
+# summary wherever appropriate.
+help: a sample script generated with bashly
+
+# The string to display when using --version
+version: 0.1.0
+
+# Specify the array of subcommands to generate.
+# Each subcommand will have its own args and flags.
+# If this is provided, then you cannot provide flags or args for the main
+# script.
+commands: 
+- ...
+
+# Specify the array of positional arguments this script needs.
+# If this is provided, then you cannot provide commands for the main script.
+args:
+- ...
+
+# Specify the array of option flags this script needs.
+# If this is provided, then you cannot provide commands for the main script.
+flags:
+- ...
+```
+
+
+### Argument options
+
+The below configuration generates this argument:
+
+```
+  Usage: 
+    myscript USER
+
+  Arguments:
+    USER
+      Username to use for logging in
+```
+
+The argument's value will be available to you as `${args[user]}` in your 
+bash function.
+
+```yaml
+# The name of the argument.
+name: user
+
+# The message to display when using --help.
+# This can have multiple lines, but it is recommended to keep lines shorter
+# than ~70 characters, to avoid text wrapping in narrower terminals.
+help: Username to use for logging in
+
+# Specify if this argument is required.
+# Note that once you define an optional argument (without required: true)
+# then you cannot define required arguments after it.
+required: true
+```
+
+### Flag options
+
+The below configuration generates this flag:
+
+```
+   -o, --output DIRECTORY (required)
+     Specify the output directory
+```
+
+The flags's value will be available to you as `${args[--output]}` in your 
+bash function (regardless of whether the user provided ut with the long or 
+short form).
+
+```yaml
+# The long form of the flag.
+long: --output
+
+# The short form of the flag.
+short: -o
+
+# The text to display when using --help
+# This can have multiple lines, but it is recommended to keep lines shorter
+# than ~70 characters, to avoid text wrapping in narrower terminals.
+help: Specify the output directory
+
+# If the flag requires an argument, specify its name here.
+arg: directory
+
+# Specify if this flag is required.
+required: true
+```
+
 Contributing / Support
 --------------------------------------------------
 
 If you experience any issue, have a question or a suggestion, or if you wish
 to contribute, feel free to [open an issue][issues].
+
+[issues]: https://github.com/DannyBen/bashly/issues
+

data/lib/bashly.rb

@@ -5,6 +5,7 @@ if ENV['BYEBUG']
   require 'lp'
 end
 
+requires 'bashly/polyfills'
 requires 'bashly/settings'
 requires 'bashly/exceptions'
 requires 'bashly/concerns'

data/lib/bashly/commands/generate.rb

@@ -1,4 +1,5 @@
 require 'mister_bin'
+require 'fileutils'
 
 module Bashly
   module Commands
@@ -47,6 +48,7 @@ module Bashly
       def create_master_script
         master_script = command.render 'master_script'
         File.write master_script_path, master_script
+        FileUtils.chmod "+x", master_script_path
         say "created !txtgrn!#{master_script_path}"
       end
 

data/lib/bashly/polyfills/hash.rb

@@ -0,0 +1,10 @@
+# :nocov:
+
+# Required for Ruby < 2.4
+if !Dir.respond_to? :empty?
+  class Dir
+    def self.empty?(path_name)
+      exist?(path_name) && (entries(path_name) - ['.', '..']).empty?
+    end
+  end
+end

data/lib/bashly/version.rb

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

data/lib/bashly/views/command/inspect_args.erb

@@ -1,5 +1,5 @@
 # :command.inspect_args
 inspect_args() {
   echo args:
-  for k in "${!args[@]}"; do echo "- \${args[$k]}" = ${args[$k]}; done
+  for k in "${!args[@]}"; do echo "- \${args[$k]} = ${args[$k]}"; done
 }

data/lib/bashly/views/command/master_script.erb

@@ -1,4 +1,6 @@
 #!/usr/bin/env bash
+# This script was generated by bashly (https://github.com/DannyBen/bashly)
+# Modifying it manually is not recommended
 
 <%= render :root_command if commands.empty? %>
 <%= render :version_command %>

data/lib/bashly/views/command/parse_args_case.erb

@@ -8,10 +8,10 @@
 <%- condition = "elif" -%>
 <%- end -%>
 else
-  echo invalid argument: $key
+  echo "invalid argument: $key"
   exit 1
 fi
 <%- else -%>
-echo invalid argument: $key
+echo "invalid argument: $key"
 exit 1
 <%- end -%>

data/lib/bashly/views/command/parse_args_while.erb

@@ -8,7 +8,7 @@ while [[ $# -gt 0 ]]; do
   <%- end -%>
 
   -* )
-    echo invalid option: $key
+    echo "invalid option: $key"
     exit 1
     ;;
 

data/lib/bashly/views/command/required_args_filter.erb

@@ -4,8 +4,8 @@ if [[ $1 && $1 != -* ]]; then
   args[<%= arg.name %>]=$1
   shift
 else
-  echo missing required argument: <%= arg.name.upcase %>
-  echo Usage: <%= usage_string %>
+  echo "missing required argument: <%= arg.name.upcase %>"
+  echo "Usage: <%= usage_string %>"
   exit 1
 fi
 

data/lib/bashly/views/command/required_flags_filter.erb

@@ -1,6 +1,9 @@
 # :command.required_flags_filter
+<%- if required_flags.any? -%>
+argstring="$*"
+<%- end -%>
 <%- required_flags.each do |flag| -%>
-if [[ <%= flag.aliases.map { |a| "$* != *#{a}*" }.join " && " %> ]]; then
+if [[ <%= flag.aliases.map { |a| %Q["$argstring" != *#{a}*] }.join " && " %> ]]; then
   echo "missing required flag: <%= flag.usage_string %>"
   exit 1
 fi

data/lib/bashly/views/command/version_command.erb

@@ -1,4 +1,4 @@
 # :command.version_command
 version_command() {
-  echo $version
+  echo "$version"
 }

data/lib/bashly/views/flag/case.erb

@@ -6,7 +6,7 @@
     shift
     shift
   else
-    echo <%= long %> requires an argument: <%= usage_string %>
+    echo "<%= long %> requires an argument: <%= usage_string %>"
     exit 1
   fi
   <%- else -%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-19 00:00:00.000000000 Z
+date: 2019-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: mister_bin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: requires
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +75,7 @@ files:
 - lib/bashly/models/base.rb
 - lib/bashly/models/command.rb
 - lib/bashly/models/flag.rb
+- lib/bashly/polyfills/hash.rb
 - lib/bashly/settings.rb
 - lib/bashly/templates/bashly.yml
 - lib/bashly/templates/minimal.yml