brainstem 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e825c08d783b4cecd7da03879db5545efd3e0697
-  data.tar.gz: 1478c23f3186dd7d065585d102245e995e6d9df5
+  metadata.gz: be36bdc7fac874075d12f3fc38f599db5b212521
+  data.tar.gz: 34d5b34f8f0ff187174aa72e7cab77de068d31fe
 SHA512:
-  metadata.gz: 27a6f03a61dcd1371ffe0b7860563fe8ba94b6be14814f21ae35f4230d2af65fdcf1790f8a547c5913d11611a4ded52e8f17136cd6b6efb4d8a32adf40b1680c
-  data.tar.gz: 501e3164fade58216384cc7ddfe32a07e009af99029a75ddd0f1db19d770e356983af1d4786953997ff18ce3ea03a55e376db05a784db06088e0e3090b131b84
+  metadata.gz: c89e79f9afe533a869501ede83e86ad4cbeba0dbb08c6a29d57b4dbac437e3a7072e672fc807ec517225b67f5aefdc42d0ebaba68cdc713505cd460f02b1a3bb
+  data.tar.gz: d9a506a58f9fd81d58ae3546dd88dce4e7f6fd836661673915402c54ee0d6a3235def1abddafe465cff485daf7e1f911a7b5bdad0b539a623590c6dbe11a3db7

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
++ **2.2.0** - _08/15/2019_
+  ### Bugfixes
+    - Add support for API documentation generation in Rails 5.x
+    - Address deprecation warnings for Rails 6 by wrapping raw sql in `Arel.sql`
+
 + **2.1.0** - _05/10/2019_
   ### New Features
     - Add the ability to mark properties as internal for Open API.

data/brainstem.gemspec

@@ -33,4 +33,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "pry"
   gem.add_development_dependency "pry-nav"
   gem.add_development_dependency "db-query-matchers"
+  gem.add_development_dependency 'actionpack'
 end

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

@@ -212,17 +212,19 @@ module Brainstem
                   .classify
                   .constantize rescue nil
 
+              http_methods = (
+                route.verb.is_a?(Regexp) ?
+                  route.verb.inspect.gsub(/[\/\$\^]/, '') :
+                  route.verb
+              ).split("|")
+
               {
                 alias:            route.name,
                 path:             route.path.spec.to_s,
                 controller_name:  route.defaults[:controller],
                 controller:       controller_const,
                 action:           route.defaults[:action],
-                http_methods:     route.constraints
-                  .fetch(:request_method, nil)
-                  .inspect
-                  .gsub(/[\/\$\^]/, '')
-                  .split("|")
+                http_methods:     http_methods
               }
             end.compact
           end

data/lib/brainstem/controller_methods.rb

@@ -25,7 +25,7 @@ module Brainstem
     # @yield (see PresenterCollection#presenting)
     # @return (see PresenterCollection#presenting)
     def brainstem_present(name, options = {}, &block)
-      Brainstem.presenter_collection(options[:namespace]).presenting(name, options.reverse_merge(:params => params), &block)
+      Brainstem.presenter_collection(options[:namespace]).presenting(name, options.reverse_merge(:params => params.to_unsafe_h), &block)
     end
 
     # Similar to ControllerMethods#brainstem_present, but always returns all of the given objects, not just those that
@@ -36,7 +36,7 @@ module Brainstem
     #                           only required if the name cannot be inferred.
     # @return (see PresenterCollection#presenting)
     def brainstem_present_object(objects, options = {})
-      options.merge!(:params => params, :apply_default_filters => false)
+      options.merge!(:params => params.to_unsafe_h, :apply_default_filters => false)
 
       if objects.is_a?(ActiveRecord::Relation) || objects.is_a?(Array)
         raise ActiveRecord::RecordNotFound if objects.empty?

data/lib/brainstem/presenter.rb

@@ -232,7 +232,7 @@ module Brainstem
       primary_key = scope.model.primary_key
 
       if table_name && primary_key
-        "#{scope.connection.quote_table_name(table_name)}.#{scope.connection.quote_column_name(primary_key)} ASC"
+        Arel.sql("#{scope.connection.quote_table_name(table_name)}.#{scope.connection.quote_column_name(primary_key)} ASC")
       else
         nil
       end

data/lib/brainstem/presenter_collection.rb

@@ -35,7 +35,7 @@ module Brainstem
     # @yield Must return a scope on the model +name+, which will then be presented.
     # @return [Hash] A hash of arrays of hashes. Top-level hash keys are pluralized model names, with values of arrays containing one hash per object that was found by the given given options.
     def presenting(name, options = {}, &block)
-      options[:params] = HashWithIndifferentAccess.new(options[:params] || {})
+      options[:params] = ActiveSupport::HashWithIndifferentAccess.new(options[:params] || {})
       check_for_old_options!(options)
       set_default_filters_option!(options)
       presented_class = (options[:model] || name)

data/lib/brainstem/query_strategies/filter_and_search.rb

@@ -35,7 +35,7 @@ module Brainstem
       private
 
       def run_search(scope, includes)
-        search_options = HashWithIndifferentAccess.new(
+        search_options = ActiveSupport::HashWithIndifferentAccess.new(
           include: includes,
           limit: @options[:default_max_filter_and_search_page],
           offset: 0

data/lib/brainstem/query_strategies/filter_or_search.rb

@@ -44,7 +44,7 @@ module Brainstem
       def run_search(scope, includes, sort_name, direction)
         return scope unless searching?
 
-        search_options = HashWithIndifferentAccess.new(
+        search_options = ActiveSupport::HashWithIndifferentAccess.new(
           include: includes,
           order: { sort_order: sort_name, direction: direction },
         )

data/lib/brainstem/version.rb

@@ -1,3 +1,3 @@
 module Brainstem
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
 end

data/spec/brainstem/controller_methods_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'action_controller/metal/strong_parameters'
 
 describe Brainstem::ControllerMethods do
   class TasksController
@@ -7,15 +8,27 @@ describe Brainstem::ControllerMethods do
     attr_accessor :call_results
 
     def params
-      { :a => :b }
+      @params ||= ActionController::Parameters.new({ :a => :b })
     end
   end
 
+  before(:all) do
+    ActionController::Parameters.action_on_unpermitted_parameters = :raise
+  end
+
   describe "#present_object" do
     before do
       @controller = TasksController.new
     end
 
+    describe '#integration' do
+      it 'permits the parameters' do
+        # This would throw an UnpermittedParameters exception if we didn't permit the parameters
+        @controller.brainstem_present_object([Workspace.find(1), Workspace.find(3)])
+        @controller.brainstem_present(Workspace) { Workspace.unscoped }
+      end
+    end
+
     describe "calling #present with sensible params" do
       before do
         def @controller.brainstem_present(klass, options)
@@ -60,7 +73,9 @@ describe Brainstem::ControllerMethods do
       it "adds an only param if there is only one object to present" do
         @controller.brainstem_present_object(Workspace.find(1))
         expect(@controller.call_results[:options][:params][:only]).to eq("1")
+      end
 
+      it "doesn't set only if there is more than one object" do
         @controller.brainstem_present_object(Workspace.all)
         expect(@controller.call_results[:options][:params][:only]).to be_nil
       end

data/spec/dummy/rails.rb

@@ -4,34 +4,47 @@ silence_warnings do
   FakeRailsApplication      = Struct.new(:eager_load!, :routes)
   FakeRailsRoutesObject     = Struct.new(:routes)
   FakeRailsRoutePathObject  = Struct.new(:spec)
-  FakeRailsRoute            = Struct.new(:name, :path, :defaults, :constraints)
+  FakeRailsRoute            = Struct.new(:name, :path, :defaults, :verb)
 end
 
 class Rails
   def self.application
     @application ||= begin
+      #
+      # For Rails 4.1 & 4.2, the `verb` method on a route returns a regular expression.
+      #
       route_1 = FakeRailsRoute.new(
         "fake_descendant",
         FakeRailsRoutePathObject.new(spec: '/fake_descendant'),
         { controller: "fake_descendant", action: "show" },
-        { :request_method => /^GET|POST$/ }
+        /^GET|POST$/
       )
 
       route_2 = FakeRailsRoute.new(
         "route_with_no_controller",
         FakeRailsRoutePathObject.new(spec: '/fake_descendant'),
         { },
-        { :request_method => /^PATCH$/ }
+        /^PATCH$/
       )
 
+      #
+      # For Rails 5.x, the `verb` method on a route returns a string.
+      #
       route_3 = FakeRailsRoute.new(
         "route_with_invalid_controller",
         FakeRailsRoutePathObject.new(spec: '/fake_descendant'),
         { controller: "invalid_controller", action: "show" },
-        { :request_method => /^GET$/ }
+        'GET'
       )
 
-      routes = FakeRailsRoutesObject.new([ route_1, route_2, route_3 ])
+      route_4 = FakeRailsRoute.new(
+        "another_fake_descendant",
+        FakeRailsRoutePathObject.new(spec: '/another_fake_descendant'),
+        { controller: "another_fake_descendant", action: "update" },
+        'PUT|PATCH'
+      )
+
+      routes = FakeRailsRoutesObject.new([ route_1, route_2, route_3, route_4 ])
 
       FakeRailsApplication.new(true, routes)
     end
@@ -54,14 +67,14 @@ class FakeApiEngine
         "fake_descendant",
         FakeRailsRoutePathObject.new(spec: '/fake_route_1'),
         { controller: "fake_descendant", action: "show" },
-        { :request_method => /^GET$/ }
+        /^PUT|PATCH$/
       )
 
       route_2 = FakeRailsRoute.new(
         "fake_descendant",
         FakeRailsRoutePathObject.new(spec: '/fake_route_2'),
         { controller: "fake_descendant", action: "show" },
-        { :request_method => /^GET$/ }
+        'PUT|PATCH'
       )
 
       FakeRailsRoutesObject.new([ route_1, route_2 ])

data/spec/spec_helpers/schema.rb

@@ -1,5 +1,5 @@
 if ENV['USE_MYSQL']
-  ActiveRecord::Base.establish_connection(:adapter => 'mysql2', :database => 'test', :username => 'root', :password => '', :host => '127.0.0.1')
+  ActiveRecord::Base.establish_connection(:adapter => 'mysql2', :database => 'test', :username => 'root', :password => '', :host => '127.0.0.1', variables: { sql_mode: "STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION" })
 else
   ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brainstem
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Mavenlink
@@ -192,6 +192,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Brainstem allows you to create rich API presenters that know how to filter,
   sort, and include associations.
 email: