standardapi 6.1.0 → 7.1.1

data/test/standard_api/standard_api_test.rb

@@ -92,19 +92,34 @@ class PropertiesControllerTest < ActionDispatch::IntegrationTest
     assert_equal @controller.send(:model_includes), []
   end
 
-  test 'Controller#model_params defaults to []' do
+  test 'Controller#model_params defaults to ActionController::Parameters' do
+    @controller = DocumentsController.new
+    @controller.params = ActionController::Parameters.new
+    assert_equal @controller.send(:model_params), ActionController::Parameters.new
+  end
+
+  test 'Controller#model_params defaults to ActionController::Parameters when no resource_attributes' do
     @controller = ReferencesController.new
-    @controller.params = {}
+    @controller.params = ActionController::Parameters.new
     assert_equal @controller.send(:model_params), ActionController::Parameters.new
   end
 
-  test 'Controller#current_mask' do
+  test 'Controller#mask' do
     @controller = ReferencesController.new
-    @controller.instance_variable_set('@current_mask', { 'references' => { 'subject_id' => 1 }})
+    @controller.define_singleton_method(:mask_for) do |table_name|
+      {subject_id: 1}
+    end
     @controller.params = {}
     assert_equal 'SELECT "references".* FROM "references" WHERE "references"."subject_id" = 1', @controller.send(:resources).to_sql
   end
 
+  test "Auto includes on a controller without a model" do
+    @controller = SessionsController.new
+    assert_nil @controller.send(:model)
+    post sessions_path(format: :json), params: {session: {user: 'user', pass: 'pass'}}
+    assert_response :ok
+  end
+
   test 'ApplicationController#schema.json' do
     get schema_path(format: 'json')
 
@@ -112,7 +127,7 @@ class PropertiesControllerTest < ActionDispatch::IntegrationTest
     controllers = ApplicationController.descendants
     controllers.select! { |c| c.ancestors.include?(StandardAPI::Controller) && c != StandardAPI::Controller }
 
-    @controller.send(:models).reject { |x| x.name == 'Photo' }.each do |model|
+    @controller.send(:models).reject { |x| %w(Photo Document).include?(x.name)  }.each do |model|
       assert_equal true, schema['models'].has_key?(model.name)
 
       model_comment = model.connection.table_comment(model.table_name)
@@ -125,7 +140,7 @@ class PropertiesControllerTest < ActionDispatch::IntegrationTest
       model.columns.each do |column|
         assert_equal json_column_type(column.sql_type), schema.dig('models', model.name, 'attributes', column.name, 'type')
         default = column.default
-        if default then
+        if default
           default = model.connection.lookup_cast_type_from_column(column).deserialize(default)
           assert_equal default, schema.dig('models', model.name, 'attributes', column.name, 'default')
         else
@@ -134,11 +149,15 @@ class PropertiesControllerTest < ActionDispatch::IntegrationTest
         assert_equal column.name == model.primary_key, schema.dig('models', model.name, 'attributes', column.name, 'primary_key')
         assert_equal column.null, schema.dig('models', model.name, 'attributes', column.name, 'null')
         assert_equal column.array, schema.dig('models', model.name, 'attributes', column.name, 'array')
-        if column.comment then
+        if column.comment
           assert_equal column.comment, schema.dig('models', model.name, 'attributes', column.name, 'comment')
         else
           assert_nil schema.dig('models', model.name, 'attributes', column.name, 'comment')
         end
+
+        if column.respond_to?(:auto_populated?)
+          assert_equal !!column.auto_populated?, schema.dig('models', model.name, 'attributes', column.name, 'auto_populated')
+        end
       end
     end
 
@@ -163,6 +182,26 @@ class PropertiesControllerTest < ActionDispatch::IntegrationTest
     assert_nil schema['limit']
   end
 
+  test 'Controller#schema.json for an enum with default' do
+    get schema_documents_path(format: 'json')
+
+    schema = JSON(response.body)
+
+    assert_equal true, schema.has_key?('attributes')
+    assert_equal 'string', schema['attributes']['level']['type']
+    assert_equal 'public', schema['attributes']['level']['default']
+  end
+
+  test 'Controller#schema.json for an enum without default' do
+    get schema_documents_path(format: 'json')
+
+    schema = JSON(response.body)
+
+    assert_equal true, schema.has_key?('attributes')
+    assert_equal 'string', schema['attributes']['rating']['type']
+    assert_nil schema['attributes']['rating']['default']
+  end
+
   test 'Controller#index w/o limit' do
     account = create(:account)
     get unlimited_index_path(format: 'json')
@@ -188,47 +227,6 @@ class PropertiesControllerTest < ActionDispatch::IntegrationTest
     assert_redirected_to document_path(pdf)
   end
 
-  test 'Controller#add_resource' do
-    property = create(:property, photos: [])
-    photo = create(:photo)
-
-    post "/properties/#{property.id}/photos/#{photo.id}"
-    assert_equal property.photos.reload.map(&:id), [photo.id]
-    assert_response :created
-
-    post "/properties/#{property.id}/photos/9999999"
-    assert_response :not_found
-  end
-
-  test 'Controller#add_resource with has_one' do
-    photo = create(:document)
-    property = create(:property)
-    post "/properties/#{property.id}/document/#{photo.id}"
-    assert_equal property.reload.document, photo
-    assert_response :created
-  end
-
-  test 'Controller#remove_resource' do
-    photo = create(:photo)
-    property = create(:property, photos: [photo])
-    assert_equal property.photos.reload, [photo]
-    delete "/properties/#{property.id}/photos/#{photo.id}"
-    assert_equal property.photos.reload, []
-    assert_response :no_content
-
-    delete "/properties/#{property.id}/photos/9999999"
-    assert_response :not_found
-  end
-
-  test 'Controller#remove_resource with has_one' do
-    photo = create(:document)
-    property = create(:property, document: photo)
-    assert_equal property.document, photo
-    delete "/properties/#{property.id}/document/#{photo.id}"
-    assert_nil property.reload.document
-    assert_response :no_content
-  end
-
   # = View Tests
 
   test 'rendering tables' do
@@ -236,7 +234,7 @@ class PropertiesControllerTest < ActionDispatch::IntegrationTest
     assert_response :ok
     # assert_equal ['properties', 'accounts', 'photos', 'references', 'sessions', 'unlimited'], response.parsed_body
     # Multiple 'accounts' because multiple controllers with that model for testing.
-    assert_equal ["properties", "accounts", "documents", "photos", "references", "accounts", 'accounts'].sort, response.parsed_body.sort
+    assert_equal ["properties", "accounts", "documents", "photos", "references", "accounts", 'accounts', 'uuid_models'].sort, response.parsed_body.sort
   end
 
   test 'rendering null attribute' do
@@ -246,6 +244,19 @@ class PropertiesControllerTest < ActionDispatch::IntegrationTest
     assert_nil JSON(response.body)['landlord']
   end
 
+  test 'rendering binary attribute' do
+    reference = create(:reference, sha: "Hello World")
+    get reference_path(reference, format: 'json'), params: { id: reference.id }
+    assert_equal "48656c6c6f20576f726c64", JSON(response.body)['sha']
+  end
+
+  test 'rendering a custom binary attribute' do
+    reference = create(:reference, custom_binary: 2)
+    get reference_path(reference, format: 'json'), params: { id: reference.id }
+    assert_equal 2, JSON(response.body)['custom_binary']
+    assert_equal "\\x00000002".b,reference.custom_binary_before_type_cast
+  end
+
   test 'rendering null attribute for has_one through' do
     property = create(:property)
     get property_path(property, format: 'json'), params: { id: property.id, include: [:document] }
@@ -253,6 +264,25 @@ class PropertiesControllerTest < ActionDispatch::IntegrationTest
     assert_nil JSON(response.body)['document']
   end
 
+  test 'rendering serialize_attribute' do
+    property = create(:property, description: 'This text will magically change')
+    get property_path(property, format: 'json'), params: { id: property.id, magic: true }
+
+    body = JSON(response.body)
+    assert_equal body['description'], 'See it changed!'
+  end
+
+  test 'rendering an enum' do
+    public_document = create(:document, level: 'public')
+
+    get documents_path(format: 'json'), params: { limit: 1 }
+    assert_equal JSON(response.body)[0]['level'], 'public'
+
+    secret_document = create(:document, level: 'secret')
+    get document_path(secret_document, format: 'json')
+    assert_equal JSON(response.body)['level'], 'secret'
+  end
+
   test '#index.json uses overridden partial' do
     create(:property, photos: [create(:photo)])
     get properties_path(format: 'json'), params: { limit: 100, include: [{:photos => { order: :id }}] }
