plek 4.1.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1157f1b8a26836a70c428e595d27392858f6a858043dd44bfeda13314c4e7e99
-  data.tar.gz: 7b970caacd3c079d9bd31836fbc53dee83d98da3110982f67e16d618c89e5f91
+  metadata.gz: e6a63e60446a37aebde2d7ecbb659286e8afa0e31da683f37652e889f32b1dfc
+  data.tar.gz: afd8884693b6ed5d8cf8757dbe679854f657565d3d03fd68647ade3378699cba
 SHA512:
-  metadata.gz: bffcec46ce28fbfdc43d276ddea36fc741dca07a3db9292952d5f7717ecd0eed704a15a96c0ca223f29260b903843374e1c6e317a1e0ba8193dd332cfa07f4bd
-  data.tar.gz: 74501f62f53fb5263e6a41d679604685ca07147599c42d48afbd9921936f18e7c7f900d163ad5255bbfbd7022f0cef8ae1551cfdd61b67deafa528afc57bb92f
+  metadata.gz: b398f7c452471fd8b76a3620b8d29669b91df4febfb6956acc5877f5521c8deda8d3a17ac5193dcf122972e531deb2ced1f67473cc5ac3917c42850e0833e54f
+  data.tar.gz: 865f7dec648f21375336fa29c7eb57789d2a4d9b1a22374e9cc635c66616a32c8a07cbba173a12245357a50f08cfa236c38b49fa3dcfa29dc4c74f468618af1c

data/lib/plek/version.rb

@@ -1,3 +1,3 @@
 class Plek
-  VERSION = "4.1.0".freeze
+  VERSION = "5.0.0".freeze
 end

data/lib/plek.rb

@@ -1,5 +1,6 @@
 require "plek/version"
 require "uri"
+require "forwardable"
 
 # Plek resolves service names to a corresponding base URL.
 #
@@ -71,7 +72,7 @@ class Plek
   #   scheme (eg `//foo.example.com`)
   # @return [String] The base URL for the service.
   def find(service, options = {})
-    name = clean_name(service)
+    name = valid_service_name(service)
     if (service_uri = defined_service_uri_for(name))
       return service_uri
     end
@@ -101,15 +102,6 @@ class Plek
     find(service, options.merge(external: true))
   end
 
-  # Find the base URL for a service/application, and parse as a URI object.
-  # This wraps #find and returns the parsed result.
-  #
-  # @param args see {#find}
-  # @return [URI::HTTPS,URI::HTTP,URI::Generic] The base URL for the service
-  def find_uri(*args)
-    URI(find(*args))
-  end
-
   # Find the base URL for assets.
   #
   # @return [String] The assets base URL.
@@ -124,51 +116,37 @@ class Plek
     env_var_or_dev_fallback("GOVUK_WEBSITE_ROOT") { find("www") }
   end
 
-  # Find the base URL for assets.
-  #
-  # @return [URI::HTTPS,URI::HTTP,URI::Generic] The assets base URL.
-  def asset_uri
-    URI(asset_root)
-  end
-
-  # Find the base URL for the public website frontend.
-  #
-  # @return [URI::HTTPS,URI::HTTP,URI::Generic] The website base URL.
-  def website_uri
-    URI(website_root)
-  end
-
-  # TODO: clean up all references to these and then remove them.
   class << self
-    # This alias allows calls to be made in the old style:
-    #     Plek.current.find('foo')
-    # as well as the new style:
-    #     Plek.new.find('foo')
-    def current(...)
-      warn "Plek.current is deprecated and will be removed. Use Plek.new or Plek.find instead."
-      new(...)
-    end
-
-    # Convenience wrapper.  The same as calling +Plek.new.find+.
-    # @see #find
-    def find(*args)
-      new.find(*args)
-    end
-
-    # Convenience wrapper.  The same as calling +Plek.new.find_uri+.
-    # @see #find_uri
-    def find_uri(*args)
-      new.find_uri(*args)
-    end
+    extend Forwardable
+
+    # @!method find
+    #   Convenience wrapper. The same as calling +Plek.new.find+.
+    #   @see #find
+    #   @return [String]
+    # @!method external_url_for
+    #   Convenience wrapper. The same as calling +Plek.new.external_url_for+.
+    #   @see #external_url_for
+    #   @return [String]
+    # @!method asset_root
+    #   Convenience wrapper. The same as calling +Plek.new.asset_root+.
+    #   @see #asset_root
+    #   @return [String]
+    # @!method website_root
+    #   Convenience wrapper. The same as calling +Plek.new.website_root+.
+    #   @see #website_root
+    #   @return [String]
+    def_delegators :new, :find, :external_url_for, :asset_root, :website_root
   end
 
 private
 
   attr_reader :host_prefix, :unprefixable_hosts, :use_http_for_single_label_domains
 
-  # TODO: clean up call sites throughout alphagov and then delete clean_name.
-  def clean_name(service)
-    service.to_s.downcase.strip.gsub(/[^a-z.-]+/, "")
+  def valid_service_name(name)
+    service_name = name.to_s
+    return service_name if service_name.match?(/\A[a-z1-9.-]+\z/)
+
+    raise ArgumentError, "Plek expects a service name to only contain lowercase a-z, numbers . (period) and - (dash) characters."
   end
 
   def http_domain?(domain)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plek
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 5.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-03 00:00:00.000000000 Z
+date: 2022-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.7.0
+        version: 4.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.7.0
+        version: 4.8.0
 description: Find the right hostname for each service in an environment-dependent
   manner
 email:
@@ -97,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.22
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Locations for services