basic_url 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7f10e56f551ec196327c0a2976c49e36a68270ac1bfebee851cd1780916f61d7
+  data.tar.gz: 26c1b5b16d7ced8dffc962fbaab4f332a3cb958a7f57dd1197e2a98d06e1cb8e
+SHA512:
+  metadata.gz: faa9b663146901b711854535d862218f3d3fa75b08d10c2b0bc0a4d54c38b731aa917ad9f558555df1ac9fa1f3604df45a7a057fcbb3c7f1bb85d59835bc5ed3
+  data.tar.gz: 0f292a5a51c9ffb75cb451417e590fd6a339c350127058b046f9c6038b25fb49855b4f87cfa686504bb9d3987faef9fb8f4fb7a24fc3f2a65b3ee030296e84f0

data/.rubocop.yml

@@ -0,0 +1,68 @@
+AllCops:
+  TargetRubyVersion: 3.2
+  NewCops: enable
+  SuggestExtensions: false
+
+Layout/LineLength:
+  Max: 180
+
+# Just turn off the metrics cops.  Long lines and methods are fine.
+# This project prefers large, logical blocks to "papering the wall with post-its"
+Metrics:
+  Enabled: false
+
+# 'exc' is just as good, if not better, as 'e'
+Naming/RescuedExceptionsVariableName:
+  Enabled: false
+
+# 123_456 doesn't add value IMO.
+NumericLiterals:
+  Enabled: false
+
+# Favor explicit over implicit code: don't complain of "redundant returns"
+RedundantReturn:
+  Enabled: false
+
+Style/ArgumentsForwarding:
+  UseAnonymousForwarding: false
+
+# A "This class manages the App Config" comment on App::Config has no value.
+Style/Documentation:
+  Enabled: false
+
+# This cop can result in incompatible code
+Style/EmptyLiteral:
+  Enabled: false
+
+# Ruby 3.0 upgrade cop
+# Literally recommends "magic" code.
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/HashSyntax:
+  # Explicit over implicit code
+  EnforcedShorthandSyntax: never
+
+# value == 0 is fine, value.zero? is syntactic nonsense.
+Style/NumericPredicate:
+  Enabled: false
+
+# Not adding parenthesis can introduce bugs in complex conditions
+Style/ParenthesesAroundCondition:
+  Enabled: false
+
+# Not adding parenthesis can introduce bugs in complex conditions
+Style/RedundantParentheses:
+  Enabled: false
+
+# Do not remove explicit range ends
+Style/SlicingWithRange:
+  Enabled: false
+
+# Allow $? instead of $CHILD_STATUS (which isn't native)
+Style/SpecialGlobalVars:
+  Enabled: false
+
+# Enforce trailing commas on multiline hashes.  This reduces developer error.
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/.ruby-version

@@ -0,0 +1 @@
+3.2.3

data/.versions

@@ -0,0 +1,6 @@
+# DO NOT EDIT.  This file is automatically generated
+# This project is versioned with Semantic Versioning: https://semver.org/
+# Use ./cicd/manage_version.sh to increment the major or minor versions (Supports -h for help).
+# This file contains MAJOR.MINOR, PATCH is incremented by the build system to prevent overwriting tags.
+0.1.0    6ce56b44c6ba4e20f4b234a29ce9615d3e805ab0
+0.1.1	6c32353c8e1a8162c700b53a82582d020e1dda8b

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+BasicUrl Changelog
+==================
+
+0.1.0
+-----
+
+Initial Release

data/LICENSE.md

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/Makefile

@@ -0,0 +1,14 @@
+all: test lint
+
+build: test lint
+	./cicd/build_gem.sh
+
+lint:
+	bundle exec rubocop
+
+push:
+	./cicd/push_gem.sh
+
+test:
+	bundle exec rspec
+

data/README.md

@@ -0,0 +1,72 @@
+BasicUrl
+========
+
+A simple Ruby module that provides basic URL operations.
+
+This implementation supports:
+
+- Object oriented operations (`obj.join(component)` instead of `MODULE.join(obj, component)`)
+- Easy URL encoding
+- Joining relative paths (`obj('a/b').join('c')` returns `a/b/c` not `a/c`)
+
+This gem *does not try to be RFC compliant when joining URLs.*
+
+Given that the majority of other implementations all do some degree of shenanigans when joining URLs it's assumed that `a/b/c` + `d` = `a/d` is buried in a spec somewhere.
+This library does not do that, it does `a/b/c` + `d` = `a/b/c/d`, which is what is needed in 99% of cases.
+If you need full RFC compliance this gem is not suitable.
+
+
+## Usage
+
+```ruby
+require 'BasicURL'
+
+base_url = BasicUrl.parse('192.0.2.64/api/v1', default_protocol: 'https')
+
+puts(base_url.path)
+# api/v1
+
+# Basic joining, returns a new object
+# join! is also available to update the current object
+controller = base_url.join('some/controller')
+puts controller.path
+# api/v1/some/controller
+
+# By default absolute paths replace
+controller = base_url.join('/some/controller')
+puts controller.path
+# some/controller
+
+# But this is selectable
+controller = base_url.join('/some/controller', replace_when_absolute: false)
+puts controller.path
+# api/v1/some/controller             
+
+# To get a URL string call .to_s
+puts controller.to_s
+# https://192.0.2.64/api/v1/some/controller
+
+# Path components are URL encoded by default
+puts BasicUrl.new(protocol: 'http', host: 'foo.local', path: '/api/v0/some path/with spaces', params: { key: 'value:1', key2: 'Value!', key3: ['and', 'arrays']}).to_s
+# http://foo.local/api/v0/some+path/with+spaces?key=value%3A1&key2=Value%21&key3[]=and&key3[]=arrays
+
+# Query parameters can also be added with params=.  This modifies the object
+controller = base_url.join('some/controller')
+
+controller.params = { key1: 'val1' }
+controller.params[:key2] = 'val2'
+puts controller.to_s
+# https://192.0.2.64/api/v1/some/controller?key1=val1&key2=val2
+```
+
+## Contributing
+
+All support is through Github issues.
+Questions, bug reports and pull requests are accepted at https://github.com/TJNII/basic_url.
+
+This is an opinionated project, the author was finally annoyed enough by using Pathname to join URL components to publish this.
+This project will not support the `a + b + c + d = d` behavior of other implementations, if you require that perhaps Adressable::URI would be better.
+
+For the quickest response please add a test case.
+
+Hope this helped you, have a good day.

data/basic_url.gemspec

@@ -0,0 +1,31 @@
+Gem::Specification.new do |spec|
+  spec.name = 'basic_url'
+  spec.version = `./cicd/current_gem_version.sh`
+  spec.authors = ['Tom Noonan II']
+  spec.email = ['tom@tjnii.com']
+  spec.licenses = ['Apache-2.0']
+
+  spec.summary = 'A Basic URL object that supports common URL operations'
+  spec.description = 'Implements a simple URL object supporting object oriented paradigms, basic as-you-expect path joins, and native URLencoding.'
+  spec.homepage = 'https://github.com/TJNII/basic_url'
+  spec.required_ruby_version = '>= 3.2.0'
+
+  #  spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata['homepage_uri'] = 'https://github.com/TJNII/basic_url'
+  spec.metadata['source_code_uri'] = 'https://github.com/TJNII/basic_url'
+  spec.metadata['changelog_uri'] = 'https://github.com/TJNII/basic_url/blob/master/CHANGELOG.md'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/cicd/_version_common.sh

@@ -0,0 +1,44 @@
+#!/bin/bash
+# Common version handling for ci/cd scripts
+# https://semver.org/
+
+set -euo pipefail
+
+SCRIPT_DIR=$(dirname "$0")
+SOURCE_DIR=$(dirname "${SCRIPT_DIR}")
+
+if [ -n "$(git status -s "${SOURCE_DIR}")" ]; then
+    SEMVER_PREFIXED_PRERELEASE="-dirty"
+    REPO_CLEAN=false
+else
+    SEMVER_PREFIXED_PRERELEASE=""
+    REPO_CLEAN=true
+fi
+
+PRIMARY_VERSION_FILE="${SOURCE_DIR}/.versions"
+if [ ! -f "${PRIMARY_VERSION_FILE}" ]; then
+    echo >&2 "ERROR: Version file ${PRIMARY_VERSION_FILE} not found"
+    echo "FAULT"
+    exit 1
+fi
+
+LAST_VERSION=$(grep "^[0-9]\+\.[0-9]\+\.[0-9]\+[[:space:]]\+[0-9a-f]\+$" "${PRIMARY_VERSION_FILE}" | tail -n 1)
+
+SEMVER_VERSION_MAJOR=$(echo "$LAST_VERSION" | awk '{print $1}' | cut -f 1 -d .)
+SEMVER_VERSION_MINOR=$(echo "$LAST_VERSION" | awk '{print $1}' | cut -f 2 -d .)
+SEMVER_VERSION_PATCH=$(echo "$LAST_VERSION" | awk '{print $1}' | cut -f 3 -d .)
+VERSION_LAST_SHA=$(echo "$LAST_VERSION" | awk '{print $2}')
+
+# Patch is the count of commits since the last Version file line sha
+# ~1 is because git omits the trailing newline when outputting to a pipe, making it imposible to tell 0 commits from 1 with wc alone,
+#  And to make sure something is output to avoid a pipefail
+# The grep ensures each line has a newline.
+SEMVER_NEW_VERSION_PATCH=$(git log --pretty=format:"%H" "${VERSION_LAST_SHA}"~1.. "${SOURCE_DIR}" | wc -l)
+
+if [ $SEMVER_NEW_VERSION_PATCH -lt $SEMVER_VERSION_PATCH -a $REPO_CLEAN == "true" ]; then
+    echo >&2 "ERROR: Git patch version $SEMVER_NEW_VERSION_PATCH less than released patch version $SEMVER_VERSION_PATCH"
+    echo ERROR
+    exit 1
+fi
+
+CUR_SEMVER="${SEMVER_VERSION_MAJOR}.${SEMVER_VERSION_MINOR}.${SEMVER_VERSION_PATCH}"

data/cicd/build_gem.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+# Pulled out of the Makefile because Make's variable handling is screwball.
+
+set -euo pipefail
+
+./cicd/manage_version.sh -r
+
+out_version=$(./cicd/current_gem_version.sh)
+out_file="out/basic_url.$(./cicd/current_gem_version.sh).gem"
+
+gem build -o "${out_file}"

data/cicd/current_gem_version.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+set -euo pipefail
+
+SCRIPT_DIR=$(dirname "$0")
+source "${SCRIPT_DIR}/_version_common.sh"
+
+echo "$CUR_SEMVER"
+exit 0

data/cicd/manage_version.sh

@@ -0,0 +1,99 @@
+#!/bin/bash
+# This is helper utility for bumping project release versions.
+# Intended to be run interactively as part of PR generation.
+
+set -euo pipefail
+
+SCRIPT_DIR=$(dirname "$0")
+source "${SCRIPT_DIR}/_version_common.sh"
+
+function show_help {
+    echo "$0: Manage project version"
+    echo "  -c: Show if repo is clean"
+    echo "  -m: Increment minor"
+    echo "  -M: Increment major"
+    echo "  -r: Cut release version"
+    echo "  -s: Show current full version"
+    echo ""
+    echo "Patch, pre-release, and build are automatic."
+    echo "Major/minor bumps are written to ${PRIMARY_VERSION_FILE} which needs to be comitted into the repo."
+    exit 0
+}
+
+ACTION="default"
+
+while getopts ":chMmrs" arg; do
+    case $arg in
+        h)
+            show_help
+            ;;
+        c)
+            echo "${REPO_CLEAN}"
+            exit 0
+            ;;
+        s)
+            echo "${CUR_SEMVER}"
+            exit 0
+            ;;
+        M)
+            ACTION="inc_major"
+            ;;
+        m)
+            ACTION="inc_minor"
+            ;;
+        r)
+            ACTION="release"
+            ;;
+        *)
+            echo "INTERNAL ERROR: option fallthrough"
+            exit 1
+            ;;
+    esac
+done
+
+if [ $ACTION == default ]; then
+    show_help
+fi
+
+if [ ${REPO_CLEAN} != true ]; then
+    echo "ERROR: Repo git state is dirty"
+    echo "Version automation is git sha based, cannot version uncomitted files."
+    echo "Clean git state and retry."
+    exit 1
+fi
+
+case $ACTION in
+    inc_major)
+        NEW_SEMVER_VERSION_MAJOR=$((${SEMVER_VERSION_MAJOR} + 1))
+        NEW_SEMVER_VERSION_MINOR=0
+        ;;
+    inc_minor)
+        NEW_SEMVER_VERSION_MAJOR=${SEMVER_VERSION_MAJOR}
+        NEW_SEMVER_VERSION_MINOR=$((${SEMVER_VERSION_MINOR} + 1))
+        ;;
+    release)
+         NEW_SEMVER_VERSION_MAJOR=${SEMVER_VERSION_MAJOR}
+         NEW_SEMVER_VERSION_MINOR=${SEMVER_VERSION_MINOR}
+        ;;
+    *)
+        echo "INTERNAL ERROR: Action fallthrough"
+        exit 1
+        ;;
+esac
+
+SOURCE_GIT_SHA=$(git log  --pretty=format:"%H" -1 "${SOURCE_DIR}")
+NEW_SEMVER="${NEW_SEMVER_VERSION_MAJOR}.${NEW_SEMVER_VERSION_MINOR}.${SEMVER_NEW_VERSION_PATCH}"
+
+if [ "${NEW_SEMVER}" == "${CUR_SEMVER}" ]; then
+    if [ "${ACTION}" == "RELEASE" ]; then
+        echo "No change: Version ${CUR_SEMVER}"
+        exit 0
+    else
+        echo "ERROR: Version ${CUR_SEMVER} failed to increment"
+        exit 1
+    fi
+fi
+
+echo "Incrementing version from ${CUR_SEMVER} to ${NEW_SEMVER} on commit ${SOURCE_GIT_SHA}"
+echo -e "${NEW_SEMVER}\t${SOURCE_GIT_SHA}" >> "${PRIMARY_VERSION_FILE}"
+exit 0

data/cicd/push_gem.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+# Pulled out of the Makefile because Make's variable handling is screwball.
+
+set -euo pipefail
+
+out_version=$(./cicd/current_gem_version.sh)
+out_file="out/basic_url.$(./cicd/current_gem_version.sh).gem"
+
+gem push --otp "${out_file}"
+git tag "${out_version}"

data/lib/basic_url/errors.rb

@@ -0,0 +1,27 @@
+# Licensed under the Apache 2 License
+# (C)2024 Tom Noonan II
+
+class BasicUrl
+  module Errors
+    class BasicUrlError < StandardError
+    end
+
+    class InternalError < StandardError
+    end
+
+    #
+    # Input Validation Errors
+    #
+    class ValidationFault < StandardError
+    end
+
+    class ComponentTypeError < ValidationFault
+    end
+
+    class InvalidComponent < ValidationFault
+    end
+
+    class InvalidURL < ValidationFault
+    end
+  end
+end

data/lib/basic_url.rb

@@ -0,0 +1,270 @@
+# Licensed under the Apache 2 License
+# (C)2024 Tom Noonan II
+
+require 'uri'
+require_relative 'basic_url/errors'
+
+class BasicUrl
+  def self.urldecode_component(input)
+    return nil if input.nil?
+
+    return URI.decode_www_form_component(input)
+  end
+
+  def self.parse(input, **kwargs)
+    input = input.downcase
+
+    # URI.parse does all kinds of oddball grouping if it doesn't have a protocol
+    # Parse the protocol out ourself, injecting a placeholder if needed
+    proto_match = input.match(%r{^(?<proto>[a-z0-9]+)://})
+    if proto_match
+      proto = proto_match[:proto]
+    else
+      proto = nil
+      input = "DUMMY://#{input}"
+    end
+
+    begin
+      uri_obj = URI.parse(input)
+    rescue StandardError => exc
+      raise(Errors::InvalidURL, "Failed to parse URL #{input}: #{exc.class}: #{exc}")
+    end
+
+    params_hash = {}
+
+    if uri_obj.query
+      begin
+        params_array = uri_obj.query.split('&').map { |qc| qc.split('=') }
+        params_array.each.with_index do |pair, index|
+          raise(Errors::InvalidURL, "Parameter #{pair} at index #{index + 1} failed to parse as a key-value pair") if pair.length != 2
+
+          value = urldecode_component(pair[1])
+
+          if pair[0][-2..-1] == '[]'
+            key = urldecode_component(pair[0][0..-3])
+            params_hash[key] ||= []
+            params_hash[key].push(value)
+          else
+            key = urldecode_component(pair[0])
+            params_hash[key] = value
+          end
+        end
+      rescue StandardError => exc
+        raise(Errors::InvalidURL, "Failed to parse URL #{input} query parameters: #{exc.class}: #{exc}")
+      end
+    end
+
+    components = {
+      protocol: proto,
+      host: uri_obj.host,
+      port: uri_obj.port,
+      path: uri_obj.path,
+      params: params_hash,
+      fragment: urldecode_component(uri_obj.fragment),
+      user: urldecode_component(uri_obj.user),
+      password: urldecode_component(uri_obj.password),
+    }.reject { |_, v| v.to_s.empty? }
+
+    return new(**kwargs.merge(components))
+  end
+
+  attr_reader :default_protocol, :fragment, :host, :params, :password, :path_components, :port, :protocol, :user
+
+  %i[protocol host port path_components params fragment user password].each do |component|
+    define_method("#{component}=") do |value|
+      _validate_component(component: component, value: value)
+      instance_variable_set("@#{component}", value)
+    end
+  end
+
+  def initialize(**kwargs)
+    @path_components = []
+    @default_protocol = kwargs.delete(:default_protocol)
+
+    raise(ArgumentError, ':path and :path_components are exclusive') if kwargs.key(:path) && kwargs.key(:path_components)
+
+    defaults = {
+      protocol: @default_protocol,
+      host: nil,
+      port: _default_port_for_protocol(protocol: @default_protocol),
+      params: {},
+      fragment: nil,
+      user: nil,
+      password: nil,
+    }
+
+    defaults.merge(kwargs.compact).sort.each do |component, value|
+      send("#{component}=", value)
+    end
+  end
+
+  def join(value, replace_when_absolute: true)
+    _validate_component(component: :path, value: value)
+    new_components = _path_to_a(value: value)
+
+    rv = dup
+
+    rv.path_components = if replace_when_absolute && value[0] == '/'
+                           new_components
+                         else
+                           @path_components + new_components
+                         end
+
+    return rv
+  end
+
+  def join!(value, replace_when_absolute: true)
+    _validate_component(component: :path, value: value)
+    new_components = _path_to_a(value: value)
+
+    if replace_when_absolute && value[0] == '/'
+      @path_components  = new_components
+    else
+      @path_components += new_components
+    end
+
+    return path
+  end
+
+  def path=(value)
+    if value.nil?
+      @path_components = []
+    else
+      _validate_component(component: :path, value: value)
+      @path_components = _path_to_a(value: value)
+    end
+  end
+
+  def path
+    return nil if @path_components.empty?
+
+    return @path_components.join('/')
+  end
+
+  def path_encoded
+    return nil if @path_components.empty?
+
+    return @path_components.map { |c| urlencode_component(c) }.join('/')
+  end
+
+  def to_s
+    %i[protocol host].each do |required_component|
+      raise(Errors::InvalidURL, "Missing #{required_component}") unless send(required_component)
+    end
+
+    ret_val = "#{protocol}://"
+    if user || password
+      ret_val += urlencode_component(user) if user
+      ret_val += ":#{urlencode_component(password)}" if password
+      ret_val += '@'
+    end
+
+    ret_val += host
+    ret_val += ":#{port}" if port && port != _default_port_for_protocol(protocol: protocol)
+    ret_val += "/#{path_encoded}" unless @path_components.empty?
+    ret_val += _query_string unless params.empty?
+    ret_val += "##{urlencode_component(fragment)}" if fragment
+
+    return ret_val
+  end
+
+  def urlencode_component(value)
+    return URI.encode_www_form_component(value.to_s)
+  end
+
+  private
+
+  def _default_port_for_protocol(protocol:)
+    return nil if protocol.nil?
+
+    rv = URI.parse("#{protocol}://").port
+    return rv
+  end
+
+  def _query_string
+    encoded_components = []
+
+    params.each_pair do |key, value|
+      encoded_key = urlencode_component(key)
+      if value.is_a? Array
+        value.map { |v| urlencode_component(v) }.each do |encoded_value|
+          encoded_components.push("#{encoded_key}[]=#{encoded_value}")
+        end
+      else
+        encoded_value = urlencode_component(value)
+        encoded_components.push("#{encoded_key}=#{encoded_value}")
+      end
+    end
+
+    return "?#{encoded_components.join('&')}"
+  end
+
+  def _path_to_a(value:)
+    value.split('/').reject(&:empty?).map { |c| self.class.urldecode_component(c) }
+  end
+
+  def _validate_component(**kwargs)
+    if kwargs.fetch(:value).nil?
+      raise(Errors::InvalidComponent, "nil #{kwargs.fetch(:component)} not allowed") if %i[params].include?(kwargs.fetch(:component))
+
+      return
+    end
+
+    _validate_component_type(**kwargs)
+    _validate_component_characters(**kwargs)
+  end
+
+  def _validate_component_characters(component:, value:)
+    case component
+    when :default_protocol, :protocol
+      # Basic URL building symbols
+      disallowed_chars = %w[@ : / ? & #]
+    when :host
+      disallowed_chars = if value[0] == '[' && value[-1] == ']'
+                           # IPv6
+                           # This should technically be more strict, but this is a minimal sanity check
+                           %w[@ / ? & #]
+                         else
+                           %w[@ : / ? & #]
+                         end
+    when :path
+      disallowed_chars = %w[? #]
+    when :path_components
+      value.each do |comp|
+        _validate_component_characters(component: :path, value: comp)
+      end
+
+      return
+    when :port, :params, :fragment, :user, :password
+      # port: integer: Nothing to do
+      # params: hash, urlencoded
+      # user: urlencoded
+      # password: urlencoded
+      return
+    else
+      raise(Errors::InternalError, "Unknown component #{component}")
+    end
+
+    disallowed_chars.each do |dchar|
+      raise(Errors::InvalidComponent, "#{component} contains disallowed character #{dchar}") if value.include?(dchar)
+    end
+  end
+
+  def _validate_component_type(component:, value:)
+    types = {
+      default_protocol: String,
+      protocol: String,
+      host: String,
+      port: Integer,
+      path: String,
+      path_components: Array,
+      params: Hash,
+      fragment: String,
+      user: String,
+      password: String,
+    }
+
+    raise(Errors::InternalError, "Unknown component #{component}") unless types.key?(component)
+    raise(Errors::ComponentTypeError, "#{component} must be a #{types[component]}, got a #{value.class} (#{value})") unless value.is_a?(types[component])
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: basic_url
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Tom Noonan II
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-11 00:00:00.000000000 Z
+dependencies: []
+description: Implements a simple URL object supporting object oriented paradigms,
+  basic as-you-expect path joins, and native URLencoding.
+email:
+- tom@tjnii.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".ruby-version"
+- ".versions"
+- CHANGELOG.md
+- LICENSE.md
+- Makefile
+- README.md
+- basic_url.gemspec
+- cicd/_version_common.sh
+- cicd/build_gem.sh
+- cicd/current_gem_version.sh
+- cicd/manage_version.sh
+- cicd/push_gem.sh
+- lib/basic_url.rb
+- lib/basic_url/errors.rb
+homepage: https://github.com/TJNII/basic_url
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/TJNII/basic_url
+  source_code_uri: https://github.com/TJNII/basic_url
+  changelog_uri: https://github.com/TJNII/basic_url/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: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.6
+signing_key:
+specification_version: 4
+summary: A Basic URL object that supports common URL operations
+test_files: []