well_formed-pundit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cb057708bb13973cbd0c53de24ab3192545ff35dd573eefdb0f858042046828f
+  data.tar.gz: f0fd614c650858f13659b23bae675c6043b91625a759e936259d8327c5b68592
+SHA512:
+  metadata.gz: 629f94d148cf0fdee0c1348d78945f4b9f8f4db6061d5445eb4cafc3d87ee7b0fbddb70b3676f8f431be7d10290b5a77c676ce6005f972413803821e1d0e2909
+  data.tar.gz: 9507603657d833691d19ceee63393cba33482fe825d4921c080b9cc07c1ab9141e6be9546b7ae98ee1859d4ab8edd9bc2bd9c4b8519279d48ce2304754ece2fe

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/README.md

@@ -0,0 +1,73 @@
+# well_formed-pundit
+
+[Pundit](https://github.com/varvet/pundit) authorization integration for [WellFormed](https://github.com/bmorrall/well_formed) form objects.
+
+Adds `policy`, `authorize!`, and `policy_scope` helpers directly to any WellFormed form, using the form's built-in `resource` and `user` references.
+
+## Installation
+
+```bash
+bundle add well_formed-pundit
+```
+
+## Usage
+
+Require the gem in your application:
+
+```ruby
+require "well_formed-pundit"
+```
+
+`WellFormed::Pundit` is automatically included into all WellFormed forms — no `include` required.
+
+### `authorize!`
+
+Raise `Pundit::NotAuthorizedError` if the user is not permitted to perform an action on the resource:
+
+```ruby
+class CreateArticleForm < WellFormed::ResourceForm
+  resource_alias :article
+
+  attribute :title, :string
+  attribute :body,  :string
+
+  validates :title, presence: true
+
+  def perform
+    authorize!(:create?)                  # authorizes resource
+    authorize!(parent_record, :update?)   # authorizes a different record
+    # proceed with save ...
+  end
+end
+```
+
+### `policy`
+
+Access the resolved Pundit policy instance directly. Defaults to the form's `resource`, but accepts an optional record argument:
+
+```ruby
+form.policy           # => ArticlePolicy for resource
+form.policy.create?   # => true / false
+form.policy(other)    # => policy resolved for a different record
+```
+
+### `policy_scope`
+
+Resolve a scoped collection for the current user:
+
+```ruby
+articles = form.policy_scope(Article.all)
+```
+
+## API
+
+| Method | Description |
+|--------|-------------|
+| `policy(record = resource)` | Returns the Pundit policy instance for `record` and `user` |
+| `authorize!(query)` | Raises `Pundit::NotAuthorizedError` unless the user is authorized for `resource` |
+| `authorize!(record, query)` | Raises `Pundit::NotAuthorizedError` unless the user is authorized for `record` |
+| `policy_scope(collection)` | Returns the policy scope resolved for `user` |
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[spec rubocop]

data/lib/well_formed/pundit/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module WellFormed
+  module Pundit
+    VERSION = "0.1.0"
+  end
+end

data/lib/well_formed/pundit.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module WellFormed
+  module Pundit
+    # Returns the Pundit policy instance for the given record (defaults to resource).
+    def policy(record = resource)
+      ::Pundit::PolicyFinder.new(record).policy!.new(user, record)
+    end
+
+    # Returns the scoped collection for the current user.
+    def policy_scope(collection)
+      ::Pundit::PolicyFinder.new(collection).scope!.new(user, collection).resolve
+    end
+
+    # Raises Pundit::NotAuthorizedError if the user is not authorized for the given query.
+    # Optionally pass an explicit record as the first argument; defaults to resource.
+    def authorize!(record_or_query, query = nil)
+      if query.nil?
+        ::Pundit.authorize(user, resource, record_or_query)
+      else
+        ::Pundit.authorize(user, record_or_query, query)
+      end
+    end
+  end
+end

data/lib/well_formed-pundit.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "well_formed"
+require "pundit"
+require_relative "well_formed/pundit/version"
+require_relative "well_formed/pundit"
+
+WellFormed::WithUser.register_extension(WellFormed::Pundit)

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: well_formed-pundit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Morrall
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: well_formed
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: pundit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+email:
+- bemo56@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- README.md
+- Rakefile
+- lib/well_formed-pundit.rb
+- lib/well_formed/pundit.rb
+- lib/well_formed/pundit/version.rb
+homepage: https://github.com/bmorrall/well_formed
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Pundit authorization integration for well_formed
+test_files: []