Repository is archived
No commit activity in last 3 years
No release in over 3 years
There's a lot of open issues
Simplifying updating settings from controllers.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 3.7
~> 0.52

Runtime

 Project Readme

Ledermann Rails Settings Update

Gem Version

Simplifying updating settings from controllers. Ledermann Rails Settings Update depends on Ledermann Rails Settings.


Table of Contents

  • Installation
  • Usage
    • Forms
    • Controllers
  • To Do
  • Contributing
    • Contributors
    • Semantic versioning
  • License

Installation

Note: Before installing Ledermann Rails Settings Update make sure to setup the original Ledermann Rails Settings gem.

Ledermann Rails Settings Update works with Rails 5 onwards. You can add it to your Gemfile with:

gem 'ledermann-rails-settings-update'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ledermann-rails-settings-update

If you always want to be up to date fetch the latest from GitHub in your Gemfile:

gem 'ledermann-rails-settings-update', github: 'jonhue/ledermann-rails-settings-update'

Usage

Forms

Let's say we have this Post model:

class Post < ApplicationRecord
    has_settings do |s|
        s.key :preferences, defaults: { language: 'en' }
    end
end

To update this preferences/language setting, a form could look like this:

= simple_form_for @post, url: @post, html: { method: :put } do |f|
    = f.input :title
    = text_field_tag 'post[settings][preferences][language]'
    = f.input :submit

Controllers

Here is a corresponding controller:

class PostsController < ApplicationController

    def update
        @post = Post.find params[:id]
        update_settings @post
        @post.update! post_params
        redirect_back fallback_location: root_path, notice: 'Post updated'
    end

    private

    def post_params
        params.require(:post).permit(:title)
    end

    def settings_params
        params.require(:post).permit(
            settings: [
                preferences: [:language]
            ]
        )
    end

end

Note: The private settings_params method is required.


To Do

Here is the full list of current projects.

To propose your ideas, initiate the discussion by adding a new issue.


Contributing

We hope that you will consider contributing to Ledermann Rails Settings Update. Please read this short overview for some information about how to get started:

Learn more about contributing to this repository, Code of Conduct

Contributors

Give the people some ❤️ who are working on this project. See them all at:

https://github.com/jonhue/ledermann-rails-settings-update/graphs/contributors

Semantic Versioning

Ledermann Rails Settings Update follows Semantic Versioning 2.0 as defined at http://semver.org.

License

MIT License

Copyright (c) 2018 Jonas Hübotter

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.