govuk_design_system_formbuilder 0.9.8 → 1.0.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 +4 -4
- data/README.md +25 -18
- data/lib/govuk_design_system_formbuilder/elements/inputs/base.rb +1 -1
- data/lib/govuk_design_system_formbuilder/version.rb +1 -1
- metadata +24 -24
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: c6cd261aede14003b41cba2f6d164a952e07daf37b18ce0cdddf553391fa335e
|
|
4
|
+
data.tar.gz: 72e545d0c8f00a97392ca6265f8ddbea7d3e28549889e9c6ec672c8560bcc503
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a040500a96d4238db0dd79dff19d27304f6463ef790a7c71b83ba88b68391a4b9c5b2285e9d839e51f34ebfed2d1dc36ac40131cfeb31567f44d0356362b6b6a
|
|
7
|
+
data.tar.gz: 004f50ef512c190bfb96b4e1b772edf84bf73a8c33e8973542f6eca774842085889170f3dc3047df8fc21d3a76daa516ba978c2026c8cf6306ad4ec97622af84
|
data/README.md
CHANGED
|
@@ -2,17 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://travis-ci.com/DFE-Digital/govuk_design_system_formbuilder)
|
|
4
4
|
[](https://codeclimate.com/github/DFE-Digital/govuk_design_system_formbuilder/maintainability)
|
|
5
|
-
[](https://codeclimate.com/github/DFE-Digital/govuk_design_system_formbuilder/test_coverage)
|
|
6
5
|
[](https://badge.fury.io/rb/govuk_design_system_formbuilder)
|
|
7
|
-
[](https://rubygems.org/gems/govuk_design_system_formbuilder)
|
|
7
|
+
[](https://codeclimate.com/github/DFE-Digital/govuk_design_system_formbuilder/test_coverage)
|
|
8
|
+
[](https://dependabot.com)
|
|
9
|
+
[](https://github.com/DFE-Digital/govuk_design_system_formbuilder/blob/master/LICENSE)
|
|
10
|
+
[](https://design-system.service.gov.uk)
|
|
8
11
|
|
|
9
12
|
This gem provides a easy-to-use form builder that generates forms that are
|
|
10
|
-
fully-compliant with version 3.
|
|
13
|
+
fully-compliant with version 3.4.0 of the [GOV.UK Design System](https://design-system.service.gov.uk/),
|
|
11
14
|
minimising the amount of markup you need to write.
|
|
12
15
|
|
|
13
|
-
The latest version of this gem that supports GOV.UK Design System version 2 is
|
|
14
|
-
[0.7.10](https://github.com/DFE-Digital/govuk_design_system_formbuilder/releases/tag/v0.7.10).
|
|
15
|
-
|
|
16
16
|
In addition to the basic markup, the more-advanced functionality of the Design
|
|
17
17
|
System is exposed via the API. Adding [JavaScript-enhanced word count
|
|
18
18
|
checking](https://govuk-form-builder.netlify.com/form-elements/text-area/)
|
|
@@ -20,12 +20,20 @@ to text areas or [setting the size and weight of
|
|
|
20
20
|
labels](https://govuk-form-builder.netlify.com/introduction/labels-hints-and-legends/)
|
|
21
21
|
on text fields requires only a single argument.
|
|
22
22
|
|
|
23
|
+
## Documentation 📚
|
|
24
|
+
|
|
25
|
+
The gem comes with [a full guide](https://govuk-form-builder.netlify.com/) that
|
|
26
|
+
covers most aspects of day-to-day use, along with code and output examples. The guide
|
|
27
|
+
is generated from the builder itself so it will always be up to date.
|
|
28
|
+
|
|
23
29
|
If you're still not sure what a form builder is or how it works, don't worry!
|
|
24
30
|
[This screencast](https://www.youtube.com/watch?v=PhoFZ0qXAlA) should give you
|
|
25
|
-
an idea of what's on offer and
|
|
26
|
-
|
|
31
|
+
an idea of what's on offer and the official guide goes into a bit more depth on
|
|
32
|
+
how everything works.
|
|
33
|
+
|
|
34
|
+
[](https://app.netlify.com/sites/govuk-form-builder/deploys)
|
|
27
35
|
|
|
28
|
-
## What's included
|
|
36
|
+
## What's included 🧳
|
|
29
37
|
|
|
30
38
|
* 100% compatibility with the GOV.UK Design System
|
|
31
39
|
* Full control of labels, hints, fieldsets and legends
|
|
@@ -36,10 +44,9 @@ into a bit more depth on how everything works 😅
|
|
|
36
44
|
button collections
|
|
37
45
|
* No external dependencies
|
|
38
46
|
* An exhaustive test suite
|
|
39
|
-
* [Extensive documentation](https://www.rubydoc.info/gems/govuk_design_system_formbuilder/GOVUKDesignSystemFormBuilder/Builder)
|
|
40
|
-
* [A full guide](https://govuk-form-builder.netlify.com/)
|
|
47
|
+
* [Extensive technical documentation](https://www.rubydoc.info/gems/govuk_design_system_formbuilder/GOVUKDesignSystemFormBuilder/Builder)
|
|
41
48
|
|
|
42
|
-
## Installation
|
|
49
|
+
## Installation 🏗
|
|
43
50
|
|
|
44
51
|
You can install the form builder gem by running the `gem install
|
|
45
52
|
govuk_design_system_formbuilder` or by adding the following line
|
|
@@ -59,7 +66,7 @@ pre-configured template:
|
|
|
59
66
|
* [DfE Boilerplate](https://github.com/DFE-Digital/govuk-rails-boilerplate)
|
|
60
67
|
* [MoJ Rails Template](https://github.com/ministryofjustice/moj_rails_template)
|
|
61
68
|
|
|
62
|
-
## Setup
|
|
69
|
+
## Setup 🔧
|
|
63
70
|
|
|
64
71
|
To use the form builder in an ad hoc basis you can specify it
|
|
65
72
|
as an argument to `form_for` or `form_with`:
|
|
@@ -77,7 +84,7 @@ class ApplicationController < ActionController::Base
|
|
|
77
84
|
end
|
|
78
85
|
```
|
|
79
86
|
|
|
80
|
-
Now we can get started!
|
|
87
|
+
Now we can get started!
|
|
81
88
|
|
|
82
89
|
```slim
|
|
83
90
|
= form_for @person do |f|
|
|
@@ -97,7 +104,7 @@ Now we can get started! 🎉
|
|
|
97
104
|
= f.govuk_submit 'Away we go!'
|
|
98
105
|
```
|
|
99
106
|
|
|
100
|
-
## Developing and running the tests
|
|
107
|
+
## Developing and running the tests 👨🏻🏭
|
|
101
108
|
|
|
102
109
|
The form builder is covered by RSpec, to run all the tests first ensure that
|
|
103
110
|
all of the development and testing prerequisite gems are installed. At the root
|
|
@@ -113,7 +120,7 @@ Now, if everything was successful, run RSpec:
|
|
|
113
120
|
bundle exec rspec -fd
|
|
114
121
|
```
|
|
115
122
|
|
|
116
|
-
## Contributing
|
|
123
|
+
## Contributing 📦
|
|
117
124
|
|
|
118
125
|
Bug reports and feature requests are most welcome, please raise an issue or
|
|
119
126
|
submit a pull request.
|
|
@@ -122,7 +129,7 @@ Currently we're using [GOVUK Lint](https://github.com/alphagov/govuk-lint) to
|
|
|
122
129
|
ensure code meets the GOV.UK guidelines. Please ensure that any PRs also adhere
|
|
123
130
|
to this standard.
|
|
124
131
|
|
|
125
|
-
## Thanks
|
|
132
|
+
## Thanks 👩🏽⚖️
|
|
126
133
|
|
|
127
|
-
This project was inspired by [
|
|
134
|
+
This project was inspired by [Ministry of Justice's GovukElementsFormBuilder](https://github.com/ministryofjustice/govuk_elements_form_builder),
|
|
128
135
|
but is leaner, more modular and written in a more idiomatic style.
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: govuk_design_system_formbuilder
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 1.0.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Peter Yates
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2019-11-
|
|
11
|
+
date: 2019-11-19 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: actionview
|
|
@@ -58,14 +58,14 @@ dependencies:
|
|
|
58
58
|
requirements:
|
|
59
59
|
- - "~>"
|
|
60
60
|
- !ruby/object:Gem::Version
|
|
61
|
-
version: '
|
|
61
|
+
version: '4'
|
|
62
62
|
type: :development
|
|
63
63
|
prerelease: false
|
|
64
64
|
version_requirements: !ruby/object:Gem::Requirement
|
|
65
65
|
requirements:
|
|
66
66
|
- - "~>"
|
|
67
67
|
- !ruby/object:Gem::Version
|
|
68
|
-
version: '
|
|
68
|
+
version: '4'
|
|
69
69
|
- !ruby/object:Gem::Dependency
|
|
70
70
|
name: pry
|
|
71
71
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -143,103 +143,103 @@ dependencies:
|
|
|
143
143
|
- !ruby/object:Gem::Version
|
|
144
144
|
version: '0'
|
|
145
145
|
- !ruby/object:Gem::Dependency
|
|
146
|
-
name:
|
|
146
|
+
name: adsf
|
|
147
147
|
requirement: !ruby/object:Gem::Requirement
|
|
148
148
|
requirements:
|
|
149
149
|
- - "~>"
|
|
150
150
|
- !ruby/object:Gem::Version
|
|
151
|
-
version:
|
|
151
|
+
version: 1.4.2
|
|
152
152
|
type: :development
|
|
153
153
|
prerelease: false
|
|
154
154
|
version_requirements: !ruby/object:Gem::Requirement
|
|
155
155
|
requirements:
|
|
156
156
|
- - "~>"
|
|
157
157
|
- !ruby/object:Gem::Version
|
|
158
|
-
version:
|
|
158
|
+
version: 1.4.2
|
|
159
159
|
- !ruby/object:Gem::Dependency
|
|
160
|
-
name:
|
|
160
|
+
name: adsf-live
|
|
161
161
|
requirement: !ruby/object:Gem::Requirement
|
|
162
162
|
requirements:
|
|
163
163
|
- - "~>"
|
|
164
164
|
- !ruby/object:Gem::Version
|
|
165
|
-
version: 4.
|
|
165
|
+
version: 1.4.2
|
|
166
166
|
type: :development
|
|
167
167
|
prerelease: false
|
|
168
168
|
version_requirements: !ruby/object:Gem::Requirement
|
|
169
169
|
requirements:
|
|
170
170
|
- - "~>"
|
|
171
171
|
- !ruby/object:Gem::Version
|
|
172
|
-
version: 4.
|
|
172
|
+
version: 1.4.2
|
|
173
173
|
- !ruby/object:Gem::Dependency
|
|
174
|
-
name:
|
|
174
|
+
name: htmlbeautifier
|
|
175
175
|
requirement: !ruby/object:Gem::Requirement
|
|
176
176
|
requirements:
|
|
177
177
|
- - "~>"
|
|
178
178
|
- !ruby/object:Gem::Version
|
|
179
|
-
version: 1.
|
|
179
|
+
version: 1.3.1
|
|
180
180
|
type: :development
|
|
181
181
|
prerelease: false
|
|
182
182
|
version_requirements: !ruby/object:Gem::Requirement
|
|
183
183
|
requirements:
|
|
184
184
|
- - "~>"
|
|
185
185
|
- !ruby/object:Gem::Version
|
|
186
|
-
version: 1.
|
|
186
|
+
version: 1.3.1
|
|
187
187
|
- !ruby/object:Gem::Dependency
|
|
188
|
-
name:
|
|
188
|
+
name: nanoc
|
|
189
189
|
requirement: !ruby/object:Gem::Requirement
|
|
190
190
|
requirements:
|
|
191
191
|
- - "~>"
|
|
192
192
|
- !ruby/object:Gem::Version
|
|
193
|
-
version:
|
|
193
|
+
version: '4.11'
|
|
194
194
|
type: :development
|
|
195
195
|
prerelease: false
|
|
196
196
|
version_requirements: !ruby/object:Gem::Requirement
|
|
197
197
|
requirements:
|
|
198
198
|
- - "~>"
|
|
199
199
|
- !ruby/object:Gem::Version
|
|
200
|
-
version:
|
|
200
|
+
version: '4.11'
|
|
201
201
|
- !ruby/object:Gem::Dependency
|
|
202
202
|
name: rouge
|
|
203
203
|
requirement: !ruby/object:Gem::Requirement
|
|
204
204
|
requirements:
|
|
205
205
|
- - "~>"
|
|
206
206
|
- !ruby/object:Gem::Version
|
|
207
|
-
version: 3.
|
|
207
|
+
version: 3.12.0
|
|
208
208
|
type: :development
|
|
209
209
|
prerelease: false
|
|
210
210
|
version_requirements: !ruby/object:Gem::Requirement
|
|
211
211
|
requirements:
|
|
212
212
|
- - "~>"
|
|
213
213
|
- !ruby/object:Gem::Version
|
|
214
|
-
version: 3.
|
|
214
|
+
version: 3.12.0
|
|
215
215
|
- !ruby/object:Gem::Dependency
|
|
216
|
-
name:
|
|
216
|
+
name: sassc
|
|
217
217
|
requirement: !ruby/object:Gem::Requirement
|
|
218
218
|
requirements:
|
|
219
219
|
- - "~>"
|
|
220
220
|
- !ruby/object:Gem::Version
|
|
221
|
-
version:
|
|
221
|
+
version: 2.2.1
|
|
222
222
|
type: :development
|
|
223
223
|
prerelease: false
|
|
224
224
|
version_requirements: !ruby/object:Gem::Requirement
|
|
225
225
|
requirements:
|
|
226
226
|
- - "~>"
|
|
227
227
|
- !ruby/object:Gem::Version
|
|
228
|
-
version:
|
|
228
|
+
version: 2.2.1
|
|
229
229
|
- !ruby/object:Gem::Dependency
|
|
230
|
-
name:
|
|
230
|
+
name: slim
|
|
231
231
|
requirement: !ruby/object:Gem::Requirement
|
|
232
232
|
requirements:
|
|
233
233
|
- - "~>"
|
|
234
234
|
- !ruby/object:Gem::Version
|
|
235
|
-
version:
|
|
235
|
+
version: 4.0.1
|
|
236
236
|
type: :development
|
|
237
237
|
prerelease: false
|
|
238
238
|
version_requirements: !ruby/object:Gem::Requirement
|
|
239
239
|
requirements:
|
|
240
240
|
- - "~>"
|
|
241
241
|
- !ruby/object:Gem::Version
|
|
242
|
-
version:
|
|
242
|
+
version: 4.0.1
|
|
243
243
|
description: A Rails form builder that generates form inputs adhering to the GOV.UK
|
|
244
244
|
Design System
|
|
245
245
|
email:
|