Fixes #11331: Created random generator to fetch nodes randomly as cards #11332

KarishmaVanwari · 2022-08-05T19:39:14Z

Make sure these boxes are checked before your pull request (PR) is ready to be reviewed and merged. Thanks!

PR is descriptively titled 📑 and links the original issue above 🔗
tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR -- or run tests locally with rake test
code is in uniquely-named feature branch and has no merge conflicts 📁
screenshots/GIFs are attached 📎 in case of UI updation
ask @publiclab/reviewers for help, in a comment below

…ly as cards

gitpod-io · 2022-08-05T19:39:21Z

codeclimate · 2022-08-05T19:40:09Z

app/models/tag.rb

@@ -478,4 +478,34 @@ def span(start, fin)
  def range(fin, week)
    (fin.to_i - week.weeks.to_i).to_s..(fin.to_i - (week - 1).weeks.to_i).to_s
  end
+
+  def self.get_recommendations(tag1, tag2)


private (on line 464) does not make singleton methods private. Use private_class_method or private inside a class << self block instead.

codeclimate · 2022-08-05T19:40:09Z

app/models/tag.rb

+    Node.where("nid IN (?)", random_content_nids)
+  end  
+
+  def self.find_recommended_nodes(tagnames, limit = 10)


private (on line 464) does not make singleton methods private. Use private_class_method or private inside a class << self block instead.

codeclimate · 2022-08-05T19:40:10Z

app/controllers/wiki_controller.rb

@@ -60,6 +60,11 @@ def show
    if !@node.nil? # it's a place page!
      @tags = @node.tags
      @tags += [Tag.find_by(name: params[:id])] if Tag.find_by(name: params[:id])
+


Trailing whitespace detected.

codeclimate · 2022-08-05T19:40:10Z

app/controllers/wiki_controller.rb

@@ -60,6 +60,11 @@ def show
    if !@node.nil? # it's a place page!
      @tags = @node.tags
      @tags += [Tag.find_by(name: params[:id])] if Tag.find_by(name: params[:id])
+
+      tag1, tag2 = @node.normal_tags(:followers).includes(:tag).pluck(:name).first(2)
+


Trailing whitespace detected.

codeclimate · 2022-08-05T19:40:11Z

Code Climate has analyzed commit 8ae260f and detected 4 issues on this pull request.

Here's the issue category breakdown:

Category	Count
Style	4

View more on Code Climate.

github-actions · 2022-08-05T19:50:27Z

This pull request generated screenshots of many common pages in the running app. You should be able to download and view them here:
https://github.com/publiclab/plots2/suites/7689226168/artifacts/321116664

codecov · 2022-08-05T19:51:39Z

Codecov Report

Merging #11332 (73ab354) into main (8b97a11) will increase coverage by 0.09%.
The diff coverage is 100.00%.

❗ Current head 73ab354 differs from pull request most recent head 1850bf3. Consider uploading reports for the commit 1850bf3 to get more accurate results

@@            Coverage Diff             @@
##             main   #11332      +/-   ##
==========================================
+ Coverage   82.46%   82.56%   +0.09%     
==========================================
  Files          98       96       -2     
  Lines        5995     5960      -35     
==========================================
- Hits         4944     4921      -23     
+ Misses       1051     1039      -12

Impacted Files	Coverage Δ
app/controllers/wiki_controller.rb	`82.97% <100.00%> (+0.12%)`	⬆️
app/models/tag.rb	`93.60% <100.00%> (+0.30%)`	⬆️
app/controllers/home_controller.rb	`95.77% <0.00%> (-0.18%)`	⬇️
app/models/user.rb	`86.49% <0.00%> (-0.15%)`	⬇️
app/models/node.rb	`91.18% <0.00%> (-0.09%)`	⬇️
app/models/comment.rb	`77.70% <0.00%> (-0.08%)`	⬇️
app/models/answer.rb
app/models/drupal_content_field_image_gallery.rb
app/controllers/comment_controller.rb	`83.07% <0.00%> (+0.26%)`	⬆️
app/controllers/map_controller.rb	`50.33% <0.00%> (+0.33%)`	⬆️
... and 1 more

TildaDares · 2022-08-07T17:18:21Z

app/controllers/wiki_controller.rb

+      tag1, tag2 = @node.normal_tags(:followers).includes(:tag).pluck(:name).first(2)
+
+      # get recommendations
+      @recommendations = Tag.get_recommendations(tag1, tag2)


Hi @KarishmaVanwari, since you want the random cards to be displayed in the dashboard's sidebar shouldn't this be in home_controller?

plots2/app/controllers/home_controller.rb

Lines 39 to 59 in ca319fc

def dashboard_v2

@title = I18n.t('dashboard._header.dashboard')

# The new dashboard displays the blog and topics list

if current_user

@blog = Tag.find_nodes_by_type('blog', 'note', 1).limit(1).first

# Tags without the blog tag and everything tag to avoid double display

exclude_tids = Tag.where(name: %w(blog everything)).pluck(:tid)

@pagy, @tag_subscriptions = pagy(

TagSelection

.select('tag_selections.tid, term_data.name')

.where(user_id: current_user.id, following: true)

.where.not(tid: exclude_tids)

.joins("INNER JOIN term_data ON tag_selections.tid = term_data.tid")

.order("term_data.activity_timestamp DESC")

)

@trending_tags = trending

render template: 'dashboard_v2/dashboard'

else

redirect_to '/research'

end

end

Please let me know if I'm wrong or missing something.

What if we put it in a reusable named methodin application_controller so it can be used in multiple places?

I tried placing this piece of code on line 54 in home_conroller but it gives the following error -
NoMethodError in HomeController#dashboard_v2
undefined method normal_tags for nil:NilClass .

@TildaDares @jywarren

jywarren · 2022-08-15T16:32:20Z

app/views/dashboard_v2/_sidebar.html.erb

@@ -55,7 +55,20 @@
    </div>
  </div>
 </div>
-
+<div>


could we move this into its own partial - to load with <%= render partial: "nodes/random" %> and the partial template would be _random.html.erb.

jywarren · 2022-08-15T16:34:50Z

app/controllers/wiki_controller.rb

@@ -60,6 +60,11 @@ def show
    if !@node.nil? # it's a place page!
      @tags = @node.tags
      @tags += [Tag.find_by(name: params[:id])] if Tag.find_by(name: params[:id])
+
+      tag1, tag2 = @node.normal_tags(:followers).includes(:tag).pluck(:name).first(2)


Suggested change

tag1, tag2 = @node.normal_tags(:followers).includes(:tag).pluck(:name).first(2)

puts ">>>>>>>>>>>>>>>>>>>>>>>>>>>"

puts @node.inspect

puts ">>>>>>>>>>>>>>>>>>>>>>>>>>>"

tag1, tag2 = @node.normal_tags(:followers).includes(:tag).pluck(:name).first(2)

jywarren · 2022-08-15T16:47:26Z

app/views/dashboard_v2/_sidebar.html.erb

@@ -55,7 +55,20 @@
    </div>
  </div>
 </div>
-
+<div>
+<% if !@recommendations.nil? %>


Suggested change

<% if !@recommendations.nil? %>

<% @recommendations ||= Tag.get_recommendations("water-quality", "air-quality") %>

@jywarren, I tried this out, but it still doesn't seem to work as I am unable to find cards as expected on the dashboard.

That may be because you don't have nodes with those tags in your local development environment? Can you try tagging a note (not a wiki, i think this is just returning notes, right?) with "water-quality" or "air-quality"? If that doesn't work I will try running this code to debug. No worries!! Did you want to accept this suggestion and commit it?

KarishmaVanwari · 2022-09-02T01:44:58Z

Hi @jywarren, I've opened a PR #11380. Thanks!

jywarren · 2022-09-02T13:21:32Z

My apologies for mixing these all up, but i hid the subtopics discussion from this thread to try to clear it up. Looking at the issues here now!

jywarren · 2022-09-05T17:30:36Z

OK, so I had to make some edits to the dashboard code to make it work, but ultimately I found that Tag.get_recommendations("blog", "three") is not returning anything (i used "blog" because that's in the db seeds file so it exists).

So let's debug why that's not working. I think we may want to write a unit test for that code. That will let us test Tag.get_recommendations("blog", "three") in isolation and ensure it returns the right thing. Why don't I write the unit test and you can work on figuring out why it's not returning anything!

jywarren · 2022-09-05T17:34:21Z

test/unit/tag_test.rb

@@ -294,4 +294,9 @@ def setup
    assert lat.location_tag?
    assert lon.location_tag?
  end
+
+  test 'Tag.get_recommendations' do


OK, here's the unit test. Let's ensure it returns something! We could even test how many nodes it returns, or something else. But most importantly that it returns nodes at all!

OK, see below where I made a further suggestion about the unit test: #11332 (comment) (it got collapsed because I accepted the change)

github-actions · 2022-09-05T17:44:07Z

This pull request generated screenshots of many common pages in the running app. You should be able to download and view them here:
https://github.com/publiclab/plots2/suites/8142454649/artifacts/353100585

test/unit/tag_test.rb

jywarren · 2022-09-06T23:17:07Z

Generally unit tests test individual functions in isolation, not in the context of a big running application all at once. They're useful for finding narrow reasons things may have gone wrong, and that individual pieces function as expected.

By contrast, integration tests, or system tests, are "full-stack" tests which start up the whole application and help us see how things might go wrong when everything is trying to work in synchrony, all at once.

Both types of test -- the narrow ones and the broad ones -- are useful for catching errors. Sometimes both get tripped! But I hope that way of thinking of different kinds of tests makes sense!

jywarren · 2022-09-06T23:23:03Z

test/unit/tag_test.rb

+  test 'Tag.get_recommendations' do
+    nodes = Tag.get_recommendations("blog", "test")
+    assert_not_nil nodes
+    assert nodes.length > 0


Aha! This assertion failed! So, looks like we have been getting an empty array back:

https://github.com/publiclab/plots2/runs/8217990567?check_suite_focus=true#step:5:85

TagTest#test_Tag.get_recommendations (23.30s) Expected false to be truthy. test/unit/tag_test.rb:301:in `block in <class:TagTest>'

Great, so now, we can try to fix that. Once we push a fix up as a commit to this PR, the test will start to pass again -- that's actually "Test Driven Development" -- we set up a specific enough test condition (or "assertion") that our test will pass once it's working properly. The test actually precedes the final solution!

github-actions · 2022-09-06T23:31:55Z

This pull request generated screenshots of many common pages in the running app. You should be able to download and view them here:
https://github.com/publiclab/plots2/suites/8164595320/artifacts/354647543

stale · 2023-09-16T22:30:16Z

Hi 😄, this issue has been automatically marked as stale because it has not had recent activity. Don't worry you can continue to work on this and ask @publiclab/reviewers to add in-progress label 🎉 . Otherwise, it will be closed if no further activity occurs in 10 days -- but you can always re-open it if you like! 💯 Thank you for your contributions! 🙌 🎈.

Fixes publiclab#11331: Created random generator to fetch nodes random…

8ae260f

…ly as cards

codeclimate bot reviewed Aug 5, 2022

View reviewed changes

KarishmaVanwari requested review from TildaDares, cesswairimu and jywarren August 7, 2022 14:06

TildaDares reviewed Aug 7, 2022

View reviewed changes

KarishmaVanwari requested a review from TildaDares August 8, 2022 21:38

This comment was marked as outdated.

Sign in to view

jywarren reviewed Aug 15, 2022

View reviewed changes

This comment was marked as off-topic.

Sign in to view

KarishmaVanwari requested a review from jywarren September 2, 2022 12:20

This was referenced Sep 2, 2022

Fixes #11379: Made the subtopics method #11380

Closed

Make the subtopics method #11379

Open

fixes to sidebar html and get_recommendations unit test

73ab354

jywarren reviewed Sep 5, 2022

View reviewed changes

jywarren reviewed Sep 6, 2022

View reviewed changes

test/unit/tag_test.rb Show resolved Hide resolved

Update test/unit/tag_test.rb

1850bf3

jywarren reviewed Sep 6, 2022

View reviewed changes

stale bot added the stale label Sep 16, 2023

stale bot closed this Oct 15, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixes #11331: Created random generator to fetch nodes randomly as cards #11332

Fixes #11331: Created random generator to fetch nodes randomly as cards #11332

KarishmaVanwari commented Aug 5, 2022

gitpod-io bot commented Aug 5, 2022

codeclimate bot Aug 5, 2022

codeclimate bot Aug 5, 2022

codeclimate bot Aug 5, 2022

codeclimate bot Aug 5, 2022

codeclimate bot commented Aug 5, 2022

github-actions bot commented Aug 5, 2022

codecov bot commented Aug 5, 2022 •

edited

TildaDares Aug 7, 2022

jywarren Aug 8, 2022

KarishmaVanwari Aug 8, 2022

This comment was marked as outdated.

This comment was marked as outdated.

jywarren Aug 15, 2022

jywarren Aug 15, 2022 •

edited

jywarren Aug 15, 2022

KarishmaVanwari Sep 2, 2022

jywarren Sep 2, 2022

This comment was marked as off-topic.

This comment was marked as off-topic.

KarishmaVanwari commented Sep 2, 2022

jywarren commented Sep 2, 2022

jywarren commented Sep 5, 2022

jywarren Sep 5, 2022

jywarren Sep 6, 2022 •

edited

github-actions bot commented Sep 5, 2022

jywarren commented Sep 6, 2022

jywarren Sep 6, 2022

jywarren Sep 6, 2022

github-actions bot commented Sep 6, 2022

stale bot commented Sep 16, 2023

	def dashboard_v2
	@title = I18n.t('dashboard._header.dashboard')
	# The new dashboard displays the blog and topics list
	if current_user
	@blog = Tag.find_nodes_by_type('blog', 'note', 1).limit(1).first
	# Tags without the blog tag and everything tag to avoid double display
	exclude_tids = Tag.where(name: %w(blog everything)).pluck(:tid)
	@pagy, @tag_subscriptions = pagy(
	TagSelection
	.select('tag_selections.tid, term_data.name')
	.where(user_id: current_user.id, following: true)
	.where.not(tid: exclude_tids)
	.joins("INNER JOIN term_data ON tag_selections.tid = term_data.tid")
	.order("term_data.activity_timestamp DESC")
	)
	@trending_tags = trending
	render template: 'dashboard_v2/dashboard'
	else
	redirect_to '/research'
	end
	end

@@ @@ -55,7 +55,20 @@ @@
                   </div>
                 </div>
               </div>
+              <div>

-      tag1, tag2 = @node.normal_tags(:followers).includes(:tag).pluck(:name).first(2)
+      puts ">>>>>>>>>>>>>>>>>>>>>>>>>>>"
+      puts @node.inspect
+      puts ">>>>>>>>>>>>>>>>>>>>>>>>>>>"
+      tag1, tag2 = @node.normal_tags(:followers).includes(:tag).pluck(:name).first(2)

	<% if !@recommendations.nil? %>
	<% @recommendations \|\|= Tag.get_recommendations("water-quality", "air-quality") %>

Fixes #11331: Created random generator to fetch nodes randomly as cards #11332

Fixes #11331: Created random generator to fetch nodes randomly as cards #11332

Conversation

KarishmaVanwari commented Aug 5, 2022

gitpod-io bot commented Aug 5, 2022

codeclimate bot Aug 5, 2022

Choose a reason for hiding this comment

codeclimate bot Aug 5, 2022

Choose a reason for hiding this comment

codeclimate bot Aug 5, 2022

Choose a reason for hiding this comment

codeclimate bot Aug 5, 2022

Choose a reason for hiding this comment

codeclimate bot commented Aug 5, 2022

github-actions bot commented Aug 5, 2022

codecov bot commented Aug 5, 2022 • edited

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as outdated.

This comment was marked as outdated.

Choose a reason for hiding this comment

jywarren Aug 15, 2022 • edited

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

This comment was marked as off-topic.

This comment was marked as off-topic.

KarishmaVanwari commented Sep 2, 2022

jywarren commented Sep 2, 2022

jywarren commented Sep 5, 2022

Choose a reason for hiding this comment

jywarren Sep 6, 2022 • edited

Choose a reason for hiding this comment

github-actions bot commented Sep 5, 2022

jywarren commented Sep 6, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Sep 6, 2022

stale bot commented Sep 16, 2023

codecov bot commented Aug 5, 2022 •

edited

jywarren Aug 15, 2022 •

edited

jywarren Sep 6, 2022 •

edited