better_uri 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a849e6946f0715f5e7892fa480d9c5c221fe3b50fe0b39b3dd486344154c8801
+  data.tar.gz: 416b7ca94556d681e140d79d9d5b772df9cf1be89d955b6726262b2c792fb30e
+SHA512:
+  metadata.gz: 3ced0f502e074206efcc64ca625d723d8fe91b57c669ccd9259226ff430d01871ef0a55fccecef9f146492e3385314c0620daac1f793eeb4d94c93bac79d1d58
+  data.tar.gz: e1fb486d9d91d2144c72c9008f90c9055eb2c71f78678b032afc20bdb97c308096736ae7729e73c619cb730b732cbabc9ede3cbfd4a3b7d4c3be1ff84cf3c1ff

data/README.md

@@ -0,0 +1,88 @@
+## Quick start guide
+
+```ruby
+  gem install better_uri
+```
+
+or add it to your Gemfile:
+
+```ruby
+  gem 'better_uri'
+```
+
+Replace ruby core URI with `BetterUri::URI`.
+
+In plain ruby:
+```ruby
+define_method(:URI, ->(string) { BetterUri::URI.new(string) })
+```
+
+In rails:
+```ruby
+# config/initalizers/uri.rb
+
+define_method(:URI, ->(string) { BetterUri::URI.new(string) })
+```
+
+If you already have code in place that uses ruby core `URI` you can skip the replacement and just use `BetterUri::URI` directly:
+
+```ruby
+BetterUri::URI.new('https://depay.fi')
+```
+
+## Working with URIs
+
+`BetterUri::URI` has the following capabilities:
+
+### Queries
+
+#### Merge hashes into url queries
+
+`merge(hash)` - returns a copy of the base BetterUri::URI with given hash being merged into the query params:
+
+```ruby
+
+uri = URI('https://depay.fi/d/abc')
+uri.to_s # https://depay.fi/d/abc
+
+uri.query.merge(tracking_id: 123).to_s # https://depay.fi/d/abc?tracking_id=123
+```
+
+If you place those urls directly in the view or api response, an explicit to_s is not necessary:
+
+```ruby
+
+%a{href: URI('https://depay.fi/d/abc').query.merge(tracking_id: 123)} # <a href="https://depay.fi/d/abc?tracking_id=123"/>
+
+```
+
+`merge!(hash)` - the same as `merge` but changes the original URI.
+
+`merge(hash)` and `merge!(hash)` also support nested query:
+
+```ruby
+
+uri = URI('https://depay.fi/entries/abc/bookings/new')
+uri.query.merge(booking: { people: 2 }).to_s # https://depay.fi/entries/abc/bookings/new?booking[people]=2
+```
+
+#### Access data in queries
+
+```ruby
+
+uri = URI('https://depay.fi?id=1&place[name]=casa')
+uri.query[:id] # '1'
+uri.query.dig(:place, :name) # 'casa'
+```
+
+#### Remove parts of a query
+
+```ruby
+uri = URI('https://depay.fi?one=1&two=2&three=3')
+uri.query.except(:two, :three).to_s # https://depay.fi?one=1
+```
+
+`except(keys)` - Returns a uri which query includes everything except given keys.
+
+`except!(keys)` - Removes the given keys from the query of the original uri and returns the uri itself.
+

data/lib/better_uri/query.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'rack/utils'
+require 'active_support/core_ext/hash/indifferent_access'
+
+module BetterUri
+  class Query
+    delegate :[], :dig, to: :parsed_query
+
+    def initialize(uri)
+      @uri = uri
+    end
+
+    def to_s
+      @uri.query_string
+    end
+
+    def merge(*args, &block)
+      @uri.dup.tap do |uri|
+        uri.query_string = build_query_string(parsed_query.merge(*args, &block))
+      end
+    end
+
+    def merge!(*args, &block)
+      @uri.tap do |uri|
+        uri.query_string = build_query_string(parsed_query.merge(*args, &block))
+      end
+    end
+
+    def except(*args, &block)
+      @uri.dup.tap do |uri|
+        uri.query_string = build_query_string(parsed_query.except(*args, &block))
+      end
+    end
+
+    def except!(*args, &block)
+      @uri.tap do |uri|
+        uri.query_string = build_query_string(parsed_query.except(*args, &block))
+      end
+    end
+
+    private
+
+    def parsed_query
+      Rack::Utils.parse_nested_query(@uri.query_string).with_indifferent_access
+    end
+
+    def build_query_string(query)
+      query_string = Rack::Utils.build_nested_query(query)
+      query_string.empty? ? nil : query_string
+    end
+  end
+end

data/lib/better_uri/uri.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/module/delegation'
+
+module BetterUri
+  URI_CORE = URI
+
+  class URI < SimpleDelegator
+    attr_reader :uri
+
+    def initialize(string)
+      @uri = super(URI_CORE.parse(string.to_s))
+    end
+
+    def empty?
+      @uri.to_s.empty?
+    end
+
+    def dup
+      self.class.new(@uri.to_s)
+    end
+
+    def query_string
+      @uri.query
+    end
+
+    def query_string=(val)
+      @uri.query = val
+    end
+    alias query= query_string=
+
+    def query
+      BetterUri::Query.new(self)
+    end
+    alias params query
+  end
+end

data/lib/better_uri/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BetterUri
+  VERSION = '1.0.0'
+end

data/lib/better_uri.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module BetterUri
+  autoload :Query, 'better_uri/query'
+  autoload :URI, 'better_uri/uri'
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: better_uri
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- https://github.com/depayfi/better_uri/graphs/contributors
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Better URI gem to improve Ruby's URI (Uniform Resource Identifiers) core
+  module.
+email:
+- engineering@depay.fi
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/better_uri.rb
+- lib/better_uri/query.rb
+- lib/better_uri/uri.rb
+- lib/better_uri/version.rb
+homepage: https://github.com/depayfi/better_uri
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: Better URI gem to improve Ruby's URI (Uniform Resource Identifiers) core
+  module.
+test_files: []