Effective Resources

Make your controller an effective resource controller.

Implements the 7 RESTful actions as a one-liner on any controller.

Getting Started

gem 'effective_resources'

Run the bundle command to install it:

bundle install

Install the configuration file:

rails generate effective_resources:install

The generator will install an initializer which describes all configuration options.

Usage

Add to your contoller:

class PostsController < ApplicationController
  include Effective::CrudController

  # Sets the @page_title in a before_filter
  page_title 'My Posts', only: [:index]

  # All queries and objects will be built with this scope
  resource_scope -> { current_user.posts }

  # Similar to above, with block syntax
  resource_scope do
    Post.active.where(user: current_user)
  end

  # When GET request, will render the approve page
  # When POST|PATCH|PUT request, will call @post.approve! and do the right thing
  member_action :approve

  # When GET request, will render an index page scoped to this method (if it's a scope on the model i.e. Post.approved)
  collection_action :approved

  # When POST|PATCH|PUT request, will call @post.approve! on each post as per params[:ids]
  # Created with effective_datatables bulk actions in mind
  collection_action :bulk_approve

  protected

  # The permitted parameters for this post.  Other recognized method names are posts_params and permitted_params
  def post_params
    params.require(:post).permit(:id, :author_id, :category, :title, :body)
  end

  # Pass /things/new?duplicate_id=3
  def duplicate_resource(resource)
    resource_klass.new(resource.attributes.slice('job_site', 'address'))
  end

end

What it does

Implements the 7 RESTful actions: index, new, create, show, edit, update, destroy.

Loads an appropriate @posts or @post type instance variable.
Sets a @page_title (effective_pages).
Calls authorize as per the configured EffectiveResources.authorization_method (flow through to CanCan or Pundit)
Does the create/update save
Sets a flash[:success] and redirects on success, or sets a flash.now[:danger] and renders on error.
Does the right thing with member and collection actions
Intelligently redirects based on commit message

Bootstrap3 Helpers

nav_link_to

Use nav_link_to and nav_dropdown to create bootstrap3 menus.

The helper automatically assigns the active class based on the request path.

%nav.navbar.navbar-default
  .container
    .navbar-header
      = link_to(image_tag('logo.png', alt: 'Logo'), '/', class: 'navbar-brand')
      %button.navbar-toggle.collapsed{data: {toggle: 'collapse', target: '.navbar-collapse', 'aria-expanded': false}}
        %span.icon-bar
        %span.icon-bar
        %span.icon-bar
    .collapse.navbar-collapse
      %ul.nav.navbar-nav.navbar-right
        - if current_user.present?
          - if can?(:index, Things)
            = nav_link_to 'Things', things_path

          = nav_dropdown 'Settings' do
            = nav_link_to 'Account Settings', user_settings_path
            %li.divider
            = nav_link_to 'Sign Out', destroy_user_session_path, method: :delete
        - else
          = nav_link_to 'Sign In', new_user_session_path

tabs

Use tabs do and tabs to create bootstrap3 tabs.

The helper inserts both the tablist and the tabpanel, and assigns the active class.

= tabs do
  = tab 'Imports' do
    %p Imports

  = tab 'Exports' do
    %p Exports

You can also call tabs(active: 'Exports') do to set the active tab.

Simple Form Helpers

simple_form_submit

Call simple_form_submit(f) like follows:

= simple_form_for(post) do |f|
  = f.input :title
  = f.input :body

  = simple_form_submit(f)

to render 3 submit buttons: Save, Save and Continue, and Save and Add New.

simple_form_save

Call simple_form_save(f) like follows:

= simple_form_for(post) do |f|
  ...
  = simple_form_save(f)

to render just the Save button, with appropriate data-disable, title, etc.

Effective Form with


= effective_form_with(model: user, url: user_settings_path) do |f|
  = effective_submit(f)
  = effective_save(f)

  = effective_save(f) do
    = f.save 'Save'
    = f.save 'Another'

  = effective_save(f, 'Save It')

  = effective_submit(f) do
    = f.save 'Will be appended'

Remote Delete will automatically fade out the closest match

= link_to 'Delete', post_path(post), remote: true,
  data: { confirm: "Really delete #{post}?", method: :delete, closest: '.post' }

acts_as_tokened

Quickly adds rails 5 has_secure_token to your model, along with some Post.find() enhancements to work with tokens instead of IDs.

This prevents enumeration of this resource.

Make sure to create a string token field on your model, then just declare acts_as_tokened. There are no options.

License

MIT License. Copyright Code and Effect Inc.

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Bonus points for test coverage
Create new Pull Request