link_to_me 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5cd0f4641234663fcfc4c89dfdb95f38b6f920bccb047f7066b955fe62cc1c74
+  data.tar.gz: 7ebc82b1a3b53edf2264bdedd895074b38cfc9b36b471949a60846d06b47a8b1
+SHA512:
+  metadata.gz: 5f0d0704534d036754b605b5825cb8d58759c3058007f78ffa4b9d8e12fee51d7fd34d2f94d1422c40d3ff8f25e84f7f8acc7eb1a0ac5d6647fe405b6876bead
+  data.tar.gz: 0451d2101bfabde0a1c0496c9542e37e75c59a0b84fa82b58c526bf8fdf51d253762c8fe19cdfc510bd195e78bd6fd53d876dcde1c38744516454a28403fb4c9

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2021-02-19
+
+### Added
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hi@olivierlacan.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in link_to_me.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Olivier Lacan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+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 OR COPYRIGHT HOLDERS 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.

data/README.md

@@ -0,0 +1,88 @@
+# LinkToMe
+
+Extend Rails Action View's `link_to` to allow it to autolink any
+Active Record model instances with a GET url.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'link_to_me'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install link_to_me
+
+## Usage
+
+```ruby
+link_to @model
+```
+
+Will result in the following code:
+```
+<a href="/models/1">Model 1</a>
+```
+
+Given the `@model` instance defines the following method:
+
+```ruby
+class Model
+  def to_s
+    "Model #{id}"
+  end
+end
+```
+
+Here, `to_s` can point to an attribute like `name` as well if it exists
+and use a fallback:
+
+```ruby
+class Model
+  def to_s
+    name || "Model #{id}"
+  end
+end
+```
+
+If you don't implement a `to_s` method, `link_to` will instead default
+to the original Ruby definition of `to_s` which prints the name of the
+instance's class and its `object_id` in hexacidemal format:
+
+```ruby
+Object.new.to_s
+=> "#<Object:0x00007fc122ad4d10>"
+```
+
+It's not quite as useful. Defining `to_s` on Rails Active Record model
+classes is not at all destructive. You can still obtain the
+non-hexadecimal memory object ID via `Object.new.object_id`:
+
+```ruby
+Object.new.object_id
+=> 109720
+```
+
+## Development
+
+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.
+
+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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/olivierlacan/link_to_me. 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/olivierlacan/link_to_me/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the LinkToMe project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/olivierlacan/link_to_me/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "link_to_me"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/link_to_me.rb

