effective_resources 1.2.4 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d95fec4a073172b1c5761499c4e4209892661264
-  data.tar.gz: 591c72a18aec34a832892d221efd4b5bd6e114fa
+SHA256:
+  metadata.gz: ae9635ad1328b7109aaaf6250dd6e73b1e82c94883a26128f6c175dfaa541d2d
+  data.tar.gz: 5921dbfd7773c0b1eb440b2864de2b1f1c95f0ec0d0de543de70433f185ed165
 SHA512:
-  metadata.gz: 88f0cfd8484a610198932329f55934f7697dad7919e58b804a1404da8d2c0940bbc4250cbf9eb8dc24fa2d8b9264122fea22c035d2e64c1de462a2be5880df76
-  data.tar.gz: 3ed8d6aeeac162af20d57d0cfe7cb6e2f818848ca3361b42aace8b4236a065a3a75f0ea7ba88caa414ae7cb321290e281aa8a5cf418982621211722af61a81bf
+  metadata.gz: 973334cca43d4337328170e7b97f95d2e97d678d24181c067d7f7e1e0c2cd81f79154a8c3c29745fbdace515cb8ea77c53dbbf313804e5331f8f36dc8270b4ab
+  data.tar.gz: 43e5b2f690eac1dbd8b81cb9fbf54f2f3efa95b8886c15cce725b6f6299d4acfca795ef92e4d235caf3189bb3a944beb62e5cd51a4212f6694594c02fa574ef3

data/README.md

@@ -2,31 +2,26 @@
 
 The goal of this gem is to reduce the amount of code that needs to be written when developing a ruby on rails website.
 
-It is ruby on rails, on effective rails.
+It's ruby on rails, on effective rails.
 
-A rails developer will always need to maintain and write:
+A rails developer will **always** need to maintain and write:
 
 - The `routes.rb` as it's the single most important file in an entire app.
 - The `ability.rb` or other authorization.
-- A normal active record model file for each model / form object / interaction / resource, whatever.
-- A corresponding form.
-- Any javascripts, etc, and unique resource actions.
+- A normal ApplicationRecord model file for each model, `/app/models/post.rb`.
+- Its corresponding form, `/app/views/posts/_form.html.haml` and `_post.html.haml`
+- Any javascript and css
 
-However, all other patterns and a lot of code can be automated.
+However, all other areas of code should be automated.
 
-This gem replaces the following work a rails developer would normally do:
+This gem **replaces** the following work a rails developer would normally do:
 
 - Controllers.
-- permitted params. This gem implements a model dsl to define and blacklist params. It's not the rails way.
+- Any file named `index/edit/show/new.html`. We use rails application templates and powerful defaults views so these files need never be written.
+- Writing `permitted params`. This gem implements a model dsl to define and blacklist params.
+- Manually checking which actions are available to the `current_user` on each `resource` all the time.
+- Writing submit buttons
 
-- Any file named index/edit/show/new.html. We use rails application templates and powerful defaults views so these files need never be written.
-- Figure out actions available to the `current_user` to each `resource` on the fly, based on controller namespace, the routes.rb and ability.rb
-- Powerful helpers to render the correct resource action links.
-- Collection of concern files.
-
-Make your controller an effective resource controller.
-Implements the 7 RESTful actions as a one-liner on any controller.
-Reads the `routes.rb` and serves collection and member actions.
 
 ## Getting Started
 
@@ -48,7 +43,21 @@ rails generate effective_resources:install
 
 The generator will install an initializer which describes all configuration options.
 
-## Usage
+Check the `config/initializer/effective_resources.rb` and make sure it's calling your authentication library correctly.
+
+```
+config.authorization_method = Proc.new { |controller, action, resource| authorize!(action, resource) } # CanCanCan
+```
+
+# Quick Start
+
+This gem was built to quickly build CRUD interfaces. Automate all the actions, and submit buttons.
+
+It uses the `params[:commit]` message to call the appropriate action, or `save` on the given resource.
+
+It reads the `routes.rb` to serve `collection` and `member` actions, and considers `current_user` and `ability.rb`
+
+Tries to do the right thing in all situations.
 
 Add to your `app/models/post.rb`:
 
@@ -57,7 +66,6 @@ class Post < ApplicationRecord
   belongs_to :author, class_name: 'User'
 
   # The only thing this block is used for - right now - is permitted_params
-  # So yo
   effective_resource do
     category      :string
     title         :string
@@ -70,23 +78,16 @@ class Post < ApplicationRecord
 
   # The approve! action will be called by Effective::CrudController when submitted on a create/update or member action
   def approve!
-    raise 'already approved' if approved?
+    raise 'already approved' if approved?s
     update!(approved: true)
   end
-
 end
 ```
 
 Add to your `routes.rb`:
 
 ```ruby
-resources :posts, only: [:index, :show] do
-  get :approve, on: :member
-  post :approve, on: :member
-
-  get :approved, on: :collection
-  post :bulk_approve, on: :collection
-end
+resources :posts
 ```
 
 Add to your contoller:
@@ -95,9 +96,58 @@ Add to your contoller:
 class PostsController < ApplicationController
   include Effective::CrudController
 
+  submit :approve, 'Approve'
+end
+```
+
+and in your view:
+
+```ruby
+  = form_with(model: post) do
+    = f.input :text
+    = effective_submit(f)  # Will make a Save and an Approve. Rails 5 forms.
+    = simple_form_submit(f) # Ditto.
+```
+
+and in your authorization:
+
+```ruby
+  can :approve, Post
+  # can(:approve, Post) { |post| !post.approved? }
+```
+
+## Controller
+
+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
+
+You can override individual methods on the CrudController.
+
+Here is a more advanced example:
+
+```ruby
+class PostsController < ApplicationController
+  include Effective::CrudController
   # Sets the @page_title in a before_filter
   page_title 'My Posts', only: [:index]
 
+  # Callbacks: before_save, after_save, resource_error
+  before_render(only: :new) do
+    resource.client = current_user.clients.first
+  end
+
+  submit :accept, 'Accept',
+    if: -> { !resource.approved? }, # Imho this check should be kept in ability.rb, but you could do it here.
+    redirect: -> { accepted_posts_path },
+    success: 'The @resource has been approved' # Any @resource will be replaced with @resource.to_s
+
   # All queries and objects will be built with this scope
   resource_scope -> { current_user.posts }
 
@@ -133,122 +183,39 @@ class PostsController < ApplicationController
   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.
-
-```haml
-%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
+## Helpers
 
-Use `tabs do` and `tabs` to create bootstrap3 tabs.
-
-The helper inserts both the tablist and the tabpanel, and assigns the `active` class.
-
-```haml
-= 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:
-
-```haml
-= simple_form_for(post) do |f|
-  = f.input :title
-  = f.input :body
+### effective_submit & simple_form_submit
 
+```rails
+= form_with(model: post) do |f|
+  = effective_submit(f)
   = simple_form_submit(f)
 ```
 
-to render 3 submit buttons: `Save`, `Save and Continue`, and `Save and Add New`.
+These helpers output the `= f.submit 'Save'` based on the controllers `submits`, the `current_user` and `ability.rb`.
 
-### simple_form_save
+They try to add good `data-confirm` options for `delete` buttons and sort by `btn-primary`, `btn-secondary` and `btn-danger`.
 
-Call `simple_form_save(f)` like follows:
+### Application Templates
 
-```haml
-= simple_form_for(post) do |f|
-  ...
-  = simple_form_save(f)
-```
+When you installed the gem, it should make some `views/application/index.html.haml`, `new.html.haml`, etc.
 
-to render just the `Save` button, with appropriate data-disable, title, etc.
+If you're not using haml, you should be, go install `haml`. Or convert to slim, you sly devils.
 
-### Effective Form with
+These files, possibly customized to your app, should replace almost all resource specific views.
 
-```ruby
+Just create a `_form.html.haml` and `_post.html.haml` for each resource.
 
-= effective_form_with(model: user, url: user_settings_path) do |f|
-  = effective_submit(f)
-  = effective_save(f)
+Just put another `app/views/posts/index.html.haml` in the posts directory to override the default template.
 
-  = effective_save(f) do
-    = f.save 'Save'
-    = f.save 'Another'
 
-  = effective_save(f, 'Save It')
+## Concerns
 
-  = 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' }
-```
+Sure why not. These don't really fit into my code base anywhere else.
 
 ### acts_as_tokened
 

data/app/controllers/concerns/effective/crud_controller/permitted_params.rb

@@ -65,13 +65,13 @@ module Effective
           end
         end
 
-        permitted_params = permitted_params.map do |k, (datatype, v)|
+        permitted_params = permitted_params.flat_map do |k, (datatype, v)|
           if datatype == :array
-            { k => [] }
+            [k, { k => [] }]
           elsif datatype == :permitted_param && k.to_s.ends_with?('_ids')
             { k => [] }
           elsif v.present? && v[:permitted] == :array
-            { k => [] }
+            [k, { k => [] }]
           elsif datatype == :permitted_param && v.present? && v.key?(:permitted_attributes)
             { k => v[:permitted_attributes] }
           elsif datatype == :effective_address

data/app/controllers/concerns/effective/crud_controller/respond.rb

@@ -20,7 +20,7 @@ module Effective
 
           format.js do
             flash.now[:success] ||= resource_flash(:success, resource, action)
-            reload_resource unless action == :destroy
+            #reload_resource unless action == :destroy # Removed.
             render(action) # action.js.erb
           end
         else # Default
@@ -100,7 +100,7 @@ module Effective
       end
 
       def template_present?(action)
-        lookup_context.template_exists?("#{action}.#{request.format.symbol || 'html'}", _prefixes)
+        lookup_context.template_exists?("#{action}.#{request.format.symbol.to_s.sub('json', 'js').presence || 'html'}", _prefixes)
       end
 
     end

data/app/controllers/concerns/effective/crud_controller/save.rb

@@ -52,6 +52,9 @@ module Effective
             flash.now[:danger] = resource_flash(:danger, resource, action, e: e)
 
             case e
+            when ActiveRecord::StaleObjectError
+              flash.now[:danger] = "#{flash.now[:danger]} <a href='#', class='alert-link' onclick='window.location.reload(true); return false;'>reload page and try again</a>"
+              raise(ActiveRecord::Rollback) # This is a soft error, we want to display the flash message to user
             when Effective::ActionFailed, ActiveRecord::RecordInvalid, RuntimeError
               raise(ActiveRecord::Rollback) # This is a soft error, we want to display the flash message to user
             else

data/app/controllers/concerns/effective/flash_messages.rb

@@ -20,7 +20,7 @@ module Effective
 
       name ||= resource.to_s.presence
 
-      ["Unable to #{action}", (" #{name}" if name), (": #{messages}." if messages)].compact.join.html_safe
+      ["Unable to #{action}", (" #{name}" if name), (": #{messages}" if messages)].compact.join.html_safe
     end
 
     # flash.now[:danger] = "Unable to accept: #{flash_errors(@post)}"

data/lib/effective_resources/version.rb

@@ -1,3 +1,3 @@
 module EffectiveResources
-  VERSION = '1.2.4'.freeze
+  VERSION = '1.2.5'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_resources
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.2.5
 platform: ruby
 authors:
 - Code and Effect
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-22 00:00:00.000000000 Z
+date: 2019-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -111,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Make any controller an effective resource controller.