@@ -444,7 +474,7 @@ class PropertiesControllerTest < ActionDispatch::IntegrationTest
       },
       format: 'json')
 
-    assert_equal [photos.first.id], JSON(response.body)['photos'].map { |x| x['id'] }
+    assert_equal [photos.map(&:id).sort.first], JSON(response.body)['photos'].map { |x| x['id'] }
 
     get property_path(property,
       include: {
@@ -696,4 +726,34 @@ class PropertiesControllerTest < ActionDispatch::IntegrationTest
     assert_equal [1], JSON(response.body)
   end
 
+  test 'preloading polymorphic associations' do
+    p1 = create(:property)
+    p2 = create(:property)
+    c1 = create(:camera)
+    c2 = create(:camera)
+    a1 = create(:account, subject: p1, subject_cached_at: Time.now)
+    a2 = create(:account, subject: p2, subject_cached_at: Time.now)
+    a3 = create(:account, subject: c1, subject_cached_at: Time.now)
+    a4 = create(:account, subject: c2, subject_cached_at: Time.now)
+    a5 = create(:account, subject: c2, subject_cached_at: Time.now)
+
+    assert_sql(
+      'SELECT "properties".* FROM "properties" WHERE "properties"."id" IN ($1, $2)',
+      'SELECT "cameras".* FROM "cameras" WHERE "cameras"."id" IN ($1, $2)'
+    ) do
+      assert_no_sql("SELECT \"properties\".* FROM \"properties\" WHERE \"properties\".\"id\" = $1 LIMIT $2") do
+        get accounts_path(limit: 10, include: { subject: { landlord: { when: { subject_type: 'Property' } } } }, format: 'json')
+
+        assert_equal p1.id, a1.subject_id
+        assert_equal p2.id, a2.subject_id
+        assert_equal c1.id, a3.subject_id
+        assert_equal p1.id, JSON(response.body).dig(0, 'subject', 'id')
+        assert_equal p2.id, JSON(response.body).dig(1, 'subject', 'id')
+        assert_equal c1.id, JSON(response.body).dig(2, 'subject', 'id')
+        assert_equal c2.id, JSON(response.body).dig(3, 'subject', 'id')
+        assert_equal c2.id, JSON(response.body).dig(4, 'subject', 'id')
+      end
+    end
+  end
+
 end

data/test/standard_api/test_app/app/controllers/acl/account_acl.rb

@@ -9,7 +9,11 @@ module AccountACL
   end
 
   def includes
-    [ "photos", "subject", "property" ]
+    {
+      photos: true,
+      subject: [ 'landlord' ],
+      property: true
+    }
   end
 
 end

data/test/standard_api/test_app/app/controllers/acl/camera_acl.rb

@@ -0,0 +1,7 @@
+module CameraACL
+
+  def attributes
+    [ :make ]
+  end
+
+end

data/test/standard_api/test_app/app/controllers/acl/photo_acl.rb

@@ -0,0 +1,13 @@
+module PhotoACL
+
+  def attributes
+    [
+      :format
+    ]
+  end
+  
+  def nested
+    [ :account, :camera ]
+  end
+
+end

data/test/standard_api/test_app/app/controllers/acl/property_acl.rb

@@ -1,5 +1,6 @@
 module PropertyACL
 
+  # Attributes allowed to be updated
   def attributes
     [ :name,
       :aliases,
@@ -12,16 +13,21 @@ module PropertyACL
     ]
   end
 
+  # Orderings allowed
   def orders
     ["id", "name", "aliases", "description", "constructed", "size", "created_at", "active"]
   end
 
+  # Sub resources allowed to be included in the response
   def includes
     [ :photos, :landlord, :english_name, :document ]
   end
 
+  # Sub resourced allowed to be set during create / update / delete if a user is
+  # allowed to ....
+  # only add to and from the relation, can also create or update the subresource
   def nested
-    [ :photos ]
+    [ :photos, :accounts ]
   end
 
 end

data/test/standard_api/test_app/controllers.rb

@@ -2,6 +2,18 @@ class ApplicationController < ActionController::Base
   include StandardAPI::Controller
   include StandardAPI::AccessControlList
   prepend_view_path File.join(File.dirname(__FILE__), 'views')
+  
+  helper_method :serialize_attribute
+
+  def serialize_attribute(json, record, attribute, type)
+    value = if attribute == 'description' && params["magic"] === "true"
+      'See it changed!'
+    else
+      record.send(attribute)
+    end
+    
+    json.set! attribute, type == :binary ? value&.unpack1('H*') : value
+  end
 
 end
 
@@ -48,6 +60,8 @@ class ReferencesController < ApplicationController
 end
 
 class SessionsController < ApplicationController
+  def create
+  end
 end
 
 class UnlimitedController < ApplicationController
@@ -73,3 +87,6 @@ class DefaultLimitController < ApplicationController
   end
 
 end
+
+class UuidModelController < ApplicationController
+end

data/test/standard_api/test_app/models.rb

@@ -7,12 +7,16 @@ class Account < ActiveRecord::Base
 end
 
 class Photo < ActiveRecord::Base
-  belongs_to :account, :counter_cache => true
+  belongs_to :account, counter_cache: true
   has_and_belongs_to_many :properties
+  has_one :camera
 end
 
 class Document < ActiveRecord::Base
   attr_accessor :file
+  
+  enum level:   { public: 0, secret: 1 }, _suffix: true
+  enum rating:  { poor: 0, ok: 1, good: 2 }
 end
 
 class Pdf < Document
@@ -34,8 +38,36 @@ class Property < ActiveRecord::Base
   end
 end
 
+class LSNType < ActiveRecord::Type::Value
+
+  def type
+    :lsn
+  end
+
+  def cast_value(value)
+    case value
+    when Integer
+      [value].pack('N')
+    else
+      value&.to_s&.b
+    end
+  end
+
+  def serialize(value)
+    PG::TextEncoder::Bytea.new.encode(value)
+  end
+
+  def deserialize(value)
+    return nil if value.nil?
+    PG::TextDecoder::Bytea.new.decode(value).unpack1('N')
+  end
+
+end
+
 class Reference < ActiveRecord::Base
   belongs_to :subject, polymorphic: true
+
+  attribute :custom_binary, LSNType.new
 end
 
 class Document < ActiveRecord::Base
@@ -47,7 +79,16 @@ class Attachment < ActiveRecord::Base
   belongs_to :document
 end
 
-# = Migration
+class Camera < ActiveRecord::Base
+end
+
+class UuidModel < ActiveRecord::Base
+end
+
+# = Create/recreate database and migration
+task = ActiveRecord::Tasks::PostgreSQLDatabaseTasks.new(ActiveRecord::Base.connection_db_config)
+task.drop
+task.create
 
 class CreateModelTables < ActiveRecord::Migration[6.0]
 
@@ -93,6 +134,8 @@ class CreateModelTables < ActiveRecord::Migration[6.0]
     create_table "references", force: :cascade do |t|
       t.integer  "subject_id"
       t.string   "subject_type",         limit: 255
+      t.binary   "sha"
+      t.binary   "custom_binary"
       t.string   "key"
       t.string   "value"
     end
@@ -100,6 +143,7 @@ class CreateModelTables < ActiveRecord::Migration[6.0]
     create_table "photos_properties", force: :cascade do |t|
       t.integer  "photo_id"
       t.integer  "property_id"
+      t.index ["photo_id", "property_id"], unique: true
     end
 
     create_table "landlords_properties", force: :cascade do |t|
@@ -108,14 +152,27 @@ class CreateModelTables < ActiveRecord::Migration[6.0]
     end
 
     create_table "documents", force: :cascade do |t|
+      t.integer  'level', limit: 2, null: false, default: 0
+      t.integer  'rating', limit: 2
       t.string   'type'
     end
 
+    create_table "cameras", force: :cascade do |t|
+      t.integer  'photo_id'
+      t.string   'make'
+    end
+
     create_table "attachments", force: :cascade do |t|
       t.string  'record_type'
       t.integer  'record_id'
       t.integer  'document_id'
     end
+    
+    create_table "uuid_models", id: :uuid, force: :cascade do |t|
+      t.string 'title', default: 'recruit'
+      t.string 'name', default: -> { 'round(random() * 1000)' }
+    end
+    
   end
 
 end

data/test/standard_api/test_app/test/factories.rb

@@ -48,4 +48,7 @@ FactoryBot.define do
     end
   end
 
+  factory :camera do
+    make  { ['Sony', 'Nokia', 'Canon', 'Leica'].sample }
+  end
 end

data/test/standard_api/test_app/views/sessions/create.json.jbuilder

@@ -0,0 +1 @@
+json.set! 'includes', includes

data/test/standard_api/test_app/views/sessions/create.streamer

@@ -0,0 +1,3 @@
+json.object! do
+  json.set! 'includes', includes
+end

data/test/standard_api/test_app.rb

@@ -18,7 +18,7 @@ class TestApplication < Rails::Application
   config.cache_classes = true
   config.action_controller.perform_caching = true
   config.cache_store = :memory_store, { size: 8.megabytes }
-  config.action_dispatch.show_exceptions = false
+  config.action_dispatch.show_exceptions = :none
 
   # if defined?(FactoryBotRails)
   #   config.factory_bot.definition_file_paths += [ '../factories' ]
@@ -28,6 +28,15 @@ end
 # Test Application initialization
 TestApplication.initialize!
 
+# Make sure to test the right view files
+ActionView::Template.unregister_template_handler :streamer, :jbuilder
+case ENV["TSENCODER"]
+when "turbostreamer"
+  ActionView::Template.register_template_handler :streamer, TurboStreamer::Handler
+else
+  ActionView::Template.register_template_handler :jbuilder, JbuilderHandler
+end
+
 # Test Application Models
 require 'standard_api/test_app/models'
 
@@ -44,6 +53,9 @@ Rails.application.routes.draw do
   end
 
   standard_resource :account
+  standard_resources :accounts, only: :index
+  # standard_resources :photos, only: [ :index, :show ]
+
 end
 
 # Test Application Helpers

data/test/standard_api/test_helper.rb

@@ -64,6 +64,15 @@ class ActiveSupport::TestCase
 
   # = Helper Methods
 
+  def debug
+    ActiveRecord::Base.logger = Logger.new(STDOUT)
+    $debugging = true
+    yield
+  ensure
+    ActiveRecord::Base.logger = nil
+    $debugging = false
+  end
+
   def controller_path
     if defined?(@controller)
       @controller.controller_path
@@ -76,16 +85,58 @@ class ActiveSupport::TestCase
     { :controller => controller_path, :action => action }.merge(options)
   end
 
-  def assert_sql(sql, &block)
-    queries = []
-    callback = -> (*, payload) do
-      queries << payload[:sql]
+  def assert_sql(*expected)
+    return_value = nil
+
+    queries_ran = if block_given?
+      queries_ran = SQLLogger.log.size
+      return_value = yield if block_given?
+      SQLLogger.log[queries_ran...]
+    else
+      [expected.pop]
     end
 
-    ActiveSupport::Notifications.subscribed(callback, "sql.active_record", &block)
+    failed_patterns = []
+    expected.each do |pattern|
+      failed_patterns << pattern unless queries_ran.any?{ |sql| sql_equal(pattern, sql) }
+    end
+
+    assert failed_patterns.empty?, <<~MSG
+      Query pattern(s) not found:
+        - #{failed_patterns.map{|l| l.gsub(/\n\s*/, " ")}.join('\n  - ')}
+      Queries Ran (queries_ran.size):
+        - #{queries_ran.map{|l| l.gsub(/\n\s*/, "\n    ")}.join("\n  - ")}
+    MSG
+
+    return_value
+  end
 
-    assert_not_nil queries.map { |x| x.strip.gsub(/\s+/, ' ') }.
-      find { |x| x == sql.strip.gsub(/\s+/, ' ') }
+  def assert_no_sql(*not_expected)
+    return_value = nil
+    queries_ran = block_given? ? SQLLogger.log.size : 0
+    return_value = yield if block_given?
+  ensure
+    failed_patterns = []
+    queries_ran = SQLLogger.log[queries_ran...]
+    not_expected.each do |pattern|
+      failed_patterns << pattern if queries_ran.any?{ |sql| sql_equal(pattern, sql) }
+    end
+    assert failed_patterns.empty?, <<~MSG
+      Unexpected Query pattern(s) found:
+        - #{failed_patterns.map(&:inspect).join('\n  - ')}
+      Queries Ran (queries_ran.size):
+        - #{queries_ran.map{|l| l.gsub(/\n\s*/, "\n    ")}.join("\n  - ")}
+    MSG
+
+    return_value
+  end
+  def sql_equal(expected, sql)
+    sql = sql.strip.gsub(/"(\w+)"/, '\1').gsub(/\(\s+/, '(').gsub(/\s+\)/, ')').gsub(/\s+/, ' ')
+    if expected.is_a?(String)
+      expected = Regexp.new(Regexp.escape(expected.strip.gsub(/"(\w+)"/, '\1').gsub(/\(\s+/, '(').gsub(/\s+\)/, ')').gsub(/\s+/, ' ')), Regexp::IGNORECASE)
+    end
+
+    expected.match(sql)
   end
 
   def assert_rendered(options = {}, message = nil)
@@ -225,6 +276,48 @@ class ActiveSupport::TestCase
     end
   end
 
+  class SQLLogger
+    class << self
+      attr_accessor :ignored_sql, :log, :log_all
+      def clear_log; self.log = []; self.log_all = []; end
+    end
+
+    self.clear_log
+
+    self.ignored_sql = [/^PRAGMA/i, /^SELECT currval/i, /^SELECT CAST/i, /^SELECT @@IDENTITY/i, /^SELECT @@ROWCOUNT/i, /^SAVEPOINT/i, /^ROLLBACK TO SAVEPOINT/i, /^RELEASE SAVEPOINT/i, /^SHOW max_identifier_length/i, /^BEGIN/i, /^COMMIT/i]
+
+    # FIXME: this needs to be refactored so specific database can add their own
+    # ignored SQL, or better yet, use a different notification for the queries
+    # instead examining the SQL content.
+    oracle_ignored     = [/^select .*nextval/i, /^SAVEPOINT/, /^ROLLBACK TO/, /^\s*select .* from all_triggers/im, /^\s*select .* from all_constraints/im, /^\s*select .* from all_tab_cols/im]
+    mysql_ignored      = [/^SHOW FULL TABLES/i, /^SHOW FULL FIELDS/, /^SHOW CREATE TABLE /i, /^SHOW VARIABLES /, /^\s*SELECT (?:column_name|table_name)\b.*\bFROM information_schema\.(?:key_column_usage|tables)\b/im]
+    postgresql_ignored = [/^\s*select\b.*\bfrom\b.*pg_namespace\b/im, /^\s*select tablename\b.*from pg_tables\b/im, /^\s*select\b.*\battname\b.*\bfrom\b.*\bpg_attribute\b/im, /^SHOW search_path/i]
+    sqlite3_ignored =    [/^\s*SELECT name\b.*\bFROM sqlite_master/im, /^\s*SELECT sql\b.*\bFROM sqlite_master/im]
+
+    [oracle_ignored, mysql_ignored, postgresql_ignored, sqlite3_ignored].each do |db_ignored_sql|
+      ignored_sql.concat db_ignored_sql
+    end
+
+    attr_reader :ignore
+
+    def initialize(ignore = Regexp.union(self.class.ignored_sql))
+      @ignore = ignore
+    end
+
+    def call(name, start, finish, message_id, values)
+      sql = values[:sql]
+
+      # FIXME: this seems bad. we should probably have a better way to indicate
+      # the query was cached
+      return if 'CACHE' == values[:name]
+
+      self.class.log_all << sql
+      # puts sql
+      self.class.log << sql unless ignore =~ sql
+    end
+  end
+  ActiveSupport::Notifications.subscribe('sql.active_record', SQLLogger.new)
+
 end
 
 class ActionController::TestCase