human_routes 0.0.4 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6619b6b97a5cb0145a8d7094e78b9a60977de870747daab57ead72a4616b35a7
-  data.tar.gz: 9ce9e153c6662da207f112f4eb35bca3959afa80993d10be771d23768db38590
+  metadata.gz: b141f9a399978068f28f1756d0a575a893aaeb48d998ce3aecb641bb0648fb57
+  data.tar.gz: cf69b4906f02fad6d251ec3210e902961f27cea5e9f1e1757a947d8aca34ae9f
 SHA512:
-  metadata.gz: 99529e4c6c0b3eaea6557cc8caa3eac0c25c68fc17e4404ebd1a825e02ac556a69307d0e769488164b7e35797b0099c72f6a7e9b54d359702f861b5b6aad0a64
-  data.tar.gz: 21d11d2ea7e321637278de2488bdcf55c733d0e2684cfe3e6b1f46b02fcdaf6f2b16dc156fdc3eca637fe88cd6f6798efaef07028a767ce469fc284ac2ffff2f
+  metadata.gz: 4023dccdbcfbd1be66d10124df81e4b1f75fb3daf354d309ce391b90fd4762701e33a28baa18a930bd0a56617729b656d020fad65d045828691f3e4d95913ac1
+  data.tar.gz: 4f4708fe090019fff8a630aa403b76a66d38480feccb26856cfb21559b3cda61a7fdced5d077cd896bdd0aaf48c9044d1d5c0bd0115bf149b119c29facd3c680

data/.rubocop.yml

@@ -4,6 +4,7 @@ inherit_gem:
 
 AllCops:
   TargetRubyVersion: 2.7
+  NewCops: enable
 
 Metrics:
   Enabled: false

data/README.md

@@ -120,6 +120,7 @@ Rails.application.routes.draw do
   # This will generate the following routes:
   #
   # GET  /profile         profile_path
+  # GET  /profile/new     new_profile_path
   # POST /profile/new
   # GET  /profile/edit    edit_profile_path
   # POST /profile/edit
@@ -128,6 +129,21 @@ Rails.application.routes.draw do
   route "profile" do
     all
   end
+
+  # You can use `resource: true` when you want a plural route but need a
+  # singular resource.
+  #
+  # GET  /settings         settings_path
+  # GET  /settings/new     new_settings_path
+  # POST /settings/new
+  # GET  /settings/edit    edit_settings_path
+  # POST /settings/edit
+  # GET  /settings/remove  remove_settings_path
+  # POST /settings/remove
+  #
+  route "settings", resource: true do
+    all
+  end
 end
 ```
 
@@ -159,6 +175,39 @@ Rails.application.routes.draw do
 end
 ```
 
+For nested paths, you can use `:prefix`:
+
+```ruby
+Rails.application.routes.draw do
+  route :posts do
+    all
+  end
+
+  route :comments, prefix: "posts/:post_id" do
+    remove #=> /posts/:post_id/comments/:id/remove
+    list   #=> /posts/:post_id/comments
+
+    # or
+    all
+  end
+end
+```
+
+If you need to change the url path, but point to a different controller, then
+use `:path_name`:
+
+```ruby
+Rails.application.routes.draw do
+  route :blogs do
+    all
+  end
+
+  route :blog_comments, path: "blogs/:blog_id", path_name: "comments" do
+    all
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run

data/lib/human_routes/context.rb

@@ -16,11 +16,19 @@ module HumanRoutes
     end
 
     def singular_controller_name
-      @singular_controller_name ||= controller_name.singularize
+      @singular_controller_name ||= if options[:resource]
+                                      controller_name
+                                    else
+                                      controller_name.singularize
+                                    end
     end
 
     def resource?
-      controller_name == singular_controller_name
+      options[:resource] || controller_name == singular_controller_name
+    end
+
+    def path_name
+      options[:path_name] || controller_name
     end
 
     def routes
@@ -129,7 +137,7 @@ module HumanRoutes
       update
       remove
       show
-      list unless controller_name == controller_name.singularize
+      list unless resource?
     end
 
     def get(action, *args)
@@ -180,9 +188,25 @@ module HumanRoutes
                       .merge(route_options)
 
       path = args.first || path_for(segment, route_options)
-      path = path.to_s.dasherize
+
+      path = [
+        route_options[:prefix].to_s.split("/"),
+        path.to_s.split("/")
+      ].flatten.compact
+
+      path = path.map do |s|
+        s.start_with?(":") ? s : s.dasherize
+      end.join("/")
+
       name = route_options.delete(:as) { default_name.underscore.tr("/", "_") }
 
+      %i[
+        bare
+        prefix
+        path_name
+        resource
+      ].each {|key| route_options.delete(key) }
+
       [path, name, route_options]
     end
 
@@ -205,7 +229,7 @@ module HumanRoutes
     end
 
     private def resource_segments(segment, _param, options)
-      segments = [controller_name]
+      segments = [path_name]
       segments << segment unless options[:bare]
       segments
     end
@@ -213,13 +237,13 @@ module HumanRoutes
     private def resources_segments(segment, param, _options)
       case segment
       when :list
-        [controller_name]
+        [path_name]
       when :new
-        [controller_name, segment]
+        [path_name, segment]
       when :show
-        [controller_name, ":#{param}"]
+        [path_name, ":#{param}"]
       else
-        [controller_name, ":#{param}", segment]
+        [path_name, ":#{param}", segment]
       end
     end
   end

data/lib/human_routes/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HumanRoutes
-  VERSION = "0.0.4"
+  VERSION = "0.0.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: human_routes
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.7
 platform: ruby
 authors:
 - Nando Vieira
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-27 00:00:00.000000000 Z
+date: 2022-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -167,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.17
 signing_key:
 specification_version: 4
 summary: I say no to REST for client-facing urls.