human_routes 0.0.3 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 750706caf0cfc1bbd3580eaf6c3103c73bc2e0f02c190c5103c7883f0749a958
-  data.tar.gz: d6cf027de35c5b1c9a3905550a606bb26585307b2b6fd97a5224975d804c4e8c
+  metadata.gz: 599c1d4f7022f37dd7a8c87f89e01480c95ea8f04d89137034139d87beabd8a5
+  data.tar.gz: e26db1816cc2b383938b5f2adf7e5d6c1955c8d25996c0913a2bb7def1c8f61e
 SHA512:
-  metadata.gz: c00bc6a43435013e188b97913862a37cd5dc665fd5fab540d4ee64808f997c81967e0437b9a85cbc7726a638cbeecd58b033940e851f23b590935295ceb7f5f8
-  data.tar.gz: dd0df5f668857a9906c74ad87df9f9518f8320df74c961a548d2a00abc5f2dd0277851168fca14aed51a1a135a6fef0366511d9127a58bf083afd2ec42aba94f
+  metadata.gz: af48d012d17e2c1525a524c68e14e6a72f8626fd4804d9a9252b923850547bf39eefcfe54966410ef5fe1619f3c510d92cd0271691e9e29c43ad6c4a02193849
+  data.tar.gz: 789d18466d195a4afb4490567a38ad8c72d0f489b9485ffbb3a9c3cbcd2b09f63a58f49a5968b366ea07a28fca126ca191b663f5d1a43768c1d20b4fd08371c7

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
@@ -127,6 +131,52 @@ Rails.application.routes.draw do
 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
+```
+
+For nested paths, you can use `:parent`:
+
+```ruby
+Rails.application.routes.draw do
+  route :posts do
+    all
+  end
+
+  route :comments, parent: "posts/:post_id" do
+    remove #=> /posts/:post_id/comments/:id/remove
+    list   #=> /posts/:post_id/comments
+
+    # or
+    all
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run
@@ -142,7 +192,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,12 +2,13 @@
 
 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
@@ -33,25 +34,19 @@ module HumanRoutes
         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)
@@ -61,25 +56,19 @@ module HumanRoutes
         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)
@@ -89,25 +78,19 @@ module HumanRoutes
         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)
@@ -117,33 +100,28 @@ module HumanRoutes
         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(
         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
@@ -154,12 +132,68 @@ module HumanRoutes
       list unless controller_name == controller_name.singularize
     end
 
-    private def extract_route_args(segment:, 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)
+      route_options = default_options
+                      .merge(bare: bare)
+                      .merge(options)
+                      .merge(route_options)
+
       path = args.first || path_for(segment, route_options)
+
+      path = [
+        route_options[:parent].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("/", "_") }
 
+      route_options.delete(:bare)
+
       [path, name, route_options]
     end
 
@@ -173,21 +207,21 @@ module HumanRoutes
       param = options.fetch(:param, :id)
 
       segments = if resource?
-                   resource_segments(segment, param)
+                   resource_segments(segment, param, options)
                  else
-                   resources_segments(segment, param)
+                   resources_segments(segment, param, options)
                  end
 
       segments.compact.join("/")
     end
 
-    private def resource_segments(segment, _param)
+    private def resource_segments(segment, _param, options)
       segments = [controller_name]
-      segments << segment unless segment == :show
+      segments << segment unless options[:bare]
       segments
     end
 
-    private def resources_segments(segment, param)
+    private def resources_segments(segment, param, _options)
       case segment
       when :list
         [controller_name]

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.3"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: human_routes
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.6
 platform: ruby
 authors:
 - Nando Vieira
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-02-22 00:00:00.000000000 Z
+date: 2022-07-18 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.17
+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