local_uri 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: caa9d2f25b700ff2a28a8a6886426c7934492675488b0a9f19c128db8ff8a12b
+  data.tar.gz: c1082b30719ec5ce94ea677de1fbe48374568c8dd0f53dda58907339ae34fd75
+SHA512:
+  metadata.gz: d6b54b04bbc94c191371896e496f1ae04cf394b66d1282da0aeed621604b2ceb1785c5e41e1e572be99ee0208221c2ac6957fc60146b519c36afb2ab511287dc
+  data.tar.gz: ab14910f84fd4147c6610adf20ece458848032e0b27e6bf7584bbb0839ee5341d6300860d02369e70300012fecc2aa0b8a5837c0478f732b3dcfb7dd9fc7e573

data/README.md

@@ -0,0 +1,76 @@
+## Quick start guide
+
+```ruby
+  gem install local_uri
+```
+
+or add it to your Gemfile:
+
+```ruby
+  gem 'local_uri'
+```
+
+Replace ruby core URI with `LocalUri::URI`.
+
+In plain ruby:
+```ruby
+define_method(:URI, ->(string) { LocalUri::URI.new(string) })
+```
+
+In rails:
+```ruby
+# config/initalizers/uri.rb
+
+define_method(:URI, ->(string) { LocalUri::URI.new(string) })
+```
+
+If you already have code in place that uses ruby core `URI` you can skip the replacement and just use `LocalUri::URI` directly:
+
+```ruby
+LocalUri::URI.new('https://local.ch')
+```
+
+## Working with URIs
+
+`LocalUri::URI` has the following capabilities:
+
+### Queries
+
+#### Merge hashes into url queries
+
+`merge(hash)` - returns a copy of the base LocalUri::URI with given hash being merged into the query params:
+
+```ruby
+
+uri = URI('https://yellow.local.ch/d/abc')
+uri.to_s # https://yellow.local.ch/d/abc
+
+uri.query.merge(tracking_id: 123).to_s # https://yellow.local.ch/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://yellow.local.ch/d/abc').query.merge(tracking_id: 123)} # <a href="https://yellow.local.ch/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://booking-widget.local.ch/entries/abc/bookings/new')
+uri.query.merge(booking: { people: 2 }).to_s # https://booking-widget.local.ch/entries/abc/bookings/new?booking[people]=2
+```
+
+#### Access data in queries
+
+```ruby
+
+uri = URI('https://local.ch?id=1&place[name]=casa')
+uri[:id] # '1'
+uri.dig(:place, :name) # 'casa'
+```

data/lib/local_uri/query.rb

@@ -0,0 +1,35 @@
+require 'rack/utils'
+require 'active_support/core_ext/hash/indifferent_access'
+
+module LocalUri
+  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 = Rack::Utils.build_nested_query(parsed_query.merge(*args, &block))
+      end
+    end
+
+    def merge!(*args, &block)
+      @uri.tap do |uri|
+        uri.query_string = Rack::Utils.build_nested_query(parsed_query.merge(*args, &block))
+      end
+    end
+
+    private
+
+    def parsed_query
+      Rack::Utils.parse_nested_query(@uri.query_string).with_indifferent_access
+    end
+  end
+end

data/lib/local_uri/uri.rb

@@ -0,0 +1,36 @@
+require 'active_support/core_ext/module/delegation'
+
+module LocalUri
+  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
+      LocalUri::Query.new(self)
+    end
+    alias params query
+  end
+end

data/lib/local_uri/version.rb

@@ -0,0 +1,3 @@
+module LocalUri
+  VERSION = '1.1.0'.freeze
+end

data/lib/local_uri.rb

@@ -0,0 +1,4 @@
+module LocalUri
+  autoload :Query, 'local_uri/query'
+  autoload :URI, 'local_uri/uri'
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: local_uri
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- https://github.com/local-ch/local_uri/graphs/contributors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-09 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.58.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.58.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.26.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.26.0
+description: Useful and slight extension to Ruby's URI (Uniform Resource Identifiers)
+  core module.
+email:
+- web@localsearch.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/local_uri.rb
+- lib/local_uri/query.rb
+- lib/local_uri/uri.rb
+- lib/local_uri/version.rb
+homepage: https://github.com/local-ch/local_uri
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Useful and slight extension to Ruby's URI (Uniform Resource Identifiers)
+  core module.
+test_files: []