private_person 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8fc5ea2ff01d3b1c9aa4fdf1d08b1e89d4b59fda
-  data.tar.gz: 53cdaee285d896caf9591c4bfed3d4897af94e40
+SHA256:
+  metadata.gz: fb0dc73f8b0f56d09feec4fafa8255e374fe6e430361f85ff34806fc5e908e5b
+  data.tar.gz: 1add348c75fc0a2a270c0647811e3e4e6af64d92c11ed37380fbbff33d9fdeba
 SHA512:
-  metadata.gz: f7fa47f819e68afc2931b7cf9a0f8ac845fe559dee7948b3616e51498957a9f5d7ae42490a263593a850abc656e4e9cbbdfae91c13bb31aef23964d0daaabdf4
-  data.tar.gz: f760e1935c191e8f78fbde750decc436dcd80993b70eb080a2ecd9e3a50a0900308e9e0323b6c12b58c5f57e1a6875b5f03c4e104c4762a2eeeeb7d010c9d461
+  metadata.gz: 4799c45274e7f19bc7ee3184bfb42f9bb57a2c3228ef5d8d17705deceb92123cd383963be9606471ee6b4cf5dbd9aa4a848c06759522a724e034b7385dcb3dca
+  data.tar.gz: 26d4586cbd765cf4018f47ae170d22f22b36212ad1c76cb2721e218821f4ee829a5be02589b104386cd09a9d6d3e3b957d470d5c57f53ed8a3e9d62fbeb115bc

data/.github/workflows/ci.yml

@@ -0,0 +1,57 @@
+name: CI
+on:
+  push:
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+          bundler-cache: true
+      - run: bundle exec rubocop
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['3.4', '4.0']
+    env:
+      RAILS_ENV: test
+      TZ: America/Denver
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Set up test database
+        run: bundle exec rails db:create db:schema:load
+        working-directory: spec/dummy
+      - run: bundle exec rspec
+      - uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: coverage-ruby-${{ matrix.ruby }}
+          path: coverage/
+      # Publishes a self-hosted coverage badge (badges/coverage.json, read by
+      # a shields.io endpoint badge in the README) instead of depending on a
+      # third-party coverage service like Coveralls/Codecov.
+      - name: Update coverage badge
+        if: matrix.ruby == '4.0' && github.ref_name == github.event.repository.default_branch && github.event_name == 'push'
+        run: |
+          pct=$(ruby -rjson -e "r = JSON.parse(File.read('coverage/.last_run.json'))['result']; puts (r['covered_percent'] || r['line']).round(1)")
+          color=$(ruby -e "pct = $pct; puts(pct >= 90 ? 'brightgreen' : pct >= 75 ? 'yellow' : 'red')")
+          mkdir -p badges
+          printf '{"schemaVersion":1,"label":"coverage","message":"%s%%","color":"%s"}\n' "$pct" "$color" > badges/coverage.json
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add badges/coverage.json
+          git diff --staged --quiet || git commit -m "Update coverage badge [skip ci]"
+          git push

data/.gitignore

@@ -0,0 +1,13 @@
+Gemfile.lock
+*.log
+tmp
+*.pid
+*.gem
+.idea
+.bundle
+coverage
+spec/dummy/db/development.sqlite3
+spec/dummy/db/test.sqlite3
+*.sqlite3-journal
+*.sqlite3-shm
+*.sqlite3-wal

data/.rspec

@@ -1 +1 @@
---color
+--color

data/.rubocop.yml

@@ -0,0 +1,28 @@
+inherit_from: .rubocop_todo.yml
+
+plugins:
+  - rubocop-rails
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.2
+  DisplayCopNames: true
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - private_person.gemspec
+    - spec/dummy/db/schema.rb
+    - spec/dummy/db/migrate/*
+    - lib/generators/private_person/install/templates/**/*
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/*
+    - spec/*/*
+
+# PrivatePerson::Permission is a gem-owned model shipped to consumers -
+# it can't assume a host app's own ApplicationRecord exists.
+Rails/ApplicationRecord:
+  Exclude:
+    - lib/**/*

data/.rubocop_todo.yml

