clasp-ruby 0.23.0.1 → 0.23.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e021c90f3ea92340418a827f98a4fcb3c3f1369b023b0374f90e224acb8f01c
-  data.tar.gz: 62ed469712505ebbf289e7b642e48525f37f21dc1223cf8f13dca107f3b1a1f4
+  metadata.gz: 6116d56077b53fd8d42a2f1275e08d5921982e2d4ffe425e9df637d6a7d97861
+  data.tar.gz: 778800e1fcacd3b7ccbb6911c3251c5fcca73fef3447c01318b458c36ef7472a
 SHA512:
-  metadata.gz: 462eca92c73b9eefd0846cb64567d1b2071570789c0beb6cc0802e443e1e6a3c762ec39f57e438781d0b53e8d31310dc765a8e108d77ff989795d24bae7c1239
-  data.tar.gz: e7b1b47f51ea4e724412e2ffa634a1e8e47118f00f32b133735656c98f0e9b18c3286b1b77ba7e409545340e248b50c187c1939e6275a34ee36025ad17eb7b81
+  metadata.gz: 56d7aa277b5f5441c9472d0bb1e8961ccd577ae6477e3ec82f5a932aa6033aa3bbd4506d290e664a4f74c1f2cf9915fb4bb7b41606f884a32e1f7a29dec0ab20
+  data.tar.gz: 33474797746dfe908b5d083d4aaedf4922d9b2cd990b0264595f557c1075d70ef0aa07d0940e1d3ed94869c0a70b999fdc3a3677f64145b2b2e6578afd904f13

data/README.md

@@ -1,32 +1,40 @@
-# CLASP.Ruby
+# CLASP.Ruby <!-- omit in toc -->
 Command-Line Argument Sorting and Parsing, for Ruby
 
 [![Gem Version](https://badge.fury.io/rb/clasp-ruby.svg)](https://badge.fury.io/rb/clasp-ruby)
 
-## Table of Contents
-
-1. [Introduction](#introduction)
-2. [Installation](#installation)
-3. [Components](#components)
-4. [Examples](#examples)
-5. [Project Information](#project-information)
+## Table of Contents <!-- omit in toc -->
+
+- [Introduction](#introduction)
+    - [libCLImate.Ruby](#libclimateruby)
+- [Installation](#installation)
+- [Components](#components)
+    - [Command-line parsing](#command-line-parsing)
+    - [Declarative specification of the flags and options for a CLI](#declarative-specification-of-the-flags-and-options-for-a-cli)
+    - [Utility functions for displaying usage and version information](#utility-functions-for-displaying-usage-and-version-information)
+- [Examples](#examples)
+- [Project Information](#project-information)
+    - [Where to get help](#where-to-get-help)
+    - [Contribution guidelines](#contribution-guidelines)
+    - [Related projects](#related-projects)
+    - [License](#license)
 
 ## Introduction
 
-**CLASP** stands for Command-Line Argument Sorting and
-Parsing. The first CLASP library was a C library with a C++ wrapper. There
-have been several implementations in other languages. **CLASP.Ruby** is the
-Ruby version.
+**CLASP** stands for **C**ommand-**L**ine **A**rgument **S**orting and **P**arsing. The first **CLASP** library was a C library with a C++ wrapper (see project [**CLASP**](https://github.com/synesissoftware/CLASP/)). There have been several implementations in other languages (as listed in [Relation projects](#related-projects)). **CLASP.Ruby** is the Ruby version.
+
+All **CLASP** libraries provide the facilities to **C**ommand **L**ine **I**nterface (**CLI**) programs as described in detail below.
+
+### libCLImate.Ruby
 
-All CLASP libraries provide the facilities to **C**ommand **L**ine
-**I**nterface (**CLI**) programs as described in detail below.
+The [**libCLImate.Ruby**](https://github.com/synesissoftware/libCLImate.Ruby) library is implemented in terms of **CLASP.Ruby** but provides a higher-level abstration as well as several utility functions and the facility to fully specify command-line arguments declaratively in the `__END__` section of a source file. More information and examples provided in the [**libCLImate.Ruby**](https://github.com/synesissoftware/libCLImate.Ruby) project.
 
 ## Installation
 
 Install via **gem** as in:
 
 ```
-	gem install clasp-ruby
+    gem install clasp-ruby
 ```
 
 or add it to your `Gemfile`.
@@ -50,7 +58,7 @@ All **CLASP** libraries discriminate between three types of command-line argumen
 For example, in the command line
 
 ```
-	myprog --all -c --opt1=val1 infile outfile
+    myprog --all -c --opt1=val1 infile outfile
 ```
 
 there are:
@@ -62,25 +70,25 @@ there are:
 *Flags* and *options* may have alias. If the alias for `--all` is `-a` and the alias for `--opt1` is `-o` then the following command-line is exactly equivalent to the previous one:
 
 ```
-	myprog -a -c -o val1 infile outfile
+    myprog -a -c -o val1 infile outfile
 ```
 
 One-letter *flags* may be combined. Hence, the following command-line is exactly equivalent to the previous ones:
 
 ```
-	myprog -ac -o val1 infile outfile
+    myprog -ac -o val1 infile outfile
 ```
 
 Option aliases may specify a value. If the alias `-v1` means `--opt1=val1` then the following command-line is exactly equivalent to the previous ones:
 
 ```
-	myprog -ac -v1 infile outfile
+    myprog -ac -v1 infile outfile
 ```
 
 Option aliases that are one letter may be combined with one-letter flags. If the alias `-v` means `--opt1=val1` then the following command-line is exactly equivalent to the previous ones:
 
 ```
-	myprog -acv infile outfile
+    myprog -acv infile outfile
 ```
 
 UNIX standard arguments confer specific meanings:
@@ -104,14 +112,14 @@ PROGRAM_VERSION = '0.1.2'
 
 Specifications = [
 
-	CLASP.Flag('--all', alias: '-a', help: 'processes all item types'),
-	CLASP.Flag('-c', help: 'count the processed items'),
-	CLASP.Option('--opt1', alias: '-o', help: 'an option of some kind', values_range: %w{ val1, val2 }),
-	CLASP.Flag('--opt1=val1', alias: '-v'),
+    CLASP.Flag('--all', alias: '-a', help: 'processes all item types'),
+    CLASP.Flag('-c', help: 'count the processed items'),
+    CLASP.Option('--opt1', alias: '-o', help: 'an option of some kind', values_range: %w{ val1, val2 }),
+    CLASP.Flag('--opt1=val1', alias: '-v'),
 
-	# see next section for why these two are here
-	CLASP::Flag.Help,
-	CLASP::Flag.Version,
+    # see next section for why these two are here
+    CLASP::Flag.Help,
+    CLASP::Flag.Version,
 ]
 
 # assuming the command-line `myprog -acv infile outfile`
@@ -139,25 +147,25 @@ There are aspects common to all CLI programs, such as responding to `--help` and
 
 Args.flags.each do |f|
 
-	case f.name
-	when CLASP::Flag.Help.name
+    case f.name
+    when CLASP::Flag.Help.name
 
-		CLASP.show_usage(Specifications, exit: 0, values: '<input-file> <output-file>')
-	when CLASP::Flag.Version.name
+        CLASP.show_usage(Specifications, exit: 0, values: '<input-file> <output-file>')
+    when CLASP::Flag.Version.name
 
-		CLASP.show_version(Specifications, exit: 0, version: PROGRAM_VERSION)
-	when '--all'
+        CLASP.show_version(Specifications, exit: 0, version: PROGRAM_VERSION)
+    when '--all'
 
-		# do something appropriate to `--all`
+        # do something appropriate to `--all`
 
-	. . .
+    . . .
 
 ```
 
 Given the command
 
 ```
-	./cr-example.rb --help
+    ./cr-example.rb --help
 ```
 
 then the program will output the following
@@ -167,32 +175,32 @@ USAGE: cr-example.rb [ ... flags and options ... ] <input-file> <output-file>
 
 flags/options:
 
-	-a
-	--all
-		processes all item types
+    -a
+    --all
+        processes all item types
 
-	-c
-		count the processed items
+    -c
+        count the processed items
 
-	-v --opt1=val1
-	-o <value>
-	--opt1=<value>
-		an option of some kind where <value> one of:
-			val1,
-			val2
+    -v --opt1=val1
+    -o <value>
+    --opt1=<value>
+        an option of some kind where <value> one of:
+            val1,
+            val2
 
-	--help
-		shows this help and terminates
+    --help
+        shows this help and terminates
 
-	--version
-		shows version and terminates
+    --version
+        shows version and terminates
 
 ```
 
 and given the command
 
 ```
-	./cr-example.rb --version
+    ./cr-example.rb --version
 ```
 
 then the program will output the following
@@ -239,3 +247,6 @@ Projects in which **CLASP.Ruby** is used include:
 
 **CLASP.Ruby** is released under the 3-clause BSD license. See LICENSE for details.
 
+
+<!-- ########################### end of file ########################### -->
+

data/examples/cr-example.rb

@@ -11,31 +11,31 @@ PROGRAM_VERSION = '0.1.2'
 
 Specifications = [
 
-	CLASP.Flag('--all', alias: '-a', help: 'processes all item types'),
-	CLASP.Flag('-c', help: 'count the processed items'),
-	CLASP.Option('--opt1', alias: '-o', help: 'an option of some kind', values_range: %w{ val1, val2 }),
-	CLASP.Flag('--opt1=val1', alias: '-v'),
-
-	# see next section for why these two are here
-	CLASP::Flag.Help,
-	CLASP::Flag.Version,
+    CLASP.Flag('--all', alias: '-a', help: 'processes all item types'),
+    CLASP.Flag('-c', help: 'count the processed items'),
+    CLASP.Option('--opt1', alias: '-o', help: 'an option of some kind', values_range: %w{ val1, val2 }),
+    CLASP.Flag('--opt1=val1', alias: '-v'),
+
+    # see next section for why these two are here
+    CLASP::Flag.Help,
+    CLASP::Flag.Version,
 ]
 
 Args = CLASP::Arguments.new(ARGV, Specifications)
 
 Args.flags.each do |f|
 
-	case f.name
-	when CLASP::Flag.Help.name
+    case f.name
+    when CLASP::Flag.Help.name
 
-		CLASP.show_usage(Specifications, exit: 0, values: '<input-file> <output-file>')
-	when CLASP::Flag.Version.name
+        CLASP.show_usage(Specifications, exit: 0, values: '<input-file> <output-file>')
+    when CLASP::Flag.Version.name
 
-		CLASP.show_version(Specifications, exit: 0, version: PROGRAM_VERSION)
-	when '--all'
+        CLASP.show_version(Specifications, exit: 0, version: PROGRAM_VERSION)
+    when '--all'
 
-		;
-	end
+        ;
+    end
 end
 
 puts Args.flags.size

data/examples/flag_and_option_specifications.md

@@ -35,9 +35,9 @@ Flag_Chatty = CLASP.Flag('--verbosity=chatty', alias: '-c')
 
 Specifications = [
 
-	Flag_Debug,
-	Option_Verbosity,
-	Flag_Chatty,
+    Flag_Debug,
+    Option_Verbosity,
+    Flag_Chatty,
 
     CLASP::FlagSpecification.Help,
     CLASP::FlagSpecification.Version,
@@ -60,12 +60,12 @@ end
 
 if (opt = args.find_option('--verbosity'))
 
-	$stdout.puts "verbosity is specified as: #{opt.value}"
+    $stdout.puts "verbosity is specified as: #{opt.value}"
 end
 
 if args.flags.include?('--debug')
 
-	$stdout.puts 'Debug mode is specified'
+    $stdout.puts 'Debug mode is specified'
 end
 
 
@@ -74,7 +74,7 @@ end
 
 if (unused = args.find_first_unknown())
 
-	$stderr.puts "#{args.program_name}: unrecognised flag/option: #{unused}"
+    $stderr.puts "#{args.program_name}: unrecognised flag/option: #{unused}"
 
     exit 1
 end
@@ -120,25 +120,25 @@ USAGE: flag_and_option_specifications.rb [ ... flags and options ... ]
 
 flags/options:
 
-	-d
-	--debug
-		runs in Debug mode
-
-	-c --verbosity=chatty
-	-v <value>
-	--verbosity=<value>
-		specifies the verbosity
-		where <value> one of:
-			terse	*default*
-			quiet
-			silent
-			chatty
-
-	--help
-		shows this help and terminates
-
-	--version
-		shows version and terminates
+    -d
+    --debug
+        runs in Debug mode
+
+    -c --verbosity=chatty
+    -v <value>
+    --verbosity=<value>
+        specifies the verbosity
+        where <value> one of:
+            terse   *default*
+            quiet
+            silent
+            chatty
+
+    --help
+        shows this help and terminates
+
+    --version
+        shows version and terminates
 ```
 
 ### Specify flags and options in long-form

data/examples/flag_and_option_specifications.rb

@@ -26,9 +26,9 @@ Flag_Chatty = CLASP.Flag('--verbosity=chatty', alias: '-c')
 
 Specifications = [
 
-	Flag_Debug,
-	Option_Verbosity,
-	Flag_Chatty,
+    Flag_Debug,
+    Option_Verbosity,
+    Flag_Chatty,
 
     CLASP::FlagSpecification.Help,
     CLASP::FlagSpecification.Version,
@@ -51,12 +51,12 @@ end
 
 if (opt = args.find_option('--verbosity'))
 
-	$stdout.puts "verbosity is specified as: #{opt.value}"
+    $stdout.puts "verbosity is specified as: #{opt.value}"
 end
 
 if args.flags.include?('--debug')
 
-	$stdout.puts 'Debug mode is specified'
+    $stdout.puts 'Debug mode is specified'
 end
 
 
@@ -65,7 +65,7 @@ end
 
 if (unused = args.find_first_unknown())
 
-	$stderr.puts "#{args.program_name}: unrecognised flag/option: #{unused}"
+    $stderr.puts "#{args.program_name}: unrecognised flag/option: #{unused}"
 
     exit 1
 end

data/examples/show_usage_and_version.md

@@ -52,7 +52,7 @@ end
 
 if (unused = args.find_first_unknown())
 
-	$stderr.puts "#{args.program_name}: unrecognised flag/option: #{unused}"
+    $stderr.puts "#{args.program_name}: unrecognised flag/option: #{unused}"
 
     sys.exit(1)
 end
@@ -102,11 +102,11 @@ USAGE: show_usage_and_version.rb [ ... flags and options ... ]
 
 flags/options:
 
-	--help
-		Shows usage and terminates
+    --help
+        Shows usage and terminates
 
-	--version
-		Shows version and terminates
+    --version
+        Shows version and terminates
 ```
 
 ### Show version

data/examples/show_usage_and_version.rb

@@ -43,7 +43,7 @@ end
 
 if (unused = args.find_first_unknown())
 
-	$stderr.puts "#{args.program_name}: unrecognised flag/option: #{unused}"
+    $stderr.puts "#{args.program_name}: unrecognised flag/option: #{unused}"
 
     exit 1
 end

data/examples/simple_command_line_no_specifications.rb

@@ -25,6 +25,6 @@ puts args.values[0].given_index  # => 1
 puts args.values[1]              # => outfile
 puts args.values[1].given_index  # => 3
 
-# ############################## end of file ############################# #
 
+# ############################## end of file ############################# #