jets 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7210442948a1180913859f3afbd0aebb049560adfdf53faf02357c4f299bb246
-  data.tar.gz: b94be0bc50ec242e9c6e908050a4ddd342874e9026cdf12f28ae54e465d12303
+  metadata.gz: 82e56d77408579a757373a115134668315a2c47fdbcd297f8eae827951274f6a
+  data.tar.gz: 0152fbf8fe291033319761e987667026a77958b67398ba237d9152cc70a00615
 SHA512:
-  metadata.gz: 95f6b7c61d0867b09c6af7f099fc84ec3de07defec86707f8aaadc8aac2da318557260b828142133384350163bd0bcbccc0a0f5bd204eb1c2645be0791e9637e
-  data.tar.gz: 0cb91a7f2593103a557a59f0d3d8b2732f9ba196725ed2825d12b34db2f2879e72bff137e8193411aecb0e31522c704bacbf2bbf9b5329242dad514655f38b5d
+  metadata.gz: f638230df0a341ee7b4e0a73355a89a650a78178d7ebb46326c4215d40ea4d33d6648a3d0909a98789e416b4c03c59bae8b5c8e5a94e254c45de78915e5214c4
+  data.tar.gz: 5a9e606725ae25d18c3ce4b1ea901780d7062245035c20a9d5139566b0e92ab998d9c3e6d2bb14081a5e77c04bfa5bb871ed95db51ac48467c42f186292b82ab

data/CHANGELOG.md

@@ -3,6 +3,13 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/).
 
+## [2.1.1]
+- #347 Add documentation about torch vs. warm
+- #348 Provide another minimal privileges example
+- #349 Fix route params for specs
+- #350 Fix config.autoload_paths setting
+- remove the jets c warning
+
 ## [2.1.0]
 - #345 upgrade to use rails 6 components
 

data/lib/jets/application.rb

@@ -13,8 +13,9 @@ class Jets::Application
 
   def setup!
     load_default_config
-    autoload_paths = config.autoload_paths + config.extra_autoload_paths
-    setup_auto_load_paths(autoload_paths)
+    setup_autoload_paths
+    setup_ignore_paths
+    main_loader_setup
   end
 
   def configs!
@@ -99,14 +100,29 @@ class Jets::Application
     end
   end
 
-  def setup_auto_load_paths(autoload_paths=default_autoload_paths)
-    loader = Jets::Autoloaders.main
+  def main_loader
+    Jets::Autoloaders.main
+  end
+
+  def setup_autoload_paths
+    autoload_paths = default_autoload_paths + config.autoload_paths
     autoload_paths.each do |path|
       next unless File.exist?(path)
-      loader.push_dir(path)
+      main_loader.push_dir(path)
     end
-    loader.enable_reloading if Jets.env.development?
-    loader.setup
+  end
+
+  # Allow use to add config.ignore_paths just in case there's some case Jets hasn't considered
+  def setup_ignore_paths
+    ignore_paths = default_ignore_paths + config.ignore_paths
+    ignore_paths.each do |path|
+      main_loader.ignore("#{Jets.root}/#{path}")
+    end
+  end
+
+  def main_loader_setup
+    main_loader.enable_reloading if Jets.env.development?
+    main_loader.setup # only respected on the first call
   end
 
   def each_app_autoload_path(expression)

data/lib/jets/application/defaults.rb

@@ -54,8 +54,8 @@ class Jets::Application
       config = ActiveSupport::OrderedOptions.new
       config.project_name = parse_project_name # must set early because other configs requires this
       config.cors = false
-      config.autoload_paths = default_autoload_paths
-      config.extra_autoload_paths = []
+      config.autoload_paths = [] # allows for customization
+      config.ignore_paths = [] # allows for customization
       config.logger = Jets::Logger.new($stderr)
 
       # function properties defaults
@@ -176,5 +176,12 @@ class Jets::Application
 
       paths
     end
+
+    def default_ignore_paths
+      %w[
+        app/functions
+        app/shared/functions
+      ]
+    end
   end
 end

data/lib/jets/autoloaders.rb

@@ -27,7 +27,8 @@ module Jets
         Zeitwerk::Loader.new.tap do |loader|
           loader.tag = "jets.main"
           # loader.inflector = Inflector.new # TODO: allow custom app inflector
-          loader.ignore("#{Jets.root}/app/shared/functions")
+          # The main loader is configured later on in Jets::Application#setup_autoload_paths
+          # because it needs access to Jets.root and Jets.config settings
         end
       end
       memoize :main

data/lib/jets/booter.rb

@@ -11,7 +11,7 @@ class Jets::Booter
 
       Jets.application.setup!
 
-      # Turbines are loaded after setup_auto_load_paths in Jets.application.setup!  Some Turbine options are defined
+      # Turbines are loaded after setup_autoload_paths in Jets.application.setup!  Some Turbine options are defined
       # in the project so setup must happen before internal Turbines are loaded.
       load_internal_turbines
 
@@ -25,7 +25,7 @@ class Jets::Booter
 
       setup_db # establish db connections in Lambda Execution Context.
       # The eager load calls connects_to in models and establish those connections in Lambda Execution Context also.
-      Jets::Autoloaders.main.eager_load # Eager load project code. Rather have user find out early than later on AWS Lambda.
+      eager_load
 
       # TODO: Figure out how to build middleware during Jets.boot without breaking jets new and webpacker:install
       # build_middleware_stack
@@ -33,6 +33,22 @@ class Jets::Booter
       @booted = true
     end
 
+    def eager_load
+      preload_extensions
+      Jets::Autoloaders.main.eager_load # Eager load project code. Rather have user find out early than later on AWS Lambda.
+    end
+
+    def preload_extensions
+      base_path = "#{Jets.root}/app/extensions"
+      Dir.glob("#{base_path}/**/*.rb").each do |path|
+        next unless File.file?(path)
+
+        class_name = path.sub("#{base_path}/", '').sub(/\.rb/,'').camelize
+        klass = class_name.constantize # autoload
+        Jets::Lambda::Functions.extend(klass)
+      end
+    end
+
     # Using ActiveRecord outside of Rails, so we need to set up the db connection ourself.
     #
     # Only connects to database for ActiveRecord and when config/database.yml exists.

data/lib/jets/cli.rb

@@ -78,8 +78,7 @@ class Jets::CLI
 
     # jets generate is a special command requires doesn't puts out the help menu automatically when
     # `jets generate` is called without additional args.  We'll take it over early and fix it here.
-    autocomplete_command = Jets::Commands::Base.autocomplete(args[0])
-    generate = autocomplete_command == "generate"
+    generate = full_command == "generate"
 
     if generate && ((args.size == 1 || help_flags.include?(args.last)) || args.size == 2)
       puts Jets::Generator.help

data/lib/jets/commands/base.rb

@@ -138,7 +138,6 @@ class Jets::Commands::Base < Thor
     def eager_load!
       return if Jets::Turbo.afterburner?
 
-      Jets.application.setup_auto_load_paths # in case an app/extension is defined
       Jets::Autoloaders.once.eager_load
     end
     memoize :eager_load!

data/lib/jets/commands/templates/skeleton/config/application.rb.tt

@@ -12,7 +12,7 @@ Jets.application.configure do
 <% end -%>
 
   # config.env_extra = 2 # can also set this with JETS_ENV_EXTRA
-  # config.extra_autoload_paths = []
+  # config.autoload_paths = []
 
   # config.asset_base_url = 'https://cloudfront.domain.com/assets' # example
 

data/lib/jets/commands/upgrade.rb

@@ -14,6 +14,7 @@ module Jets::Commands
       inject_csrf_meta_tags
       update_crud_js
       update_config_application_rb
+      update_autoload_paths_config
       puts "Upgrade complete."
     end
 
