command_mapper 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abc51ed8c1f7edf0484053eb62854a56b13dce9d5e3ea7b3373799c4b7a1d4fb
-  data.tar.gz: 0e7945e79e57cb99a4448b4eafef1237e9cc5e06d4523e13efd68b2767106a2f
+  metadata.gz: 254468c58bbee95ac037609a4ddefc34c026240b4933a37038df1bade5b7487e
+  data.tar.gz: 1fe51a7d6ad09b0b51c753bee28632e70292bfa9e9938896e22183c0327f48ae
 SHA512:
-  metadata.gz: ea9449f43ab086e941cc011dffd778cea4d356a2a9171aef5496e9a4593f62ca3ba68356d455cc510046ee926970c290c065b76bf445ba843a317f60c0fbbd31
-  data.tar.gz: 5979c264d481d50be2fed8ca17a19cb59b4c522303ff4d5cdf14164195b9b27fd6589ebe5b8e0b06276494f5298c6898fb297a97a606ca10d5fb916dbe1d568d
+  metadata.gz: c1fc9b041fafa2d92300bcbf312e8b1d848450bd4691b6b0eea57fb401a8d20b8a73613328c69cc5d323e9b42313ecc2f3e66b8bcfff14454a8cdb5bd5db5467
+  data.tar.gz: 62fd74bd469bff9620c94a8c0710f6d309bb0611af7e58664fa7d04808ee40b14d3b076fb8143a6fdbd409a0fd35fb12682e535c30b41ed616200dc7be982bd2

data/ChangeLog.md

@@ -1,3 +1,7 @@
+### 0.3.0 / 2022-11-11
+
+* Added {CommandMapper::Types::Dec}.
+
 ### 0.2.1 / 2022-04-22
 
 * Properly validate in {CommandMapper::OptionValue#validate} when an option,

data/README.md

@@ -10,8 +10,8 @@
 
 ## Description
   
-Command Mapper maps a command's options and arguments to Class attributes to
-allow safely and securely executing commands.
+Command Mapper maps an external command's options and arguments to Class
+attributes to allow safely and securely executing commands.
 
 ## Features
 
@@ -20,6 +20,7 @@ allow safely and securely executing commands.
   * Supports common option types:
     * [Str][CommandMapper::Types::Str]: string values
     * [Num][CommandMapper::Types::Num]: numeric values
+    * [Dec][CommandMapper::Types::Dec]: decimal values
     * [Hex][CommandMapper::Types::Hex]: hexadecimal values
     * [Map][CommandMapper::Types::Map]: maps Ruby values to other String values.
       * `Map::YesNo`: maps `true`/`false` to `yes`/`no`.
@@ -50,6 +51,7 @@ allow safely and securely executing commands.
 
 [CommandMapper::Types::Str]: https://rubydoc.info/gems/command_mapper/CommandMapper/Types/Str
 [CommandMapper::Types::Num]: https://rubydoc.info/gems/command_mapper/CommandMapper/Types/Num
+[CommandMapper::Types::Dec]: https://rubydoc.info/gems/command_mapper/CommandMapper/Types/Dec
 [CommandMapper::Types::Hex]: https://rubydoc.info/gems/command_mapper/CommandMapper/Types/Hex
 [CommandMapper::Types::Map]: https://rubydoc.info/gems/command_mapper/CommandMapper/Types/Map
 [CommandMapper::Types::Enum]: https://rubydoc.info/gems/command_mapper/CommandMapper/Types/Enum

data/gemspec.yml

@@ -1,8 +1,8 @@
 name: command_mapper
 summary: Safe and secure execution of commands.
 description:
-  Command Mapper maps a command's arguments to Class attributes to allow safely
-  and securely executing commands.
+  Command Mapper maps an external command's arguments to Class attributes to
+  allow safely and securely executing commands.
 
 license: MIT
 authors: Postmodern

data/lib/command_mapper/types/dec.rb

@@ -0,0 +1,84 @@
+require 'command_mapper/types/type'
+
+module CommandMapper
+  module Types
+    #
+    # Represents a decimal value (ex: `1.5`).
+    #
+    # @since 0.3.0
+    #
+    class Dec < Type
+
+      # The optional range of acceptable decimal numbers.
+      #
+      # @return [Range<Float,Float>, nil]
+      #
+      # @api semipublic
+      attr_reader :range
+
+      #
+      # Initializes the decimal type.
+      #
+      # @param [Range<Float,Float>] range
+      #   Specifies the range of acceptable numbers.
+      #
+      def initialize(range: nil)
+        @range = range
+      end
+
+      #
+      # Validates a value.
+      #
+      # @param [String, Numeric] value
+      #   The given value to validate.
+      #
+      # @return [true, (false, String)]
+      #   Returns true if the value is valid, or `false` and a validation error
+      #   message if the value is not compatible.
+      #
+      # @api semipublic
+      #
+      def validate(value)
+        case value
+        when Float
+          # no-op
+        when String
+          unless value =~ /\A\d+(?:\.\d+)?\z/
+            return [false, "contains non-decimal characters (#{value.inspect})"]
+          end
+        else
+          unless value.respond_to?(:to_f)
+            return [false, "cannot be converted into a Float (#{value.inspect})"]
+          end
+        end
+
+        if @range
+          unless @range.include?(value.to_f)
+            return [false, "(#{value.inspect}) not within the range of acceptable values (#{range.inspect})"]
+          end
+        end
+
+        return true
+      end
+
+      #
+      # Formats a decimal value.
+      #
+      # @param [String, Float, #to_f] value
+      #   The given value to format.
+      #
+      # @return [String]
+      #   The formatted decimal value.
+      #
+      # @api semipublic
+      #
+      def format(value)
+        case value
+        when Float, String then value.to_s
+        else                    value.to_f.to_s
+        end
+      end
+
+    end
+  end
+end

data/lib/command_mapper/types/type.rb

@@ -58,7 +58,7 @@ module CommandMapper
       # The default `validate` method for all types.
       #
       # @param [Object]
-      #   The given value to format.
+      #   The given value to validate.
       #
       # @return [true, (false, String)]
       #   Returns true if the value is valid, or `false` and a validation error

data/lib/command_mapper/types.rb

@@ -1,6 +1,7 @@
 require 'command_mapper/types/type'
 require 'command_mapper/types/str'
 require 'command_mapper/types/num'
+require 'command_mapper/types/dec'
 require 'command_mapper/types/hex'
 require 'command_mapper/types/map'
 require 'command_mapper/types/enum'

data/lib/command_mapper/version.rb

@@ -1,4 +1,4 @@
 module CommandMapper
   # Version of command_mapper
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/spec/commnad_spec.rb

@@ -808,7 +808,7 @@ describe CommandMapper::Command do
       end
 
       it "must initialize a new command with the Hash of params and call #run_command" do
-        if RUBY_VERSION < '3.' || RUBY_ENGINE == 'truffleruby'
+        if RUBY_VERSION < '3.'
           expect(subject).to receive(:new).with({},params).and_return(command_instance)
         else
           expect(subject).to receive(:new).with(params).and_return(command_instance)
@@ -846,7 +846,7 @@ describe CommandMapper::Command do
       end
 
       it "must initialize a new command with the Hash of params and call #spawn_command" do
-        if RUBY_VERSION < '3.' || RUBY_ENGINE == 'truffleruby'
+        if RUBY_VERSION < '3.'
           expect(subject).to receive(:new).with({},params).and_return(command_instance)
         else
           expect(subject).to receive(:new).with(params).and_return(command_instance)
@@ -884,7 +884,7 @@ describe CommandMapper::Command do
       end
 
       it "must initialize a new command with the Hash of params and call #capture_command" do
-        if RUBY_VERSION < '3.' || RUBY_ENGINE == 'truffleruby'
+        if RUBY_VERSION < '3.'
           expect(subject).to receive(:new).with({},params).and_return(command_instance)
         else
           expect(subject).to receive(:new).with(params).and_return(command_instance)
@@ -922,7 +922,7 @@ describe CommandMapper::Command do
       end
 
       it "must initialize a new command with the Hash of params and call #popen_command" do
-        if RUBY_VERSION < '3.' || RUBY_ENGINE == 'truffleruby'
+        if RUBY_VERSION < '3.'
           expect(subject).to receive(:new).with({},params).and_return(command_instance)
         else
           expect(subject).to receive(:new).with(params).and_return(command_instance)
@@ -960,7 +960,7 @@ describe CommandMapper::Command do
       end
 
       it "must initialize a new command with the Hash of params and call #sudo_command" do
-        if RUBY_VERSION < '3.' || RUBY_ENGINE == 'truffleruby'
+        if RUBY_VERSION < '3.'
           expect(subject).to receive(:new).with({},params).and_return(command_instance)
         else
           expect(subject).to receive(:new).with(params).and_return(command_instance)

data/spec/types/dec_spec.rb

@@ -0,0 +1,180 @@
+require 'spec_helper'
+require 'command_mapper/types/dec'
+
+describe CommandMapper::Types::Dec do
+  describe "#initialize" do
+    context "when initialized with no keyword arguments" do
+      it "must set #range to nil" do
+        expect(subject.range).to be(nil)
+      end
+    end
+
+    context "when initialized with range: ..." do
+      let(:range) { 1.0..1.5 }
+
+      subject { described_class.new(range: range) }
+
+      it "must set #range" do
+        expect(subject.range).to eq(range)
+      end
+    end
+  end
+
+  describe "#validate" do
+    context "when given an Integer" do
+      let(:value) { 1 }
+
+      it "must return true" do
+        expect(subject.validate(value)).to be(true)
+      end
+
+      context "when initialized with range: ..." do
+        let(:range) { 2.0..10.0 }
+
+        subject { described_class.new(range: range) }
+
+        context "and the value is within the range of values" do
+          let(:value) { 4.0 }
+
+          it "must return true" do
+            expect(subject.validate(value)).to be(true)
+          end
+        end
+
+        context "but the value is not within the range of values" do
+          let(:value) { 0.0 }
+
+          it "must return [false, \"(...) not within the range of acceptable values (...)\"]" do
+            expect(subject.validate(value)).to eq(
+              [false, "(#{value.inspect}) not within the range of acceptable values (#{range.inspect})"]
+            )
+          end
+        end
+      end
+    end
+
+    context "when given a String" do
+      context "and it contains only digits" do
+        let(:value) { "0123456789" }
+
+        it "must return true" do
+          expect(subject.validate(value)).to be(true)
+        end
+
+        context "when initialized with range: ..." do
+          let(:range) { 2.0..10.0 }
+
+          subject { described_class.new(range: range) }
+
+          context "and the value is within the range of values" do
+            let(:value) { '4.0' }
+
+            it "must return true" do
+              expect(subject.validate(value)).to be(true)
+            end
+          end
+
+          context "but the value is not within the range of values" do
+            let(:value) { '0.0' }
+
+            it "must return [false, \"(...) not within the range of acceptable values (...)\"]" do
+              expect(subject.validate(value)).to eq(
+                [false, "(#{value.inspect}) not within the range of acceptable values (#{range.inspect})"]
+              )
+            end
+          end
+        end
+
+        context "but the String contains a newline" do
+          let(:value) { "01234.\n56789" }
+
+          it "must return [false, \"contains non-decimal characters (...)\"]" do
+            expect(subject.validate(value)).to eq(
+              [false, "contains non-decimal characters (#{value.inspect})"]
+            )
+          end
+        end
+      end
+
+      context "but it contains non-digits" do
+        let(:value) { "12.abc34" }
+
+        it "must return [false, \"contains non-decimal characters (...)\"]" do
+          expect(subject.validate(value)).to eq(
+            [false, "contains non-decimal characters (#{value.inspect})"]
+          )
+        end
+      end
+    end
+
+    context "when given another type of Object" do
+      context "and it defines a #to_f method" do
+        let(:value) { 1 }
+
+        it "must return true" do
+          expect(subject.validate(value)).to be(true)
+        end
+      end
+
+      context "when initialized with range: ..." do
+        let(:range) { 2.0..10.0 }
+
+        subject { described_class.new(range: range) }
+
+        context "and the value is within the range of values" do
+          let(:value) { 4 }
+
+          it "must return true" do
+            expect(subject.validate(value)).to be(true)
+          end
+        end
+
+        context "but the value is not within the range of values" do
+          let(:value) { 0 }
+
+          it "must return [false, \"(...) not within the range of acceptable values (...)\"]" do
+            expect(subject.validate(value)).to eq(
+              [false, "(#{value.inspect}) not within the range of acceptable values (#{range.inspect})"]
+            )
+          end
+        end
+      end
+
+      context "but it does not define a #to_f method" do
+        let(:value) { Object.new }
+
+        it "must return [false, \"value cannot be converted into a Float\"]" do
+          expect(subject.validate(value)).to eq(
+            [false, "cannot be converted into a Float (#{value.inspect})"]
+          )
+        end
+      end
+    end
+  end
+
+  describe "#format" do
+    context "when given a String" do
+      let(:value) { "12345.67890" }
+
+      it "must return the same String" do
+        expect(subject.format(value)).to eq(value)
+      end
+    end
+
+    context "when given an Intger" do
+      let(:value) { 12345.67890 }
+
+      it "must convert the Integer into a String" do
+        expect(subject.format(value)).to eq(value.to_s)
+      end
+    end
+
+    context "when given another type of Object" do
+      let(:value) { 1 }
+
+      it "must call #to_i then #to_s" do
+        expect(subject.format(value)).to eq(value.to_f.to_s)
+      end
+    end
+  end
+end

data/spec/types/input_dir_spec.rb

@@ -3,19 +3,21 @@ require 'command_mapper/types/input_dir'
 
 describe CommandMapper::Types::InputDir do
   describe "#validate" do
-    context "when given a valid file path" do
-      let(:value) { __FILE__ }
+    context "when given a valid directory path" do
+      let(:value) { __dir__ }
 
-      it "must return [false, 'directory does not exist (...)']" do
-        expect(subject.validate(value)).to eq([false, "directory does not exist (#{value.inspect})"])
+      it "must return true" do
+        expect(subject.validate(value)).to be(true)
       end
     end
 
-    context "when given a valid directory path" do
-      let(:value) { __dir__ }
+    context "when given a valid file path" do
+      let(:value) { __FILE__ }
 
-      it "must return true" do
-        expect(subject.validate(value)).to eq(true)
+      it "must return [false, 'directory does not exist (...)']" do
+        expect(subject.validate(value)).to eq(
+          [false, "directory does not exist (#{value.inspect})"]
+        )
       end
     end
 
@@ -23,7 +25,9 @@ describe CommandMapper::Types::InputDir do
       let(:value) { "/path/does/not/exist" }
 
       it "must return [false, 'path does not exist (...)']" do
-        expect(subject.validate(value)).to eq([false, "path does not exist (#{value.inspect})"])
+        expect(subject.validate(value)).to eq(
+          [false, "path does not exist (#{value.inspect})"]
+        )
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: command_mapper
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-22 00:00:00.000000000 Z
+date: 2022-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,8 +24,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: Command Mapper maps a command's arguments to Class attributes to allow
-  safely and securely executing commands.
+description: Command Mapper maps an external command's arguments to Class attributes
+  to allow safely and securely executing commands.
 email: postmodern.mod3@gmail.com
 executables: []
 extensions: []
@@ -44,7 +44,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- commnad_mapper.gemspec
+- command_mapper.gemspec
 - examples/grep.rb
 - gemspec.yml
 - lib/command_mapper.rb
@@ -56,6 +56,7 @@ files:
 - lib/command_mapper/option_value.rb
 - lib/command_mapper/sudo.rb
 - lib/command_mapper/types.rb
+- lib/command_mapper/types/dec.rb
 - lib/command_mapper/types/enum.rb
 - lib/command_mapper/types/hex.rb
 - lib/command_mapper/types/input_dir.rb
@@ -77,6 +78,7 @@ files:
 - spec/option_value_spec.rb
 - spec/spec_helper.rb
 - spec/sudo_spec.rb
+- spec/types/dec_spec.rb
 - spec/types/enum_spec.rb
 - spec/types/hex_spec.rb
 - spec/types/input_dir_spec.rb
@@ -114,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Safe and secure execution of commands.