modular_routes 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5341830eca8ac468d9bf1843691214bf42e7806a9dedee7aa363227b39f2fb1a
-  data.tar.gz: d0ce8a5bd66d31555ab827efafaec86e512939ba8c21470e6738ede33da9a200
+  metadata.gz: 735442d6f4629c4b130223eeffdc78e817d2dc183acb01cf541a2174411cf02b
+  data.tar.gz: 9d03465ec7092e08236ece0e73f3fd90d6cf43832ea581e7c0f465f072f4cc7c
 SHA512:
-  metadata.gz: f8ad0fa09d007407fb020109a93b33d7cf6c6b21a041759d5c556b76cb15cfd8c109ea10dac1b9d670d52cee9d1ff43dfe0c9357e88cdcffea3b92a46032d11a
-  data.tar.gz: c4581eede9b12a585ae8d409ad91a5405e4fbf4b040187aa1a41cd94f3599346c5ab0d5e53b709a4d2a37a11f6a93965e1c25da6c2098a1297295efdf7bcb3a2
+  metadata.gz: 4ebb16561f04f2e6648ea42a7eb29cb2077f8fd6b0e8bf35a28e655d7d39cd0983e9d181612e7d52305bd73acd659157de400929e16d8801148d64dc197767b7
+  data.tar.gz: 3c7f422084864aaf10ea89fbe62bd55158d4947df249f07c4e111b3fb2fb4de40c82453984e92d5a837a7242ec200573f15282def879cf7a9f078496e4c20da7

data/CHANGELOG.md

@@ -1,3 +1,30 @@
+## [v0.3.0] - 2021-08-30
+
+**NEW**
+
+- `root` helper will raise a syntax error indicating that it should be used outside of `modular_routes` block.
+
+- `concern` and `concerns` support:
+
+  ```ruby
+  modular_routes do
+    concern :commentable do
+      resource :comments
+    end
+
+    concern :activatable do
+      member do
+        put :activate
+        put :deactivate
+      end
+    end
+
+    resources :articles, concerns: :activatable do
+      concerns :commentable
+    end
+  end
+  ```
+
 ## [v0.2.0] - 2021-07-21
 
 **REMOVED**
@@ -9,11 +36,11 @@
 - `modular_routes` helper was added to fix the problems encountered on the previous helper. Check the example below:
 
   ```ruby
-    modular_routes do
-      resources :books
+  modular_routes do
+    resources :books
 
-      get :about, to: "about#index"
-    end
+    get :about, to: "about#index"
+  end
   ```
 
   The idea was to bring simplicity and proximity to what you already write in your routes file.
@@ -21,9 +48,9 @@
 - `namespace` support`
 
   ```ruby
-    namespace :v1 do
-      resources :books
-    end
+  namespace :v1 do
+    resources :books
+  end
   ```
 
   It falls back to Rails default behavior.
@@ -31,13 +58,13 @@
 - `scope` support
 
   ```ruby
-    scope :v1 do
-      resources :books
-    end
+  scope :v1 do
+    resources :books
+  end
 
-    scope module: :v1 do
-      resources :books
-    end
+  scope module: :v1 do
+    resources :books
+  end
   ```
 
   It falls back to Rails default behavior. In this example it recognizes `/v1/books` and `/books` expecting `BooksController` and `V1::BooksController` respectively.
@@ -45,11 +72,11 @@
 - Nested resources support
 
   ```ruby
-    modular_routes do
-      resources :books do
-        resources :comments
-      end
+  modular_routes do
+    resources :books do
+      resources :comments
     end
+  end
   ```
 
   It recognizes paths like `/books/1/comments/2`.
@@ -57,9 +84,9 @@
 - Standalone (non-resourceful) routes
 
   ```ruby
