rage-rb 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43393d351828980659e1a5e574887b818727744bf679bca2c1e0e0a164848496
-  data.tar.gz: d732652d4966c9cdcdd1825ec692b6c88286e467c229a2e4acdb7658e2b0a455
+  metadata.gz: 24a5bc4310d226a4072c06ac0a3cb015eb52163e7c37fc85aced61f5705b6ef5
+  data.tar.gz: 8bedd5b522c64c945a44fa4cb97e19f48d5b3a3aa46bb5687183c4cf3eac75f3
 SHA512:
-  metadata.gz: e23ca7a0309a24e665850c6c7798a3a4d7cb5dd5d8f239346907bc2be0ae3c6446530e5299e2f5a6b08f773281a8e3c570dc19b9ebe1f6cbe1b0712b643ed688
-  data.tar.gz: 9578c4f912c7ce713639acd0c043de9f4b757ff816e60dd5ae9637434699190d8c84af29a0a42fd7c0f0f32ae6724b710429cde6fab20011c23fd79bade36d13
+  metadata.gz: 10feb1fe42789d8470ecf9d7754be26b58db2f160f24c7e82aac8a831a5c4b828d297e01c2535b8e914d167de2bcf40a843b1964c5d1f3102ef4429016fefabd
+  data.tar.gz: 87c3ee06201e71f691b7158f911c0cfbf7763d2021801d298885c890772082a934d91fdb5df8c0f6bf65110acd480fd839ef19d6e9adc39d1c78d165a0e2701f

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 ## [Unreleased]
 
+## [1.5.0] - 2024-05-08
+
+### Added
+
+- Allow to have both Rails and Rage controllers in one application (#83).
+- Add `authenticate_or_request_with_http_token` (#85).
+- Add the `member` and `controller` route helpers (#86).
+
+### Changed
+
+- Deprecate `Rage.load_middlewares` (#83).
+
+### Fixed
+
+- Correctly init console in Rails mode (credit to [efibootmgr](https://github.com/efibootmgr)) (#84).
+
 ## [1.4.0] - 2024-05-01
 
 ### Added

data/README.md

@@ -155,8 +155,8 @@ Status | Changes
 :white_check_mark:  | ~~Add request logging.~~
 :white_check_mark: | ~~Automatic code reloading in development with Zeitwerk.~~
 :white_check_mark: | ~~Support conditional get with `etag` and `last_modified`.~~
+:white_check_mark: | ~~Expose the `cookies` and `session` objects.~~
 ⏳ | Expose the `send_data` and `send_file` methods.
-⏳ | Expose the `cookies` and `session` objects.
 ⏳ | Implement Iodine-based equivalent of Action Cable.
 
 ## Development

data/lib/rage/cli.rb

@@ -116,10 +116,8 @@ module Rage
     def environment
       require File.expand_path("config/application.rb", Dir.pwd)
 
-      # in Rails mode we delegate code loading to Rails, and thus need
-      # to manually load application code for CLI utilities to work
       if Rage.config.internal.rails_mode
-        require "rage/setup"
+        require File.expand_path("config/environment.rb", Dir.pwd)
       end
     end
 

data/lib/rage/controller/api.rb

@@ -428,6 +428,28 @@ class RageController::API
     yield token
   end
 
+  # Authenticate using an HTTP Bearer token, or otherwise render an HTTP header requesting the client to send a
+  # Bearer token. For the authentication to be considered successful, the block should return a non-nil value.
+  #
+  # @yield [token] token value extracted from the `Authorization` header
+  # @example
+  #   before_action :authenticate
+  #
+  #   def authenticate
+  #     authenticate_or_request_with_http_token do |token|
+  #       ApiToken.find_by(token: token)
+  #     end
+  #   end
+  def authenticate_or_request_with_http_token
+    authenticate_with_http_token { |token| yield(token) } || request_http_token_authentication
+  end
+
+  # Render an HTTP header requesting the client to send a Bearer token for authentication.
+  def request_http_token_authentication
+    headers["Www-Authenticate"] = "Token"
+    render plain: "HTTP Token: Access denied.", status: 401
+  end
+
   if !defined?(::ActionController::Parameters)
     # Get the request data. The keys inside the hash are symbols, so `params.keys` returns an array of `Symbol`.<br>
     # You can also load Strong Params to have Rage automatically wrap `params` in an instance of `ActionController::Parameters`.<br>

data/lib/rage/router/backend.rb

@@ -68,12 +68,18 @@ class Rage::Router::Backend
       raise "Invalid route handler format, expected to match the 'controller#action' pattern" unless handler =~ STRING_HANDLER_REGEXP
 
       controller, action = Rage::Router::Util.path_to_class($1), $2
-      run_action_method_name = controller.__register_action(action.to_sym)
 
-      meta[:controller] = $1
-      meta[:action] = $2
+      if controller.ancestors.include?(RageController::API)
+        run_action_method_name = controller.__register_action(action.to_sym)
 
-      handler = eval("->(env, params) { #{controller}.new(env, params).#{run_action_method_name} }")
+        meta[:controller] = $1
+        meta[:action] = $2
+
+        handler = eval("->(env, params) { #{controller}.new(env, params).#{run_action_method_name} }")
+      else
+        # this is a Rails controller; notify `Rage::Router::Util::Cascade` to forward the request to Rails
+        handler = ->(_, _) { [404, { "X-Cascade" => "pass" }, []] }
+      end
     else
       raise "Non-string route handler should respond to `call`" unless handler.respond_to?(:call)
       # while regular handlers are expected to be called with the `env` and `params` objects,

data/lib/rage/router/dsl.rb

@@ -209,6 +209,7 @@ class Rage::Router::DSL
     # @param [Hash] opts scope options.
     # @option opts [String] :module module option
     # @option opts [String] :path path option
+    # @option opts [String] :controller controller option
     # @example Route `/photos` to `Api::PhotosController`
     #   scope module: "api" do
     #     get "photos", to: "photos#index"
@@ -217,6 +218,11 @@ class Rage::Router::DSL
     #   scope path: "admin" do
     #     get "photos", to: "photos#index"
     #   end
+    # @example Route `/like` to `photos#like` and `/dislike` to `photos#dislike`
+    #   scope controller: "photos" do
+    #     post "like"
+    #     post "dislike"
+    #   end
     # @example Nested calls
     #   scope module: "admin" do
     #     get "photos", to: "photos#index"
@@ -252,6 +258,19 @@ class Rage::Router::DSL
       @defaults.pop
     end
 
+    # Scopes routes to a specific controller.
+    #
+    # @example
+    #   controller "photos" do
+    #     post "like"
+    #     post "dislike"
+    #   end
+    def controller(controller, &block)
+      @controllers << controller
+      instance_eval &block
+      @controllers.pop
+    end
+
     # Add a route to the collection.
     #
     # @example Add a `photos/search` path instead of `photos/:photo_id/search`
@@ -267,6 +286,27 @@ class Rage::Router::DSL
       @path_prefixes = orig_path_prefixes
     end
 
+    # Add a member route.
+    #
+    # @example Add a `photos/:id/preview` path instead of `photos/:photo_id/preview`
+    #   resources :photos do
+    #     member do
+    #       get "preview"
+    #     end
+    #   end
+    def member(&block)
+      orig_path_prefixes = @path_prefixes
+
+      if (param_prefix = @path_prefixes.last)&.start_with?(":") && @controllers.any?
+        member_prefix = param_prefix.delete_prefix(":#{to_singular(@controllers.last)}_")
+        @path_prefixes = [*@path_prefixes[0...-1], ":#{member_prefix}"]
+      end
+
+      instance_eval &block
+
+      @path_prefixes = orig_path_prefixes
+    end
+
     # Automatically create REST routes for a resource.
     #
     # @example Create five REST routes, all mapping to the `Photos` controller:

data/lib/rage/router/util.rb

@@ -30,4 +30,19 @@ class Rage::Router::Util
       end
     end
   end
+
+  # @private
+  class Cascade
+    def initialize(rage_app, rails_app)
+      @rage_app = rage_app
+      @rails_app = rails_app
+    end
+
+    def call(env)
+      result = @rage_app.call(env)
+      return result if result[0] == :__http_defer__ || result[1]["X-Cascade".freeze] != "pass".freeze
+
+      @rails_app.call(env)
+    end
+  end
 end

data/lib/rage/templates/config.ru

@@ -1,4 +1,3 @@
 require_relative "config/application"
 
 run Rage.application
-Rage.load_middlewares(self)

data/lib/rage/version.rb

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

data/lib/rage-rb.rb

@@ -7,7 +7,25 @@ require "pathname"
 
 module Rage
   def self.application
-    Application.new(__router)
+    app = Application.new(__router)
+
+    config.middleware.middlewares.reverse.inject(app) do |next_in_chain, (middleware, args, block)|
+      # in Rails compatibility mode we first check if the middleware is a part of the Rails middleware stack;
+      # if it is - it is expected to be built using `ActionDispatch::MiddlewareStack::Middleware#build`
+      if Rage.config.internal.rails_mode
+        rails_middleware = Rails.application.config.middleware.middlewares.find { |m| m.name == middleware.name }
+      end
+
+      if rails_middleware
+        rails_middleware.build(next_in_chain)
+      else
+        middleware.new(next_in_chain, *args, &block)
+      end
+    end
+  end
+
+  def self.multi_application
+    Rage::Router::Util::Cascade.new(application, Rails.application)
   end
 
   def self.routes
@@ -43,28 +61,8 @@ module Rage
     @logger ||= config.logger
   end
 
-  def self.load_middlewares(rack_builder)
-    config.middleware.middlewares.each do |middleware, args, block|
-      # in Rails compatibility mode we first check if the middleware is a part of the Rails middleware stack;
-      # if it is - it is expected to be built using `ActionDispatch::MiddlewareStack::Middleware#build`, but Rack
-      # expects the middleware to respond to `#new`, so we wrap the middleware into a helper module
-      if Rage.config.internal.rails_mode
-        rails_middleware = Rails.application.config.middleware.middlewares.find { |m| m.name == middleware.name }
-        if rails_middleware
-          wrapper = Module.new do
-            extend self
-            attr_accessor :middleware
-            def new(app, *, &)
-              middleware.build(app)
-            end
-          end
-          wrapper.middleware = rails_middleware
-          middleware = wrapper
-        end
-      end
-
-      rack_builder.use(middleware, *args, &block)
-    end
+  def self.load_middlewares(_)
+    puts "`Rage.load_middlewares` is deprecated and has been merged into `Rage.application`. Please remove this call."
   end
 
   def self.code_loader

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rage-rb
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Roman Samoilov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-01 00:00:00.000000000 Z
+date: 2024-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor