phi_attrs 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be64c426b92892524e0263b2026ad0d654dc36f5dca2f75af0237df680638a76
-  data.tar.gz: 314a8480ee93bd132bf0e9dbf0cd9dd5a6a8a7fa28f318d758645a074e07cf0e
+  metadata.gz: bb209a550589eee5edbb17853c56c001c9ce8f7292784e1775cebb644468b830
+  data.tar.gz: 0ca474072ecf6b33b2491ac77f097622e4611716d8c95fb03afee896615b8ac8
 SHA512:
-  metadata.gz: cb48b129482db7fab7c73b5b2de63d4f47e61ae551e230fc071de5d53c5079f681daea25d9db3ae2b7b483fee7986454734ef74e2783505a2e45c91b9c219a0e
-  data.tar.gz: 7cfc622520e128ed1ee59045febadd5de155119e88dbb11560c3a52b1a71db85d40511352c9804bc7d542db7275e132cbb44cbe3b5e93ae607515271dc217361
+  metadata.gz: 19021f005a8283d3db4da049c8278dd63b4e0cf5b229ddec2274b414501c9414347e8553d47bfdf5597d06f3da3d4ae2c679fe852d98c8a94e5299f7cb598f1e
+  data.tar.gz: 8fdf599c5db471f842ee25fb91e50d5e54d3c9174978e709ebab5c6d45219a7bc8025f3b7060a51d425bc5fcd1176bcd7ea04df0054b50e8fb48b83c41658170

data/README.md

@@ -438,9 +438,8 @@ Tests are written using [RSpec](http://rspec.info/) and are setup to use [Apprai
     $ bundle exec appraisal rspec spec/path/to/spec.rb
 
 To run just a particular rails version:
-    $  bundle exec appraisal rails-5.1 rspec
-    $  bundle exec appraisal rails-5.2 rspec
-    $  bundle exec appraisal rails-6.0 rspec
+    $  bundle exec appraisal rails_6.1 rspec
+    $  bundle exec appraisal rails-7.0 rspec
 
 ### Console
 
@@ -464,7 +463,7 @@ To release a new version, update the version number in `version.rb`, and then ru
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/apsislabs/phi_attrs.
 
-Any PRs should be accompanied with documentation in `README.md`, and changes documented in [`CHANGELOG.md`](https://keepachangelog.com/).
+Any PRs should be accompanied with documentation in `README.md`.
 
 ## License
 

data/lib/phi_attrs/phi_record.rb

@@ -142,32 +142,32 @@ module PhiAttrs
         # Save this so we don't revoke access previously extended outside the block
         frozen_instances = __instances_with_extended_phi.index_with { |obj| obj.instance_variable_get(:@__phi_relations_extended).clone }
 
-        if allow_only.nil?
-          allow_phi!(user_id, reason)
-        else
-          allow_only.each { |t| t.allow_phi!(user_id, reason) }
-        end
+        begin
+          if allow_only.nil?
+            allow_phi!(user_id, reason)
+          else
+            allow_only.each { |t| t.allow_phi!(user_id, reason) }
+          end
 
-        result = yield if block_given?
+          return yield
+        ensure
+          __instances_with_extended_phi.each do |obj|
+            if frozen_instances.include?(obj)
+              old_extensions = frozen_instances[obj]
+              new_extensions = obj.instance_variable_get(:@__phi_relations_extended) - old_extensions
+              obj.send(:revoke_extended_phi!, new_extensions) if new_extensions.any?
+            else
+              obj.send(:revoke_extended_phi!) # Instance is new to the set, so revoke everything
+            end
+          end
 
-        __instances_with_extended_phi.each do |obj|
-          if frozen_instances.include?(obj)
-            old_extensions = frozen_instances[obj]
-            new_extensions = obj.instance_variable_get(:@__phi_relations_extended) - old_extensions
-            obj.send(:revoke_extended_phi!, new_extensions) if new_extensions.any?
+          if allow_only.nil?
+            disallow_last_phi!
           else
-            obj.send(:revoke_extended_phi!) # Instance is new to the set, so revoke everything
+            allow_only.each { |t| t.disallow_last_phi!(preserve_extensions: true) }
+            # We've handled any newly extended allowances ourselves above
           end
         end
-
-        if allow_only.nil?
-          disallow_last_phi!
-        else
-          allow_only.each { |t| t.disallow_last_phi!(preserve_extensions: true) }
-          # We've handled any newly extended allowances ourselves above
-        end
-
-        result
       end
 
       # Explicitly disallow phi access in a specific area of code. This does not
@@ -385,15 +385,15 @@ module PhiAttrs
       raise ArgumentError, 'block required' unless block_given?
 
       extended_instances = @__phi_relations_extended.clone
-      allow_phi!(user_id, reason)
-
-      result = yield if block_given?
-
-      new_extensions = @__phi_relations_extended - extended_instances
-      disallow_last_phi!(preserve_extensions: true)
-      revoke_extended_phi!(new_extensions) if new_extensions.any?
-
-      result
+      begin
+        allow_phi!(user_id, reason)
+
+        return yield
+      ensure
+        new_extensions = @__phi_relations_extended - extended_instances
+        disallow_last_phi!(preserve_extensions: true)
+        revoke_extended_phi!(new_extensions) if new_extensions.any?
+      end
     end
 
     # Revoke all PHI access for a single instance of this class.
@@ -624,6 +624,10 @@ module PhiAttrs
     #   # through access logging.
     #
     def phi_wrap_method(method_name)
+      unless respond_to?(method_name)
+        PhiAttrs::Logger.warn("#{self.class.name} tried to wrap non-existant method (#{method_name})")
+        return
+      end
       return if self.class.__phi_methods_wrapped.include? method_name
 
       wrapped_method = :"__#{method_name}_phi_wrapped"
@@ -659,6 +663,7 @@ module PhiAttrs
     # @private
     #
     def phi_wrap_extension(method_name)
+      raise NameError, "Undefined relationship in `extend_phi_access`: #{method_name}" unless respond_to?(method_name)
       return if self.class.__phi_methods_to_extend.include? method_name
 
       wrapped_method = wrapped_extended_name(method_name)

data/lib/phi_attrs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PhiAttrs
-  VERSION = '0.3.0'
+  VERSION = '0.3.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phi_attrs
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Wyatt Kirby
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-02 00:00:00.000000000 Z
+date: 2024-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -178,37 +178,16 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - wyatt@apsis.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/build.yml"
-- ".github/workflows/publish.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- Appraisals
-- CHANGELOG.md
 - DISCLAIMER.txt
-- Dockerfile
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/helpers/docker
-- bin/rubo_fix
-- bin/run_tests
-- bin/setup
-- bin/ssh_to_container
-- config.ru
-- docker-compose.yml
-- docker/start.sh
-- gemfiles/rails_6.1.gemfile
-- gemfiles/rails_7.0.gemfile
 - lib/phi_attrs.rb
 - lib/phi_attrs/configure.rb
 - lib/phi_attrs/exceptions.rb
@@ -218,7 +197,6 @@ files:
 - lib/phi_attrs/railtie.rb
 - lib/phi_attrs/rspec.rb
 - lib/phi_attrs/version.rb
-- phi_attrs.gemspec
 homepage: http://www.apsis.io
 licenses:
 - MIT
@@ -242,8 +220,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
-signing_key: 
+rubygems_version: 3.3.27
+signing_key:
 specification_version: 4
 summary: PHI Access Restriction & Logging for Rails ActiveRecord
 test_files: []

data/.github/workflows/build.yml

@@ -1,27 +0,0 @@
-name: Spec CI
-
-on: [push, pull_request]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    name: Ruby ${{ matrix.ruby }}
-    strategy:
-      matrix:
-        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
-        ruby: ['2.7.2', '3.0', 3.1]
-    env:
-      RUBY_VERSION: ${{ matrix.ruby }}
-    steps:
-      - uses: actions/checkout@v3
-      - name: Set up Ruby ${{ matrix.ruby }}
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-      - name: Install dependencies
-        run: |
-          bundle exec appraisal install
-      - name: Run rspec
-        run: |
-          bundle exec appraisal "rake dummy:db:create dummy:db:migrate && rspec"

data/.github/workflows/publish.yml

@@ -1,25 +0,0 @@
-name: Publish Gem
-
-on:
-  push:
-    branches:
-      - "main"
-    tags:
-      - v*
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v3
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '3.1'
-          bundler-cache: true
-      - name: Release Gem
-        if: contains(github.ref, 'refs/tags/v')
-        uses: cadwallion/publish-rubygems-action@master
-        env:
-          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
-          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
-          RELEASE_COMMAND: bundle exec rake release

data/.gitignore

@@ -1,23 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-*Gemfile.lock
-.byebug_history
-
-/spec/dummy/tmp/
-/spec/dummy/db/schema.rb
-*.sqlite
-*.sqlite3
-*.log
-.rspec_status
-gemfiles/*.gemfile.lock
-
-# Macs. Ugh.
-.DS_Store

data/.rspec

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

data/.rubocop.yml

@@ -1,94 +0,0 @@
-require: rubocop-rails
-
-Rails:
-  Enabled: true
-
-AllCops:
-  Exclude:
-    - 'bin/**/*'
-    - 'gemfiles/**/*'
-    - 'spec/internal/db/schema.rb'
-  NewCops: enable
-  TargetRubyVersion: 2.7
-
-Layout/IndentationWidth:
-  Enabled: true
-
-Layout/LineLength:
-  Exclude:
-    - 'spec/**/*'
-    - 'lib/phi_attrs/phi_record.rb' # TODO: RUBOCOP Cleanup exclusion
-  Max: 140
-
-Lint/UnreachableCode:
-  Exclude:
-    - 'lib/phi_attrs/phi_record.rb' # TODO: RUBOCOP Cleanup exclusion
-
-Lint/UnusedMethodArgument:
-  Exclude:
-    - 'lib/phi_attrs.rb' # TODO: RUBOCOP Cleanup exclusion
-
-Metrics/AbcSize:
-  Max: 30
-  Exclude:
-    - 'spec/internal/db/**/*'
-    - 'lib/phi_attrs/phi_record.rb' # TODO: RUBOCOP Cleanup exclusion
-
-Metrics/BlockLength:
-  Enabled: false
-
-Metrics/ClassLength:
-  Max: 1500
-
-Metrics/CyclomaticComplexity:
-  Exclude:
-   - 'lib/phi_attrs/phi_record.rb' # TODO: RUBOCOP Cleanup exclusion
-
-Metrics/MethodLength:
-  Exclude:
-    - 'spec/**/*'
-    - 'lib/phi_attrs/phi_record.rb' # TODO: RUBOCOP Cleanup exclusion
-  Max: 20
-
-Metrics/ModuleLength:
-  Exclude:
-    - 'lib/phi_attrs/phi_record.rb' # TODO: RUBOCOP Cleanup exclusion
-
-Metrics/PerceivedComplexity:
-  Exclude:
-    - 'lib/phi_attrs/phi_record.rb' # TODO: RUBOCOP Cleanup exclusion
-
-Naming/PredicateName:
-  Enabled: false
-
-Rails/DynamicFindBy:
-  Exclude:
-    - 'spec/spec_helper.rb' # TODO: RUBOCOP Cleanup exclusion
-
-# Style/BracesAroundHashParameters:
-#   Enabled: false
-
-Style/ClassVars:
-  Enabled: false
-
-Style/CommentedKeyword:
-  Exclude:
-    - 'spec/**/*'
-
-Style/ConditionalAssignment:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Style/EmptyMethod:
-  EnforcedStyle: expanded
-
-Style/SymbolArray:
-  EnforcedStyle: brackets
-
-Style/RedundantReturn:
-  Enabled: false
-
-Style/WordArray:
-  MinSize: 4

data/Appraisals

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-appraise 'rails_6.1' do
-  gem 'rails', '~> 6.1'
-  gem 'rspec', '~> 3.10'
-  gem 'rspec-rails', '~> 5.1'
-  gem 'sqlite3', '~> 1.5'
-end
-
-appraise 'rails_7.0' do
-  gem 'rails', '~> 7.0'
-  gem 'rspec', '~> 3.12'
-  gem 'rspec-rails', '~> 6.0'
-  gem 'sqlite3', '~> 1.5'
-end

data/CHANGELOG.md

@@ -1,17 +0,0 @@
-# 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.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-### Added
-- Added documentation for CHANGELOG to README
-
-## [v0.1.4] - 2018-07-05
-## [v0.1.3] - 2018-07-05
-## [v0.1.2] - 2018-07-05
-## [v0.1.1] - 2018-07-05
-
-## [v0.1.0] - 2018-07-04
-Initial release

data/Dockerfile

@@ -1,21 +0,0 @@
-ARG RUBY_VERSION=3.1.3
-
-FROM ruby:${RUBY_VERSION}-buster
-
-RUN apt-get update -qq && apt-get install -y --no-install-recommends \
-  build-essential \
-  git \
-  bash \
-  sqlite3
-
-ENV APP_HOME /app
-WORKDIR $APP_HOME
-
-COPY . $APP_HOME/
-
-RUN gem update --system
-RUN bundle config set force_ruby_platform true
-
-EXPOSE 3000
-
-CMD ["bash"]

data/Gemfile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in phi_attrs.gemspec
-gemspec

data/Rakefile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubygems'
-require 'bundler/setup'
-require 'bundler/gem_tasks'
-
-require 'rake'
-
-namespace :dummy do
-  require_relative 'spec/dummy/application'
-  Dummy::Application.load_tasks
-end

data/bin/console

@@ -1,20 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'phi_attrs'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-require 'irb/completion'
-
-PhiAttrs.configure do |conf|
-  conf.log_path = File.join('log', 'phi_access_console.log')
-end
-
-IRB.start(__FILE__)

data/bin/helpers/docker

@@ -1,12 +0,0 @@
-#!/usr/bin/env bash
-
-# runOnDocker SERVICE
-runOnDocker() {
-  if [[ $DOCKER_CONTAINER -ne 1 ]]; then
-    echo "On Host. Executing command on container"
-    docker-compose exec -T $1 $0
-    exit $?
-  fi
-}
-
-export -f runOnDocker

data/bin/rubo_fix

@@ -1,6 +0,0 @@
-#!/usr/bin/env bash
-source bin/helpers/docker
-runOnDocker ruby3
-
-echo "== Starting rubocop =="
-bundle exec rubocop --format worst --format simple --format offenses --auto-correct

data/bin/run_tests

@@ -1,19 +0,0 @@
-#!/usr/bin/env bash
-source bin/helpers/docker
-runOnDocker ruby3
-
-echo "== Starting unit tests =="
-bundle exec appraisal rspec
-if [ $? -ne 0 ]; then
-    echo -e "\n== RSpec failed; push aborted! ==\n"
-    exit 1
-fi
-
-echo "== Starting rubocop =="
-bundle exec rubocop --format worst --format simple --format offenses
-if [ $? -ne 0 ]; then
-    echo -e "\n== Rubocop failed; push aborted! ==\n"
-    echo -e "To auto-correct errors run:"
-    echo -e "\tbin/rubo_fix"
-    exit 1
-fi

data/bin/setup

@@ -1,9 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-gem install bundler -v $BUNDLER_VERSION
-
-bundle check || bundle install
-bundle exec appraisal install

data/bin/ssh_to_container

@@ -1,8 +0,0 @@
-#! /bin/bash
-
-CONTAINER=$1
-if [[ -z $CONTAINER ]]; then
-  CONTAINER='ruby3'
-fi
-
-docker-compose run $CONTAINER sh

data/config.ru

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubygems'
-require 'bundler'
-
-Bundler.require :default, :development

data/docker/start.sh

@@ -1,7 +0,0 @@
-#!/usr/bin/env bash
-
-echo "Beginning Setup"
-/app/bin/setup
-
-echo "Environment Ready"
-tail -f /etc/hosts

data/docker-compose.yml

@@ -1,37 +0,0 @@
-version: '3'
-
-services:
-  ruby2:
-    build:
-      context: .
-      args:
-        - RUBY_VERSION=2.7.0
-    volumes:
-      - bundle_cache:/bundle
-      - .:/app
-    environment:
-      - BUNDLER_VERSION=2.2.33
-      - BUNDLE_JOBS=5
-      - BUNDLE_PATH=/bundle
-      - BUNDLE_BIN=/bundle/bin
-      - GEM_HOME=/bundle
-      - DOCKER_CONTAINER=1
-    command:
-      - docker/start.sh
-  ruby3:
-    build: .
-    volumes:
-      - bundle_cache:/bundle
-      - .:/app
-    environment:
-      - BUNDLER_VERSION=2.4.0
-      - BUNDLE_JOBS=5
-      - BUNDLE_PATH=/bundle
-      - BUNDLE_BIN=/bundle/bin
-      - GEM_HOME=/bundle
-      - DOCKER_CONTAINER=1
-    command:
-      - docker/start.sh
-
-volumes:
-  bundle_cache:

data/gemfiles/rails_6.1.gemfile

@@ -1,10 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", "~> 6.1"
-gem "rspec", "~> 3.10"
-gem "rspec-rails", "~> 5.1"
-gem "sqlite3", "~> 1.5"
-
-gemspec path: "../"

data/gemfiles/rails_7.0.gemfile

@@ -1,10 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", "~> 7.0"
-gem "rspec", "~> 3.12"
-gem "rspec-rails", "~> 6.0"
-gem "sqlite3", "~> 1.5"
-
-gemspec path: "../"

data/phi_attrs.gemspec

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'phi_attrs/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'phi_attrs'
-  spec.version       = PhiAttrs::VERSION
-  spec.authors       = ['Wyatt Kirby']
-  spec.email         = ['wyatt@apsis.io']
-
-  spec.summary       = 'PHI Access Restriction & Logging for Rails ActiveRecord'
-  spec.homepage      = 'http://www.apsis.io'
-  spec.license       = 'MIT'
-  spec.post_install_message = '
-    Thank you for installing phi_attrs! By installing this gem,
-    you acknowledge and agree to the disclaimer as provided in the
-    DISCLAIMER.txt file.
-
-    For full details, see: https://github.com/apsislabs/phi_attrs/blob/master/DISCLAIMER.txt
-  '
-
-  spec.required_ruby_version = '>= 2.7.0'
-
-  spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_runtime_dependency 'rails', '>= 6.0.0'
-  spec.add_runtime_dependency 'request_store', '~> 1.4'
-
-  spec.add_development_dependency 'appraisal'
-  spec.add_development_dependency 'bundler', '>= 2.2.33'
-  spec.add_development_dependency 'byebug'
-  spec.add_development_dependency 'factory_bot_rails'
-  spec.add_development_dependency 'faker'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-rails'
-  spec.add_development_dependency 'simplecov', '~> 0.16'
-  spec.add_development_dependency 'tzinfo-data'
-  spec.metadata['rubygems_mfa_required'] = 'false'
-end