rage-rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 213f5a221d8e6cac6f5fde63e3ffaf17ea9258b8e62b22e101669efac42b3e03
+  data.tar.gz: 8a2ff71ae4ade7ac77b4734557b345e93794a2a7559d7ca2f65186e102bfad75
+SHA512:
+  metadata.gz: 2389af124774b3c65aab25b88082df641af660a047d050ec0ac494f64a0d01054bd649b95e91cce0dacf98a685a749002e0fcebbf10bf6660f85b5b06faf0c2f
+  data.tar.gz: 20d7122017e6fdb1084a762e6326cc5e140b814014353dcb88ea525f38cfe9a23cb8fc2a64e8a27e4b772231b8cb5b10cb74b2e000846f14316404ea79b7b6b9

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-09-15
+
+- Initial release
+  - Add console utility to generate new apps and start up the server.
+  - Implement base API controller:
+    - support `before_action` with the `only` and `except` options;
+    - support `render` with the `json`, `plain` and `status` options;
+    - support the `head` method;
+  - Implement router:
+    - support the `root`, `get`, `post`, `patch`, `put`, `delete` methods;
+    - support the `scope` method with the `path` and `module` options;
+    - support `host` constraint;
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at roman.samoilov@wework.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rage.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Roman Samoilov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,96 @@
+# Rage
+
+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:
+
+* **Rails compatible API** - Rails' API is clean, straightforward, and simply makes sense. I believe it was one of the reasons why Rails was so successful in the past.
+
+* **High performance** - some think performance is not a major metric for a framework, but I don't believe it's true. Poor performance is a risk, and in today's world, companies refuse to use risky technologies.
+
+* **API-only** - the only technology we should use to create web UI is JavaScript. I recommend checking out [Vite](https://vitejs.dev) if you don't know where to start.
+
+* **Acceptance of modern Ruby** - the framework includes a fiber scheduler, which means your code never blocks while waiting on IO.
+
+This framework results from reflecting on [Ruby's declining popularity](https://survey.stackoverflow.co/2023/#most-popular-technologies-language) and attempting to answer why this is happening and what we, as a community, could be doing differently.
+
+## Installation
+
+Install the gem:
+```
+$ gem install rage
+```
+
+Create a new app:
+```
+$ rage new my_app
+```
+
+Switch to your new application and install dependencies:
+```
+$ cd my_app
+$ bundle
+```
+
+Start up the server and visit http://localhost:3000.
+```
+$ rage s
+```
+
+Start coding!
+
+## Benchmarks
+
+#### hello world
+
+```ruby
+class ArticlesController < ApplicationController
+  def index
+    render json: { hello: "world" }
+  end
+end
+```
+![Requests per second](https://github.com/rage-rb/rage/assets/2270393/7d9f408c-7cec-4cc0-a509-66c9dedc1d0a)
+
+#### waiting on IO
+
+```ruby
+require "net/http"
+
+class ArticlesController < ApplicationController
+  def index
+    Net::HTTP.get(URI("<endpoint-that-responds-in-one-second>"))
+    head :ok
+  end
+end
+```
+![Time to complete 100 requests](https://github.com/rage-rb/rage/assets/2270393/007044e9-efe0-4675-9cab-8a4868154118)
+
+## Milestones
+
+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.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`.
+0.6 | Expose the `cookies` object.<br>Expose the `send_data` and `send_file` methods.<br>Support conditional get with `etag` and `last_modified`.
+0.7 | Add request logging.
+0.8 | Collect app metrics.
+0.9 | Automatic code reloading in development.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rage-rb/rage. 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/rage-rb/rage/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rage project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rage-rb/rage/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/exe/rage

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/rage/cli"
+Rage::CLI.start

data/lib/rage/application.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+class Rage::Application
+  def initialize(router)
+    Fiber.set_scheduler(Rage::FiberScheduler.new)
+    @router = router
+  end
+
+  def call(env)
+    fiber = Fiber.schedule do
+      handler = @router.lookup(env)
+
+      if handler
+        handler[:handler].call(env, handler[:params])
+      else
+        [404, {}, ["Not Found"]]
+      end
+
+    rescue => e
+      [500, {}, ["#{e.class}:#{e.message}\n\n#{e.backtrace.join("\n")}"]]
+
+    ensure
+      # notify Iodine the request can now be served
+      Iodine.publish(env["IODINE_REQUEST_ID"], "")
+    end
+
+    # the fiber encountered blocking IO and yielded; instruct Iodine to pause the request;
+    if fiber.alive?
+      [:__http_defer__, fiber]
+    else
+      fiber.__get_result
+    end
+  end
+end

data/lib/rage/cli.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "thor"
+require "iodine"
+require "rack"
+
+module Rage
+  class CLI < Thor
+    def self.exit_on_failure?
+      true
+    end
+
+    desc "new PATH", "Create a new application."
+    def new(path)
+      NewAppGenerator.start([path])
+    end
+
+    desc "s", "Start the app server."
+    def server
+      app = ::Rack::Builder.parse_file("config.ru")
+      app = app[0] if app.is_a?(Array)
+
+      ::Iodine.listen service: :http, handler: app
+      ::Iodine.threads = 1
+      ::Iodine.start
+    end
+  end
+
+  class NewAppGenerator < Thor::Group
+    include Thor::Actions
+
+    argument :path, type: :string
+
+    def self.source_root
+      File.expand_path("templates", __dir__)
+    end
+
+    def create_directory
+      empty_directory(path)
+    end
+
+    def copy_files
+      Dir.glob("*", base: self.class.source_root).each do |template|
+        *template_path_parts, template_name = template.split("-")
+        template(template, "#{path}/#{template_path_parts.join("/")}/#{template_name}")
+      end
+    end
+  end
+end

data/lib/rage/controller/api.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+class RageController::API
+  class << self
+    def __register_action(action)
+      raise "The action '#{action}' could not be found for #{self}" unless method_defined?(action)
+
+      before_actions_chunk = if @__before_actions
+        filtered_before_actions = @__before_actions.select do |h|
+          (h[:only].nil? || h[:only].include?(action)) &&
+            (h[:except].nil? || !h[:except].include?(action))
+        end
+
+        lines = filtered_before_actions.map do |h|
+          <<-RUBY
+            #{h[:name]}
+            return [@__status, @__headers, @__body] if @__rendered
+          RUBY
+        end
+
+        lines.join("\n")
+      else
+        ""
+      end
+
+      class_eval <<-RUBY
+        def __run_#{action}
+          #{before_actions_chunk}
+          #{action}
+
+          [@__status, @__headers, @__body]
+        end
+      RUBY
+    end
+
+    # Register a new `before_action` hook.
+    #
+    # @param action_name [String] the name of the callback to add
+    # @param only [Symbol, Array<Symbol>] restrict the callback to run only for specific actions
+    # @param except [Symbol, Array<Symbol>] restrict the callback to run for all actions except specified
+    # @example
+    #   before_action :find_photo, only: :show
+    #   def find_photo
+    #     ...
+    #   end
+    def before_action(action_name, only: nil, except: nil)
+      (@__before_actions ||= []) << {
+        name: action_name,
+        only: only && Array(only),
+        except: except && Array(except)
+      }
+    end
+  end # class << self
+
+  DEFAULT_HEADERS = { "content-type" => "application/json; charset=utf-8" }.freeze
+
+  def initialize(env, params)
+    @__env = env
+    @__params = params
+    @__status, @__headers, @__body = 204, DEFAULT_HEADERS, []
+    @__rendered = false
+  end
+
+  # Send a response to the client.
+  #
+  # @param json [String, Object] send a json response to the client; objects like arrays will be serialized automatically
+  # @param plain [String] send a text response to the client
+  # @param status [Integer, Symbol] set a response status
+  # @example
+  #   render json: { hello: "world" }
+  # @example
+  #   render status: :ok
+  # @example
+  #   render plain: "hello world", status: 201
+  # @note `render` doesn't terminate execution of the action, so if you want to exit an action after rendering, you need to do something like 'render(...) and return'
+  def render(json: nil, plain: nil, status: nil)
+    raise "Render was called multiple times in this action" if @__rendered
+    @__rendered = true
+
+    if json || plain
+      @__body << if json
+        json.is_a?(String) ? json : json.to_json
+      else
+        set_header("content-type", "text/plain; charset=utf-8")
+        plain
+      end
+
+      @__status = 200
+    end
+
+    if status
+      @__status = if status.is_a?(Symbol)
+        ::Rack::Utils::SYMBOL_TO_STATUS_CODE[status]
+      else
+        status
+      end
+    end
+  end
+
+  # Send a response with no body.
+  #
+  # @param status [Integer, Symbol] set a response status
+  # @example
+  #   head :unauthorized
+  # @example
+  #   head 429
+  def head(status)
+    @__rendered = true
+
+    @__status = if status.is_a?(Symbol)
+      ::Rack::Utils::SYMBOL_TO_STATUS_CODE[status]
+    else
+      status
+    end
+  end
+
+  private
+
+  def set_header(key, value)
+    @__headers = @__headers.dup if DEFAULT_HEADERS.equal?(@__headers)
+    @__headers[key] = value
+  end
+end

data/lib/rage/fiber.rb

@@ -0,0 +1,9 @@
+class Fiber
+  def __set_result(result)
+    @__result = result
+  end
+
+  def __get_result
+    @__result
+  end
+end

data/lib/rage/fiber_scheduler.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+class Rage::FiberScheduler
+  def io_wait(io, events, timeout = nil)
+    f = Fiber.current
+    ::Iodine::Scheduler.attach(io.fileno, events, timeout&.ceil || 0) { f.resume }
+    Fiber.yield
+
+    events
+  end
+
+  # TODO: this is more synchronous than asynchronous right now
+  def io_read(io, buffer, length, offset = 0)
+    loop do
+      string = ::Iodine::Scheduler.read(io.fileno, length, offset)
+
+      if string.nil?
+        return offset
+      end
+
+      if string.empty?
+        io_wait(io, IO::READABLE)
+        next
+      end
+
+      buffer.set_string(string, offset)
+      offset += string.bytesize
+
+      size = string.bytesize
+      break if size >= length
+      length -= size
+    end
+
+    offset
+  end
+
+  def io_write(io, buffer, length, offset = 0)
+    bytes_to_write = length
+    bytes_to_write = buffer.size if length == 0
+
+    ::Iodine::Scheduler.write(io.fileno, buffer.get_string, bytes_to_write, offset)
+
+    buffer.size - offset
+  end
+
+  def kernel_sleep(duration = nil)
+    if duration
+      f = Fiber.current
+      ::Iodine.run_after((duration * 1000).to_i) { f.resume } 
+      Fiber.yield
+    end
+  end
+
+  # TODO: GC works a little strange with this closure;
+  # 
+  # def timeout_after(duration, exception_class = Timeout::Error, *exception_arguments, &block)
+  #   fiber, block_status = Fiber.current, :running
+  #   ::Iodine.run_after((duration * 1000).to_i) do
+  #     fiber.raise(exception_class, exception_arguments) if block_status == :running
+  #   end
+
+  #   result = block.call
+  #   block_status = :finished
+
+  #   result
+  # end
+
+  def address_resolve(hostname)
+    Resolv.getaddresses(hostname)
+  end
+
+  def block(blocker, timeout = nil)
+    f = Fiber.current
+    ::Iodine.subscribe("unblock:#{f.object_id}") do
+      ::Iodine.defer { ::Iodine.unsubscribe("unblock:#{f.object_id}") }
+      f.resume
+    end
+    # TODO support timeout
+    Fiber.yield
+  end
+
+  def unblock(_blocker, fiber)
+    ::Iodine.publish("unblock:#{fiber.object_id}", "")
+  end
+
+  def fiber(&block)
+    fiber = Fiber.new(blocking: false) do
+      Fiber.current.__set_result(block.call)
+    end
+    fiber.resume
+
+    fiber
+  end
+
+  def close
+    ::Iodine::Scheduler.close
+  end
+end

data/lib/rage/router/README.md

@@ -0,0 +1,19 @@
+This is an almost complete rewrite of https://github.com/delvedor/find-my-way.
+
+Currrently, the only constraint supported is the `host` constraint. Regexp constraints are likely to be added. Custom/lambda constraints are unlikely to be added.
+
+Compared to the Rails router, the most notable difference except constraints is that a wildcard segment can only be in the last section of the path and cannot be named.
+
+```ruby
+Rage.routes.draw do
+  get "photos/:id", to: "photos#show", constraints: { host: /myhost/ }
+
+  scope path: "api/v1", module: "api/v1" do
+    get "photos/:id", to: "photos#show"
+  end
+
+  root to: "photos#index"
+
+  get "*", to: ->(env) { [404, {}, [{ message: "Not Found" }.to_json]] }
+end
+```