@@ -0,0 +1,174 @@
+require "link_to_me/version"
+require "link_to_me/railtie" if defined?(Rails::Railtie)
+
+module LinkToMe
+  def self.included(klass)
+    klass.class_eval do
+      alias_method :_rails_link_to, :link_to
+      remove_method :link_to
+    end
+  end
+  # Creates an anchor element of the given +name+ using a URL created by the set of +options+.
+  # See the valid options in the documentation for +url_for+. It's also possible to
+  # pass a \String instead of an options hash, which generates an anchor element that uses the
+  # value of the \String as the href for the link. Using a <tt>:back</tt> \Symbol instead
+  # of an options hash will generate a link to the referrer (a JavaScript back link
+  # will be used in place of a referrer if none exists). If +nil+ is passed as the name
+  # the value of the link itself will become the name.
+  #
+  # ==== Signatures
+  #
+  #   link_to(body, url, html_options = {})
+  #     # url is a String; you can use URL helpers like
+  #     # posts_path
+  #
+  #   link_to(body, url_options = {}, html_options = {})
+  #     # url_options, except :method, is passed to url_for
+  #
+  #   link_to(options = {}, html_options = {}) do
+  #     # name
+  #   end
+  #
+  #   link_to(url, html_options = {}) do
+  #     # name
+  #   end
+  #
+  #   link_to(active_record_model)
+  #
+  # ==== Options
+  # * <tt>:data</tt> - This option can be used to add custom data attributes.
+  # * <tt>method: symbol of HTTP verb</tt> - This modifier will dynamically
+  #   create an HTML form and immediately submit the form for processing using
+  #   the HTTP verb specified. Useful for having links perform a POST operation
+  #   in dangerous actions like deleting a record (which search bots can follow
+  #   while spidering your site). Supported verbs are <tt>:post</tt>, <tt>:delete</tt>, <tt>:patch</tt>, and <tt>:put</tt>.
+  #   Note that if the user has JavaScript disabled, the request will fall back
+  #   to using GET. If <tt>href: '#'</tt> is used and the user has JavaScript
+  #   disabled clicking the link will have no effect. If you are relying on the
+  #   POST behavior, you should check for it in your controller's action by using
+  #   the request object's methods for <tt>post?</tt>, <tt>delete?</tt>, <tt>patch?</tt>, or <tt>put?</tt>.
+  # * <tt>remote: true</tt> - This will allow the unobtrusive JavaScript
+  #   driver to make an Ajax request to the URL in question instead of following
+  #   the link. The drivers each provide mechanisms for listening for the
+  #   completion of the Ajax request and performing JavaScript operations once
+  #   they're complete
+  #
+  # ==== Data attributes
+  #
+  # * <tt>confirm: 'question?'</tt> - This will allow the unobtrusive JavaScript
+  #   driver to prompt with the question specified (in this case, the
+  #   resulting text would be <tt>question?</tt>. If the user accepts, the
+  #   link is processed normally, otherwise no action is taken.
+  # * <tt>:disable_with</tt> - Value of this parameter will be used as the
+  #   name for a disabled version of the link. This feature is provided by
+  #   the unobtrusive JavaScript driver.
+  #
+  # ==== Examples
+  # Because it relies on +url_for+, +link_to+ supports both older-style controller/action/id arguments
+  # and newer RESTful routes. Current Rails style favors RESTful routes whenever possible, so base
+  # your application on resources and use
+  #
+  #   link_to "Profile", profile_path(@profile)
+  #   # => <a href="/profiles/1">Profile</a>
+  #
+  # or the even pithier
+  #
+  #   link_to "Profile", @profile
+  #   # => <a href="/profiles/1">Profile</a>
+  #
+  # in place of the older more verbose, non-resource-oriented
+  #
+  #   link_to "Profile", controller: "profiles", action: "show", id: @profile
+  #   # => <a href="/profiles/show/1">Profile</a>
+  #
+  # Similarly,
+  #
+  #   link_to "Profiles", profiles_path
+  #   # => <a href="/profiles">Profiles</a>
+  #
+  # is better than
+  #
+  #   link_to "Profiles", controller: "profiles"
+  #   # => <a href="/profiles">Profiles</a>
+  #
+  # When name is +nil+ the href is presented instead
+  #
+  #   link_to nil, "http://example.com"
+  #   # => <a href="http://www.example.com">http://www.example.com</a>
+  #
+  # Pithier yet, when name is an ActiveRecord model that defines a
+  # +to_s+ method returning a name attribute or a default value
+  #
+  #   link_to @profile
+  #   # => <a href="http://www.example.com/profiles/1">David</a>
+  #
+  # You can use a block as well if your link target is hard to fit into the name parameter. ERB example:
+  #
+  #   <%= link_to(@profile) do %>
+  #     <strong><%= @profile.name %></strong> -- <span>Check it out!</span>
+  #   <% end %>
+  #   # => <a href="/profiles/1">
+  #          <strong>David</strong> -- <span>Check it out!</span>
+  #        </a>
+  #
+  # Classes and ids for CSS are easy to produce:
+  #
+  #   link_to "Articles", articles_path, id: "news", class: "article"
+  #   # => <a href="/articles" class="article" id="news">Articles</a>
+  #
+  # Be careful when using the older argument style, as an extra literal hash is needed:
+  #
+  #   link_to "Articles", { controller: "articles" }, id: "news", class: "article"
+  #   # => <a href="/articles" class="article" id="news">Articles</a>
+  #
+  # Leaving the hash off gives the wrong link:
+  #
+  #   link_to "WRONG!", controller: "articles", id: "news", class: "article"
+  #   # => <a href="/articles/index/news?class=article">WRONG!</a>
+  #
+  # +link_to+ can also produce links with anchors or query strings:
+  #
+  #   link_to "Comment wall", profile_path(@profile, anchor: "wall")
+  #   # => <a href="/profiles/1#wall">Comment wall</a>
+  #
+  #   link_to "Ruby on Rails search", controller: "searches", query: "ruby on rails"
+  #   # => <a href="/searches?query=ruby+on+rails">Ruby on Rails search</a>
+  #
+  #   link_to "Nonsense search", searches_path(foo: "bar", baz: "quux")
+  #   # => <a href="/searches?foo=bar&baz=quux">Nonsense search</a>
+  #
+  # The only option specific to +link_to+ (<tt>:method</tt>) is used as follows:
+  #
+  #   link_to("Destroy", "http://www.example.com", method: :delete)
+  #   # => <a href='http://www.example.com' rel="nofollow" data-method="delete">Destroy</a>
+  #
+  # You can also use custom data attributes using the <tt>:data</tt> option:
+  #
+  #   link_to "Visit Other Site", "http://www.rubyonrails.org/", data: { confirm: "Are you sure?" }
+  #   # => <a href="http://www.rubyonrails.org/" data-confirm="Are you sure?">Visit Other Site</a>
+  #
+  # Also you can set any link attributes such as <tt>target</tt>, <tt>rel</tt>, <tt>type</tt>:
+  #
+  #   link_to "External link", "http://www.rubyonrails.org/", target: "_blank", rel: "nofollow"
+  #   # => <a href="http://www.rubyonrails.org/" target="_blank" rel="nofollow">External link</a>
+  def link_to(name = nil, options = nil, html_options = nil, &block)
+    html_options, options, name = options, name, block if block_given?
+    options ||= {}
+
+    html_options = convert_options_to_data_attributes(options, html_options)
+
+    url = url_for(url_target(name, options))
+    html_options["href"] ||= url
+
+    content_tag("a", name || url, html_options, &block)
+  end
+
+  private
+    def url_target(name, options)
+      if name.respond_to?(:model_name) && options.empty?
+        url_for(name)
+      else
+        url_for(options)
+      end
+    end
+end

data/lib/link_to_me/railtie.rb

@@ -0,0 +1,9 @@
+module LinkToMe
+  class Railtie < Rails::Railtie
+    initializer "link_to_me.configure_rails_initialization" do
+      ActiveSupport.on_load(:action_view) do
+        ActionView::Helpers::UrlHelper.send(:include, LinkToMe)
+      end
+    end
+  end
+end

data/lib/link_to_me/version.rb

@@ -0,0 +1,3 @@
+module LinkToMe
+  VERSION = "0.1.0"
+end

data/link_to_me.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/link_to_me/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "link_to_me"
+  spec.version       = LinkToMe::VERSION
+  spec.authors       = ["Olivier Lacan"]
+  spec.email         = ["hi@olivierlacan.com"]
+
+  spec.summary       = %q{Extend link_to to autolink Active Record model instances}
+  spec.description   = %q{Give link_to the ability to point to the show page of an Active Record model instance resource.}
+  spec.homepage      = "https://github.com/olivierlacan/link_to_me"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/olivierlacan/link_to_me"
+  spec.metadata["changelog_uri"] = "https://github.com/olivierlacan/link_to_me/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: link_to_me
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Olivier Lacan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-02-19 00:00:00.000000000 Z
+dependencies: []
+description: Give link_to the ability to point to the show page of an Active Record
+  model instance resource.
+email:
+- hi@olivierlacan.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/link_to_me.rb
+- lib/link_to_me/railtie.rb
+- lib/link_to_me/version.rb
+- link_to_me.gemspec
+homepage: https://github.com/olivierlacan/link_to_me
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/olivierlacan/link_to_me
+  source_code_uri: https://github.com/olivierlacan/link_to_me
+  changelog_uri: https://github.com/olivierlacan/link_to_me/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Extend link_to to autolink Active Record model instances
+test_files: []