Skip to content

Commit 7e9e1f0

Browse files
olivierlacanolivierlacan
committed
Initial commit
0 parents  commit 7e9e1f0

18 files changed

+536
-0
lines changed

‎.github/workflows/tests.yml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: build
2+
on: [push, pull_request]
3+
jobs:
4+
build:
5+
runs-on: ubuntu-latest
6+
strategy:
7+
matrix:
8+
os: [ubuntu]
9+
ruby:
10+
- 2.7
11+
steps:
12+
- uses: actions/checkout@v2
13+
- uses: ruby/setup-ruby@v1
14+
with:
15+
ruby-version: ${{ matrix.ruby }}
16+
bundler-cache: true
17+
- name: "bundle install"
18+
run: bundle install --jobs 4 --retry 3
19+
- name: "rspec"
20+
run: bundle exec rspec spec/

‎.gitignore

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
/.bundle/
2+
/.yardoc
3+
/_yardoc/
4+
/coverage/
5+
/doc/
6+
/pkg/
7+
/spec/reports/
8+
/tmp/
9+
10+
# rspec failure tracking
11+
.rspec_status
12+
*.gem

‎.rspec

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
--format documentation
2+
--color
3+
--require spec_helper

‎CHANGELOG.md

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

‎CODE_OF_CONDUCT.md

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at hi@olivierlacan.com. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [https://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: https://contributor-covenant.org
74+
[version]: https://contributor-covenant.org/version/1/4/

‎Gemfile

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
source "https://rubygems.org"
2+
3+
# Specify your gem's dependencies in link_to_me.gemspec
4+
gemspec
5+
6+
gem "rake", "~> 12.0"
7+
gem "rspec", "~> 3.0"

‎Gemfile.lock

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
PATH
2+
remote: .
3+
specs:
4+
link_to_me (0.1.0)
5+
6+
GEM
7+
remote: https://rubygems.org/
8+
specs:
9+
diff-lcs (1.4.4)
10+
rake (12.3.3)
11+
rspec (3.10.0)
12+
rspec-core (~> 3.10.0)
13+
rspec-expectations (~> 3.10.0)
14+
rspec-mocks (~> 3.10.0)
15+
rspec-core (3.10.1)
16+
rspec-support (~> 3.10.0)
17+
rspec-expectations (3.10.1)
18+
diff-lcs (>= 1.2.0, < 2.0)
19+
rspec-support (~> 3.10.0)
20+
rspec-mocks (3.10.2)
21+
diff-lcs (>= 1.2.0, < 2.0)
22+
rspec-support (~> 3.10.0)
23+
rspec-support (3.10.2)
24+
25+
PLATFORMS
26+
ruby
27+
28+
DEPENDENCIES
29+
link_to_me!
30+
rake (~> 12.0)
31+
rspec (~> 3.0)
32+
33+
BUNDLED WITH
34+
2.1.4

‎LICENSE.txt

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2021 Olivier Lacan
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.

‎README.md

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# LinkToMe
2+
3+
Extend Rails Action View's `link_to` to allow it to autolink any
4+
Active Record model instances with a GET url.
5+
6+
## Installation
7+
8+
Add this line to your application's Gemfile:
9+
10+
```ruby
11+
gem 'link_to_me'
12+
```
13+
14+
And then execute:
15+
16+
$ bundle install
17+
18+
Or install it yourself as:
19+
20+
$ gem install link_to_me
21+
22+
## Usage
23+
24+
```ruby
25+
link_to @model
26+
```
27+
28+
Will result in the following code:
29+
30+
```html
31+
<a href="/models/1">Model 1</a>
32+
```
33+
34+
Given the `@model` instance defines the following method:
35+
36+
```ruby
37+
class Model
38+
def to_s
39+
"Model #{id}"
40+
end
41+
end
42+
```
43+
44+
Here, `to_s` can point to an attribute like `name` as well if it exists
45+
and use a fallback:
46+
47+
```ruby
48+
class Model
49+
def to_s
50+
name || "Model #{id}"
51+
end
52+
end
53+
```
54+
55+
If you don't implement a `to_s` method, `link_to` will instead default
56+
to the original Ruby definition of `to_s` which prints the name of the
57+
instance's class and its `object_id` in hexacidemal format:
58+
59+
```ruby
60+
Object.new.to_s
61+
=> "#<Object:0x00007fc122ad4d10>"
62+
```
63+
64+
It's not quite as useful. Defining `to_s` on Rails Active Record model
65+
classes is not at all destructive. You can still obtain the
66+
non-hexadecimal memory object ID via `Object.new.object_id`:
67+
68+
```ruby
69+
Object.new.object_id
70+
=> 109720
71+
```
72+
73+
## Development
74+
75+
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.
76+
77+
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).
78+
79+
## Contributing
80+
81+
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).
82+
83+
## License
84+
85+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
86+
87+
## Code of Conduct
88+
89+
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).

‎Rakefile

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
require "bundler/gem_tasks"
2+
require "rspec/core/rake_task"
3+
4+
RSpec::Core::RakeTask.new(:spec)
5+
6+
task :default => :spec

‎bin/console

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
#!/usr/bin/env ruby
2+
3+
require "bundler/setup"
4+
require "link_to_me"
5+
6+
# You can add fixtures and/or initialization code here to make experimenting
7+
# with your gem easier. You can also use a different console, if you like.
8+
9+
# (If you use this, don't forget to add pry to your Gemfile!)
10+
# require "pry"
11+
# Pry.start
12+
13+
require "irb"
14+
IRB.start(__FILE__)

‎bin/setup

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
#!/usr/bin/env bash
2+
set -euo pipefail
3+
IFS=$'\n\t'
4+
set -vx
5+
6+
bundle install
7+
8+
# Do any other automated setup that you need to do here

0 commit comments

Comments
 (0)