u-authorization 2.2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3eed3ce0a228018f007c58ae1c1e70ae5b782b841f98ae3baad6519c6fc40531
-  data.tar.gz: 2201d27e01a1f206bf395334b536596dd88fb05760a986c1e29fe4a9253e3f2e
+  metadata.gz: 51c049fdf0f6232070f3f1bb66812b92401d5fea6ff171990d07eea0e7f81693
+  data.tar.gz: 34456d500170bafe3d018687e3bbd3c46b3d373918829150549d2992297b88f8
 SHA512:
-  metadata.gz: 467a55948c8864903d7024c250dd4b9a93244fbb379dc16aa7d91f1f983ba7f5da6d14c6af8e39a52a9639aa30cad129dc84ad2e56bb34b4bfd6245491845809
-  data.tar.gz: 6c28d09268e034911b19b66a192b53057d21c8c0995fc16e3d1754249da968eeb51d71b074782e1867b2885c67437da25c8c3fb235b7826048f957dc35440514
+  metadata.gz: d62f986439e59cff7acedd82d2d0f608e0a28bbd9870f0d95347b987a13b217f2e71df86c7f32d3e47147273296bf50abe54843e93e6ad9cc69e9a535129730d
+  data.tar.gz: d3dfde01673ddf71ff0ec631d35b42275ccfd6f85e74755fa3e6b1ae8303b6ff1ffefe9fb6bf30c51ab11440173529385b57f85dd66d27c85011867aa492f912

data/.github/workflows/ci.yml

@@ -0,0 +1,41 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - main
+      - master
+
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    permissions:
+      contents: read
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.7", "3.0", "3.1", "3.2", "3.3", "3.4", "4.0", head]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install bundler
+        run: gem install bundler -v 2.4.22
+        if: ${{ matrix.ruby == '2.7' || matrix.ruby == '3.0' }}
+      - name: Bundle install
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake test
+      - name: Upload coverage to Qlty
+        uses: qltysh/qlty-action/coverage@v2
+        if: ${{ matrix.ruby == '3.4' && !github.base_ref }}
+        with:
+          token: ${{ secrets.QLTY_COVERAGE_TOKEN }}
+          files: coverage/.resultset.json

data/.gitignore

@@ -1,3 +1,5 @@
+.DS_Store
+
 /.bundle/
 /.yardoc
 /_yardoc/
@@ -6,3 +8,8 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+Gemfile.lock
+
+.tool-versions
+tags

data/CHANGELOG.md

@@ -0,0 +1,74 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [3.0.0] - 2026-06-01
+
+### Added
+
+- This `CHANGELOG.md`, following the [Keep a Changelog 1.1.0](https://keepachangelog.com/en/1.1.0/) format and backfilled to cover every tagged release.
+- GitHub Actions CI that runs the test suite across Ruby 2.7 through the current development build, with coverage uploaded to Qlty.
+- A rewritten, comprehensive `README.md`, an API stability notice, and a `CLAUDE.md` with notes for contributors.
+- `bin/setup` and `bin/console` scripts.
+- `homepage_uri`, `source_code_uri`, and `bug_tracker_uri` entries in the gem metadata.
+
+### Changed
+
+- Raised the minimum Ruby version to `>= 2.7.0` (was `>= 2.2.0`). Ruby 2.2 through 2.6 are end of life.
+- Bumped the `rake` development dependency to `~> 13.0` (was `~> 10.0`).
+
+### Fixed
+
+- Ruby 3.0+ compatibility in `Micro::Authorization::Model#add_policies`. It no longer relies on `Method#to_proc` auto-splatting the `[key, value]` pair, which raised an `ArgumentError` on Ruby 3.0 and later.
+
+### Removed
+
+- Travis CI configuration (`.travis.yml`), replaced by GitHub Actions.
+- `Gemfile.lock` is no longer tracked; it is regenerated per environment.
+
+## [2.3.0] - 2019-08-04
+
+### Changed
+
+- A policy's context must now be a Hash. `current_user` (and its `user` alias) reads `context[:user]` and falls back to `context[:current_user]`; passing a non-Hash context to use directly as the user is no longer supported.
+- Clearer `ArgumentError` message from `Micro::Authorization::Model#add_policies` when it is given something other than a Hash.
+
+### Removed
+
+- The deprecation warning on the permission checker's `required_features`. It is now a plain alias of `#features`.
+
+## [2.2.0] - 2019-07-30
+
+### Added
+
+- Multi-role permissions. `Micro::Authorization::Permissions.new` and `Micro::Authorization::Model.build` accept an array of roles and grant the union of their permissions, so a feature is allowed when any role allows it.
+
+### Deprecated
+
+- The permission checker's `required_features`, in favor of `required_context`. This was reverted in 2.3.0, where `#features` became the method name and `required_features` a plain alias.
+
+## [2.1.0] - 2019-07-29
+
+### Added
+
+- `:to_permit` as the context key for permission checks in `Micro::Authorization::Model.build`, with `:permissions` kept as an alias.
+- README badges and Travis CI configuration.
+
+## [2.0.0] - 2019-07-26
+
+### Added
+
+- First tagged release of the `Micro::Authorization` architecture: the `Micro::Authorization::Model.build` entry point, the data-driven `Permissions` layer (roles as hashes with `any` / `only` / `except` rules and context matching, including dot-notation segments), and the `Micro::Authorization::Policy` base class for record-level checks that denies undefined predicates by default.
+- Each class organized into its own file under `lib/micro/authorization/`, with the test suite running on Minitest.
+
+[Unreleased]: https://github.com/u-gems/u-authorization/compare/v3.0.0...HEAD
+[3.0.0]: https://github.com/u-gems/u-authorization/compare/v2.3.0...v3.0.0
+[2.3.0]: https://github.com/u-gems/u-authorization/compare/v2.2.0...v2.3.0
+[2.2.0]: https://github.com/u-gems/u-authorization/compare/v2.1.0...v2.2.0
+[2.1.0]: https://github.com/u-gems/u-authorization/compare/v2.0.0...v2.1.0
+[2.0.0]: https://github.com/u-gems/u-authorization/releases/tag/v2.0.0

data/CLAUDE.md

@@ -0,0 +1,124 @@
+# CLAUDE.md
+
+Notes for AI assistants working in `u-authorization`.
+
+## Golden rule: feature-complete, keep it running
+
+`u-authorization` is feature-complete. There are no plans to add new features. The only ongoing work is keeping the gem compatible and running on current and future Ruby versions, plus the usual bug fixes, docs, and CI upkeep.
+
+That means two things for any task here:
+
+- **Don't add features or change the public API.** The API is frozen and backward compatible. If a task as stated would require a new feature or a breaking change, stop and surface that, then propose a compatibility-only path.
+- **Major version bumps are for dependency-floor changes only** (dropping an old Ruby from the supported matrix) per SemVer. They do not signal a behavior break. Note that this gem is pure Ruby with no ActiveModel dependency, so the support matrix is Ruby-only.
+
+## How to work in this repo
+
+### 1. Think before coding
+
+**Don't assume. Don't hide confusion. Surface tradeoffs.**
+
+- State assumptions explicitly. If uncertain, ask.
+- If multiple interpretations exist, present them — don't pick silently.
+- If a simpler approach exists, say so. Push back when warranted.
+- If something is unclear, stop. Name what's confusing. Ask.
+
+### 2. Simplicity first
+
+**Minimum code that solves the problem. Nothing speculative.**
+
+- No features beyond what was asked.
+- No abstractions for single-use code.
+- No "flexibility" or "configurability" that wasn't requested.
+- No error handling for impossible scenarios.
+- If you write 200 lines and it could be 50, rewrite it.
+
+Ask yourself: "Would a senior engineer say this is overcomplicated?" If yes,
+simplify.
+
+### 3. Surgical changes
+
+**Touch only what you must. Clean up only your own mess.**
+
+- Don't "improve" adjacent code, comments, or formatting.
+- Don't refactor things that aren't broken.
+- Match existing style, even if you'd do it differently.
+- If you notice unrelated dead code, mention it — don't delete it.
+- Remove imports/variables/functions that _your_ changes orphaned. Don't
+  remove pre-existing dead code unless asked.
+
+The test: every changed line should trace directly to the user's request.
+
+### 4. Goal-driven execution
+
+**Define success criteria. Loop until verified.**
+
+Turn vague tasks into verifiable goals:
+
+- "Add validation" → "Write tests for invalid inputs, then make them pass"
+- "Fix the bug" → "Write a test that reproduces it, then make it pass"
+- "Refactor X" → "Ensure tests pass before and after"
+
+For multi-step work, state a brief plan with a verification check per step.
+
+---
+
+## What this is
+
+`u-authorization` is a small, zero-runtime-dependency Ruby library for
+authorization and role management, living under `lib/micro/authorization/`.
+Its public namespace is `Micro::Authorization`, built from three cohesive
+pieces:
+
+- **`Permissions`** (`permissions.rb` + `permissions/`) — role-based,
+  per-feature permission checks (`to?`, `to_not?`, context matching via
+  `Checker` / `ForEachFeature`).
+- **`Policy`** (`policy.rb`) — per-subject authorization policies, instantiated
+  with a context and the caller's permissions.
+- **`Model`** (`model.rb`) — the entry point that ties permissions, policies,
+  and a context together (`Model.build`, `#to` / `#policy`, `#map`).
+
+`require 'u-authorization'` (or `require 'micro/authorization'`) loads the lot.
+It is a pure-Ruby gem with **no ActiveModel/Rails dependency** — it's designed
+to drop into Rails controllers (`[controller_name, action_name]` style
+contexts) but doesn't require Rails. Because it's a published gem, behavior
+changes — especially anything affecting the public API or the supported `ruby`
+matrix — are highly visible.
+
+## Running tests
+
+```bash
+bundle exec rake test   # full suite (also the default `rake` task)
+```
+
+The suite is plain Minitest with SimpleCov coverage; there are no Appraisals
+or ActiveModel axes (the gem has no Rails dependency). `bin/setup` reinstalls
+the bundle; `bin/console` opens an IRB session with the gem loaded.
+
+To test across Ruby versions locally, use mise — `.tool-versions` lists the
+supported versions. CI (`.github/workflows/ci.yml`) runs the suite across the
+full `ruby` matrix (2.7 → head). Tests are the success criterion for any
+behavior change — write or update a test first, then make it pass (rule 4).
+
+## CHANGELOG and README are part of every change
+
+Both files are user-facing; keep them in sync with the code.
+
+- `CHANGELOG.md` follows [Keep a Changelog 1.1.0](https://keepachangelog.com/en/1.1.0/). Record every user-visible change (behavior change, bug fix, dependency-floor bump, security fix) under the appropriate section of `[Unreleased]`. Pure internal-refactor or CI-only changes generally don't need an entry.
+- `README.md` badges and the **Required Ruby version** section near the top reference the supported Ruby bounds; update them when those bounds move. If you change a documented API, update the relevant **Usage** section in the same commit.
+
+## Bumping the version
+
+1. Edit `lib/micro/authorization/version.rb` — change
+   `Micro::Authorization::VERSION`. Follow [SemVer](https://semver.org/):
+   patch for fixes, minor for additive user-visible changes, major for
+   breaking changes. For this gem a major bump means an old Ruby was dropped
+   from the supported matrix, not a behavior break.
+2. Add a new top entry in `CHANGELOG.md` (`## [X.Y.Z] - YYYY-MM-DD`), move the
+   relevant `[Unreleased]` notes under it, and add a matching compare link at
+   the bottom (`[X.Y.Z]: …/compare/vPREV...vX.Y.Z`).
+3. If the supported Ruby matrix moved, update the Ruby badge and the
+   **Required Ruby version** section in `README.md`, and double-check the
+   `required_ruby_version` in `u-authorization.gemspec` and the CI matrix in
+   `.github/workflows/ci.yml` agree.
+
+Don't tag, push, or `gem release` — humans do that.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at rodrigo@ysimplicity.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,10 +1,15 @@
 source 'https://rubygems.org'
 
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in u-authorization.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
 group :test do
   gem 'minitest', '~> 5.11', '>= 5.11.3'
   gem 'minitest-reporters', '~> 1.3', '>= 1.3.6'
-  gem 'simplecov', require: false
+  gem 'ostruct', '~> 0.6.3' if RUBY_VERSION >= '3.5'
+  gem 'simplecov', '~> 0.22.0', require: false
 end
-
-# Specify your gem's dependencies in u-authorization.gemspec
-gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Rodrigo Serradura
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.