guarda 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f15e288362775a5372998f48ab4a1dd3341c943cb0f61a1ffef7f8e7c6651dfe
-  data.tar.gz: 13e8ca73c3e09f446fa15d4064ee69feda99f401ab7a63c4e5ca99aee97fb6bc
+  metadata.gz: 8ffe343cd6f4cd51a1b384fdb4e1299d14960e574a60fd2ef7e5d03298563289
+  data.tar.gz: 60096b5bd502a631c19b5df0a028fd2e4d96828645da9409f47a53f19ea74b95
 SHA512:
-  metadata.gz: 1335b5450f75bb16742b8255bce42a7e21b8c704b3b3d53fee5a1da6fb00f4de352b7d568a4d324993755412c4435666d6226c444a0831a5b8c17f66f2457cc9
-  data.tar.gz: edcf1d6ad4b4b58a4e26a9c522af2b54b6c85770af54e59f316bea96517a094de9741af5593caaf2b165e02524ef1135945ec2bade377bdd927915c52f753e69
+  metadata.gz: 6b1b618a33b3b7a27322cad51b872af9aca19d3d309dbeaf3004112e82b808c859bab5e4c688be6d6f0d98e6ef5ec4359f7573e464e105e8a64563b7d12e2170
+  data.tar.gz: 01bea2ae2c82935e7cfead682f1cedcee50ccace4810b14e1f5f4f5cfbb0d3e20f85fe19eaceccfb904693480c77d1e429e405c26ebcbc3f8da18366f79507fc

data/README.md

@@ -1,34 +1,70 @@
 # Guarda
 
-TODO: Delete this and the text below, and describe your gem
+Is another authorization gem that was heavily inspired by [Pundit](https://rubygems.org/gems/pundit).
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/guarda`. To experiment with that code, run `bin/console` for an interactive prompt.
+It assumes you are using [Current Attributes](https://api.rubyonrails.org/classes/ActiveSupport/CurrentAttributes.html) to get your currently authenticated user.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```bash
+bundle add guarda
+```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Include `Guarda::Authorization` in your application controller:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```ruby
+class ApplicationController < ActionController::Base
+  include Guarda::Authorization
+end
+```
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/guarda.
+In the controller:
+
+```ruby
+class PostsController < ApplicationController
+  def index
+    authorize
+  end
+
+  def update
+    authorize @post
+  end
+end
+```
+
+In the view:
+
+```erb
+<% if policy("posts").index? %>
+  <%= link_to "Posts", "#" %>
+<% end %>
+
+<% if policy("posts", @post).update? %>
+  <%= link_to "Edit Post", "#" %>
+<% end %>
+```
+
+With this policy class `app/policies/posts_policy.rb`:
+
+```ruby
+class PostsPolicy
+  def initialize(post = nil)
+    @post = post
+  end
+
+  def index?
+    Current.person.admin?
+  end
+
+  def update?
+    @post.author == Current.person
+  end
+end
+```
 
 ## License
 

data/guarda.gemspec

@@ -9,9 +9,9 @@ Gem::Specification.new do |spec|
   spec.email = ["abdul@hey.com"]
 
   spec.summary = "Another authorization gem"
-  spec.homepage = "https://wwww.guidedrails.com"
+  spec.homepage = "https://www.guidedrails.com"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.required_ruby_version = ">= 3.1.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/Guided-Rails/guarda"
@@ -27,6 +27,6 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "activesupport"
-  spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "activesupport", "~> 7.1", ">= 7.1.3"
+  spec.add_development_dependency "minitest-reporters", "~> 1.6", ">= 1.6.1"
 end

data/lib/guarda/authorization.rb

@@ -10,7 +10,7 @@ module Guarda
       end
     end
 
-    def authorize(controller: nil, query: nil, record: nil)
+    def authorize(record = nil, controller: nil, query: nil)
       @_authorization_performed = true
       controller ||= controller_path
       query ||= "#{action_name}?"
@@ -19,7 +19,7 @@ module Guarda
         raise(NotAuthorizedError, self.class)
     end
 
-    def policy(controller, record)
+    def policy(controller, record = nil)
       PolicyFinder.find(controller).new(record)
     end
 

data/lib/guarda/policy_finder.rb

@@ -23,7 +23,7 @@ module Guarda
     end
 
     def policy_class_name
-      controller_name.camelize.concat("Policy")
+      controller_name.to_s.camelize.concat("Policy")
     end
   end
 end

data/lib/guarda/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Guarda
-  VERSION = "0.1.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,43 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: guarda
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Abdullah Hashim
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-28 00:00:00.000000000 Z
+date: 2024-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 7.1.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 7.1.3
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.1
 description:
 email:
 - abdul@hey.com
@@ -54,11 +66,11 @@ files:
 - lib/guarda/policy_finder.rb
 - lib/guarda/version.rb
 - sig/guarda.rbs
-homepage: https://wwww.guidedrails.com
+homepage: https://www.guidedrails.com
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://wwww.guidedrails.com
+  homepage_uri: https://www.guidedrails.com
   source_code_uri: https://github.com/Guided-Rails/guarda
 post_install_message:
 rdoc_options: []
@@ -68,7 +80,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="