attr_masker 0.1.0 → 0.3.1

data/spec/spec_helper.rb

@@ -1,10 +1,35 @@
 # (c) 2017 Ribose Inc.
 #
 
+# Warnings gem must be added to Gemfile or otherwise loaded in order to have
+# the following configuration in effect.
+#
+# TODO: Add Warning to gemspec or Gemfile after dropping support for Ruby 2.3.
+begin
+  require "warning"
+
+  # Deduplicate warnings
+  Warning.dedup
+
+  # Ignore all warnings in Gem dependencies
+  Gem.path.each do |path|
+    Warning.ignore(//, path)
+  end
+rescue LoadError
+end
+
+require "simplecov"
+SimpleCov.start
+
+if ENV.key?("CI")
+  require "codecov"
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+end
+
 require "bundler"
 Bundler.require :default, :development
 
-Dir[File.expand_path "../support/**/*.rb", __FILE__].each { |f| require f }
+Dir[File.expand_path "support/**/*.rb", __dir__].sort.each { |f| require f }
 
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure
@@ -17,5 +42,3 @@ RSpec.configure do |config|
     c.syntax = :expect
   end
 end
-
-require "rails/all"

data/spec/support/00_control_constants.rb

@@ -0,0 +1,2 @@
+WITHOUT_ACTIVE_RECORD = ENV.fetch("WITHOUT", "") =~ /\bactiverecord\b/
+WITHOUT_MONGOID = ENV.fetch("WITHOUT", "") =~ /\bmongoid\b/

data/spec/support/10_mongoid_env.rb

@@ -0,0 +1,9 @@
+# Copied from Mongoid's test suite
+# https://github.com/mongodb/mongoid/blob/v6.2.0/spec/spec_helper.rb
+
+# These environment variables can be set if wanting to test against a database
+# that is not on the local machine.
+ENV["MONGOID_SPEC_HOST"] ||= "127.0.0.1"
+ENV["MONGOID_SPEC_PORT"] ||= "27017"
+
+require "mongoid" unless WITHOUT_MONGOID

data/spec/support/20_combustion.rb

@@ -0,0 +1,10 @@
+# (c) 2017 Ribose Inc.
+#
+
+Combustion.path = "spec/dummy"
+
+if WITHOUT_ACTIVE_RECORD
+  Combustion.initialize!
+else
+  Combustion.initialize! :active_record
+end

data/spec/support/db_cleaner.rb

@@ -2,9 +2,20 @@ require "database_cleaner"
 
 RSpec.configure do |config|
   config.before(:suite) do
-    DatabaseCleaner.clean_with(:truncation)
+    unless WITHOUT_ACTIVE_RECORD
+      require "database_cleaner-active_record"
+      DatabaseCleaner[:active_record].strategy = :truncation
+    end
 
-    DatabaseCleaner.strategy = :truncation
+    # Since models are defined dynamically in specs, Database Cleaner is unable
+    # to list them and to determine collection names to be cleaned.
+    # Therefore, they are specified explicitly here.
+    unless WITHOUT_MONGOID
+      require "database_cleaner-mongoid"
+      DatabaseCleaner[:mongoid].strategy = :truncation, { only: "users" }
+    end
+
+    DatabaseCleaner.clean_with(:truncation)
   end
 
   config.around(:each) do |example|

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/support/rake.rb

@@ -3,4 +3,4 @@
 
 require "rake"
 Rails.application.load_tasks
-load File.expand_path("../../../lib/tasks/db.rake", __FILE__)
+load File.expand_path("../../lib/tasks/db.rake", __dir__)

data/spec/unit/attribute_spec.rb

@@ -0,0 +1,210 @@
+# (c) 2017 Ribose Inc.
+#
+
+require "spec_helper"
+
+RSpec.describe AttrMasker::Attribute do
+  describe "::new" do
+    subject { described_class.method :new }
+
+    it "instantiates a new attribute definition" do
+      opts = { arbitrary: :options }
+      retval = subject.call(:some_attr, :some_model, opts)
+      expect(retval.name).to eq(:some_attr)
+      expect(retval.model).to eq(:some_model)
+      expect(retval.options).to eq(opts)
+    end
+  end
+
+  describe "#column_names" do
+    subject { receiver.method :column_names }
+    let(:receiver) { described_class.new :some_attr, :some_model, options }
+    let(:options) { {} }
+
+    it "defaults to array containing attribute name only" do
+      expect(subject.call).to contain_exactly(:some_attr)
+    end
+
+    it "can be overriden with :column_names option" do
+      options[:column_names] = :some_column
+      expect(subject.call).to eq(:some_column)
+    end
+  end
+
+  describe "#should_mask?" do
+    subject { described_class.instance_method :should_mask? }
+
+    let(:model_instance) { double }
+    let(:truthy) { double call: true }
+    let(:falsey) { double call: false }
+
+    example { expect(retval_for_opts({})).to be(true) }
+    example { expect(retval_for_opts(if: truthy)).to be(true) }
+    example { expect(retval_for_opts(if: falsey)).to be(false) }
+    example { expect(retval_for_opts(unless: truthy)).to be(false) }
+    example { expect(retval_for_opts(unless: falsey)).to be(true) }
+    example { expect(retval_for_opts(if: truthy, unless: truthy)).to be(false) }
+    example { expect(retval_for_opts(if: truthy, unless: falsey)).to be(true) }
+    example { expect(retval_for_opts(if: falsey, unless: truthy)).to be(false) }
+    example { expect(retval_for_opts(if: falsey, unless: falsey)).to be(false) }
+
+    def retval_for_opts(opts)
+      receiver = described_class.new(:some_attr, :some_model, opts)
+      callable = subject.bind(receiver)
+      callable.(model_instance)
+    end
+  end
+
+  describe "mask" do
+    subject { described_class.instance_method :mask }
+    let(:receiver) { described_class.new :some_attr, :some_model, options }
+    let(:model_instance) { Struct.new(:some_attr).new("value") }
+    let(:options) { { masker: masker } }
+    let(:masker) { ->(**) { "masked_value" } }
+
+    it "takes the instance.options[:masker] and calls it" do
+      expect(masker).to receive(:call)
+      subject.bind(receiver).call(model_instance)
+    end
+
+    it "passes the unmarshalled attribute value to the masker" do
+      expect(receiver).to receive(:unmarshal_data).
+        with("value").and_return("unmarshalled_value")
+      expect(masker).to receive(:call).
+        with(hash_including(value: "unmarshalled_value"))
+      subject.bind(receiver).call(model_instance)
+    end
+
+    it "passes the model instance to the masker" do
+      expect(masker).to receive(:call).
+        with(hash_including(model: model_instance))
+      subject.bind(receiver).call(model_instance)
+    end
+
+    it "passes the attribute name to the masker" do
+      expect(masker).to receive(:call).
+        with(hash_including(attribute_name: :some_attr))
+      subject.bind(receiver).call(model_instance)
+    end
+
+    it "passes the masking options to the masker" do
+      expect(masker).to receive(:call).
+        with(hash_including(masking_options: options))
+      subject.bind(receiver).call(model_instance)
+    end
+
+    it "marshals the masked value, and assigns it to the attribute" do
+      expect(receiver).to receive(:marshal_data).
+        with("masked_value").and_return("marshalled_masked_value")
+      subject.bind(receiver).call(model_instance)
+      expect(model_instance.some_attr).to eq("marshalled_masked_value")
+    end
+  end
+
+  describe "#masked_attributes_new_values" do
+    subject { receiver.method :masked_attributes_new_values }
+    let(:receiver) { described_class.new :some_attr, :some_model, options }
+    let(:options) { {} }
+    let(:model_instance) { double } # Struct.new(:some_attr, :other_attr) }
+    let(:changes) { { some_attr: [nil, "new"], other_attr: [nil, "other"] } }
+
+    before { allow(model_instance).to receive(:changes).and_return(changes) }
+
+    # rubocop:disable Style/BracesAroundHashParameters
+    # We are comparing hashes here, and we want hash literals
+    it "returns a hash of required database updates which include masked field \
+        change, but ignores other attribute changes" do
+      expect(subject.(model_instance)).to eq({ some_attr: "new" })
+    end
+
+    it "returns an emtpy hash for an unchanged object" do
+      changes.clear
+      expect(subject.(model_instance)).to eq({})
+    end
+
+    it "allows overriding column/field name to be updated with column_name \
+      option" do
+      options[:column_names] = %i[other_attr]
+      expect(subject.(model_instance)).to eq({ other_attr: "other" })
+    end
+
+    it "allows specifying more than one column/field name to be updated \
+      with column_name option" do
+      options[:column_names] = %i[some_attr other_attr]
+      expect(subject.(model_instance)).
+        to eq({ some_attr: "new", other_attr: "other" })
+    end
+    # rubocop:enable Style/BracesAroundHashParameters
+  end
+
+  describe "#evaluate_option" do
+    subject { receiver.method :evaluate_option }
+    let(:receiver) { described_class.new :some_attr, model_instance, options }
+    let(:options) { {} }
+    let(:model_instance) { double }
+    let(:retval) { subject.call(:option_name, model_instance) }
+
+    context "when that option value is a symbol" do
+      let(:options) { { option_name: :meth } }
+
+      before do
+        allow(model_instance).to receive(:meth).with(no_args).and_return(:rv)
+      end
+
+      it "evaluates an object's method pointed by that symbol" do
+        expect(retval).to be(:rv)
+      end
+    end
+
+    context "when that option_nameion value responds to #call" do
+      let(:options) { { option_name: callable } }
+      let(:callable) { double }
+
+      before do
+        allow(callable).to receive(:call).with(model_instance).and_return(:rv)
+      end
+
+      it "calls #call on it passing model instance as the only argument" do
+        expect(retval).to be(:rv)
+      end
+    end
+  end
+
+  describe "#marshal_data" do
+    subject { receiver.method :marshal_data }
+    let(:receiver) { described_class.new :some_attr, model_instance, options }
+    let(:options) { { marshaler: marshaller, dump_method: :dump_m } }
+    let(:marshaller) { double }
+    let(:model_instance) { double }
+
+    it "returns unmodified argument when marshal option is falsey" do
+      options[:marshal] = false
+      expect(subject.call(:data)).to be(:data)
+    end
+
+    it "returns unmodified argument when marshal option is falsey" do
+      options[:marshal] = true
+      expect(marshaller).to receive(:dump_m).with(:data).and_return(:retval)
+      expect(subject.call(:data)).to be(:retval)
+    end
+  end
+
+  describe "#unmarshal_data" do
+    subject { receiver.method :unmarshal_data }
+    let(:receiver) { described_class.new :some_attr, model_instance, options }
+    let(:options) { { marshaler: marshaller, load_method: :load_m } }
+    let(:marshaller) { double }
+    let(:model_instance) { double }
+
+    it "returns unmodified argument when marshal option is falsey" do
+      options[:marshal] = false
+      expect(subject.call(:data)).to be(:data)
+    end
+
+    it "returns unmodified argument when marshal option is falsey" do
+      options[:marshal] = true
+      expect(marshaller).to receive(:load_m).with(:data).and_return(:retval)
+      expect(subject.call(:data)).to be(:retval)
+    end
+  end
+end

data/spec/{maskers → unit/maskers}/simple_spec.rb

@@ -5,8 +5,8 @@
 
 require "spec_helper"
 
-RSpec.describe AttrMasker::Maskers::SIMPLE do
-  subject { described_class }
+RSpec.describe AttrMasker::Maskers::Simple do
+  subject { described_class.new }
 
   example { expect(subject.(value: "Solo")).to eq("(redacted)") }
   example { expect(subject.(value: Math::PI)).to eq("(redacted)") }

data/spec/unit/model_spec.rb

@@ -0,0 +1,12 @@
+# (c) 2017 Ribose Inc.
+#
+
+require "spec_helper"
+
+RSpec.describe AttrMasker::Model do
+  it "extends every class and provides class methods" do
+    c = Class.new
+    expect(c).to respond_to(:attr_masker)
+    expect(c.singleton_class.included_modules).to include(described_class)
+  end
+end

data/spec/unit/rake_task_spec.rb

@@ -0,0 +1,30 @@
+# (c) 2017 Ribose Inc.
+#
+
+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.1.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-08-02 00:00:00.000000000 Z
+date: 2021-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -19,7 +19,7 @@ dependencies:
         version: 4.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 4.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
@@ -48,14 +48,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.15'
 - !ruby/object:Gem::Dependency
@@ -64,28 +64,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner-active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner-mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -104,14 +146,14 @@ dependencies:
   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'
 - !ruby/object:Gem::Dependency
@@ -120,28 +162,62 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: 0.54.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: 0.54.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.13
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.13
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: warning
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 description: It is desired to mask certain attributes of certain models by modifying
   the database.
 email:
@@ -151,49 +227,70 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
+- CHANGELOG.adoc
 - Gemfile
 - LICENSE
 - README.adoc
 - Rakefile
 - attr_masker.gemspec
+- bin/console
+- bin/rake
+- bin/rspec
+- bin/rubocop
+- bin/setup
 - config.ru
-- gemfiles/Rails-4.0.gemfile
-- gemfiles/Rails-4.1.gemfile
 - gemfiles/Rails-4.2.gemfile
 - gemfiles/Rails-5.0.gemfile
 - 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
+- lib/attr_masker/attribute.rb
 - lib/attr_masker/error.rb
 - lib/attr_masker/maskers/replacing.rb
 - lib/attr_masker/maskers/simple.rb
+- lib/attr_masker/model.rb
 - lib/attr_masker/performer.rb
 - lib/attr_masker/railtie.rb
 - 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
 - spec/dummy/db/schema.rb
 - spec/dummy/public/favicon.ico
-- spec/features_spec.rb
-- spec/maskers/replacing_spec.rb
-- spec/maskers/simple_spec.rb
+- spec/features/active_record_spec.rb
+- spec/features/mongoid_spec.rb
+- spec/features/shared_examples.rb
 - spec/spec_helper.rb
-- spec/support/0_combustion.rb
+- spec/support/00_control_constants.rb
+- 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
+- spec/unit/attribute_spec.rb
+- spec/unit/maskers/replacing_spec.rb
+- spec/unit/maskers/simple_spec.rb
+- spec/unit/model_spec.rb
+- spec/unit/rake_task_spec.rb
 homepage: https://github.com/riboseinc/attr_masker
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -208,22 +305,32 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.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
 - spec/dummy/db/schema.rb
 - spec/dummy/public/favicon.ico
-- spec/features_spec.rb
-- spec/maskers/replacing_spec.rb
-- spec/maskers/simple_spec.rb
+- spec/features/active_record_spec.rb
+- spec/features/mongoid_spec.rb
+- spec/features/shared_examples.rb
 - spec/spec_helper.rb
-- spec/support/0_combustion.rb
+- spec/support/00_control_constants.rb
+- 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
+- spec/unit/attribute_spec.rb
+- spec/unit/maskers/replacing_spec.rb
+- spec/unit/maskers/simple_spec.rb
+- spec/unit/model_spec.rb
+- spec/unit/rake_task_spec.rb