@@ -0,0 +1,57 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config --no-offense-counts --no-auto-gen-timestamp`
+# using RuboCop version 1.90.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros, UseSorbetSigs.
+# NamePrefix: is_, has_, have_, does_
+# ForbiddenPrefixes: is_, has_, have_, does_
+# AllowedMethods: is_a?
+# MethodDefinitionMacros: define_method, define_singleton_method
+Naming/PredicatePrefix:
+  Exclude:
+    - 'lib/private_person/extensions/acts_as_permissible.rb'
+    - 'lib/private_person/extensions/acts_as_permitted.rb'
+
+# Configuration parameters: Prefixes, AllowedPatterns.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Exclude:
+    - 'spec/models/user_spec.rb'
+    - 'spec/support/permissions_support.rb'
+    - 'spec/support/permissor_support.rb'
+    - 'spec/support/users_support.rb'
+
+RSpec/LetSetup:
+  Exclude:
+    - 'spec/support/permissions_support.rb'
+    - 'spec/support/permissor_support.rb'
+    - 'spec/support/users_support.rb'
+
+# Configuration parameters: AllowSubject.
+RSpec/MultipleMemoizedHelpers:
+  Max: 18
+
+# Configuration parameters: EnforcedStyle, IgnoreSharedExamples.
+# SupportedStyles: always, named_only
+RSpec/NamedSubject:
+  Exclude:
+    - 'spec/models/permission_spec.rb'
+
+# Configuration parameters: AllowedGroups.
+RSpec/NestedGroups:
+  Max: 5
+
+# Configuration parameters: CustomTransform, IgnoreMethods, IgnoreMetadata, InflectorPath, EnforcedInflector.
+# SupportedInflectors: default, active_support
+RSpec/SpecFilePathFormat:
+  Exclude:
+    - 'spec/models/permission_spec.rb'
+
+# Configuration parameters: AllowedConstants.
+# This gem doesn't use top-level documentation comments anywhere.
+Style/Documentation:
+  Enabled: false

data/.simplecov

@@ -0,0 +1,5 @@
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter '/spec/'
+end

data/CHANGELOG.md

@@ -0,0 +1,57 @@
+# Changelog
+
+## 1.0.0
+
+**Breaking change.** From-the-ground-up modernization: Rails 4 support
+is dropped in favor of Rails >= 7.1, < 9, and the packaging/tooling
+stack is fully replaced. There is no data-model migration needed for
+existing installs - the `permissions` table shape is unchanged (see
+below) - but the Ruby/Rails floor bump and the two association fixes
+below are real behavior changes to check against before upgrading.
+
+### Breaking
+
+- **Ruby >= 3.2, Rails >= 7.1, < 9** required (was Rails >= 4.0, no
+  ceiling, developed against Rails 3/4-era conventions).
+- **`user.permissibles` was broken and is now fixed.** The
+  `acts_as_permissor`-generated `has_many :permissibles, through:
+  :permissions` referenced the wrong association name (should have been
+  `:permissions_as_permissor`) and was missing `source_type` for its
+  polymorphic source - calling it raised outright on Rails 8's stricter
+  association validation. If your code already worked around this
+  (e.g. by never calling `.permissibles`), no change needed; if you
+  relied on it silently failing, it now actually returns the collection.
+- **`wildcard_permit!`'s de-duplication is now fixed.** It previously
+  built its "does this already exist?" check with a malformed `.where`
+  call and had its guard commented out, so calling `wildcard_permit!`
+  twice with the same arguments always created a duplicate `Permission`
+  row. It now correctly creates at most one.
+- **The generator's migration template is rewritten for Rails 8**
+  (`ActiveRecord::Migration[8.0]`, `t.references ..., polymorphic:
+  true`, `def change`) - the old template used a bare
+  `ActiveRecord::Migration` with no version bracket, which doesn't load
+  at all on Rails 5+. Column shape is otherwise unchanged: `permissor`
+  is required, `permissible` stays nullable (that's the wildcard/
+  type-level grant signal), `relationship_type` still defaults to
+  `'none'`.
+- **`Permission.permissible_types`** no longer issues an invalid
+  `GROUP BY` query (worked on SQLite by accident, would have failed on
+  Postgres) and no longer raises when a permissor record has since been
+  deleted (it's skipped instead).
+- **`Permission#by_relationship_type`**'s "match nothing" fallback
+  changed from the `where(0)` hack to `.none`.
+
+### Also changed
+
+- Jeweler/Rakefile-based packaging replaced with a hand-written
+  gemspec (`s.files` via `git ls-files`); `jeweler` is no longer even a
+  runtime dependency of the built gem (it was, by mistake, in 0.5.0).
+- factory_girl -> factory_bot, RSpec `should` syntax -> `expect`/
+  `is_expected`, shoulda-matchers bumped to 6.x.
+- Added rubocop (rubocop-rails, rubocop-rspec) - none was configured
+  before.
+- Travis CI -> GitHub Actions; Coveralls -> a self-hosted coverage
+  badge (same approach as message_train).
+- README rewritten in Markdown; its `is_permitted?` example previously
+  passed a **class** (`Page`) where the real method always expects an
+  **instance** - fixed.

data/CLAUDE.md

@@ -0,0 +1,5 @@
+# private_person
+
+## Client
+
+Fiendish Labs, via GemVein (owns all gems, owned by Fiendish Labs). Fiendish Labs (Calendula and Martusjaav's household company). See `Office/projects/TYPES.md`'s Ownership section for the full taxonomy.

data/Gemfile

@@ -1,10 +1,28 @@
-source 'http://rubygems.org'
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 # Add dependencies required to use your gem here.
-# Example:
-#   gem 'activesupport', '>= 2.3.5'
+gem 'rails', '>= 7.1', '< 9'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'rubocop', '~> 1.6', require: false
+  gem 'rubocop-rails', '~> 2.25', require: false
+  gem 'rubocop-rake', '~> 0.7', require: false
+  gem 'rubocop-rspec', '~> 3.0', require: false
+end
 
-gem 'rails', '>= 4.0'
-gem 'activerecord', '>= 4.0'
-gem 'chalk_dust', group: :test, git: 'https://github.com/nerakdon/chalk_dust.git'
+group :development, :test do
+  gem 'factory_bot_rails', '~> 6.4'
+  gem 'rspec-its', '>= 1', '< 2'
+  gem 'rspec-rails', '~> 7.0'
+  gem 'sqlite3', '~> 2.1'
+end
 
-gemspec
+group :test do
+  gem 'chalk_dust', git: 'https://github.com/krisleech/chalk_dust.git'
+  gem 'database_cleaner-active_record', '~> 2.1'
+  gem 'shoulda-matchers', '~> 6.0'
+  gem 'simplecov', '~> 0.22', require: false
+end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2014 Gem Vein
+Copyright (c) 2013-2015 Gem Vein
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,93 @@
+# PrivatePerson
+
+[![CI](https://github.com/gemvein/private_person/actions/workflows/ci.yml/badge.svg)](https://github.com/gemvein/private_person/actions/workflows/ci.yml)
+[![Gem Version](https://img.shields.io/gem/v/private_person)](https://rubygems.org/gems/private_person)
+[![Coverage](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/gemvein/private_person/HEAD/badges/coverage.json)](https://github.com/gemvein/private_person/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue)](http://opensource.org/licenses/MIT)
+
+PrivatePerson is an ActiveRecord extension gem that lets a model be given
+privacy settings over arbitrary models and polymorphic relations, putting
+users' accounts in control of their own privacy policies.
+
+## Installation
+
+Add PrivatePerson to your Gemfile:
+
+```ruby
+gem 'private_person'
+```
+
+Then run the install generator, which adds a migration for the
+`permissions` table:
+
+```bash
+rails g private_person:install
+rails db:migrate
+```
+
+## Usage
+
+Set up your models. The "permissor" is whoever is granting/checking
+access (typically a `User`); the "permissible" is whatever's being
+protected:
+
+```ruby
+# app/models/user.rb - using ChalkDust as the subscription model, but any
+# gem or hand-rolled association works, as long as each method below
+# returns the right collection of Users.
+class User < ActiveRecord::Base
+  acts_as_permissor of: [:following_users, :user_followers],
+                     class_name: 'User'
+
+  def follow(user)
+    ChalkDust.subscribe(self, to: user)
+  end
+
+  def following_users
+    ChalkDust.publishers_of(self)
+  end
+
+  def user_followers
+    ChalkDust.subscribers_of(self)
+  end
+end
+
+# app/models/page.rb
+class Page < ActiveRecord::Base
+  acts_as_permissible by: :user
+  belongs_to :user
+end
+```
+
+Then, when you need to know whether someone's permitted to see a
+specific record:
+
+```ruby
+@user.is_permitted? friend_user, @page
+```
+
+Grant or revoke access directly:
+
+```ruby
+@user.permit! 'following_users', @page       # this specific page
+@user.wildcard_permit! 'public', 'Page'      # every Page, by type
+```
+
+## Contributing to PrivatePerson
+
+* Check out the latest main to make sure the feature hasn't been
+  implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone hasn't already
+  requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it, so it doesn't break in a future version
+  unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you
+  want your own version, or it's otherwise necessary, that's fine, but
+  please isolate it to its own commit so it can be cherry-picked around.
+
+## Copyright
+
+Copyright (c) 2013-2026 Gem Vein. See LICENSE.txt for further details.

data/Rakefile

@@ -1,39 +1,21 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'rubygems'
 require 'bundler'
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
+require 'bundler/gem_tasks'
 require 'rake'
 
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "private_person"
-  gem.homepage = "http://www.gemvein.com/museum/cases/private_person"
-  gem.license = "MIT"
-  gem.summary = %Q{Private person puts your users in control of their own privacy policies.}
-  gem.description = %Q{Private person is an active record extension gem that allows a model to be given privacy settings over arbitrary models and polymorphic relations, putting users' accounts in control of their own privacy policies.}
-  gem.email = "karen.e.lundgren@gmail.com"
-  gem.authors = ["Karen Lundgren"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
 require 'rspec/core'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = false
-end
-
-task :default => :spec
+task default: :spec

data/lib/generators/private_person/install/install_generator.rb

@@ -1,31 +1,33 @@
+# frozen_string_literal: true
+
 module PrivatePerson
   class InstallGenerator < Rails::Generators::Base
-    source_root File.expand_path("../templates", __FILE__)
-    require File.expand_path('../../utils', __FILE__)
+    source_root File.expand_path('templates', __dir__)
+    require File.expand_path('../utils', __dir__)
     include Generators::Utils
     include Rails::Generators::Migration
-    
+
     def hello
-      output "With PrivatePerson, you can put your users in control of their own privacy policies.", :magenta
+      output 'With PrivatePerson, you can put your users in control of their own privacy policies.', :magenta
     end
 
     def add_migrations
-      unless ActiveRecord::Base.connection.table_exists? 'permissions'
-        migration_template 'migrate/create_permissions_table.rb', 'db/migrate/create_permissions_table.rb' rescue output $!.message
-      end
+      return if ActiveRecord::Base.connection.table_exists? 'permissions'
+
+      migration_template 'migrate/create_permissions_table.rb',
+                         'db/migrate/create_permissions_table.rb'
+    rescue StandardError => e
+      output e.message
     end
-    
+
+    # Rails::Generators::Migration (included above) declares this
+    # interface method but only raises NotImplementedError - every
+    # generator that ships a migration must supply its own. This mirrors
+    # ActiveRecord::Generators::Migration's own implementation, which
+    # can't be included directly here without also requiring
+    # rails/generators/active_record.rb (not autoloaded by default).
     def self.next_migration_number(dirname)
-      if ActiveRecord::Base.timestamped_migrations
-        unless @prev_migration_nr
-          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
-        else
-          @prev_migration_nr += 1
-        end
-        @prev_migration_nr.to_s
-      else
-        "%.3d" % (current_migration_number(dirname) + 1)
-      end
+      ActiveRecord::Migration.next_migration_number(current_migration_number(dirname) + 1)
     end
   end
-end
+end

data/lib/generators/private_person/install/templates/migrate/create_permissions_table.rb

@@ -1,18 +1,11 @@
-class CreatePermissionsTable < ActiveRecord::Migration
-  def self.up
+class CreatePermissionsTable < ActiveRecord::Migration[8.0]
+  def change
     create_table :permissions do |t|
-      t.string      :permissor_type
-      t.integer     :permissor_id
-      t.string      :permissible_type
-      t.integer     :permissible_id
-      t.string      :relationship_type, :default => 'none'
+      t.references :permissor, polymorphic: true, null: false
+      t.references :permissible, polymorphic: true, null: true
+      t.string :relationship_type, default: 'none', null: false
+
       t.timestamps
     end
-
-    add_index :permissions, [:permissor_type, :permissor_id]
-    add_index :permissions, [:permissible_type, :permissible_id]
-  end
-  def self.down
-    drop_table :permissions
   end
-end
+end

data/lib/generators/private_person/utils.rb

@@ -1,16 +1,11 @@
+# frozen_string_literal: true
+
 module PrivatePerson
   module Generators
     module Utils
       def output(output, color = :green)
         say("           -  #{output}", color)
       end
-
-      def ask_for(wording, default_value = nil, override_if_present_value = nil)
-        override_if_present_value.present? ?
-          display("Using [#{override_if_present_value}] for question '#{wording}'") && override_if_present_value :
-          ask("           ?  #{wording} Press <enter> for [#{default_value}] >", :yellow).presence || default_value
-      end
     end
   end
 end
-

data/lib/private_person/extensions/acts_as_permissible.rb

@@ -1,20 +1,21 @@
+# frozen_string_literal: true
+
 module PrivatePerson
   module ActsAsPermissible
-
     extend ActiveSupport::Concern
 
     module ClassMethods
       def acts_as_permissible(params = {})
-        if params[:by].nil?
-          raise 'Called acts_as_permissible, but without a :by parameter.'
-        end
+        raise 'Called acts_as_permissible, but without a :by parameter.' if params[:by].nil?
+
         class_attribute :by
         self.by = params[:by]
 
-        has_many :permissions, :as => :permissible, :class_name => 'PrivatePerson::Permission'
-        has_many :permissors, :through => :permissions, :as => :permissible
+        has_many :permissions, as: :permissible, class_name: 'PrivatePerson::Permission'
+        has_many :permissors, through: :permissions, source: :permissor,
+                              source_type: by.to_s.camelize
 
-        send :include, InstanceMethods
+        include InstanceMethods
       end
     end
 
@@ -24,4 +25,4 @@ module PrivatePerson
       end
     end
   end
-end
+end

data/lib/private_person/extensions/acts_as_permissor.rb

@@ -1,58 +1,55 @@
+# frozen_string_literal: true
+
 module PrivatePerson
   module ActsAsPermissor
-
     extend ActiveSupport::Concern
 
     module ClassMethods
       def acts_as_permissor(params = {})
-        if params[:of].nil?
-          raise 'Called acts_as_permissor, but without an :of parameter.'
-        end
+        raise 'Called acts_as_permissor, but without an :of parameter.' if params[:of].nil?
+
         class_attribute :of
         self.of = params[:of]
         class_name = params[:class_name] || params[:of].to_s.classify
         class_name.constantize.acts_as_permitted
 
-        has_many :permissions_as_permissor, :as => :permissor, :class_name => 'PrivatePerson::Permission'
-        has_many :permissibles, :through => :permissions, :as => :permissor
-        
-        send :include, InstanceMethods
+        has_many :permissions_as_permissor, as: :permissor, class_name: 'PrivatePerson::Permission'
+        has_many :permissibles, through: :permissions_as_permissor, source: :permissible,
+                                source_type: class_name
+
+        include InstanceMethods
       end
     end
 
     module InstanceMethods
       def permit!(whom, what)
-        existing = self.permissions_as_permissor.by_relationship_type(whom).by_permissible(what)
+        existing = permissions_as_permissor.by_relationship_type(whom).by_permissible(what)
 
-        if existing.empty?
-          self.permissions_as_permissor.create!(permission_params(whom, what))
-        end
-        self.permissions_as_permissor.reload
+        permissions_as_permissor.create!(permission_params(whom, what)) if existing.empty?
+        permissions_as_permissor.reload
       end
 
       def wildcard_permit!(whom, what)
-        existing = self.permissions_as_permissor.by_relationship_type(whom).where(:permissible_type, what)
+        existing = permissions_as_permissor.by_relationship_type(whom).where(permissible_type: what)
 
-        # if existing.empty?
-          self.permissions_as_permissor.create!(wildcard_permission_params(whom, what))
-        # end
-        self.permissions_as_permissor.reload
+        permissions_as_permissor.create!(wildcard_permission_params(whom, what)) if existing.empty?
+        permissions_as_permissor.reload
       end
 
       def permission_params(whom, what)
-        ::ActionController::Parameters.new({
-          :relationship_type => whom, 
-          :permissible_type => what.class.name, 
-          :permissible_id => what.id
-        }).permit!
+        {
+          relationship_type: whom,
+          permissible_type: what.class.name,
+          permissible_id: what.id
+        }
       end
 
       def wildcard_permission_params(whom, what)
-        ::ActionController::Parameters.new({
-          :relationship_type => whom, 
-          :permissible_type => what
-        }).permit!
+        {
+          relationship_type: whom,
+          permissible_type: what
+        }
       end
     end
   end
-end
+end