Fixes #11379: Made the subtopics method #11380

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

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

gitpod-io · 2022-09-02T01:44:28Z

codecov · 2022-09-02T01:55:53Z

Codecov Report

Merging #11380 (e220ca5) into main (e184230) will increase coverage by 2.66%.
The diff coverage is 100.00%.

❗ Current head e220ca5 differs from pull request most recent head 11cdb1c. Consider uploading reports for the commit 11cdb1c to get more accurate results

@@            Coverage Diff             @@
##             main   #11380      +/-   ##
==========================================
+ Coverage   79.75%   82.42%   +2.66%     
==========================================
  Files          96       96              
  Lines        5968     5952      -16     
==========================================
+ Hits         4760     4906     +146     
+ Misses       1208     1046     -162

Impacted Files	Coverage Δ
app/controllers/tag_controller.rb	`85.79% <100.00%> (+7.95%)`	⬆️
app/models/node.rb	`91.18% <0.00%> (+0.16%)`	⬆️
app/models/comment.rb	`77.70% <0.00%> (+0.32%)`	⬆️
app/models/user.rb	`86.49% <0.00%> (+0.72%)`	⬆️
app/controllers/spam2_controller.rb	`71.84% <0.00%> (+0.97%)`	⬆️
app/controllers/users_controller.rb	`80.78% <0.00%> (+1.06%)`	⬆️
app/api/srch/search.rb	`66.66% <0.00%> (+1.28%)`	⬆️
app/controllers/user_tags_controller.rb	`83.78% <0.00%> (+1.35%)`	⬆️
app/controllers/admin_controller.rb	`80.24% <0.00%> (+1.64%)`	⬆️
app/helpers/application_helper.rb	`88.65% <0.00%> (+2.06%)`	⬆️
... and 15 more

config/routes.rb

app/controllers/tag_controller.rb

jywarren · 2022-09-02T13:03:46Z

Hi @KarishmaVanwari ok, so, this actually relates to this PR, on topic trees: #11230 (comment)

I'm so sorry i mixed these up. But I've made some suggestions and explanations to refine this PR a bit, and you have to expand the "Show resolved" sections above to read them -- please do! Let me know if they make sense?

jywarren · 2022-09-02T13:19:59Z

app/controllers/tag_controller.rb

+nodes = Tag.find_by(name: "parent:#{params[:topic]}") # here, we look for this special tag marking a node as having a parent
+  .nodes
+  .collect(&:slug) # collect the "slugs" i.e. the unique part of the URL, which should correspond to a tagname
+    render "tags/subtopic", layout: false


OK, so here, i think we also have to actually make the partial template, at: /app/views/tags/_subtopics.html.erb, and for now it can just print out the subtopics. If you'd like, you can look at the HTML you made in #11230 and use that?

@jywarren :
I created the file _subtopics.html.erb with the following code so as to only print the subtopics when pointed at a URL say http://localhost:3000/tags/subtopic/one or http://localhost:3000/tags/subtopic/two:

<% @subtopics.each do |subtopic| %> <h1><%= subtopic %></h1> <% end %>

However, it gives an error -

Is it because the tags "one" or "two" do not have any specified subtopics as such? But it doesn't seem so, since I just tried adding a check to see if @subtopics is nil. Let me know your thoughts on this!

Thanks!

… subtopics

…into subtopics

KarishmaVanwari · 2022-09-03T19:18:26Z

Hi @KarishmaVanwari ok, so, this actually relates to this PR, on topic trees: #11230 (comment)

I'm so sorry i mixed these up. But I've made some suggestions and explanations to refine this PR a bit, and you have to expand the "Show resolved" sections above to read them -- please do! Let me know if they make sense?

Hi @jywarren, I've gone through the explanations and understood my shortcomings and the respective explanations. Thank you so much Jeff for the detailed explanation and for bearing with me while I try to figure out stuff, thanks again! ❤️

jywarren · 2022-09-05T13:59:34Z

Hi, Karishma - i'm kind of surprised that your local doesn't show a full development error log, which would highlight the line number of the error. How are you starting your development server? And, even if we don't see it in the browser debug output, we should be able to look in the console logs to find the exact reason it failed. Let's look!

…

On Sat, Sep 3, 2022 at 8:30 PM Karishma Vanwari ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In app/controllers/tag_controller.rb <#11380 (comment)>: > @@ -568,4 +568,10 @@ def fetch_counts end def topic_tree; end + + def subtopics +nodes = Tag.find_by(name: "parent:#{params[:topic]}") # here, we look for this special tag marking a node as having a parent + .nodes + .collect(&:slug) # collect the "slugs" i.e. the unique part of the URL, which should correspond to a tagname + render "tags/subtopic", layout: false @jywarren <https://github.com/jywarren> : I created the file _subtopics.html.erb with the following code so as to only print the subtopics when pointed at a URL say http://localhost:3000/tags/subtopic/one or http://localhost:3000/tags/subtopic/two: <% @subtopics.each do |subtopic| %> <h1><%= subtopic %></h1> <% end %> However, it gives an error - [image: image] <https://user-images.githubusercontent.com/78212650/188291739-bf4052ae-0030-4b76-94e7-536952eabd96.png> Is it because the tags "one" or "two" do not have any specified subtopics as such? Let me know if I am wrong. Thanks! — Reply to this email directly, view it on GitHub <#11380 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAF6J5MVB4FHWWSTF6KSJLV4PUTDANCNFSM6AAAAAAQC3TSWY> . You are receiving this because you were mentioned.Message ID: ***@***.***>

app/controllers/tag_controller.rb

Co-authored-by: Jeffrey Warren <jeff@unterbahn.com>

… subtopics

jywarren · 2022-09-05T17:42:04Z

Aha - the subtopics method is in the private area of the controller. I've made changes and will push them in a moment.

As much as possible please do push up your local changes to the PR so I can see exactly what you're working with when i open it. Thanks!

github-actions · 2022-09-05T17:46:25Z

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/8142492360/artifacts/353102091

codeclimate · 2022-09-05T17:49:16Z

app/controllers/tag_controller.rb

@@ -568,4 +579,5 @@ def fetch_counts
  end

  def topic_tree; end
+


Extra empty line detected at class body end.

codeclimate · 2022-09-05T17:49:16Z

app/controllers/tag_controller.rb

+    render "tag/_subtopics", layout: false
+  end
+
+


Extra blank line detected.

jywarren · 2022-09-05T17:51:13Z

app/controllers/tag_controller.rb

+    # collect the "slugs" i.e. the unique part of the URL, which should correspond to a tagname
+    subtopic_names = Tag.find_by(name: "parent:#{params[:topic]}")
+      &.nodes
+      &.collect(&:slug)


OK, I pushed a couple commits to fix minor issues. See how I moved this up out of the "private" section.

Also I added &. which fails gracefully if the value is nil, instead of erroring - it just doesn't continue trying.

I think it should work now, but I think it's worth writing a functional test for this. That will mean adding a tag to a wiki page with name parent:TAGNAME such that the code actually gets used.

The reason is that for most tags we might test this with, there won't be any subtopics. We need to create some test data to make that situation appear so that we can write a test around it. Make sense? I'm happy to help with the test data, let me know if you'd like some support on that!

And great work getting this far. It's complex!!

@jywarren
I tried opening the page: /tags/subtopic/one, I am able to successfully render the page (blank although), and I can render topic name also on the page by extracting it from the URL. I created a wiki page with tag parent:one but I am still unable to fetch subtopics on the page. I doubt if @subtopics actually carries the subtopics in it.

Also, a mention, on line 531 here, we have

Tag.find_by(name: "parent:#{params[:topic]}")

Here, tag is compared with parent:#{params[:topic]}, right? So I also tried creating a wiki page with tag parent:#one but still can't fetch it on the /tags/subtopic/one page. Conversely, I also tried to change the line 531 to this -

Tag.find_by(name: "parent:{params[:topic]}")

and created a wiki page with tag parent:one, but still I can't obtain desired result.

So, do you think I have this test data (the wiki pages I created), so as to write a test? Also, I am totally new to writing tests, could you please guide me with it? PS: Sharing resources also would do.

Thanks!

Hi @KarishmaVanwari ok so you are doing really well then, if it rendered a blank page. We just need to debug the controller.

A controller test is known as a functional test -- there is documentation here, but it's pretty dense: https://guides.rubyonrails.org/testing.html#functional-tests-for-your-controllers

I might start by looking at other tests:

plots2/test/functional/tag_controller_test.rb

Lines 206 to 214 in 4204a62

test 'tag show' do

get :show, params: { id: tags(:spectrometer).name }

assert :success

assert_not_nil :tags

# assert_equal assigns['tags'].length, 1

assert_select '#wiki-summary', 1

end

And at how we create test data -- by creating entries in https://github.com/publiclab/plots2/blob/main/test/fixtures/

For tags, we'll have to create not only a tag fixture entry in https://github.com/publiclab/plots2/blob/main/test/fixtures/tags.yml

but also a record to link that tag to a node: https://github.com/publiclab/plots2/blob/main/test/fixtures/node_tags.yml

Does that make sense? Let's start with that, can you add that to this PR? Once it's in place, I can help you write a simple test, then narrow the test assertions until we find what was wrong with our assumptions. How does that sound?

And, as far as I can tell, your parent:one tag should work! And here is hopefully a helpful tip - the "line of text with #{something} in the middle" syntax is a way to insert Ruby code into a string. It must use " double quotes, and the inserted Ruby code to be evaluated is surrounded by #{ }. It's a little weird looking but it is smoother than adding a bunch of separate strings together.

@jywarren : I created test data in https://github.com/publiclab/plots2/blob/main/test/fixtures/tags.yml and https://github.com/publiclab/plots2/blob/main/test/fixtures/node_tags.yml. Let me know if I got that right. Thanks!

github-actions · 2022-09-05T17:58:08Z

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/8142614414/artifacts/353110022

…into subtopics

codeclimate · 2022-09-08T15:17:15Z

Code Climate has analyzed commit 11cdb1c and detected 2 issues on this pull request.

Here's the issue category breakdown:

Category	Count
Style	2

View more on Code Climate.

github-actions · 2022-09-08T15:27:33Z

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/8197882740/artifacts/356918804

jywarren · 2022-09-08T21:23:34Z

test/fixtures/node_tags.yml

+subtopic_tag:
+  tid: 38
+  uid: 2
+  nid: 41


This looks good, but it's applied to this page, which is a note, not a wiki:

https://github.com/KarishmaVanwari/plots2/blob/subtopics/test/fixtures/nodes.yml#L497

Will that affect the logic, and possibly cause it not to return things?

Well, it should get the slug for this note, and try to use it as a subtopic tagname, according to this logic:

https://github.com/publiclab/plots2/pull/11380/files#diff-5d60373322d4baf080e5f3957fc30d0e8058337c202f5641e1775402776428b1R533

Aha - yes, so, then it takes the slug from that page, which is "jeff-12-20-2020-ouija-board" - and tries to find a tag with that name. It doesn't find one, so it returns null.

Let's change this to instead point at this node, which is a page, with slug about. Then let's add a new tag with the name about so that there is actually a tag that can be returned.

We could give these more realistic tag names so it makes more sense... but, maybe it's not worth it for now. Let's just get it working first.

Suggested change

nid: 41

nid: 2

So now you'll also have to add a new tags.yml entry, but it doesn't need a node_tags.yml entry, since we only look if the tag exists, not if we used it anywhere. Let's see how that works!

cesswairimu · 2022-09-12T14:17:19Z

app/controllers/tag_controller.rb

+    subtopic_names = Tag.find_by(name: "parent:#{params[:topic]}")
+      &.nodes
+      &.collect(&:slug)
+    @subtopics = Tag.find_by(name: subtopic_names)


I was trying this locally and this line returns nil,,, the subtopic_names variable above returns slugs of the nodes' title downcase & hyphenated -- from the comment seems we are expecting this to be tagname slugs that maybe the issue

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

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#11379: Made the subtopics method

669acd0

KarishmaVanwari mentioned this pull request Sep 2, 2022

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

Closed

5 tasks

KarishmaVanwari requested review from TildaDares, cesswairimu and jywarren September 2, 2022 12:20

jywarren reviewed Sep 2, 2022

View reviewed changes

config/routes.rb Outdated Show resolved Hide resolved

jywarren reviewed Sep 2, 2022

View reviewed changes

app/controllers/tag_controller.rb Outdated Show resolved Hide resolved

jywarren added 2 commits September 2, 2022 09:01

Update tag_controller_test.rb

d195a96

Apply suggestions from code review

31ba768

jywarren mentioned this pull request Sep 2, 2022

Fixes #11229: Built topic-tree UI at /topic-tree #11230

Merged

5 tasks

fixing my syntax errors

9d73d03

jywarren reviewed Sep 2, 2022

View reviewed changes

KarishmaVanwari added 2 commits September 4, 2022 00:28

Merge branch 'main' of https://github.com/KarishmaVanwari/plots2 into…

3ab03cc

… subtopics

Merge branch 'subtopics' of https://github.com/KarishmaVanwari/plots2 …

908f3ee

…into subtopics

jywarren reviewed Sep 5, 2022

View reviewed changes

app/controllers/tag_controller.rb Outdated Show resolved Hide resolved

KarishmaVanwari and others added 2 commits September 5, 2022 23:06

Update app/controllers/tag_controller.rb

e76687d

Co-authored-by: Jeffrey Warren <jeff@unterbahn.com>

Merge branch 'main' of https://github.com/KarishmaVanwari/plots2 into…

c7cc324

… subtopics

small fixes

f4d90c8

resolved

e220ca5

codeclimate bot reviewed Sep 5, 2022

View reviewed changes

jywarren reviewed Sep 5, 2022

View reviewed changes

Merge branch 'subtopics' of https://github.com/KarishmaVanwari/plots2 …

517175f

…into subtopics

Created test data

11cdb1c

jywarren reviewed Sep 8, 2022

View reviewed changes

cesswairimu reviewed Sep 12, 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 #11379: Made the subtopics method #11380

Fixes #11379: Made the subtopics method #11380

KarishmaVanwari commented Sep 2, 2022 •

edited by jywarren

gitpod-io bot commented Sep 2, 2022

codecov bot commented Sep 2, 2022 •

edited

jywarren commented Sep 2, 2022

jywarren Sep 2, 2022

KarishmaVanwari Sep 4, 2022 •

edited

KarishmaVanwari commented Sep 3, 2022

jywarren commented Sep 5, 2022 via email

jywarren commented Sep 5, 2022

github-actions bot commented Sep 5, 2022

codeclimate bot Sep 5, 2022

codeclimate bot Sep 5, 2022

jywarren Sep 5, 2022

jywarren Sep 5, 2022

KarishmaVanwari Sep 6, 2022

KarishmaVanwari Sep 6, 2022

jywarren Sep 6, 2022

jywarren Sep 6, 2022

KarishmaVanwari Sep 8, 2022

github-actions bot commented Sep 5, 2022

codeclimate bot commented Sep 8, 2022

github-actions bot commented Sep 8, 2022

jywarren Sep 8, 2022

jywarren Sep 8, 2022

cesswairimu Sep 12, 2022

stale bot commented Sep 16, 2023

	test 'tag show' do
	get :show, params: { id: tags(:spectrometer).name }

	assert :success
	assert_not_nil :tags

	# assert_equal assigns['tags'].length, 1
	assert_select '#wiki-summary', 1
	end

Fixes #11379: Made the subtopics method #11380

Fixes #11379: Made the subtopics method #11380

Conversation

KarishmaVanwari commented Sep 2, 2022 • edited by jywarren

gitpod-io bot commented Sep 2, 2022

codecov bot commented Sep 2, 2022 • edited

Codecov Report

jywarren commented Sep 2, 2022

Choose a reason for hiding this comment

KarishmaVanwari Sep 4, 2022 • edited

Choose a reason for hiding this comment

KarishmaVanwari commented Sep 3, 2022

jywarren commented Sep 5, 2022 via email

jywarren commented Sep 5, 2022

github-actions bot commented Sep 5, 2022

codeclimate bot Sep 5, 2022

Choose a reason for hiding this comment

codeclimate bot Sep 5, 2022

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

github-actions bot commented Sep 5, 2022

codeclimate bot commented Sep 8, 2022

github-actions bot commented Sep 8, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stale bot commented Sep 16, 2023

KarishmaVanwari commented Sep 2, 2022 •

edited by jywarren

codecov bot commented Sep 2, 2022 •

edited

KarishmaVanwari Sep 4, 2022 •

edited