crudable-rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c3bce80de66d640b96222a505af0357771fe9657d14ae853649bbdf7c78778bc
+  data.tar.gz: 435d8c280e42996182578d23065d2905ca39aa6608e324b410eac295933a33aa
+SHA512:
+  metadata.gz: be090adbbbf6dce74144fa5c5ee435fb17f85dc674505ab4244101db8bbdb35cb634a8da2e662f76e83dca14d0b411effbcad0dafa263ca98c1c044e0f1e84f6
+  data.tar.gz: 1175cca36ec335d808dbe2f7740efd2e9c6043b58b7cf45a7fbe753f0e315b7873a44fbf9ee56256766157468a4b92855a48c44ce8f1c7001bf66959efe3b104

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 Tomislav Simnett
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, 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.

data/README.md

@@ -0,0 +1,28 @@
+# Crudable
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "crudable"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install crudable
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/config/locales/en.yml

@@ -0,0 +1,6 @@
+en:
+  crudable:
+    created: "%{model_name} successfully created"
+    updated: "%{model_name} successfully updated"
+    destroyed: "%{model_name} successfully destroyed"
+    not_destroyed: "%{model_name} could not be destroyed"

data/lib/crudable/rails/base.rb

@@ -0,0 +1,214 @@
+# frozen_string_literal: true
+
+module Crudable
+  module Rails
+    module Base
+      extend ActiveSupport::Concern
+
+      included do
+        include Crudable::Rails::Resourceable
+
+        before_action :find_resource, only: %i[show edit update destroy]
+        after_action :authorize_resource, only: %i[new show edit] if defined?(Pundit)
+
+        decorates_assigned plural_resource_var_name.to_sym, resource_var_name.to_sym if defined?(Draper)
+      end
+
+      def index
+        instance_variable_set("@#{plural_resource_var_name}", resource_scope)
+        paginate_resource
+      end
+
+      def show; end
+
+      def new
+        instance_variable_set("@#{resource_var_name}", resource_class.new)
+      end
+
+      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 instance_variable_get("@#{resource_var_name}").save
+          on_successful_create
+          on_successful_create_render
+        else
+          on_failed_create_setup
+          on_failed_create_render
+        end
+      end
+
+      def edit; end
+
+      def update
+        before_authorize_update
+        authorize_resource
+        after_authorize_update
+        if instance_variable_get("@#{resource_var_name}").update update_params
+          on_successful_update
+          on_successful_update_render
+        else
+          on_failed_update_setup
+          on_failed_update_render
+        end
+      end
+
+      def destroy
+        authorize_resource(destroy_method)
+        if instance_variable_get("@#{resource_var_name}").send(destroy_method)
+          on_successful_destroy_render
+        else
+          on_failed_destroy_render
+        end
+      end
+
+      private
+
+      def destroy_method
+        return :destroy unless defined?(Discard)
+        return :destroy if params[:destroy]
+
+        @destroy_method ||= discard? && !instance_variable_get("@#{resource_var_name}").discarded? ? :discard : :destroy
+      end
+
+      def discard?
+        false
+      end
+
+      def find_resource
+        resource = friendly_finders? ? resource_class.friendly : resource_class
+        instance = singleton? ? resource.first : resource.find(params[finder_param])
+
+        return redirect_to (resource_namespace + [instance]), status: :moved_permanently if should_redirect?(instance)
+
+        instance_variable_set("@#{resource_var_name}", instance)
+      end
+
+      def should_redirect?(instance)
+        friendly_finders? && request.path != polymorphic_path(resource_namespace + [instance])
+      end
+
+      def singleton?
+        false
+      end
+
+      def finder_param
+        :id
+      end
+
+      def resource_scope
+        return apply_scopes(authorizable_scope) if defined?(HasScope)
+
+        authorizable_scope
+      end
+
+      def authorizable_scope
+        defined?(Pundit) ? policy_scope(resource_class) : resource_class.all
+      end
+
+      def paginate_resource?
+        return false unless defined?(Kaminari)
+
+        true
+      end
+
+      def friendly_finders?
+        return false unless defined?(FriendlyId) && object_class.respond_to?(:friendly)
+
+        true
+      end
+
+      def skip_initialize_create?
+        false
+      end
+
+      def paginate_resource
+        return unless paginate_resource?
+
+        instance_variable_set(
+          "@#{plural_resource_var_name}",
+          instance_variable_get("@#{plural_resource_var_name}").page(params[:page]).per(params[:per])
+        )
+      end
+
+      def after_create_redirect_path
+        resource_namespace + [plural_resource_var_name.to_sym]
+      end
+
+      def after_create_notice
+        t('crudable.created', model_name: resource_class.model_name.human)
+      end
+
+      def after_update_redirect_path
+        resource_namespace + [instance_variable_get("@#{resource_var_name}")]
+      end
+
+      def after_update_notice
+        t('crudable.updated', model_name: resource_class.model_name.human)
+      end
+
+      def after_destroy_redirect_path
+        resource_namespace + [plural_resource_var_name.to_sym]
+      end
+
+      def after_failed_destroy_redirect_path
+        after_destroy_redirect_path
+      end
+
+      def after_destroy_notice
+        t('crudable.destroyed', model_name: resource_class.model_name.human)
+      end
+
+      def after_failed_destroy_alert
+        t('crudable.not_destroyed', model_name: resource_class.model_name.human)
+      end
+
+      def on_successful_create; end
+
+      def on_successful_create_render
+        redirect_to after_create_redirect_path, success: after_create_notice
+      end
+
+      def on_failed_create_setup; end
+
+      def on_successful_update; end
+
+      def on_successful_update_render
+        redirect_to after_update_redirect_path, success: after_update_notice
+      end
+
+      def on_failed_update_setup; end
+
+      def on_successful_destroy_render
+        redirect_to after_destroy_redirect_path, success: after_destroy_notice
+      end
+
+      def on_failed_destroy_render
+        redirect_to after_failed_destroy_redirect_path, alert: after_failed_destroy_alert
+      end
+
+      def before_authorize_create; end
+
+      def before_authorize_update; end
+
+      def after_authorize_create; end
+
+      def after_authorize_update; end
+
+      def on_failed_create_render
+        respond_to do |format|
+          format.turbo_stream
+          format.html { render :new, status: :unprocessable_entity }
+        end
+      end
+
+      def on_failed_update_render
+        respond_to do |format|
+          format.turbo_stream
+          format.html { render :edit, status: :unprocessable_entity }
+        end
+      end
+    end
+  end
+end

data/lib/crudable/rails/controller.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Crudable
+  module Rails
+    # Include Crudable Controller Class Methods
+    module Controller
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def crudable(nested: false)
+          include Crudable::Rails::Base
+          include Crudable::Rails::Nestable if nested
+        end
+      end
+    end
+  end
+end

data/lib/crudable/rails/engine.rb

@@ -0,0 +1,9 @@
+module Crudable
+  module Rails
+    class Engine < ::Rails::Engine
+      ActiveSupport.on_load(:action_controller) do
+        ::ActionController::Base.include Crudable::Rails::Controller
+      end
+    end
+  end
+end

data/lib/crudable/rails/nestable.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Crudable
+  module Rails
+    # Nestable Module
+    module Nestable
+      extend ActiveSupport::Concern
+
+      included do
+        before_action :find_parent, only: %i[index new create]
+      end
+
+      def find_parent
+        params.each do |name, value|
+          next unless name =~ /(.+)_id$/
+
+          object_name = Regexp.last_match(1)
+          object_scope = object_name.classify.constantize
+          object_scope = object_class.friendly if friendly_finders?
+          instance_variable_set("@#{object_name}", object_scope.find(value))
+          self.class.send(:decorates_assigned, object_name.to_sym) if defined?(Draper)
+        end
+      end
+    end
+  end
+end

data/lib/crudable/rails/resourceable.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Crudable
+  module Rails
+    # Resourceable
+    #
+    # Provides a number of resource helpers for controllers supporting Crudable
+    module Resourceable
+      extend ActiveSupport::Concern
+
+      def resource_name
+        self.class.name.split('::').last.gsub('Controller', '').singularize
+      end
+
+      def resource_human_name
+        resource_name.humanize
+      end
+
+      def resource_class
+        resource_name.constantize
+      end
+
+      def resource_var_name
+        resource_name.underscore
+      end
+
+      def plural_resource_var_name
+        resource_name.pluralize.underscore
+      end
+
+      def resource_namespace
+        namespaces = self.class.name.split('::')
+        namespaces.pop
+        namespaces.map { |n| n.downcase.to_sym }
+      end
+
+      def authorize_resource(method = action_name)
+        authorize authorizable_resource, "#{method}?".to_sym
+      end
+
+      def authorizable_resource
+        instance_variable_get("@#{resource_var_name}")
+      end
+
+      class_methods do
+        def resource_name
+          name.split('::').last.gsub('Controller', '').singularize
+        end
+
+        def resource_class
+          resource_name.constantize
+        end
+
+        def resource_var_name
+          resource_name.underscore
+        end
+
+        def plural_resource_var_name
+          resource_name.pluralize.underscore
+        end
+
+        def resource_namespace
+          namespaces = name.split('::')
+          namespaces.pop
+          namespaces.map { |n| n.downcase.to_sym }
+        end
+      end
+    end
+  end
+end

data/lib/crudable/rails/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Crudable Version
+module Crudable
+  module Rails
+    VERSION = '1.0.0'
+  end
+end

data/lib/crudable-rails.rb

@@ -0,0 +1,12 @@
+require 'crudable/rails/version'
+require 'crudable/rails/engine'
+require 'crudable/rails/controller'
+require 'crudable/rails/base'
+require 'crudable/rails/resourceable'
+require 'crudable/rails/nestable'
+
+module Crudable
+  module Rails
+    # Your code goes here...
+  end
+end

data/lib/tasks/crudable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :crudable do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: crudable-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tomislav Simnett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.50'
+description: CRUD operations for Rails controllers
+email:
+- tom@initforthe.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- config/locales/en.yml
+- lib/crudable-rails.rb
+- lib/crudable/rails/base.rb
+- lib/crudable/rails/controller.rb
+- lib/crudable/rails/engine.rb
+- lib/crudable/rails/nestable.rb
+- lib/crudable/rails/resourceable.rb
+- lib/crudable/rails/version.rb
+- lib/tasks/crudable_tasks.rake
+homepage: https://gitlab.com/initforthe/crudable-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: CRUD operations for Rails controllers
+test_files: []