crudable-rails 1.1.0 → 1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4df342f4a146959d7105623ff9e8f1874111a5c4873f8320db55ebd38adf110b
-  data.tar.gz: 6ee3eac43181b657e960b993097100095339fe8f087fe2444781fea85112df56
+  metadata.gz: 99f925a26ed45caef1bc7192a910d67de0d25c6e8129dce513b16d828b96b500
+  data.tar.gz: 9c32e8484c889fd27dbbdae01c6da7eecfd40a10bc444219fdb763c689961e50
 SHA512:
-  metadata.gz: 54f5a65182975013cf1a561dd97ca54180220ae98bbf9764c1c805aa64996e48d7e3d0c17f91e65fe8b2f9ee729da94272ac9191ab9afbaed5f0847e2168071b
-  data.tar.gz: fe602265e19c2f9cc5186851ea4723f6078021a038d9576ab8775f55d25ea75041f7b740967a223123dac72edc3a82cf510d44ace36e7cf2d3d537ad671dcfba
+  metadata.gz: 3fddb792095a0eb01d247b64e4ce00fc5a89db2b98b12686eb17a4860667e9ee036ddfad4fc3cb01cc6467e96665c046adc6883386c6c613dc3496a15a614b9d
+  data.tar.gz: 14e0083dd324cf14aa527bcc08e604d9bf5cab4c9ccbb753a7360a3670a39f43aaa672860a00a54aa11253848c8dbe9a74f6811496fe957546075498e33126fa

data/README.md

@@ -1,28 +1,186 @@
-# Crudable
-Short description and motivation.
+# Crudable Rails
 
-## Usage
-How to use my plugin.
+`crudable-rails` is a Ruby on Rails gem that provides a set of helpers and modules to simplify the implementation of CRUD operations in Rails controllers.
+
+It uses the following gems to enhance the functionality:
+
+- `Pundit` for authorization
+- `Kaminari` for pagination
+- `FriendlyId` for friendly finders
+- `HasScope` for filtering
+- `Discard` for soft deletion
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "crudable"
+gem "crudable-rails"
 ```
 
 And then execute:
+
 ```bash
-$ bundle
+$ bundle install
 ```
 
 Or install it yourself as:
+
 ```bash
-$ gem install crudable
+$ gem install crudable-rails
+```
+
+## Usage
+
+### Controller Setup
+
+To use crudable-rails in your controllers, call the `crudable` method. You can also specify if the controller is nested by passing the `nested: true` option.
+
+```ruby
+class ProductsController < ApplicationController
+  crudable
+end
+
+class ProductSizesController < ApplicationController
+  crudable nested: true
+end
+```
+
+## Customizing CRUD Actions
+
+You can override the default behavior of CRUD actions by defining the following methods in your controller:
+
+- `before_authorize_create`
+- `after_authorize_create`
+- `on_successful_create`
+- `on_successful_create_render`
+- `on_failed_create_setup`
+- `on_failed_create_render`
+- `before_authorize_update`
+- `after_authorize_update`
+- `on_successful_update`
+- `on_successful_update_render`
+- `on_failed_update_setup`
+- `on_failed_update_render`
+- `on_successful_destroy_render`
+- `on_failed_destroy_render`
+
+For example:
+
+```ruby
+class ProductsController < ApplicationController
+  include Crudable::Rails::Controller
+
+  crudable
+
+  def on_successful_create
+    # Custom behavior on successful create
+  end
+
+  def on_failed_create_render
+    respond_to do |format|
+      format.html { render :new, status: :unprocessable_entity }
+    end
+  end
+end
+```
+
+By default, Turbo Streams are supported for create, update, and destroy actions. If Turbo Streams are not available, the gem will fallback to rendering HTML responses. If you require support for other formats, you can override the default behavior by defining the appropriate methods in your controller.
+
+### Required Private Methods
+
+### `permitted_params`
+
+This method should return the permitted parameters for the resource as an array. It's required to be defined on all controllers.
+
+### Optional Private Methods
+
+The following private methods are available for use in your controllers:
+
+### `after_create_redirect_path`
+
+This method should return the path to redirect to after a successful create. By default this will redirect to the namespaced index of the resource being created.
+
+### `after_create_notice`
+
+This method should return the notice to display after a successful create. By default this will return a success message via i18n.
+
+### `after_update_redirect_path`
+
+This method should return the path to redirect to after a successful update. By default this will redirect to the namespaced show path of the resource being updated.
+
+### `after_update_notice`
+
+This method should return the notice to display after a successful update. By default this will return a success message via i18n.
+
+### `after_destroy_redirect_path`
+
+This method should return the path to redirect to after a successful destroy. By default this will redirect to the namespaced index of the resource being destroyed.
+
+### `after_failed_destroy_redirect_path`
+
+This method should return the path to redirect to after a failed destroy. Default: `after_destroy_redirect_path`.
+
+### `after_destroy_notice`
+
+This method should return the notice to display after a successful destroy. By default this will return a success message via i18n.
+
+### `after_failed_destroy_alert`
+
+This method should return the alert to display after a failed destroy. By default this will return an error message via i18n.
+
+### `discard?`
+
+This method should return a boolean value to determine if the resource should be discarded. If it returns `false` the resource will be destroyed. Default: `false`.
+
+### `singleton?`
+
+This method should return a boolean value to determine if the resource is a singleton. Default: `false`.
+
+### `finder_param`
+
+This method should return the parameter used to find the resource. Default: `:id`.
+
+### `paginate_resource?`
+
+This method should return a boolean value to determine if the resource should be paginated. Default: `true` if Kaminari is available, otherwise `false`.
+
+### `friendly_finders?`
+
+This method should return a boolean value to determine if the resource should be found using friendly finders. Default: `true` if FriendlyId is available, otherwise `false`.
+
+### `skip_initialize_create?`
+
+This method should return a boolean value to determine if the resource should be initialized on create. Default: `false`.
+
+### `(create|update)_params`
+
+These methods should return the permitted parameters for the resource as an array. They are optional and can be defined if create and update methods need different parameters allowed.
+
+## Overriding `authorizable_resource` with a Namespace
+
+The `authorizable_resource` method can be overridden to customize the resource authorization logic, especially when dealing with namespaced resources. This method should return the resource that needs to be authorized.
+
+For example, if you have a namespaced controller:
+
+```ruby
+module Admin
+  class ProductsController < ApplicationController
+    crudable
+
+    private
+
+    def authorizable_resource
+      [:admin, @product]
+    end
+  end
+end
 ```
 
 ## Contributing
-Contribution directions go here.
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/your-username/crudable-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/crudable/rails/base.rb

@@ -27,9 +27,11 @@ module Crudable
 
       def create # rubocop:disable Metrics/MethodLength
         instance_variable_set("@#{resource_var_name}", resource_class.new(create_params)) unless skip_initialize_create?
-        before_authorize_create
-        authorize_resource
-        after_authorize_create
+        if defined?(Pundit)
+          before_authorize_create
+          authorize_resource
+          after_authorize_create
+        end
         if instance_variable_get("@#{resource_var_name}").save
           on_successful_create
           on_successful_create_render
@@ -42,9 +44,11 @@ module Crudable
       def edit; end
 
       def update
-        before_authorize_update
-        authorize_resource
-        after_authorize_update
+        if defined?(Pundit)
+          before_authorize_update
+          authorize_resource
+          after_authorize_update
+        end
         if instance_variable_get("@#{resource_var_name}").update update_params
           on_successful_update
           on_successful_update_render
@@ -55,10 +59,12 @@ module Crudable
       end
 
       def destroy
-        authorize_resource(destroy_method)
+        authorize_resource(destroy_method) if defined?(Pundit)
         if instance_variable_get("@#{resource_var_name}").send(destroy_method)
+          on_successful_destroy
           on_successful_destroy_render
         else
+          on_failed_destroy
           on_failed_destroy_render
         end
       end
@@ -164,28 +170,40 @@ module Crudable
         t('crudable.not_destroyed', model_name: resource_class.model_name.human)
       end
 
-      def on_successful_create; end
+      def on_successful_create
+        flash[:success] = after_create_notice
+      end
 
       def on_successful_create_render
-        redirect_to after_create_redirect_path, success: after_create_notice
+        redirect_to after_create_redirect_path
       end
 
       def on_failed_create_setup; end
 
-      def on_successful_update; end
+      def on_successful_update
+        flash[:success] = after_update_notice
+      end
 
       def on_successful_update_render
-        redirect_to after_update_redirect_path, success: after_update_notice
+        redirect_to after_update_redirect_path
       end
 
       def on_failed_update_setup; end
 
+      def on_successful_destroy
+        flash[:success] = after_destroy_notice
+      end
+
+      def on_failed_destroy
+        flash[:alert] = after_failed_destroy_alert
+      end
+
       def on_successful_destroy_render
-        redirect_to after_destroy_redirect_path, success: after_destroy_notice
+        redirect_to after_destroy_redirect_path
       end
 
       def on_failed_destroy_render
-        redirect_to after_failed_destroy_redirect_path, alert: after_failed_destroy_alert
+        redirect_to after_failed_destroy_redirect_path
       end
 
       def before_authorize_create; end
@@ -209,6 +227,22 @@ module Crudable
           format.html { render :edit, status: :unprocessable_entity }
         end
       end
+
+      def create_params
+        resource_params
+      end
+
+      def update_params
+        resource_params
+      end
+
+      def resource_params
+        params.require(resource_var_name).permit(*permitted_params)
+      end
+
+      def permitted_params
+        raise NotImplementedError, 'You must implement permitted_params in your controller'
+      end
     end
   end
 end

data/lib/crudable/rails/resourceable.rb

@@ -62,7 +62,7 @@ module Crudable
         def resource_namespace
           namespaces = name.split('::')
           namespaces.pop
-          namespaces.map { |n| n.downcase.to_sym }
+          namespaces.map { |n| n.underscore.to_sym }
         end
       end
     end

data/lib/crudable/rails/version.rb

@@ -3,6 +3,6 @@
 # Crudable Version
 module Crudable
   module Rails
-    VERSION = '1.1.0'
+    VERSION = '1.2'
   end
 end

data/lib/crudable-rails.rb

@@ -1,3 +1,5 @@
+require 'turbo-rails'
+
 require 'crudable/rails/version'
 require 'crudable/rails/engine'
 require 'crudable/rails/controller'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crudable-rails
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: '1.2'
 platform: ruby
 authors:
 - Tomislav Simnett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-14 00:00:00.000000000 Z
+date: 2024-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.50'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
 description: CRUD operations for Rails controllers
 email:
 - tom@initforthe.com