brainstem 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '0942f85fafa0e040a4fdc07a3d61d8e09a5fe0f7'
-  data.tar.gz: f6f6d59618aefc3d545e8d9df82b70b124f0762a
+  metadata.gz: deb35356d8b8edc1d42d302e6716a4842e22945b
+  data.tar.gz: 9c9c852103fec856d5033181e8b866ab95194a5a
 SHA512:
-  metadata.gz: 1a1d425a35a804cec4bea1e1c2cc185ba435e6ffb9bf3e6c4ff1c2ca7b09ec96c23a119fa9f4b54b758ae800abd2327e1abdd7d102056365f39af4b2e31e772c
-  data.tar.gz: 4c4d077cac14df7ba87e33c4b193e31b94690192b8a118bc3e99b09cad13f1aa521f4ea68959b9c4efa7af9acd765babe5844a1e597cd53e331753466e5bac1f
+  metadata.gz: 51d786a3d4d6a4601f69d6d2089b8096745f1142f7b6d16784a5789ac0b03a5e251394fb18e1825ea4f2da5f7834c505e846c0ff040ce5e4546ea9eca18b1cb1
+  data.tar.gz: a3dda68262d0597f1d8fbc7c14b6224c679e6820ca261a54b0c996a5faaa700c9312d698e7c854cf80827efadc834453b90ac650f97661d0acf66861a75f8b68

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
++ **1.4.1** - _05/09/2018_
+  - Add the capability to specify an alternate base application / engine the routes are derived from.
+    This capability is specific to documemtation generation.
+
 + **1.3.0** - _04/12/2018_
   - Add the capability to nest fields under evaluable parent blocks where the nested fields are evaluated
     with the resulting value of the parent field.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    brainstem (1.4.0)
+    brainstem (1.4.1)
       activerecord (>= 4.1)
       activesupport (>= 4.1)
 
@@ -22,12 +22,12 @@ GEM
     arel (8.0.0)
     coderay (1.1.2)
     concurrent-ruby (1.0.5)
-    database_cleaner (1.6.2)
+    database_cleaner (1.6.1)
     db-query-matchers (0.9.0)
       activesupport (>= 4.0, <= 6.0)
       rspec (~> 3.0)
     diff-lcs (1.3)
-    i18n (0.9.1)
+    i18n (0.9.0)
       concurrent-ruby (~> 1.0)
     method_source (0.9.0)
     minitest (5.10.3)

data/lib/brainstem/api_docs.rb

@@ -108,16 +108,11 @@ module Brainstem
     end
 
     #
-    # Defines the application or engine that all routes will be fetched from.
+    # Defines the alternate application or engine that all routes will be fetched from.
     #
-    # Is a proc because most relevant classes are not loaded until much
-    # later.
-    #
-    # @see Brainstem::ApiDocs::RailsIntrospector#base_application_proc=
+    # @see Brainstem::ApiDocs::RailsIntrospector#base_application_class=
     #
-    config_accessor(:base_application_proc) do
-      Proc.new { Rails.application }
-    end
+    config_accessor(:base_application_class) { nil }
 
 
     #

data/lib/brainstem/api_docs/introspectors/rails_introspector.rb

@@ -15,7 +15,7 @@ module Brainstem
         #
         def load_environment!
           load rails_environment_file unless env_already_loaded?
-          ::Rails.application.eager_load!
+          base_application.eager_load!
 
           validate!
         rescue LoadError => e
@@ -47,6 +47,16 @@ module Brainstem
         end
 
 
+        #
+        # Returns the alternate application class or defaults to Rails.application
+        #
+        # @return [Class] The base application class
+        #
+        def base_application
+          base_application_class.present? ? base_application_class.constantize : ::Rails.application
+        end
+
+
         #
         # Returns an array of hashes describing the endpoints of the
         # application. See +routes_method+ for the keys of those hashes.
@@ -70,7 +80,7 @@ module Brainstem
             :rails_environment_file,
             :base_presenter_class,
             :base_controller_class,
-            :base_application_proc
+            :base_application_class
           ]
         end
 
@@ -177,21 +187,26 @@ module Brainstem
 
 
         #
-        # Returns a proc that will return the application or engine to get routes from.
+        # Returns the name of the alternate application or engine to get routes from.
         #
-        # @return [Proc] Proc that returns the Rails application or an engine
+        # Because the initializer that contains configuration data is unlikely
+        # to have been loaded, this may also return a Proc, which will be called
+        # after the environment is loaded.
         #
-        def base_application_proc
-          @base_application_proc ||= Proc.new { Rails.application }
+        # @return [String,Nil] returns the name of the alternate application or engine.
+        #
+        def base_application_class
+          proc_or_string = @base_application_class
+          proc_or_string.respond_to?(:call) ? proc_or_string.call : proc_or_string
         end
 
 
         #
-        # Allows for the specification for an alternate base application
+        # Allows for the specification for an alternate base application name
         #
-        # @param [Proc] Proc that returns the Rails application or an engine
+        # @param [Nil,String] returns the name of the alternate application or engine
         #
-        attr_writer :base_application_proc
+        attr_writer :base_application_class
 
 
         #
@@ -207,7 +222,7 @@ module Brainstem
         #
         def routes_method
           @routes_method ||= Proc.new do
-            base_application_proc.call.routes.routes.map do |route|
+            base_application.routes.routes.map do |route|
               next unless route.defaults.has_key?(:controller) &&
                 controller_const = "#{route.defaults[:controller]}_controller"
                   .classify

data/lib/brainstem/cli/generate_api_docs_command.rb

@@ -49,6 +49,7 @@ module Brainstem
             args_for_introspector: {
               base_presenter_class:  ::Brainstem::ApiDocs.method(:base_presenter_class),
               base_controller_class: ::Brainstem::ApiDocs.method(:base_controller_class),
+              base_application_class: ::Brainstem::ApiDocs.method(:base_application_class),
             },
           },
         }
@@ -148,6 +149,11 @@ module Brainstem
           end
 
 
+          opts.on('--base-application-class=CLASS', "which class to look up routes on") do |o|
+            options[:builder][:args_for_introspector][:base_application_class] = o
+          end
+
+
           opts.on('--controller-matches=MATCH',
                   'a case-sensitive regexp used to winnow the list of '\
                   'controllers. It is matched against the constant, not '\

data/lib/brainstem/version.rb

@@ -1,3 +1,3 @@
 module Brainstem
-  VERSION = "1.4.0"
+  VERSION = "1.4.1"
 end

data/spec/brainstem/api_docs/introspectors/rails_introspector_spec.rb

@@ -114,6 +114,43 @@ module Brainstem
             end
           end
 
+          describe "#base_application" do
+            before do
+              stub.any_instance_of(described_class).validate!
+            end
+
+            context "when custom base_application_class is not given" do
+              subject do
+                described_class.with_loaded_environment(default_args)
+              end
+
+              it "returns nil" do
+                expect(subject.send(:base_application_class)).to be_nil
+              end
+
+              it "returns the descendants of the base controller class" do
+                expect(subject.base_application).to eq(::Rails.application)
+              end
+            end
+
+            context "when custom base_application_class is given" do
+              subject do
+                described_class.with_loaded_environment(
+                  default_args.merge(base_application_class: "::FakeApiEngine")
+                )
+              end
+
+              it "allows the specification of a custom base_application_class" do
+                expect(subject.send(:base_application_class).to_s)
+                  .to eq "::FakeApiEngine"
+              end
+
+              it "returns the descendants of the base controller class" do
+                expect(subject.base_application).to eq(FakeApiEngine)
+              end
+            end
+          end
+
           describe "#routes" do
             let(:a_proc) { Object.new }
 
@@ -161,27 +198,10 @@ module Brainstem
             end
 
             context "with an alternate base application or engine provided" do
-              let(:base_application_proc) { Proc.new { FakeRailsApplication.new(true, routes) } }
-              let(:routes) { FakeRailsRoutesObject.new([route_1, route_2]) }
-              let(:route_1) {
-                FakeRailsRoute.new(
-                  "fake_descendant",
-                  FakeRailsRoutePathObject.new(spec: '/fake_route_1'),
-                  { controller: "fake_descendant", action: "show" },
-                  { :request_method => /^GET$/ }
-                )
-              }
-              let(:route_2) {
-                FakeRailsRoute.new(
-                  "fake_descendant",
-                  FakeRailsRoutePathObject.new(spec: '/fake_route_2'),
-                  { controller: "fake_descendant", action: "show" },
-                  { :request_method => /^GET$/ }
-                )
-              }
+              let(:base_application_class) { "FakeApiEngine" }
 
               subject do
-                described_class.with_loaded_environment(default_args.merge({ base_application_proc: base_application_proc }))
+                described_class.with_loaded_environment(default_args.merge({ base_application_class: base_application_class }))
               end
 
               it "recognizes the configured application or engine's routes" do

data/spec/brainstem/api_docs_spec.rb

@@ -21,7 +21,7 @@ module Brainstem
         output_extension
         base_presenter_class
         base_controller_class
-        base_application_proc
+        base_application_class
         document_empty_presenter_associations
         document_empty_presenter_filters
       ).each do |meth|

data/spec/brainstem/cli/generate_api_docs_command_spec.rb

@@ -33,6 +33,15 @@ module Brainstem
           end
         end
 
+        context "when --base-application-class" do
+          let(:args) { %w(--base-application-class=::Api::Engine) }
+
+          it "sets sink to a ControllerPresenterMultifileSink" do
+            expect(subject.options).to have_key :builder
+            expect(subject.options[:builder][:args_for_introspector][:base_application_class]).to eq("::Api::Engine")
+          end
+        end
+
         context "when --output-dir" do
           let(:args) { %w(--output-dir=./blah) }
 

data/spec/dummy/rails.rb

@@ -39,7 +39,6 @@ class Rails
   end
 end
 
-
 class FakeBasePresenter; end
 class FakeDescendantPresenter < FakeBasePresenter; end
 
@@ -47,3 +46,26 @@ class FakeBaseController; end
 class FakeDescendantController < FakeBaseController; end
 
 class FakeNonDescendantController; end
+
+class FakeApiEngine
+  def self.eager_load!;end
+  def self.routes
+    @routes ||= begin
+      route_1 = FakeRailsRoute.new(
+        "fake_descendant",
+        FakeRailsRoutePathObject.new(spec: '/fake_route_1'),
+        { controller: "fake_descendant", action: "show" },
+        { :request_method => /^GET$/ }
+      )
+
+      route_2 = FakeRailsRoute.new(
+        "fake_descendant",
+        FakeRailsRoutePathObject.new(spec: '/fake_route_2'),
+        { controller: "fake_descendant", action: "show" },
+        { :request_method => /^GET$/ }
+      )
+
+      FakeRailsRoutesObject.new([ route_1, route_2 ])
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brainstem
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Mavenlink
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-04 00:00:00.000000000 Z
+date: 2018-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord