simple_scripting 0.10.2 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d451df42fd6ecf5e2de7ec01680151cecaf8f7438fe38beecc20c8a096669c3c
-  data.tar.gz: e295f1ff9885ce49834785c2c134aee3a85c5d26840a0234ab613d5041f7e4b9
+  metadata.gz: cc0247a6611c5316dad4d41f31b6127cf6bc7aaed615bcc271e548c11f272226
+  data.tar.gz: 3f6602c871caf6666caacfc001d47b6296be49e76c69f56e9903b0438a1fc38e
 SHA512:
-  metadata.gz: 51e691d5371ae18047cda52434f84e3e87bee48f1aa3b6db9022287e066be389f32bc3a9e3a9249289755c9b206ee634550562e4231474ce99fb8087a588fa94
-  data.tar.gz: 063a6e93572108e28a9228d8f06c121599dfc19dcbf031c2262fe4e18e22cfbbf1782acf60c1c8e2d2273aae05399b8264fce0bb094a2e04c98a12da0b137677
+  metadata.gz: '09293ef72e58432cfbb31d282f3ac86141e978dcacdc00a30203f621871bc72663c7566aaf344cb45cc8990ba6e65f1e5b7b401e09e1acc9c86bc0c6f42f05ec'
+  data.tar.gz: 024a82b8d6e483df5e679b549f17266e9c5e6d74cc25a46038484f5ac69b1534d7147ce2114f09f07589625d16f6ef51e1cfa41c12ea0655b40600d335aed1ad

data/.gitignore

@@ -1,3 +1,4 @@
-.ruby-gemset
-.ruby-version
-coverage/
+/.ruby-gemset
+/.ruby-version
+/coverage/
+/Gemfile.lock

data/lib/simple_scripting/argv.rb

@@ -44,6 +44,7 @@ module SimpleScripting
       long_help = options[:long_help]
       auto_help = options.fetch(:auto_help, true)
       output    = options.fetch(:output, $stdout)
+      raise_errors = options.fetch(:raise_errors, false)
 
       # WATCH OUT! @long_help can also be set in :decode_command!. See issue #17.
       #
@@ -60,6 +61,12 @@ module SimpleScripting
       exit_data.print_help(output, @long_help)
 
       nil # to be used with the 'decode(...) || exit' pattern
+    rescue SimpleScripting::Argv::ArgumentError, SimpleScripting::Argv::InvalidCommand, OptionParser::InvalidOption => error
+      if raise_errors
+        raise
+      else
+        output.puts "Command error!: #{error.message}"
+      end
     ensure
       @long_help = nil
     end

data/lib/simple_scripting/version.rb

@@ -1,5 +1,5 @@
 module SimpleScripting
 
-  VERSION = "0.10.2"
+  VERSION = "0.11.0"
 
 end

data/simple_scripting.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.required_ruby_version = '>= 2.3.0'
   s.authors     = ["Saverio Miroddi"]
-  s.date        = "2019-01-15"
+  s.date        = "2019-03-20"
   s.email       = ["saverio.pub2@gmail.com"]
   s.homepage    = "https://github.com/saveriomiroddi/simple_scripting"
   s.summary     = "Library for simplifying some typical scripting functionalities."

data/spec/simple_scripting/argv_spec.rb

@@ -67,7 +67,8 @@ describe SimpleScripting::Argv do
       it "should check all the options/arguments when --help is passed, raising an error when they're not correct" do
         decoder_params.last.merge!(
           arguments: ['--help'],
-          auto_help: false
+          auto_help: false,
+          raise_errors: true,
         )
 
         decoding = -> { described_class.decode(*decoder_params) }
@@ -145,16 +146,35 @@ describe SimpleScripting::Argv do
 
     context "error handling" do
 
-      it "should raise an error when mandatory arguments are missing" do
+      # All the other UTs use error raising, for convenience.
+      it "should print the error, with a previx, by default, instead of raising an error" do
         decoder_params.last[:arguments] = []
 
+        actual_result = described_class.decode(*decoder_params)
+
+        # Returning nil is an important specification, as it's part of the Argv protocol of doing
+        # so in case of problem/exit.
+        expect(actual_result).to be(nil)
+
+        expect(output_buffer.string).to eql("Command error!: Missing mandatory argument(s)\n")
+      end
+
+      it "should raise an error when mandatory arguments are missing" do
+        decoder_params.last.merge!(
+          arguments: [],
+          raise_errors: true,
+        )
+
         decoding = -> { described_class.decode(*decoder_params) }
 
         expect(decoding).to raise_error(SimpleScripting::Argv::ArgumentError, "Missing mandatory argument(s)")
       end
 
-      it "should print an error and the help when there are too many arguments" do
-        decoder_params.last[:arguments] = ['arg1', 'arg2', 'excessive_arg']
+      it "should raise an error when there are too many arguments" do
+        decoder_params.last.merge!(
+          arguments: ['arg1', 'arg2', 'excessive_arg'],
+          raise_errors: true,
+        )
 
         decoding = -> { described_class.decode(*decoder_params) }
 
@@ -219,7 +239,9 @@ describe SimpleScripting::Argv do
           arguments:  [],
         ]}
 
-        it "should exit when they are not specified" do
+        it "should raise an error when they are not specified" do
+          decoder_params.last[:raise_errors] = true
+
           decoding = -> { described_class.decode(*decoder_params) }
 
           expect(decoding).to raise_error(SimpleScripting::Argv::ArgumentError, "Missing mandatory argument(s)")
@@ -292,15 +314,21 @@ describe SimpleScripting::Argv do
       context "error handling" do
 
         it "should raise an error on invalid command" do
-          decoder_params[:arguments] = ['pizza']
+          decoder_params.merge!(
+            arguments: ['pizza'],
+            raise_errors: true,
+          )
 
           decoding = -> { described_class.decode(decoder_params) }
 
           expect(decoding).to raise_error(SimpleScripting::Argv::InvalidCommand, "Invalid command: pizza")
         end
 
-        it "should print a specific error message on missing command" do
-          decoder_params[:arguments] = []
+        it "should raise a specific error message on missing command" do
+          decoder_params.merge!(
+            arguments: [],
+            raise_errors: true,
+          )
 
           decoding = -> { described_class.decode(decoder_params) }
 
@@ -458,6 +486,7 @@ describe SimpleScripting::Argv do
 
     it 'should avoid options being interpreted as definitions' do
       decoder_params[:arguments] = ['pizza']
+      decoder_params[:raise_errors] = true
 
       decoding = -> { described_class.decode(decoder_params) }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_scripting
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.11.0
 platform: ruby
 authors:
 - Saverio Miroddi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-15 00:00:00.000000000 Z
+date: 2019-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parseconfig
@@ -64,7 +64,6 @@ files:
 - ".simplecov"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -101,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Library for simplifying some typical scripting functionalities.

data/Gemfile.lock

@@ -1,74 +0,0 @@
-PATH
-  remote: .
-  specs:
-    simple_scripting (0.10.1)
-      parseconfig (~> 1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.0)
-    byebug (10.0.2)
-    coveralls (0.8.21)
-      json (>= 1.8, < 3)
-      simplecov (~> 0.14.1)
-      term-ansicolor (~> 1.3)
-      thor (~> 0.19.4)
-      tins (~> 1.6)
-    diff-lcs (1.3)
-    docile (1.1.5)
-    jaro_winkler (1.5.1)
-    json (2.1.0)
-    parallel (1.12.1)
-    parseconfig (1.0.8)
-    parser (2.5.1.2)
-      ast (~> 2.4.0)
-    powerpack (0.1.2)
-    rainbow (3.0.0)
-    rake (12.0.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    rubocop (0.58.1)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
-    simplecov (0.14.1)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    term-ansicolor (1.6.0)
-      tins (~> 1.0)
-    thor (0.19.4)
-    tins (1.15.0)
-    unicode-display_width (1.4.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  byebug (~> 10.0.2)
-  coveralls (~> 0.8.21)
-  rake (~> 12.0)
-  rspec (~> 3.7)
-  rubocop (= 0.58.1)
-  simple_scripting!
-
-BUNDLED WITH
-   1.16.1