brainstem 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5785540a81ca6119478cd1c8567f3c96fa73fa6
-  data.tar.gz: c8ea012472c8d23767b446dfb941d0ebff5ec067
+  metadata.gz: '0942f85fafa0e040a4fdc07a3d61d8e09a5fe0f7'
+  data.tar.gz: f6f6d59618aefc3d545e8d9df82b70b124f0762a
 SHA512:
-  metadata.gz: 71a2fd84129676cd27b0d669c94080f92b23417c4d7eb0ccb1366b02e2baa388fd53e0a54d0bbb0f84ea47d139bd54d13bd1e725bafa2bfc613ecb343f7cd119
-  data.tar.gz: e5a35cc09a2a048fa30a4633b1c7b66f2d60f56f52e1889e46466983f4b9dcddbd4828859836680b012a68cbca8fbd74ad66b2cacb6ed2e53a810ea160ee7be8
+  metadata.gz: 1a1d425a35a804cec4bea1e1c2cc185ba435e6ffb9bf3e6c4ff1c2ca7b09ec96c23a119fa9f4b54b758ae800abd2327e1abdd7d102056365f39af4b2e31e772c
+  data.tar.gz: 4c4d077cac14df7ba87e33c4b193e31b94690192b8a118bc3e99b09cad13f1aa521f4ea68959b9c4efa7af9acd765babe5844a1e597cd53e331753466e5bac1f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    brainstem (1.3.0)
+    brainstem (1.4.0)
       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.1)
+    database_cleaner (1.6.2)
     db-query-matchers (0.9.0)
       activesupport (>= 4.0, <= 6.0)
       rspec (~> 3.0)
     diff-lcs (1.3)
-    i18n (0.9.0)
+    i18n (0.9.1)
       concurrent-ruby (~> 1.0)
     method_source (0.9.0)
     minitest (5.10.3)

data/lib/brainstem/api_docs.rb

@@ -101,12 +101,24 @@ module Brainstem
     # Is a string because most relevant classes are not loaded until much
     # later.
     #
-    # @see Brainstem::ApiDocs::RailsIntrospector#base_presenter_class=
+    # @see Brainstem::ApiDocs::RailsIntrospector#base_controller_class=
     #
     config_accessor(:base_controller_class) do
       "::ApplicationController"
     end
 
+    #
+    # Defines the 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=
+    #
+    config_accessor(:base_application_proc) do
+      Proc.new { Rails.application }
+    end
+
 
     #
     # If associations on a presenter have no description, i.e. no documentation,

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

@@ -70,6 +70,7 @@ module Brainstem
             :rails_environment_file,
             :base_presenter_class,
             :base_controller_class,
+            :base_application_proc
           ]
         end
 
@@ -175,6 +176,24 @@ module Brainstem
         attr_writer :base_controller_class
 
 
+        #
+        # Returns a proc that will return the application or engine to get routes from.
+        #
+        # @return [Proc] Proc that returns the Rails application or an engine
+        #
+        def base_application_proc
+          @base_application_proc ||= Proc.new { Rails.application }
+        end
+
+
+        #
+        # Allows for the specification for an alternate base application
+        #
+        # @param [Proc] Proc that returns the Rails application or an engine
+        #
+        attr_writer :base_application_proc
+
+
         #
         # Returns the proc that is called to format and retrieve routes.
         # The proc's return must be an array of hashes that contains the
@@ -188,7 +207,7 @@ module Brainstem
         #
         def routes_method
           @routes_method ||= Proc.new do
-            Rails.application.routes.routes.map do |route|
+            base_application_proc.call.routes.routes.map do |route|
               next unless route.defaults.has_key?(:controller) &&
                 controller_const = "#{route.defaults[:controller]}_controller"
                   .classify

data/lib/brainstem/version.rb

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

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

@@ -9,17 +9,15 @@ module Brainstem
           File.expand_path('../../../../../spec/dummy/rails.rb', __FILE__)
         end
 
-        let(:described_klass) { RailsIntrospector }
-        let(:default_args)    { { rails_environment_file: dummy_environment_file } }
+        let(:default_args) { { rails_environment_file: dummy_environment_file } }
 
         subject do
-          RailsIntrospector.send(:new, default_args)
+          described_class.send(:new, default_args)
         end
 
-
         context "when cannot find the environment file" do
           describe "#load_environment!" do
-            subject { described_klass.send(:new) }
+            subject { described_class.send(:new) }
 
             before do
             #   In the event that we've already loaded the environment through
@@ -74,11 +72,11 @@ module Brainstem
 
           describe "#presenters" do
             before do
-              stub.any_instance_of(described_klass).validate!
+              stub.any_instance_of(described_class).validate!
             end
 
             subject do
-              described_klass.with_loaded_environment(
+              described_class.with_loaded_environment(
                 default_args.merge(base_presenter_class: "::FakeBasePresenter")
               )
             end
@@ -96,11 +94,11 @@ module Brainstem
 
           describe "#controllers" do
             before do
-              stub.any_instance_of(described_klass).validate!
+              stub.any_instance_of(described_class).validate!
             end
 
             subject do
-              described_klass.with_loaded_environment(
+              described_class.with_loaded_environment(
                 default_args.merge(base_controller_class: "::FakeBaseController")
               )
             end
@@ -120,12 +118,12 @@ module Brainstem
             let(:a_proc) { Object.new }
 
             before do
-              stub.any_instance_of(described_klass).validate!
+              stub.any_instance_of(described_class).validate!
             end
 
             context "with dummy method" do
               subject do
-                described_klass.with_loaded_environment(
+                described_class.with_loaded_environment(
                   default_args.merge(routes_method: a_proc)
                 )
               end
@@ -142,7 +140,7 @@ module Brainstem
 
             context "with fake (but realistic) data" do
               subject do
-                described_klass.with_loaded_environment(default_args)
+                described_class.with_loaded_environment(default_args)
               end
 
               it "skips the entry if it does not have a valid controller" do
@@ -160,7 +158,38 @@ module Brainstem
               it "transforms the HTTP method regexp into a list of verbs" do
                 expect(subject.routes.first[:http_methods]).to eq %w(GET POST)
               end
+            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$/ }
+                )
+              }
 
+              subject do
+                described_class.with_loaded_environment(default_args.merge({ base_application_proc: base_application_proc }))
+              end
+
+              it "recognizes the configured application or engine's routes" do
+                expect(subject.routes.map { |route| route[:path] }).to match_array([
+                  { spec: "/fake_route_1" }.to_s,
+                  { spec: "/fake_route_2" }.to_s
+                ])
+              end
             end
           end
         end

data/spec/brainstem/api_docs_spec.rb

@@ -5,7 +5,6 @@ module Brainstem
   describe ApiDocs do
     let(:lorem) { "lorem ipsum dolor sit amet" }
 
-
     describe "configuration" do
       describe "formatters" do
         it "has a formatters constant" do
@@ -13,7 +12,6 @@ module Brainstem
         end
       end
 
-
       %w(
         controller_filename_pattern
         presenter_filename_pattern
@@ -23,21 +21,22 @@ module Brainstem
         output_extension
         base_presenter_class
         base_controller_class
+        base_application_proc
         document_empty_presenter_associations
         document_empty_presenter_filters
       ).each do |meth|
         describe meth do
           before do
-            @original = Brainstem::ApiDocs.public_send(meth)
+            @original = described_class.public_send(meth)
           end
 
           after do
-            Brainstem::ApiDocs.public_send("#{meth}=", @original)
+            described_class.public_send("#{meth}=", @original)
           end
 
           it "can be set and read" do
-            Brainstem::ApiDocs.public_send("#{meth}=", lorem)
-            expect(Brainstem::ApiDocs.public_send(meth)).to eq lorem
+            described_class.public_send("#{meth}=", lorem)
+            expect(described_class.public_send(meth)).to eq lorem
           end
         end
       end
@@ -45,14 +44,12 @@ module Brainstem
 
     describe "filename link patterns" do
       it 'defaults to the filename pattern' do
-        expect(Brainstem::ApiDocs.public_send("controller_filename_link_pattern")).
-          to eq(Brainstem::ApiDocs.public_send("controller_filename_pattern"))
+        expect(described_class.public_send("controller_filename_link_pattern")).
+          to eq(described_class.public_send("controller_filename_pattern"))
 
-        expect(Brainstem::ApiDocs.public_send("presenter_filename_link_pattern")).
-          to eq(Brainstem::ApiDocs.public_send("presenter_filename_pattern"))
+        expect(described_class.public_send("presenter_filename_link_pattern")).
+          to eq(described_class.public_send("presenter_filename_pattern"))
       end
     end
-
-
   end
 end

metadata

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