auxiliary_rails_resourceable 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4626f97cfe6bb22a70da7b258f5fe4f742f34f2b1584c76fb032125969f35cbb
-  data.tar.gz: b08f4f1a0dcdb4a2a01c9ced689032c176ed843a63301686534590712ed38760
+  metadata.gz: 0cccc3798217d2f3f64d9250d46a5797ca20e4d7aba351d36d6c9ae938d0ce22
+  data.tar.gz: f014a530c24a038df4b312336c81e3beb5e510eebc6dc6449d43c6cc2080ea46
 SHA512:
-  metadata.gz: 7138e711032c8cbb19a8542770f30aab514b2646069d2a5a71a4315b992d5e4f246e7f7dabc63560dbf9acfafd6f3c6819e19e944a625c6cdd8fa784d39c993e
-  data.tar.gz: 68cf0c091e8a4b95661b51abf4f39d4e00faca9ee3030e5ea0cd361c03d6e7a599ded540e0e131255ec019a21584bd6e3fcb15bdce51d602b8b9b5f81030b3d4
+  metadata.gz: 312ac5eaea723c5ddce906ebe9e50d0a8cbd7572b007f4798ec2178d5fc831ab39e6acbff4d85fd0a616b6574c6c03b593e2e8371cf635492a26992eceb2aab2
+  data.tar.gz: 76ad31ecd517a89bab159b0c1e672cf9ff2fc3e08669399f4074808624de8519904d4de54ca5c66d18e53d5e15df2b7944c7ad9b8cb129e7b80658788c139f20

data/.rubocop.yml

@@ -4,8 +4,15 @@ require:
   - rubocop-rspec
 
 AllCops:
+  Exclude:
+    - bin/bundle
+    - bin/rake
+    - bin/rspec
+    - bin/rubocop
+    - vendor/**/* # fix for CI
   TargetRubyVersion: 2.5
   NewCops: enable
+
 #################### Layout ##############################
 
 Layout/ArgumentAlignment:

data/CHANGELOG.md

@@ -1,5 +1,7 @@
 ## [Unreleased]
 
+## [0.1.1] - 2022-08-27
+
 ## [0.1.0] - 2022-08-20
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    auxiliary_rails_resourceable (0.1.0)
+    auxiliary_rails_resourceable (0.1.1)
       pagy
       pundit
       rails (>= 5.2)

data/README.md

@@ -1,5 +1,7 @@
 # AuxiliaryRailsResourceable
 
+[![Gem](https://img.shields.io/gem/v/auxiliary_rails_resourceable.svg)](https://rubygems.org/gems/auxiliary_rails_resourceable)
+
 ## Installation
 
 Add this line to your application's `Gemfile`:
@@ -31,8 +33,8 @@ end
 # - show.html.erb
 # - edit.html.erb
 # - _form.html.erb
-# - _search_form.html.erb
 # - _list.html.erb
+# - _search_form.html.erb
 
 # /config/locales/resources.en.yml
 en:

data/lib/auxiliary_rails/concerns/resourceable.rb

@@ -10,7 +10,7 @@ module AuxiliaryRails
         before_action only: %i[index new] do
           authorize resource_class
         end
-        before_action :resource, only: %i[show edit destroy] do
+        before_action :resource, only: %i[show edit] do
           authorize resource
         end
 
@@ -27,9 +27,9 @@ module AuxiliaryRails
       end
 
       def index
-        @q = collection.ransack(params[:q])
-        @q.sorts = default_sorts if @q.sorts.empty?
-        @pagy, @pagy_records = pagy(@q.result(distinct: true))
+        @ransack = collection.ransack(search_params)
+        @ransack.sorts = default_sorts if @ransack.sorts.empty?
+        @pagy, self.collection = pagy(@ransack.result)
       end
 
       def new
@@ -37,14 +37,8 @@ module AuxiliaryRails
       end
 
       def create
-        self.resource = build_resource(resource_params)
-
-        authorize resource
-
-        if resource.save
-          redirect_to resource_path(resource),
-            notice: t('resources.create.notice',
-              resource_name: resource_class.model_name.human)
+        if create_resource(resource_params)
+          redirect_after_create
         else
           render :new
         end
@@ -57,56 +51,95 @@ module AuxiliaryRails
       end
 
       def update
-        resource.assign_attributes(resource_params)
-
-        authorize resource
-
-        if resource.save
-          redirect_to resource_path(resource),
-            notice: t('resources.update.notice',
-              resource_name: resource_class.model_name.human)
+        if update_resource(resource_params)
+          redirect_after_update
         else
           render :edit
         end
       end
 
       def destroy
-        resource.destroy
+        destroy_resource
 
-        redirect_to collection_path,
-          notice: t('resources.destroy.notice',
-            resource_name: resource_class.model_name.human)
+        redirect_after_destroy
       end
 
       protected
 
-      # config
+      # configs
 
       def default_sorts
-        ['id asc']
+        %w[name title id].find { |v| v.in?(resource_class.column_names) } || []
+      end
+
+      # Defines an I18n scope for flash messages
+      #
+      # Use `controller_name` for scoping as the name of the controller.
+      def i18n_scope
+        :resources
       end
 
       def id_param
         params[:id]
       end
 
+      def search_params
+        params[:q]
+      end
+
       def collection_name
         @collection_name ||= controller_name
       end
 
+      def collection_scope
+        policy_scope(resource_class).all
+      end
+
       def resource_class
         @resource_class ||= resource_name.camelize.constantize
       end
 
       def resource_name
-        @resource_name ||= controller_name.singularize
+        @resource_name ||= collection_name.singularize
+      end
+
+      # actions
+
+      def build_resource(attributes = {})
+        resource_class.new(attributes)
+      end
+
+      def create_resource(attributes = {})
+        self.resource = build_resource(attributes)
+
+        authorize resource, :create?
+
+        resource.save
+      end
+
+      def find_resource
+        resource_class.find(id_param)
+      end
+
+      def update_resource(attributes = {})
+        resource.assign_attributes(attributes)
+
+        authorize resource, :update?
+
+        resource.save
+      end
+
+      def destroy_resource
+        authorize resource, :destroy?
+
+        resource.destroy
       end
 
       # helpers
 
       def collection
         instance_variable_get("@#{collection_name}") ||
-          (self.collection = resource_scope)
+          (self.collection = collection_scope)
       end
 
       def collection=(object)
@@ -128,18 +161,6 @@ module AuxiliaryRails
           .permit(policy(resource_class).permitted_attributes)
       end
 
-      def resource_scope
-        policy_scope(resource_class.all)
-      end
-
-      def build_resource(attributes = {})
-        resource_class.new(attributes)
-      end
-
-      def find_resource
-        resource_class.find(id_param)
-      end
-
       def collection_path
         public_send(path_method_name(:collection))
       end
@@ -152,35 +173,47 @@ module AuxiliaryRails
         public_send(path_method_name(:resource, :new))
       end
 
+      # redirects
+
+      def redirect_after_create
+        redirect_to resource_path(resource),
+          notice: t('create.notice',
+            resource_name: resource_class.model_name.human,
+            scope: i18n_scope)
+      end
+
+      def redirect_after_update
+        redirect_to resource_path(resource),
+          notice: t('update.notice',
+            resource_name: resource_class.model_name.human,
+            scope: i18n_scope)
+      end
+
+      def redirect_after_destroy
+        redirect_to collection_path,
+          notice: t('destroy.notice',
+            resource_name: resource_class.model_name.human,
+            scope: i18n_scope)
+      end
+
       # system
 
-      def controller_module_parent
+      def controller_module_parent_name
         if Rails.version < '6'
-          raise NotImplementedError,
-            '`controller_module_parent` needs to be implented because ' \
-              'Rails < 6 does not supports `module_parent`'
+          return self.class.parent_name
         end
 
-        self.class.module_parent
+        self.class.module_parent_name
       end
 
-      # rubocop:disable Metrics/MethodLength
       def path_method_name(type, action = nil)
-        path_parts = [
-          'path',
-          (type.to_sym == :resource ? resource_name : controller_name)
-        ]
-
-        if controller_module_parent != Object
-          path_parts << controller_module_parent.to_s.underscore
-        end
-        if action.present?
-          path_parts << action
-        end
-
-        path_parts.reverse.join('_')
+        [
+          action,
+          controller_module_parent_name&.underscore,
+          (type.to_sym == :resource ? resource_name : controller_name),
+          'path'
+        ].compact.join('_')
       end
-      # rubocop:enable Metrics/MethodLength
     end
   end
 end

data/lib/auxiliary_rails_resourceable/version.rb

@@ -1,3 +1,3 @@
 module AuxiliaryRailsResourceable
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: auxiliary_rails_resourceable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dmitry Babenko
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-20 00:00:00.000000000 Z
+date: 2022-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pagy