dry_crud 3.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 664cf77c042838728de2d0abb74525808c496448
-  data.tar.gz: e12c82079d72d2f414cef3181d2fcd14e9f72552
+  metadata.gz: cd475eb483f54acdff9dff23ae75d80715edfcdb
+  data.tar.gz: 7ba54fb2d5a22f562627fd0641f23e2a32a975ee
 SHA512:
-  metadata.gz: fb4bd2d805c8bc9a0dfa4a3eb3cf25758d70abcde034b9380d6e181bb1a8918420be98c326d036926d30c92b56fe0a7d02d5232e30a0a72b704cc02d2c9fa660
-  data.tar.gz: 5851c097e6904e68f7abaec88d5c0bec6c651de07e482737f667dd7832f976a9bb5b390900669910e945e5fc33afae27359735f1ae3c2420f7f0309902135821
+  metadata.gz: 38e784965cdb8dc622b659437fa6cb2e4be27eb3eb17b3c1686a5ec6cdfded184fb08fb10a533ff6d7f9e14331045b111aadbde8a371d6c59272462c589839e6
+  data.tar.gz: e0b78f3534243dd715cb53c6ddbfc547f236e90e84ee6a7439e392a4d0b837f17fd2a7e9e5a24fb1b885611aaf44f7c2dca47ac388256279559cd5b212e24699

data/README.rdoc

@@ -33,7 +33,7 @@ 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 3.0, only the latest released Rails version will be supported, which currently is 4.2. Version 2.0 and higher are compatible with Rails 4 and Rails 3.2. dry_crud is tested with Ruby 1.9.3, 2.1.5 and JRuby. If you are using Ruby 1.8.7, please refer to version 1.7.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. 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.2.5 and JRuby. If you are using Ruby 1.9.3, please refer to version 3.0.0.
 
 
 == Background

data/VERSION

@@ -1 +1 @@
-3.0.0
+5.0.0

data/app/controllers/crud_controller.rb

@@ -22,8 +22,6 @@ class CrudController < ListController
   # further down.
   define_render_callbacks :show, :new, :edit
 
-  hide_action :run_callbacks
-
   before_action :entry, only: [:show, :new, :edit, :update, :destroy]
 
   helper_method :entry, :full_entry_label
@@ -57,12 +55,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 create(options = {}, &block)
+  def create(options = {}, &_block)
     assign_attributes
     created = with_callbacks(:create, :save) { entry.save }
 
     respond_to do |format|
-      block.call(format, created) if block_given?
+      yield(format, created) if block_given?
       if created
         format.html { redirect_on_success(options) }
         format.json { render :show, status: :created, location: show_path }
@@ -91,12 +89,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)
     assign_attributes
     updated = with_callbacks(:update, :save) { entry.save }
 
     respond_to do |format|
-      block.call(format, updated) if block_given?
+      yield(format, updated) if block_given?
       if updated
         format.html { redirect_on_success(options) }
         format.json { render :show, status: :ok, location: show_path }
@@ -119,11 +117,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)
     destroyed = run_callbacks(:destroy) { entry.destroy }
 
     respond_to do |format|
-      block.call(format, destroyed) if block_given?
+      yield(format, destroyed) if block_given?
       if destroyed
         format.html { redirect_on_success(options) }
         format.json { head :no_content }
@@ -204,13 +202,17 @@ class CrudController < ListController
 
   # 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
+    # rubocop:enable Rails/OutputSafety
   end
 
   # Html safe error messages of the current entry.
   def error_messages
+    # rubocop:disable Rails/OutputSafety
     escaped = entry.errors.full_messages.map { |m| ERB::Util.html_escape(m) }
     escaped.join('<br/>').html_safe
+    # rubocop:enable Rails/OutputSafety
   end
 
   # Class methods for CrudActions.

data/app/controllers/dry_crud/generic_model.rb

@@ -1,6 +1,7 @@
 # encoding: UTF-8
 
 module DryCrud
+
   # Connects the including controller to the model whose name corrsponds to
   # the controller's name.
   #
@@ -8,6 +9,7 @@ module DryCrud
   # Additional helper methods store and retrieve values in instance variables
   # named after their class.
   module GenericModel
+
     extend ActiveSupport::Concern
 
     included do
@@ -18,8 +20,6 @@ module DryCrud
       delegate :model_class, :models_label, :model_identifier, to: 'self.class'
     end
 
-    private
-
     # The scope where model entries will be listed and created.
     # This is mainly used for nested models to provide the
     # required context.
@@ -38,7 +38,8 @@ module DryCrud
     def model_ivar_get(plural = false)
       name = ivar_name(model_class)
       name = name.pluralize if plural
-      instance_variable_get(:"@#{name}")
+      name = :"@#{name}"
+      instance_variable_get(name) if instance_variable_defined?(name)
     end
 
     # Sets an instance variable with the underscored class name if the given
@@ -60,6 +61,7 @@ module DryCrud
 
     # Class methods from GenericModel.
     module ClassMethods
+
       # The ActiveRecord class of the model.
       def model_class
         @model_class ||= controller_name.classify.constantize
@@ -79,7 +81,7 @@ module DryCrud
 
         model_class.model_name.human(opts)
       end
-    end
 
+    end
   end
 end

data/app/controllers/dry_crud/nestable.rb

@@ -1,6 +1,7 @@
 # encoding: UTF-8
 
 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.
@@ -9,24 +10,20 @@ module DryCrud
   # namespace, may define this attribute as follows:
   #   self.nesting = :admin, Country
   module Nestable
-    extend ActiveSupport::Concern
 
     # Adds the :nesting class attribute and parent helper methods
     # to the including controller.
-    included do
-      class_attribute :nesting
-
-      helper_method :parent, :parents
+    def self.prepended(klass)
+      klass.class_attribute :nesting
 
-      alias_method_chain :path_args, :nesting
-      alias_method_chain :model_scope, :nesting
+      klass.helper_method :parent, :parents
     end
 
     private
 
     # Returns the direct parent ActiveRecord of the current request, if any.
     def parent
-      parents.select { |p| p.is_a?(ActiveRecord::Base) }.last
+      parents.reverse.find { |p| p.is_a?(ActiveRecord::Base) }
     end
 
     # Returns the parent entries of the current request, if any.
@@ -49,16 +46,16 @@ module DryCrud
     end
 
     # An array of objects used in url_for and related functions.
-    def path_args_with_nesting(last)
+    def path_args(last)
       parents + [last]
     end
 
     # Uses the parent entry (if any) to constrain the model scope.
-    def model_scope_with_nesting
+    def model_scope
       if parent.present?
         parent_scope
       else
-        model_scope_without_nesting
+        super
       end
     end
 
@@ -66,5 +63,6 @@ module DryCrud
     def parent_scope
       parent.send(model_class.name.underscore.pluralize)
     end
+
   end
 end

data/app/controllers/dry_crud/rememberable.rb

@@ -1,6 +1,7 @@
 # encoding: UTF-8
 
 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
@@ -12,13 +13,14 @@ 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_filter :handle_remember_params, only: [:index]
+      before_action :handle_remember_params, only: [:index]
     end
 
     private
@@ -53,6 +55,7 @@ module DryCrud
     def remembered_params
       session[:list_params] ||= {}
       session[:list_params][remember_key] ||= {}
+      session[:list_params][remember_key]
     end
 
     # Params are stored by request path to play nice when a controller
@@ -60,5 +63,6 @@ module DryCrud
     def remember_key
       request.path
     end
+
   end
 end

data/app/controllers/dry_crud/render_callbacks.rb

@@ -1,46 +1,67 @@
 # encoding: UTF-8
 
 module DryCrud
+
   # Provide +before_render+ callbacks.
   module RenderCallbacks
+
     extend ActiveSupport::Concern
 
     included do
       extend ActiveModel::Callbacks
-
-      alias_method_chain :render, :callbacks
+      prepend Prepends
     end
 
-    # Helper method to run +before_render+ callbacks and render the action.
-    # If a callback renders or redirects, the action is not rendered.
-    def render_with_callbacks(*args, &block)
-      options = _normalize_render(*args, &block)
-      callback = "render_#{options[:template]}"
+    # Prepended methods for callbacks.
+    module Prepends
 
-      run_callbacks(callback) if respond_to?(:"_#{callback}_callbacks", true)
+      # 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]}"
 
-      render_without_callbacks(*args, &block) unless performed?
-    end
+        run_callbacks(callback) if respond_to?(:"_#{callback}_callbacks", true)
+
+        super(*args, &block) unless performed?
+      end
+
+      private
 
-    private
+      # Helper method the run the given block in between the before and after
+      # callbacks of the given kinds.
+      def with_callbacks(*kinds, &block)
+        kinds.reverse.reduce(block) do |a, e|
+          -> { run_callbacks(e, &a) }
+        end.call
+      end
 
-    # Helper method the run the given block in between the before and after
-    # callbacks of the given kinds.
-    def with_callbacks(*kinds, &block)
-      kinds.reverse.reduce(block) do |a, e|
-        -> { run_callbacks(e, &a) }
-      end.call
     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}" }
-        terminator = ->(ctrl, result) { result == false || ctrl.performed? }
-        args << { only: :before, terminator: terminator }
+        args << { only: :before, terminator: render_callback_terminator }
         define_model_callbacks(*args)
       end
+
+      private
+
+      def render_callback_terminator
+        proc do |ctrl, result_lambda|
+          terminate = true
+          catch(:abort) do
+            result_lambda.call if result_lambda.is_a?(Proc)
+            terminate = !ctrl.response_body.nil?
+          end
+          terminate
+        end
+      end
+
     end
+
   end
 end

data/app/controllers/dry_crud/searchable.rb

@@ -1,10 +1,12 @@
 # encoding: UTF-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
@@ -13,49 +15,55 @@ module DryCrud
 
       helper_method :search_support?
 
-      alias_method_chain :list_entries, :search
+      prepend Prepends
     end
 
-    private
+    # Prepended methods for searching.
+    module Prepends
 
-    # Enhance the list entries with an optional search criteria
-    def list_entries_with_search
-      list_entries_without_search.where(search_conditions)
-    end
+      private
+
+      # Enhance the list entries with an optional search criteria
+      def list_entries
+        super.where(search_conditions)
+      end
 
-    # Concat the word clauses with AND.
-    def search_conditions
-      if search_support? && params[:q].present?
-        search_word_conditions.reduce do |query, condition|
-          query.and(condition)
+      # Concat the word clauses with AND.
+      def search_conditions
+        if search_support? && params[:q].present?
+          search_word_conditions.reduce do |query, condition|
+            query.and(condition)
+          end
         end
       end
-    end
 
-    # Split the search query in single words and create a list of word clauses.
-    def search_word_conditions
-      params[:q].split(/\s+/).map { |w| search_word_condition(w) }
-    end
+      # Split the search query in single words and create a list of word
+      # clauses.
+      def search_word_conditions
+        params[:q].split(/\s+/).map { |w| search_word_condition(w) }
+      end
 
-    # Concat the column queries of the given word with OR.
-    def search_word_condition(word)
-      search_column_condition(word).reduce do |query, condition|
-        query.or(condition)
+      # Concat the column queries of the given word with OR.
+      def search_word_condition(word)
+        search_column_condition(word).reduce do |query, condition|
+          query.or(condition)
+        end
+      end
+
+      # Create a list of Arel #matches queries for each column and the given
+      # word.
+      def search_column_condition(word)
+        self.class.search_tables_and_fields.map do |table_name, field|
+          table = Arel::Table.new(table_name)
+          table[field].matches(Arel::Nodes::Quoted.new("%#{word}%"))
+        end
       end
-    end
 
-    # Create a list of Arel #matches queries for each column and the given
-    # word.
-    def search_column_condition(word)
-      self.class.search_tables_and_fields.map do |table_name, field|
-        table = Arel::Table.new(table_name)
-        table[field].matches("%#{word}%")
+      # Returns true if this controller has searchable columns.
+      def search_support?
+        search_columns.present?
       end
-    end
 
-    # Returns true if this controller has searchable columns.
-    def search_support?
-      search_columns.present?
     end
 
     # Class methods for Searchable.
@@ -71,6 +79,7 @@ module DryCrud
           end
         end
       end
+
     end
 
   end

data/app/controllers/dry_crud/sortable.rb

@@ -1,10 +1,12 @@
 # encoding: UTF-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
@@ -15,11 +17,12 @@ module DryCrud
 
       helper_method :sortable?
 
-      alias_method_chain :list_entries, :sort
+      prepend Prepends
     end
 
     # 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
@@ -28,38 +31,45 @@ module DryCrud
         self.sort_mappings_with_indifferent_access =
           hash.with_indifferent_access
       end
+
     end
 
-    private
+    # Prepended methods for sorting.
+    module Prepends
 
-    # Enhance the list entries with an optional sort order.
-    def list_entries_with_sort
-      sortable = sortable?(params[:sort])
-      if sortable || default_sort
-        clause = [sortable ? sort_expression : nil, default_sort]
-        list_entries_without_sort.reorder(clause.compact.join(', '))
-      else
-        list_entries_without_sort
+      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(clause.compact.join(', '))
+        else
+          super
+        end
       end
-    end
 
-    # Return the sort expression to be used in the list query.
-    def sort_expression
-      col = sort_mappings_with_indifferent_access[params[:sort]] ||
-            "#{model_class.table_name}.#{params[:sort]}"
-      "#{col} #{sort_dir}"
-    end
+      # Return the sort expression to be used in the list query.
+      def sort_expression
+        col = sort_mappings_with_indifferent_access[params[:sort]] ||
+              "#{model_class.table_name}.#{params[:sort]}"
+        "#{col} #{sort_dir}"
+      end
 
-    # The sort direction, either 'asc' or 'desc'.
-    def sort_dir
-      params[:sort_dir] == 'desc' ? 'DESC' : 'ASC'
-    end
+      # The sort direction, either 'asc' or 'desc'.
+      def sort_dir
+        params[:sort_dir] == 'desc' ? 'DESC' : 'ASC'
+      end
+
+      # Returns true if the passed attribute is sortable.
+      def sortable?(attr)
+        attr.present? && (
+        model_class.column_names.include?(attr.to_s) ||
+        sort_mappings_with_indifferent_access.include?(attr))
+      end
 
-    # Returns true if the passed attribute is sortable.
-    def sortable?(attr)
-      attr.present? && (
-      model_class.column_names.include?(attr.to_s) ||
-      sort_mappings_with_indifferent_access.include?(attr))
     end
+
   end
 end