formtastic 3.1.1 → 4.0.0.rc1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitattributes +1 -0
- data/.gitignore +3 -2
- data/.travis.yml +29 -24
- data/CHANGELOG.md +49 -0
- data/DEPRECATIONS +4 -1
- data/Gemfile.lock +104 -0
- data/{README.textile → README.md} +178 -166
- data/Rakefile +20 -1
- data/app/assets/stylesheets/formtastic.css +1 -1
- data/bin/appraisal +8 -0
- data/formtastic.gemspec +9 -15
- data/gemfiles/rails_5.2/Gemfile +5 -0
- data/gemfiles/rails_6.0/Gemfile +5 -0
- data/gemfiles/rails_edge/Gemfile +13 -0
- data/lib/formtastic.rb +9 -11
- data/lib/formtastic/actions.rb +6 -3
- data/lib/formtastic/deprecation.rb +1 -38
- data/lib/formtastic/engine.rb +3 -1
- data/lib/formtastic/form_builder.rb +11 -24
- data/lib/formtastic/helpers.rb +1 -1
- data/lib/formtastic/helpers/action_helper.rb +1 -48
- data/lib/formtastic/helpers/enum.rb +13 -0
- data/lib/formtastic/helpers/errors_helper.rb +2 -2
- data/lib/formtastic/helpers/fieldset_wrapper.rb +13 -9
- data/lib/formtastic/helpers/form_helper.rb +1 -1
- data/lib/formtastic/helpers/input_helper.rb +23 -77
- data/lib/formtastic/helpers/inputs_helper.rb +27 -22
- data/lib/formtastic/i18n.rb +1 -1
- data/lib/formtastic/inputs.rb +32 -29
- data/lib/formtastic/inputs/base/choices.rb +1 -1
- data/lib/formtastic/inputs/base/collections.rb +43 -10
- data/lib/formtastic/inputs/base/database.rb +7 -2
- data/lib/formtastic/inputs/base/errors.rb +4 -4
- data/lib/formtastic/inputs/base/hints.rb +1 -1
- data/lib/formtastic/inputs/base/html.rb +7 -6
- data/lib/formtastic/inputs/base/naming.rb +4 -4
- data/lib/formtastic/inputs/base/options.rb +2 -3
- data/lib/formtastic/inputs/base/timeish.rb +5 -1
- data/lib/formtastic/inputs/base/validations.rb +38 -12
- data/lib/formtastic/inputs/check_boxes_input.rb +13 -5
- data/lib/formtastic/inputs/color_input.rb +0 -1
- data/lib/formtastic/inputs/country_input.rb +3 -1
- data/lib/formtastic/inputs/radio_input.rb +20 -0
- data/lib/formtastic/inputs/select_input.rb +29 -1
- data/lib/formtastic/inputs/time_zone_input.rb +16 -6
- data/lib/formtastic/localizer.rb +20 -22
- data/lib/formtastic/namespaced_class_finder.rb +1 -1
- data/lib/formtastic/version.rb +1 -1
- data/lib/generators/formtastic/form/form_generator.rb +1 -1
- data/lib/generators/formtastic/input/input_generator.rb +46 -0
- data/lib/generators/templates/formtastic.rb +14 -13
- data/lib/generators/templates/input.rb +19 -0
- data/script/integration-template.rb +71 -0
- data/script/integration.sh +19 -0
- data/spec/action_class_finder_spec.rb +1 -1
- data/spec/actions/button_action_spec.rb +8 -8
- data/spec/actions/generic_action_spec.rb +60 -60
- data/spec/actions/input_action_spec.rb +7 -7
- data/spec/actions/link_action_spec.rb +10 -10
- data/spec/builder/custom_builder_spec.rb +36 -20
- data/spec/builder/error_proc_spec.rb +4 -4
- data/spec/builder/semantic_fields_for_spec.rb +27 -27
- data/spec/fast_spec_helper.rb +12 -0
- data/spec/generators/formtastic/form/form_generator_spec.rb +25 -25
- data/spec/generators/formtastic/input/input_generator_spec.rb +124 -0
- data/spec/generators/formtastic/install/install_generator_spec.rb +9 -9
- data/spec/helpers/action_helper_spec.rb +328 -10
- data/spec/helpers/actions_helper_spec.rb +17 -17
- data/spec/helpers/form_helper_spec.rb +37 -37
- data/spec/helpers/input_helper_spec.rb +975 -2
- data/spec/helpers/inputs_helper_spec.rb +120 -105
- data/spec/helpers/reflection_helper_spec.rb +3 -3
- data/spec/helpers/semantic_errors_helper_spec.rb +22 -22
- data/spec/i18n_spec.rb +26 -26
- data/spec/input_class_finder_spec.rb +1 -1
- data/spec/inputs/base/collections_spec.rb +76 -0
- data/spec/inputs/base/validations_spec.rb +480 -0
- data/spec/inputs/boolean_input_spec.rb +55 -55
- data/spec/inputs/check_boxes_input_spec.rb +155 -108
- data/spec/inputs/color_input_spec.rb +51 -63
- data/spec/inputs/country_input_spec.rb +20 -20
- data/spec/inputs/custom_input_spec.rb +2 -6
- data/spec/inputs/datalist_input_spec.rb +1 -1
- data/spec/inputs/date_picker_input_spec.rb +42 -42
- data/spec/inputs/date_select_input_spec.rb +51 -37
- data/spec/inputs/datetime_picker_input_spec.rb +46 -46
- data/spec/inputs/datetime_select_input_spec.rb +53 -37
- data/spec/inputs/email_input_spec.rb +5 -5
- data/spec/inputs/file_input_spec.rb +6 -6
- data/spec/inputs/hidden_input_spec.rb +18 -18
- data/spec/inputs/include_blank_spec.rb +8 -8
- data/spec/inputs/label_spec.rb +20 -20
- data/spec/inputs/number_input_spec.rb +112 -112
- data/spec/inputs/password_input_spec.rb +5 -5
- data/spec/inputs/phone_input_spec.rb +5 -5
- data/spec/inputs/placeholder_spec.rb +5 -5
- data/spec/inputs/radio_input_spec.rb +84 -58
- data/spec/inputs/range_input_spec.rb +66 -66
- data/spec/inputs/readonly_spec.rb +50 -0
- data/spec/inputs/search_input_spec.rb +5 -5
- data/spec/inputs/select_input_spec.rb +149 -93
- data/spec/inputs/string_input_spec.rb +23 -23
- data/spec/inputs/text_input_spec.rb +16 -16
- data/spec/inputs/time_picker_input_spec.rb +43 -43
- data/spec/inputs/time_select_input_spec.rb +67 -54
- data/spec/inputs/time_zone_input_spec.rb +54 -28
- data/spec/inputs/url_input_spec.rb +5 -5
- data/spec/inputs/with_options_spec.rb +7 -7
- data/spec/localizer_spec.rb +17 -17
- data/spec/namespaced_class_finder_spec.rb +2 -2
- data/spec/schema.rb +21 -0
- data/spec/spec_helper.rb +165 -253
- data/spec/support/custom_macros.rb +72 -75
- data/spec/support/shared_examples.rb +0 -1232
- data/spec/support/test_environment.rb +23 -9
- metadata +67 -174
- data/Appraisals +0 -29
- data/CHANGELOG +0 -31
- data/gemfiles/rails_3.2.gemfile +0 -7
- data/gemfiles/rails_4.0.4.gemfile +0 -7
- data/gemfiles/rails_4.1.gemfile +0 -7
- data/gemfiles/rails_4.2.gemfile +0 -7
- data/gemfiles/rails_4.gemfile +0 -7
- data/gemfiles/rails_edge.gemfile +0 -10
- data/lib/formtastic/util.rb +0 -53
- data/spec/helpers/namespaced_action_helper_spec.rb +0 -43
- data/spec/helpers/namespaced_input_helper_spec.rb +0 -36
- data/spec/support/deferred_garbage_collection.rb +0 -21
- data/spec/util_spec.rb +0 -66
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 8d4e6d380c2d708ed43fd63f5558416c1ef53aa6a208ba9b74ce613419683501
|
4
|
+
data.tar.gz: caf570aee5672261b10094658ab5dcfd56f944f456b288eedebeb1a58d53caf1
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: e575fe3d770692adfcac597cf9719ab459c157dd09738090eeb9ca5c23abc49ecce78df9a51a3781b55fb5b0f4e50f3f3273af70a8674346a7e059f1485523b8
|
7
|
+
data.tar.gz: 2363a8a9a9ce3b1a981df647d511db68e4fd71073e2a3b4aaa6f0023ae59ae4d402e05a2fc9454d228ca6fd659c3d6e3eceb0e9fbc3df9fb25026006956bef87
|
data/.gitattributes
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
CHANGELOG merge=union
|
data/.gitignore
CHANGED
data/.travis.yml
CHANGED
@@ -1,29 +1,34 @@
|
|
1
|
+
cache:
|
2
|
+
- bundler
|
3
|
+
- directories:
|
4
|
+
- gemfiles/rails_52/vendor/bundle
|
5
|
+
- gemfiles/rails_60/vendor/bundle
|
6
|
+
- gemfiles/rails_edge/vendor/bundle
|
7
|
+
dist: bionic
|
1
8
|
language: ruby
|
2
|
-
|
3
|
-
- gem update --system
|
4
|
-
- gem update bundler
|
9
|
+
node_js: 11
|
5
10
|
rvm:
|
6
|
-
-
|
7
|
-
- 2.
|
8
|
-
- 2.
|
11
|
+
- 2.4.9
|
12
|
+
- 2.5.7
|
13
|
+
- 2.6.5
|
14
|
+
- 2.7.0
|
9
15
|
gemfile:
|
10
|
-
- gemfiles/
|
11
|
-
- gemfiles/
|
12
|
-
- gemfiles/
|
13
|
-
|
14
|
-
-
|
15
|
-
-
|
16
|
-
|
17
|
-
-
|
18
|
-
script:
|
16
|
+
- gemfiles/rails_5.2/Gemfile
|
17
|
+
- gemfiles/rails_6.0/Gemfile
|
18
|
+
- gemfiles/rails_edge/Gemfile
|
19
|
+
before_install:
|
20
|
+
- gem install bundler
|
21
|
+
- export BUNDLE_PATH=$(dirname $(readlink -f $BUNDLE_GEMFILE))/vendor/bundle
|
22
|
+
before_cache:
|
23
|
+
- rm -f ${BUNDLE_PATH}/**/extensions/**/{gem_make.out,mkmf.log}
|
24
|
+
script:
|
25
|
+
- bundle exec rake spec
|
26
|
+
- script/integration.sh
|
19
27
|
matrix:
|
28
|
+
exclude:
|
29
|
+
- rvm: 2.4.9
|
30
|
+
gemfile: gemfiles/rails_6.0/Gemfile
|
31
|
+
- rvm: 2.4.9
|
32
|
+
gemfile: gemfiles/rails_edge/Gemfile
|
20
33
|
allow_failures:
|
21
|
-
-
|
22
|
-
gemfile: gemfiles/rails_edge.gemfile
|
23
|
-
env: DEFER_GC=false RAILS_EDGE=true
|
24
|
-
- rvm: 2.0.0
|
25
|
-
gemfile: gemfiles/rails_edge.gemfile
|
26
|
-
env: DEFER_GC=false RAILS_EDGE=true
|
27
|
-
- rvm: 2.1
|
28
|
-
gemfile: gemfiles/rails_edge.gemfile
|
29
|
-
env: DEFER_GC=false RAILS_EDGE=true
|
34
|
+
- gemfile: gemfiles/rails_edge/Gemfile
|
data/CHANGELOG.md
ADDED
@@ -0,0 +1,49 @@
|
|
1
|
+
## master
|
2
|
+
* Fixed default_columns_for_object when object has non-standard foreign keys (#1241)
|
3
|
+
* Fixed missing constants in production (#911)
|
4
|
+
* Removed support for Rails 3 and 4.0 (#1108)
|
5
|
+
* Removed deprecated input/action finder methods (#1139)
|
6
|
+
* Changed boolean label padding to margin (#1202)
|
7
|
+
* Added mapping hstore column to text input (#1203)
|
8
|
+
* Added support for Rails 5 Attributes API (#1188)
|
9
|
+
* Changed required Ruby version to >= 2.0 (#1210)
|
10
|
+
* Default to input types text for json & jsonb, string for citext columns (#1229)
|
11
|
+
* Allow symbols for numericality options (#1258)
|
12
|
+
* Support for rubies under 2.4.0 has been dropped (#1292)
|
13
|
+
* Support for Rails under 5.2.0 has been dropped (#1293)
|
14
|
+
|
15
|
+
## 3.1.2
|
16
|
+
|
17
|
+
* Fixed that we specified 4.0.4 instead of 4.1 in the Rails version deprecation message
|
18
|
+
|
19
|
+
## 3.1.1
|
20
|
+
|
21
|
+
* Fixed class custom input & action class loading in test environments
|
22
|
+
* Added documentation of custom input & action class finders
|
23
|
+
* Added a link to documentation & wiki from custom class deprecation warnings
|
24
|
+
|
25
|
+
## 3.1.0
|
26
|
+
|
27
|
+
* Performance and documentation improvements
|
28
|
+
|
29
|
+
## 3.1.0.rc2
|
30
|
+
|
31
|
+
* Deprecated :member_value and :member_label options
|
32
|
+
|
33
|
+
## 3.1.0.rc1
|
34
|
+
|
35
|
+
* Deprecated support for Rails version < 4.1.0
|
36
|
+
* Fixed synchronization issues with custom_namespace configuration
|
37
|
+
* Fixed bug where boolean (checkbox) inputs were not being correctly checked (also in 2.3.1)
|
38
|
+
* Fixed (silenced) Rails 5 deprecation on column_for_attribute that we're handling fine
|
39
|
+
* Added new DatalistInput (:as => :datalist) for HTML5 datalists
|
40
|
+
* Added configurable namespaces for custom inputs
|
41
|
+
* Various performance and documentation improvements
|
42
|
+
|
43
|
+
---
|
44
|
+
|
45
|
+
See 3.0-stable branch for 3.0.x changes
|
46
|
+
https://github.com/justinfrench/formtastic/blob/3.0-stable/CHANGELOG
|
47
|
+
|
48
|
+
See 2.3-stable branch for 2.3.x and earlier releases
|
49
|
+
https://github.com/justinfrench/formtastic/blob/2.3-stable/CHANGELOG
|
data/DEPRECATIONS
CHANGED
@@ -3,14 +3,17 @@ Formtastic features and compatibilities.
|
|
3
3
|
|
4
4
|
v4.0 (planned)
|
5
5
|
|
6
|
-
* Remove support for Rails <
|
6
|
+
* Remove support for Rails < 5.2
|
7
7
|
* Remove support for country_select 1.x syntax (they want to remove it in 3.0)
|
8
|
+
* Remove support for input_class, custom_input_class_name, standard_input_class_name, action_class, custom_action_class_name, standard_action_class_name
|
8
9
|
|
9
10
|
v3.1 (master)
|
10
11
|
|
11
12
|
* Deprecate support for Rails < 4.1
|
12
13
|
* Deprecate :member_value option
|
13
14
|
* Deprecate :member_label option
|
15
|
+
* Deprecate internal custom input class finder methods (input_class, custom_input_class_name, standard_input_class_name)
|
16
|
+
* Deprecate internal custom action class finder methods (action_class, custom_action_class_name, standard_action_class_name)
|
14
17
|
|
15
18
|
v3.0
|
16
19
|
|
data/Gemfile.lock
ADDED
@@ -0,0 +1,104 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
formtastic (3.2.0.pre)
|
5
|
+
actionpack (>= 5.2.0)
|
6
|
+
|
7
|
+
GEM
|
8
|
+
remote: https://rubygems.org/
|
9
|
+
specs:
|
10
|
+
actionpack (6.0.3.2)
|
11
|
+
actionview (= 6.0.3.2)
|
12
|
+
activesupport (= 6.0.3.2)
|
13
|
+
rack (~> 2.0, >= 2.0.8)
|
14
|
+
rack-test (>= 0.6.3)
|
15
|
+
rails-dom-testing (~> 2.0)
|
16
|
+
rails-html-sanitizer (~> 1.0, >= 1.2.0)
|
17
|
+
actionview (6.0.3.2)
|
18
|
+
activesupport (= 6.0.3.2)
|
19
|
+
builder (~> 3.1)
|
20
|
+
erubi (~> 1.4)
|
21
|
+
rails-dom-testing (~> 2.0)
|
22
|
+
rails-html-sanitizer (~> 1.1, >= 1.2.0)
|
23
|
+
activesupport (6.0.3.2)
|
24
|
+
concurrent-ruby (~> 1.0, >= 1.0.2)
|
25
|
+
i18n (>= 0.7, < 2)
|
26
|
+
minitest (~> 5.1)
|
27
|
+
tzinfo (~> 1.1)
|
28
|
+
zeitwerk (~> 2.2, >= 2.2.2)
|
29
|
+
ammeter (1.1.4)
|
30
|
+
activesupport (>= 3.0)
|
31
|
+
railties (>= 3.0)
|
32
|
+
rspec-rails (>= 2.2)
|
33
|
+
builder (3.2.4)
|
34
|
+
concurrent-ruby (1.1.6)
|
35
|
+
crass (1.0.6)
|
36
|
+
diff-lcs (1.3)
|
37
|
+
erubi (1.9.0)
|
38
|
+
i18n (1.8.3)
|
39
|
+
concurrent-ruby (~> 1.0)
|
40
|
+
loofah (2.6.0)
|
41
|
+
crass (~> 1.0.2)
|
42
|
+
nokogiri (>= 1.5.9)
|
43
|
+
method_source (1.0.0)
|
44
|
+
mini_portile2 (2.4.0)
|
45
|
+
minitest (5.14.1)
|
46
|
+
nokogiri (1.10.9)
|
47
|
+
mini_portile2 (~> 2.4.0)
|
48
|
+
rack (2.2.3)
|
49
|
+
rack-test (1.1.0)
|
50
|
+
rack (>= 1.0, < 3)
|
51
|
+
rails-dom-testing (2.0.3)
|
52
|
+
activesupport (>= 4.2.0)
|
53
|
+
nokogiri (>= 1.6)
|
54
|
+
rails-html-sanitizer (1.3.0)
|
55
|
+
loofah (~> 2.3)
|
56
|
+
railties (6.0.3.2)
|
57
|
+
actionpack (= 6.0.3.2)
|
58
|
+
activesupport (= 6.0.3.2)
|
59
|
+
method_source
|
60
|
+
rake (>= 0.8.7)
|
61
|
+
thor (>= 0.20.3, < 2.0)
|
62
|
+
rake (13.0.1)
|
63
|
+
rspec-core (3.9.2)
|
64
|
+
rspec-support (~> 3.9.3)
|
65
|
+
rspec-dom-testing (0.1.0)
|
66
|
+
rails-dom-testing (>= 1.0, < 3)
|
67
|
+
rspec-expectations (~> 3.0)
|
68
|
+
rspec-expectations (3.9.2)
|
69
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
70
|
+
rspec-support (~> 3.9.0)
|
71
|
+
rspec-mocks (3.9.1)
|
72
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
73
|
+
rspec-support (~> 3.9.0)
|
74
|
+
rspec-rails (3.9.1)
|
75
|
+
actionpack (>= 3.0)
|
76
|
+
activesupport (>= 3.0)
|
77
|
+
railties (>= 3.0)
|
78
|
+
rspec-core (~> 3.9.0)
|
79
|
+
rspec-expectations (~> 3.9.0)
|
80
|
+
rspec-mocks (~> 3.9.0)
|
81
|
+
rspec-support (~> 3.9.0)
|
82
|
+
rspec-support (3.9.3)
|
83
|
+
sqlite3 (1.4.2)
|
84
|
+
thor (1.0.1)
|
85
|
+
thread_safe (0.3.6)
|
86
|
+
tzinfo (1.2.7)
|
87
|
+
thread_safe (~> 0.1)
|
88
|
+
yard (0.9.25)
|
89
|
+
zeitwerk (2.3.0)
|
90
|
+
|
91
|
+
PLATFORMS
|
92
|
+
ruby
|
93
|
+
|
94
|
+
DEPENDENCIES
|
95
|
+
ammeter (~> 1.1.3)
|
96
|
+
formtastic!
|
97
|
+
rake
|
98
|
+
rspec-dom-testing (>= 0.1.0)
|
99
|
+
rspec-rails (~> 3.4)
|
100
|
+
sqlite3 (~> 1.4)
|
101
|
+
yard (~> 0.9.20)
|
102
|
+
|
103
|
+
BUNDLED WITH
|
104
|
+
2.1.4
|
@@ -1,36 +1,32 @@
|
|
1
|
-
|
1
|
+
# Formtastic
|
2
2
|
|
3
|
-
!https://travis-ci.org/justinfrench/formtastic.
|
4
|
-
!
|
5
|
-
!https://codeclimate.com/github/justinfrench/formtastic.
|
6
|
-
!https://badge.fury.io/rb/formtastic.
|
7
|
-
!https://gemnasium.com/justinfrench/formtastic.png!:https://gemnasium.com/justinfrench/formtastic
|
3
|
+
[![Build Status](https://travis-ci.org/justinfrench/formtastic.svg?branch=master)](https://travis-ci.org/justinfrench/formtastic)
|
4
|
+
[![Inline docs](https://inch-ci.org/github/justinfrench/formtastic.svg?branch=master)](https://inch-ci.org/github/justinfrench/formtastic)
|
5
|
+
[![Code Climate](https://codeclimate.com/github/justinfrench/formtastic/badges/gpa.svg)](https://codeclimate.com/github/justinfrench/formtastic)
|
6
|
+
[![Gem Version](https://badge.fury.io/rb/formtastic.svg)](https://badge.fury.io/rb/formtastic)
|
8
7
|
|
9
8
|
Formtastic is a Rails FormBuilder DSL (with some other goodies) to make it far easier to create beautiful, semantically rich, syntactically awesome, readily stylable and wonderfully accessible HTML forms in your Rails applications.
|
10
9
|
|
10
|
+
## Documentation & Support
|
11
11
|
|
12
|
-
|
12
|
+
* [Documentation is available on rdoc.info](https://rdoc.info/projects/justinfrench/formtastic)
|
13
|
+
* [We track issues & bugs on GitHub](https://github.com/justinfrench/formtastic/issues)
|
14
|
+
* [We have a wiki on GitHub](https://github.com/justinfrench/formtastic/wiki)
|
15
|
+
* [StackOverflow can help](https://stackoverflow.com/questions/tagged/formtastic)
|
16
|
+
* [Follow @formtastic on Twitter for news & updates](https://twitter.com/formtastic)
|
13
17
|
|
14
|
-
|
15
|
-
* "We track issues & bugs on GitHub":http://github.com/justinfrench/formtastic/issues
|
16
|
-
* "We have a wiki on GitHub":http://github.com/justinfrench/formtastic/wiki
|
17
|
-
* "StackOverflow can help":http://stackoverflow.com/questions/tagged/formtastic
|
18
|
-
* "Follow @formtastic on Twitter for news & updates":http://twitter.com/formtastic
|
18
|
+
## Compatibility
|
19
19
|
|
20
|
-
|
21
|
-
h2. Compatibility
|
22
|
-
|
23
|
-
* Formtastic 4 will require Rails 4.1
|
20
|
+
* Formtastic 4 will require Rails 5.2 and Ruby 2.4 minimum
|
24
21
|
* Formtastic 3 requires Rails 3.2.13 minimum
|
25
22
|
* Formtastic 2 requires Rails 3
|
26
23
|
* Formtastic, much like Rails, is very ActiveRecord-centric. Many are successfully using other ActiveModel-like ORMs and objects (DataMapper, MongoMapper, Mongoid, Authlogic, Devise...) but we're not guaranteeing full compatibility at this stage. Patches are welcome!
|
27
24
|
|
28
|
-
|
29
|
-
h2. The Story
|
25
|
+
## The Story
|
30
26
|
|
31
27
|
One day, I finally had enough, so I opened up my text editor, and wrote a DSL for how I'd like to author forms:
|
32
28
|
|
33
|
-
|
29
|
+
```erb
|
34
30
|
<%= semantic_form_for @article do |f| %>
|
35
31
|
|
36
32
|
<%= f.inputs :name => "Basic" do %>
|
@@ -60,15 +56,15 @@ One day, I finally had enough, so I opened up my text editor, and wrote a DSL fo
|
|
60
56
|
<% end %>
|
61
57
|
|
62
58
|
<% end %>
|
63
|
-
|
59
|
+
```
|
64
60
|
|
65
|
-
I also wrote the accompanying HTML output I expected, favoring something very similar to the fieldsets, lists and other semantic elements Aaron Gustafson presented in
|
61
|
+
I also wrote the accompanying HTML output I expected, favoring something very similar to the fieldsets, lists and other semantic elements Aaron Gustafson presented in [Learning to Love Forms](https://www.slideshare.net/AaronGustafson/learning-to-love-forms-webvisions-07), hacking together enough Ruby to prove it could be done.
|
66
62
|
|
67
63
|
|
68
|
-
|
64
|
+
## It's awesome because...
|
69
65
|
|
70
|
-
* It can handle
|
71
|
-
* It can handle
|
66
|
+
* It can handle `belongs_to` associations (like Post belongs_to :author), rendering a select or set of radio inputs with choices from the parent model.
|
67
|
+
* It can handle `has_many` and `has_and_belongs_to_many` associations (like: Post has_many :tags), rendering a multi-select with choices from the child models.
|
72
68
|
* It's Rails 3/4 compatible (including nested forms).
|
73
69
|
* It has internationalization (I18n)!
|
74
70
|
* It's _really_ quick to get started with a basic form in place (4 lines), then go back to add in more detail if you need it.
|
@@ -80,7 +76,7 @@ h2. It's awesome because...
|
|
80
76
|
* It has growing HTML5 support (new inputs like email/phone/search, new attributes like required/min/max/step/placeholder)
|
81
77
|
|
82
78
|
|
83
|
-
|
79
|
+
## Opinions
|
84
80
|
|
85
81
|
* It should be easier to do things the right way than the wrong way.
|
86
82
|
* Sometimes _more mark-up_ is better.
|
@@ -88,82 +84,82 @@ h2. Opinions
|
|
88
84
|
* Make the common things we do easy, yet ensure uncommon things are still possible.
|
89
85
|
|
90
86
|
|
91
|
-
|
87
|
+
## Installation
|
92
88
|
|
93
89
|
Simply add Formtastic to your Gemfile and bundle it up:
|
94
90
|
|
95
|
-
|
91
|
+
```ruby
|
96
92
|
gem 'formtastic', '~> 3.0'
|
97
|
-
|
93
|
+
```
|
98
94
|
|
99
95
|
Run the installation generator:
|
100
96
|
|
101
|
-
|
102
|
-
|
103
|
-
|
97
|
+
```shell
|
98
|
+
$ rails generate formtastic:install
|
99
|
+
```
|
104
100
|
|
105
101
|
|
106
|
-
|
102
|
+
## Stylesheets
|
107
103
|
|
108
104
|
A proof-of-concept set of stylesheets are provided which you can include in your layout. Customization is best achieved by overriding these styles in an additional stylesheet.
|
109
105
|
|
110
106
|
Rails 3.1 introduces an asset pipeline that allows plugins like Formtastic to serve their own Stylesheets, Javascripts, etc without having to run generators that copy them across to the host application. Formtastic makes three stylesheets available as an Engine, you just need to require them in your global stylesheets.
|
111
107
|
|
112
|
-
|
108
|
+
```css
|
113
109
|
# app/assets/stylesheets/application.css
|
114
110
|
*= require formtastic
|
115
111
|
*= require my_formtastic_changes
|
116
|
-
|
112
|
+
```
|
117
113
|
|
118
|
-
Conditional stylesheets need to be compiled separately to prevent them being bundled and included with other application styles. Remove
|
114
|
+
Conditional stylesheets need to be compiled separately to prevent them being bundled and included with other application styles. Remove `require_tree .` from application.css and specify required stylesheets individually.
|
119
115
|
|
120
|
-
|
116
|
+
```css
|
121
117
|
# app/assets/stylesheets/ie6.css
|
122
118
|
*= require formtastic_ie6
|
123
119
|
|
124
120
|
# app/assets/stylesheets/ie7.css
|
125
121
|
*= require formtastic_ie7
|
126
|
-
|
122
|
+
```
|
127
123
|
|
128
|
-
|
124
|
+
```erb
|
129
125
|
# app/views/layouts/application.html.erb
|
130
126
|
<%= stylesheet_link_tag 'application' %>
|
131
127
|
<!--[if IE 6]><%= stylesheet_link_tag 'ie6' %><![endif]-->
|
132
128
|
<!--[if IE 7]><%= stylesheet_link_tag 'ie7' %><![endif]-->
|
133
|
-
|
129
|
+
```
|
134
130
|
|
135
|
-
|
131
|
+
```ruby
|
136
132
|
# config/environments/production.rb
|
137
133
|
config.assets.precompile += %w( ie6.css ie7.css )
|
138
|
-
|
134
|
+
```
|
139
135
|
|
140
|
-
|
136
|
+
## Usage
|
141
137
|
|
142
138
|
Forms are really boring to code... you want to get onto the good stuff as fast as possible.
|
143
139
|
|
144
|
-
This renders a set of inputs (one for _most_ columns in the database table, and one for each ActiveRecord
|
140
|
+
This renders a set of inputs (one for _most_ columns in the database table, and one for each ActiveRecord `belongs_to`-association), followed by default action buttons (an input submit button):
|
145
141
|
|
146
|
-
|
142
|
+
```erb
|
147
143
|
<%= semantic_form_for @user do |f| %>
|
148
144
|
<%= f.inputs %>
|
149
145
|
<%= f.actions %>
|
150
146
|
<% end %>
|
151
|
-
|
147
|
+
```
|
152
148
|
|
153
149
|
This is a great way to get something up fast, but like scaffolding, it's *not recommended for production*. Don't be so lazy!
|
154
150
|
|
155
|
-
To specify the order of the fields, skip some of the fields or even add in fields that Formtastic couldn't infer. You can pass in a list of field names to
|
151
|
+
To specify the order of the fields, skip some of the fields or even add in fields that Formtastic couldn't infer. You can pass in a list of field names to `inputs` and list of action names to `actions`:
|
156
152
|
|
157
|
-
|
153
|
+
```erb
|
158
154
|
<%= semantic_form_for @user do |f| %>
|
159
155
|
<%= f.inputs :title, :body, :section, :categories, :created_at %>
|
160
156
|
<%= f.actions :submit, :cancel %>
|
161
157
|
<% end %>
|
162
|
-
|
158
|
+
```
|
163
159
|
|
164
|
-
You probably want control over the input type Formtastic uses for each field. You can expand the
|
160
|
+
You probably want control over the input type Formtastic uses for each field. You can expand the `inputs` and `actions` to block helper format and use the `:as` option to specify an exact input type:
|
165
161
|
|
166
|
-
|
162
|
+
```erb
|
167
163
|
<%= semantic_form_for @post do |f| %>
|
168
164
|
<%= f.inputs do %>
|
169
165
|
<%= f.input :title %>
|
@@ -177,11 +173,11 @@ You probably want control over the input type Formtastic uses for each field. Yo
|
|
177
173
|
<%= f.action :cancel, :as => :link %>
|
178
174
|
<% end %>
|
179
175
|
<% end %>
|
180
|
-
|
176
|
+
```
|
181
177
|
|
182
178
|
If you want to customize the label text, or render some hint text below the field, specify which fields are required/optional, or break the form into two fieldsets, the DSL is pretty comprehensive:
|
183
179
|
|
184
|
-
|
180
|
+
```erb
|
185
181
|
<%= semantic_form_for @post do |f| %>
|
186
182
|
<%= f.inputs "Basic", :id => "basic" do %>
|
187
183
|
<%= f.input :title %>
|
@@ -198,17 +194,17 @@ If you want to customize the label text, or render some hint text below the fiel
|
|
198
194
|
<%= f.action :submit %>
|
199
195
|
<% end %>
|
200
196
|
<% end %>
|
201
|
-
|
197
|
+
```
|
202
198
|
|
203
199
|
You can create forms for nested resources:
|
204
200
|
|
205
|
-
|
201
|
+
```erb
|
206
202
|
<%= semantic_form_for [@author, @post] do |f| %>
|
207
|
-
|
203
|
+
```
|
208
204
|
|
209
|
-
Nested forms are also supported (don't forget your models need to be setup correctly with
|
205
|
+
Nested forms are also supported (don't forget your models need to be setup correctly with `accepts_nested_attributes_for`). You can do it in the Rails way:
|
210
206
|
|
211
|
-
|
207
|
+
```erb
|
212
208
|
<%= semantic_form_for @post do |f| %>
|
213
209
|
<%= f.inputs :title, :body, :created_at %>
|
214
210
|
<%= f.semantic_fields_for :author do |author| %>
|
@@ -216,41 +212,41 @@ Nested forms are also supported (don't forget your models need to be setup corre
|
|
216
212
|
<% end %>
|
217
213
|
<%= f.actions %>
|
218
214
|
<% end %>
|
219
|
-
|
215
|
+
```
|
220
216
|
|
221
|
-
Or the Formtastic way with the
|
217
|
+
Or the Formtastic way with the `:for` option:
|
222
218
|
|
223
|
-
|
219
|
+
```erb
|
224
220
|
<%= semantic_form_for @post do |f| %>
|
225
221
|
<%= f.inputs :title, :body, :created_at %>
|
226
222
|
<%= f.inputs :first_name, :last_name, :for => :author, :name => "Author" %>
|
227
223
|
<%= f.actions %>
|
228
224
|
<% end %>
|
229
|
-
|
225
|
+
```
|
230
226
|
|
231
|
-
When working in has many association, you can even supply
|
227
|
+
When working in has many association, you can even supply `"%i"` in your fieldset name; they will be properly interpolated with the child index. For example:
|
232
228
|
|
233
|
-
|
229
|
+
```erb
|
234
230
|
<%= semantic_form_for @post do |f| %>
|
235
231
|
<%= f.inputs %>
|
236
232
|
<%= f.inputs :name => 'Category #%i', :for => :categories %>
|
237
233
|
<%= f.actions %>
|
238
234
|
<% end %>
|
239
|
-
|
235
|
+
```
|
240
236
|
|
241
237
|
Alternatively, the current index can be accessed via the `inputs` block's arguments for use anywhere:
|
242
238
|
|
243
|
-
|
239
|
+
```erb
|
244
240
|
<%= semantic_form_for @post do |f| %>
|
245
241
|
<%= f.inputs :for => :categories do |category, i| %>
|
246
242
|
...
|
247
243
|
<%= f.actions %>
|
248
244
|
<% end %>
|
249
|
-
|
245
|
+
```
|
250
246
|
|
251
247
|
If you have more than one form on the same page, it may lead to HTML invalidation because of the way HTML element id attributes are assigned. You can provide a namespace for your form to ensure uniqueness of id attributes on form elements. The namespace attribute will be prefixed with underscore on the generate HTML id. For example:
|
252
248
|
|
253
|
-
|
249
|
+
```erb
|
254
250
|
<%= semantic_form_for(@post, :namespace => 'cat_form') do |f| %>
|
255
251
|
<%= f.inputs do %>
|
256
252
|
<%= f.input :title %> # id="cat_form_post_title"
|
@@ -259,11 +255,11 @@ If you have more than one form on the same page, it may lead to HTML invalidatio
|
|
259
255
|
<% end %>
|
260
256
|
<%= f.actions %>
|
261
257
|
<% end %>
|
262
|
-
|
258
|
+
```
|
263
259
|
|
264
|
-
Customize HTML attributes for any input using the
|
260
|
+
Customize HTML attributes for any input using the `:input_html` option. Typically this is used to disable the input, change the size of a text field, change the rows in a textarea, or even to add a special class to an input to attach special behavior like [autogrow](https://plugins.jquery.com/project/autogrowtextarea) textareas:
|
265
261
|
|
266
|
-
|
262
|
+
```erb
|
267
263
|
<%= semantic_form_for @post do |f| %>
|
268
264
|
<%= f.inputs do %>
|
269
265
|
<%= f.input :title, :input_html => { :size => 10 } %>
|
@@ -273,22 +269,22 @@ Customize HTML attributes for any input using the @:input_html@ option. Typicall
|
|
273
269
|
<% end %>
|
274
270
|
<%= f.actions %>
|
275
271
|
<% end %>
|
276
|
-
|
272
|
+
```
|
277
273
|
|
278
|
-
The same can be done for actions with the
|
274
|
+
The same can be done for actions with the `:button_html` option:
|
279
275
|
|
280
|
-
|
276
|
+
```erb
|
281
277
|
<%= semantic_form_for @post do |f| %>
|
282
278
|
...
|
283
279
|
<%= f.actions do %>
|
284
280
|
<%= f.action :submit, :button_html => { :class => "primary", :disable_with => 'Wait...' } %>
|
285
281
|
<% end %>
|
286
282
|
<% end %>
|
287
|
-
|
283
|
+
```
|
288
284
|
|
289
|
-
Customize the HTML attributes for the
|
285
|
+
Customize the HTML attributes for the `<li>` wrapper around every input with the `:wrapper_html` option hash. There's one special key in the hash: (`:class`), which will actually _append_ your string of classes to the existing classes provided by Formtastic (like `"required string error"`).
|
290
286
|
|
291
|
-
|
287
|
+
```erb
|
292
288
|
<%= semantic_form_for @post do |f| %>
|
293
289
|
<%= f.inputs do %>
|
294
290
|
<%= f.input :title, :wrapper_html => { :class => "important" } %>
|
@@ -297,11 +293,11 @@ Customize the HTML attributes for the @
|
|
297
293
|
<% end %>
|
298
294
|
...
|
299
295
|
<% end %>
|
300
|
-
|
296
|
+
```
|
301
297
|
|
302
|
-
Many inputs provide a collection of options to choose from (like
|
298
|
+
Many inputs provide a collection of options to choose from (like `:select`, `:radio`, `:check_boxes`, `:boolean`). In many cases, Formtastic can find choices through the model associations, but if you want to use your own set of choices, the `:collection` option is what you want. You can pass in an Array of objects, an array of Strings, a Hash... Throw almost anything at it! Examples:
|
303
299
|
|
304
|
-
|
300
|
+
```ruby
|
305
301
|
f.input :authors, :as => :check_boxes, :collection => User.order("last_name ASC").all
|
306
302
|
f.input :authors, :as => :check_boxes, :collection => current_user.company.users.active
|
307
303
|
f.input :authors, :as => :check_boxes, :collection => [@justin, @kate]
|
@@ -319,58 +315,58 @@ Many inputs provide a collection of options to choose from (like @:select@, @:ra
|
|
319
315
|
f.input :admin, :as => :radio, :collection => ["Yes!", "No"]
|
320
316
|
f.input :book_id, :as => :select, :collection => Hash[Book.all.map{|b| [b.name,b.id]}]
|
321
317
|
f.input :fav_book,:as => :datalist , :collection => Book.pluck(:name)
|
322
|
-
|
318
|
+
```
|
323
319
|
|
324
320
|
|
325
|
-
|
321
|
+
## The Available Inputs
|
326
322
|
|
327
323
|
The Formtastic input types:
|
328
324
|
|
329
|
-
*
|
330
|
-
*
|
331
|
-
*
|
332
|
-
*
|
333
|
-
*
|
334
|
-
*
|
335
|
-
*
|
336
|
-
*
|
337
|
-
*
|
338
|
-
*
|
339
|
-
*
|
340
|
-
*
|
341
|
-
*
|
342
|
-
*
|
343
|
-
*
|
344
|
-
*
|
345
|
-
*
|
346
|
-
*
|
347
|
-
*
|
348
|
-
*
|
349
|
-
*
|
325
|
+
* `:select` - a select menu. Default for ActiveRecord associations: `belongs_to`, `has_many`, and `has_and_belongs_to_many`.
|
326
|
+
* `:check_boxes` - a set of check_box inputs. Alternative to `:select` for ActiveRecord-associations: `has_many`, and has_and_belongs_to_many`.
|
327
|
+
* `:radio` - a set of radio inputs. Alternative to `:select` for ActiveRecord-associations: `belongs_to`.
|
328
|
+
* `:time_zone` - a select input. Default for column types: `:string` with name matching `"time_zone"`.
|
329
|
+
* `:password` - a password input. Default for column types: `:string` with name matching `"password"`.
|
330
|
+
* `:text` - a textarea. Default for column types: `:text`.
|
331
|
+
* `:date_select` - a date select. Default for column types: `:date`.
|
332
|
+
* `:datetime_select` - a date and time select. Default for column types: `:datetime` and `:timestamp`.
|
333
|
+
* `:time_select` - a time select. Default for column types: `:time`.
|
334
|
+
* `:boolean` - a checkbox. Default for column types: `:boolean`.
|
335
|
+
* `:string` - a text field. Default for column types: `:string`.
|
336
|
+
* `:number` - a text field (just like string). Default for column types: `:integer`, `:float`, and `:decimal`.
|
337
|
+
* `:file` - a file field. Default for file-attachment attributes matching: [paperclip](https://github.com/thoughtbot/paperclip) or [attachment_fu](https://github.com/technoweenie/attachment_fu).
|
338
|
+
* `:country` - a select menu of country names. Default for column types: `:string` with name `"country"` - requires a *country_select* plugin to be installed.
|
339
|
+
* `:email` - a text field (just like string). Default for columns with name matching `"email"`. New in HTML5. Works on some mobile browsers already.
|
340
|
+
* `:url` - a text field (just like string). Default for columns with name matching `"url"`. New in HTML5. Works on some mobile browsers already.
|
341
|
+
* `:phone` - a text field (just like string). Default for columns with name matching `"phone"` or `"fax"`. New in HTML5.
|
342
|
+
* `:search` - a text field (just like string). Default for columns with name matching `"search"`. New in HTML5. Works on Safari.
|
343
|
+
* `:hidden` - a hidden field. Creates a hidden field (added for compatibility).
|
344
|
+
* `:range` - a slider field.
|
345
|
+
* `:datalist` - a text field with a accompanying [datalist tag](https://developer.mozilla.org/en/docs/Web/HTML/Element/datalist) which provides options for autocompletion
|
350
346
|
|
351
347
|
The comments in the code are pretty good for each of these (what it does, what the output is, what the options are, etc.) so go check it out.
|
352
348
|
|
353
349
|
|
354
|
-
|
350
|
+
## Delegation for label lookups
|
355
351
|
|
356
352
|
Formtastic decides which label to use in the following order:
|
357
353
|
|
358
|
-
|
354
|
+
```
|
359
355
|
1. :label # :label => "Choose Title"
|
360
356
|
2. Formtastic i18n # if either :label => true || i18n_lookups_by_default = true (see Internationalization)
|
361
357
|
3. Activerecord i18n # if localization file found for the given attribute
|
362
358
|
4. label_str_method # if nothing provided this defaults to :humanize but can be set to a custom method
|
363
|
-
|
359
|
+
```
|
364
360
|
|
365
|
-
|
361
|
+
## Internationalization (I18n)
|
366
362
|
|
367
|
-
|
363
|
+
### Basic Localization
|
368
364
|
|
369
|
-
Formtastic has some neat I18n-features. ActiveRecord object names and attributes are, by default, taken from calling
|
365
|
+
Formtastic has some neat I18n-features. ActiveRecord object names and attributes are, by default, taken from calling `@object.human_name` and `@object.human_attribute_name(attr)` respectively. There are a few words specific to Formtastic that can be translated. See `lib/locale/en.yml` for more information.
|
370
366
|
|
371
367
|
Basic localization (labels only, with ActiveRecord):
|
372
368
|
|
373
|
-
|
369
|
+
```erb
|
374
370
|
<%= semantic_form_for @post do |f| %>
|
375
371
|
<%= f.inputs do %>
|
376
372
|
<%= f.input :title %> # => :label => I18n.t('activerecord.attributes.user.title') or 'Title'
|
@@ -378,23 +374,23 @@ Basic localization (labels only, with ActiveRecord):
|
|
378
374
|
<%= f.input :section %> # => :label => I18n.t('activerecord.attributes.user.section') or 'Section'
|
379
375
|
<% end %>
|
380
376
|
<% end %>
|
381
|
-
|
377
|
+
```
|
382
378
|
|
383
379
|
*Note:* This is perfectly fine if you just want your labels/attributes and/or models to be translated using *ActiveRecord I18n attribute translations*, and you don't use input hints and legends. But what if you do? And what if you don't want same labels in all forms?
|
384
380
|
|
385
|
-
|
381
|
+
### Enhanced Localization (Formtastic I18n API)
|
386
382
|
|
387
383
|
Formtastic supports localized *labels*, *hints*, *legends*, *actions* using the I18n API for more advanced usage. Your forms can now be DRYer and more flexible than ever, and still fully localized. This is how:
|
388
384
|
|
389
|
-
*1. Enable I18n lookups by default (
|
385
|
+
*1. Enable I18n lookups by default (`config/initializers/formtastic.rb`):*
|
390
386
|
|
391
|
-
|
387
|
+
```ruby
|
392
388
|
Formtastic::FormBuilder.i18n_lookups_by_default = true
|
393
|
-
|
389
|
+
```
|
394
390
|
|
395
|
-
*2. Add some label-translations/variants (
|
391
|
+
*2. Add some label-translations/variants (`config/locales/en.yml`):*
|
396
392
|
|
397
|
-
|
393
|
+
```yml
|
398
394
|
en:
|
399
395
|
formtastic:
|
400
396
|
titles:
|
@@ -421,11 +417,11 @@ Formtastic supports localized *labels*, *hints*, *legends*, *actions* using the
|
|
421
417
|
reset: "Reset form"
|
422
418
|
cancel: "Cancel and go back"
|
423
419
|
dummie: "Launch!"
|
424
|
-
|
420
|
+
```
|
425
421
|
|
426
422
|
*3. ...and now you'll get:*
|
427
423
|
|
428
|
-
|
424
|
+
```erb
|
429
425
|
<%= semantic_form_for Post.new do |f| %>
|
430
426
|
<%= f.inputs do %>
|
431
427
|
<%= f.input :title %> # => :label => "Choose a title...", :hint => "Choose a good title for your post."
|
@@ -436,24 +432,24 @@ Formtastic supports localized *labels*, *hints*, *legends*, *actions* using the
|
|
436
432
|
<%= f.action :submit %> # => "Create my %{model}"
|
437
433
|
<% end %>
|
438
434
|
<% end %>
|
439
|
-
|
435
|
+
```
|
440
436
|
|
441
437
|
*4. Localized titles (a.k.a. legends):*
|
442
438
|
|
443
439
|
_Note: Slightly different because Formtastic can't guess how you group fields in a form. Legend text can be set with first (as in the sample below) specified value, or :name/:title options - depending on what flavor is preferred._
|
444
440
|
|
445
|
-
|
441
|
+
```erb
|
446
442
|
<%= semantic_form_for @post do |f| %>
|
447
443
|
<%= f.inputs :post_details do %> # => :title => "Post details"
|
448
444
|
# ...
|
449
445
|
<% end %>
|
450
446
|
# ...
|
451
447
|
<% end %>
|
452
|
-
|
448
|
+
```
|
453
449
|
|
454
450
|
*5. Override I18n settings:*
|
455
451
|
|
456
|
-
|
452
|
+
```erb
|
457
453
|
<%= semantic_form_for @post do |f| %>
|
458
454
|
<%= f.inputs do %>
|
459
455
|
<%= f.input :title %> # => :label => "Choose a title...", :hint => "Choose a good title for your post."
|
@@ -464,17 +460,17 @@ _Note: Slightly different because Formtastic can't guess how you group fields in
|
|
464
460
|
<%= f.action :submit, :label => :dummie %> # => "Launch!"
|
465
461
|
<% end %>
|
466
462
|
<% end %>
|
467
|
-
|
463
|
+
```
|
468
464
|
|
469
465
|
If I18n-lookups is disabled, i.e.:
|
470
466
|
|
471
|
-
|
467
|
+
```ruby
|
472
468
|
Formtastic::FormBuilder.i18n_lookups_by_default = false
|
473
|
-
|
469
|
+
```
|
474
470
|
|
475
471
|
...then you can enable I18n within the forms instead:
|
476
472
|
|
477
|
-
|
473
|
+
```erb
|
478
474
|
<%= semantic_form_for @post do |f| %>
|
479
475
|
<%= f.inputs do %>
|
480
476
|
<%= f.input :title, :label => true %> # => :label => "Choose a title..."
|
@@ -485,25 +481,25 @@ If I18n-lookups is disabled, i.e.:
|
|
485
481
|
<%= f.action :submit, :label => true %> # => "Update %{model}" (if we are in edit that is...)
|
486
482
|
<% end %>
|
487
483
|
<% end %>
|
488
|
-
|
484
|
+
```
|
489
485
|
|
490
486
|
*6. Advanced I18n lookups*
|
491
487
|
|
492
488
|
For more flexible forms; Formtastic finds translations using a bottom-up approach taking the following variables in account:
|
493
489
|
|
494
|
-
*
|
495
|
-
*
|
496
|
-
*
|
490
|
+
* `MODEL`, e.g. "post"
|
491
|
+
* `ACTION`, e.g. "edit"
|
492
|
+
* `KEY/ATTRIBUTE`, e.g. "title", :my_custom_key, ...
|
497
493
|
|
498
494
|
...in the following order:
|
499
495
|
|
500
|
-
1.
|
501
|
-
2.
|
502
|
-
3.
|
496
|
+
1. `formtastic.{titles,labels,hints,actions}.MODEL.ACTION.ATTRIBUTE` - by model and action
|
497
|
+
2. `formtastic.{titles,labels,hints,actions}.MODEL.ATTRIBUTE` - by model
|
498
|
+
3. `formtastic.{titles,labels,hints,actions}.ATTRIBUTE` - global default
|
503
499
|
|
504
500
|
...which means that you can define translations like this:
|
505
501
|
|
506
|
-
|
502
|
+
```yml
|
507
503
|
en:
|
508
504
|
formtastic:
|
509
505
|
labels:
|
@@ -517,100 +513,116 @@ For more flexible forms; Formtastic finds translations using a bottom-up approac
|
|
517
513
|
edit:
|
518
514
|
title: "Edit title"
|
519
515
|
body: "Edit body"
|
520
|
-
|
516
|
+
```
|
521
517
|
|
522
|
-
Values for
|
518
|
+
Values for `labels`/`hints`/`actions` are can take values: `String` (explicit value), `Symbol` (i18n-lookup-key relative to the current "type", e.g. actions:), `true` (force I18n lookup), `false` (force no I18n lookup). Titles (legends) can only take: `String` and `Symbol` - true/false have no meaning.
|
523
519
|
|
524
520
|
*7. Basic Translations*
|
525
|
-
If you want some basic translations, take a look on the
|
521
|
+
If you want some basic translations, take a look on the [formtastic_i18n gem](https://github.com/timoschilling/formtastic_i18n).
|
526
522
|
|
527
|
-
|
523
|
+
## Semantic errors
|
528
524
|
|
529
525
|
You can show errors on base (by default) and any other attribute just by passing its name to the semantic_errors method:
|
530
526
|
|
531
|
-
|
527
|
+
```erb
|
532
528
|
<%= semantic_form_for @post do |f| %>
|
533
529
|
<%= f.semantic_errors :state %>
|
534
530
|
<% end %>
|
535
|
-
|
531
|
+
```
|
536
532
|
|
537
533
|
|
538
|
-
|
534
|
+
## Modified & Custom Inputs
|
539
535
|
|
540
536
|
You can modify existing inputs, subclass them, or create your own from scratch. Here's the basic process:
|
541
537
|
|
542
|
-
*
|
543
|
-
*
|
544
|
-
* To use that input, leave off the word "input" in your @as@ statement. For example, @f.input(:size, :as => :hat_size)@
|
538
|
+
* Run the input generator and provide your custom input name. For example, `rails generate formtastic:input hat_size`. This creates the file `app/inputs/hat_size_input.rb`. You can also provide namespace to input name like `rails generate formtastic:input foo/custom` or `rails generate formtastic:input Foo::Custom`, this will create the file `app/inputs/foo/custom_input.rb` in both cases.
|
539
|
+
* To use that input, leave off the word "input" in your `as` statement. For example, `f.input(:size, :as => :hat_size)`
|
545
540
|
|
546
541
|
Specific examples follow.
|
547
542
|
|
548
|
-
|
543
|
+
### Changing Existing Input Behavior
|
549
544
|
|
550
|
-
To modify the behavior of
|
545
|
+
To modify the behavior of `StringInput`, subclass it in a new file, `app/inputs/string_input.rb`:
|
551
546
|
|
552
|
-
|
547
|
+
```ruby
|
553
548
|
class StringInput < Formtastic::Inputs::StringInput
|
554
549
|
def to_html
|
555
550
|
puts "this is my modified version of StringInput"
|
556
551
|
super
|
557
552
|
end
|
558
553
|
end
|
559
|
-
|
554
|
+
```
|
555
|
+
|
556
|
+
Another way to modify behavior is by using the input generator:
|
557
|
+
```shell
|
558
|
+
$ rails generate formtastic:input string --extend
|
559
|
+
```
|
560
|
+
|
561
|
+
This generates the file `app/inputs/string_input.rb` with its respective content class.
|
560
562
|
|
561
|
-
You can use your modified version with
|
563
|
+
You can use your modified version with `:as => :string`.
|
562
564
|
|
563
|
-
|
565
|
+
### Creating New Inputs Based on Existing Ones
|
564
566
|
|
565
|
-
To create your own new types of inputs based on existing inputs, the process is similar. For example, to create
|
567
|
+
To create your own new types of inputs based on existing inputs, the process is similar. For example, to create `FlexibleTextInput` based on `StringInput`, put the following in `app/inputs/flexible_text_input.rb`:
|
566
568
|
|
567
|
-
|
569
|
+
```ruby
|
568
570
|
class FlexibleTextInput < Formtastic::Inputs::StringInput
|
569
571
|
def input_html_options
|
570
572
|
super.merge(:class => "flexible-text-area")
|
571
573
|
end
|
572
574
|
end
|
573
|
-
|
575
|
+
```
|
574
576
|
|
575
|
-
You can
|
577
|
+
You can also extend existing input behavior by using the input generator:
|
576
578
|
|
577
|
-
|
579
|
+
```shell
|
580
|
+
$ rails generate formtastic:input FlexibleText --extend string
|
581
|
+
```
|
578
582
|
|
579
|
-
|
583
|
+
This generates the file `app/inputs/flexible_text_input.rb` with its respective content class.
|
580
584
|
|
581
|
-
|
585
|
+
You can use your new input with `:as => :flexible_text`.
|
586
|
+
|
587
|
+
### Creating New Inputs From Scratch
|
588
|
+
|
589
|
+
To create a custom `DatePickerInput` from scratch, put the following in `app/inputs/date_picker_input.rb`:
|
590
|
+
|
591
|
+
```ruby
|
582
592
|
class DatePickerInput
|
583
593
|
include Formtastic::Inputs::Base
|
584
594
|
def to_html
|
585
595
|
# ...
|
586
596
|
end
|
587
597
|
end
|
588
|
-
|
598
|
+
```
|
589
599
|
|
590
|
-
You can use your new input with
|
600
|
+
You can use your new input with `:as => :date_picker`.
|
591
601
|
|
592
602
|
|
593
|
-
|
603
|
+
## Dependencies
|
594
604
|
|
595
605
|
There are none other than Rails itself, but...
|
596
606
|
|
597
|
-
* If you want to use the
|
607
|
+
* If you want to use the `:country` input, you'll need to install the [country-select plugin](https://github.com/stefanpenner/country_select) (or any other country_select plugin with the same API). Both 1.x and 2.x are supported, but they behave differently when storing data, so please see their [upgrade notes](https://github.com/stefanpenner/country_select/blob/master/UPGRADING.md) if switching from 1.x.
|
598
608
|
* There are a bunch of development dependencies if you plan to contribute to Formtastic
|
599
609
|
|
600
610
|
|
601
|
-
|
611
|
+
## How to contribute
|
602
612
|
|
603
613
|
* Fork the project on Github
|
614
|
+
* Install development dependencies (`bundle install` and `bin/appraisal install`)
|
604
615
|
* Create a topic branch for your changes
|
605
616
|
* Ensure that you provide *documentation* and *test coverage* for your changes (patches won't be accepted without)
|
606
617
|
* Ensure that all tests pass (`bundle exec rake`)
|
607
618
|
* Create a pull request on Github (these are also a great place to start a conversation around a patch as early as possible)
|
608
619
|
|
609
620
|
|
610
|
-
|
621
|
+
## Project Info
|
622
|
+
|
623
|
+
Formtastic was created by [Justin French](https://www.justinfrench.com) with contributions from around 180 awesome developers. Run `git shortlog -n -s` to see the awesome.
|
611
624
|
|
612
|
-
|
625
|
+
The project is hosted on Github: [https://github.com/justinfrench/formtastic](https://github.com/justinfrench/formtastic), where your contributions, forkings, comments, issues and feedback are greatly welcomed.
|
613
626
|
|
614
|
-
|
627
|
+
Copyright (c) 2007-2016 Justin French, released under the MIT license.
|
615
628
|
|
616
|
-
Copyright (c) 2007-2014 Justin French, released under the MIT license.
|