parameterised-paths 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 14909f6ce18269c8afd086847a4d0765fd800fd0cf99e81957ccd4032647f431
+  data.tar.gz: f8e54b794bc929bef9b5df5d31caf6ee1d4c6bad5c1f10080622c8e0129f3b56
+SHA512:
+  metadata.gz: 16d617b261f7f82f8e91433062988d62ecf183131866bebef9dd33062960f9105909bcbb30c2237eb2d10e6f53d57fd3ea87431b05c9a0a06754de5225cc735e
+  data.tar.gz: 0d04fd5014a93564c0d566f109b73083728c9656ba9c248bd8f03cbfa12f11e278fabc714b750e6837dd341e5420a79f651e829991a7a954136c28e5c56c1876

data/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org/>

data/lib/parameterised/paths.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Parameterised
+  module Paths
+    autoload :VERSION, 'parameterised/paths/version'
+    autoload :Path, 'parameterised/paths/path'
+    autoload :PathMatch, 'parameterised/paths/path_match'
+
+    # Shorthand method to create a Path object
+    # @param path [String]
+    # @return [Path]
+    def self.path(path)
+      Path.new(path)
+    end
+
+    # Attempts to match two paths together
+    # @param path [String]
+    # @param other_path [String]
+    # @return [PathMatch|nil]
+    #   A PathMatch if a match is made or nil for no match
+    def self.path_match(path, other_path)
+      Path.new(path).match(other_path)
+    end
+  end
+end

data/lib/parameterised/paths/path.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+module Parameterised
+  module Paths
+    class Path
+      # Path constructor
+      # @param path [String]
+      #   A potentially parameterised path
+      def initialize(path)
+        @original_path = path
+        @parameterised = false
+        @params = []
+        @path = parse_path(path)
+      end
+
+      # Attempts to match a path against our parameterised path
+      # @param path [String]
+      #   The path we want to attempt to match
+      # @return [PathMatch|nil]
+      #   A PathMatch if we have encountered a match or nil when there
+      #   if no match
+      def match(path)
+        path = normalise_path(path)
+
+        unless @path.is_a?(Regexp)
+          return @path == path ? PathMatch.new(@original_path) : nil
+        end
+
+        match = path.match(@path)
+
+        return nil if match.nil?
+
+        pos = 0
+        param = {}
+        match.captures.each do |capture|
+          capture.sub!('/', '')
+          param[@params[pos]] = capture
+          pos += 1
+        end
+
+        PathMatch.new(@original_path, param)
+      end
+
+      private
+
+      # Normalise the provided path removing problematic characters
+      # @param path [String]
+      # @return [String]
+      def normalise_path(path)
+        # Remove windows specific separators
+        path = path.gsub('\\', '/')
+        Regexp.escape(path)
+      end
+
+      # Attempt to parse our given path
+      # @param path [String]
+      #   The path to parse
+      # @return [Regexp|String]
+      #   The original path if there are no parameters, Regexp if is did
+      #   contain parameters
+      def parse_path(path)
+        path = normalise_path(path)
+
+        # if we do not have param sections, just return the string
+        return path unless path.include?('/:')
+
+        path = path.gsub(%r{/:\w+}) do |m|
+          m.sub!('/:', '')
+          @params.push(m)
+          '(/\w+)'
+        end
+
+        Regexp.new("^#{path}$")
+      end
+    end
+  end
+end

data/lib/parameterised/paths/path_match.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Parameterised
+  module Paths
+    # Class describing a path match
+    class PathMatch
+      attr_reader :path, :params
+
+      # @param path [String]
+      #   The original path matched against
+      # @param params [Hash]
+      #   Any parameters matched within the path
+      def initialize(path, params = {})
+        @path = path
+        @params = params
+      end
+    end
+  end
+end

data/lib/parameterised/paths/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Parameterised
+  module Paths
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: parameterised-paths
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christopher Birmingham
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A little gem for matching potentially parameterised paths
+email:
+- chris.birmingham@hotmail.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/parameterised/paths.rb
+- lib/parameterised/paths/path.rb
+- lib/parameterised/paths/path_match.rb
+- lib/parameterised/paths/version.rb
+homepage: https://github.com/chrisBirmingham/parameterised-paths
+licenses:
+- Unlicense
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: A little gem for matching potentially parameterised paths
+test_files: []