wallaby-core 0.3.0.beta2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86ff434d6a25fa665cb828cc1a1839166f386a71dff24afacb7a114402a81f50
-  data.tar.gz: 1a923d492ef62f597608a9c49f8a1341fe59687e8c4668749f3ad25d7a1b1c71
+  metadata.gz: 78bd6d5518f084f9d968a6e880148186171a5d9e57155750d695c50a6cf40b70
+  data.tar.gz: b61387cb2a538b3befff1646adfdf2b9c207585b9bc0f4a42f56bb5e34465820
 SHA512:
-  metadata.gz: 73183959d1177a5d707baae5c698e57f6e5ca47fe4b248e1014402dbe95c9015418d3d6d46194161c38543745c685a99bfacb73c197a1972e85beec758d8598c
-  data.tar.gz: ffdeeb4e9df6b63f281912c21acb758e0a7bb9d8863d38a5e081b5c81cbfed5bf4942910ebf8d03fcef2c90cb8cd66f3bf0d9763302f59ae084003ea4f82dfb3
+  metadata.gz: ce828c53a527a2dae0fe51aeb81e1a95d3282242f7b324de4f87542a6c670f90938612e0c263677cb3f2d68287fa182081a4a931762886d22467cdde0ec99d05
+  data.tar.gz: 5a18a775749c109e769d285d09d188c49f370faf13bde75e3a0ca7626ec31b95060b35fa5d4fd3a44b7438d433ca9f56b5b7966aa3bcbc01b43ae7d7256ef21a

data/app/security/ability.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # @!visibility private
-# Defualt ability for {Wallaby}
+# Default ability for {Wallaby}
 # If main app has defined `ability.rb`, this file will not be loaded/used.
 class Ability
   include ::CanCan::Ability if defined?(::CanCan)

data/config/routes.rb

@@ -5,42 +5,56 @@ Wallaby::Engine.routes.draw do
   # @see Wallaby::ApplicationConcern#healthy
   get 'status', to: 'wallaby/resources#healthy'
 
-  with_options to: Wallaby::ResourcesRouter.new do |route|
+  with_options to: Wallaby::ResourcesRouter.new do
     # @see Wallaby::ResourcesConcern#home
-    route.root defaults: { action: 'home' }
+    root defaults: { action: 'home' }
 
     # Error pages for all supported HTTP status in {Wallaby::ERRORS}
     Wallaby::ERRORS.each do |status|
       code = Rack::Utils::SYMBOL_TO_STATUS_CODE[status]
-      route.get status, defaults: { action: status.to_s }
-      route.get code.to_s, defaults: { action: status.to_s }
+      get status, defaults: { action: status.to_s }
+      get code.to_s, defaults: { action: status.to_s }
     end
 
     # resourceful routes.
     #
-    # `:resources` param here will be converted to the model class in the controller.
-    # For instance, `"order::items"` will become `Order::Item` later,
+    # `*resources` param here will be converted to the model class
+    # used in the controller that [Wallaby::ResourcesRouter] dispatches to.
+    # For instance, `"order/items"` will become `Order::Item` later,
     # and `Order::Item` will be used by servicer/authorizer/paginator through out the whole request process.
     #
-    # Using colons in the `:resources` param e.g. `"order::items"` instead of `"order/items"` is
-    # to make nested namespace possible to be handled by these dynamic routes.
     # @see Wallaby::ResourcesRouter
-    scope path: ':resources' do
-      # @see Wallaby::ResourcesConcern#index
-      route.get '', defaults: { action: 'index' }, as: :resources
-      # @see Wallaby::ResourcesConcern#new
-      route.get 'new', defaults: { action: 'new' }, as: :new_resource
-      # @see Wallaby::ResourcesConcern#edit
-      route.get ':id/edit', defaults: { action: 'edit' }, as: :edit_resource
-      # @see Wallaby::ResourcesConcern#show
-      route.get ':id', defaults: { action: 'show' }, as: :resource
-
-      # @see Wallaby::ResourcesConcern#create
-      route.post '', defaults: { action: 'create' }
-      # @see Wallaby::ResourcesConcern#update
-      route.match ':id', via: %i[patch put], defaults: { action: 'update' }
-      # @see Wallaby::ResourcesConcern#destroy
-      route.delete ':id', defaults: { action: 'destroy' }
+    constraints = {
+      id: Wallaby::LazyRegexp.new(:id_regexp),
+      resources: Wallaby::LazyRegexp.new(:resources_regexp)
+    }
+
+    scope path: '*resources' do
+      with_options(constraints: constraints) do
+        # NOTE: DO NOT change the order of the following routes!!!
+
+        # Exact match for `*resources/new`
+        # @see Wallaby::ResourcesConcern#new
+        get 'new', defaults: { action: 'new' }, as: :new_resource
+
+        # Match `*resources`
+        # `''` needs to be before `':id'` so that the resourcesful route will match `orders/items` with:
+        # `resources: 'orders/items'` instead of `resources: 'orders', id: 'items'`
+        # @see Wallaby::ResourcesConcern#index
+        get '', defaults: { action: 'index' }, as: :resources
+        # @see Wallaby::ResourcesConcern#create
+        post '', defaults: { action: 'create' }
+
+        # Match `*resources/:id`
+        # @see Wallaby::ResourcesConcern#edit
+        get ':id/edit', defaults: { action: 'edit' }, as: :edit_resource
+        # @see Wallaby::ResourcesConcern#show
+        get ':id', defaults: { action: 'show' }, as: :resource
+        # @see Wallaby::ResourcesConcern#update
+        match ':id', via: %i[patch put], defaults: { action: 'update' }
+        # @see Wallaby::ResourcesConcern#destroy
+        delete ':id', defaults: { action: 'destroy' }
+      end
     end
   end
 end

data/lib/adaptors/wallaby/custom/model_decorator.rb

@@ -9,9 +9,9 @@ module Wallaby
       def fields
         @fields ||=
           ::ActiveSupport::HashWithIndifferentAccess.new.tap do |hash|
-            methods = model_class.public_instance_methods(false).map(&:to_s)
+            methods = model_class.public_instance_methods.map(&:to_s)
             methods
-              .grep(/[^=]$/).select { |method_id| methods.include? "#{method_id}=" }
+              .grep(/(\A[^!=]|[^!=]\Z)/).select { |method_id| methods.include? "#{method_id}=" }
               .each { |attribute| hash[attribute] = { label: attribute.humanize, type: 'string' } }
           end.freeze
       end
@@ -45,7 +45,7 @@ module Wallaby
 
       # @return [String, Symbole] default to `:id`
       def primary_key
-        @primary_key ||= :id
+        @primary_key ||= fields.key?(:id) ? :id : fields.keys.first.try(:to_sym)
       end
 
       # @param resource [Object]

data/lib/forms/wallaby/form_builder.rb

@@ -20,7 +20,7 @@ module Wallaby
       content_tag :ul, class: 'errors' do
         errors.each do |message|
           concat content_tag :li, content_tag(
-            :small, raw(message) # rubocop:disable Rails/OutputSafety
+            :small, raw(message)
           )
         end
       end

data/lib/interfaces/wallaby/model_decorator.rb

@@ -7,7 +7,7 @@ module Wallaby
     include Fieldable
 
     MISSING_METHODS_RELATED_TO_FIELDS =
-      /\A(?<prefix>[a-zA-Z]\w*_)(?<method_partial>fields=?|field_names=?|metadata_of|label_of|type_of)\Z/.freeze
+      /\A(?<method_prefix>[a-zA-Z]\w*_)(?<method_suffix>fields=?|field_names=?|metadata_of|label_of|type_of)\Z/.freeze
 
     # Initialize with model class
     # @param model_class [Class]
@@ -123,7 +123,7 @@ module Wallaby
       return super unless method_name.match?(MISSING_METHODS_RELATED_TO_FIELDS)
 
       matched = MISSING_METHODS_RELATED_TO_FIELDS.match(method_name)
-      try("prefix_#{matched[:method_partial]}", *args, matched[:prefix], &block)
+      try("prefix_#{matched[:method_suffix]}", *args, matched[:method_prefix], &block)
     end
 
     # Check if method looks like: `_fields`, `_field_names` that can be processed by {Fieldable}
@@ -150,19 +150,20 @@ module Wallaby
     # @return [String, Symbol] type
     # @raise [ArgumentError] when type is nil
     def ensure_type_is_present(field_name, type, prefix = '')
-      type || raise(::ArgumentError, <<~INSTRUCTION
-        The type for field `#{field_name}` is missing in metadata `#{prefix}_fields`.
-        The possible causes are:
+      type || raise(::ArgumentError, <<~INSTRUCTION)
+        The field `#{field_name}` is missing its type definition. Potential causes include:
 
-        1. Check type's value from metadata `#{prefix}_fields[:#{field_name}][:type]`.
-          If it is missing, specify the type as below:
+        1. Check the type value from the metadata `#{prefix}fields[:#{field_name}][:type]`.
+          If it is absent, specify the type as shown in the example below:
 
-          #{prefix}fields[:#{field_name}][:type] = 'string'
+          #{prefix}fields[:#{field_name}][:type] = 'string' # or the specified type
 
-        2. If metadata `#{prefix}_fields` is blank, maybe table hasn't be created yet
-          or there is some error in the decorator class declaration.
+        2. If the metadata `#{prefix}fields[:#{field_name}]` is empty, the field may not exist.
+          Search for `index_field_names` and `#{field_name}` to determine if `#{field_name}` is inserted elsewhere.
+
+        3. If the metadata `#{prefix}fields` is empty, the table may not have been created yet,
+          or there may be an error in the decorator class declaration.
       INSTRUCTION
-      )
     end
   end
 end

data/lib/routes/wallaby/id_regexp.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Wallaby
+  class IdRegexp < ResourcesRegexp
+    # This method works with {Map.resources_regexp} to complete the constraint restriction in `config/routes.rb`.
+    # This regular expression matches the ids which have all the possible resources names in front
+    #
+    # It looks like `((?<=products/)|(?<=orders/)|(?<=order/items/)|...|(?<!.))[^/]+`:
+    #
+    # - `(?<=products/)` is a positive lookbehind assertion,
+    #   it means the ids must have `products/` in front of itself, but the match data won't include `products/`.
+    #   it matches string e.g. `/admin/products/1`, and the match data is `1`.
+    # - `(?<!.)` is a negative lookbehind assertion,
+    #   it means the ids must have nothing in front of itself.
+    #   it matches string e.g. `1`, and the match data is `1`.
+    #   this is required for URL helper when `:id` param is given,
+    #   e.g. `resources_path(action: 'show', resources: 'products', id: 1)`
+    # - `[^/]+` is to match id. id can be anything as long as it doesn't contain `|` character.
+    def execute
+      Regexp.new(<<~REGEXP, Regexp::EXTENDED)
+        (
+          #{resources_sources.map { |resources| "(?<=#{resources}/)" }.join('|')} # all the possible resources names in front of the id
+          |(?<!.) # nothing is in front of the id, this is needed by URL helpers
+        )
+        [^/]+ # id
+      REGEXP
+    end
+  end
+end

data/lib/routes/wallaby/lazy_regexp.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Wallaby
+  # This is designed to delegate all the methods to {#lazy_regexp}
+  # So that it doesn't need to load all the models for {Map.mode_map}
+  # when the engine is mounted in `config/routes.rb`
+  #
+  # @see Map.resources_regexp
+  # @see Map.id_regexp
+  class LazyRegexp < Regexp
+    delegate(*Regexp.instance_methods(false), to: :lazy_regexp)
+
+    def initialize(source, **options)
+      @lazy_source = source
+      super(source.to_s, **options)
+    end
+
+    protected
+
+    def lazy_regexp
+      Map.try(@lazy_source)
+    end
+  end
+end

data/lib/routes/wallaby/resources_regexp.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Wallaby
+  class ResourcesRegexp
+    # This method works with {Map.id_regexp} to complete the constraint restriction in `config/routes.rb`.
+    # This regular expression matches all the possible resources names that are loaded from the {.mode_map}
+    #
+    # It looks like `(products|orders|order/items|...)`
+    def execute
+      Regexp.new(<<~REGEXP, Regexp::EXTENDED)
+        (#{resources_sources.join('|')}) # all the possible resources names
+      REGEXP
+    end
+
+    protected
+
+    def resources_sources
+      # NOTE: `.reverse` is required so that for `order/items`,
+      # `%r{order/items|order}` matches `order/items`, not `order`
+      Map
+        .mode_map
+        .keys.flat_map { |klass| Inflector.to_resources_name(klass.to_s) }
+        .sort.reverse.uniq
+    end
+  end
+end

data/lib/routes/wallaby/resources_router.rb

@@ -31,7 +31,7 @@ module Wallaby
       controller_class = find_controller_class_by(options)
       controller_class.action(options[:action]).call(env)
     rescue ::AbstractController::ActionNotFound, ModelNotFound => e
-      set_flash_error_for(e, env)
+      Wallaby::Logger.warn(e, sourcing: 1)
       default_controller(options).action(:not_found).call(env)
     rescue UnprocessableEntity => e
       set_flash_error_for(e, env)

data/lib/utils/wallaby/inflector.rb

@@ -65,7 +65,7 @@ module Wallaby
       return EMPTY_STRING if name.blank?
 
       name = name.to_s unless name.is_a?(String)
-      name.tableize.gsub(SLASH, COLONS)
+      name.tableize
     end
 
     # @param name [Class, String]

data/lib/wallaby/classifier.rb

@@ -7,10 +7,10 @@ module Wallaby
 
     # Convert Class to String. If not Class, unchanged.
     # @param klass [Object]
-    # @return [String] if klass is a Class
-    # @return [Object] if klass is not a Class
+    # @return [String] if klass is not nil
+    # @return [nil] if klass is nil or klass is an anonymous Class
     def class_name_of(klass)
-      klass.try(:name) || klass || nil
+      klass.is_a?(Class) ? klass.try(:name) : klass.try(:to_s)
     end
 
     # Convert String to Class. If not String, unchanged.
@@ -18,13 +18,21 @@ module Wallaby
     # @return [Class] if name is a Class
     # @return [Object] if name is not a String
     # @return [nil] if class cannot be found
-    def to_class(name)
-      return name unless name.is_a? String
+    def to_class(name, raising: Wallaby.configuration.raise_on_name_error)
+      return name unless name.is_a?(String)
+      # blank string will lead to NameError `wrong constant name`
+      return if name.blank?
 
-      # NOTE: DO NOT try to use const_defined? and const_get EVER.
-      # This is Rails, use constantize
+      # NOTE: DO NOT try to use `const_defined?` and `const_get` EVER.
+      # Rails does all the class loading magics using `constantize`
       name.constantize
-    rescue NameError
+    rescue NameError => e
+      raise if raising
+
+      uninitialized = e.message.start_with?('uninitialized constant')
+      raise unless uninitialized
+
+      # block to handle this missing constant, e.g. use a default class or log useful instruction
       yield(name) if block_given?
     end
   end

data/lib/wallaby/configuration.rb

@@ -6,6 +6,9 @@ module Wallaby
   class Configuration
     include Classifier
 
+    # @!attribute [w] raise_on_name_error
+    attr_accessor :raise_on_name_error
+
     # @!attribute [w] logger
     attr_writer :logger
 
@@ -101,6 +104,7 @@ module Wallaby
       Deprecator.alert 'config.models.presence', from: '0.3.0', alternative: <<~INSTRUCTION
         Please use controller_class.models instead.
       INSTRUCTION
+      @models ||= Models.new
     end
 
     # To globally configure the models that Wallaby should handle.

data/lib/wallaby/core/version.rb

@@ -2,6 +2,6 @@
 
 module Wallaby
   module Core
-    VERSION = '0.3.0.beta2' # :nodoc:
+    VERSION = '0.3.0' # :nodoc:
   end
 end

data/lib/wallaby/core.rb

@@ -30,6 +30,9 @@ require 'wallaby/map'
 
 require 'support/action_dispatch/routing/mapper'
 
+require 'routes/wallaby/lazy_regexp'
+require 'routes/wallaby/resources_regexp'
+require 'routes/wallaby/id_regexp'
 require 'routes/wallaby/resources_router'
 require 'routes/wallaby/engines/base_route'
 require 'routes/wallaby/engines/engine_route'

data/lib/wallaby/map.rb

@@ -90,6 +90,18 @@ module Wallaby
       end
     end
 
+    class << self
+      # @return [Regexp] regexp to match data for param `:resources`
+      def resources_regexp
+        @resources_regexp ||= ResourcesRegexp.new.execute
+      end
+
+      # @return [Regexp] regexp to match data for param `:id`
+      def id_regexp
+        @id_regexp ||= IdRegexp.new.execute
+      end
+    end
+
     class << self
       # Reset all the instance variables to nil
       def clear

data/lib/wallaby/preloader.rb

@@ -33,6 +33,7 @@ module Wallaby
       @eager_load_paths ||=
         Rails.configuration.paths['app'].expanded
           .concat(Rails.configuration.eager_load_paths)
+          .uniq
     end
 
     # @!attribute [w] model_paths

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wallaby-core
 version: !ruby/object:Gem::Version
-  version: 0.3.0.beta2
+  version: 0.3.0
 platform: ruby
 authors:
-- Tian Chen
+- Tianwen Chen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-21 00:00:00.000000000 Z
+date: 2024-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -17,6 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 8.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 8.0.0
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -267,6 +273,9 @@ files:
 - lib/routes/wallaby/engines/base_route.rb
 - lib/routes/wallaby/engines/custom_app_route.rb
 - lib/routes/wallaby/engines/engine_route.rb
+- lib/routes/wallaby/id_regexp.rb
+- lib/routes/wallaby/lazy_regexp.rb
+- lib/routes/wallaby/resources_regexp.rb
 - lib/routes/wallaby/resources_router.rb
 - lib/servicers/wallaby/model_servicer.rb
 - lib/services/wallaby/authorizer_finder.rb
@@ -317,13 +326,13 @@ files:
 - lib/wallaby/logger.rb
 - lib/wallaby/map.rb
 - lib/wallaby/preloader.rb
-homepage: https://github.com/wallaby-rails/wallaby-core
+homepage: https://github.com/wallaby-rails/wallaby-rails/blob/main/wallaby-core
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/wallaby-rails/wallaby-core
-  source_code_uri: https://github.com/wallaby-rails/wallaby-core
-  changelog_uri: https://github.com/wallaby-rails/wallaby-core/blob/master/CHANGELOG.md
+  homepage_uri: https://github.com/wallaby-rails/wallaby-rails/blob/main/wallaby-core
+  source_code_uri: https://github.com/wallaby-rails/wallaby-rails/blob/main/wallaby-core
+  changelog_uri: https://github.com/wallaby-rails/wallaby-rails/blob/main/wallaby-core/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []