url_builder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1b8b72829b787ec5055b35e86442c636ec2ac0a407df01d3ab42b5c886fda301
+  data.tar.gz: c2974c6ca969693e7c7d6f9de9007d6c3f4a0e71d558cd106777fea66d7e0707
+SHA512:
+  metadata.gz: fca4e15976d4a029a08d1319fa3b23851cc83fbf609ecac9db84d6cd9a5fd53cf7f8db0afab03db6f07d38743bf75913c6c697ce37e8618c7171650e210ff649
+  data.tar.gz: acaa931863a6557d83e998400f487ab67bd9c49baa59b43b9a15035c8ee1b1179d34492b59c83ba083ce7fc78da0e8e71c6ae15fbdfc3832b2daae6cbad634b5

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-07-05
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in url_builder.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    url_builder (0.1.0)
+      activesupport (~> 7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.2)
+    minitest (5.16.2)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.31.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.2.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rspec (~> 3.11)
+  rubocop (~> 1.21)
+  url_builder!
+
+BUNDLED WITH
+   2.3.13

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# UrlBuilder
+
+A simple ruby implementation of the builder pattern to create urls. 
+Supports dynamically adding path segments and query parameters as well as custom path segment separator characters.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add url_builder
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install url_builder
+
+## Usage
+
+Instantiate the builder class with the base url and then add segments and query params as needed.
+
+    builder = UrlBuilder::Builder.new(base_url: 'www.example.com')
+    builder.add_segment("foo")
+    builder.add_segment("bar")
+    builder.add_query_param("key", "value")
+    builder.to_s # "www.example.com/foo/bar?key=value"
+ 
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/url_builder.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+rescue StandardError
+  nil
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/url_builder/builder.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/core_ext"
+
+module UrlBuilder
+  # A builder class to construct a url with path segments and query params
+  class Builder
+    # @param [String] base_url the base url to use. Must include the protocol
+    # @param [String] separator - optional path segment separator to use, defaults to '/'
+    # @param [Hash] query_params - optional query params to use
+    def initialize(base_url:, separator: "/", query_params: {})
+      @base_url = base_url
+      @separator = separator
+      @query_params = query_params.with_indifferent_access
+      @path_segments = []
+    end
+
+    # Add a path segment to the url
+    # @param [String] segment the path segment to add
+    # @return [void]
+    def add_segment(segment)
+      @path_segments << segment
+    end
+
+    # Add a query param to the url
+    # @param [String] key the key of the query param
+    # @param [String] value the value of the query param
+    # @return [void]
+    def add_query_param(key: "", value: "")
+      @query_params[key] = value
+    end
+
+    # Build the url to a string
+    # @return [String] the url
+    def to_s
+      path = @path_segments.filter(&:present?).join(@separator)
+      query_string = @query_params.filter { |k, v| k.present? && v.present? }.map { |k, v| "#{k}=#{v}" }.join("&")
+      url = @base_url
+      url += @separator + path if path.present?
+      url += "?#{query_string}" if query_string.present?
+      url
+    end
+  end
+end

data/lib/url_builder/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module UrlBuilder
+  VERSION = "0.1.0"
+end

data/lib/url_builder.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "url_builder/version"
+require_relative "url_builder/builder"
+
+# Module for namespacing the UrlBuilder to avoid naming conflicts
+module UrlBuilder
+end

data/sig/url_builder.rbs

@@ -0,0 +1,4 @@
+module UrlBuilder
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/url_builder.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/url_builder/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "url_builder"
+  spec.version = UrlBuilder::VERSION
+  spec.authors = ["Sean Dickinson"]
+  spec.email = ["contact@seandickinson.dev"]
+
+  spec.summary = "A Ruby Class to create URLs using the builder pattern"
+  spec.description = "See the github page for more details"
+  spec.homepage = "https://github.com/atinybeardedman/url-builder"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/atinybeardedman/url-builder"
+  spec.metadata["changelog_uri"] = "https://github.com/atinybeardedman/url-builder/blob/main/CHANGELOG.md"
+
+  # 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|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec", "~> 3.11"
+  spec.add_dependency "activesupport", "~> 7.0"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: url_builder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sean Dickinson
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description: See the github page for more details
+email:
+- contact@seandickinson.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/url_builder.rb
+- lib/url_builder/builder.rb
+- lib/url_builder/version.rb
+- sig/url_builder.rbs
+- url_builder.gemspec
+homepage: https://github.com/atinybeardedman/url-builder
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/atinybeardedman/url-builder
+  source_code_uri: https://github.com/atinybeardedman/url-builder
+  changelog_uri: https://github.com/atinybeardedman/url-builder/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: A Ruby Class to create URLs using the builder pattern
+test_files: []