docbrown/app/models/async_info.rb
Jeremy Friesen c3c884f4d0
Conditional rendering of "Create Post" link (#17076)
* WIP - Conditional rendering of "Create Post" link

This PR builds on the conversation from forem/forem#17056 and moves in a
slightly different direction.

Important in all of this is that the ability to create a post is
enforced on the server.  If the "Create Post" button were to be visible
but the user couldn't create a post when they clicked the button, they
would get an authorization error (or some such response).

This PR posits a different and perhaps competing approach to
forem/forem#16606.  This PR provides a general approach in which we add
class attributes in our HTML erb files.

Note: I have not included Cypress tests as I don't want to yet commit
that time.  I'm also wondering if this is the "right" thing to do.  I
definitely think we want to add some JS tests.  But could we do JS and
unit tests?  (How do we reach consensus regarding our test approach?)

Again, thank you for the conversation and expect an even more "complete"
PR after we have our discussion.

* Extracting AsyncInfo model to ease testing

* Renaming forbidden to visible

* Adding cypress test to assert no 'Create Post'

These are always treacherous.  What happens when we rename the button?
The test will continue to work.

* Apply suggestions from code review

Co-authored-by: Suzanne Aitchison <suzanne@forem.com>

* Switching to pack file for policy

Follows on [Suzanne's comment](https://github.com/forem/forem/pull/17076#issuecomment-1088567286)

* Update app/javascript/packs/applyApplicationPolicyToggles.js

Co-authored-by: Suzanne Aitchison <suzanne@forem.com>

Co-authored-by: Suzanne Aitchison <suzanne@forem.com>
2022-04-05 12:47:12 -04:00

74 lines
2.5 KiB
Ruby

# Responsible for generating the asynchronus data of a user. This is data that we send on the wire
# to the application for much of its user specific client-side rendering.
#
# @see AsyncInfoController#user_data
# @see UserDecorator
# @see ApplicationPolicy
class AsyncInfo
# @api public
#
# Generate a Hash of the relevant user data.
#
# @param user [User, UserDecorator]
# @param context [ApplicationController]
# @return [Hash<Symbol,Object>]
#
# @see ApplicationController#feed_style_preference
#
# @todo The given feed_style_prefernce could be extracted to the user decorator. We would need to
# account for a nil current user in our view logic.
def self.to_hash(user:, context:)
new(user: user, context: context).to_hash
end
def initialize(user:, context:)
@user = user.decorate
@context = context
end
attr_reader :user, :context
def to_hash
{
id: user.id,
name: user.name,
username: user.username,
profile_image_90: user.profile_image_url_for(length: 90),
followed_tags: user.cached_followed_tags.to_json,
followed_podcast_ids: user.cached_following_podcasts_ids,
reading_list_ids: user.cached_reading_list_article_ids,
blocked_user_ids: UserBlock.cached_blocked_ids_for_blocker(user.id),
saw_onboarding: user.saw_onboarding,
checked_code_of_conduct: user.checked_code_of_conduct,
checked_terms_and_conditions: user.checked_terms_and_conditions,
display_sponsors: user.display_sponsors,
display_announcements: user.display_announcements,
trusted: user.trusted?,
moderator_for_tags: user.moderator_for_tags,
config_body_class: user.config_body_class,
feed_style: feed_style_preference,
created_at: user.created_at,
admin: user.any_admin?,
policies: [
{
dom_class: ApplicationPolicy.dom_class_for(record: Article, query: :create?),
visible: visible?(record: Article, query: :create?)
},
],
apple_auth: user.email.to_s.end_with?("@privaterelay.appleid.com")
}
end
private
delegate :feed_style_preference, to: :context
# @return [TrueClass] if policy allows the given query on the given record
# @return [FalseClass] if policy raises Pundit::NotAuthorizedError
# @return [FalseClass] if policy does not allow the given query on the given record
def visible?(record:, query:)
context.__send__(:policy, record).public_send(query)
rescue Pundit::NotAuthorizedError
false
end
end