rage-rb 0.5.2 → 0.7.0

data/lib/rage/rails.rb

@@ -0,0 +1,62 @@
+if Gem::Version.new(Rails.version) < Gem::Version.new(6)
+  fail "Rage is only compatible with Rails 6+. Detected Rails version: #{Rails.version}."
+end
+
+# load the framework
+require "rage/all"
+
+# patch Rack
+Iodine.patch_rack
+
+# configure the framework
+Rage.config.internal.rails_mode = true
+
+# make sure log formatter is not used in console
+Rails.application.console do
+  Rage.config.internal.rails_console = true
+  Rage.logger.level = Rage.logger.level if Rage.logger # trigger redefining log methods
+end
+
+# patch ActiveRecord's connection pool
+if defined?(ActiveRecord)
+  Rails.configuration.after_initialize do
+    module ActiveRecord::ConnectionAdapters
+      class ConnectionPool
+        def connection_cache_key(_)
+          Fiber.current
+        end
+      end
+    end
+  end
+end
+
+# plug into Rails' Zeitwerk instance to reload the code
+Rails.autoloaders.main.on_setup do
+  if Iodine.running?
+    Rage.code_loader.rails_mode_reload
+  end
+end
+
+# patch `ActionDispatch::Reloader` to synchronize `reload!` calls
+Rails.configuration.after_initialize do
+  conditional_mutex = Module.new do
+    def call(env)
+      @mutex ||= Mutex.new
+      if Rails.application.reloader.check!
+        @mutex.synchronize { super }
+      else
+        super
+      end
+    end
+  end
+
+  ActionDispatch::Reloader.prepend(conditional_mutex)
+end
+
+# clone Rails logger
+Rails.configuration.after_initialize do
+  if Rails.logger && !Rage.logger
+    rails_logdev = Rails.logger.instance_variable_get(:@logdev)
+    Rage.config.logger = Rage::Logger.new(rails_logdev) if rails_logdev.is_a?(Logger::LogDevice)
+  end
+end

data/lib/rage/request.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "time"
+
 class Rage::Request
   # @private
   def initialize(env)
@@ -14,6 +16,55 @@ class Rage::Request
     @headers ||= Headers.new(@env)
   end
 
+  # Check if the request is fresh.
+  # @param etag [String] The etag of the requested resource.
+  # @param last_modified [Time] The last modified time of the requested resource.
+  # @return [Boolean] True if the request is fresh, false otherwise.
+  # @example
+  #  request.fresh?(etag: "123", last_modified: Time.utc(2023, 12, 15))
+  #  request.fresh?(last_modified: Time.utc(2023, 12, 15))
+  #  request.fresh?(etag: "123")
+  def fresh?(etag:, last_modified:)
+    # Always render response when no freshness information
+    # is provided in the request.
+    return false unless if_none_match || if_not_modified_since
+
+    etag_matches?(
+      requested_etags: if_none_match, response_etag: etag
+    ) && not_modified?(
+      request_not_modified_since: if_not_modified_since,
+      response_last_modified: last_modified
+    )
+  end
+
+  private
+
+  def if_none_match
+    headers["HTTP_IF_NONE_MATCH"]
+  end
+
+  def if_not_modified_since
+    headers["HTTP_IF_MODIFIED_SINCE"] ? Time.httpdate(headers["HTTP_IF_MODIFIED_SINCE"]) : nil
+  rescue ArgumentError
+    nil
+  end
+
+  def etag_matches?(requested_etags:, response_etag:)
+    requested_etags = requested_etags ? requested_etags.split(",").each(&:strip!) : []
+
+    return true if requested_etags.empty?
+    return false if response_etag.nil?
+
+    requested_etags.include?(response_etag) || requested_etags.include?("*")
+  end
+
+  def not_modified?(request_not_modified_since:, response_last_modified:)
+    return true if request_not_modified_since.nil?
+    return false if response_last_modified.nil?
+
+    request_not_modified_since >= response_last_modified
+  end
+
   # @private
   class Headers
     HTTP = "HTTP_"

data/lib/rage/response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class Rage::Response
+  # @private
+  def initialize(headers, body)
+    @headers = headers
+    @body = body
+  end
+
+  # Returns the content of the response as a string. This contains the contents of any calls to `render`.
+  # @return [String]
+  def body
+    @body[0]
+  end
+
+  # Returns the headers for the response.
+  # @return [Hash]
+  def headers
+    @headers
+  end
+end

data/lib/rage/router/backend.rb

@@ -14,6 +14,11 @@ class Rage::Router::Backend
     @constrainer = Rage::Router::Constrainer.new({})
   end
 
+  def reset_routes
+    @routes = []
+    @trees = {}
+  end
+
   def mount(path, handler, methods)
     raise "Mount handler should respond to `call`" unless handler.respond_to?(:call)
 
@@ -79,6 +84,9 @@ class Rage::Router::Backend
     end
 
     __on(method, path, handler, constraints, defaults, meta)
+
+  rescue Rage::Errors::RouterError => e
+    raise e unless Rage.code_loader.reloading?
   end
 
   def lookup(env)
@@ -280,7 +288,7 @@ class Rage::Router::Backend
     if Object.const_defined?(klass)
       Object.const_get(klass)
     else
-      raise "Routing error: could not find the #{klass} class"
+      raise Rage::Errors::RouterError, "Routing error: could not find the #{klass} class"
     end
   end
 end

data/lib/rage/router/dsl.rb

@@ -7,6 +7,8 @@ class Rage::Router::DSL
 
   def draw(&block)
     Handler.new(@router).instance_eval(&block)
+    # propagate route definitions to Rails for `rails routes` to work
+    Rails.application.routes.draw(&block) if Rage.config.internal.rails_mode
   end
 
   ##
@@ -283,7 +285,7 @@ class Rage::Router::DSL
       end
 
       _module, _path, _only, _except, _param = opts.values_at(:module, :path, :only, :except, :param)
-      raise ":param option can't contain colons" if _param&.include?(":")
+      raise ":param option can't contain colons" if _param.to_s.include?(":")
 
       _only = Array(_only) if _only
       _except = Array(_except) if _except

data/lib/rage/setup.rb

@@ -2,22 +2,10 @@ Iodine.patch_rack
 
 require_relative "#{Rage.root}/config/environments/#{Rage.env}"
 
+# Run application initializers
+Dir["#{Rage.root}/config/initializers/**/*.rb"].each { |initializer| load(initializer) }
 
-# load application files
-app, bad = Dir["#{Rage.root}/app/**/*.rb"], []
-
-loop do
-  path = app.shift
-  break if path.nil?
-
-  require_relative path
-
-# push the file to the end of the list in case it depends on another file that has not yet been required;
-# re-raise if only errored out files are left
-rescue NameError
-  raise if (app - bad).empty?
-  app << path
-  bad << path
-end
+# Load application classes
+Rage.code_loader.setup
 
 require_relative "#{Rage.root}/config/routes"

data/lib/rage/templates/config-environments-development.rb

@@ -7,4 +7,6 @@ Rage.configure do
 
   # Specify the logger
   config.logger = Rage::Logger.new(STDOUT)
+
+  config.middleware.use Rage::Reloader
 end

data/lib/rage/version.rb

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

data/lib/rage-rb.rb

@@ -28,7 +28,7 @@ module Rage
   end
 
   def self.env
-    @__env ||= Rage::Env.new(ENV["RAGE_ENV"] || ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development")
+    @__env ||= Rage::Env.new(ENV["RAGE_ENV"])
   end
 
   def self.groups
@@ -45,10 +45,32 @@ module Rage
 
   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
   end
 
+  def self.code_loader
+    @code_loader ||= Rage::CodeLoader.new
+  end
+
   module Router
     module Strategies
     end

data/rage.gemspec

@@ -30,4 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "thor", "~> 1.0"
   spec.add_dependency "rack", "~> 2.0"
   spec.add_dependency "rage-iodine", "~> 3.0"
+  spec.add_dependency "zeitwerk", "~> 2.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rage-rb
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Roman Samoilov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-11 00:00:00.000000000 Z
+date: 2024-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
 description:
 email:
 - rsamoi@icloud.com
@@ -74,17 +88,23 @@ files:
 - lib/rage/all.rb
 - lib/rage/application.rb
 - lib/rage/cli.rb
+- lib/rage/code_loader.rb
 - lib/rage/configuration.rb
 - lib/rage/controller/api.rb
 - lib/rage/env.rb
 - lib/rage/errors.rb
 - lib/rage/fiber.rb
 - lib/rage/fiber_scheduler.rb
-- lib/rage/fiber_wrapper.rb
+- lib/rage/logger/json_formatter.rb
 - lib/rage/logger/logger.rb
 - lib/rage/logger/text_formatter.rb
+- lib/rage/middleware/cors.rb
+- lib/rage/middleware/fiber_wrapper.rb
+- lib/rage/middleware/reloader.rb
 - lib/rage/params_parser.rb
+- lib/rage/rails.rb
 - lib/rage/request.rb
+- lib/rage/response.rb
 - lib/rage/router/README.md
 - lib/rage/router/backend.rb
 - lib/rage/router/constrainer.rb
@@ -101,6 +121,7 @@ files:
 - lib/rage/templates/config-environments-development.rb
 - lib/rage/templates/config-environments-production.rb
 - lib/rage/templates/config-environments-test.rb
+- lib/rage/templates/config-initializers-.keep
 - lib/rage/templates/config-routes.rb
 - lib/rage/templates/config.ru
 - lib/rage/templates/lib-.keep