rage-rb 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15d0d4682a307384b3e291b5b9d2f4f0323fc5ca74966b06a856a1f1367da01d
-  data.tar.gz: 4a5d0f7ef64f5b70615e0b1f43a170ba7072b0b44d908858cf43d5dc4cc3fb2d
+  metadata.gz: abee0787faa5947d8ecb03f9c5851cb669295bc2bd52abe5513e7b10940ddfff
+  data.tar.gz: d167a4d6a48dbced809578f3c3a569c5ccdb913ed7bf51eba3e8d054b61e1c75
 SHA512:
-  metadata.gz: d7c3a2cf837d4038618e925508af8b536040927cc9506beaed3f312f1176903dc5a0a1141c47321eb5b7f2ba20a21e4e9e635d54e098ed7b4e04ec93fba08da0
-  data.tar.gz: e48c1bf19c83f09a21f5b0c8c731db109a24fe0c37de870454b2b155c5d85be98c890d555bec1b78a00c19f91e7a25a3cbc99df6937561d30a88e96027d10e4d
+  metadata.gz: eea4d03aa25b675fdf1f19836037dceaeb7f38e2227af9cafc1609d59b8f322d3e3fa49da7905b4c0dd783615d16ce6e592aa11f2fa934056d711f03aaafbb43
+  data.tar.gz: adf6eaaee9a88eef39631581ce52eaa311b5ac61797f481a95e28502ccabf166615a87e215b5f5b3260ebdfbb5c28f8c32e1e8342566d9d23836e56eb97b14d8

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.5.2] - 2023-12-11
+
+### Added
+
+- Add env class (#43).
+
+### Changed
+
+- Schedule request Fibers in a separate middleware (#48).
+
 ## [0.5.1] - 2023-12-01
 
 ### Fixed

data/README.md

@@ -4,6 +4,8 @@
 
 [![Gem Version](https://badge.fury.io/rb/rage-rb.svg)](https://badge.fury.io/rb/rage-rb)
 ![Tests](https://github.com/rage-rb/rage/actions/workflows/main.yml/badge.svg)
+![Ruby Requirement](https://img.shields.io/badge/Ruby-3.1%2B-%23f40000)
+
 
 Inspired by [Deno](https://deno.com) and built on top of [Iodine](https://github.com/rage-rb/iodine), this is a Ruby web framework that is based on the following design principles:
 
@@ -11,7 +13,7 @@ Inspired by [Deno](https://deno.com) and built on top of [Iodine](https://github
 
 * **High performance** - some think performance is not a major metric for a framework, but it's not true. Poor performance is a risk, and in today's world, companies refuse to use risky technologies.
 
-* **API-only** - the only technology we should be using to create web UI is JavaScript. Using native technologies is always the most flexible, scalable, and simple solution in the long run. Check out [Vite](https://vitejs.dev) if you don't know where to start.
+* **API-only** - separation of concerns is one of the most fundamental principles in software development. Backend and frontend are very different layers with different goals and paths to those goals. Separating BE code from FE code results in a much more sustainable architecture compared with classic Rails monoliths.
 
 * **Acceptance of modern Ruby** - the framework includes a fiber scheduler, which means your code never blocks while waiting on IO.
 

data/lib/rage/all.rb

@@ -9,6 +9,7 @@ require_relative "request"
 require_relative "uploaded_file"
 require_relative "errors"
 require_relative "params_parser"
+require_relative "fiber_wrapper"
 
 require_relative "router/strategies/host"
 require_relative "router/backend"

data/lib/rage/application.rb

@@ -2,41 +2,28 @@
 
 class Rage::Application
   def initialize(router)
-    Iodine.on_state(:on_start)  do
-      Fiber.set_scheduler(Rage::FiberScheduler.new)
-    end
     @router = router
   end
 
   def call(env)
-    fiber = Fiber.schedule do
-      init_logger
-
-      handler = @router.lookup(env)
+    init_logger
 
-      response = if handler
-        params = Rage::ParamsParser.prepare(env, handler[:params])
-        handler[:handler].call(env, params)
-      else
-        [404, {}, ["Not Found"]]
-      end
+    handler = @router.lookup(env)
 
-    rescue Exception => e
-      exception_str = "#{e.class} (#{e.message}):\n#{e.backtrace.join("\n")}"
-      Rage.logger.error(exception_str)
-      response = [500, {}, [exception_str]]
-
-    ensure
-      finalize_logger(env, response, params)
-      Iodine.publish(env["IODINE_REQUEST_ID"], "") # notify Iodine the request can now be served
-    end
-
-    # the fiber encountered blocking IO and yielded; instruct Iodine to pause the request;
-    if fiber.alive?
-      [:__http_defer__, fiber]
+    response = if handler
+      params = Rage::ParamsParser.prepare(env, handler[:params])
+      handler[:handler].call(env, params)
     else
-      fiber.__get_result
+      [404, {}, ["Not Found"]]
     end
+
+  rescue Exception => e
+    exception_str = "#{e.class} (#{e.message}):\n#{e.backtrace.join("\n")}"
+    Rage.logger.error(exception_str)
+    response = [500, {}, [exception_str]]
+
+  ensure
+    finalize_logger(env, response, params)
   end
 
   private

data/lib/rage/cli.rb

@@ -20,6 +20,13 @@ module Rage
       app = ::Rack::Builder.parse_file("config.ru")
       app = app[0] if app.is_a?(Array)
 
+      unless app.is_a?(Rage::FiberWrapper)
+        raise <<-ERR
+          Couldn't find the default middleware. Make sure to add the following line to your config.ru file:
+          Rage.load_middlewares(self)
+        ERR
+      end
+
       ::Iodine.listen service: :http, handler: app, port: options[:port] || Rage.config.server.port
       ::Iodine.threads = Rage.config.server.threads_count
       ::Iodine.workers = Rage.config.server.workers_count

data/lib/rage/configuration.rb

@@ -8,6 +8,10 @@ class Rage::Configuration
     @server ||= Server.new
   end
 
+  def middleware
+    @middleware ||= Middleware.new
+  end
+
   class Server
     attr_accessor :port, :workers_count
     attr_reader :threads_count
@@ -19,6 +23,43 @@ class Rage::Configuration
     end
   end
 
+  class Middleware
+    attr_reader :middlewares
+
+    def initialize
+      @middlewares = [[Rage::FiberWrapper]]
+    end
+
+    def use(new_middleware, *args, &block)
+      insert_after(@middlewares.length - 1, new_middleware, *args, &block)
+    end
+
+    def insert_before(existing_middleware, new_middleware, *args, &block)
+      index = find_middleware_index(existing_middleware)
+      @middlewares = (@middlewares[0...index] + [[new_middleware, args, block]] + @middlewares[index..]).uniq(&:first)
+    end
+
+    def insert_after(existing_middleware, new_middleware, *args, &block)
+      index = find_middleware_index(existing_middleware)
+      @middlewares = (@middlewares[0..index] + [[new_middleware, args, block]] + @middlewares[index + 1..]).uniq(&:first)
+    end
+
+    private
+
+    def find_middleware_index(middleware)
+      if middleware.is_a?(Integer)
+        if middleware < 0 || middleware >= @middlewares.length
+          raise ArgumentError, "Middleware index should be in the (0...#{@middlewares.length}) range"
+        end
+        middleware
+      else
+        @middlewares.index { |m, _, _| m == middleware }.tap do |i|
+          raise ArgumentError, "Couldn't find #{middleware} in the middleware stack" unless i
+        end
+      end
+    end
+  end
+
   def __finalize
     @logger ||= Rage::Logger.new(nil)
     @logger.formatter = @log_formatter if @logger && @log_formatter

data/lib/rage/env.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+class Rage::Env
+  STANDARD_ENVS = %w(development test staging production)
+
+  def initialize(env)
+    @env = env
+
+    STANDARD_ENVS.each do |standard_env|
+      self.class.define_method("#{standard_env}?") { false } if standard_env != @env
+    end
+    self.class.define_method("#{@env}?") { true }
+  end
+
+  def method_missing(method_name, *, &)
+    method_name.end_with?("?") ? false : super
+  end
+
+  def respond_to_missing?(method_name, include_private = false)
+    method_name.end_with?("?")
+  end
+
+  def ==(other)
+    @env == other
+  end
+
+  def to_sym
+    @env.to_sym
+  end
+
+  def to_s
+    @env
+  end
+end

data/lib/rage/fiber.rb

@@ -23,6 +23,16 @@ class Fiber
     @__err
   end
 
+   # @private
+  def __get_id
+    @__rage_id ||= object_id.to_s
+  end
+
+  # @private
+  def __yielded?
+    !@__rage_id.nil?
+  end
+
   # @private
   # pause a fiber and resume in the next iteration of the event loop
   def self.pause

data/lib/rage/fiber_wrapper.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+##
+# The middleware wraps every request in a Fiber and implements the custom defer protocol with Iodine.
+# Scheduling fibers in a middleware allows the framework to be compatibe with custom Rack middlewares.
+#
+class Rage::FiberWrapper
+  def initialize(app)
+    Iodine.on_state(:on_start) do
+      Fiber.set_scheduler(Rage::FiberScheduler.new)
+    end
+    @app = app
+  end
+
+  def call(env)
+    fiber = Fiber.schedule do
+      @app.call(env)
+    ensure
+      Iodine.publish(Fiber.current.__get_id, "", Iodine::PubSub::PROCESS) if Fiber.current.__yielded?
+    end
+
+    if fiber.alive?
+      [:__http_defer__, fiber]
+    else
+      fiber.__get_result
+    end
+  end
+end

data/lib/rage/templates/config.ru

@@ -1,3 +1,4 @@
 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 = "0.5.1"
+  VERSION = "0.5.2"
 end

data/lib/rage-rb.rb

@@ -28,7 +28,7 @@ module Rage
   end
 
   def self.env
-    @__env ||= ENV["RAGE_ENV"] || ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
+    @__env ||= Rage::Env.new(ENV["RAGE_ENV"] || ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development")
   end
 
   def self.groups
@@ -43,6 +43,12 @@ module Rage
     @logger ||= config.logger
   end
 
+  def self.load_middlewares(rack_builder)
+    config.middleware.middlewares.each do |middleware, args, block|
+      rack_builder.use(middleware, *args, &block)
+    end
+  end
+
   module Router
     module Strategies
     end
@@ -51,3 +57,5 @@ end
 
 module RageController
 end
+
+require_relative "rage/env"

data/rage.gemspec

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rage-rb
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Roman Samoilov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-01 00:00:00.000000000 Z
+date: 2023-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.0'
 description:
 email:
 - rsamoi@icloud.com
@@ -76,9 +76,11 @@ files:
 - lib/rage/cli.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/logger.rb
 - lib/rage/logger/text_formatter.rb
 - lib/rage/params_parser.rb