dry_crud 6.0.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ff2a042dc7c846957d5e17001f9a538df726084e3695988d68066849938d544
-  data.tar.gz: 504a97b4e2b0769cb260790725bb1a59aaffe33a16a093556d9462dd2403794f
+  metadata.gz: 728d9df7af506d9680cf74d6b7031db221a645816ef03307f1f9a8abca8bd40b
+  data.tar.gz: 748c707433dd4dfea6069f482276e48f45124ba3e26d1ba956d78ab3fc629702
 SHA512:
-  metadata.gz: 9808508def34a37d4d7bea43c5e7d810a4ac57d09c36ceadf8ee0fbf5bba3650611c5e3c5b010f5aa015666076ac3971fe824f2d6deeb17d913cc4404d2261bd
-  data.tar.gz: c9b52ac7b06f5ab74f4fc3b8b0f340f1e3e5f35296296d109585dcb51906b46eb9615c393865cdde30aefb096dabf41dac197a24dc8e364d57e071551fbb0e5e
+  metadata.gz: 692538e533f409bee57aa7ebc5ac99d040d3fabd2e376ecd4edf4057f1f8732011f4753178af4abffe36973baa2dad81c9afa5edc55047bf6c93eb68aef2b80b
+  data.tar.gz: 247d2b34b35ec952f334635a50e5bba85733f0ffef5abbc2efcafa5b5a581aca44f188946eab0bdef662734554e87ae268638a1674720df773599135fd4ee9b9

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2013 Pascal Zumkehr
+Copyright (c) 2010-2023 Pascal Zumkehr
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -16,4 +16,4 @@ 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.
+THE SOFTWARE.

data/README.rdoc

@@ -1,6 +1,8 @@
 = DRY CRUD
 
-{<img src="https://travis-ci.org/codez/dry_crud.svg?branch=master" />}[http://travis-ci.org/codez/dry_crud]
+{rdoc-image:https://github.com/codez/dry_crud/actions/workflows/build.yml/badge.svg}[https://github.com/codez/dry_crud/actions/workflows/build.yml]
+{rdoc-image:https://api.codeclimate.com/v1/badges/ef7488764a0d9805b37d/maintainability}[https://codeclimate.com/github/codez/dry_crud/maintainability]
+{rdoc-image:https://api.codeclimate.com/v1/badges/ef7488764a0d9805b37d/test_coverage}[https://codeclimate.com/github/codez/dry_crud/test_coverage]
 
 dry_crud generates simple and extendable controllers, views and helpers that support you to DRY up the CRUD code in your Rails projects. List, search, sort, show, create, edit and destroy any model entries in just 5 minutes. Start with these artifacts and build a clean base to efficiently develop your application upon.
 
@@ -33,12 +35,11 @@ To integrate dry_crud into your code, only a few additions are required:
 * Optionally define a +list+ scope in your models to be used in the +index+ action.
 * Optionally define a +options_list+ scope in your models to be used in select dropdowns.
 
-From version 5.0 onwards, the major and minor version numbers will be kept in sync with Rails, and only the matching Rails version is supported. Version 3.0 is compatible 4.2, Version 2.0 and higher are compatible with Rails 4 and Rails 3.2. dry_crud is tested with Ruby 2.5. If you are using Ruby 1.9.3, please refer to version 3.0.0.
-
+From version 5.0 onwards, the major and minor version numbers will be kept in sync with Rails, and only the matching Rails version is supported.
 
 == Background
 
-In most Rails applications, you have some models that require basic CRUD (create, read, update, delete) functionality. There are various possibilities like Rails scaffolding, {Inherited Resources}[https://github.com/activeadmin/inherited_resources] or {Rails Admin}[https://github.com/sferik/rails_admin]. Still, various parts in your application remain duplicated. While you might pull up common methods into a common superclass controller, most views still contain very similar code. And then you also have to remember the entire API of these frameworks.
+In most Rails applications, you have some models that require basic CRUD (create, read, update, delete) functionality. There are various possibilities like Rails scaffolding, {Inherited Resources}[https://github.com/activeadmin/inherited_resources] or {Rails Admin}[https://github.com/railsadminteam/rails_admin]. Still, various parts in your application remain duplicated. While you might pull up common methods into a common superclass controller, most views still contain very similar code. And then you also have to remember the entire API of these frameworks.
 
 Enter dry_crud.
 
@@ -50,7 +51,7 @@ dry_crud is a Rails generator. All code resides in your application and is open
 
 dry_crud does not depend on any other gems, but easily allows you to integrate them in order to unify the behavior of your CRUD controllers. You might even use the gems mentioned above to adapt your generated CrudController base class. All classes come with thorough tests that provide you with a solid foundation for implementing your own adaptions.
 
-A basic CSS gets you started with your application's layout. For advanced needs, dry_crud supports the styles and classes used in {Bootstrap 4}[http://getbootstrap.com]. A great design never was so close.
+A basic CSS gets you started with your application's layout. For advanced needs, dry_crud supports the styles and classes used in {Bootstrap}[http://getbootstrap.com]. As the views are generated into your application code, you are free to change the styling to your needs.
 
 If you find yourself adapting the same parts of dry_crud for your applications over and over, please feel free to {fork me on Github}[http://github.com/codez/dry_crud].
 
@@ -161,7 +162,7 @@ To render custom columns, use the +col+ method with an appropriate block:
         t.sortable_attrs(:lastname, :firstname)
         t.col('', class: 'center') { |entry| image_tag(entry.picture) }
         t.attr(:street)
-        t.col('Map') { |entry| link_to(entry.city, "http://maps.google.com/?q=#{entry.city}" }
+        t.col('Map') { |entry| link_to(entry.city, "http://maps.google.com/?q=#{entry.city}") }
       end %>
 
 For views of subclasses of ListController, you can directly use the +crud_table+ helper method, where you do not have to pass the <tt>@people</tt> list explicitly and actions are added automatically.

data/VERSION

@@ -1 +1 @@
-6.0.0
+8.0.0

data/app/assets/stylesheets/sample.scss

@@ -1,8 +1,12 @@
 $container_width: 1000px;
 $theme_color: #2580a2;
 
-body, div, p, td, th {
-  font-family: "Helvetica Neue",Helvetica,Arial,sans-serif;
+body,
+div,
+p,
+td,
+th {
+  font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
   font-size: 14px;
   line-height: 1.42857;
 }
@@ -101,7 +105,8 @@ table.table {
 }
 
 /* div rendered if no entries available for list */
-div.table {}
+div.table {
+}
 
 table.table th {
   background-color: $theme_color;
@@ -119,20 +124,21 @@ table.table td {
   padding: 4px 4px;
 }
 
-.table-striped thead tr:nth-child(odd), .table thead tr:nth-child(even) {
-  background-color: #D0D0D0;
+.table-striped thead tr:nth-child(odd),
+.table thead tr:nth-child(even) {
+  background-color: #d0d0d0;
 }
 
 .table-striped tr:nth-child(odd) {
-  background-color: #F8F8F8;
+  background-color: #f8f8f8;
 }
 
 .table-striped tr:nth-child(even) {
-  background-color: #F0F0F0;
+  background-color: #f0f0f0;
 }
 
 .table-hover tr:hover {
-  background-color: #FFFFE0;
+  background-color: #ffffe0;
 }
 
 td {
@@ -153,7 +159,7 @@ a:hover {
 }
 
 a:visited {
-  color:  #2580a2;
+  color: #2580a2;
 }
 
 a img {
@@ -213,11 +219,21 @@ a.icon img {
   vertical-align: top;
 }
 
-.icon-plus { background-image: image-url('actions/add.png'); }
-.icon-remove { background-image: image-url('actions/delete.png'); }
-.icon-pencil { background-image: image-url('actions/edit.png'); }
-.icon-list { background-image: image-url('actions/list.png'); }
-.icon-zoom-in { background-image: image-url('actions/show.png'); }
+.icon-plus {
+  background-image: image-url("actions/add.png");
+}
+.icon-trash {
+  background-image: image-url("actions/delete.png");
+}
+.icon-pencil {
+  background-image: image-url("actions/edit.png");
+}
+.icon-list {
+  background-image: image-url("actions/list.png");
+}
+.icon-zoom-in {
+  background-image: image-url("actions/show.png");
+}
 
 .form-group {
   clear: both;
@@ -231,34 +247,39 @@ a.icon img {
   padding-top: 3px;
 }
 
-input, textarea, select {
+input,
+textarea,
+select {
   font-family: Verdana, Geneva, Helvetica, Arial, sans-serif;
   font-size: 14px;
 }
 
-input[type=text], input[type=password], input[type=email] {
+input[type="text"],
+input[type="password"],
+input[type="email"] {
   width: 300px;
 }
 
-input[type=number] {
+input[type="number"] {
   width: 100px;
 }
 
-textarea, select[multiple] {
+textarea,
+select[multiple] {
   width: 300px;
   height: 80px;
 }
 
-[role=search] [type=search] {
+[role="search"] [type="search"] {
   width: 220px;
 }
 
 .has-error .control-label {
-  color: #D88;
+  color: #d88;
 }
 
 .has-error .form-control {
-  border-color: #D88;
+  border-color: #d88;
 }
 
 .input-group-append {
@@ -284,7 +305,7 @@ textarea, select[multiple] {
 }
 
 .alert-danger {
-  border: solid 2px #D88;
+  border: solid 2px #d88;
   background-color: #fec;
 }
 
@@ -292,11 +313,11 @@ textarea, select[multiple] {
   float: right;
 }
 
-.float-right {
+.float-end {
   float: right;
 }
 
-.float-left {
+.float-start {
   float: left;
 }
 

data/app/controllers/crud_controller.rb

@@ -8,7 +8,6 @@
 # With the help of additional callbacks, it is possible to hook into the
 # action procedures without overriding the entire method.
 class CrudController < ListController
-
   class_attribute :permitted_attrs
 
   # Defines before and after callback hooks for create, update, save and
@@ -40,6 +39,11 @@ class CrudController < ListController
     assign_attributes if params[model_identifier]
   end
 
+  #   GET /entries/1/edit
+  #
+  # Display a form to edit an exisiting entry of this model.
+  def edit; end
+
   #   POST /entries
   #   POST /entries.json
   #
@@ -52,22 +56,17 @@ class CrudController < ListController
   # in the given block will take precedence over the one defined here.
   #
   # Specify a :location option if you wish to do a custom redirect.
-  def create(options = {}, &block)
+  def create(**options, &block)
     model_class.transaction do
       assign_attributes
       created = with_callbacks(:create, :save) { entry.save }
       respond(created,
-              options.merge(status: :created, render_on_failure: :new),
+              **options.merge(status: :created, render_on_failure: :new),
               &block)
       raise ActiveRecord::Rollback unless created
     end
   end
 
-  #   GET /entries/1/edit
-  #
-  # Display a form to edit an exisiting entry of this model.
-  def edit; end
-
   #   PUT /entries/1
   #   PUT /entries/1.json
   #
@@ -80,12 +79,12 @@ class CrudController < ListController
   # in the given block will take precedence over the one defined here.
   #
   # Specify a :location option if you wish to do a custom redirect.
-  def update(options = {}, &block)
+  def update(**options, &block)
     model_class.transaction do
       assign_attributes
       updated = with_callbacks(:update, :save) { entry.save }
       respond(updated,
-              options.merge(status: :ok, render_on_failure: :edit),
+              **options.merge(status: :ok, render_on_failure: :edit),
               &block)
       raise ActiveRecord::Rollback unless updated
     end
@@ -103,11 +102,11 @@ class CrudController < ListController
   # in the given block will take precedence over the one defined here.
   #
   # Specify a :location option if you wish to do a custom redirect.
-  def destroy(options = {}, &block)
+  def destroy(**options, &block)
     model_class.transaction do
       destroyed = run_callbacks(:destroy) { entry.destroy }
       respond(destroyed,
-              options.merge(status: :no_content),
+              **options.merge(status: :no_content),
               &block)
       raise ActiveRecord::Rollback unless destroyed
     end
@@ -139,7 +138,7 @@ class CrudController < ListController
 
   # The form params for this model.
   def model_params
-    params.require(model_identifier).permit(permitted_attrs)
+    params.expect(model_identifier => permitted_attrs)
   end
 
   # Path of the index page to return to.
@@ -152,14 +151,14 @@ class CrudController < ListController
     path_args(entry)
   end
 
-  def respond(success, options)
+  def respond(success, **options)
     respond_to do |format|
       yield(format, success) if block_given?
       if success
-        format.html { redirect_on_success(options) }
+        format.html { redirect_on_success(**options) }
         format.json { render_success_json(options[:status]) }
       else
-        format.html { render_or_redirect_on_failure(options) }
+        format.html { render_or_redirect_on_failure(**options) }
         format.json { render_failure_json }
       end
     end
@@ -167,16 +166,16 @@ class CrudController < ListController
 
   # If the option :render_on_failure is given, render the corresponding
   # template, otherwise redirect.
-  def render_or_redirect_on_failure(options)
+  def render_or_redirect_on_failure(**options)
     if options[:render_on_failure]
       render options[:render_on_failure]
     else
-      redirect_on_failure(options)
+      redirect_on_failure(**options)
     end
   end
 
   # Perform a redirect after a successfull operation and set a flash notice.
-  def redirect_on_success(options = {})
+  def redirect_on_success(**options)
     location = options[:location] ||
                (entry.destroyed? ? index_path : show_path)
     flash[:notice] ||= flash_message(:success)
@@ -184,9 +183,9 @@ class CrudController < ListController
   end
 
   # Perform a redirect after a failed operation and set a flash alert.
-  def redirect_on_failure(options = {})
+  def redirect_on_failure(**options)
     location = options[:location] ||
-               request.env['HTTP_REFERER'].presence ||
+               request.env["HTTP_REFERER"].presence ||
                index_path
     flash[:alert] ||= error_messages.presence || flash_message(:failure)
     redirect_to location
@@ -211,17 +210,17 @@ class CrudController < ListController
   # or crud.{action_name}.flash.{state} as fallback.
   def flash_message(state)
     scope = "#{action_name}.flash.#{state}"
-    keys = [:"#{controller_name}.#{scope}_html",
+    keys = [ :"#{controller_name}.#{scope}_html",
             :"#{controller_name}.#{scope}",
             :"crud.#{scope}_html",
-            :"crud.#{scope}"]
+            :"crud.#{scope}" ]
     I18n.t(keys.shift, model: full_entry_label, default: keys)
   end
 
   # A label for the current entry, including the model name.
   def full_entry_label
     # rubocop:disable Rails/OutputSafety
-    "#{models_label(false)} <i>#{ERB::Util.h(entry)}</i>".html_safe
+    "#{models_label(plural: false)} <i>#{ERB::Util.h(entry)}</i>".html_safe
     # rubocop:enable Rails/OutputSafety
   end
 
@@ -229,7 +228,7 @@ class CrudController < ListController
   def error_messages
     # rubocop:disable Rails/OutputSafety
     escaped = entry.errors.full_messages.map { |m| ERB::Util.html_escape(m) }
-    escaped.join('<br/>').html_safe
+    escaped.join("<br/>").html_safe
     # rubocop:enable Rails/OutputSafety
   end
 
@@ -242,5 +241,4 @@ class CrudController < ListController
       before_render_edit(*methods)
     end
   end
-
 end

data/app/controllers/dry_crud/generic_model.rb

@@ -1,5 +1,4 @@
 module DryCrud
-
   # Connects the including controller to the model whose name corrsponds to
   # the controller's name.
   #
@@ -7,15 +6,12 @@ module DryCrud
   # Additional helper methods store and retrieve values in instance variables
   # named after their class.
   module GenericModel
-
     extend ActiveSupport::Concern
 
     included do
       helper_method :model_class, :models_label, :path_args
 
-      private
-
-      delegate :model_class, :models_label, :model_identifier, to: 'self.class'
+      delegate :model_class, :models_label, :model_identifier, to: "self.class"
     end
 
     # The scope where model entries will be listed and created.
@@ -33,7 +29,7 @@ module DryCrud
 
     # Get the instance variable named after the +model_class+.
     # If the collection variable is required, pass true as the second argument.
-    def model_ivar_get(plural = false)
+    def model_ivar_get(plural: false)
       name = ivar_name(model_class)
       name = name.pluralize if plural
       name = :"@#{name}"
@@ -45,11 +41,11 @@ module DryCrud
     def model_ivar_set(value)
       name = if value.respond_to?(:klass) # ActiveRecord::Relation
                ivar_name(value.klass).pluralize
-             elsif value.respond_to?(:each) # Array
+      elsif value.respond_to?(:each) # Array
                ivar_name(value.first.class).pluralize
-             else
+      else
                ivar_name(value.class)
-             end
+      end
       instance_variable_set(:"@#{name}", value)
     end
 
@@ -59,7 +55,6 @@ module DryCrud
 
     # Class methods from GenericModel.
     module ClassMethods
-
       # The ActiveRecord class of the model.
       def model_class
         @model_class ||= controller_name.classify.constantize
@@ -72,14 +67,13 @@ module DryCrud
       end
 
       # A human readable plural name of the model.
-      def models_label(plural = true)
+      def models_label(plural: true)
         opts = { count: (plural ? 3 : 1) }
         opts[:default] = model_class.model_name.human.titleize
         opts[:default] = opts[:default].pluralize if plural
 
         model_class.model_name.human(opts)
       end
-
     end
   end
 end

data/app/controllers/dry_crud/nestable.rb

@@ -1,5 +1,4 @@
 module DryCrud
-
   # Provides functionality to nest controllers/resources.
   # If a controller is nested, the parent classes and namespaces
   # may be defined as an array in the +nesting+ class attribute.
@@ -8,7 +7,6 @@ module DryCrud
   # namespace, may define this attribute as follows:
   #   self.nesting = :admin, Country
   module Nestable
-
     # Adds the :nesting class attribute and parent helper methods
     # to the including controller.
     def self.prepended(klass)
@@ -45,7 +43,7 @@ module DryCrud
 
     # An array of objects used in url_for and related functions.
     def path_args(last)
-      parents + [last]
+      parents + [ last ]
     end
 
     # Uses the parent entry (if any) to constrain the model scope.
@@ -61,6 +59,5 @@ module DryCrud
     def parent_scope
       parent.send(model_class.name.underscore.pluralize)
     end
-
   end
 end

data/app/controllers/dry_crud/rememberable.rb

@@ -1,5 +1,4 @@
 module DryCrud
-
   # Remembers certain params of the index action in order to return
   # to the same list after an entry was viewed or edited.
   # If the index is called with a param :returning, the remembered params
@@ -11,14 +10,13 @@ module DryCrud
   # The params are stored separately for each different +remember_key+, which
   # defaults to the current request's path.
   module Rememberable
-
     extend ActiveSupport::Concern
 
     included do
       class_attribute :remember_params
       self.remember_params = %w[q sort sort_dir page]
 
-      before_action :handle_remember_params, only: [:index]
+      before_action :handle_remember_params, only: [ :index ]
     end
 
     private
@@ -61,6 +59,5 @@ module DryCrud
     def remember_key
       request.path
     end
-
   end
 end

data/app/controllers/dry_crud/render_callbacks.rb

@@ -1,8 +1,6 @@
 module DryCrud
-
   # Provide +before_render+ callbacks.
   module RenderCallbacks
-
     extend ActiveSupport::Concern
 
     included do
@@ -12,16 +10,14 @@ module DryCrud
 
     # Prepended methods for callbacks.
     module Prepends
-
       # Helper method to run +before_render+ callbacks and render the action.
       # If a callback renders or redirects, the action is not rendered.
-      def render(*args, &block)
-        options = _normalize_render(*args, &block)
-        callback = "render_#{options[:template]}"
-
+      def render(...)
+        options = _normalize_render(...)
+        callback = "render_#{options[:template] || options[:action] || action_name}"
         run_callbacks(callback) if respond_to?(:"_#{callback}_callbacks", true)
 
-        super(*args, &block) unless performed?
+        super unless performed?
       end
 
       private
@@ -33,12 +29,10 @@ module DryCrud
           -> { run_callbacks(e, &a) }
         end.call
       end
-
     end
 
     # Class methods for callbacks.
     module ClassMethods
-
       # Defines before callbacks for the render actions.
       def define_render_callbacks(*actions)
         args = actions.map { |a| :"render_#{a}" }
@@ -58,8 +52,6 @@ module DryCrud
           terminate
         end
       end
-
     end
-
   end
 end

data/app/controllers/dry_crud/searchable.rb

@@ -1,10 +1,8 @@
 module DryCrud
-
   # The search functionality for the index table.
   # Define an array of searchable string columns in your subclassing
   # controllers using the class attribute +search_columns+.
   module Searchable
-
     extend ActiveSupport::Concern
 
     included do
@@ -18,7 +16,6 @@ module DryCrud
 
     # Prepended methods for searching.
     module Prepends
-
       private
 
       # Enhance the list entries with an optional search criteria
@@ -61,24 +58,20 @@ module DryCrud
       def search_support?
         search_columns.present?
       end
-
     end
 
     # Class methods for Searchable.
     module ClassMethods
-
       # All search columns divided in table and field names.
       def search_tables_and_fields
         @search_tables_and_fields ||= search_columns.map do |f|
-          if f.to_s.include?('.')
-            f.split('.', 2)
+          if f.to_s.include?(".")
+            f.split(".", 2)
           else
-            [model_class.table_name, f]
+            [ model_class.table_name, f ]
           end
         end
       end
-
     end
-
   end
 end

data/app/controllers/dry_crud/sortable.rb

@@ -1,10 +1,8 @@
 module DryCrud
-
   # Sort functionality for the index table.
   # Define a default sort expression that is always appended to the
   # current sort params with the class attribute +default_sort+.
   module Sortable
-
     extend ActiveSupport::Concern
 
     included do
@@ -20,7 +18,6 @@ module DryCrud
 
     # Class methods for sorting.
     module ClassMethods
-
       # Define a map of (virtual) attributes to SQL order expressions.
       # May be used for sorting table columns that do not appear directly
       # in the database table. E.g., map city_id: 'cities.name' to
@@ -29,20 +26,18 @@ module DryCrud
         self.sort_mappings_with_indifferent_access =
           hash.with_indifferent_access
       end
-
     end
 
     # Prepended methods for sorting.
     module Prepends
-
       private
 
       # Enhance the list entries with an optional sort order.
       def list_entries
         sortable = sortable?(params[:sort])
         if sortable || default_sort
-          clause = [sortable ? sort_expression : nil, default_sort]
-          super.reorder(Arel.sql(clause.compact.join(', ')))
+          clause = [ sortable ? sort_expression : nil, default_sort ]
+          super.reorder(Arel.sql(clause.compact.join(", ")))
         else
           super
         end
@@ -57,7 +52,7 @@ module DryCrud
 
       # The sort direction, either 'asc' or 'desc'.
       def sort_dir
-        params[:sort_dir] == 'desc' ? 'DESC' : 'ASC'
+        params[:sort_dir] == "desc" ? "DESC" : "ASC"
       end
 
       # Returns true if the passed attribute is sortable.
@@ -66,8 +61,6 @@ module DryCrud
         model_class.column_names.include?(attr.to_s) ||
         sort_mappings_with_indifferent_access.include?(attr))
       end
-
     end
-
   end
 end