ronin-core 0.1.0.beta1

data/spec/params/types/string_spec.rb

@@ -0,0 +1,174 @@
+require 'spec_helper'
+require 'ronin/core/params/types/string'
+
+describe Ronin::Core::Params::Types::String 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
+
+    it "must default #format to nil" do
+      expect(subject.format).to be(nil)
+    end
+    
+    context "when given the format: keyword argument" do
+      let(:format) { /foo/ }
+
+      subject { described_class.new(format: format) }
+
+      it "must set #format" do
+        expect(subject.format).to eq(format)
+      end
+    end
+  end
+
+  describe "#allow_empty?" do
+    context "when initialized with allow_empty: true" do
+      subject { described_class.new(allow_empty: true) }
+
+      it "must return true" do
+        expect(subject.allow_empty?).to be(true)
+      end
+    end
+
+    context "when initialized with allow_empty: false" do
+      subject { described_class.new(allow_empty: false) }
+
+      it "must return false" do
+        expect(subject.allow_empty?).to be(false)
+      end
+    end
+  end
+
+  describe "#allow_blank?" do
+    context "when initialized with allow_blank: true" do
+      subject { described_class.new(allow_blank: true) }
+
+      it "must return true" do
+        expect(subject.allow_blank?).to be(true)
+      end
+    end
+
+    context "when initialized with allow_blank: false" do
+      subject { described_class.new(allow_blank: false) }
+
+      it "must return false" do
+        expect(subject.allow_blank?).to be(false)
+      end
+    end
+  end
+
+  describe "#coerce" do
+    context "when given an Enumerable" do
+      let(:value) { ["foo", "bar"] }
+
+      it do
+        expect {
+          subject.coerce(value)
+        }.to raise_error(Ronin::Core::Params::ValidationError,"cannot convert an Enumerable into a String (#{value.inspect})")
+      end
+    end
+
+    context "when given a String" do
+      let(:value) { "foo" }
+
+      it "must return the String" do
+        expect(subject.coerce(value)).to eq(value)
+      end
+
+      context "but when #format is set" do
+        subject { described_class.new(format: /foo/) }
+
+        context "and the given value matches #format" do
+          it "must return the String value" do
+            expect(subject.coerce(value)).to eq(value)
+          end
+        end
+
+        context "but the given value does not match #format" do
+          let(:value) { "bar" }
+
+          it do
+            expect {
+              subject.coerce(value)
+            }.to raise_error(Ronin::Core::Params::ValidationError,"does not match the format (#{value.inspect})")
+          end
+        end
+      end
+
+      context "but the string is empty" do
+        let(:value) { "" }
+
+        it do
+          expect {
+            subject.coerce(value)
+          }.to raise_error(Ronin::Core::Params::ValidationError,"value cannot be empty")
+        end
+
+        context "and when initialized with allow_empty: true" do
+          subject { described_class.new(allow_empty: true) }
+
+          it "must return the empty String" do
+            expect(subject.coerce(value)).to eq(value)
+          end
+        end
+      end
+
+      context "but the String is all whitespace" do
+        let(:value) { " \t\n\r" }
+
+        it do
+          expect {
+            subject.coerce(value)
+          }.to raise_error(Ronin::Core::Params::ValidationError,"value cannot contain all whitespace (#{value.inspect})")
+        end
+
+        context "and when initialized with allow_blank: true" do
+          subject { described_class.new(allow_blank: true) }
+
+          it "must return the blank String" do
+            expect(subject.coerce(value)).to eq(value)
+          end
+        end
+      end
+    end
+
+    context "when given a non-String object" do
+      context "and it defines a #to_s method" do
+        module TestTypesString
+          class ObjectWithToS
+            def to_s
+              "foo"
+            end
+          end
+        end
+
+        let(:value) { TestTypesString::ObjectWithToS.new }
+
+        it "must call #to_s on the value" do
+          expect(subject.coerce(value)).to eq(value.to_s)
+        end
+      end
+
+      context "but it does not respond to #to_s" do
+        module TestTypesString
+          class ObjectWithoutToS
+            undef to_s
+          end
+        end
+
+        let(:value) { TestTypesString::ObjectWithoutToS.new }
+
+        it do
+          expect {
+            subject.coerce(value)
+          }.to raise_error(Ronin::Core::Params::ValidationError,"value does not define a #to_s method (#{value.inspect})")
+        end
+      end
+    end
+  end
+end

data/spec/params/types/type_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'ronin/core/params/types/type'
+
+describe Ronin::Core::Params::Types::Type do
+  describe "#corece" do
+    let(:value) { Object.new }
+
+    it do
+      expect {
+        subject.coerce(value)
+      }.to raise_error(NotImplementedError,"#{described_class}#coerce method was not implemented")
+    end
+  end
+end

data/spec/params/types/uri_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+require 'ronin/core/params/types/uri'
+
+describe Ronin::Core::Params::Types::URI do
+  describe "#coerce" do
+    context "when given a Regexp value" do
+      let(:value) { URI('https://example.com/') }
+
+      it "must return the Regexp" do
+        expect(subject.coerce(value)).to eq(value)
+      end
+    end
+
+    context "when given a String value" do
+      let(:value) { "https://example.com/" }
+
+      it "must parse the String as a URI" do
+        expect(subject.coerce(value)).to eq(URI.parse(value))
+      end
+
+      context "but the String is empty" do
+        let(:value) { "" }
+
+        it do
+          expect {
+            subject.coerce(value)
+          }.to raise_error(Ronin::Core::Params::ValidationError,"value must not be empty")
+        end
+      end
+
+      context "but the String does not start with a 'scheme:'" do
+        let(:value) { "foo" }
+
+        it do
+          expect {
+            subject.coerce(value)
+          }.to raise_error(Ronin::Core::Params::ValidationError,"value must start with a 'scheme:' (#{value.inspect})")
+        end
+      end
+
+      context "but the String cannot be parsed as a valid URI" do
+        let(:value) { "https:// \n" }
+
+        it do
+          expect {
+            subject.coerce(value)
+          }.to raise_error(Ronin::Core::Params::ValidationError,"value is not a valid URI (#{value.inspect})")
+        end
+      end
+    end
+
+    context "when given a non-URI and non-String value" do
+      let(:value) { Object.new }
+
+      it do
+        expect {
+          subject.coerce(value)
+        }.to raise_error(Ronin::Core::Params::ValidationError,"value must be either a String or a URI (#{value.inspect})")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rspec'
+require 'simplecov'
+SimpleCov.start
+
+ENV.delete('XDG_CACHE_HOME')
+ENV.delete('XDG_CONFIG_HOME')
+ENV.delete('XDG_DATA_HOME')
+
+require 'ronin/core/version'
+
+include Ronin

metadata

@@ -0,0 +1,252 @@
+--- !ruby/object:Gem::Specification
+name: ronin-core
+version: !ruby/object:Gem::Version
+  version: 0.1.0.beta1
+platform: ruby
+authors:
+- Postmodern
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: reline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: command_kit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !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: |
+  ronin-core is a core library providing common functionality for all ronin
+  libraries.
+email: postmodern.mod3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- COPYING.txt
+- ChangeLog.md
+- README.md
+files:
+- ".document"
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".yardopts"
+- COPYING.txt
+- ChangeLog.md
+- Gemfile
+- README.md
+- Rakefile
+- examples/ruby_shell.rb
+- gemspec.yml
+- lib/ronin/core/class_registry.rb
+- lib/ronin/core/cli/command.rb
+- lib/ronin/core/cli/command_shell.rb
+- lib/ronin/core/cli/command_shell/command.rb
+- lib/ronin/core/cli/generator.rb
+- lib/ronin/core/cli/generator/options/author.rb
+- lib/ronin/core/cli/generator/options/description.rb
+- lib/ronin/core/cli/generator/options/reference.rb
+- lib/ronin/core/cli/generator/options/summary.rb
+- lib/ronin/core/cli/logging.rb
+- lib/ronin/core/cli/options/param.rb
+- lib/ronin/core/cli/options/values/arches.rb
+- lib/ronin/core/cli/options/values/oses.rb
+- lib/ronin/core/cli/printing/arch.rb
+- lib/ronin/core/cli/printing/metadata.rb
+- lib/ronin/core/cli/printing/os.rb
+- lib/ronin/core/cli/printing/params.rb
+- lib/ronin/core/cli/ruby_shell.rb
+- lib/ronin/core/cli/shell.rb
+- lib/ronin/core/git.rb
+- lib/ronin/core/home.rb
+- lib/ronin/core/metadata/authors.rb
+- lib/ronin/core/metadata/authors/author.rb
+- lib/ronin/core/metadata/description.rb
+- lib/ronin/core/metadata/id.rb
+- lib/ronin/core/metadata/references.rb
+- lib/ronin/core/metadata/summary.rb
+- lib/ronin/core/metadata/version.rb
+- lib/ronin/core/params.rb
+- lib/ronin/core/params/exceptions.rb
+- lib/ronin/core/params/mixin.rb
+- lib/ronin/core/params/param.rb
+- lib/ronin/core/params/types.rb
+- lib/ronin/core/params/types/boolean.rb
+- lib/ronin/core/params/types/enum.rb
+- lib/ronin/core/params/types/float.rb
+- lib/ronin/core/params/types/integer.rb
+- lib/ronin/core/params/types/numeric.rb
+- lib/ronin/core/params/types/regexp.rb
+- lib/ronin/core/params/types/string.rb
+- lib/ronin/core/params/types/type.rb
+- lib/ronin/core/params/types/uri.rb
+- lib/ronin/core/version.rb
+- ronin-core.gemspec
+- spec/class_registry_spec.rb
+- spec/cli/command_shell/command_spec.rb
+- spec/cli/command_shell_spec.rb
+- spec/cli/command_spec.rb
+- spec/cli/fixtures/irb_command
+- spec/cli/fixtures/template/dir/file1.txt
+- spec/cli/fixtures/template/dir/file2.txt
+- spec/cli/fixtures/template/file.erb
+- spec/cli/fixtures/template/file.txt
+- spec/cli/generator/options/author_spec.rb
+- spec/cli/generator/options/description_spec.rb
+- spec/cli/generator/options/reference_spec.rb
+- spec/cli/generator/options/summary_spec.rb
+- spec/cli/generator_spec.rb
+- spec/cli/logging_spec.rb
+- spec/cli/options/param_spec.rb
+- spec/cli/options/values/arches_spec.rb
+- spec/cli/printing/arch_spec.rb
+- spec/cli/printing/metadata_spec.rb
+- spec/cli/printing/os_spec.rb
+- spec/cli/printing/params_spec.rb
+- spec/cli/ruby_shell.rb
+- spec/cli/shell_spec.rb
+- spec/fixtures/example_class_registry.rb
+- spec/fixtures/example_class_registry/base_class.rb
+- spec/fixtures/example_class_registry/classes/loaded_class.rb
+- spec/fixtures/example_class_registry/classes/name_mismatch.rb
+- spec/fixtures/example_class_registry/classes/no_module.rb
+- spec/git_spec.rb
+- spec/home_spec.rb
+- spec/metadata/authors/author_spec.rb
+- spec/metadata/authors_spec.rb
+- spec/metadata/description_spec.rb
+- spec/metadata/id_spec.rb
+- spec/metadata/references_spec.rb
+- spec/metadata/summary_spec.rb
+- spec/metadata/version_spec.rb
+- spec/params/mixin_spec.rb
+- spec/params/param_spec.rb
+- spec/params/types/boolean_spec.rb
+- spec/params/types/enum_spec.rb
+- spec/params/types/float_spec.rb
+- spec/params/types/integer_spec.rb
+- spec/params/types/numeric_spec.rb
+- spec/params/types/regexp_spec.rb
+- spec/params/types/string_spec.rb
+- spec/params/types/type_spec.rb
+- spec/params/types/uri_spec.rb
+- spec/spec_helper.rb
+homepage: https://ronin-rb.dev/
+licenses:
+- LGPL-3.0
+metadata:
+  documentation_uri: https://rubydoc.info/gems/ronin-core
+  source_code_uri: https://github.com/ronin-rb/ronin-core
+  bug_tracker_uri: https://github.com/ronin-rb/ronin-core/issues
+  changelog_uri: https://github.com/ronin-rb/ronin-core/blob/main/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: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: A core library for all ronin libraries.
+test_files:
+- spec/class_registry_spec.rb
+- spec/cli/command_shell/command_spec.rb
+- spec/cli/command_shell_spec.rb
+- spec/cli/command_spec.rb
+- spec/cli/generator/options/author_spec.rb
+- spec/cli/generator/options/description_spec.rb
+- spec/cli/generator/options/reference_spec.rb
+- spec/cli/generator/options/summary_spec.rb
+- spec/cli/generator_spec.rb
+- spec/cli/logging_spec.rb
+- spec/cli/options/param_spec.rb
+- spec/cli/options/values/arches_spec.rb
+- spec/cli/printing/arch_spec.rb
+- spec/cli/printing/metadata_spec.rb
+- spec/cli/printing/os_spec.rb
+- spec/cli/printing/params_spec.rb
+- spec/cli/shell_spec.rb
+- spec/git_spec.rb
+- spec/home_spec.rb
+- spec/metadata/authors/author_spec.rb
+- spec/metadata/authors_spec.rb
+- spec/metadata/description_spec.rb
+- spec/metadata/id_spec.rb
+- spec/metadata/references_spec.rb
+- spec/metadata/summary_spec.rb
+- spec/metadata/version_spec.rb
+- spec/params/mixin_spec.rb
+- spec/params/param_spec.rb
+- spec/params/types/boolean_spec.rb
+- spec/params/types/enum_spec.rb
+- spec/params/types/float_spec.rb
+- spec/params/types/integer_spec.rb
+- spec/params/types/numeric_spec.rb
+- spec/params/types/regexp_spec.rb
+- spec/params/types/string_spec.rb
+- spec/params/types/type_spec.rb
+- spec/params/types/uri_spec.rb