restomatic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5e40b314565dc501d5da5f6b97f108c41c4700a940208b056af5205fa681cb4d
+  data.tar.gz: c93b2fc63f639ef8a899e29934b20c7a0492869acdd195a9758c17c4a143ecb2
+SHA512:
+  metadata.gz: 7e895db99eb254ea860f56e46d371b327576d0403c72520f1f2a7578b7f245b23a1268e79c9ff4a7476e8bdd5e00d1331d38b4df5b634176245c4161c4165e61
+  data.tar.gz: 560e927399392480f81eeffaeb45653b4f9a0d4aed1838f5f914bbc2389442f19f23b1b1aea919758adc27b77195ad2437ff2db6b93e50879ec0b0f11f387912

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Brad Gessler
+
+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,228 @@
+# RESTomatic
+
+RESTomatic helps Rails developers organize nested resources with automatic namespacing. Each nested resource gets its own controller module, making your app cleaner and easier to maintain.
+
+Unlike Rails shallow routes that send everything to one controller, RESTomatic enforces proper separation: `Blogs::PostsController`, `Users::PostsController`, etc. keeping your controllers organized and your codebase more maintainable.
+
+## Installation
+
+Add to your Rails application Gemfile:
+
+```ruby
+bundle add "restomatic"
+```
+That's it! The routing helpers are automatically available in your `config/routes.rb` file.
+
+Then start using more RESTful routes in `config/routes.rb`:
+
+```ruby
+resources :blogs do
+  nest :posts do                    # Blogs::PostsController
+    collection do
+      get :search                   # Blogs::PostsController#search
+    end
+  end
+end
+
+resources :posts do
+  create :comments                  # Posts::CommentsController#new, #create
+end
+```
+
+## The Problem
+
+Rails provides shallow routes and nested resources, but the syntax becomes verbose and repetitive, especially when you want to properly namespace controllers.
+
+### Before RESTomatic
+
+```ruby
+resources :blogs do
+  scope module: :blogs do
+    resources :posts, only: %i[index new create] do
+      collection do
+        get :search
+      end
+    end
+  end
+end
+
+resources :posts do
+  scope module: :posts do
+    resources :comments, only: %i[new create]
+  end
+end
+```
+
+### With RESTomatic
+
+```ruby
+resources :blogs do
+  nest :posts do                    # Blogs::PostsController
+    collection do
+      get :search                   # Blogs::PostsController#search
+    end
+  end
+end
+
+resources :posts do
+  create :comments                  # Posts::CommentsController#new, #create
+end
+```
+
+Much cleaner! The `nest` helper automatically:
+- Scopes to the parent resource's module (e.g., `Blogs::PostsController`)
+- Sets sensible defaults for which actions are included
+- Reduces boilerplate while maintaining Rails conventions
+
+## Route Helpers
+
+### `nest`
+
+Nest resources under a parent with automatic module scoping and sensible action defaults.
+
+```ruby
+resources :blogs do
+  nest :posts         # Creates index, new, create actions under Blogs::PostsController
+  nest :post          # Singular: creates new, create actions (no edit/update/destroy)
+end
+```
+
+**Options:**
+- `except:` - Exclude specific actions (overrides defaults)
+- Singular resources default to excluding: `[:edit, :update, :destroy]`
+- Plural resources default to excluding: `[:show, :edit, :update, :destroy]`
+
+**Module-only nesting:**
+
+```ruby
+resources :posts do
+  nest do
+    # Routes defined here will be scoped to Posts module
+    # without creating a nested resource
+    get :analytics
+  end
+end
+```
+
+### `create`
+
+Define routes for creating a resource (new + create actions only).
+
+```ruby
+resources :posts do
+  create :comments    # Only new and create actions
+end
+
+create :session       # Works with both singular and plural forms
+```
+
+### `edit`
+
+Define routes for editing a resource (edit + update actions only).
+
+```ruby
+resources :posts do
+  edit :metadata      # Only edit and update actions
+end
+```
+
+### `show`
+
+Define routes for showing a resource (show action only).
+
+```ruby
+resources :posts do
+  show :preview       # Only show action
+end
+```
+
+### `destroy`
+
+Define routes for destroying a resource (destroy action only).
+
+```ruby
+resources :posts do
+  destroy :attachment # Only destroy action
+end
+```
+
+### `list`
+
+Define routes for listing resources (index action only).
+
+```ruby
+resources :users do
+  list :posts         # Only index action
+end
+```
+
+## Real-World Example
+
+```ruby
+Rails.application.routes.draw do
+  root "home#index"
+
+  # Public blog routes
+  resources :blogs, only: [:index, :show] do
+    list :posts                              # Blogs::PostsController#index
+  end
+
+  # Admin area with nested resources
+  namespace :admin do
+    resources :blogs do
+      nest :posts do                         # Admin::Blogs::PostsController
+        create :comments                     # Admin::Blogs::Posts::CommentsController#new, #create
+        collection do
+          get :scheduled                     # Admin::Blogs::PostsController#scheduled
+          post :bulk_publish                 # Admin::Blogs::PostsController#bulk_publish
+        end
+      end
+    end
+
+    resources :posts do
+      edit :seo                              # Admin::Posts::SeosController#edit, #update
+      show :preview                          # Admin::Posts::PreviewsController#show
+      destroy :featured_image                # Admin::Posts::FeaturedImagesController#destroy
+    end
+  end
+
+  # User account management
+  resource :account do
+    nest do
+      edit :profile                          # Accounts::ProfilesController#edit, #update
+      edit :password                         # Accounts::PasswordsController#edit, #update
+      show :billing                          # Accounts::BillingsController#show
+    end
+  end
+end
+```
+
+## How It Works
+
+RESTomatic extends `ActionDispatch::Routing::Mapper` to add these helper methods. The helpers automatically:
+
+1. Detect singular vs. plural resource names
+2. Apply appropriate module scoping
+3. Set sensible action defaults based on the helper used
+4. Work seamlessly with existing Rails routing features
+
+## Philosophy
+
+Rails routing is powerful but can become verbose when building properly organized applications with shallow routes and namespaced controllers. RESTomatic embraces Rails conventions while reducing boilerplate, making your routes file more readable and maintainable.
+
+## Requirements
+
+- Rails 7.0+
+- Ruby 3.0+
+
+## Contributing
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## 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,2 @@
+require "bundler/setup"
+require "bundler/gem_tasks"

data/lib/restomatic/routing_mapper.rb

@@ -0,0 +1,97 @@
+module ActionDispatch::Routing
+  # I have no idea how or why this works this way, I lifted the pattern from Devise, which came with even
+  # more weird stuff. Rails could use an API for adding route helpers to decrease the brittleness of this
+  # approach. For now, deal with this helper.
+  class Mapper
+    def nest(name = nil, *args, except: nil, **kwargs, &block)
+      unless resource_scope?
+        raise ArgumentError, "can't use nest outside resource(s) scope"
+      end
+
+      if name.nil?
+        scope module: parent_module_name, &block
+      elsif is_singular_resource_name? name
+        scope module: parent_module_name do
+          except ||= %i[edit update destroy]
+          resource name, *args, except: except, **kwargs, &block
+        end
+      else
+        scope module: parent_module_name do
+          except ||= %i[show edit update destroy]
+          resources name, *args, except: except, **kwargs, &block
+        end
+      end
+    end
+
+    def create(name, *args, **kwargs, &block)
+      if resource_scope? && !@scope[:module]
+        scope module: parent_module_name do
+          resource name, *args, only: %i[new create], **kwargs, &block
+        end
+      else
+        resource name, *args, only: %i[new create], **kwargs, &block
+      end
+    end
+
+    def edit(name, *args, **kwargs, &block)
+      if resource_scope? && !@scope[:module]
+        scope module: parent_module_name do
+          resource name, *args, only: %i[edit update], **kwargs, &block
+        end
+      else
+        resource name, *args, only: %i[edit update], **kwargs, &block
+      end
+    end
+
+    def show(name, *args, **kwargs, &block)
+      if resource_scope? && !@scope[:module]
+        scope module: parent_module_name do
+          resource name, *args, only: :show, **kwargs, &block
+        end
+      else
+        resource name, *args, only: :show, **kwargs, &block
+      end
+    end
+
+    def destroy(name, *args, **kwargs, &block)
+      if resource_scope? && !@scope[:module]
+        scope module: parent_module_name do
+          resource name, *args, only: :destroy, **kwargs, &block
+        end
+      else
+        resource name, *args, only: :destroy, **kwargs, &block
+      end
+    end
+
+    def index(name, *args, **kwargs, &block)
+      if resource_scope? && !@scope[:module]
+        scope module: parent_module_name do
+          resources name, *args, only: :index, **kwargs, &block
+        end
+      else
+        resources name, *args, only: :index, **kwargs, &block
+      end
+    end
+
+    private
+
+    def parent_module_name
+      # For singular resources (resource :account), Rails uses plural controller names (AccountsController)
+      # So we need to pluralize the parent resource name for the module scope
+      parent_resource.singular ? parent_resource.name.to_s.pluralize : parent_resource.name
+    end
+
+    def is_singular_resource_name?(name)
+      name_string = name.to_s
+      name_string.singularize == name_string
+    end
+
+    def resource_plurality(name)
+      is_singular_resource_name?(name) ? :resource : :resources
+    end
+
+    def inflect_resource_plurality(name, *args, **kwargs, &)
+      self.method(resource_plurality(name)).call(name, *args, **kwargs, &)
+    end
+  end
+end

data/lib/restomatic/version.rb

@@ -0,0 +1,3 @@
+module Restomatic
+  VERSION = "0.1.0"
+end

data/lib/restomatic.rb

@@ -0,0 +1,6 @@
+require "restomatic/version"
+require "restomatic/routing_mapper"
+
+module Restomatic
+  # Rails routing mapper extensions for cleaner route definitions
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: restomatic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brad Gessler
+bindir: bin
+cert_chain: []
+date: 2025-11-18 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'
+description: Provides cleaner, more intuitive helpers for defining RESTful routes
+  with proper scoping and namespacing in Rails
+email:
+- bradgessler@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/restomatic.rb
+- lib/restomatic/routing_mapper.rb
+- lib/restomatic/version.rb
+homepage: https://github.com/rocketshipio/restomatic
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/rocketshipio/restomatic
+  source_code_uri: https://github.com/rocketshipio/restomatic
+  changelog_uri: https://github.com/rocketshipio/restomatic
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Better route mappers for Rails applications
+test_files: []