Giter Club home page Giter Club logo

Comments (7)

palkan avatar palkan commented on August 27, 2024 3

I've added a basic implementation to my project: https://gist.github.com/palkan/eb6fab36c5f60e899cccacd3d5649a93

Works good; no complex lookup strategies yet.

from action_policy.

brendon avatar brendon commented on August 27, 2024 1

Thanks @palkan :) If I get some spare time I'll have a go at this :)

from action_policy.

brendon avatar brendon commented on August 27, 2024

Hi @palkan, would you like help with this implementation? Currently I'm hacking it like:

rescue_from ActionPolicy::Unauthorized do |exception|
    key = exception.result.reasons.details.flatten.join('.')
    render :inline => t("action_policy.#{key}"),
           :status => 403,
           :layout => 'error'
  end

What are your ideas around how you'd implement this in the gem? :)

from action_policy.

brendon avatar brendon commented on August 27, 2024

An extra consideration around namespaces could be that we first try the namespaced policy in the key, then (if missing) start stripping namespaces off and retrying until there are none so that one doesn't have to repeat data in the translation file.

from action_policy.

palkan avatar palkan commented on August 27, 2024

Hi @brendon!

What are your ideas around how you'd implement this in the gem? :)

The idea is the following.

First, add a general helper method, say, ActionPolicy::I18n.full_message(policy_class, rule):

def full_message(policy_class, rule)
  # generate candidates
  candidates = [:"policy.#{policy_class.identifier}.#{rule}"]

  # then we have to populate candidates taking into account superclasses
  # and probably namespaces

  candidates << ...
  
  # then add global fallbacks
  candidates << :"policy.#{rule}" # e.g. "action_policy.policy.index?"
  candidates << :default_message

  I18n.t(
    candidates.shift,
    default: candidates,
    scope: [:action_policy]
  )
end

ActiveModel::Errors works the similar way.

Having this we can easily extend Unauthorized class and FailureReasons:

ActionPolicy::Unauthorized.include(Module.new do
  def message
    ActionPolicy::I18n.full_message(policy, rule)
  end
end)

ActionPolicy::Policy::FailureReasons.include(Module.new do
  def full_messages
    reasons.flat_map do |policy_klass, rules|
      rules.map { |rule| ActionPolicy::I18n.full_message(policy_klass, rules) }
    end
  end
end)

The trickiest part here is generating lookup candidates. We should take into account parent policy classes. For example:

# having such policies
class UserPolicy < ActionPolicy::Base
  def index?; end
end

class GuestPolicy < UserPolicy; end

class Admin::UserPolicy < UserPolicy; end

class Admin::GuestPolicy < Admin::UserPolicy; end

# the lookup candidates should be

# for UserPolicy
["user.index?"]

# for GuestPolicy
["guest.index?", "user.index?"]

# for Admin::UserPolicy
["admin/user.index?", "user.index?"]

# for Admin::GuestPolicy
["admin/guest.index?", "admin/user.index?", "guest.index?", "user.index?"]

from action_policy.

palkan avatar palkan commented on August 27, 2024

Note to myself:

Add to docs the following instructions on how to configure Rails to store locale files in config/locale/policies/<policy>.yml:

# in config/application.rb
config.i18n.load_path += Dir[
  Rails.root.join('config', 'locales', '**', '*.{yml,rb}').to_s
]

from action_policy.

brendon avatar brendon commented on August 27, 2024

Well done :)

from action_policy.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.