better_controller 0.1.0

data/lib/generators/better_controller/controller_generator.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module BetterController
+  module Generators
+    # Generator for creating a controller with BetterController
+    class ControllerGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('templates', __dir__)
+
+      argument :actions, type: :array, default: [], banner: 'action action'
+      class_option :skip_service, type: :boolean, default: false, desc: 'Skip generating a service'
+      class_option :skip_serializer, type: :boolean, default: false, desc: 'Skip generating a serializer'
+      class_option :model, type: :string, desc: 'Specify the model name (defaults to singular of controller name)'
+
+      def create_controller_file
+        template 'controller.rb', File.join('app/controllers', "#{file_name}_controller.rb")
+      end
+
+      def create_service_file
+        return if options[:skip_service]
+
+        template 'service.rb', File.join('app/services', "#{service_file_name}_service.rb")
+      end
+
+      def create_serializer_file
+        return if options[:skip_serializer]
+
+        template 'serializer.rb', File.join('app/serializers', "#{serializer_file_name}_serializer.rb")
+      end
+
+      private
+
+      def model_name
+        options[:model] || file_name.singularize
+      end
+
+      def service_file_name
+        model_name.underscore
+      end
+
+      def serializer_file_name
+        model_name.underscore
+      end
+
+      def model_class_name
+        model_name.camelize
+      end
+
+      def service_class_name
+        "#{model_class_name}Service"
+      end
+
+      def serializer_class_name
+        "#{model_class_name}Serializer"
+      end
+
+      def controller_actions
+        actions.map(&:to_sym)
+      end
+
+      def has_action?(action)
+        controller_actions.include?(action.to_sym) || controller_actions.empty?
+      end
+    end
+  end
+end

data/lib/generators/better_controller/install_generator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BetterController
+  module Generators
+    # Generator for installing BetterController
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      def create_initializer
+        template 'initializer.rb', 'config/initializers/better_controller.rb'
+      end
+
+      def mount_routes
+        route '# BetterController routes can be added here'
+      end
+
+      def show_readme
+        readme 'README' if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/better_controller/templates/README

@@ -0,0 +1,87 @@
+# BetterController
+
+BetterController has been successfully installed! 
+
+## Getting Started
+
+### Configuration
+
+An initializer has been created at `config/initializers/better_controller.rb`. 
+You can modify the configuration options to suit your needs.
+
+### Generating Controllers
+
+You can generate a controller with BetterController using the following command:
+
+```bash
+rails generate better_controller:controller Users index show create update destroy
+```
+
+This will create:
+- A UsersController with the specified actions
+- A UserService for handling business logic
+- A UserSerializer for serializing responses
+
+### Customizing Controllers
+
+You can customize the generated controllers by overriding the following methods:
+
+```ruby
+# Define the resource service class
+def resource_service_class
+  UserService
+end
+
+# Define the root key for resource parameters
+def resource_params_root_key
+  :user
+end
+
+# Define the resource serializer class
+def resource_serializer
+  UserSerializer
+end
+```
+
+### Using Services
+
+Services handle the business logic for your resources. You can customize them by overriding methods:
+
+```ruby
+# Define permitted attributes
+def permitted_attributes
+  [:name, :email, :password]
+end
+
+# Add custom validation
+def validate_create(attributes)
+  raise BetterController::Error.new("Email is required") if attributes[:email].blank?
+end
+```
+
+### Using Serializers
+
+Serializers define how your resources are presented in responses:
+
+```ruby
+# Define attributes to include
+attributes :id, :name, :email, :created_at
+
+# Define methods for calculated fields
+methods :full_name
+
+# Define associations to include
+has_many :posts
+belongs_to :company
+
+# Define a method that returns a calculated field
+def full_name
+  "#{object.first_name} #{object.last_name}"
+end
+```
+
+## Documentation
+
+For more information, please refer to the BetterController documentation.
+
+Happy coding!

data/lib/generators/better_controller/templates/controller.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+class <%= class_name %>Controller < ApplicationController
+  include BetterController::ResourcesController
+  
+<% if has_action?(:index) -%>
+  # GET /<%= file_name %>
+  def index
+    execute_action do
+      @resource_collection = resource_collection_resolver
+      data = serialize_resource(@resource_collection, index_serializer)
+      respond_with_success(data, options: { meta: meta })
+    end
+  end
+<% end -%>
+
+<% if has_action?(:show) -%>
+  # GET /<%= file_name %>/:id
+  def show
+    execute_action do
+      @resource = resource_resolver
+      data = serialize_resource(@resource, show_serializer)
+      respond_with_success(data)
+    end
+  end
+<% end -%>
+
+<% if has_action?(:create) -%>
+  # POST /<%= file_name %>
+  def create
+    execute_action do
+      @resource = resource_service.create(resource_params)
+      data = serialize_resource(@resource, create_serializer)
+      respond_with_success(data, status: :created)
+    end
+  end
+<% end -%>
+
+<% if has_action?(:update) -%>
+  # PATCH/PUT /<%= file_name %>/:id
+  def update
+    execute_action do
+      @resource = resource_resolver
+      resource_service.update(@resource, resource_params)
+      data = serialize_resource(@resource, update_serializer)
+      respond_with_success(data)
+    end
+  end
+<% end -%>
+
+<% if has_action?(:destroy) -%>
+  # DELETE /<%= file_name %>/:id
+  def destroy
+    execute_action do
+      @resource = resource_resolver
+      resource_service.destroy(@resource)
+      respond_with_success(nil, status: :no_content)
+    end
+  end
+<% end -%>
+
+  protected
+
+  # Define the resource service class
+  def resource_service_class
+    <%= service_class_name %>
+  end
+
+  # Define the root key for resource parameters
+  def resource_params_root_key
+    :<%= model_name.underscore %>
+  end
+
+  # Define the resource serializer class
+  def resource_serializer
+    <%= serializer_class_name %>
+  end
+end

data/lib/generators/better_controller/templates/initializer.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# BetterController Configuration
+BetterController.configure do |config|
+  # Pagination configuration
+  config[:pagination] = {
+    # Enable pagination for ResourcesController
+    enabled:  true,
+    # Default number of items per page
+    per_page: 25,
+  }
+
+  # Serialization configuration
+  config[:serialization] = {
+    # Include root key in JSON response
+    include_root:  false,
+    # Camelize keys in JSON response
+    camelize_keys: true,
+  }
+
+  # Error handling configuration
+  config[:error_handling] = {
+    # Log errors to Rails logger
+    log_errors:      true,
+    # Include detailed error information in responses
+    detailed_errors: true,
+  }
+end
+
+# Optional: Configure custom logger
+# BetterController::Logging.logger = Rails.logger

data/lib/generators/better_controller/templates/serializer.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+class <%= serializer_class_name %> < BetterController::Serializer
+  # Define the attributes to include in the serialized output
+  attributes :id, 
+             :created_at, 
+             :updated_at
+             # Add your model attributes here
+  
+  # Define methods to include in the serialized output
+  # methods :calculated_field
+  
+  # Define associations to include in the serialized output
+  # has_many :related_items
+  # has_one :related_item
+  # belongs_to :parent_item
+  
+  # Optional: Define a custom serializer for a specific association
+  # has_many :related_items, serializer: RelatedItemSerializer
+  
+  # Optional: Define a method that returns a calculated field
+  # def calculated_field
+  #   # Add your calculation logic here
+  #   object.some_attribute * 2
+  # end
+  
+  # Optional: Define a method that conditionally includes an attribute
+  # def include_some_attribute?
+  #   # Add your condition logic here
+  #   object.some_condition?
+  # end
+end

data/lib/generators/better_controller/templates/service.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+class <%= service_class_name %> < BetterController::Service
+  # Define the model class for this service
+  def model_class
+    <%= model_class_name %>
+  end
+
+  # Define the permitted attributes for create and update operations
+  def permitted_attributes
+    [
+      # Add your permitted attributes here
+      # Examples:
+      # :name,
+      # :email,
+      # { address_attributes: [:street, :city, :state, :zip] }
+    ]
+  end
+
+  # Optional: Override the default query for finding resources
+  # def find_query(id)
+  #   model_class.includes(:associations).find(id)
+  # end
+
+  # Optional: Override the default query for listing resources
+  # def list_query
+  #   model_class.includes(:associations).all
+  # end
+
+  # Optional: Add custom validation before create
+  # def validate_create(attributes)
+  #   # Add your validation logic here
+  #   # Raise BetterController::Error.new("Custom error message") if validation fails
+  # end
+
+  # Optional: Add custom validation before update
+  # def validate_update(resource, attributes)
+  #   # Add your validation logic here
+  #   # Raise BetterController::Error.new("Custom error message") if validation fails
+  # end
+
+  # Optional: Add custom logic after create
+  # def after_create(resource)
+  #   # Add your after create logic here
+  # end
+
+  # Optional: Add custom logic after update
+  # def after_update(resource)
+  #   # Add your after update logic here
+  # end
+
+  # Optional: Add custom logic before destroy
+  # def before_destroy(resource)
+  #   # Add your before destroy logic here
+  #   # Return false to prevent destruction
+  # end
+end

data/lib/tasks/better_controller_tasks.rake

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+namespace :better_controller do
+  desc 'Print the BetterController version'
+  task version: :environment do
+    require 'better_controller/version'
+    puts "BetterController version: #{BetterController::VERSION}"
+  end
+
+  desc 'Generate a new controller using BetterController'
+  task :generate_controller, %i[name model] => :environment do |_, args|
+    name  = args[:name]
+    model = args[:model]
+
+    if name.blank?
+      puts 'Error: Controller name is required'
+      puts 'Usage: rake better_controller:generate_controller[name,model]'
+      next
+    end
+
+    model_class     = model.presence || name.singularize
+    controller_name = "#{name.camelize}Controller"
+    file_path       = Rails.root.join('app', 'controllers', "#{name.underscore}_controller.rb")
+
+    template = <<~RUBY
+      # frozen_string_literal: true
+
+      class #{controller_name} < ApplicationController
+        include BetterController::ResourcesController
+      #{'  '}
+        # Define required parameters for actions
+        requires_params :create, :id  # Add your required params
+      #{'  '}
+        # Define parameter schema for validation
+        param_schema :create, {
+          # Add your parameter schema here
+        }
+      #{'  '}
+        protected
+      #{'  '}
+        # Define the resource service class
+        def resource_service_class
+          #{model_class.camelize}Service
+        end
+      #{'  '}
+        # Define the root key for resource parameters
+        def resource_params_root_key
+          :#{model_class.underscore}
+        end
+      #{'  '}
+        # Define the resource serializer class
+        def resource_serializer
+          #{model_class.camelize}Serializer
+        end
+      end
+    RUBY
+
+    File.write(file_path, template)
+    puts "Created controller at #{file_path}"
+  end
+end

data/sig/better_controller.rbs

@@ -0,0 +1,4 @@
+module BetterController
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,226 @@
+--- !ruby/object:Gem::Specification
+name: better_controller
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- alessiobussolari
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.19'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.22'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+description: BetterController provides tools and utilities to improve Rails controllers,
+  making them more maintainable and feature-rich.
+email:
+- alessio@cosmic.tech
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/api_controller.rb
+- examples/application_controller.rb
+- examples/products_controller.rb
+- examples/user_serializer.rb
+- examples/user_service.rb
+- examples/users_controller.rb
+- lib/better_controller.rb
+- lib/better_controller/action_helpers.rb
+- lib/better_controller/base.rb
+- lib/better_controller/configuration.rb
+- lib/better_controller/logging.rb
+- lib/better_controller/method_not_overridden_error.rb
+- lib/better_controller/pagination.rb
+- lib/better_controller/parameter_validation.rb
+- lib/better_controller/params_helpers.rb
+- lib/better_controller/railtie.rb
+- lib/better_controller/resources_controller.rb
+- lib/better_controller/response_helpers.rb
+- lib/better_controller/serializer.rb
+- lib/better_controller/service.rb
+- lib/better_controller/version.rb
+- lib/generators/better_controller/controller_generator.rb
+- lib/generators/better_controller/install_generator.rb
+- lib/generators/better_controller/templates/README
+- lib/generators/better_controller/templates/controller.rb
+- lib/generators/better_controller/templates/initializer.rb
+- lib/generators/better_controller/templates/serializer.rb
+- lib/generators/better_controller/templates/service.rb
+- lib/tasks/better_controller_tasks.rake
+- sig/better_controller.rbs
+homepage: https://github.com/alessiobussolari/better_controller
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/alessiobussolari/better_controller
+  source_code_uri: https://github.com/alessiobussolari/better_controller
+  changelog_uri: https://github.com/alessiobussolari/better_controller/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: A Ruby gem to enhance Rails controllers with additional functionality
+test_files: []