human_routes 0.0.1 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ad89763d40365e71ad1e2d6ca62e93c9d407cb4342ed0904c1b181338c5a599
-  data.tar.gz: 076fe95f90963ab455b86559c00c0af7dd0aeb624b2a1605c12ab2cccfbd3418
+  metadata.gz: 3c9732c44671356336d93d93f66551dc7ac4f05e430b0abe73cbff5d4aa32fe9
+  data.tar.gz: ec8df768c2dfbdea30fd6e020545fc9df04669da1236c1266877a4046e987589
 SHA512:
-  metadata.gz: 2af45ff4d9f08a645a0c2a367a652579ef43e24bd7bb9ad13db111b6be11b9d0952f0fcd6570797279d467948599d9cd4b92881ba48f44ea41a489d1513baad8
-  data.tar.gz: 51122db49e0b50327e3f7dd9751e7f4051425386f5ab59b6c1504819d7d4654fa320f1896c4bb05e17d6eef4f324a5d47a5ad9865e8e174974f9f76f11275bee
+  metadata.gz: 1c66820fb3a6224c242ce241f7d9256946e96d4c27e855b7b5ef5548e7a8ad2c91b036faf6897c2442bb0d33ca6b5889d6e865de8dca5ba85430713f36afc32f
+  data.tar.gz: 594bbc22352cd07cc313768f7768c308f1f965763d4ed6da2d773ef2b7132e76aba914c95f8fc6413a4335467e2f7ec6e590d30df777601be4d11daaec8bf496

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+---
+github: [fnando]
+custom: ["https://www.paypal.me/nandovieira/🍕"]

data/.rubocop.yml

@@ -4,9 +4,7 @@ inherit_gem:
 
 AllCops:
   TargetRubyVersion: 2.7
+  NewCops: enable
 
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/ClassLength:
+Metrics:
   Enabled: false

data/README.md

@@ -16,11 +16,15 @@ gem "human_routes"
 
 And then execute:
 
-    $ bundle install
+```bash
+bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install human_routes
+```bash
+gem install human_routes
+```
 
 ## Usage
 
@@ -36,7 +40,7 @@ end
 
 This will generate a few routes different routes, as you can see below:
 
-```
+```console
 $ rails routes
    Prefix     Verb   URI Pattern   Controller#Action
    new_signup GET    /signup/new   signup#new
@@ -64,7 +68,7 @@ The above could added in one line with `route(:blogs) { all }`.
 
 This will generate the following routes:
 
-```
+```console
 $ rails routes
      Prefix Verb   URI Pattern        Controller#Action
    new_blog GET    /blogs/new         blogs#new
@@ -104,6 +108,54 @@ Rails.application.routes.draw do
   route :pages, module: "customer" do
     all
   end
+
+  # Additionally, you can use `:name` to give a different name to
+  # namespaced controllers. This way routes can be generated using a shallow
+  # path instead of the usual `admin/reports`.
+  route "admin/reports", name: "reports" do
+    all
+  end
+
+  # Singular routes also are detected and generated accordingly.
+  # This will generate the following routes:
+  #
+  # GET  /profile         profile_path
+  # POST /profile/new
+  # GET  /profile/edit    edit_profile_path
+  # POST /profile/edit
+  # GET  /profile/remove  remove_profile_path
+  # POST /profile/remove
+  route "profile" do
+    all
+  end
+end
+```
+
+Sometimes you want to create routes without the action (e.g. `new` or `edit`);
+in this case, you can use `bare: true`.
+
+```ruby
+Rails.application.routes.draw do
+  # This will generate the following routes:
+  #
+  # GET  /login  new_login_path
+  # POST /login
+  route :login do
+    create bare: true
+  end
+end
+```
+
+You may want to add another paths not covered by the default helpers. In that
+case, you can use `get` and `post`.
+
+```ruby
+Rails.application.routes.draw do
+  route :login do
+    create as: "login", bare: true
+    get :verify_email #=> /login/verify-email
+    get :check_inbox  #=> /login/check-inbox
+  end
 end
 ```
 
@@ -122,7 +174,7 @@ git commits and tags, and push the `.gem` file to
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at
-https://github.com/fnando/human_routes. This project is intended to be a safe,
+<https://github.com/fnando/human_routes>. This project is intended to be a safe,
 welcoming space for collaboration, and contributors are expected to adhere to
 the
 [code of conduct](https://github.com/fnando/human_routes/blob/master/CODE_OF_CONDUCT.md).

data/human_routes.gemspec

@@ -7,6 +7,8 @@ Gem::Specification.new do |spec|
   spec.version       = HumanRoutes::VERSION
   spec.authors       = ["Nando Vieira"]
   spec.email         = ["me@fnando.com"]
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+  spec.metadata = {"rubygems_mfa_required" => "true"}
 
   spec.summary       = "I say no to REST for client-facing urls."
   spec.description   = spec.summary

data/lib/human_routes/context.rb

@@ -2,16 +2,25 @@
 
 module HumanRoutes
   class Context
-    attr_reader :controller
-    attr_reader :options
+    attr_reader :controller, :options, :router, :named_routes
 
-    def initialize(controller, options = {})
+    def initialize(router, controller, options = {})
+      @router = router
       @controller = controller
       @options = options
+      @named_routes = {}
+    end
+
+    def controller_name
+      @controller_name ||= options.delete(:name) { controller.to_s }
     end
 
     def singular_controller_name
-      @singular_controller_name ||= controller.to_s.singularize
+      @singular_controller_name ||= controller_name.singularize
+    end
+
+    def resource?
+      controller_name == singular_controller_name
     end
 
     def routes
@@ -20,137 +29,161 @@ module HumanRoutes
 
     def create(*args)
       path, name, options = extract_route_args(
-        default_path: "#{controller}/new",
+        segment: :new,
         default_name: "new_#{singular_controller_name}",
         args: args
       )
 
-      routes << [
-        path,
-        {
-          via: :get,
-          controller: controller,
-          action: :new,
-          as: name
-        }.merge(options)
-      ]
-
-      routes << [
-        path,
-        {
-          via: :post,
-          controller: controller,
-          action: :create,
-          as: ""
-        }.merge(options)
-      ]
+      match path, {
+        via: :get,
+        controller: controller,
+        action: :new,
+        as: name
+      }.merge(options)
+
+      match path, {
+        via: :post,
+        controller: controller,
+        action: :create,
+        as: ""
+      }.merge(options)
     end
 
     def update(*args)
       path, name, options = extract_route_args(
-        default_path: "#{controller}/:id/edit",
+        segment: :edit,
         default_name: "edit_#{singular_controller_name}",
         args: args
       )
 
-      routes << [
-        path,
-        {
-          via: :get,
-          controller: controller,
-          action: :edit,
-          as: name
-        }.merge(options)
-      ]
-
-      routes << [
-        path,
-        {
-          via: :post,
-          controller: controller,
-          action: :update,
-          as: ""
-        }.merge(options)
-      ]
+      match path, {
+        via: :get,
+        controller: controller,
+        action: :edit,
+        as: name
+      }.merge(options)
+
+      match path, {
+        via: :post,
+        controller: controller,
+        action: :update,
+        as: ""
+      }.merge(options)
     end
 
     def remove(*args)
       path, name, options = extract_route_args(
-        default_path: "#{controller}/:id/remove",
+        segment: :remove,
         default_name: "remove_#{singular_controller_name}",
         args: args
       )
 
-      routes << [
-        path,
-        {
-          via: :get,
-          controller: controller,
-          action: :remove,
-          as: name
-        }.merge(options)
-      ]
-
-      routes << [
-        path,
-        {
-          via: :post,
-          controller: controller,
-          action: :destroy,
-          as: ""
-        }.merge(options)
-      ]
+      match path, {
+        via: :get,
+        controller: controller,
+        action: :remove,
+        as: name
+      }.merge(options)
+
+      match path, {
+        via: :post,
+        controller: controller,
+        action: :destroy,
+        as: ""
+      }.merge(options)
     end
 
     def list(*args)
       path, name, options = extract_route_args(
-        default_path: controller,
-        default_name: controller,
+        segment: :list,
+        default_name: controller_name,
         args: args
       )
 
-      routes << [
-        path,
-        {
-          via: :get,
-          controller: controller,
-          action: :index,
-          as: name
-        }.merge(options)
-      ]
+      match path, {
+        via: :get,
+        controller: controller,
+        action: :index,
+        as: name
+      }.merge(options)
     end
 
     def show(*args)
       path, name, options = extract_route_args(
-        default_path: "#{controller}/:id",
+        segment: :show,
         default_name: singular_controller_name,
-        args: args
+        args: args,
+        bare: true
       )
 
-      routes << [
-        path,
-        {
-          via: :get,
-          controller: controller,
-          action: :show,
-          as: name
-        }.merge(options)
-      ]
+      match path, {
+        via: :get,
+        controller: controller,
+        action: :show,
+        as: name
+      }.merge(options)
     end
 
     def all
       create
       update
       remove
-      list
       show
+      list unless controller_name == controller_name.singularize
     end
 
-    private def extract_route_args(default_path:, default_name:, args:)
+    def get(action, *args)
+      path, name, options = extract_route_args(
+        segment: action,
+        default_name: action.to_s,
+        args: args
+      )
+
+      match path, {
+        via: :get,
+        controller: controller,
+        action: action,
+        as: name
+      }.merge(options)
+    end
+
+    def post(action, *args)
+      path, name, options = extract_route_args(
+        segment: action,
+        default_name: action.to_s,
+        args: args
+      )
+
+      match path, {
+        via: :post,
+        controller: controller,
+        action: action,
+        as: named_routes[path] == name ? "" : name
+      }.merge(options)
+    end
+
+    private def match(path, options)
+      named_routes[path] = options[:as] unless options[:as].empty?
+      router.match(path, options)
+    end
+
+    private def extract_route_args(
+      segment:,
+      default_name:,
+      args:,
+      bare: false
+    )
       route_options = args.extract_options!
-      route_options = default_options.merge(options).merge(route_options)
-      path = args.first || default_path
-      name = route_options.delete(:as) || default_name
+      route_options = default_options
+                      .merge(bare: bare)
+                      .merge(options)
+                      .merge(route_options)
+
+      path = args.first || path_for(segment, route_options)
+      path = path.to_s.dasherize
+      name = route_options.delete(:as) { default_name.underscore.tr("/", "_") }
+
+      route_options.delete(:bare)
 
       [path, name, route_options]
     end
@@ -160,5 +193,36 @@ module HumanRoutes
         format: false
       }
     end
+
+    private def path_for(segment, options)
+      param = options.fetch(:param, :id)
+
+      segments = if resource?
+                   resource_segments(segment, param, options)
+                 else
+                   resources_segments(segment, param, options)
+                 end
+
+      segments.compact.join("/")
+    end
+
+    private def resource_segments(segment, _param, options)
+      segments = [controller_name]
+      segments << segment unless options[:bare]
+      segments
+    end
+
+    private def resources_segments(segment, param, _options)
+      case segment
+      when :list
+        [controller_name]
+      when :new
+        [controller_name, segment]
+      when :show
+        [controller_name, ":#{param}"]
+      else
+        [controller_name, ":#{param}", segment]
+      end
+    end
   end
 end

data/lib/human_routes/extensions.rb

@@ -3,12 +3,8 @@
 module HumanRoutes
   module Extensions
     def route(controller, options = {}, &block)
-      context = Context.new(controller, options)
+      context = Context.new(self, controller, options)
       context.instance_eval(&block)
-
-      context.routes.each do |route|
-        match(*route)
-      end
     end
   end
 end

data/lib/human_routes/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: human_routes
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.5
 platform: ruby
 authors:
 - Nando Vieira
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-02-22 00:00:00.000000000 Z
+date: 2022-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -129,9 +129,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".tool-versions"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -148,10 +148,11 @@ homepage: https://github.com/fnando/human_routes
 licenses:
 - MIT
 metadata:
+  rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/fnando/human_routes
   source_code_uri: https://github.com/fnando/human_routes
   changelog_uri: https://github.com/fnando/human_routes
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -159,15 +160,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: I say no to REST for client-facing urls.
 test_files: []

data/.tool-versions

@@ -1 +0,0 @@
-nodejs 12.16.1