@@ -75,5 +76,30 @@ module Jets::Commands
       IO.write(app_rb, content)
       puts "Update: #{app_rb} with default_protect_from_forgery"
     end
+
+    def update_autoload_paths_config
+      app_rb = "config/application.rb"
+      lines = IO.readlines(app_rb)
+
+      new_config = lines.find { |l| l.include?('config.autoload_paths') }
+      return if new_config
+
+      old_config = lines.find { |l| l.include?('config.extra_autoload_paths') }
+      return unless old_config
+
+      lines.map! do |line|
+        md = line.match(/config\.extra_autoload_paths(.*)/)
+        if md
+          rest = md[1]
+          "  config.autoload_paths#{rest}"
+        else
+          line
+        end
+      end
+
+      content = lines.join
+      IO.write(app_rb, content)
+      puts "Update: #{app_rb} with config.autoload_paths"
+    end
   end
 end

data/lib/jets/controller/middleware/local/route_matcher.rb

@@ -5,102 +5,18 @@ class Jets::Controller::Middleware::Local
     end
 
     def find_route
-      reset_routes!
-      # Precedence:
-      # 1. Routes with no captures get highest precedence: posts/new
-      # 2. Then we consider the routes with captures: post/:id
-      #
-      # Within these 2 groups we consider the routes with the longest path first
-      # since posts/:id and posts/:id/edit can both match.
-      routes = router.ordered_routes
-      route = routes.find do |r|
-        route_found?(r)
-      end
-      route
+      Jets::Router::Finder.new(method, path).run
     end
 
-    # "hot reload" for development
-    def reset_routes!
-      return unless Jets.env.development?
+  private
+    attr_reader :env
 
-      Jets::Router.clear!
-      Jets.application.load_routes(refresh: true)
+    def path
+      env["REQUEST_METHOD"] || "GET"
     end
 
-    def route_found?(route)
-      request_method = @env["REQUEST_METHOD"] || "GET"
-      actual_path = @env["PATH_INFO"].sub(/^\//,'') # remove beginning slash
-
-      # Immediately stop checking when the request method: GET, POST, ANY, etc
-      # doesnt match.
-      return false if request_method != route.method and route.method != "ANY"
-
-      path = route.path
-
-      if actual_path == path
-        # regular string match detection
-        return true # exact route matches are highest precedence
-      end
-
-      # Check path for route capture and wildcard matches:
-      # A colon (:) means the variable has a variable
-      if path.include?(':') # 2nd highest precedence
-        capture_detection(path, actual_path) # early return true or false
-      # A star (*) means the variable has a glob
-      elsif path.include?('*') # lowest precedence
-        proxy_detection(path, actual_path) # early return true or false
-      else
-        false # reach here, means no route matched
-      end
-    end
-
-    # catchall/globbing/wildcard/proxy routes. Examples:
-    #
-    #    get "files/*path", to: "files#show"
-    #    get "others/*rest", to: "others#show"
-    #    get "*catchall", to: "public_files#show" # last catchall route for Jets
-    #
-    def proxy_detection(route_path, actual_path)
-      # drop the proxy_segment
-      leading_path = route_path.split('/')[0..-2].join('/')
-
-      # get "*catchall", to: "public_files#show"
-      if leading_path.empty? # This is the last catchall route "*catchall"
-        return true # always return true here because the entire path
-        # will always match
-      end
-
-      # Other types of wildcard route:
-      #
-      #    get "files/*path", to: "files#show"
-      #    get "others/*rest", to: "others#show"
-      unless leading_path.ends_with?('/')
-        # Ensure trailing slash to make pattern matching stricter
-        leading_path = "#{leading_path}/"
-      end
-
-      pattern = "^#{leading_path}"
-      regexp = Regexp.new(pattern)
-      !!regexp.match(actual_path) # could be true or false
-    end
-
-    def capture_detection(route_path, actual_path)
-      # changes path to a string used for a regexp
-      # posts/:id/edit => posts\/(.*)\/edit
-
-      regexp_string = route_path.split('/').map do |s|
-                        s.include?(':') ? Jets::Router::Route::CAPTURE_REGEX : s
-                      end.join('\/')
-      # make sure beginning and end of the string matches
-      regexp_string = "^#{regexp_string}$"
-
-      regexp = Regexp.new(regexp_string)
-      !!regexp.match(actual_path) # could be true or false
-    end
-
-    def router
-      return @router if @router
-      @router = Jets.application.routes
+    def method
+      env["PATH_INFO"].sub(/^\//,'')
     end
   end
 end

data/lib/jets/lambda/dsl.rb

@@ -401,19 +401,4 @@ module Jets::Lambda::Dsl
       end
     end # end of class << self
   end # end of included
-
-  def self.add_custom_resource_extensions(base)
-    base_path = "#{Jets.root}/app/extensions"
-    Dir.glob("#{base_path}/**/*.rb").each do |path|
-      next unless File.file?(path)
-
-      class_name = path.sub("#{base_path}/", '').sub(/\.rb/,'').camelize
-      klass = class_name.constantize # autoload
-      base.extend(klass)
-    end
-  end
-
-  def self.included(base)
-    add_custom_resource_extensions(base)
-  end
 end

data/lib/jets/router/finder.rb

@@ -0,0 +1,47 @@
+class Jets::Router
+  class Finder
+    extend Memoist
+
+    def initialize(path, method)
+      @path = path
+      @method = method.to_s.upcase
+    end
+
+    def run
+      reset_routes!
+      # Precedence:
+      # 1. Routes with no captures get highest precedence: posts/new
+      # 2. Then we consider the routes with captures: post/:id
+      #
+      # Within these 2 groups we consider the routes with the longest path first
+      # since posts/:id and posts/:id/edit can both match.
+      routes = router.ordered_routes
+      route = routes.find do |r|
+        matcher.match?(r)
+      end
+      route
+    end
+
+  private
+
+    attr_reader :path, :method
+
+    # "hot reload" for development
+    def reset_routes!
+      return unless Jets.env.development?
+
+      Jets::Router.clear!
+      Jets.application.load_routes(refresh: true)
+    end
+
+    def matcher
+      Jets::Router::Matcher.new(path, method)
+    end
+    memoize :matcher
+
+    def router
+      Jets.application.routes
+    end
+    memoize :router
+  end
+end

data/lib/jets/router/matcher.rb

@@ -0,0 +1,81 @@
+class Jets::Router
+  class Matcher
+    def initialize(path, method)
+      @path = path.sub(/^\//,'')
+      @method = method.to_s.upcase
+    end
+
+    def match?(route)
+      # Immediately stop checking when the request method: GET, POST, ANY, etc
+      # doesnt match.
+
+      return false if method != route.method && route.method != "ANY"
+
+      route_path = route.path
+
+      if path == route_path
+        # regular string match detection
+        return true # exact route matches are highest precedence
+      end
+
+      # Check path for route capture and wildcard matches:
+      # A colon (:) means the variable has a variable
+      if route_path.include?(':') # 2nd highest precedence
+        capture_detection(route_path, path) # early return true or false
+      # A star (*) means the variable has a glob
+      elsif route_path.include?('*') # lowest precedence
+        proxy_detection(route_path, path) # early return true or false
+      else
+        false # reach here, means no route matched
+      end
+    end
+
+  private
+
+    attr_reader :path, :method
+
+    # catchall/globbing/wildcard/proxy routes. Examples:
+    #
+    #    get "files/*path", to: "files#show"
+    #    get "others/*rest", to: "others#show"
+    #    get "*catchall", to: "public_files#show" # last catchall route for Jets
+    #
+    def proxy_detection(route_path, actual_path)
+      # drop the proxy_segment
+      leading_path = route_path.split('/')[0..-2].join('/')
+
+      # get "*catchall", to: "public_files#show"
+      if leading_path.empty? # This is the last catchall route "*catchall"
+        return true # always return true here because the entire path
+        # will always match
+      end
+
+      # Other types of wildcard route:
+      #
+      #    get "files/*path", to: "files#show"
+      #    get "others/*rest", to: "others#show"
+      unless leading_path.ends_with?('/')
+        # Ensure trailing slash to make pattern matching stricter
+        leading_path = "#{leading_path}/"
+      end
+
+      pattern = "^#{leading_path}"
+      regexp = Regexp.new(pattern)
+      !!regexp.match(actual_path) # could be true or false
+    end
+
+    def capture_detection(route_path, actual_path)
+      # changes path to a string used for a regexp
+      # posts/:id/edit => posts\/(.*)\/edit
+      regexp_string = route_path.split('/').map do |s|
+                        s.include?(':') ? Jets::Router::Route::CAPTURE_REGEX : s
+                      end.join('\/')
+      # make sure beginning and end of the string matches
+      regexp_string = "^#{regexp_string}$"
+
+      regexp = Regexp.new(regexp_string)
+
+      !!regexp.match(actual_path) # could be true or false
+    end
+  end
+end

data/lib/jets/spec_helpers/controllers/request.rb

@@ -1,5 +1,7 @@
 module Jets::SpecHelpers::Controllers
   class Request
+    extend Memoist
+
     attr_accessor :method, :path, :headers, :params
     def initialize(method, path, headers={}, params={})
       @method, @path, @headers, @params = method, path, headers, params
@@ -7,14 +9,14 @@ module Jets::SpecHelpers::Controllers
 
     def event
       json = {}
-      id_params = path.scan(%r{:([^/]+)}).flatten
+      id_params = route.path.scan(%r{:([^/]+)}).flatten
       expanded_path = path.dup
       path_parameters = {}
 
       id_params.each do |id_param|
-        raise "missing param: :#{id_param}" unless params.path_params.include? id_param.to_sym
+        raise "missing param: :#{id_param}" unless path_params.include? id_param.to_sym
 
-        path_param_value = params.path_params[id_param.to_sym]
+        path_param_value = path_params[id_param.to_sym]
         raise "Path param :#{id_param} value cannot be blank" if path_param_value.blank?
 
         expanded_path.gsub!(":#{id_param}", path_param_value.to_s)
@@ -50,19 +52,28 @@ module Jets::SpecHelpers::Controllers
       json
     end
 
-    def find_route!
+    def path_params
+      params.path_params.reverse_merge(extract_parameters)
+    end
+    memoize :path_params
+
+    def extract_parameters
+      route.extract_parameters(normalized_path).symbolize_keys
+    end
+
+    def normalized_path
       path = self.path
       path = path[0..-2] if path.end_with? '/'
       path = path[1..-1] if path.start_with? '/'
+      path
+    end
 
-      route = Jets::Router.routes.find { |r| r.path == path && r.method == method.to_s.upcase }
-      raise "Route not found: #{method.to_s.upcase} #{path}" if route.blank?
-
-      route
+    def route
+      Jets::Router::Finder.new(normalized_path, method).run
     end
+    memoize :route
 
     def dispatch!
-      route = find_route!
       klass = Object.const_get(route.controller_name)
       controller = klass.new(event, {}, route.action_name)
       response = controller.process! # response is API Gateway Hash

data/lib/jets/version.rb

@@ -1,3 +1,3 @@
 module Jets
-  VERSION = "2.1.0"
+  VERSION = "2.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jets
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-18 00:00:00.000000000 Z
+date: 2019-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -895,9 +895,11 @@ files:
 - lib/jets/router.rb
 - lib/jets/router/dsl.rb
 - lib/jets/router/error.rb
+- lib/jets/router/finder.rb
 - lib/jets/router/helpers.rb
 - lib/jets/router/helpers/core_helper.rb
 - lib/jets/router/helpers/named_routes_helper.rb
+- lib/jets/router/matcher.rb
 - lib/jets/router/method_creator.rb
 - lib/jets/router/method_creator/code.rb
 - lib/jets/router/method_creator/edit.rb