imgix-rails 4.2.0 → 4.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.circleci/config.yml +129 -0
- data/.github/ISSUE_TEMPLATE/bug_report.md +27 -9
- data/.github/ISSUE_TEMPLATE/feature_request.md +4 -9
- data/.github/ISSUE_TEMPLATE/question.md +3 -8
- data/.github/pull_request_template.md +22 -59
- data/.github/workflows/add-issue-to-project.yml +16 -0
- data/.github/workflows/add-pr-to-project.yml +16 -0
- data/CHANGELOG.md +4 -0
- data/CODE-OF-CONDUCT.md +3 -0
- data/CONTRIBUTING.md +108 -0
- data/README.md +27 -21
- data/imgix-rails.gemspec +1 -0
- data/lib/imgix/rails/picture_tag.rb +3 -2
- data/lib/imgix/rails/version.rb +1 -1
- data/lib/imgix/rails/view_helper.rb +2 -2
- metadata +24 -6
- data/.travis.yml +0 -9
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 98533b06694b9f4b6e0a1a7efa85f10542da35f6e3de8f41db8bf81f7e43cca0
|
|
4
|
+
data.tar.gz: 448ab739e71fd41287b9c8eecdac0fc0214c09bda78104287fc13552030299bc
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 0a3de9ced7e43cbf79f35aca4c7b102994b8e8fa91e97ac4884b376f5741b7fee7dbf0fdb1be3e4eedf6a1a0e3538800d1af9e8cd28b1647b00924df18483dd6
|
|
7
|
+
data.tar.gz: 6f46063c7cd96e2bc1793dd5df3e7b93c529fe9bc6a9c1d5b6fd7b05382cc9a28e662697b5dea3ea7144eb4bf6ceea5b6cc5fe166d28ab3be6ccb024422dda54
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
version: 2.1 # Use 2.1 to enable using orbs and other features.
|
|
2
|
+
|
|
3
|
+
orbs:
|
|
4
|
+
ruby: circleci/ruby@1.2.0
|
|
5
|
+
node: circleci/node@2
|
|
6
|
+
|
|
7
|
+
commands:
|
|
8
|
+
rspec:
|
|
9
|
+
parameters:
|
|
10
|
+
out-path:
|
|
11
|
+
default: /tmp/test-results/rspec
|
|
12
|
+
description: >-
|
|
13
|
+
Where to save the rspec.xml file. Will automatically be saved to
|
|
14
|
+
test_results and artifacts on CircleCI.
|
|
15
|
+
type: string
|
|
16
|
+
steps:
|
|
17
|
+
- run:
|
|
18
|
+
command: >
|
|
19
|
+
mkdir -p <<parameters.out-path>>
|
|
20
|
+
|
|
21
|
+
bundle exec rspec --format RspecJunitFormatter --out <<parameters.out-path>>/results.xml --format progress
|
|
22
|
+
name: "Run tests with RSpec"
|
|
23
|
+
- store_test_results:
|
|
24
|
+
path: <<parameters.out-path>>
|
|
25
|
+
- store_artifacts:
|
|
26
|
+
destination: test-results
|
|
27
|
+
path: <<parameters.out-path>>
|
|
28
|
+
# Have to override the command from the ruby orb, since it doesn't support the --add-platform command
|
|
29
|
+
# Since this command wholly comes from the ruby orb, the best documentation can be found at: https://circleci.com/developer/orbs/orb/circleci/ruby
|
|
30
|
+
install-deps:
|
|
31
|
+
description: Install gems with Bundler.
|
|
32
|
+
parameters:
|
|
33
|
+
app-dir:
|
|
34
|
+
default: .
|
|
35
|
+
description: >
|
|
36
|
+
Path to the directory containing your Gemfile file. Not needed if Gemfile
|
|
37
|
+
lives in the root.
|
|
38
|
+
type: string
|
|
39
|
+
bundler-version:
|
|
40
|
+
default: ''
|
|
41
|
+
description: >
|
|
42
|
+
Configure which version of bundler to install and utilize. By default, it
|
|
43
|
+
gets the bundler version from Gemfile.lock, but if it is not working use
|
|
44
|
+
this to override.
|
|
45
|
+
type: string
|
|
46
|
+
key:
|
|
47
|
+
default: gems-v1
|
|
48
|
+
description: The cache key to use. The key is immutable.
|
|
49
|
+
type: string
|
|
50
|
+
path:
|
|
51
|
+
default: ./vendor/bundle
|
|
52
|
+
description: >
|
|
53
|
+
Installation path. By default, it will run bundle with `--deployment` flag
|
|
54
|
+
and installs gems to the vendor/bundle directory.
|
|
55
|
+
type: string
|
|
56
|
+
with-cache:
|
|
57
|
+
default: true
|
|
58
|
+
description: Enable automatic caching of your gemfile dependencies for increased speed.
|
|
59
|
+
type: boolean
|
|
60
|
+
platform:
|
|
61
|
+
default: 'x86_64-linux'
|
|
62
|
+
type: string
|
|
63
|
+
steps:
|
|
64
|
+
- when:
|
|
65
|
+
condition: <<parameters.with-cache>>
|
|
66
|
+
steps:
|
|
67
|
+
- restore_cache:
|
|
68
|
+
keys:
|
|
69
|
+
- >-
|
|
70
|
+
<< parameters.key >>-{{ checksum
|
|
71
|
+
"<<parameters.app-dir>>/Gemfile" }}-{{ .Branch }}
|
|
72
|
+
- >-
|
|
73
|
+
<< parameters.key >>-{{ checksum
|
|
74
|
+
"<<parameters.app-dir>>/Gemfile" }}
|
|
75
|
+
- << parameters.key >>
|
|
76
|
+
- run:
|
|
77
|
+
command: |
|
|
78
|
+
gem install bundler
|
|
79
|
+
|
|
80
|
+
# here is only part that is changed from the orb command,
|
|
81
|
+
# where we add the platform command to allow CircleCI to bundle
|
|
82
|
+
bundle lock --add-platform <<parameters.platform>>
|
|
83
|
+
if [ "<< parameters.path >>" == "./vendor/bundle" ]; then
|
|
84
|
+
bundle config set deployment 'true'
|
|
85
|
+
fi
|
|
86
|
+
bundle config set path << parameters.path >>
|
|
87
|
+
bundle check || bundle install
|
|
88
|
+
name: >-
|
|
89
|
+
Bundle Install <<^parameters.with-cache>>(No
|
|
90
|
+
Cache)<</parameters.with-cache>>
|
|
91
|
+
working_directory: <<parameters.app-dir>>
|
|
92
|
+
- when:
|
|
93
|
+
condition: <<parameters.with-cache>>
|
|
94
|
+
steps:
|
|
95
|
+
- save_cache:
|
|
96
|
+
key: >-
|
|
97
|
+
<< parameters.key >>-{{ checksum
|
|
98
|
+
"<<parameters.app-dir>>/Gemfile" }}-{{ .Branch }}
|
|
99
|
+
paths:
|
|
100
|
+
- <<parameters.app-dir>>/<< parameters.path >>
|
|
101
|
+
|
|
102
|
+
jobs:
|
|
103
|
+
test:
|
|
104
|
+
parameters:
|
|
105
|
+
version:
|
|
106
|
+
default: "cimg/ruby:3.0-node"
|
|
107
|
+
description: Ruby image to use
|
|
108
|
+
type: string
|
|
109
|
+
docker:
|
|
110
|
+
- image: <<parameters.version>>
|
|
111
|
+
steps:
|
|
112
|
+
- checkout
|
|
113
|
+
- install-deps:
|
|
114
|
+
key: <<parameters.version>>
|
|
115
|
+
- rspec
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
workflows:
|
|
119
|
+
version: 2
|
|
120
|
+
test:
|
|
121
|
+
jobs:
|
|
122
|
+
- test:
|
|
123
|
+
matrix:
|
|
124
|
+
parameters:
|
|
125
|
+
version:
|
|
126
|
+
- "cimg/ruby:3.0-node"
|
|
127
|
+
- "cimg/ruby:2.7-node"
|
|
128
|
+
- "cimg/ruby:3.1-node"
|
|
129
|
+
- "circleci/jruby:9.2.11.0-node"
|
|
@@ -1,28 +1,46 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: Bug report
|
|
3
3
|
about: Create a report to help us improve
|
|
4
|
-
title: ''
|
|
5
|
-
labels: bug
|
|
6
|
-
assignees: ''
|
|
7
|
-
|
|
8
4
|
---
|
|
9
5
|
|
|
10
|
-
|
|
6
|
+
**Before you submit:**
|
|
7
|
+
|
|
8
|
+
- [ ] Please read the [contributing guidelines](CONTRIBUTING.md)
|
|
9
|
+
- [ ] Please search through the existing issues (both open AND closed) to see if your issue has been discussed before. Github issue search can be used for this: https://github.com/imgix/vue/issues?utf8=%E2%9C%93&q=is%3Aissue
|
|
10
|
+
- [ ] Please ensure the problem has been isolated and reduced. This link explains more: http://css-tricks.com/6263-reduced-test-cases/
|
|
11
11
|
|
|
12
12
|
**Describe the bug**
|
|
13
|
-
A clear and concise description of what the bug is.
|
|
13
|
+
A clear and concise description of what the bug is. Please strive to reach the **root problem** of your issue to avoid the XY problem. See more: https://meta.stackexchange.com/questions/66377/what-is-the-xy-problem
|
|
14
14
|
|
|
15
15
|
**To Reproduce**
|
|
16
|
-
|
|
16
|
+
A bug is a _demonstrable problem_ that is caused by the code in the repository. Thus, the contributors need a way to reproduce your issue - if we can't reproduce your issue, we can't help you! Also, please be as detailed as possible.
|
|
17
|
+
|
|
18
|
+
[a link to a codesandox or repl.it; here is a link to a codesandbox with @imgix/vue installed which can be forked: https://codesandbox.io/s/vue-imgix-base-codesandbox-bhz8n]
|
|
19
|
+
|
|
20
|
+
[alternatively, please provide a code example]
|
|
17
21
|
|
|
18
|
-
|
|
22
|
+
```js
|
|
23
|
+
// A *self-contained* demonstration of the problem follows...
|
|
24
|
+
// This should be able to be dropped into a file with @imgix/vue installed and just work
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Steps to reproduce the behaviour:
|
|
28
|
+
|
|
29
|
+
1. Go to '...'
|
|
30
|
+
2. Click on '....'
|
|
31
|
+
3. Scroll down to '....'
|
|
32
|
+
4. See error
|
|
33
|
+
|
|
34
|
+
**Expected behaviour**
|
|
19
35
|
A clear and concise description of what you expected to happen.
|
|
20
36
|
|
|
21
37
|
**Screenshots**
|
|
22
38
|
If applicable, add screenshots to help explain your problem.
|
|
23
39
|
|
|
24
40
|
**Information:**
|
|
25
|
-
|
|
41
|
+
|
|
42
|
+
- @imgix/vue version: [e.g. v1.0]
|
|
43
|
+
- browser version: [include link from [https://www.whatsmybrowser.org/](https://www.whatsmybrowser.org/) or details about the OS used and browser version]
|
|
26
44
|
|
|
27
45
|
**Additional context**
|
|
28
46
|
Add any other context about the problem here.
|
|
@@ -1,24 +1,19 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: Feature request
|
|
3
3
|
about: Suggest an idea for this project
|
|
4
|
-
title: ''
|
|
5
|
-
labels: ''
|
|
6
|
-
assignees: ''
|
|
7
|
-
|
|
8
4
|
---
|
|
9
5
|
|
|
10
|
-
Please provide the following information and someone from @imgix/imgix-sdk-team will respond to your issue shortly.
|
|
11
|
-
|
|
12
6
|
**Before you submit:**
|
|
13
7
|
|
|
14
|
-
- [ ] Please
|
|
15
|
-
- [ ] Please
|
|
8
|
+
- [ ] Please read the [contributing guidelines](CONTRIBUTING.md)
|
|
9
|
+
- [ ] Please search through the existing issues (both open AND closed) to see if your feature has already been discussed. Github issue search can be used for this: https://github.com/imgix/vue/issues?utf8=%E2%9C%93&q=is%3Aissue
|
|
10
|
+
- [ ] Please take a moment to find out whether your idea fits with the scope and aims of the project
|
|
16
11
|
|
|
17
12
|
**Is your feature request related to a problem? Please describe.**
|
|
18
13
|
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
|
19
14
|
|
|
20
15
|
**Describe the solution you'd like**
|
|
21
|
-
A clear and concise description of
|
|
16
|
+
A clear and concise description of how this feature would function.
|
|
22
17
|
|
|
23
18
|
**Describe alternatives you've considered**
|
|
24
19
|
A clear and concise description of any alternative solutions or features you've considered.
|
|
@@ -1,17 +1,12 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: Question
|
|
3
3
|
about: Ask a question about the project
|
|
4
|
-
title: ''
|
|
5
|
-
labels: ''
|
|
6
|
-
assignees: ''
|
|
7
|
-
|
|
8
4
|
---
|
|
9
5
|
|
|
10
|
-
Please provide the following information and someone from @imgix/imgix-sdk-team will respond to your issue shortly.
|
|
11
|
-
|
|
12
6
|
**Before you submit:**
|
|
13
7
|
|
|
14
|
-
- [ ] Please
|
|
8
|
+
- [ ] Please read the [contributing guidelines](CONTRIBUTING.md)
|
|
9
|
+
- [ ] Please search through the existing issues (both open AND closed) to see if your question has already been discussed. Github issue search can be used for this: https://github.com/imgix/vue/issues?utf8=%E2%9C%93&q=is%3Aissue
|
|
15
10
|
|
|
16
11
|
**Question**
|
|
17
|
-
A clear and concise description of your question
|
|
12
|
+
A clear and concise description of your question
|
|
@@ -1,73 +1,36 @@
|
|
|
1
1
|
<!--
|
|
2
|
-
Hello, and thanks for contributing
|
|
2
|
+
Hello, and thanks for contributing 🎉🙌
|
|
3
3
|
Please take a second to fill out PRs with the following template!
|
|
4
4
|
-->
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
## Description
|
|
7
7
|
|
|
8
|
-
<!-- What is accomplished by this PR? If there is something potentially
|
|
8
|
+
<!-- What is accomplished by this PR? If there is something potentially
|
|
9
|
+
controversial in your PR, please take a moment to tell us about your choices.-->
|
|
9
10
|
|
|
10
|
-
<!--
|
|
11
|
-
Please use the checklist that is most closely related to your PR, and delete the other checklists. -->
|
|
11
|
+
<!-- Before this PR... -->
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
<!-- After this PR... -->
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
<!-- Steps to test: either provide a code snippet that exhibits this change or a link to a codepen/codesandbox demo -->
|
|
16
16
|
|
|
17
|
-
## Checklist
|
|
17
|
+
## Checklist
|
|
18
18
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
- [ ] Update the readme
|
|
23
|
-
- [ ] Update or add any necessary API documentation
|
|
24
|
-
- [ ] Add some [steps](#steps-to-test) so we can test your bug fix
|
|
25
|
-
|
|
26
|
-
## Checklist: New Feature
|
|
27
|
-
|
|
28
|
-
- [ ] Each commit follows the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/#summary) format: e.g. `chore(readme): fixed typo`. See the end of this file for more information.
|
|
29
|
-
- [ ] Any breaking changes are specified on the commit on which they are introduced with `BREAKING CHANGE` in the body of the commit.
|
|
30
|
-
- [ ] If this is a big feature with breaking changes, consider [opening an issue](https://github.com/imgix/imgix-rails/issues/new?assignees=&labels=&template=feature_request.md&title=) to discuss first. This is completely up to you, but please keep in mind that your PR might not be accepted.
|
|
31
|
-
- [ ] Run unit tests to ensure all existing tests are still passing
|
|
32
|
-
- [ ] Add new passing unit tests to cover the code introduced by your PR
|
|
33
|
-
- [ ] Update the readme
|
|
34
|
-
- [ ] Add some [steps](#steps-to-test) so we can test your cool new feature!
|
|
35
|
-
|
|
36
|
-
## Steps to Test
|
|
37
|
-
|
|
38
|
-
<!-- Delete this selction if you are just submitting a doc change/small fix -->
|
|
39
|
-
|
|
40
|
-
<!-- A code example or a set of steps is preferred -->
|
|
41
|
-
|
|
42
|
-
Related issue: [e.g. #42]
|
|
43
|
-
|
|
44
|
-
Code:
|
|
45
|
-
|
|
46
|
-
```rb
|
|
47
|
-
# A standalone example of what the PR solves
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
<!-- A link to a codepen/codesandbox is also an option. -->
|
|
51
|
-
|
|
52
|
-
<!--
|
|
19
|
+
<!-- Please ensure you've completed this checklist before submitting a PR. If
|
|
20
|
+
You're not submitting a bugfix or feature, delete that part of the checklist.
|
|
21
|
+
-->
|
|
53
22
|
|
|
54
|
-
|
|
23
|
+
<!-- For all Pull Requests -->
|
|
55
24
|
|
|
56
|
-
|
|
25
|
+
- [ ] Read the [contributing guidelines](CONTRIBUTING.md).
|
|
26
|
+
- [ ] Each commit follows the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/#summary) spec format.
|
|
27
|
+
- [ ] Update the readme (if applicable).
|
|
28
|
+
- [ ] Update or add any necessary API documentation (if applicable)
|
|
29
|
+
- [ ] All existing unit tests are still passing (if applicable).
|
|
57
30
|
|
|
58
|
-
|
|
59
|
-
- `feat`: a feature, or breaking change
|
|
60
|
-
- `fix`: a bug-fix
|
|
61
|
-
- `test`: Adding missing tests or correcting existing tests
|
|
62
|
-
- `docs`: documentation only changes (readme, changelog, contributing guide)
|
|
63
|
-
- `refactor`: a code change that neither fixes a bug nor adds a feature
|
|
64
|
-
- `chore`: reoccurring tasks for project maintainability (example scopes: release, deps)
|
|
65
|
-
- `config`: changes to tooling configurations used in the project
|
|
66
|
-
- `build`: changes that affect the build system or external dependencies (example scopes: npm, bundler, gradle)
|
|
67
|
-
- `ci`: changes to CI configuration files and scripts (example scopes: travis)
|
|
68
|
-
- `perf`: a code change that improves performance
|
|
69
|
-
- `style`: changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
|
|
31
|
+
<!-- For new feature and bugfix Pull Requests-->
|
|
70
32
|
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
33
|
+
- [ ] Add some [steps](#steps-to-test) so we can test your bug fix or feature (if applicable).
|
|
34
|
+
- [ ] Add new passing unit tests to cover the code introduced by your PR (if applicable).
|
|
35
|
+
- [ ] Any breaking changes are specified on the commit on which they are introduced with `BREAKING CHANGE` in the body of the commit.
|
|
36
|
+
- [ ] If this is a big feature with breaking changes, consider opening an issue to discuss first. This is completely up to you, but please keep in mind that your PR might not be accepted.
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
name: Add issues to project
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
issues:
|
|
5
|
+
types:
|
|
6
|
+
- opened
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
add-to-project:
|
|
10
|
+
name: Add issue to project
|
|
11
|
+
runs-on: ubuntu-latest
|
|
12
|
+
steps:
|
|
13
|
+
- uses: actions/add-to-project@v0.3.0
|
|
14
|
+
with:
|
|
15
|
+
project-url: https://github.com/orgs/imgix/projects/4
|
|
16
|
+
github-token: ${{ secrets.GH_TOKEN }}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
name: Add needs-review and size/XL pull requests to projects
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
pull_request:
|
|
5
|
+
types:
|
|
6
|
+
- opened
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
add-to-project:
|
|
10
|
+
name: Add issue to project
|
|
11
|
+
runs-on: ubuntu-latest
|
|
12
|
+
steps:
|
|
13
|
+
- uses: actions/add-to-project@v0.3.0
|
|
14
|
+
with:
|
|
15
|
+
project-url: https://github.com/orgs/imgix/projects/4
|
|
16
|
+
github-token: ${{ secrets.GH_TOKEN }}
|
data/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,10 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
This project adheres to [Semantic Versioning](http://semver.org/).
|
|
5
5
|
|
|
6
|
+
## [4.3.0](https://github.com/imgix/imgix-rb/compare/4.2.0...4.3.0) - December 14, 2022
|
|
7
|
+
|
|
8
|
+
- Add img_tag_options to ix_picture_tag ([#118] (https://github.com/imgix/imgix-rails/pull/118))
|
|
9
|
+
|
|
6
10
|
## [4.2.0](https://github.com/imgix/imgix-rb/compare/4.1.0...4.2.0) - January 05, 2021
|
|
7
11
|
|
|
8
12
|
- Add support for lazy image loading ([#108](https://github.com/imgix/imgix-rails/pull/108))
|
data/CODE-OF-CONDUCT.md
ADDED
data/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
# Contributing Guide
|
|
2
|
+
|
|
3
|
+
Thank you for investing your time in contributing to this project! Please take a moment to review this document in order to streamline the contribution process for you and any reviewers involved.
|
|
4
|
+
|
|
5
|
+
Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable.
|
|
6
|
+
|
|
7
|
+
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
|
|
8
|
+
|
|
9
|
+
## New contributor guide
|
|
10
|
+
|
|
11
|
+
To get an overview of the project, read the [README](README.md). Here are some resources to help you get started with open source contributions:
|
|
12
|
+
|
|
13
|
+
- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)
|
|
14
|
+
- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git)
|
|
15
|
+
- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow)
|
|
16
|
+
- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)
|
|
17
|
+
|
|
18
|
+
## Opening a Pull Request
|
|
19
|
+
|
|
20
|
+
_To help the project's maintainers and community quickly understand the nature of your pull request, please be sure to do the following:_
|
|
21
|
+
|
|
22
|
+
1. Include a descriptive Pull Request title.
|
|
23
|
+
2. Provide a detailed description that explains the nature of the change(s) introduced. This is not only helpful for your reviewer, but also for future users who may need to revisit your Pull Request for context purposes. Screenshots/video captures are helpful here!
|
|
24
|
+
3. Make incremental, modular changes, with a clean commit history. This helps reviewers understand your contribution more easily and maintain project quality.
|
|
25
|
+
|
|
26
|
+
### Checklist
|
|
27
|
+
|
|
28
|
+
Check to see that you have completed each of the following before requesting a review of your Pull Request:
|
|
29
|
+
|
|
30
|
+
- [ ] All existing unit tests are still passing (if applicable)
|
|
31
|
+
- [ ] Add new passing unit tests to cover the code introduced by your PR
|
|
32
|
+
- [ ] Update the README
|
|
33
|
+
- [ ] Update or add any necessary API documentation
|
|
34
|
+
- [ ] All commits in the branch adhere to the [conventional commit](#conventional-commit-spec) format: e.g. `fix: bug #issue-number`
|
|
35
|
+
|
|
36
|
+
## Conventional Commit Spec
|
|
37
|
+
|
|
38
|
+
Commits should be in the format `<type>(<scope>): <description>`. This allows our team to leverage tooling for automatic releases and changelog generation. An example of a commit in this format might be: `docs(readme): fix typo in documentation`
|
|
39
|
+
|
|
40
|
+
`type` can be any of the follow:
|
|
41
|
+
|
|
42
|
+
- `feat`: a feature, or breaking change
|
|
43
|
+
- `fix`: a bug-fix
|
|
44
|
+
- `test`: Adding missing tests or correcting existing tests
|
|
45
|
+
- `docs`: documentation only changes (readme, changelog, contributing guide)
|
|
46
|
+
- `refactor`: a code change that neither fixes a bug nor adds a feature
|
|
47
|
+
- `chore`: reoccurring tasks for project maintainability (example scopes: release, deps)
|
|
48
|
+
- `config`: changes to tooling configurations used in the project
|
|
49
|
+
- `build`: changes that affect the build system or external dependencies (example scopes: npm, bundler, gradle)
|
|
50
|
+
- `ci`: changes to CI configuration files and scripts (example scopes: travis)
|
|
51
|
+
- `perf`: a code change that improves performance
|
|
52
|
+
- `style`: changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
|
|
53
|
+
|
|
54
|
+
`scope` is optional, and can be anything.
|
|
55
|
+
`description` should be a short description of the change, written in the imperative-mood.
|
|
56
|
+
|
|
57
|
+
### Example workflow
|
|
58
|
+
|
|
59
|
+
Follow this process if you'd like your work considered for inclusion in the
|
|
60
|
+
project:
|
|
61
|
+
|
|
62
|
+
1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork,
|
|
63
|
+
and configure the remotes:
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
# Clone your fork of the repo into the current directory
|
|
67
|
+
git clone git@github.com:<YOUR_USERNAME>/imgix-rails.git
|
|
68
|
+
# Navigate to the newly cloned directory
|
|
69
|
+
cd imgix-rails
|
|
70
|
+
# Assign the original repo to a remote called "upstream"
|
|
71
|
+
git remote add upstream https://github.com/imgix/imgix-rails
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
2. If you cloned a while ago, get the latest changes from upstream:
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
git checkout <dev-branch>
|
|
78
|
+
git pull upstream <dev-branch>
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
3. Create a new topic branch (off the main project development branch) to
|
|
82
|
+
contain your feature, change, or fix:
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
git checkout -b <topic-branch-name>
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
4. Commit your changes in logical chunks. Use Git's
|
|
89
|
+
[interactive rebase](https://help.github.com/articles/interactive-rebase)
|
|
90
|
+
feature to tidy up your commits before making them public.
|
|
91
|
+
|
|
92
|
+
5. Locally merge (or rebase) the upstream development branch into your topic branch:
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
git pull [--rebase] upstream <dev-branch>
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
6. Push your topic branch up to your fork:
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
git push origin <topic-branch-name>
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
|
|
105
|
+
with a clear title and description.
|
|
106
|
+
|
|
107
|
+
**IMPORTANT**: By submitting a patch, you agree to allow the project owner to
|
|
108
|
+
license your work under the same license as that used by the project.
|
data/README.md
CHANGED
|
@@ -4,35 +4,37 @@
|
|
|
4
4
|
`imgix-rails` is a gem for integrating [imgix](https://www.imgix.com/) into Ruby on Rails applications. It builds on [imgix-rb](https://github.com/imgix/imgix-rb) to offer a few Rails-specific interfaces.
|
|
5
5
|
|
|
6
6
|
[](https://rubygems.org/gems/imgix-rails)
|
|
7
|
-
[](https://circleci.com/gh/imgix/imgix-rails)
|
|
8
8
|
|
|
9
9
|
[](https://github.com/imgix/imgix-rails/blob/main/LICENSE)
|
|
10
|
+
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fimgix%2Fimgix-rails?ref=badge_shield)
|
|
10
11
|
|
|
11
12
|
---
|
|
12
13
|
<!-- /ix-docs-ignore -->
|
|
13
14
|
|
|
14
15
|
- [Installation](#installation)
|
|
15
16
|
- [Usage](#usage)
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
17
|
+
* [Configuration](#configuration)
|
|
18
|
+
+ [Multi-source configuration](#multi-source-configuration)
|
|
19
|
+
* [`ix_image_tag`](#ix_image_tag)
|
|
20
|
+
+ [Fixed image rendering](#fixed-image-rendering)
|
|
21
|
+
+ [Lazy loading](#lazy-loading)
|
|
22
|
+
* [`ix_picture_tag`](#ix_picture_tag)
|
|
23
|
+
* [`ix_image_url`](#ix_image_url)
|
|
24
|
+
+ [Usage in Model](#usage-in-model)
|
|
25
|
+
+ [Usage in Sprockets](#usage-in-sprockets)
|
|
25
26
|
- [Using With Image Uploading Libraries](#using-with-image-uploading-libraries)
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
27
|
+
* [Paperclip and CarrierWave](#paperclip-and-carrierwave)
|
|
28
|
+
* [Refile](#refile)
|
|
29
|
+
* [Active Storage](#active-storage)
|
|
30
|
+
* [S3](#s3)
|
|
31
|
+
* [GCS](#gcs)
|
|
31
32
|
- [Upgrade Guides](#upgrade-guides)
|
|
32
|
-
|
|
33
|
+
* [3.x to 4.0](#3x-to-40)
|
|
33
34
|
- [Development](#development)
|
|
34
35
|
- [Contributing](#contributing)
|
|
35
36
|
- [Code of Conduct](#code-of-conduct)
|
|
37
|
+
- [License](#license)
|
|
36
38
|
|
|
37
39
|
## Installation
|
|
38
40
|
|
|
@@ -213,6 +215,7 @@ The `ix_picture_tag` helper method makes it easy to generate `picture` elements
|
|
|
213
215
|
* `source`: an optional String indicating the source to be used. If unspecified `:source` or `:default_source` will be used. If specified, the value must be defined in the config.
|
|
214
216
|
* `path`: The path or URL of the image to display.
|
|
215
217
|
* `tag_options`: Any options to apply to the parent `picture` element. This is useful for adding class names, etc.
|
|
218
|
+
* `img_tag_options`: Any options to apply to the generated `img` element. This can be useful to add an `alt` attribute.
|
|
216
219
|
* `url_params`: Default imgix options. These will be used to generate a fallback `img` tag for older browsers, and used in each `source` unless overridden by `breakpoints`.
|
|
217
220
|
* `breakpoints`: A hash describing the variants. Each key must be a media query (e.g. `(max-width: 880px)`), and each value must be a hash of parameter overrides for that media query. A `source` element will be generated for each breakpoint specified.
|
|
218
221
|
* `srcset_options`: A variety of options that allow for fine tuning `srcset` generation. More information on each of these modifiers can be found in the [imgix-rb documentation](https://github.com/imgix/imgix-rb#srcset-generation). Any of the following can be passed as arguments:
|
|
@@ -226,6 +229,9 @@ The `ix_picture_tag` helper method makes it easy to generate `picture` elements
|
|
|
226
229
|
tag_options: {
|
|
227
230
|
class: 'a-picture-tag'
|
|
228
231
|
},
|
|
232
|
+
img_tag_options: {
|
|
233
|
+
alt: 'A picture of Bert and Ernie arguing'
|
|
234
|
+
},
|
|
229
235
|
url_params: {
|
|
230
236
|
w: 300,
|
|
231
237
|
h: 300,
|
|
@@ -265,6 +271,7 @@ To generate a `picture` element on a different source:
|
|
|
265
271
|
```erb
|
|
266
272
|
<%= ix_picture_tag('assets2.imgix.net', 'bertandernie.jpg',
|
|
267
273
|
tag_options: {},
|
|
274
|
+
img_tag_options: {},
|
|
268
275
|
url_params: {},
|
|
269
276
|
breakpoints: {
|
|
270
277
|
'(max-width: 640px)' => {
|
|
@@ -446,11 +453,10 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
|
|
|
446
453
|
|
|
447
454
|
## Contributing
|
|
448
455
|
|
|
449
|
-
|
|
450
|
-
2. Create your feature branch (`git checkout -b my-new-feature`)
|
|
451
|
-
3. Commit your changes (`git commit -am 'Add some feature'`)
|
|
452
|
-
4. Push to the branch (`git push origin my-new-feature`)
|
|
453
|
-
5. Create a new Pull Request
|
|
456
|
+
See [contributing guidelines](CONTRIBUTING.md).
|
|
454
457
|
|
|
455
458
|
## Code of Conduct
|
|
456
459
|
Users contributing to or participating in the development of this project are subject to the terms of imgix's [Code of Conduct](https://github.com/imgix/code-of-conduct).
|
|
460
|
+
|
|
461
|
+
## License
|
|
462
|
+
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fimgix%2Fimgix-rails?ref=badge_large)
|
data/imgix-rails.gemspec
CHANGED
|
@@ -5,10 +5,11 @@ require "action_view"
|
|
|
5
5
|
class Imgix::Rails::PictureTag < Imgix::Rails::Tag
|
|
6
6
|
include ActionView::Context
|
|
7
7
|
|
|
8
|
-
def initialize(path, source: nil, tag_options: {}, url_params: {}, breakpoints: {}, srcset_options: {})
|
|
8
|
+
def initialize(path, source: nil, tag_options: {}, img_tag_options: {}, url_params: {}, breakpoints: {}, srcset_options: {})
|
|
9
9
|
@path = path
|
|
10
10
|
@source = source
|
|
11
11
|
@tag_options = tag_options
|
|
12
|
+
@img_tag_options = img_tag_options
|
|
12
13
|
@url_params = url_params
|
|
13
14
|
@breakpoints = breakpoints
|
|
14
15
|
@srcset_options = srcset_options
|
|
@@ -28,7 +29,7 @@ class Imgix::Rails::PictureTag < Imgix::Rails::Tag
|
|
|
28
29
|
concat(content_tag(:source, nil, source_tag_opts))
|
|
29
30
|
end
|
|
30
31
|
|
|
31
|
-
concat Imgix::Rails::ImageTag.new(@path, source: @source, url_params: @url_params, srcset_options: @srcset_options).render
|
|
32
|
+
concat Imgix::Rails::ImageTag.new(@path, source: @source, tag_options: @img_tag_options, url_params: @url_params, srcset_options: @srcset_options).render
|
|
32
33
|
end
|
|
33
34
|
end
|
|
34
35
|
|
data/lib/imgix/rails/version.rb
CHANGED
|
@@ -12,8 +12,8 @@ module Imgix
|
|
|
12
12
|
return Imgix::Rails::ImageTag.new(path, source: source, tag_options: tag_options, url_params: url_params, srcset_options: srcset_options, attribute_options: attribute_options).render
|
|
13
13
|
end
|
|
14
14
|
|
|
15
|
-
def ix_picture_tag(source=nil, path, tag_options: {}, url_params: {}, breakpoints: {}, srcset_options: {})
|
|
16
|
-
return Imgix::Rails::PictureTag.new(path, source: source, tag_options: tag_options, url_params: url_params, breakpoints: breakpoints, srcset_options: srcset_options).render
|
|
15
|
+
def ix_picture_tag(source=nil, path, tag_options: {}, img_tag_options: {}, url_params: {}, breakpoints: {}, srcset_options: {})
|
|
16
|
+
return Imgix::Rails::PictureTag.new(path, source: source, tag_options: tag_options, img_tag_options: img_tag_options, url_params: url_params, breakpoints: breakpoints, srcset_options: srcset_options).render
|
|
17
17
|
end
|
|
18
18
|
end
|
|
19
19
|
end
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: imgix-rails
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 4.
|
|
4
|
+
version: 4.3.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Kelly Sutton
|
|
@@ -9,7 +9,7 @@ authors:
|
|
|
9
9
|
autorequire:
|
|
10
10
|
bindir: exe
|
|
11
11
|
cert_chain: []
|
|
12
|
-
date:
|
|
12
|
+
date: 2022-12-15 00:00:00.000000000 Z
|
|
13
13
|
dependencies:
|
|
14
14
|
- !ruby/object:Gem::Dependency
|
|
15
15
|
name: imgix
|
|
@@ -81,6 +81,20 @@ dependencies:
|
|
|
81
81
|
- - ">="
|
|
82
82
|
- !ruby/object:Gem::Version
|
|
83
83
|
version: '0'
|
|
84
|
+
- !ruby/object:Gem::Dependency
|
|
85
|
+
name: rspec_junit_formatter
|
|
86
|
+
requirement: !ruby/object:Gem::Requirement
|
|
87
|
+
requirements:
|
|
88
|
+
- - "~>"
|
|
89
|
+
- !ruby/object:Gem::Version
|
|
90
|
+
version: 0.4.1
|
|
91
|
+
type: :development
|
|
92
|
+
prerelease: false
|
|
93
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
94
|
+
requirements:
|
|
95
|
+
- - "~>"
|
|
96
|
+
- !ruby/object:Gem::Version
|
|
97
|
+
version: 0.4.1
|
|
84
98
|
description: Makes integrating imgix into your Rails app easier. It builds on imgix-rb
|
|
85
99
|
to offer a few Rails-specific interfaces. Please see https://github.com/imgix/imgix-rails
|
|
86
100
|
for more details.
|
|
@@ -91,15 +105,19 @@ executables: []
|
|
|
91
105
|
extensions: []
|
|
92
106
|
extra_rdoc_files: []
|
|
93
107
|
files:
|
|
108
|
+
- ".circleci/config.yml"
|
|
94
109
|
- ".github/CODEOWNERS"
|
|
95
110
|
- ".github/ISSUE_TEMPLATE/bug_report.md"
|
|
96
111
|
- ".github/ISSUE_TEMPLATE/feature_request.md"
|
|
97
112
|
- ".github/ISSUE_TEMPLATE/question.md"
|
|
98
113
|
- ".github/pull_request_template.md"
|
|
114
|
+
- ".github/workflows/add-issue-to-project.yml"
|
|
115
|
+
- ".github/workflows/add-pr-to-project.yml"
|
|
99
116
|
- ".gitignore"
|
|
100
117
|
- ".rspec"
|
|
101
|
-
- ".travis.yml"
|
|
102
118
|
- CHANGELOG.md
|
|
119
|
+
- CODE-OF-CONDUCT.md
|
|
120
|
+
- CONTRIBUTING.md
|
|
103
121
|
- Gemfile
|
|
104
122
|
- LICENSE
|
|
105
123
|
- README.md
|
|
@@ -121,8 +139,8 @@ licenses:
|
|
|
121
139
|
metadata:
|
|
122
140
|
bug_tracker_uri: https://github.com/imgix/imgix-rails/issues
|
|
123
141
|
changelog_uri: https://github.com/imgix/imgix-rails/blob/main/CHANGELOG.md
|
|
124
|
-
documentation_uri: https://www.rubydoc.info/gems/imgix-rails/4.
|
|
125
|
-
source_code_uri: https://github.com/imgix/imgix-rails/tree/v4.
|
|
142
|
+
documentation_uri: https://www.rubydoc.info/gems/imgix-rails/4.3.0
|
|
143
|
+
source_code_uri: https://github.com/imgix/imgix-rails/tree/v4.3.0
|
|
126
144
|
allowed_push_host: https://rubygems.org
|
|
127
145
|
post_install_message:
|
|
128
146
|
rdoc_options: []
|
|
@@ -139,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
139
157
|
- !ruby/object:Gem::Version
|
|
140
158
|
version: '0'
|
|
141
159
|
requirements: []
|
|
142
|
-
rubygems_version: 3.1
|
|
160
|
+
rubygems_version: 3.0.3.1
|
|
143
161
|
signing_key:
|
|
144
162
|
specification_version: 4
|
|
145
163
|
summary: Makes integrating imgix into your Rails app easier. It builds on imgix-rb
|