command_mapper 0.1.0.pre1

data/spec/types/str_spec.rb

@@ -0,0 +1,232 @@
+require 'spec_helper'
+require 'command_mapper/types/str'
+
+describe CommandMapper::Types::Str do
+  describe "#initialize" do
+    it "must default allow_empty: to false" do
+      expect(subject.allow_empty?).to be(false)
+    end
+
+    it "must default allow_blank: to false" do
+      expect(subject.allow_blank?).to be(false)
+    end
+
+    context "when given allow_empty: true" do
+      subject { described_class.new(allow_empty: true) }
+
+      it "must set allow_empty: to true" do
+        expect(subject.allow_empty?).to be(true)
+      end
+    end
+
+    context "when given allow_empty: false" do
+      subject { described_class.new(allow_empty: false) }
+
+      it "must set allow_empty: to false" do
+        expect(subject.allow_empty?).to be(false)
+      end
+    end
+
+    context "when given allow_blank: true" do
+      subject { described_class.new(allow_blank: true) }
+
+      it "must set allow_blank: to true" do
+        expect(subject.allow_blank?).to be(true)
+      end
+    end
+
+    context "when given allow_blank: false" do
+      subject { described_class.new(allow_blank: false) }
+
+      it "must set allow_blank: to false" do
+        expect(subject.allow_blank?).to be(false)
+      end
+    end
+  end
+
+  describe "#allow_empty?" do
+    it "must be false by default" do
+      expect(subject.allow_empty?).to be(false)
+    end
+
+    context "when initialized with allow_empty: true" do
+      subject { described_class.new(allow_empty: true) }
+
+      it "must be true" do
+        expect(subject.allow_empty?).to be(true)
+      end
+    end
+
+    context "when initialized with allow_empty: true" do
+      subject { described_class.new(allow_empty: false) }
+
+      it "must be false" do
+        expect(subject.allow_empty?).to be(false)
+      end
+    end
+  end
+
+  describe "#allow_blank?" do
+    it "must be false by default" do
+      expect(subject.allow_blank?).to be(false)
+    end
+
+    context "when initialized with allow_blank: true" do
+      subject { described_class.new(allow_blank: true) }
+
+      it "must be true" do
+        expect(subject.allow_blank?).to be(true)
+      end
+    end
+
+    context "when initialized with allow_blank: true" do
+      subject { described_class.new(allow_blank: false) }
+
+      it "must be false" do
+        expect(subject.allow_blank?).to be(false)
+      end
+    end
+  end
+
+  describe "#validate" do
+    context "when given nil" do
+      let(:value) { nil }
+
+      it "must return [false, \"cannot be nil\"]" do
+        expect(subject.validate(value)).to eq(
+          [false, "cannot be nil"]
+        )
+      end
+
+      context "but #allow_empty? is true" do
+        subject { described_class.new(allow_empty: true) }
+
+        it "must return true" do
+          expect(subject.validate(value)).to be(true)
+        end
+      end
+    end
+
+    context "when a String is given" do
+      let(:value) { "foo" }
+
+      it "must return true" do
+        expect(subject.validate(value)).to be(true)
+      end
+
+      context "and it's empty" do
+        let(:value) { "" }
+
+        it "must return [false, \"does not allow an empty value\"]" do
+          expect(subject.validate(value)).to eq([false, "does not allow an empty value"])
+        end
+
+        context "but #allow_empty? is true" do
+          subject { described_class.new(allow_empty: true) }
+
+          it "must return true" do
+            expect(subject.validate(value)).to be(true)
+          end
+        end
+      end
+
+      context "and it's blank" do
+        let(:value) { " \t\n\r\v " }
+
+        it "must return [false, \"does not allow a blank value (...)\"]" do
+          expect(subject.validate(value)).to eq([false, "does not allow a blank value (#{value.inspect})"])
+        end
+
+        context "but #allow_blank? is true" do
+          subject { described_class.new(allow_blank: true) }
+
+          it "must return true" do
+            expect(subject.validate(value)).to be(true)
+          end
+        end
+      end
+    end
+
+    context "when a Symbol is given" do
+      let(:value) { :foo }
+
+      it "must return true" do
+        expect(subject.validate(value)).to be(true)
+      end
+
+      context "and it's empty" do
+        let(:value) { :"" }
+
+        it "must return [false, \"does not allow an empty value\"]" do
+          expect(subject.validate(value)).to eq([false, "does not allow an empty value"])
+        end
+
+        context "but #allow_empty? is true" do
+          subject { described_class.new(allow_empty: true) }
+
+          it "must return true" do
+            expect(subject.validate(value)).to be(true)
+          end
+        end
+      end
+
+      context "and it's blank" do
+        let(:value) { :" \t\n\r\v " }
+
+        it "must return [false, \"does not allow a blank value (...)\"]" do
+          expect(subject.validate(value)).to eq([false, "does not allow a blank value (#{value.inspect})"])
+        end
+
+        context "but #allow_blank? is true" do
+          subject { described_class.new(allow_blank: true) }
+
+          it "must return true" do
+            expect(subject.validate(value)).to be(true)
+          end
+        end
+      end
+    end
+
+    context "when an Enumerable object is given" do
+      let(:value) { %w[foo bar] }
+
+      it "must return [false, \"cannot convert an Enumerable object into a String (...)\"]" do
+        expect(subject.validate(value)).to eq(
+          [false, "cannot convert a #{value.class} into a String (#{value.inspect})"]
+        )
+      end
+    end
+
+    context "when another kind of Object is given" do
+      module TestStr
+        class CustomObject
+          def to_s
+            "foo"
+          end
+        end
+      end
+
+      let(:value) { TestStr::CustomObject.new }
+
+      it "must return true" do
+        expect(subject.validate(value)).to be(true)
+      end
+
+      context "but the object does not define a #to_s method" do
+        module TestStr
+          class ObjectWithoutToS
+            undef to_s
+          end
+        end
+
+        let(:value) { TestStr::ObjectWithoutToS.new }
+
+        it "must return [false, \"dpes not define a #to_s method (...)\"]" do
+          expect(subject.validate(value)).to eq(
+            [false, "does not define a #to_s method (#{value.inspect})"]
+          )
+        end
+      end
+    end
+  end
+end

data/spec/types/type_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+require 'command_mapper/types/type'
+
+describe CommandMapper::Types::Type do
+  describe "#validate" do
+    it "must return true by default" do
+      expect(subject.validate(Object.new)).to be(true)
+    end
+  end
+
+  describe "#format" do
+    it "must convert the given value into a String" do
+      expect(subject.format(1)).to eq("1")
+    end
+  end
+end
+
+describe "CommandMapper::Types::Type()" do
+  context "when given a CommandMapper::Types::Type" do
+    let(:value) { CommandMapper::Types::Type.new }
+
+    subject { CommandMapper::Types::Type(value) }
+
+    it "must return the CommandMapper::Types::Type object" do
+      expect(subject).to be(value)
+    end
+  end
+
+  context "when given a Hash" do
+    let(:value) { {allow_empty: true} }
+
+    subject { CommandMapper::Types::Type(value) }
+
+    it "must initialize a new CommandMapper::Types::Str" do
+      expect(subject).to be_kind_of(CommandMapper::Types::Str)
+      expect(subject.allow_empty?).to be(true)
+    end
+  end
+
+  context "when given nil" do
+    let(:value) { nil }
+
+    subject { CommandMapper::Types::Type(value) }
+
+    it "must return nil" do
+      expect(subject).to be(nil)
+    end
+  end
+
+  context "when given another kind of Object" do
+    let(:value) { Object.new }
+
+    it do
+      expect {
+        CommandMapper::Types::Type(value)
+      }.to raise_error(ArgumentError,"value must be a CommandMapper::Types::Type, Hash, or nil: #{value.inspect}")
+    end
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: command_mapper
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre1
+platform: ruby
+authors:
+- Postmodern
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.
+email: postmodern.mod3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".yardopts"
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- commnad_mapper.gemspec
+- gemspec.yml
+- lib/command_mapper.rb
+- lib/command_mapper/arg.rb
+- lib/command_mapper/argument.rb
+- lib/command_mapper/command.rb
+- lib/command_mapper/exceptions.rb
+- lib/command_mapper/option.rb
+- lib/command_mapper/option_value.rb
+- lib/command_mapper/sudo.rb
+- lib/command_mapper/types.rb
+- lib/command_mapper/types/enum.rb
+- lib/command_mapper/types/hex.rb
+- lib/command_mapper/types/input_dir.rb
+- lib/command_mapper/types/input_file.rb
+- lib/command_mapper/types/input_path.rb
+- lib/command_mapper/types/key_value.rb
+- lib/command_mapper/types/key_value_list.rb
+- lib/command_mapper/types/list.rb
+- lib/command_mapper/types/map.rb
+- lib/command_mapper/types/num.rb
+- lib/command_mapper/types/str.rb
+- lib/command_mapper/types/type.rb
+- lib/command_mapper/version.rb
+- spec/arg_spec.rb
+- spec/argument_spec.rb
+- spec/commnad_spec.rb
+- spec/exceptions_spec.rb
+- spec/option_spec.rb
+- spec/option_value_spec.rb
+- spec/spec_helper.rb
+- spec/sudo_spec.rb
+- spec/types/enum_spec.rb
+- spec/types/hex_spec.rb
+- spec/types/input_dir_spec.rb
+- spec/types/input_file_spec.rb
+- spec/types/input_path_spec.rb
+- spec/types/key_value_list_spec.rb
+- spec/types/key_value_spec.rb
+- spec/types/list_spec.rb
+- spec/types/map_spec.rb
+- spec/types/num_spec.rb
+- spec/types/str_spec.rb
+- spec/types/type_spec.rb
+homepage: https://github.com/postmodern/command_mapper.rb#readme
+licenses:
+- MIT
+metadata:
+  documentation_uri: https://rubydoc.info/gems/command_mapper
+  source_code_uri: https://github.com/postmodern/command_mapper.rb
+  bug_tracker_uri: https://github.com/postmodern/command_mapper.rb/issues
+  changelog_uri: https://github.com/postmodern/command_mapper.rb/blob/master/ChangeLog.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Safe and secure execution of commands.
+test_files: []