metasploit-concern 0.3.1 → 0.4.0.pre.app.pre.concerns.pre.eager.pre.load

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c8239f87c878597352fa3992c32f89a3f92240f
-  data.tar.gz: 37aee8ebbdd86eae3e72c1a605be8ce5842ad415
+  metadata.gz: d39b6b285869860965908a82e66258700a373784
+  data.tar.gz: cb60d58aad9d081456a98d239684155b0e3a08e8
 SHA512:
-  metadata.gz: db146a20ddcc0a7089d4e627db465575492c76f4ec75d1b47cd2c22f4a5e19350c371658e15731d886129d8feba3520f621031ebbf504af3ee73cdccf1ae3ec5
-  data.tar.gz: 37137092522ee806668f157501686a1287ab4498097da46243f632b606d3ad08935a45a3fe870f0115e217711a044bd1ec0dbc2395d971999dfb7d8a101ad96b
+  metadata.gz: 417e9ed3422d57aab511209eec4abbcb61b2987b8a1fc73ee1f129b56807e56a3fd5d11a947ceb5d3f61f619bb321ca3bffb0918778b34968dd38eff3b147b61
+  data.tar.gz: b2f650eaed33a42f1790e881b980908915fcf09001d4ca82bb9ff757f4675a0376ffe99a04765fbf4fbcefd3004769b387cd67ac3aad1b400db7cf00a69e9910

data/lib/metasploit/concern.rb

@@ -4,6 +4,8 @@
 
 # `String#underscore``
 require 'active_support/core_ext/string/inflections'
+# `ActiveSupport::Autoload`
+require 'active_support/dependencies/autoload'
 # `ActiveSupport.run_load_hooks`
 require 'active_support/lazy_load_hooks'
 
@@ -77,6 +79,11 @@ module Metasploit
   #     end
   #   end
   module Concern
+    extend ActiveSupport::Autoload
+
+    autoload :Error
+    autoload :EagerLoadError
+
     # @note If `Rails` is loaded and {Metasploit::Concern::Engine} is defined, just use
     #   `Metasploit::Concern::Engine.root`.
     #

data/lib/metasploit/concern/engine.rb

@@ -30,17 +30,21 @@ module Metasploit
           concerns_path = engine.paths['app/concerns']
 
           if concerns_path
+            if concerns_path.eager_load?
+              raise Metasploit::Concern::Error::EagerLoad, engine
+            end
+
+            unless concerns_path.autoload?
+              raise Metasploit::Concern::Error::SkipAutoload, engine
+            end
+
             concerns_directories = concerns_path.existent_directories
-          else
-            # app/concerns is not set, so just derive it from root.  Cannot
-            # derive from app because it will glob app/models too
-            concerns_directories = [engine.root.join('app', 'concerns').to_path]
-          end
 
-          concerns_directories.each do |concerns_directory|
-            concerns_pathname = Pathname.new(concerns_directory)
-            loader = Metasploit::Concern::Loader.new(root: concerns_pathname)
-            loader.register
+            concerns_directories.each do |concerns_directory|
+              concerns_pathname = Pathname.new(concerns_directory)
+              loader = Metasploit::Concern::Loader.new(root: concerns_pathname)
+              loader.register
+            end
           end
         end
       end

data/lib/metasploit/concern/error.rb

@@ -0,0 +1,8 @@
+# Namespace for errors raised by {Metasploit::Concern}.
+module Metasploit::Concern::Error
+  extend ActiveSupport::Autoload
+
+  autoload :Base
+  autoload :EagerLoad
+  autoload :SkipAutoload
+end

data/lib/metasploit/concern/error/base.rb

@@ -0,0 +1,4 @@
+# Base of exception hierarchy raise by {Metasploit::Concern}
+class Metasploit::Concern::Error::Base < StandardError
+
+end

data/lib/metasploit/concern/error/eager_load.rb

@@ -0,0 +1,17 @@
+# Exception raised when a `Rails::Engine` has left its `'app/concerns'` path as `eager_load: true`
+class Metasploit::Concern::Error::EagerLoad < Metasploit::Concern::Error::Base
+  # @param engine [Rails::Engine] `Rails::Engine` where `engine.paths['app/concerns'].eager_load?` is `true`.
+  def initialize(engine)
+    @engine = engine
+
+    super(
+        "#{engine}'s `app/concerns` is marked as `eager_load: true`.  This will cause circular dependency " \
+        "errors when the concerns are loaded.  Declare `app/concerns` to stop it from inheriting `eager_load: true` " \
+        "from `app`: \n" \
+        "\n" \
+        "  class #{engine} < Rails::Engine\n" \
+        "    config.paths.add 'app/concerns', autoload: true\n" \
+        "  end\n"
+    )
+  end
+end

data/lib/metasploit/concern/error/skip_autoload.rb

@@ -0,0 +1,15 @@
+# Exception raised when a `Rails::Engine` has left its `'app/concerns'` path as `autoload_load: false`
+class Metasploit::Concern::Error::SkipAutoload < Metasploit::Concern::Error::Base
+  # @param engine [Rails::Engine] `Rails::Engine` where `engine.paths['app/concerns'].autoload?` is `false`.
+  def initialize(engine)
+    @engine = engine
+
+    super(
+        "#{engine}'s `app/concerns` is marked as `autoload: false`.  Declare `app/concerns` as autoloading:\n" \
+        "\n" \
+        "  class #{engine} < Rails::Engine\n" \
+        "    config.paths.add 'app/concerns', autoload: true\n" \
+        "  end\n"
+    )
+  end
+end

data/lib/metasploit/concern/version.rb

@@ -5,9 +5,11 @@ module Metasploit
       # The major version number.
       MAJOR = 0
       # The minor version number, scoped to the {MAJOR} version number.
-      MINOR = 3
+      MINOR = 4
       # The patch number, scoped to the {MAJOR} and {MINOR} version numbers.
-      PATCH = 1
+      PATCH = 0
+      # The prerelease version, scoped to the {MAJOR}, {MINOR}, and {PATCH} version numbers.
+      PRERELEASE = 'app-concerns-eager-load'
 
       # The full version string, including the {MAJOR}, {MINOR}, {PATCH}, and optionally, the `PRERELEASE` in the
       # {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0} format.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metasploit-concern
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0.pre.app.pre.concerns.pre.eager.pre.load
 platform: ruby
 authors:
 - Luke Imhoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-13 00:00:00.000000000 Z
+date: 2015-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -60,6 +60,10 @@ files:
 - app/models/metasploit/concern/loader.rb
 - lib/metasploit/concern.rb
 - lib/metasploit/concern/engine.rb
+- lib/metasploit/concern/error.rb
+- lib/metasploit/concern/error/base.rb
+- lib/metasploit/concern/error/eager_load.rb
+- lib/metasploit/concern/error/skip_autoload.rb
 - lib/metasploit/concern/version.rb
 - lib/tasks/yard.rake
 - spec/support/shared/examples/metasploit/concern/run.rb
@@ -78,9 +82,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.3