cyclops 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c7bfa77550e65e5f43540c3eb45b68c39d8699e
-  data.tar.gz: 778b46e92d8b22c33eea63f03177459608a4615f
+  metadata.gz: d20c8ac18e0f174a287735b1bb22d9f1d4fec432
+  data.tar.gz: 88d9a76c70d8430b3ea7310d924465c598f23dc4
 SHA512:
-  metadata.gz: 66d0e27a997554bb1bfbaab940b3c7a84f6709f5d7e337a6c5b22679b33e5af4fb51d47951a60d45d697c36a9935dbaf312b8a1aa2643cf0731d2fac27dc87c8
-  data.tar.gz: ed78fac887806de5c77d631d8aa1099569a50a353756794b454656fcc3cd908e5cfe9cae0a6a374ed6571a0926dbdb069574cd373a2a23901b77a22cae5676c5
+  metadata.gz: 7b375b5da84cff2b15b5598813930e84a20e90dca93fd183ed246940daa86e268db1e2721d3110eb30cdbe5f737db583d22cbc3b99947863094fc105be82e11f
+  data.tar.gz: 214e3157759ffc2c9c7f5a0c600d9a37df16ef54cf3e64d2fb4ff90d5898379e4454e56f40fd78f8bfb7ab3f82bff76f185558c2b27cf936b9982ef32d378cc0

data/ChangeLog

@@ -2,6 +2,12 @@
 
 = Revision history for cyclops
 
+== 0.0.4 [2014-09-01]
+
+* Added support for <tt>--[no-]<switch></tt>.
+* <tt>--verbose</tt> also prints program name and version.
+* Print error and usage on parse errors.
+
 == 0.0.3 [2014-04-14]
 
 * Always set symbol key in options hash.

data/README

@@ -2,7 +2,7 @@
 
 == VERSION
 
-This documentation refers to cyclops version 0.0.3
+This documentation refers to cyclops version 0.0.4
 
 
 == DESCRIPTION
@@ -13,7 +13,7 @@ enough CLI libraries already...
 
 == LINKS
 
-Documentation:: https://blackwinter.github.io/cyclops/
+Documentation:: https://blackwinter.github.com/cyclops
 Source code::   https://github.com/blackwinter/cyclops
 RubyGem::       https://rubygems.org/gems/cyclops
 

data/lib/cyclops.rb

@@ -95,11 +95,10 @@ class Cyclops
     run(arguments)
   rescue => err
     raise if $VERBOSE
-    abort "#{err.backtrace.first}: #{err} (#{err.class})"
+    abort err.is_a?(OptionParser::ParseError) ?
+      "#{err}\n#{usage}" : "#{err.backtrace.first}: #{err} (#{err.class})"
   ensure
-    options.each_value { |value|
-      value.close if value.is_a?(Zlib::GzipWriter)
-    }
+    options.each_value { |value| value.close if value.is_a?(Zlib::GzipWriter) }
   end
 
   def run(arguments)
@@ -168,14 +167,10 @@ class Cyclops
   end
 
   def open_file_or_std(file, write = false)
-    if file == '-'
-      write ? stdout : stdin
-    else
+    file == '-' ? write ? stdout : stdin : begin
       gz = file =~ /\.gz\z/i
 
-      if write
-        gz ? Zlib::GzipWriter.open(file) : File.open(file, 'w')
-      else
+      write ? gz ? Zlib::GzipWriter.open(file) : File.open(file, 'w') : begin
         quit "No such file: #{file}" unless File.readable?(file)
         (gz ? Zlib::GzipReader : File).open(file)
       end
@@ -186,7 +181,7 @@ class Cyclops
     return unless file
 
     if File.readable?(file)
-      @config = SafeYAML.load_file(file, :deserialize_symbols => true)
+      @config = SafeYAML.load_file(file, deserialize_symbols: true)
     else
       quit "No such file: #{file}" unless default
     end
@@ -247,7 +242,9 @@ class Cyclops
   def verbose_opts(opts)
     verbose, debug = defaults.key?(:verbose), defaults.key?(:debug)
 
-    opts.switch(:verbose, 'Print verbose output') if verbose
+    opts.switch(:verbose, 'Print verbose output') {
+      warn "#{progname} v#{version}"
+    } if verbose
 
     msg = "; #{debug_message}" if respond_to?(:debug_message, true)
     opts.switch(:debug, :D, "Print debug output#{msg}") if debug

data/lib/cyclops/option_parser_extension.rb

@@ -30,10 +30,14 @@ class Cyclops
 
     attr_accessor :cli
 
+    OPTION_RE = /(\w+)__(\w+)(\?)?\z/
+
+    SWITCH_RE = /(\w+)(\?)?\z/
+
     KEY_POOL = ('A'..'Z').to_a + ('a'..'z').to_a + ('0'..'9').to_a
 
     def keys
-      { :used => keys = top.short.keys, :free => KEY_POOL - keys }
+      { used: keys = top.short.keys, free: KEY_POOL - keys }
     end
 
     def separator(string = '')
@@ -55,9 +59,9 @@ class Cyclops
     # the argument name ends with a question mark, the value is marked
     # as optional.
     def option(name, *args, &block)
-      if name =~ /(\w+)__(\w+)(\?)?\z/
-        sym = name.is_a?(Symbol)
+      sym = name.is_a?(Symbol)
 
+      if name =~ OPTION_RE
         name, arg, opt = $1, $2, !!$3
         __on_opts(name, args, sym)
 
@@ -69,7 +73,7 @@ class Cyclops
           yield value if block_given?
         }
       else
-        on(*__on_opts(name, args), &block)
+        on(*__on_opts(name, args, sym), &block)
       end
     end
 
@@ -84,16 +88,35 @@ class Cyclops
     #
     # Sets the CLI's +name+ option (as a Symbol) to +true+ and calls
     # the optional block (with no argument).
+    #
+    # If +name+ ends with a question mark, installs only the long option
+    # and sets the CLI's +name+ option (as a Symbol) to either +true+ or
+    # +false+, depending on whether <tt>--name</tt> or <tt>--no-name</tt>
+    # was given on the command line.
     def switch(name, *args)
-      on(*__on_opts(name, args)) {
-        cli.options[name.to_sym] = true
-        yield if block_given?
-      }
+      sym = name.is_a?(Symbol)
+
+      name, opt = $1, !!$2 if name =~ SWITCH_RE
+
+      if opt
+        __on_opts(name, args, false)
+        args.first.insert(2, '[no-]')
+
+        on(*args) { |value|
+          cli.options[name.to_sym] = value
+          yield if block_given?
+        }
+      else
+        on(*__on_opts(name, args, sym)) {
+          cli.options[name.to_sym] = true
+          yield if block_given?
+        }
+      end
     end
 
     private
 
-    def __on_opts(name, args, sym = name.is_a?(Symbol))
+    def __on_opts(name, args, sym)
       args.insert(0, "-#{args[0].is_a?(Symbol) ? args.shift : name[0]}") if sym
       args.insert(sym ? 1 : 0, "--#{name.to_s.tr('_', '-')}")
     end

data/lib/cyclops/version.rb

@@ -4,7 +4,7 @@ class Cyclops
 
     MAJOR = 0
     MINOR = 0
-    TINY  = 3
+    TINY  = 4
 
     class << self
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cyclops
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Jens Wille
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-14 00:00:00.000000000 Z
+date: 2014-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -88,13 +88,15 @@ licenses:
 metadata: {}
 post_install_message: |2+
 
-  cyclops-0.0.3 [2014-04-14]:
+  cyclops-0.0.4 [2014-09-01]:
 
-  * Always set symbol key in options hash.
+  * Added support for <tt>--[no-]<switch></tt>.
+  * <tt>--verbose</tt> also prints program name and version.
+  * Print error and usage on parse errors.
 
 rdoc_options:
 - "--title"
-- cyclops Application documentation (v0.0.3)
+- cyclops Application documentation (v0.0.4)
 - "--charset"
 - UTF-8
 - "--line-numbers"
@@ -115,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: A command-line option parser based on optparse.