rage-rb 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3aacbd2e65fda6a0e7a7f7a24e67f718e55fd66bd3e0a6c6d3a1a319294be44b
-  data.tar.gz: 40d3d2225cf40bf0f125884afd99a86b47b34f6dddce5fdeea0a9b5239fdfd0a
+  metadata.gz: 4570bfdf4f86125be1d6c35b9ccba08a956fe8a20dac392e5ae914db347ad396
+  data.tar.gz: '019e919339f97e641e65f9aecc91c02740875ebcbe71edf14a07144950e47f07'
 SHA512:
-  metadata.gz: 288d8f707d78901e9c209cc3af075bcf3c37c7ef0ff4c24355702bd3898ab2e041afc5ab028e4cbe09e26a95f7297e01af03430ac6f126fd5d6cfa0b772f0e5e
-  data.tar.gz: 5c70306e1901176e5da774dcb153e21c382359825a2527a7de97ce75772dfdf6a510ac3ffba05486b684b55634a4173596d9469306571acf58ffff274a6185c9
+  metadata.gz: 9ad7b89eb46407831ae723c1c15b87ea12b898ae1784989374b07fcffcc3afcff2a237861c94565afe4c5f486b99edb15022b539ab9cad142778e4b2718b92ea
+  data.tar.gz: 471cb6bcbf294d9a4eb3e5fd69827f26661effafc1df20447b8e7eddd0816aff411266d22104988978c46318dc08c4fa753f1e1a4fa1327268a5f24d8851ac5a

data/.yardopts

@@ -1 +1 @@
---exclude lib/rage/templates --markup markdown --no-private
+--exclude lib/rage/templates --markup markdown --no-private -o doc

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 ## [Unreleased]
 
+## [0.2.0] - 2023-09-27
+
+### Added
+
+- Gem configuration by env.
+- Add `skip_before_action`.
+- Add `rescue_from`.
+- Add `Fiber.await`.
+- Support the `defaults` route option.
+
+### Fixed
+
+- Ignore trailing slashes in the URLs.
+- Support constraints in routes with optional params.
+- Make the `root` routes helper work correctly with scopes.
+- Convert objects to string when rendering text.
+
 ## [0.1.0] - 2023-09-15
 
 - Initial release

data/Gemfile

@@ -11,3 +11,6 @@ gem "rspec", "~> 3.0"
 
 gem "pg"
 gem "mysql2"
+
+gem "benchmark-ips"
+gem "mustache"

data/README.md

@@ -1,4 +1,4 @@
-<p align="center"><img height="200" src="https://github.com/rage-rb/rage/assets/2270393/d0f0834f-50e4-4b1b-a564-1f241c4ec149" /></p>
+<p align="center"><img height="200" src="https://github.com/rage-rb/rage/assets/2270393/9d06e0a4-5c20-49c7-b51d-e16ce8f1e1b7" /></p>
 
 # Rage
 
@@ -141,7 +141,7 @@ end
 
 Version | Changes
 ------- |------------
-0.2 | Gem configuration by env.<br>Add `skip_before_action`.<br>Add `rescue_from`.<br>Router updates:<br>&emsp;• make the `root` helper work correctly with `scope`;<br>&emsp;• support the `defaults` option;
+0.2 :white_check_mark: | ~~Gem configuration by env.<br>Add `skip_before_action`.<br>Add `rescue_from`.<br>Router updates:<br>&emsp;• make the `root` helper work correctly with `scope`;<br>&emsp;• support the `defaults` option;~~
 0.3 | CLI updates:<br>&emsp;• `routes` task;<br>&emsp;• `console` task;<br>Support the `:if` and `:unless` options in `before_action`.<br>Allow to set response headers.
 0.4 | Expose the `params` object.<br>Support header authentication with `authenticate_with_http_token`.<br>Router updates:<br>&emsp;• add the `resources` route helper;<br>&emsp;• add the `namespace` route helper;<br>&emsp;• support regexp constraints;
 0.5 | Implement Iodine-based equivalent of `ActionController::Live`.<br>Use `ActionDispatch::RemoteIp`.

data/lib/rage/application.rb

@@ -19,7 +19,7 @@ class Rage::Application
       end
 
     rescue => e
-      [500, {}, ["#{e.class}:#{e.message}\n\n#{e.backtrace.join("\n")}"]]
+      [500, {}, ["#{e.class}:#{e.message}\n\n#{e.backtrace.join("\n")}"]] # TODO: check Rage.env
 
     ensure
       # notify Iodine the request can now be served

data/lib/rage/controller/api.rb

@@ -193,7 +193,7 @@ class RageController::API
         json.is_a?(String) ? json : json.to_json
       else
         __set_header("content-type", "text/plain; charset=utf-8")
-        plain
+        plain.to_s
       end
 
       @__status = 200

data/lib/rage/router/backend.rb

@@ -12,7 +12,7 @@ class Rage::Router::Backend
     @constrainer = Rage::Router::Constrainer.new({})
   end
 
-  def on(method, path, handler, constraints: {})
+  def on(method, path, handler, constraints: {}, defaults: nil)
     raise "Path could not be empty" if path&.empty?
 
     if match_index = (path =~ OPTIONAL_PARAM_REGEXP)
@@ -21,8 +21,8 @@ class Rage::Router::Backend
       path_full = path.sub(OPTIONAL_PARAM_REGEXP, "/#{$1}")
       path_optional = path.sub(OPTIONAL_PARAM_REGEXP, "")
 
-      on(method, path_full, handler, constraints: constraints)
-      on(method, path_optional, handler, constraints: constraints)
+      on(method, path_full, handler, constraints: constraints, defaults: defaults)
+      on(method, path_optional, handler, constraints: constraints, defaults: defaults)
       return
     end
 
@@ -42,7 +42,7 @@ class Rage::Router::Backend
       handler = ->(env, _params) { orig_handler.call(env) }
     end
 
-    __on(method, path, handler, constraints)
+    __on(method, path, handler, constraints, defaults)
   end
 
   def lookup(env)
@@ -52,7 +52,7 @@ class Rage::Router::Backend
 
   private
 
-  def __on(method, path, handler, constraints)
+  def __on(method, path, handler, constraints, defaults)
     @constrainer.validate_constraints(constraints)
     # Let the constrainer know if any constraints are being used now
     @constrainer.note_usage(constraints)
@@ -159,7 +159,7 @@ class Rage::Router::Backend
       end
     end
 
-    route = { method: method, path: path, pattern: pattern, params: params, constraints: constraints, handler: handler }
+    route = { method: method, path: path, pattern: pattern, params: params, constraints: constraints, handler: handler, defaults: defaults }
     @routes << route
     current_node.add_route(route, @constrainer)
   end

data/lib/rage/router/dsl.rb

@@ -16,6 +16,7 @@ class Rage::Router::DSL
 
       @path_prefixes = []
       @module_prefixes = []
+      @defaults = []
     end
 
     # Register a new GET route.
@@ -23,10 +24,13 @@ class Rage::Router::DSL
     # @param path [String] the path for the route handler
     # @param to [String] the route handler in the format of "controller#action"
     # @param constraints [Hash] a hash of constraints for the route
+    # @param defaults [Hash] a hash of default parameters for the route
     # @example
     #   get "/photos/:id", to: "photos#show", constraints: { host: /myhost/ }
-    def get(path, to:, constraints: nil)
-      __on("GET", path, to, constraints)
+    # @example
+    #   get "/photos(/:id)", to: "photos#show", defaults: { id: "-1" }
+    def get(path, to:, constraints: nil, defaults: nil)
+      __on("GET", path, to, constraints, defaults)
     end
 
     # Register a new POST route.
@@ -34,10 +38,13 @@ class Rage::Router::DSL
     # @param path [String] the path for the route handler
     # @param to [String] the route handler in the format of "controller#action"
     # @param constraints [Hash] a hash of constraints for the route
+    # @param defaults [Hash] a hash of default parameters for the route
     # @example
     #   post "/photos", to: "photos#create", constraints: { host: /myhost/ }
-    def post(path, to:, constraints: nil)
-      __on("POST", path, to, constraints)
+    # @example
+    #   post "/photos", to: "photos#create", defaults: { format: "jpg" }
+    def post(path, to:, constraints: nil, defaults: nil)
+      __on("POST", path, to, constraints, defaults)
     end
 
     # Register a new PUT route.
@@ -45,10 +52,13 @@ class Rage::Router::DSL
     # @param path [String] the path for the route handler
     # @param to [String] the route handler in the format of "controller#action"
     # @param constraints [Hash] a hash of constraints for the route
+    # @param defaults [Hash] a hash of default parameters for the route
     # @example
     #   put "/photos/:id", to: "photos#update", constraints: { host: /myhost/ }
-    def put(path, to:, constraints: nil)
-      __on("PUT", path, to, constraints)
+    # @example
+    #   put "/photos(/:id)", to: "photos#update", defaults: { id: "-1" }
+    def put(path, to:, constraints: nil, defaults: nil)
+      __on("PUT", path, to, constraints, defaults)
     end
 
     # Register a new PATCH route.
@@ -56,10 +66,13 @@ class Rage::Router::DSL
     # @param path [String] the path for the route handler
     # @param to [String] the route handler in the format of "controller#action"
     # @param constraints [Hash] a hash of constraints for the route
+    # @param defaults [Hash] a hash of default parameters for the route
     # @example
     #   patch "/photos/:id", to: "photos#update", constraints: { host: /myhost/ }
-    def patch(path, to:, constraints: nil)
-      __on("PATCH", path, to, constraints)
+    # @example
+    #   patch "/photos(/:id)", to: "photos#update", defaults: { id: "-1" }
+    def patch(path, to:, constraints: nil, defaults: nil)
+      __on("PATCH", path, to, constraints, defaults)
     end
 
     # Register a new DELETE route.
@@ -67,10 +80,13 @@ class Rage::Router::DSL
     # @param path [String] the path for the route handler
     # @param to [String] the route handler in the format of "controller#action"
     # @param constraints [Hash] a hash of constraints for the route
+    # @param defaults [Hash] a hash of default parameters for the route
     # @example
     #   delete "/photos/:id", to: "photos#destroy", constraints: { host: /myhost/ }
-    def delete(path, to:, constraints: nil)
-      __on("DELETE", path, to, constraints)
+    # @example
+    #   delete "/photos(/:id)", to: "photos#destroy", defaults: { id: "-1" }
+    def delete(path, to:, constraints: nil, defaults: nil)
+      __on("DELETE", path, to, constraints, defaults)
     end
 
     # Register a new route pointing to '/'.
@@ -79,7 +95,7 @@ class Rage::Router::DSL
     # @example
     #   root to: "photos#index"
     def root(to:)
-      __on("GET", "/", to, nil)
+      __on("GET", "/", to, nil, nil)
     end
 
     # Scopes a set of routes to the given default options.
@@ -115,9 +131,22 @@ class Rage::Router::DSL
       @module_prefixes.pop if opts[:module]
     end
 
+    # Specify default parameters for a set of routes.
+    #
+    # @param defaults [Hash] a hash of default parameters
+    # @example
+    #   defaults id: "-1", format: "jpg" do
+    #     get "photos/(:id)", to: "photos#index"
+    #   end
+    def defaults(defaults, &block)
+      @defaults << defaults
+      instance_eval &block
+      @defaults.pop
+    end
+
     private
 
-    def __on(method, path, to, constraints)
+    def __on(method, path, to, constraints, defaults)
       if path != "/"
         path = "/#{path}" unless path.start_with?("/")
         path = path.delete_suffix("/") if path.end_with?("/")
@@ -129,11 +158,12 @@ class Rage::Router::DSL
 
       path_prefix = @path_prefixes.any? ? "/#{@path_prefixes.join("/")}" : nil
       module_prefix = @module_prefixes.any? ? "#{@module_prefixes.join("/")}/" : nil
+      defaults = (defaults ? @defaults + [defaults] : @defaults).reduce(&:merge)
 
       if to.is_a?(String)
-        @router.on(method, "#{path_prefix}#{path}", "#{module_prefix}#{to}", constraints: constraints || {})
+        @router.on(method, "#{path_prefix}#{path}", "#{module_prefix}#{to}", constraints: constraints || {}, defaults: defaults)
       else
-        @router.on(method, "#{path_prefix}#{path}", to, constraints: constraints || {})
+        @router.on(method, "#{path_prefix}#{path}", to, constraints: constraints || {}, defaults: defaults)
       end
     end
   end

data/lib/rage/router/handler_storage.rb

@@ -22,7 +22,7 @@ class Rage::Router::HandlerStorage
       params: params,
       constraints: constraints,
       handler: route[:handler],
-      create_params_object: compile_create_params_object(params)
+      create_params_object: compile_create_params_object(params, route[:defaults])
     }
 
     constraints_keys = constraints.keys
@@ -47,13 +47,19 @@ class Rage::Router::HandlerStorage
 
   private
 
-  def compile_create_params_object(param_keys)
+  def compile_create_params_object(param_keys, defaults)
     lines = []
 
     param_keys.each_with_index do |key, i|
       lines << "'#{key}' => param_values[#{i}]"
     end
 
+    if defaults
+      defaults.except(*param_keys.map(&:to_sym)).each do |key, value|
+        lines << "'#{key}' => '#{value}'"
+      end
+    end
+
     eval "->(param_values) { { #{lines.join(',')} } }"
   end
 

data/lib/rage/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rage-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Roman Samoilov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-25 00:00:00.000000000 Z
+date: 2023-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor