attr_masker 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27910333a759a7f91a708ff2c58af8cdab7d828064b847c53e7ae4142f030bfe
-  data.tar.gz: 1818b579b51d2b00cf6ed138792641ddbf1863d04b1e3abfbaac65d47b5666ed
+  metadata.gz: 1ea11966d0da57a262387f54288c40df983b8f81756237ec3eb56e3907f49f4b
+  data.tar.gz: 15d5f3edbf6a072069d5107373e1cd0ccc78f9c554a8c2a5624620e4f6ce8b36
 SHA512:
-  metadata.gz: 1256f5c38378beff3bc682aff8f1f168b82d92b1c00c20c71e8207fe9933ed4befb575aa852954f528f800c9d346fae15ae7303191ff2450782ebad8f07f5d54
-  data.tar.gz: bdc5b2b64246d8c95c0e6d4dd0b860f12c98d46a315c27d4b5175219fcf0468d940295430ee1b14df2e79767e5d0352128f6f128de93924eed100f3e9325adeb
+  metadata.gz: e1c41e5e356c0660b720996f31eb2357a5559d10fe499ffe018462f593ca03c7f9afc853aa922bc70d4b9276c1e7d361273b052234f56287dd82ec7c878e71f3
+  data.tar.gz: 3d007123bf82fb0380aada1bd4d82df8295d5531dbac0a8742ae4650f37b6cc01bd4144e72fa928a3463c7601f6745d50d01d7b86b46c9c2506a185f6768a6a5

data/.github/workflows/tests.yml

@@ -3,6 +3,7 @@ name: Tests
 on:
   - pull_request
   - push
+  - workflow_dispatch
 
 jobs:
   test:
@@ -19,11 +20,13 @@ jobs:
       max-parallel: 10
       matrix:
         ruby:
-          - 2.7
-          - 2.6
-          - 2.5
-          - 2.4
+          - "3.0"
+          - "2.7"
+          - "2.6"
+          - "2.5"
+          - "2.4"
         gemfile:
+          - Rails-6.1
           - Rails-6.0
           - Rails-5.2
           - Rails-5.1
@@ -34,25 +37,37 @@ jobs:
           - activerecord
           - mongoid
 
+        include:
+          # Rails 4.2 requires Bundler 1.x.
+          - gemfile: Rails-4.2
+            bundler_version: "1.17"
+
         exclude:
-          # Rails 4.2 refuses to install on Ruby 2.7 for some reason;
-          # anyway, it's a weird combination of old Rails and new Ruby
+          # Rails 4.2 refuses to install on Ruby 2.7 and newer.
+          - gemfile: Rails-4.2
+            ruby: "3.0"
           - gemfile: Rails-4.2
-            ruby: 2.7
-          # Rails 6.0 requires Ruby 2.5 or above
+            ruby: "2.7"
+          # Rails 5.x won't work with Ruby 3.0 and newer.  See:
+          # - https://github.com/rails/rails/issues/40938#issuecomment-751569171
+          # - https://weblog.rubyonrails.org/2020/5/6/Rails-6-0-3-has-been-released/
+          - gemfile: Rails-5.2
+            ruby: "3.0"
+          - gemfile: Rails-5.1
+            ruby: "3.0"
+          - gemfile: Rails-5.0
+            ruby: "3.0"
+          # Rails 6 requires Ruby 2.5 or above
+          - gemfile: Rails-6.1
+            ruby: "2.4"
           - gemfile: Rails-6.0
-            ruby: 2.4
+            ruby: "2.4"
 
     env:
       # For Bundler control variables, refer to:
       # https://bundler.io/v1.17/bundle_config.html
       BUNDLE_GEMFILE: ${{ format('gemfiles/{0}.gemfile', matrix.gemfile) }}
 
-      # Rails 4.2 requires Bundler 1.x.
-      # BUNDLE_ALLOW_BUNDLER_DEPENDENCY_CONFLICTS overrides that requirement.
-      # See: https://bundler.io/v2.1/man/bundle-config.1.html
-      BUNDLE_ALLOW_BUNDLER_DEPENDENCY_CONFLICTS: 1
-
     steps:
       - uses: actions/checkout@v2
 
@@ -67,12 +82,8 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-
-      - name: Install Bundler
-        run: gem install bundler
-
-      - name: Install gems
-        run: bundle install --jobs 4 --retry 3
+          bundler: ${{ matrix.bundler_version || '2' }}
+          bundler-cache: true
 
       - name: Run tests
         run: bundle exec rspec

data/Gemfile

@@ -4,5 +4,5 @@ gemspec
 
 gem "mongoid", require: false
 
-gem "database_cleaner-active_record", require: false
-gem "database_cleaner-mongoid", require: false
+gem "database_cleaner-active_record", "~> 1.8", require: false
+gem "database_cleaner-mongoid", "~> 1.8", require: false

data/README.adoc

@@ -163,6 +163,26 @@ This list is likely to be extended in future versions, and that will not be
 considered a breaking change, therefore it is strongly recommended to always
 use a splat (`**`) at end of argument list of masker's `#call` method.
 
+=== Configuration file
+
+It is also possible to contain all the maskers configuration in one file.
+Just place it in `config/attr_masker.rb`, and it will be loaded from a Rake
+task after the application is fully loaded.  That means you can re-open classes
+and add masker definitions there, for example:
+
+[source,ruby]
+----
+# config/attr_masker.rb
+
+class User
+  attr_masker :first_name, :last_name
+end
+
+class Email
+  attr_masker :address, ->(model:, **) { "mail#{model.id}@example.com" }
+end
+----
+
 == Roadmap & TODOs
 
 - documentation

data/gemfiles/Rails-6.1.gemfile

@@ -0,0 +1,3 @@
+eval_gemfile "common.gemfile"
+
+gem "activerecord", "~> 6.1.0"

data/lib/attr_masker/error.rb

@@ -1,5 +1,6 @@
 # (c) 2017 Ribose Inc.
 #
+
 module AttrMasker
   class Error < ::StandardError
   end

data/lib/attr_masker/maskers/replacing.rb

@@ -1,5 +1,6 @@
 # (c) 2017 Ribose Inc.
 #
+
 module AttrMasker
   module Maskers
     # +Replacing+ masker replaces every character of string which is being

data/lib/attr_masker/maskers/simple.rb

@@ -1,3 +1,6 @@
+# (c) 2017 Ribose Inc.
+#
+
 module AttrMasker
   module Maskers
     # +Simple+ masker replaces values with a predefined +(redacted)+ string.

data/lib/attr_masker/model.rb

@@ -1,3 +1,6 @@
+# (c) 2017 Ribose Inc.
+#
+
 module AttrMasker
   module Model
     def self.extended(base) # :nodoc:

data/lib/attr_masker/version.rb

@@ -2,5 +2,5 @@
 #
 
 module AttrMasker
-  VERSION = "0.3.0".freeze
+  VERSION = "0.3.1".freeze
 end

data/lib/tasks/db.rake

@@ -15,6 +15,9 @@ namespace :db do
   task :mask => :environment do
     Rails.application.eager_load!
 
+    config_file = Rails.root.join("config", "attr_masker.rb").to_s
+    require config_file if File.file?(config_file)
+
     performers = AttrMasker::Performer::Base.descendants.map(&:new)
     performers.select!(&:dependencies_available?)
 

data/spec/dummy/config/attr_masker.rb

@@ -0,0 +1 @@
+$CONFIG_LOADED_AT = Time.now

data/spec/features/shared_examples.rb

@@ -370,6 +370,10 @@ RSpec.shared_examples "Attr Masker gem feature specs" do
     end
   end
 
+  example "It loads configuration file", :force_config_file_reload do
+    expect { run_rake_task }.to change { $CONFIG_LOADED_AT }
+  end
+
   def run_rake_task
     Rake::Task["db:mask"].execute
   end

data/spec/support/force_config_file_reload.rb

@@ -0,0 +1,9 @@
+RSpec.configure do |config|
+  config.before(:each, :force_config_file_reload) do
+    config_path = Rails.root.join("config", "attr_masker.rb").to_s
+    # $" holds names of source files which have been loaded already.
+    # Removing a path from that list causes given file to be loaded
+    # again at next #require call.
+    $".delete(config_path)
+  end
+end

data/spec/unit/rake_task_spec.rb

@@ -6,9 +6,25 @@ require "spec_helper"
 RSpec.describe "db:mask", :suppress_progressbar do
   subject { Rake::Task["db:mask"] }
 
+  let(:config_file_path) do
+    File.expand_path("../dummy/config/attr_masker.rb", __dir__)
+  end
+
   it "loads all application's models eagerly" do
     expect(Rails.application).to receive(:eager_load!)
     subject.execute
     expect(defined? NonPersistedModel).to be_truthy
   end
+
+  it "loads configuration file if it exists", :force_config_file_reload do
+    allow(File).to receive(:file?).and_call_original
+    allow(File).to receive(:file?).with(config_file_path).and_return(true)
+    expect { subject.execute }.to change { $CONFIG_LOADED_AT }
+  end
+
+  it "works without configuration file", :force_config_file_reload do
+    allow(File).to receive(:file?).and_call_original
+    allow(File).to receive(:file?).with(config_file_path).and_return(false)
+    expect { subject.execute }.not_to change { $CONFIG_LOADED_AT }
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attr_masker
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-30 00:00:00.000000000 Z
+date: 2021-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -249,6 +249,7 @@ files:
 - gemfiles/Rails-5.1.gemfile
 - gemfiles/Rails-5.2.gemfile
 - gemfiles/Rails-6.0.gemfile
+- gemfiles/Rails-6.1.gemfile
 - gemfiles/Rails-head.gemfile
 - gemfiles/common.gemfile
 - lib/attr_masker.rb
@@ -262,6 +263,7 @@ files:
 - lib/attr_masker/version.rb
 - lib/tasks/db.rake
 - spec/dummy/app/models/non_persisted_model.rb
+- spec/dummy/config/attr_masker.rb
 - spec/dummy/config/database.yml
 - spec/dummy/config/mongoid.yml
 - spec/dummy/config/routes.rb
@@ -275,6 +277,7 @@ files:
 - spec/support/10_mongoid_env.rb
 - spec/support/20_combustion.rb
 - spec/support/db_cleaner.rb
+- spec/support/force_config_file_reload.rb
 - spec/support/matchers.rb
 - spec/support/rake.rb
 - spec/support/silence_stdout.rb
@@ -287,7 +290,7 @@ homepage: https://github.com/riboseinc/attr_masker
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -302,12 +305,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Masking attributes
 test_files:
 - spec/dummy/app/models/non_persisted_model.rb
+- spec/dummy/config/attr_masker.rb
 - spec/dummy/config/database.yml
 - spec/dummy/config/mongoid.yml
 - spec/dummy/config/routes.rb
@@ -321,6 +325,7 @@ test_files:
 - spec/support/10_mongoid_env.rb
 - spec/support/20_combustion.rb
 - spec/support/db_cleaner.rb
+- spec/support/force_config_file_reload.rb
 - spec/support/matchers.rb
 - spec/support/rake.rb
 - spec/support/silence_stdout.rb