Search through association fields #1005

jonatasrancan · 2017-10-16T19:37:11Z

After searching the documentation I didn't find anything about searching using the association fields, and also I didn't find any open PR related to this, so I decided to open this PR.

The approach I used was using with_options, when declaring a field on the dashboard, and added a new option called searchable_field.

The dashboard will look like this:

class StateDashboard < Administrate::BaseDashboard 
....
country: Administrate::Fields::BelongsTo.with_options(searchable: true, searchable_field: 'name')
....

houndci-bot · 2017-10-16T19:37:22Z

spec/lib/administrate/search_spec.rb

+      end
+
+      it "builds the 'where' clause using the joined tables" do
+        allow(scoped_object).to receive(:joins).with([:role, :address]).and_return(scoped_object)


Use %i or %I for an array of symbols.
Line is too long. [97/80]

houndci-bot · 2017-10-16T19:37:22Z

spec/lib/administrate/search_spec.rb

+      it "joins with the correct association table to query" do
+        allow(scoped_object).to receive(:where)
+
+        expect(scoped_object).to receive(:joins).with([:role, :address]).and_return(scoped_object)


Use %i or %I for an array of symbols.
Line is too long. [98/80]

houndci-bot · 2017-10-16T19:37:22Z

spec/lib/administrate/search_spec.rb

+        Administrate::Search.new(
+          scoped_object,
+          MockDashboardWithAssociation,
+          "Тест Test"


Put a comma after the last parameter of a multiline method call.

houndci-bot · 2017-10-16T19:37:22Z

spec/lib/administrate/search_spec.rb

+class MockDashboardWithAssociation
+  ATTRIBUTE_TYPES = {
+    role: Administrate::Field::BelongsTo.with_options(searchable: true, searchable_field: 'name'),
+    address: Administrate::Field::HasOne.with_options(searchable: true, searchable_field: 'street')


Put a comma after the last item of a multiline hash.
Line is too long. [99/80]
Prefer double-quoted strings unless you need single quotes to avoid extra backslashes for escaping.

houndci-bot · 2017-10-16T19:37:23Z

spec/lib/administrate/search_spec.rb

@@ -13,6 +13,13 @@ class MockDashboard
  }
 end

+class MockDashboardWithAssociation
+  ATTRIBUTE_TYPES = {
+    role: Administrate::Field::BelongsTo.with_options(searchable: true, searchable_field: 'name'),


Line is too long. [98/80]
Prefer double-quoted strings unless you need single quotes to avoid extra backslashes for escaping.

houndci-bot · 2017-10-16T19:37:23Z

spec/example_app/app/dashboards/customer_dashboard.rb

+        primary_key: :code,
+        foreign_key: :country_code,
+        searchable: true,
+        searchable_field: 'name'


Put a comma after the last parameter of a multiline method call.
Prefer double-quoted strings unless you need single quotes to avoid extra backslashes for escaping.

houndci-bot · 2017-10-16T19:37:23Z

lib/administrate/search.rb

+      [
+        Administrate::Field::BelongsTo,
+        Administrate::Field::HasMany,
+        Administrate::Field::HasOne


Put a comma after the last item of a multiline array.

houndci-bot · 2017-10-16T19:37:23Z

lib/administrate/search.rb

    attr_reader :resolver, :term
+
+    private


Useless private access modifier.

houndci-bot · 2017-10-16T19:37:23Z

lib/administrate/search.rb

+
+    def column_to_query(attr)
+      if association_search?(attr)
+        ActiveRecord::Base.connection.quote_column_name(attribute_types[attr].searchable_field)


Line is too long. [95/80]

houndci-bot · 2017-10-16T19:37:23Z

lib/administrate/search.rb

+      if association_search?(attr)
+        ActiveRecord::Base.connection.quote_table_name(attr.to_s.pluralize)
+      else
+        ActiveRecord::Base.connection.quote_table_name(@scoped_resource.table_name)


Line is too long. [83/80]

houndci-bot · 2017-10-16T19:49:23Z

spec/lib/administrate/search_spec.rb

+
+      it "builds the 'where' clause using the joined tables" do
+        allow(scoped_object).to receive(:joins).with(%i(role address))
+          .and_return(scoped_object)


Place the . on the previous line, together with the method call receiver.

houndci-bot · 2017-10-16T19:49:23Z

spec/lib/administrate/search_spec.rb

+        allow(scoped_object).to receive(:where)
+
+        expect(scoped_object).to receive(:joins).with(%i(role address))
+          .and_return(scoped_object)


Place the . on the previous line, together with the method call receiver.

houndci-bot · 2017-10-16T19:49:23Z

spec/lib/administrate/search_spec.rb

+    ),
+    address: Administrate::Field::HasOne.with_options(
+      searchable: true,
+      searchable_field: "street"


Put a comma after the last parameter of a multiline method call.

houndci-bot · 2017-10-16T19:49:23Z

spec/lib/administrate/search_spec.rb

+  ATTRIBUTE_TYPES = {
+    role: Administrate::Field::BelongsTo.with_options(
+      searchable: true,
+      searchable_field: "name"


Put a comma after the last parameter of a multiline method call.

houndci-bot · 2017-10-16T19:49:23Z

spec/lib/administrate/search_spec.rb

+end
+
+class MockDashboardWithAssociation
+  ATTRIBUTE_TYPES = {


Freeze mutable objects assigned to constants.

Don't know why this still here, it's fixed

houndci-bot · 2017-10-16T19:49:23Z

spec/lib/administrate/order_spec.rb

-    double(columns_hash: { column.to_s => :column_info })
+    double(
+      columns_hash: { column.to_s => :column_info },
+      table_name: "table_name"


Put a comma after the last parameter of a multiline method call.

houndci-bot · 2017-10-16T19:49:23Z

lib/administrate/search.rb

+    def column_to_query(attr)
+      if association_search?(attr)
+        ActiveRecord::Base.connection
+          .quote_column_name(attribute_types[attr].searchable_field)


Place the . on the previous line, together with the method call receiver.

houndci-bot · 2017-10-16T19:49:24Z

lib/administrate/search.rb

+        ActiveRecord::Base.connection.quote_table_name(attr.to_s.pluralize)
+      else
+        ActiveRecord::Base.connection
+          .quote_table_name(@scoped_resource.table_name)


Place the . on the previous line, together with the method call receiver.

matheuscla · 2017-11-28T18:05:49Z

Up

nicolaslazartekaqui · 2017-11-28T18:09:52Z

up

nickcharlton · 2017-12-19T21:56:41Z

Hi @jonatasrancan! Thank you for contributing this. This looks good to me!

Would you be able to look at that final Hound comment?

And add something to the docs about the new feature?

jonatasrancan · 2017-12-20T10:37:10Z

@nickcharlton I think that last Hound comment, is a bug from github, I fixed that, but it continue to appear.
I will update the docs about this.

houndci-bot · 2017-12-20T17:55:52Z

spec/lib/administrate/order_spec.rb

@@ -171,6 +171,7 @@ def relation_with_column(column)
    double(
      klass: double(reflect_on_association: nil),
      columns_hash: { column.to_s => :column_info },
+      table_name: "table_name"


Put a comma after the last parameter of a multiline method call.

houndci-bot · 2017-12-20T17:55:52Z

spec/features/log_entries_index_spec.rb

@@ -43,7 +43,7 @@

  scenario "user clicks through to the new page" do
    visit admin_log_entries_path
-    click_on("New log entry")
+    click_on t("administrate.actions.new_resource", name: 'log entries')


Prefer double-quoted strings unless you need single quotes to avoid extra backslashes for escaping.

houndci-bot · 2017-12-20T17:55:52Z

lib/administrate/order.rb

@@ -9,7 +9,7 @@ def apply(relation)
      return order_by_association(relation) unless
        reflect_association(relation).nil?

-      return relation.reorder("#{attribute} #{direction}") if
+      return relation.reorder("#{relation.table_name}.#{attribute} #{direction}") if


Line is too long. [84/80]

houndci-bot · 2017-12-20T18:00:28Z

lib/administrate/order.rb

-        relation.columns_hash.keys.include?(attribute.to_s)
+      order = "#{relation.table_name}.#{attribute} #{direction}"
+
+      return relation.reorder(order) if relation.columns_hash.keys.include?(attribute.to_s)


Line is too long. [91/80]

houndci-bot · 2017-12-20T18:00:28Z

lib/administrate/order.rb

-        relation.columns_hash.keys.include?(attribute.to_s)
+      order = "#{relation.table_name}.#{attribute} #{direction}"
+
+      return relation.reorder(order) if relation.columns_hash.keys.include?(attribute.to_s)


Line is too long. [91/80]

jonatasrancan · 2017-12-20T18:11:15Z

@nickcharlton This is ready.
The broken test is related to #1054.
Let me now when it get merged, so I can update my fork.

nickcharlton · 2018-01-16T10:16:27Z

Hi @jonatasrancan! #1054 is now merged.

jonatasrancan · 2018-01-16T12:28:09Z

@nickcharlton the PR is updated and all green 😄

dsolomadin · 2018-02-16T19:12:16Z

@nickcharlton It would be so nice to have this in next release :)

nickcharlton · 2018-03-02T18:45:59Z

Thanks for doing that!

@jonatasrancan I had a quick go myself, but rebasing got a bit knarly. Would you be able to take another look so we can get this merged in?

jonatasrancan · 2018-03-02T19:21:59Z

@nickcharlton all done 😃

nickcharlton · 2018-03-02T21:13:33Z

Great, thanks! Merging away…

houndci-bot reviewed Oct 16, 2017

View reviewed changes

jonatasrancan force-pushed the feature/search-through-association-fields branch from 63b56cd to 6141d82 Compare October 16, 2017 19:53

jonatasrancan changed the title ~~Feature/search through association fields~~ Search through association fields Oct 24, 2017

jonatasrancan force-pushed the feature/search-through-association-fields branch from 6141d82 to 89cfaba Compare December 20, 2017 17:55

houndci-bot reviewed Dec 20, 2017

View reviewed changes

jonatasrancan force-pushed the feature/search-through-association-fields branch from 89cfaba to d569835 Compare December 20, 2017 18:00

houndci-bot reviewed Dec 20, 2017

View reviewed changes

jonatasrancan force-pushed the feature/search-through-association-fields branch from d569835 to e999cb4 Compare December 20, 2017 18:06

jonatasrancan force-pushed the feature/search-through-association-fields branch 2 times, most recently from 76d5087 to 0b57c02 Compare January 16, 2018 12:15

jhonytaveira approved these changes Jan 18, 2018

View reviewed changes

jonatasrancan force-pushed the feature/search-through-association-fields branch 2 times, most recently from d27bdb5 to 0ae7f5a Compare February 1, 2018 18:53

jonatasrancan force-pushed the feature/search-through-association-fields branch from 0ae7f5a to 693b047 Compare March 2, 2018 19:12

Add ability to search through association fields

1a47be0

nickcharlton force-pushed the feature/search-through-association-fields branch from 693b047 to 1a47be0 Compare March 2, 2018 21:02

nickcharlton merged commit 71a5bd0 into thoughtbot:master Mar 2, 2018

jonatasrancan deleted the feature/search-through-association-fields branch March 5, 2018 13:12

Search through association fields #1005

Search through association fields #1005

Conversation

jonatasrancan commented Oct 16, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

matheuscla commented Nov 28, 2017

nicolaslazartekaqui commented Nov 28, 2017

nickcharlton commented Dec 19, 2017

jonatasrancan commented Dec 20, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jonatasrancan commented Dec 20, 2017

nickcharlton commented Jan 16, 2018

jonatasrancan commented Jan 16, 2018

dsolomadin commented Feb 16, 2018

nickcharlton commented Mar 2, 2018

jonatasrancan commented Mar 2, 2018

nickcharlton commented Mar 2, 2018