superlink 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 0a0f5b12ebb316c3ebb15ce0837b0aa5b2754fca026be6c0a938eb2986b7e478
4
+ data.tar.gz: 96150538f8c6cf39ed080b7dde9dfb794eb1d0bbd3cbc6a985f3862c1074e11c
5
+ SHA512:
6
+ metadata.gz: 5dd5e7f94cf799593d5d7cea80951d31e38265b178d83ffe9d76bec477ddc5c2862c61f81a669c6d7c9e71e2b54853091b07a82368527367b56993c3fd56f192
7
+ data.tar.gz: 850c466b5ddbb158b1b18fd47351267a62b0fa2604bdd449442af0c915051e1e8a9db1989798bc029d0a744ea4921fac81ff1fae10001702c994c1508cf32c8a
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
@@ -0,0 +1,132 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our
6
+ community a harassment-free experience for everyone, regardless of age, body
7
+ size, visible or invisible disability, ethnicity, sex characteristics, gender
8
+ identity and expression, level of experience, education, socio-economic status,
9
+ nationality, personal appearance, race, caste, color, religion, or sexual
10
+ identity and orientation.
11
+
12
+ We pledge to act and interact in ways that contribute to an open, welcoming,
13
+ diverse, inclusive, and healthy community.
14
+
15
+ ## Our Standards
16
+
17
+ Examples of behavior that contributes to a positive environment for our
18
+ community include:
19
+
20
+ * Demonstrating empathy and kindness toward other people
21
+ * Being respectful of differing opinions, viewpoints, and experiences
22
+ * Giving and gracefully accepting constructive feedback
23
+ * Accepting responsibility and apologizing to those affected by our mistakes,
24
+ and learning from the experience
25
+ * Focusing on what is best not just for us as individuals, but for the overall
26
+ community
27
+
28
+ Examples of unacceptable behavior include:
29
+
30
+ * The use of sexualized language or imagery, and sexual attention or advances of
31
+ any kind
32
+ * Trolling, insulting or derogatory comments, and personal or political attacks
33
+ * Public or private harassment
34
+ * Publishing others' private information, such as a physical or email address,
35
+ without their explicit permission
36
+ * Other conduct which could reasonably be considered inappropriate in a
37
+ professional setting
38
+
39
+ ## Enforcement Responsibilities
40
+
41
+ Community leaders are responsible for clarifying and enforcing our standards of
42
+ acceptable behavior and will take appropriate and fair corrective action in
43
+ response to any behavior that they deem inappropriate, threatening, offensive,
44
+ or harmful.
45
+
46
+ Community leaders have the right and responsibility to remove, edit, or reject
47
+ comments, commits, code, wiki edits, issues, and other contributions that are
48
+ not aligned to this Code of Conduct, and will communicate reasons for moderation
49
+ decisions when appropriate.
50
+
51
+ ## Scope
52
+
53
+ This Code of Conduct applies within all community spaces, and also applies when
54
+ an individual is officially representing the community in public spaces.
55
+ Examples of representing our community include using an official email address,
56
+ posting via an official social media account, or acting as an appointed
57
+ representative at an online or offline event.
58
+
59
+ ## Enforcement
60
+
61
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
62
+ reported to the community leaders responsible for enforcement at
63
+ [INSERT CONTACT METHOD].
64
+ All complaints will be reviewed and investigated promptly and fairly.
65
+
66
+ All community leaders are obligated to respect the privacy and security of the
67
+ reporter of any incident.
68
+
69
+ ## Enforcement Guidelines
70
+
71
+ Community leaders will follow these Community Impact Guidelines in determining
72
+ the consequences for any action they deem in violation of this Code of Conduct:
73
+
74
+ ### 1. Correction
75
+
76
+ **Community Impact**: Use of inappropriate language or other behavior deemed
77
+ unprofessional or unwelcome in the community.
78
+
79
+ **Consequence**: A private, written warning from community leaders, providing
80
+ clarity around the nature of the violation and an explanation of why the
81
+ behavior was inappropriate. A public apology may be requested.
82
+
83
+ ### 2. Warning
84
+
85
+ **Community Impact**: A violation through a single incident or series of
86
+ actions.
87
+
88
+ **Consequence**: A warning with consequences for continued behavior. No
89
+ interaction with the people involved, including unsolicited interaction with
90
+ those enforcing the Code of Conduct, for a specified period of time. This
91
+ includes avoiding interactions in community spaces as well as external channels
92
+ like social media. Violating these terms may lead to a temporary or permanent
93
+ ban.
94
+
95
+ ### 3. Temporary Ban
96
+
97
+ **Community Impact**: A serious violation of community standards, including
98
+ sustained inappropriate behavior.
99
+
100
+ **Consequence**: A temporary ban from any sort of interaction or public
101
+ communication with the community for a specified period of time. No public or
102
+ private interaction with the people involved, including unsolicited interaction
103
+ with those enforcing the Code of Conduct, is allowed during this period.
104
+ Violating these terms may lead to a permanent ban.
105
+
106
+ ### 4. Permanent Ban
107
+
108
+ **Community Impact**: Demonstrating a pattern of violation of community
109
+ standards, including sustained inappropriate behavior, harassment of an
110
+ individual, or aggression toward or disparagement of classes of individuals.
111
+
112
+ **Consequence**: A permanent ban from any sort of public interaction within the
113
+ community.
114
+
115
+ ## Attribution
116
+
117
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118
+ version 2.1, available at
119
+ [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120
+
121
+ Community Impact Guidelines were inspired by
122
+ [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123
+
124
+ For answers to common questions about this code of conduct, see the FAQ at
125
+ [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126
+ [https://www.contributor-covenant.org/translations][translations].
127
+
128
+ [homepage]: https://www.contributor-covenant.org
129
+ [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130
+ [Mozilla CoC]: https://github.com/mozilla/diversity
131
+ [FAQ]: https://www.contributor-covenant.org/faq
132
+ [translations]: https://www.contributor-covenant.org/translations
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2025 Brad Gessler
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,47 @@
1
+ # Superlink
2
+
3
+ Superlink tames the verbosti of Rails' `link_to` helper by providing a more concise and readable alternative.
4
+
5
+ For example, a link that deletes a user from a Rails admin panel might look like this:
6
+
7
+ ```erb
8
+ <%= link_to "Delete #{@user.name}", admin_edit_user_path(@user), data_turbo_method: "delete" %>
9
+ ```
10
+
11
+ With Superlink, the same link can be written as:
12
+
13
+ ```erb
14
+ <% delete(@user, &:name) %>
15
+ ```
16
+
17
+ ## Installation
18
+
19
+ Install the gem and add to the application's Gemfile by executing:
20
+
21
+ ```bash
22
+ bundle add superlink
23
+ ```
24
+
25
+ Then reboot your Rails server.
26
+
27
+ ## Usage
28
+
29
+ Superlink is still under active development! When its finished, usage instructions will be included here. 🤠
30
+
31
+ ## Development
32
+
33
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
34
+
35
+ 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).
36
+
37
+ ## Contributing
38
+
39
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/superlink. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/superlink/blob/main/CODE_OF_CONDUCT.md).
40
+
41
+ ## License
42
+
43
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
44
+
45
+ ## Code of Conduct
46
+
47
+ Everyone interacting in the Superlink project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/superlink/blob/main/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,8 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "bundler/gem_tasks"
4
+ require "rspec/core/rake_task"
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+
8
+ task default: :spec
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Superlink
4
+ VERSION = "0.1.0"
5
+ end
data/lib/superlink.rb ADDED
@@ -0,0 +1,121 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "superlink/version"
4
+ require "uri-builder"
5
+ require "active_support/concern"
6
+ require "active_support/core_ext/module/delegation"
7
+
8
+ module Superlink
9
+ class Error < StandardError; end
10
+
11
+ class Builder < URI::Builder::DSL
12
+ attr_reader :model
13
+
14
+ def join(*segments)
15
+ super(*route(*segments))
16
+ end
17
+
18
+ def format(format)
19
+ @format = format
20
+ self
21
+ end
22
+
23
+ def clear_format
24
+ @format = nil
25
+ self
26
+ end
27
+
28
+ def uri
29
+ super.clone.tap do |uri|
30
+ uri.path = "#{uri.path}.#{@format}" if @format
31
+ # Check if the route exists in the routes.rb file
32
+ unless Rails.application.routes.recognize_path(uri.path)
33
+ raise ActionController::UrlGenerationError, "No route matches [#{uri.path}]"
34
+ end
35
+ end
36
+ end
37
+
38
+ def self.parse(...)
39
+ new URI(...)
40
+ end
41
+
42
+ def initialize_copy(original)
43
+ super
44
+ @uri = original.uri
45
+ end
46
+
47
+ protected
48
+
49
+ def route(*segments)
50
+ segments.flat_map do |it|
51
+ if it.respond_to?(:to_model)
52
+ @model = it.to_model
53
+ [it.model_name.route_key, it.to_param]
54
+ elsif it.respond_to?(:model_name)
55
+ it.model_name.route_key
56
+ elsif it.respond_to?(:to_param)
57
+ it.to_param
58
+ else
59
+ it.to_s
60
+ end
61
+ end
62
+ end
63
+ end
64
+
65
+ module Helpers
66
+ extend ActiveSupport::Concern
67
+
68
+ included do
69
+ helper_method :url, :path
70
+ end
71
+
72
+ def url(...)
73
+ @url ||= Builder.parse(request.url)
74
+ @url.clone.join(...)
75
+ end
76
+
77
+ def path
78
+ url.path
79
+ end
80
+ end
81
+
82
+ module Phlex
83
+ delegate :url, to: :helpers
84
+
85
+ def xlink_to(target, *segments, **, &content)
86
+ if target.nil? and segments.empty?
87
+ return # Render nothing if we link to nothing
88
+ elsif target.is_a? URI::Builder::DSL and segments.empty?
89
+ builder = target
90
+ url = builder.uri
91
+ model = builder.model
92
+ href = helpers.request.host == url.host ? url.path : url.to_s
93
+
94
+ a(href:, **) {
95
+ if content&.lambda? and model
96
+ render content.call model
97
+ elsif content
98
+ render content
99
+ else
100
+ render url.to_s
101
+ end
102
+ }
103
+ else
104
+ xlink_to(helpers.url.join(target, *segments), **, &content)
105
+ end
106
+ end
107
+ alias :xshow :xlink_to
108
+
109
+ def xedit(*segments, **, &content)
110
+ xlink_to(*segments.push(:edit), **, &content)
111
+ end
112
+
113
+ def xcreate(*segments, **, &content)
114
+ xlink_to(*segments.push(:new), **, &content)
115
+ end
116
+
117
+ def xdestroy(*segments, confirm: "Are you sure?", **, &content)
118
+ xlink_to(*segments, data_turbo: { method: :delete, confirm: }, **, &content)
119
+ end
120
+ end
121
+ end
data/sig/superlink.rbs ADDED
@@ -0,0 +1,4 @@
1
+ module Superlink
2
+ VERSION: String
3
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
4
+ end
metadata ADDED
@@ -0,0 +1,80 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: superlink
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Brad Gessler
8
+ bindir: exe
9
+ cert_chain: []
10
+ date: 2025-03-14 00:00:00.000000000 Z
11
+ dependencies:
12
+ - !ruby/object:Gem::Dependency
13
+ name: uri-builder
14
+ requirement: !ruby/object:Gem::Requirement
15
+ requirements:
16
+ - - "~>"
17
+ - !ruby/object:Gem::Version
18
+ version: '0.1'
19
+ type: :runtime
20
+ prerelease: false
21
+ version_requirements: !ruby/object:Gem::Requirement
22
+ requirements:
23
+ - - "~>"
24
+ - !ruby/object:Gem::Version
25
+ version: '0.1'
26
+ - !ruby/object:Gem::Dependency
27
+ name: activesupport
28
+ requirement: !ruby/object:Gem::Requirement
29
+ requirements:
30
+ - - ">="
31
+ - !ruby/object:Gem::Version
32
+ version: '7.0'
33
+ type: :runtime
34
+ prerelease: false
35
+ version_requirements: !ruby/object:Gem::Requirement
36
+ requirements:
37
+ - - ">="
38
+ - !ruby/object:Gem::Version
39
+ version: '7.0'
40
+ description: A more powerful path and url generator for Rails
41
+ email:
42
+ - bradgessler@gmail.com
43
+ executables: []
44
+ extensions: []
45
+ extra_rdoc_files: []
46
+ files:
47
+ - ".rspec"
48
+ - CODE_OF_CONDUCT.md
49
+ - LICENSE.txt
50
+ - README.md
51
+ - Rakefile
52
+ - lib/superlink.rb
53
+ - lib/superlink/version.rb
54
+ - sig/superlink.rbs
55
+ homepage: https://github.com/rubymonolith/superlink
56
+ licenses:
57
+ - MIT
58
+ metadata:
59
+ allowed_push_host: https://rubygems.org
60
+ homepage_uri: https://github.com/rubymonolith/superlink
61
+ source_code_uri: https://github.com/rubymonolith/superlink
62
+ changelog_uri: https://github.com/rubymonolith/superlink
63
+ rdoc_options: []
64
+ require_paths:
65
+ - lib
66
+ required_ruby_version: !ruby/object:Gem::Requirement
67
+ requirements:
68
+ - - ">="
69
+ - !ruby/object:Gem::Version
70
+ version: 3.1.0
71
+ required_rubygems_version: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ requirements: []
77
+ rubygems_version: 3.6.2
78
+ specification_version: 4
79
+ summary: A more powerful path and url generator for Rails
80
+ test_files: []