attr_masker 0.1.0 → 0.3.1

data/CHANGELOG.adoc

@@ -0,0 +1,31 @@
+== Not released yet
+
+* Drop support for Rails < 4.2
+* Allow masking attributes which span on more than one column (or field),
+  supersede `column_name` option with `column_names`
+
+== 0.2.1
+
+* Bugfix: preload application to find all models
+* Bugfix: require all dependencies correctly
+
+== 0.2.0
+
+* `AttrMasker::Maskers::Simple` is now a class
+* Added support for Mongoid
+
+== 0.1.1
+
+* Mask records disregarding default scope
+  (https://github.com/riboseinc/attr_masker/pull/41[#41])
+* Major refactoring (extracting `Attribute` and `Model` classes)
+* Code style improvements (nearly all violations fixed)
+
+== 0.1
+
+* First useful version
+* Rails 4 & 5 compatibility
+* Callable objects as maskers
+* Nice progress bar
+* Built-in maskers: `AttrMasker::Maskers::Replacing`
+  and `AttrMasker::Maskers::SIMPLE`

data/Gemfile

@@ -1,3 +1,8 @@
 source "https://rubygems.org"
 
 gemspec
+
+gem "mongoid", require: false
+
+gem "database_cleaner-active_record", "~> 1.8", require: false
+gem "database_cleaner-mongoid", "~> 1.8", require: false

data/README.adoc

@@ -3,17 +3,33 @@
 :pygments-style: native
 :pygments-linenums-mode: inline
 
-image:https://img.shields.io/travis/riboseinc/attr_masker/master.svg["Build Status", link="https://travis-ci.org/riboseinc/attr_masker"]
-
-Mask ActiveRecord data with ease!
+ifdef::env-github[]
+image:https://img.shields.io/gem/v/attr_masker[
+	"Gem Version",
+	link="https://rubygems.org/gems/attr_masker"]
+image:https://img.shields.io/github/workflow/status/riboseinc/attr_masker/Tests[
+	"Build Status",
+	link="https://github.com/riboseinc/attr_masker/actions"]
+image:https://img.shields.io/codeclimate/maintainability/riboseinc/attr_masker[
+	"Code Climate",
+	link="https://codeclimate.com/github/riboseinc/attr_masker"]
+image:https://img.shields.io/codecov/c/github/riboseinc/attr_masker[
+	"Test Coverage",
+	link="https://codecov.io/gh/riboseinc/attr_masker"]
+image:https://img.shields.io/badge/documentation-rdoc-informational[
+	"Documentation on RubyDoc.info",
+	link="https://rubydoc.info/gems/attr_masker"]
+endif::[]
+
+Mask ActiveRecord/Mongoid data with ease!
 
 == Introduction
 
 This gem is intended to mask sensitive data so that production database dumps
-can be used in staging or test environments.  It works with Active Record 4+
-and modern Rubies.
+can be used in staging or test environments.  It works with Rails 4.2+ and
+modern Rubies.  It supports Active Record and Mongoid models.
 
-== Getting started
+== Usage instructions
 
 === Installation
 
@@ -68,33 +84,16 @@ attr_masker :email :unless => ->(record) { ! record.tester_user? }
 attr_masker :first_name, :if => :tester_user?
 ----
 
-=== Using custom maskers
-
-By default, data is maksed with `AttrMasker::Maskers::SIMPLE` masker which
-always returns `"(redacted)"` string.  But anything what responds to `#call`
-can be used instead: a lambda, `Method` instance, and more.  You can specify it
-by setting the `:masker` option.
-
-For instance, you may want to use https://github.com/ffaker/ffaker[ffaker] or
-https://github.com/skalee/well_read_faker[Well Read Faker] to generate random
-replacement values:
-
-[source,ruby]
-----
-require "ffaker"
-
-attr_masker :first_name, :masker => ->(_hash) { FFaker::Name.first_name }
-----
-
-A hash is passed as an argument, which includes some information about the
-record being masked and the attribute value.  It can be used to further
-customize masker's behaviour.
+The ActiveRecord's `::default_scope` method has no effect on masking.  All
+table records are updated, provided that :if and :unless filters allow that.
+For example, if you're using a https://github.com/rubysherpas/paranoia[Paranoia]
+gem to soft-delete your data, records marked as deleted will be masked as well.
 
 === Built-in maskers
 
 Attr Masker comes with several built-in maskers.
 
-`AttrMasker::Maskers::SIMPLE`::
+`AttrMasker::Maskers::Simple`::
 +
 Simply replaces any value with the `"(redacted)"`.  Only useful for columns
 containing textual data.
@@ -106,7 +105,7 @@ Example:
 [source,ruby]
 ----
 attr_masker :first_name
-attr_masker :last_name, :masker => AttrMasker::Maskers::SIMPLE
+attr_masker :last_name, :masker => AttrMasker::Maskers::Simple.new
 ----
 +
 Would set both `first_name` and `last_name` attributes to `"(redacted)"`.
@@ -120,7 +119,7 @@ Can be initialized with options.
 |===============================================================================
 |Name|Default|Description
 |`replacement`|`"*"`|Replacement string, can be empty.
-|`alphanum_only`|`false`|When true, only alphanumeric charaters are replaced.
+|`alphanum_only`|`false`|When true, only alphanumeric characters are replaced.
 |===============================================================================
 +
 Example:
@@ -133,7 +132,59 @@ attr_masker :phone, :masker => rm
 +
 Would mask "123-456-7890" as "XXX-XXX-XXXX".
 
+=== Using custom maskers
+
+Apart from built-in maskers, any object which responds to `#call` can be used,
+e.g. some lambda or `Method` instance.  For instance, you may want to produce
+unique values basing on other attributes, to mask selectively, or to use
+tool like https://github.com/skalee/well_read_faker[Well Read Faker] to
+generate random replacement values:
+
+[source,ruby]
+----
+require "well_read_faker"
+
+attr_masker :email, masker: ->(model:, **) { "user#{model.id}@example.com" }
+attr_masker :phone, masker: ->(value:, **) { "******" + value[-3..-1] }
+attr_masker :bio, masker: ->(**) { WellReadFaker.paragraph }
+----
+
+Masker is called with following keyword arguments:
+
+`value`:: Original value of the field which is about to be masked
+
+`model`:: Model instance
+
+`attribute_name`:: Name of the attribute which is about to be masked
+
+`masking_options`:: Hash of options which were passed in `#attr_masker` call
+
+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
 - spec tests
 - Make the `Rails.env` (in which `db:mask` could be run) configurable

data/Rakefile

@@ -1,32 +1,5 @@
 # (c) 2017 Ribose Inc.
 #
 
-# require 'rake'
-# require 'rake/testtask'
-# require 'rake/rdoctask'
-
 require "bundler/gem_tasks"
 load "tasks/db.rake"
-
-# desc 'Generate documentation for the attr_masker gem.'
-# Rake::RDocTask.new(:rdoc) do |rdoc|
-#   rdoc.rdoc_dir = 'rdoc'
-#   rdoc.title    = 'attr_masker'
-#   rdoc.options << '--line-numbers' << '--inline-source'
-#   rdoc.rdoc_files.include('README*')
-#   rdoc.rdoc_files.include('lib/**/*.rb')
-# end
-#
-# if RUBY_VERSION < '1.9.3'
-#   require 'rcov/rcovtask'
-#
-#   task :rcov do
-#     system "rcov -o coverage/rcov --exclude '^(?!lib)' " + FileList[ 'test/**/*_test.rb' ].join(' ')
-#   end
-#
-#   desc 'Default: run unit tests under rcov.'
-#   task :default => :rcov
-# else
-#   desc 'Default: run unit tests.'
-#   task :default => :test
-# end

data/attr_masker.gemspec

@@ -1,13 +1,13 @@
 # (c) 2017 Ribose Inc.
 #
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "attr_masker/version"
 
 Gem::Specification.new do |gem|
   gem.name              = "attr_masker"
-  gem.version           = AttrMasker::Version.string
+  gem.version           = AttrMasker::VERSION
   gem.authors           = ["Ribose Inc."]
   gem.email             = ["open.source@ribose.com"]
   gem.homepage          = "https://github.com/riboseinc/attr_masker"
@@ -17,18 +17,23 @@ Gem::Specification.new do |gem|
                           "of certain models by modifying the database."
 
   gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_runtime_dependency("rails", ">= 4.0.0", "< 6.0")
+  gem.add_runtime_dependency("rails", ">= 4.0.0", "< 7")
   gem.add_runtime_dependency("ruby-progressbar", "~> 1.8")
 
-  gem.add_development_dependency("bundler", "~> 1.15")
-  gem.add_development_dependency("combustion", "~> 0.7.0")
-  gem.add_development_dependency("database_cleaner", "~> 1.6")
+  gem.add_development_dependency("bundler", ">= 1.15")
+  gem.add_development_dependency("combustion", "~> 1.0")
+  gem.add_development_dependency("database_cleaner", "~> 1.8")
+  gem.add_development_dependency("database_cleaner-active_record", "~> 1.8")
+  gem.add_development_dependency("database_cleaner-mongoid", "~> 1.8")
+  # Older versions aren't needed as we don't support Rails < 4
+  gem.add_development_dependency("mongoid", ">= 5")
   gem.add_development_dependency("pry")
-  gem.add_development_dependency("rspec", ">= 3.0")
-  gem.add_development_dependency("rubocop", "~> 0.49.1")
-  gem.add_development_dependency("sqlite3", "~> 1.3.13")
+  gem.add_development_dependency("rspec", "~> 3.0")
+  gem.add_development_dependency("rubocop", "~> 0.54.0")
+  gem.add_development_dependency("simplecov")
+  gem.add_development_dependency("sqlite3", ">= 1.3.13", "< 2")
+  gem.add_development_dependency("warning", "~> 1.1")
 end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rack/cleanser"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+# rubocop:disable all
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake") if File.exists?(Gem.bin_path("rake", "rake"))

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+# rubocop:disable all
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+# rubocop:disable all
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/bin/setup

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+# rubocop:disable all
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gemfiles/Rails-4.2.gemfile

@@ -1,5 +1,4 @@
-source "https://rubygems.org"
+eval_gemfile "common.gemfile"
 
 gem "activerecord", "~> 4.2.0"
-
-gemspec path: ".."
+gem "sqlite3", "~> 1.3.13"

data/gemfiles/Rails-5.0.gemfile

@@ -1,5 +1,4 @@
-source "https://rubygems.org"
+eval_gemfile "common.gemfile"
 
 gem "activerecord", "~> 5.0.0"
-
-gemspec path: ".."
+gem "sqlite3", "~> 1.3.13"

data/gemfiles/Rails-5.1.gemfile

@@ -1,5 +1,4 @@
-source "https://rubygems.org"
+eval_gemfile "common.gemfile"
 
 gem "activerecord", "~> 5.1.0"
-
-gemspec path: ".."
+gem "sqlite3", "~> 1.3.13"

data/gemfiles/Rails-5.2.gemfile

@@ -0,0 +1,4 @@
+eval_gemfile "common.gemfile"
+
+gem "activerecord", "~> 5.2.0"
+gem "sqlite3", "~> 1.3.13"

data/gemfiles/Rails-6.0.gemfile

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

data/gemfiles/Rails-6.1.gemfile

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

data/gemfiles/Rails-head.gemfile

@@ -1,6 +1,4 @@
-source "https://rubygems.org"
+eval_gemfile "common.gemfile"
 
 gem "activerecord", github: "rails/rails"
 gem "arel", github: "rails/arel"
-
-gemspec path: ".."