bootstrap_form 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02eeb0d89ce2c25d6c38aba37ec7ea381e8110ea31ac771cde6a0f92dc36823e
-  data.tar.gz: 3b8448de1c213e51e9a5b34b4c79328318297f0ee30b724f73a65d79f871bb70
+  metadata.gz: d661bd91f892a0d10b09359e36a4846266f622e7fbc38430327bab3f51cd0e13
+  data.tar.gz: 4322fb71af8060d60a28268f00529d857eea8f5b09463953f21e32718ce64251
 SHA512:
-  metadata.gz: 6abcc632e3ccda2b53d839b32cf8f1189a0eb8ccdff59864de232ebfee82df795ed77530bb7de10f12b2de0fecf75a318845030159b73a17e87aedc087150474
-  data.tar.gz: e111e67482e8ed21d54e441d82be365658aad122306d50571d0ae95e68cb7bb344af8906b4b35774a60cafef5757efe6566c642b795e20c3277ab4d23db9467d
+  metadata.gz: 5e21b999c29774ec236fba107ed3d20476345cb60e5675f7aad7e56715ddc2307dc2ed397c51e44d3f35e62d2be1d8e14ffb455ff11d5b2f6ae80525306e0894
+  data.tar.gz: 176023ba2fe9ff4131996289508f63cd654011eddf23cb22c90afa739fcb49c369d7b68b1a533158f925faadcd76e40c23bf0b4dd7a4da96566ad59303967c34

data/.rubocop.yml

@@ -0,0 +1,102 @@
+# Taken from: https://github.com/mattbrictson/rails-template/blob/master/rubocop.yml.tt
+# Modified for demo app in `demo/` directory.
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  TargetRubyVersion: 2.2.2
+  Exclude:
+    - "bin/*"
+    - Capfile
+    - demo/config/boot.rb
+    - demo/config/environment.rb
+    - demo/config/initializers/version.rb
+    - demo/db/schema.rb
+    - "demo/node_modules/**/*"
+    - "demo/bower_components/**/*"
+    - "demo/tmp/**/*"
+    - "demo/vendor/**/*"
+    - Gemfile
+    - Guardfile
+    - demo/Rakefile
+    - Rakefile
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+Metrics/AbcSize:
+  Exclude:
+    - "demo/test/**/*"
+    - "test/**/*"
+
+Metrics/BlockLength:
+  Exclude:
+    - "demo/config/**/*"
+    - "demo/test/**/*"
+    - "test/**/*"
+
+Metrics/ClassLength:
+  Exclude:
+    - "demo/test/**/*"
+    - "test/**/*"
+
+Metrics/LineLength:
+  Max: 132
+  Exclude:
+    - "demo/config/**/*"
+    - "demo/db/**/*"
+
+Metrics/MethodLength:
+  Max: 12
+  Exclude:
+    - "demo/db/migrate/*"
+    - "demo/test/**/*"
+    - "test/**/*"
+
+Naming/MemoizedInstanceVariableName:
+  EnforcedStyleForLeadingUnderscores: optional
+
+Naming/VariableNumber:
+  Enabled: false
+
+Performance/Casecmp:
+  Enabled: false
+
+Rails:
+  Enabled: true
+
+Rails/ApplicationRecord:
+  Exclude:
+    - "demo/db/migrate/**"
+
+Rails/RefuteMethods:
+  Enabled: false
+
+Rails/Validation:
+  Enabled: false
+
+Style/BarePercentLiterals:
+  EnforcedStyle: percent_q
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/EmptyMethod:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrivialAccessors:
+  AllowPredicates: true

data/.rubocop_todo.yml

@@ -0,0 +1,104 @@
+inherit_from: .rubocop.yml
+
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-11-01 19:28:56 +0000 using RuboCop version 0.60.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: auto_detection, squiggly, active_support, powerpack, unindent
+Layout/IndentHeredoc:
+  Exclude:
+    - 'Dangerfile'
+
+# Offense count: 9
+Metrics/AbcSize:
+  Max: 67
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 445
+
+# Offense count: 7
+Metrics/CyclomaticComplexity:
+  Max: 17
+
+# Offense count: 1
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 137
+
+# Offense count: 11
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 45
+
+# Offense count: 2
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 8
+
+# Offense count: 5
+Metrics/PerceivedComplexity:
+  Max: 19
+
+# Offense count: 2
+# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist, MethodDefinitionMacros.
+# NamePrefix: is_, has_, have_
+# NamePrefixBlacklist: is_, has_, have_
+# NameWhitelist: is_a?
+# MethodDefinitionMacros: define_method, define_singleton_method
+Naming/PredicateName:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/bootstrap_form/form_builder.rb'
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: slashes, arguments
+Rails/FilePath:
+  Exclude:
+    - 'demo/config/environments/development.rb'
+
+# Offense count: 23
+Rails/OutputSafety:
+  Exclude:
+    - 'bootstrap_error_rendering_test.rb'
+    - 'lib/bootstrap_form/form_builder.rb'
+    - 'lib/bootstrap_form/helpers/bootstrap.rb'
+    - 'test/bootstrap_checkbox_test.rb'
+    - 'test/bootstrap_form_group_test.rb'
+    - 'test/bootstrap_other_components_test.rb'
+    - 'test/bootstrap_radio_button_test.rb'
+
+# Offense count: 1
+Style/CaseEquality:
+  Exclude:
+    - 'test/test_helper.rb'
+
+# Offense count: 6
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/bootstrap_form/form_builder.rb'
+    - 'lib/bootstrap_form/helpers/bootstrap.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'demo/config/application.rb'
+    - 'lib/bootstrap_form/helper.rb'
+
+# Offense count: 2
+Style/MixinUsage:
+  Exclude:
+    - 'demo/bin/setup'
+    - 'demo/bin/update'

data/.travis.yml

@@ -9,8 +9,10 @@ gemfile:
   - test/gemfiles/5.1.gemfile
   - test/gemfiles/5.2.gemfile
 before_install:
-  - gem update --system
-  - gem install bundler --no-document
+  - gem i rubygems-update -v '<3' && update_rubygems
+  - gem install bundler -v 1.17.3 --no-document
+script:
+  - bundle exec rake test
 
 matrix:
   include:
@@ -18,12 +20,13 @@ matrix:
     - rvm: ruby-head
       gemfile: test/gemfiles/5.2.gemfile
 
-    # Running one job to execute DANGER bot
+    # Running one job to execute DANGER bot and linting
     - rvm: 2.5.0
       gemfile: test/gemfiles/5.2.gemfile
       script:
         - gem install danger
         - danger
+        - bundle exec rake rubocop
 
   allow_failures:
     - rvm: ruby-head

data/CHANGELOG.md

@@ -12,6 +12,16 @@
 
 * Your contribution here!
 
+## [4.1.0][] (2019-01-19)
+
+### New features
+
+- [#259] Allow to render input without wrapper [@yevhene].
+
+### Bugfixes
+
+* [#496] Ensure required attribute is passed through to input tag.
+
 ## [4.0.0][] (2018-10-27)
 
 🚨 **This release adds support for Bootstrap v4 and drops support for Bootstrap v3.** 🚨
@@ -31,6 +41,7 @@ In addition to these necessary markup changes, the bootstrap_form API itself has
 * [#476] Give a way to pass classes to the `div.form-check` wrapper for check boxes and radio buttons - [@lcreid](https://github.com/lcreid).
 * [461](https://github.com/bootstrap-ruby/bootstrap_form/pull/461): default form-inline class applied to parent content div on date select helpers. Can override with a :skip_inline option on the field helper - [@lancecarlson](https://github.com/lancecarlson).
 * The `button`, `submit`, and `primary` helpers can now receive an additional option, `extra_class`. This option allows us to specify additional CSS classes to be added to the corresponding button/input, _while_ maintaining the original default ones. E.g., a primary button with an `extra_class` 'test-button' will have its final CSS classes declaration as 'btn btn-primary test-button'.
+* [#488](https://github.com/bootstrap-ruby/bootstrap_form/pull/488): add required option on form_group_builder - [@ThomasSevestre](https://github.com/ThomasSevestre).
 
 ### Bugfixes
 
@@ -75,6 +86,7 @@ In addition to these necessary markup changes, the bootstrap_form API itself has
 * [#449](https://github.com/bootstrap-ruby/bootstrap_form/pull/449): Passing `.form-row` overrides default `.form-group.row` in horizontal layouts.
 * Added an option to the `submit` (and `primary`, by transitivity) form tag helper, `render_as_button`, which when truthy makes the submit button render as a button instead of an input. This allows you to easily provide further styling to your form submission buttons, without requiring you to reinvent the wheel and use the `button` helper (and having to manually insert the typical Bootstrap classes). - [@jsaraiva](https://github.com/jsaraiva).
 * Add `:error_message` option to `check_box` and `radio_button`, so they can output validation error messages if needed. [@lcreid](https://github.com/lcreid).
+* [#487](https://github.com/bootstrap-ruby/bootstrap_form/pull/487): Add add_control_col_class option on form_group. - [@ThomasSevestre](https://github.com/ThomasSevestre).
 * Your contribution here!
 
 ### Bugfixes
@@ -243,7 +255,8 @@ Features:
   - Added support for bootstrap_form_tag (@baldwindavid)
 
 
-[Pending Release]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v4.0.0...HEAD
+[Pending Release]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v4.1.0...HEAD
+[4.1.0]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v4.0.0...v4.1.0
 [4.0.0]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v4.0.0.alpha1...v4.0.0
 [4.0.0.alpha1]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v2.7.0...v4.0.0.alpha1
 [2.7.0]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v2.6.0...v2.7.0

data/CODE_OF_CONDUCT.md

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

data/CONTRIBUTING.md

@@ -1,16 +1,18 @@
 # Contributing
 
-The release of Bootstrap 4 and Rails 5.1 have implications for the future
-direction of `bootstrap_form`. Don't worry. We plan to move this gem forward to
-Bootstrap 4 and to support Rails 5.1 and beyond. If you're thinking of
-contributing to `bootstrap_form`, please read
-[issue #361](https://github.com/bootstrap-ruby/bootstrap_form/issues/361).
+Thanks so much for considering a contribution to bootstrap_form. We love pull requests!
 
-Your comments are welcome.
+We want everyone to feel welcome to contribute. We encourage respectful exchanges of ideas. We govern ourselves with the Contributor Covenant [Code of Conduct](/CODE_OF_CONDUCT.md).
 
-Thanks so much for considering a contribution to bootstrap_form. We love pull requests!
+There are a number of ways you can contribute to `bootstrap_form`:
+
+- Fix a bug or add a new feature
+- Add to the documentation
+- Review pull requests
+
+## Code Contributions
 
-Here's a quick guide for contributing:
+Here's a quick guide for code contributions:
 
 ### 1. Check if issue or feature is available to work on
 
@@ -19,38 +21,65 @@ and pull requests for anything that looks like the issue or feature you want to
 address. If no one else is working on your issue or feature, carry on with the
 following steps.
 
-### 2. Fork the repo
+### 2. (Optional) Create an issue, and wait a few days for someone to respond
 
-For the project. Optionally, create a branch you want to work on
+If you create an issue for your feature request or bug, it gives the maintainers a chance to comment on your ideas before you invest a lot of work on a contribution. It may save you some re-work compared to simply submitting a pull request. It's up to you whether you submit an issue.
 
-### 3. Get it running locally
+### 3. Fork the repo
+
+Fork the project. Optionally, create a branch you want to work on.
+
+### 4. Get it running locally
 
 - Install the required dependencies with `bundle install`
 - Run tests via: `bundle exec rake`
 
-### 4. Hack away
+### 5. Hack away
 
-- Try to keep your changes small. Consider making several smaller pull requests.
+- Try to keep your changes small. Consider making several smaller pull requests if your changes are extensive.
 - Don't forget to add necessary tests.
 - Update the README if necessary.
 - Add a line to the CHANGELOG for your bug fix or feature.
+- Read the [Coding Guidelines](#coding-guidelines) section and make sure that `rake lint` doesn't find any offences.
 
-You may find using demo application useful for development and debugging.
+You may find the demo application useful for development and debugging.
 
 - `cd demo`
 - `rake db:schema:load`
 - `rails s`
 - Navigate to http://localhost:3000
 
-### 5. Make a Pull Request
+### 6. Make a pull request
+
+- If you've never made a pull request (PR) before, read this: https://help.github.com/articles/about-pull-requests/.
+- If your PR fixes an issues, be sure to put "Fixes #nnn" in the description of the PR (where `nnn` is the issue number). Github will automatically close the issue when the PR is merged.
+- When the PR is submitted, check if Travis CI ran all the tests successfully, and didn't raise any issues.
+
+### 7. Done!
+
+Somebody will shortly review your pull request and if everything is good, it will be
+merged into the master branch. Eventually the gem will be published with your changes.
+
+### Coding guidelines
+
+This project uses [RuboCop](https://github.com/bbatsov/rubocop) to enforce standard Ruby coding
+guidelines. Currently we run RuboCop's as described by [this post](https://tech.offgrid-electric.com/rubocop-getting-to-green-in-a-huge-rails-app-12d1ad6678eb), under the section "How to make CI pass". That means we allow certain existing RuboCop offences in the code, but prevent people from adding any new offences. So you might copy some existing code, and then discover that it doesn't pass. Please fix the new code, and if you're ambitious, fix the old code as well.
+
+* Test that your contribution passes with `rake rubocop`.
+* RuboCop is also run as part of the full test suite with `bundle exec rake`.
+* Note the Travis build will fail and your PR cannot be merged if RuboCop finds offences.
+
+Note that most editors have plugins to run RuboCop as you type, or when you save a file. You may find it well worth your time to install and configure the RuboCop plugin for your editor. Read the [RuboCop documentation](https://rubocop.readthedocs.io/en/latest/integration_with_other_tools/).
+
+## Documentation Contributions
+
+Contributions to documentation are always welcome. Even fixing one typo improves the quality of `bootstrap_form`. To make a documentation contribution, follow steps 1-3 of Code Contributions, then make the documentation changes, then make the pull request (step 6 of Code Contributions).
 
-- If you never done it before read this: https://help.github.com/articles/about-pull-requests/
-- When PR is submitted check if TravisCI ran all tests successfully didn't raise any issues
+If you put `[ci skip]` in the commit message of the most recent commit of the PR, you'll be a good citizen by not causing Travis CI to run all the tests when it's not necessary.
 
-### 6. Done!
+## Reviewing Pull Requests
 
-Somebody will shortly review your pull request and if everything is good will be
-merged into master branch. Eventually gem will be published with your changes.
+We are an entirely volunteer project. Sometimes it's hard for people to find the time to review pull requests. You can help! If you see a pull request that's waiting to be merged, it could be because no one has reviewed it yet. Your review could help move the pull request forward to be merged.
 
 ---