-    modular_routes do
-      get :about, to: "about#index"
-    end
+  modular_routes do
+    get :about, to: "about#index"
+  end
   ```
 
   It expects `About::IndexController` to exist in `controllers/about/index_controller.rb`. They don't belong to a resourceful scope.

data/README.md

@@ -71,7 +71,7 @@ end
 
 The reason I don't like this approach is that you can end up with a lot of code that are not related to each other in the same file. You can still have it all organized but I believe that it could be better.
 
-[DHH](http://jeromedalbert.com/how-dhh-organizes-his-rails-controllers/) prefers to keep the RESTful actions (index, new, edit, show, create, update, destroy) inside the same controller and the custom ones in dedicated controllers.
+[DHH](http://jeromedalbert.com/how-dhh-organizes-his-rails-controllers/) prefers to keep the RESTful actions (index, new, edit, show, create, update, destroy) inside the same controller and the custom ones in dedicated controllers but represented as RESTful actions.
 
 One way of representing that would be
 
@@ -79,8 +79,8 @@ One way of representing that would be
 # routes.rb
 
 resources :articles do
-  get  :stats,   on: :collection, controller: 'articles/stats'
-  post :archive, on: :member,     controller: 'articles/archive'
+  get  :stats,   on: :collection, to: 'articles/stats#show'
+  post :archive, on: :member,     to: 'articles/archive#create'
 end
 
 # articles_controller.rb
@@ -100,14 +100,14 @@ end
 # articles/archive_controller.rb
 
 class Articles::ArchiveController
-  def archive
+  def create
   end
 end
 
 # articles/stats_controller.rb
 
 class Articles::StatsController
-  def stats
+  def show
   end
 end
 ```
@@ -263,7 +263,7 @@ The output routes for the code above would be
 | GET       | /articles/:id/edit    | articles/edit#call    | edit_articles_path(:id)   |
 | PATCH/PUT | /articles/:id         | articles/update#call  | articles_path(:id)        |
 | DELETE    | /articles/:id         | articles/destroy#call | articles_path(:id)        |
-| POST      | /articles/stats       | articles/stats#call   | stats_articles_path(:id)  |
+| POST      | /articles/stats       | articles/stats#call   | stats_articles_path       |
 | POST      | /articles/:id/archive | articles/archive#call | archive_article_path(:id) |
 
 ### Restricting routes
@@ -314,15 +314,15 @@ end
 
 The output routes for that would be
 
-| HTTP Verb | Path                             | Controller#Action          | Named Route Helper              |
-| --------- | -------------------------------- | -------------------------- | ------------------------------- |
-| GET       | /books/:book_id/reviews          | books/reviews/index#call   | books_reviews_path              |
-| GET       | /books/:book_id/reviews/new      | books/reviews/new#call     | new_articles_reviews_path       |
-| POST      | /books/:book_id/reviews          | books/reviews/create#call  | books_reviews_path              |
-| GET       | /books/:book_id/reviews/:id      | books/reviews/show#call    | books_reviews_path(:id)         |
-| GET       | /books/:book_id/reviews/:id/edit | books/reviews/edit#call    | edit_articles_reviews_path(:id) |
-| PATCH/PUT | /books/:book_id/reviews/:id      | books/reviews/update#call  | books_reviews_path(:id)         |
-| DELETE    | /books/:book_id/reviews/:id      | books/reviews/destroy#call | books_reviews_path(:id)         |
+| HTTP Verb | Path                             | Controller#Action          | Named Route Helper         |
+| --------- | -------------------------------- | -------------------------- | -------------------------- |
+| GET       | /books/:book_id/reviews          | books/reviews/index#call   | book_reviews_path          |
+| GET       | /books/:book_id/reviews/new      | books/reviews/new#call     | new_book_review_path       |
+| POST      | /books/:book_id/reviews          | books/reviews/create#call  | book_reviews_path          |
+| GET       | /books/:book_id/reviews/:id      | books/reviews/show#call    | book_review_path(:id)      |
+| GET       | /books/:book_id/reviews/:id/edit | books/reviews/edit#call    | edit_book_review_path(:id) |
+| PATCH/PUT | /books/:book_id/reviews/:id      | books/reviews/update#call  | book_review_path(:id)      |
+| DELETE    | /books/:book_id/reviews/:id      | books/reviews/destroy#call | book_review_path(:id)      |
 
 ### Non-resourceful routes (standalone)
 
@@ -374,15 +374,60 @@ modular_routes do
 end
 ```
 
-| HTTP Verb | Path               | Controller#Action     | Named Route Helper  |
-| --------- | ------------------ | --------------------- | ------------------- |
-| GET       | /v1/books          | v1/books/index#call   | books_path          |
-| GET       | /v1/books/new      | v1/books/new#call     | new_book_path       |
-| POST      | /v1/books          | v1/books/create#call  | books_path          |
-| GET       | /v1/books/:id      | v1/books/show#call    | book_path(:id)      |
-| GET       | /v1/books/:id/edit | v1/books/edit#call    | edit_book_path(:id) |
-| PATCH/PUT | /v1/books/:id      | v1/books/update#call  | book_path(:id)      |
-| DELETE    | /v1/books/:id      | v1/books/destroy#call | book_path(:id)      |
+| HTTP Verb | Path               | Controller#Action     | Named Route Helper     |
+| --------- | ------------------ | --------------------- | ---------------------- |
+| GET       | /v1/books          | v1/books/index#call   | v1_books_path          |
+| GET       | /v1/books/new      | v1/books/new#call     | new_v1_book_path       |
+| POST      | /v1/books          | v1/books/create#call  | v1_books_path          |
+| GET       | /v1/books/:id      | v1/books/show#call    | v1_book_path(:id)      |
+| GET       | /v1/books/:id/edit | v1/books/edit#call    | edit_v1_book_path(:id) |
+| PATCH/PUT | /v1/books/:id      | v1/books/update#call  | v1_book_path(:id)      |
+| DELETE    | /v1/books/:id      | v1/books/destroy#call | v1_book_path(:id)      |
+
+### Routing concerns
+
+When you want to reuse route declarations that are usually associated with a common behavior, you can use concerns declaring blocks like:
+
+```ruby
+concern :commentable do
+  resource :comments
+end
+
+concern :activatable do
+  member do
+    put :activate
+    put :deactivate
+  end
+end
+```
+
+To use it you can pass it through resource(s) options or calling `concerns` helper inside of a resource(s) block:
+
+```ruby
+resources :articles, concerns: :commentable
+
+resources :articles, concerns: [:activatable]
+
+# or
+
+resources :articles, concerns: :activatable do
+  concerns :commentable
+end
+```
+
+The output of that would be:
+
+| HTTP Verb | Path                                    | Controller#Action              | Named Route Helper                          |
+| --------- | --------------------------------------- | ------------------------------ | ------------------------------------------- |
+| GET       | /articles/:id/activate                  | articles/activate#call         | activate_article_path                       |
+| GET       | /articles/:id/deactivate                | articles/deactivate#call       | deactivate_article_path                     |
+| GET       | /articles/:article_id/comments          | articles/comments/index#call   | article_comments_path(:article_id)          |
+| GET       | /articles/:article_id/comments/new      | articles/comments/new#call     | new_article_comment_path (:article_id)      |
+| POST      | /articles/:article_id/comments          | articles/comments/create#call  | article_comments_path(:article_id)          |
+| GET       | /articles/:article_id/comments/:id      | articles/comments/show#call    | article_comment_path(:article_id, :id)      |
+| GET       | /articles/:article_id/comments/:id/edit | articles/comments/edit#call    | edit_article_comment_path(:article_id, :id) |
+| PATCH/PUT | /articles/:article_id/comments/:id      | articles/comments/update#call  | article_comment_path(:article_id, :id)      |
+| DELETE    | /articles/:article_id/comments/:id      | articles/comments/destroy#call | article_comment_path(:article_id, :id)      |
 
 ### API mode
 

data/lib/modular_routes/builder.rb

@@ -25,6 +25,19 @@ module ModularRoutes
       end
     end
 
+    def root(*, **)
+      raise SyntaxError, "You must call `root` outside of `modular_routes` block"
+    end
+
+    def concerns(names)
+      raise SyntaxError, "You must call `concerns` inside of a resource block" unless current_scope
+
+      Array(names).each do |name|
+        concern = Routable.for(:concerns, name)
+        current_scope.add(concern)
+      end
+    end
+
     def collection(&block)
       apply_inner_scope(:collection, &block)
     end
@@ -41,6 +54,10 @@ module ModularRoutes
       apply_scopable(:namespace, namespace_name, options, &block)
     end
 
+    def concern(concern_name, **options, &block)
+      apply_scopable(:concern, concern_name, options, &block)
+    end
+
     def scope(*args, **options, &block)
       apply_scopable(:scope, args, options, &block)
     end
@@ -80,7 +97,7 @@ module ModularRoutes
       block&.call
 
       @scopes.pop
-      @routes.unshift(scopable) unless current_scope
+      @routes.push(scopable) unless current_scope
     end
 
     private def apply_inner_scope(type)

data/lib/modular_routes/routable/concerns.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ModularRoutes
+  module Routable
+    class Concerns
+      def initialize(name)
+        @name = name
+      end
+
+      def apply(mapper)
+        mapper.concerns(@name)
+      end
+    end
+
+    private_constant :Concerns
+  end
+end

data/lib/modular_routes/routable.rb

@@ -7,6 +7,7 @@ module ModularRoutes
       when :standalone then Standalone.new(*args)
       when :non_restful then NonRestful.new(*args)
       when :restful then Restful.new(*args)
+      when :concerns then Concerns.new(*args)
       else raise NotImplementedError
       end
     end

data/lib/modular_routes/scopable/concern.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module ModularRoutes
+  module Scopable
+    class Concern
+      def initialize(name, options)
+        @name = name
+        @options = options.except(:api_only)
+
+        @children = []
+      end
+
+      def add(route_or_scope)
+        @children << route_or_scope
+      end
+
+      def resource?
+        true
+      end
+
+      def apply(mapper)
+        block = proc do
+          @children.each { |route_or_scope| route_or_scope.apply(mapper) }
+        end
+
+        mapper.concern(@name, block)
+      end
+    end
+
+    private_constant :Concern
+  end
+end

data/lib/modular_routes/scopable/resource.rb

@@ -13,6 +13,7 @@ module ModularRoutes
         @api_only = options.delete(:api_only)
         @only = options.delete(:only) { default_actions }
         @except = options.delete(:except)
+        @concerns = Array(options.delete(:concerns))
         @options = { module: name, only: [] }.merge(options)
       end
 
@@ -31,6 +32,8 @@ module ModularRoutes
       def apply(mapper)
         mapper.public_send(resource_type, @name, @options) do
           @children.each { |route_or_scope| route_or_scope.apply(mapper) }
+
+          apply_concerns(mapper)
         end
 
         apply_restful_actions(mapper)
@@ -55,6 +58,12 @@ module ModularRoutes
           Routable.for(:restful, action, self).apply(mapper)
         end
       end
+
+      private def apply_concerns(mapper)
+        @concerns.each do |concern|
+          Routable.for(:concerns, concern).apply(mapper)
+        end
+      end
     end
 
     private_constant :Resource

data/lib/modular_routes/scopable.rb

@@ -8,6 +8,7 @@ module ModularRoutes
       when :resources then Resource.new(*args)
       when :resource then SingleResource.new(*args)
       when :scope then Scope.new(*args)
+      when :concern then Concern.new(*args)
       else raise NotImplementedError
       end
     end

data/lib/modular_routes/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ModularRoutes
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/modular_routes.rb

@@ -5,10 +5,12 @@ require "action_dispatch"
 require_relative "modular_routes/builder"
 require_relative "modular_routes/extension"
 require_relative "modular_routes/routable"
+require_relative "modular_routes/routable/concerns"
 require_relative "modular_routes/routable/non_restful"
 require_relative "modular_routes/routable/restful"
 require_relative "modular_routes/routable/standalone"
 require_relative "modular_routes/scopable"
+require_relative "modular_routes/scopable/concern"
 require_relative "modular_routes/scopable/namespace"
 require_relative "modular_routes/scopable/resource"
 require_relative "modular_routes/scopable/scope"

data/modular_routes.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/vitoravelino/modular_routes/blob/main/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modular_routes
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Vítor Avelino
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-21 00:00:00.000000000 Z
+date: 2021-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -148,10 +148,12 @@ files:
 - lib/modular_routes/builder.rb
 - lib/modular_routes/extension.rb
 - lib/modular_routes/routable.rb
+- lib/modular_routes/routable/concerns.rb
 - lib/modular_routes/routable/non_restful.rb
 - lib/modular_routes/routable/restful.rb
 - lib/modular_routes/routable/standalone.rb
 - lib/modular_routes/scopable.rb
+- lib/modular_routes/scopable/concern.rb
 - lib/modular_routes/scopable/namespace.rb
 - lib/modular_routes/scopable/resource.rb
 - lib/modular_routes/scopable/scope.rb
@@ -163,7 +165,7 @@ licenses: []
 metadata:
   homepage_uri: https://github.com/vitoravelino/modular_routes
   source_code_uri: https://github.com/vitoravelino/modular_routes
-  changelog_uri: https://github.com/vitoravelino/modular_routes
+  changelog_uri: https://github.com/vitoravelino/modular_routes/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: