pg_rls 0.2.5 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9493a424a024fbd8f24b81e04f0a861a8326ffb7328ee8e4d421a51c05ba1975
-  data.tar.gz: 7aa7430c9a92ab38dc6ad4b80b127f194dbb7754f5bc5f337dbddac4f2950d8e
+  metadata.gz: 278c5a74c59b9b7b98709a4d36bd50d30facc864b140b231e5aa7d5a1bc26cfd
+  data.tar.gz: 30fab69ef11cf047c3c25213463160f66959c0d6f2da97a09e1bbfb6365247aa
 SHA512:
-  metadata.gz: afb00fc54a85c7bcf7a0488574ab7ee8bda60e31c24a985cb38f943ac6fe6c6c93c6a32069de1661f8d507221eec943c66b9f2dc61e124a1d02702813caef2cc
-  data.tar.gz: bb0f1e17f8bd9ffa3ad09cf1fceb6f539a3aa13d4bed84f6131128496c930c0e23beb6092c9833ada8abc9e12edc3dfae06129fb1e0a533814803e1531edfa47
+  metadata.gz: 6df51d2edd3e608a4a9a0bdfd5c42c21cf9462b85e6a3b572f151991990d292b6e6fd625578254923145b836ea4129aacffcc08aeca0ca03eda9537be4dc8caa
+  data.tar.gz: 6f409cafedc4a4208e110cca2c8e13d76175272e4c4d022b1e87d3c1b3991e2dfe875f1fa80b6a1141654afa8fe31cbe6dd3c99faf29b5eccb50970e81207e76

data/.rubocop.yml

@@ -1,29 +1,67 @@
 require:
-- rubocop-rails
-- rubocop-performance
-- rubocop-rspec
-- rubocop-rake
+  - rubocop-performance
+  - rubocop-rake
 
 AllCops:
+  SuggestExtensions: false
+  TargetRubyVersion: 3.0
   NewCops: enable
-Style/Documentation:
-  Enabled: false
-Style/ClassVars:
   Exclude:
-  - 'lib/pg_rls.rb'
-Metrics/MethodLength:
+    - vendor/**/*
+    - bin/**/*
+    - db/**/*
+    - test/dummy/**/*
+    - test/dummy/db/schema.rb
+    - test/lib/generators/pg_rls/tmp/**/*
+    - test/lib/generators/tmp/**/*
+    - lib/pg_rls/active_record/test_databases.rb
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/ClassVars:
+  Enabled: true
   Exclude:
-  - 'lib/pg_rls/schema/**/*'
-  - 'lib/pg_rls/database/prepared.rb'
+    - lib/pg_rls.rb
+
 Metrics/BlockLength:
+  Enabled: true
   Exclude:
-  - 'lib/pg_rls/database/tasks/admin_database.rake'
-Security/MarshalLoad:
+    - test/**/*
+    - pg_rls.gemspec
+
+Style/Documentation:
+  Enabled: true
   Exclude:
-  - 'lib/pg_rls/middleware/set_reset_connection.rb'
+    - test/**/*
+
 Metrics/ModuleLength:
+  Enabled: true
   Exclude:
-  - 'lib/pg_rls.rb'
-Naming/AccessorMethodName:
+    - lib/pg_rls/active_record/connection_adapters/postgre_sql/check_rls_user_privileges.rb
+    - lib/pg_rls/active_record/connection_adapters/postgre_sql/grant_rls_user_privileges.rb
+    - test/**/*
+Metrics/MethodLength:
+  Enabled: true
+  Exclude:
+    - test/pg_rls/active_record/connection_adapters/postgre_sql/shared_example/rls_table_behavior.rb
+    - test/pg_rls/active_record/connection_adapters/postgre_sql/shared_example/rls_tenant_table_behavior.rb
+
+Metrics/AbcSize:
+  Enabled: true
+  Exclude:
+    - test/pg_rls/active_record/connection_adapters/postgre_sql/shared_example/rls_table_behavior.rb
+    - test/pg_rls/active_record/connection_adapters/postgre_sql/shared_example/rls_tenant_table_behavior.rb
+
+Metrics/CyclomaticComplexity:
+  Enabled: true
+  Exclude:
+    - test/pg_rls/active_record/connection_adapters/postgre_sql/shared_example/rls_table_behavior.rb
+
+Metrics/PerceivedComplexity:
+  Enabled: true
   Exclude:
-  - 'lib/pg_rls/tenant.rb'
+    - test/pg_rls/active_record/connection_adapters/postgre_sql/shared_example/rls_table_behavior.rb

data/.ruby-version

@@ -0,0 +1 @@
+3.3.5

data/CHANGELOG.md

@@ -1,5 +1,22 @@
-## [Unreleased]
 
-## [0.1.0] - 2021-10-04
+# [Released]
+
+## [1.0.1] - 2024-10-10
+
+### Major Changes
+
+- **Switched to Rails native sharding**: We no longer use the `admin_execute` methods for handling admin connections. The database connections are now managed through the Rails native sharding system.
+- **New user group `pg_rls`**: All users **must** be assigned to the `pg_rls` group for security and access control purposes. The server will not boot if this is not configured properly.
+- **Database configuration changes**: The `database.yml` must be updated to support Rails sharding.
+- **Server boot pre-checks**: The server will not boot unless the proper configuration is in place, including shard setup and user group assignment.
+- **Performance recommendations**: In production, it is recommended to configure only one user per server, and consider using separate machines for resource-intensive processes.
+
+### Breaking Changes
+
+- `admin_execute` methods have been removed.
+- You **must** assign users to the `pg_rls` group.
+- `database.yml` requires modification for both development and production environments.
+
+### [0.2.1] - 2024-09-29
 
 - Initial release

data/CODE_OF_CONDUCT.md

@@ -2,83 +2,131 @@
 
 ## Our Pledge
 
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
 
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
 
 ## Our Standards
 
-Examples of behavior that contributes to a positive environment for our community include:
+Examples of behavior that contributes to a positive environment for our
+community include:
 
 * Demonstrating empathy and kindness toward other people
 * Being respectful of differing opinions, viewpoints, and experiences
 * Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
 * Trolling, insulting or derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
 * Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Enforcement Responsibilities
 
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
 
-Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
 
 ## Scope
 
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at daniel.laloush@influitive.com. All complaints will be reviewed and investigated promptly and fairly.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
 
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
 
 ## Enforcement Guidelines
 
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
 
 ### 1. Correction
 
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
 
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
 
 ### 2. Warning
 
-**Community Impact**: A violation through a single incident or series of actions.
+**Community Impact**: A violation through a single incident or series of
+actions.
 
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
 
 ### 3. Temporary Ban
 
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
 
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
 
 ### 4. Permanent Ban
 
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
 
-**Consequence**: A permanent ban from any sort of public interaction within the community.
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
 
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
 
 For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/Guardfile

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :minitest, spring: "bin/test" do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)/?([^/]+)_test\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}#{m[2]}_test.rb" }
+  watch(%r{^test/test_helper\.rb$})      { "test" }
+
+  # with Minitest::Spec
+  # watch(%r{^spec/(.*)_spec\.rb$})
+  # watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+
+  # Rails 4
+  # watch(%r{^app/(.+)\.rb$})                               { |m| "test/#{m[1]}_test.rb" }
+  # watch(%r{^app/controllers/application_controller\.rb$}) { 'test/controllers' }
+  # watch(%r{^app/controllers/(.+)_controller\.rb$})        { |m| "test/integration/#{m[1]}_test.rb" }
+  # watch(%r{^app/views/(.+)_mailer/.+})                    { |m| "test/mailers/#{m[1]}_mailer_test.rb" }
+  # watch(%r{^lib/(.+)\.rb$})                               { |m| "test/lib/#{m[1]}_test.rb" }
+  # watch(%r{^test/.+_test\.rb$})
+  # watch(%r{^test/test_helper\.rb$}) { 'test' }
+
+  # Rails < 4
+  # watch(%r{^app/controllers/(.*)\.rb$}) { |m| "test/functional/#{m[1]}_test.rb" }
+  # watch(%r{^app/helpers/(.*)\.rb$})     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r{^app/models/(.*)\.rb$})      { |m| "test/unit/#{m[1]}_test.rb" }
+end