Handle composite primary keys in scopes

[causztic]

Fixes #531

• Make search scope work with composite primary keys
• Test associations with composite primary keys

[nertzy]

A good place to start would be to set up something in the spec/integration directory following the general pattern there. I think making a new file such as spec/integration/composite_primary_key_spec.rb may be a good approach.

The test should set up a model / DB table using with_model and with a pg_search_scope applied. It should perform some queries against the model and assert that the correct results are returned.

If we have this level of testing, then I think that the more specific "unit"-level specs are more optional and only really needed if there is some complex or surprising behavior in one of the specific implementation classes.

[nertzy]

You can also run rake standard:fix to fix the code formatting issues that are being triggered.

Good luck, and thanks for this contribution.

[nertzy]

It's great that you are testing associated_against, good catch!

[causztic]

@nertzy before e1fd67d I attempted to test when both the model AND the association have composite primary keys, and quickly realised that we need some more changes on association.rb to make it work

Could we leave that for a future PR?

[causztic]

@nertzy checking in ICYMI!

[mszyndel]

@causztic @nertzy How can I help to get this merged?

[mszyndel]

I run into an issue with associations and ended up making this monkey patch. Maybe you find it useful

  attr_reader :model

  delegate :connection, :quoted_table_name, to: :model

  def join(primary_key)
    "LEFT OUTER JOIN (#{relation(primary_key).to_sql}) #{subselect_alias} ON #{join_condition}"
  end

  def join_condition
    if composite_primary_key?
      model.primary_key.map do |part|
        "#{quoted_column_name(part)} = #{subselect_alias}.#{part}"
      end
        .join(" AND ")
    else
      "#{primary_key} = #{subselect_alias}.#{primary_key}"
    end
  end

  def quoted_column_name(column)
    "#{quoted_table_name}.#{connection.quote_column_name(column)}"
  end

  def relation(primary_key)
    result = if composite_primary_key?
      @model.unscoped.joins(@name).select("#{primary_key}, #{selects}")
    else
      @model.unscoped.joins(@name).select("#{primary_key} AS id, #{selects}")
    end
    result = result.group(primary_key) unless singular_association?
    result
  end

  def composite_primary_key?
    model.primary_key.is_a?(Array)
  end

[causztic]

@mszyndel probably needs an active maintainer to review this for this to go in 😅