rage-rb 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3aacbd2e65fda6a0e7a7f7a24e67f718e55fd66bd3e0a6c6d3a1a319294be44b
-  data.tar.gz: 40d3d2225cf40bf0f125884afd99a86b47b34f6dddce5fdeea0a9b5239fdfd0a
+  metadata.gz: 7684c979952ee81bee165b9b667dea87199f3fa28dadadc4878b29a12211fdac
+  data.tar.gz: 2428443ee2456ef375990decfbf36a2952670ee517ac07cf4c994f5b9b7076f9
 SHA512:
-  metadata.gz: 288d8f707d78901e9c209cc3af075bcf3c37c7ef0ff4c24355702bd3898ab2e041afc5ab028e4cbe09e26a95f7297e01af03430ac6f126fd5d6cfa0b772f0e5e
-  data.tar.gz: 5c70306e1901176e5da774dcb153e21c382359825a2527a7de97ce75772dfdf6a510ac3ffba05486b684b55634a4173596d9469306571acf58ffff274a6185c9
+  metadata.gz: f59da6b77e69fa2b89761b30a497b4c0fa8f02cbabeed65c953b0f5e807b349e5b305bf31564bcc3eaeed4957215766e8781af5a5b8bbd9754e0461fa18f7b87
+  data.tar.gz: 733a15ef91abcbfc079a3bbbb83f82686038059b3c518c1c0a279e8000ad885c65cc5019cc691e2731fa1e59ca1f62e8fe95c8f454837ed0bdc65e181157ffc7

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,32 @@
 ## [Unreleased]
 
+## [0.3.0] - 2023-10-08
+
+### Added
+
+- CLI `routes` task.
+- CLI `console` task.
+- `:if` and `:unless` options in `before_action`.
+- Allow to set response headers.
+- Block version of `before_action`.
+
+## [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/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,8 +141,8 @@ 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.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.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 :white_check_mark: | ~~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`.

data/lib/rage/cli.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
-
 require "thor"
 require "rage"
+require "irb"
 
 module Rage
   class CLI < Thor
@@ -25,11 +25,81 @@ module Rage
 
       ::Iodine.start
     end
+
+    desc 'routes', 'List all routes.'
+    option :grep, aliases: "-g", desc: "Filter routes by pattern"
+    def routes
+      # the result would be something like this:
+      # Action    Verb  Path  Controller#Action
+      # index     GET   /     application#index
+
+      # load config/application.rb
+      environment
+
+      routes = Rage.__router.routes
+
+      pattern = options[:grep]
+
+      if pattern
+        routes = routes.select do |route|
+          route[:path].match?(pattern) || route[:raw_handler].to_s.match?(pattern) || route[:method].match?(pattern)
+        end
+      end
+
+      return puts 'Action    Verb  Path  Controller#Action' if routes.empty?
+  
+      # construct a table
+      table = []
+
+      # longest_path is either the length of the longest path or 5
+      longest_path = routes.map { |route| route[:path].length }.max + 3
+      longest_path = longest_path > 5 ? longest_path : 5
+
+      longest_verb = routes.map { |route| route[:method].length }.max + 3
+      longest_verb = longest_verb > 4 ? longest_verb : 7
+
+      # longest_handler is either the length of the longest handler or 7, since DELETE is the longest HTTP method
+      longest_handler = routes.map { |route| route[:raw_handler].is_a?(Proc) ? 7 : route[:raw_handler].split('#').last.length }.max + 3
+      longest_handler = longest_handler > 7 ? longest_handler : 7
+
+      # longest_controller is either the length of the longest controller or 12, since Controller#{length} is the longest controller
+      longest_controller = routes.map { |route| route[:raw_handler].is_a?(Proc) ? 7 : route[:raw_handler].to_s.length }.max + 3
+      longest_controller = longest_controller > 12 ? longest_controller : 12
+
+      routes.each do |route|
+        table << [
+          format("%- #{longest_handler}s", route[:raw_handler].is_a?(Proc) ? 'Lambda' : route[:raw_handler].split('#').last),
+          format("%- #{longest_verb}s", route[:method]),
+          format("%- #{longest_path}s", route[:path]),
+          format("%- #{longest_controller}s", route[:raw_handler].is_a?(Proc) ? 'Lambda' : route[:raw_handler])
+        ]
+      end
+
+      table.unshift([format("%- #{longest_handler}s", 'Action'), format("%- #{longest_verb}s", 'Verb'), format("%- #{longest_path}s", 'Path'),
+                     format("%- #{longest_path}s", "Controller#Action\n")])
+      # print the table
+      table.each do |row|
+        # this should be changed to use the main logger when added
+        puts row.join
+      end
+    end
+
+    desc "c", "Start the app console."
+    def console
+      environment
+      ARGV.clear
+      IRB.start
+    end
+
+    private
+
+    def environment
+      require File.expand_path("config/application.rb", Dir.pwd)
+    end
   end
 
   class NewAppGenerator < Thor::Group
     include Thor::Actions
-
     argument :path, type: :string
 
     def self.source_root

data/lib/rage/controller/api.rb

@@ -12,13 +12,21 @@ class RageController::API
 
       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))
+          (!h[:only] || h[:only].include?(action)) &&
+            (!h[:except] || !h[:except].include?(action))
         end
 
         lines = filtered_before_actions.map do |h|
+          condition = if h[:if] && h[:unless]
+            "if #{h[:if]} && !#{h[:unless]}"
+          elsif h[:if]
+            "if #{h[:if]}"
+          elsif h[:unless]
+            "unless #{h[:unless]}"
+          end
+
           <<-RUBY
-            #{h[:name]}
+            #{h[:name]} #{condition}
             return [@__status, @__headers, @__body] if @__rendered
           RUBY
         end
@@ -65,6 +73,16 @@ class RageController::API
       klass.__rescue_handlers = @__rescue_handlers.freeze
     end
 
+    # @private
+    @@__tmp_name_seed = ("a".."i").to_a.permutation
+
+    # @private
+    # define temporary method based on a block
+    def define_tmp_method(block)
+      name = @@__tmp_name_seed.next.join
+      define_method("__rage_tmp_#{name}", block)
+    end
+
     ############
     #
     # PUBLIC API
@@ -89,8 +107,7 @@ class RageController::API
     def rescue_from(*klasses, with: nil, &block)
       unless with
         if block_given?
-          name = ("a".."z").to_a.sample(15).join
-          with = define_method("__#{name}", &block)
+          with = define_tmp_method(block)
         else
           raise "No handler provided. Pass the `with` keyword argument or provide a block."
         end
@@ -107,21 +124,53 @@ class RageController::API
 
     # Register a new `before_action` hook. Calls with the same `action_name` will overwrite the previous ones.
     #
-    # @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
+    # @param action_name [String, nil] the name of the callback to add
+    # @param [Hash] opts action options
+    # @option opts [Symbol, Array<Symbol>] :only restrict the callback to run only for specific actions
+    # @option opts [Symbol, Array<Symbol>] :except restrict the callback to run for all actions except specified
+    # @option opts [Symbol, Proc] :if only run the callback if the condition is true
+    # @option opts [Symbol, Proc] :unless only run the callback if the condition is false
     # @example
     #   before_action :find_photo, only: :show
     #
     #   def find_photo
     #     Photo.first
     #   end
-    def before_action(action_name, only: nil, except: nil)
+    # @example
+    #   before_action :require_user, unless: :logged_in?
+    # @example
+    #   before_action :set_locale, if: -> { params[:locale] != "en-US" }
+    # @example
+    #   before_action do
+    #     unless logged_in? # would be `controller.send(:logged_in?)` in Rails
+    #       head :unauthorized
+    #     end
+    #   end
+    # @note The block form doesn't receive an argument and is executed on the controller level as if it was a regular method.
+    def before_action(action_name = nil, **opts, &block)
+      if block_given?
+        action_name = define_tmp_method(block)
+      elsif action_name.nil?
+        raise "No handler provided. Pass the `action_name` parameter or provide a block."
+      end
+
+       _only, _except, _if, _unless = opts.values_at(:only, :except, :if, :unless)
+
       if @__before_actions && @__before_actions.frozen?
         @__before_actions = @__before_actions.dup
       end
 
-      action = { name: action_name, only: only && Array(only), except: except && Array(except) }
+      action = {
+        name: action_name,
+        only: _only && Array(_only),
+        except: _except && Array(_except),
+        if: _if,
+        unless: _unless
+      }
+      
+      action[:if] = define_tmp_method(action[:if]) if action[:if].is_a?(Proc)
+      action[:unless] = define_tmp_method(action[:unless]) if action[:unless].is_a?(Proc)
+
       if @__before_actions.nil?
         @__before_actions = [action]
       elsif i = @__before_actions.find_index { |a| a[:name] == action_name }
@@ -192,8 +241,8 @@ class RageController::API
       @__body << if json
         json.is_a?(String) ? json : json.to_json
       else
-        __set_header("content-type", "text/plain; charset=utf-8")
-        plain
+        headers["content-type"] = "text/plain; charset=utf-8"
+        plain.to_s
       end
 
       @__status = 200
@@ -225,11 +274,13 @@ class RageController::API
     end
   end
 
-  private
-
-  # copy-on-write implementation for the headers object
-  def __set_header(key, value)
-    @__headers = @__headers.dup if DEFAULT_HEADERS.equal?(@__headers)
-    @__headers[key] = value
+  # Set response headers.
+  #
+  # @example
+  #   headers["Content-Type"] = "application/pdf"
+  def headers
+    # copy-on-write implementation for the headers object
+    @__headers = {}.merge!(@__headers) if DEFAULT_HEADERS.equal?(@__headers)
+    @__headers
   end
 end

data/lib/rage/router/backend.rb

@@ -3,6 +3,8 @@
 require "uri"
 
 class Rage::Router::Backend
+  attr_reader :routes
+
   OPTIONAL_PARAM_REGEXP = /\/?\(\/?(:\w+)\/?\)/
   STRING_HANDLER_REGEXP = /^([a-z0-9_\/]+)#([a-z_]+)$/
 
@@ -12,7 +14,8 @@ class Rage::Router::Backend
     @constrainer = Rage::Router::Constrainer.new({})
   end
 
-  def on(method, path, handler, constraints: {})
+  def on(method, path, handler, constraints: {}, defaults: nil)
+    raw_handler = handler
     raise "Path could not be empty" if path&.empty?
 
     if match_index = (path =~ OPTIONAL_PARAM_REGEXP)
@@ -21,8 +24,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 +45,7 @@ class Rage::Router::Backend
       handler = ->(env, _params) { orig_handler.call(env) }
     end
 
-    __on(method, path, handler, constraints)
+    __on(method, path, handler, raw_handler, constraints, defaults)
   end
 
   def lookup(env)
@@ -52,7 +55,7 @@ class Rage::Router::Backend
 
   private
 
-  def __on(method, path, handler, constraints)
+  def __on(method, path, handler, raw_handler, constraints, defaults)
     @constrainer.validate_constraints(constraints)
     # Let the constrainer know if any constraints are being used now
     @constrainer.note_usage(constraints)
@@ -159,7 +162,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, raw_handler: raw_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/setup.rb

@@ -1,7 +1,23 @@
 Iodine.patch_rack
 
-project_root = Pathname.new(".").expand_path
+require_relative "#{Rage.root}/config/environments/#{Rage.env}"
 
-require_relative "#{project_root}/config/environments/#{Rage.env}"
-Dir["#{project_root}/app/**/*.rb"].each { |path| require_relative path }
-require_relative "#{project_root}/config/routes"
+
+# 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
+
+require_relative "#{Rage.root}/config/routes"

data/lib/rage/version.rb

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

data/lib/rage-rb.rb

@@ -3,6 +3,7 @@
 require "rack"
 require "json"
 require "iodine"
+require "pathname"
 
 module Rage
   def self.application
@@ -33,6 +34,10 @@ module Rage
     [:default, Rage.env.to_sym]
   end
 
+  def self.root
+    @root ||= Pathname.new(".").expand_path
+  end
+
   module Router
     module Strategies
     end

metadata

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