active_record_mask 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 593e6c6410f460d9132dbc4af812ed92c2f8a214424a6c331155530f9e0ef4d0
+  data.tar.gz: f0731cf80aeb377786fbad0eea4e7f6642825470da78d7e77edbacc7ab4024a6
+SHA512:
+  metadata.gz: 74eb58fd54d849f6190a79be682200931d5b9ba5612d448e368dad89505b1ce34b0da231345b50f540bb405a01578f5f0cc916759ff9ecf1ced3dec93333bea5
+  data.tar.gz: ac4f6ad4e9ad758866507b6ae97e30b61a3a4c06282fbd81869bd38e2d6b1a0e34c8e37dd6871b17684327d785d599004564c84c90cbb9df069de3866792b07e

data/.github/workflows/ruby.yml

@@ -0,0 +1,38 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/Gemfile.lock
+/coverage/
+/doc/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.log
+*.sqlite
+*.lock

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+gem 'rspec-rails', group: :test
+gem 'sqlite3', group: :test
+gem 'activerecord'
+gem 'activesupport'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Sven Tantau
+
+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.

data/README.md

@@ -0,0 +1,104 @@
+# ActiveRecordMask
+
+ActiveRecordMask is a small ruby library that provides an easy way to mask read access to database attributes and associations in ActiveRecord objects. 
+
+It allows you to configure default or empty values with configuration on a per-model basis.
+
+## Simple example
+
+```ruby
+some_object = SomeClass.first
+
+some_object.title == 'Real Title'
+=> false
+
+some_object.title == 'some configured default'
+=> true
+
+# Allow reading of real data.
+some_object.mask_down!
+
+some_object.title == 'Real Title'
+=> true
+
+# Prevent reading of real data.
+some_object.mask_up!
+
+some_object.title == 'Real Title'
+=> false
+
+```
+
+## Features
+
+- Whitelist attributes and associations that should be returned by default.
+- Define custom default values for attributes.
+- Toggle between showing real data or default values.
+- All configurable per model.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_record_mask'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install active_record_mask
+```
+
+## Usage
+
+### Basic configuration
+
+Include the `ActiveRecordMask` module in your ActiveRecord model and use the `configure_active_record_mask` block to set up the configuration.
+
+```ruby
+class SomeClass < ActiveRecord::Base
+  include ActiveRecordMask
+
+  has_many :another_classes
+  
+  # ActiveRecordMask configuration
+  configure_active_record_mask do |config|
+    config.show_real_data_by_default(false)
+    config.allow_attributes([:id])
+    # config.allow_associations([:another_classes])
+    config.revealed_defaults({ title: 'hidden' })
+  end
+end
+```
+
+
+
+### Configuration options
+
+- `show_real_data_by_default`: Set to `true` if you want real data to be shown by default, without calling `mask_down!`. Default: `false`
+
+- `revealed_defaults`: Define custom default values for specific attributes. It accepts a attribute-name value hash. Default: `{}`
+
+- `allow_attributes`: Define a list of attributes that should not be protected. Default: `[:id]`
+
+- `allow_associations`: Define a list of associations that should not be protected. Default: `[]`
+
+## Testing
+```ruby
+bundle exec rspec
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome: [https://github.com/sventantau/active_record_mask](https://github.com/sventantau/active_record_mask)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/active_record_mask.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_record_mask/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_record_mask"
+  spec.version       = ActiveRecordMask::VERSION
+  spec.authors       = ["Sven Tantau"]
+  spec.email         = ["sven@beastiebytes.com"]
+
+  spec.summary       = %q{A gem that provides a configurable mechanism to mask read access to Active Record attributes and associations}
+  spec.description   = %q{ActiveRecordMask is a small ruby library that provides an easy way to mask read access to database attributes and associations in ActiveRecord objects.}
+  spec.homepage      = "https://github.com/sventantau/active_record_mask"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/sventantau/active_record_mask"
+  spec.metadata["bug_tracker_uri"] = "https://github.com/sventantau/active_record_mask/issues"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.add_dependency "activerecord", "~> 7"
+  spec.add_dependency "activesupport", "~> 7"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/active_record_mask/active_record_mask.rb

@@ -0,0 +1,115 @@
+module ActiveRecordMask
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def configure_active_record_mask
+      yield self if block_given?
+      @allowed_attributes ||= [:id]
+      @allowed_associations ||= []
+    end
+
+    def revealed_defaults(value = nil)
+      @revealed_defaults = value if value
+      @revealed_defaults ||= {}
+    end
+
+    def allow_attributes(value = nil)
+      @allowed_attributes = value if value
+    end
+
+    def allow_associations(value = nil)
+      @allowed_associations = value if value
+    end
+
+    def show_real_data_by_default(value = nil)
+      @show_real_data_by_default = value if value
+      @show_real_data_by_default ||= false
+    end
+
+    attr_reader :allowed_attributes, :allowed_associations
+  end
+
+  included do
+    configure_active_record_mask {}
+    after_initialize :initialize_protector
+    prepend InstanceMethods
+  end
+
+  def mask_down!
+    @show_real_data = true
+  end
+
+  def mask_up!
+    @show_real_data = false
+  end
+
+  private
+
+  def initialize_protector
+    @show_real_data = self.class.show_real_data_by_default
+
+    self.class.reflect_on_all_associations.each do |reflection|
+      association = reflection.name
+
+      define_singleton_method(association) do
+        if @show_real_data || self.class.allowed_associations.include?(association.to_sym)
+          super()
+        else
+          reflection.klass.none
+        end
+      end
+
+      if reflection.macro == :has_many || reflection.macro == :has_and_belongs_to_many
+        define_singleton_method("#{association.to_s.singularize}_ids") do
+          if @show_real_data || self.class.allowed_associations.include?(association.to_sym)
+            super()
+          else
+            []
+          end
+        end
+      end
+    end
+  end
+
+  module InstanceMethods
+    def _read_attribute(attr_name, &block)
+      return super(attr_name, &block) if @show_real_data
+
+      if self.class.allowed_attributes.include?(attr_name.to_sym) || self.class.allowed_attributes.empty?
+        return super(attr_name, &block)
+      end
+
+      empty_value_for_attribute(attr_name)
+    end
+
+    def empty_value_for_attribute(attr_name)
+      column = self.class.columns_hash[attr_name.to_s]
+      return nil unless column
+
+      if self.class.revealed_defaults.key?(attr_name.to_sym)
+        return self.class.revealed_defaults[attr_name.to_sym]
+      end
+
+      case column.type
+      when :string, :text
+        if (column.try(:array) rescue false)
+          []
+        else
+          ""
+        end
+      when :integer, :float, :decimal
+        0
+      when :datetime, :timestamp, :time, :date
+        nil
+      when :boolean
+        false
+      when :json, :jsonb, :hstore
+        {}
+      when :array
+        []
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/active_record_mask/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordMask
+  VERSION = '0.1.0'
+end

data/lib/active_record_mask.rb

@@ -0,0 +1 @@
+require 'active_record_mask/active_record_mask'

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: active_record_mask
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sven Tantau
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ActiveRecordMask is a small ruby library that provides an easy way to
+  mask read access to database attributes and associations in ActiveRecord objects.
+email:
+- sven@beastiebytes.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_record_mask.gemspec
+- lib/active_record_mask.rb
+- lib/active_record_mask/active_record_mask.rb
+- lib/active_record_mask/version.rb
+homepage: https://github.com/sventantau/active_record_mask
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sventantau/active_record_mask
+  source_code_uri: https://github.com/sventantau/active_record_mask
+  bug_tracker_uri: https://github.com/sventantau/active_record_mask/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: A gem that provides a configurable mechanism to mask read access to Active
+  Record attributes and associations
+test_files: []