attr_masker 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43cbbd6cf1150e2228d2b5fc1323bbdbae852510
-  data.tar.gz: 614372bc5a85ac8b23112062b437a8d468064160
+  metadata.gz: 84f6dabd5fc0ea9d919da16d60ca4b06c46b2c97
+  data.tar.gz: 72d8b8eeb8eb59a24c7613c752fb8c2175be566f
 SHA512:
-  metadata.gz: cb815eda36c7a99d2cfebf18df5a1b901a5e597df340b6f2041bd9bdb6ee722b4fac5b21dde71457ad63794de5cc3e1aec2659c02d32c2aea6e0bce7dfff2b8c
-  data.tar.gz: 6e97866032f1d8c1323e11bb160f62d9798f001b2736b98be03907f9269f39ff462be45633ac3c59c04856621196fc8979556c1438cac3b6be5eff68f1f6c238
+  metadata.gz: 0274cb6920ce73043fff153a27c8140cfb3fa9ec095a020c1fe5f4180e1339d0ad75bb41cccf5a68573d351b3fb4b98ced45829ff836729e2c7966a8b9b3316e
+  data.tar.gz: 3e13de85e38714f92b9a10cbdcae9178ea6bf81ebca353b63e764ed33d797e759cb489803ee22f006883548b9d2ca1daad2ee2ceb17658da16d92f9097651015

data/.travis.yml

@@ -3,6 +3,9 @@ dist: trusty
 language: ruby
 before_install: gem install bundler -v 1.15.1
 
+services:
+  - mongodb
+
 script:
   - bundle exec rspec
 
@@ -26,6 +29,14 @@ matrix:
       gemfile: "gemfiles/Rails-4.1.gemfile"
     - rvm: "2.2"
       gemfile: "gemfiles/Rails-4.0.gemfile"
+    - rvm: "2.4"
+      gemfile: "gemfiles/Rails-5.1.gemfile"
+      env:
+        - WITHOUT_ACTIVE_RECORD: "1"
+    - rvm: "2.4"
+      gemfile: "gemfiles/Rails-5.1.gemfile"
+      env:
+        - WITHOUT_MONGOID: "1"
 
   allow_failures:
     - rvm: "ruby-head"

data/CHANGELOG.adoc

@@ -1,3 +1,10 @@
+== Not released yet
+
+== 0.2.0
+
+* `AttrMasker::Maskers::Simple` is now a class
+* Added support for Mongoid
+
 == 0.1.1
 
 * Mask records disregarding default scope

data/README.adoc

@@ -6,13 +6,13 @@
 image:https://img.shields.io/gem/v/attr_masker.svg["Gem Version", link="https://rubygems.org/gems/attr_masker"]
 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!
+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+ and modern
+Rubies.  It supports Active Record and Mongoid models.
 
 == Getting started
 
@@ -76,7 +76,7 @@ gem to soft-delete your data, records marked as deleted will be masked as well.
 
 === Using custom maskers
 
-By default, data is maksed with `AttrMasker::Maskers::SIMPLE` masker which
+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.
@@ -100,7 +100,7 @@ customize masker's behaviour.
 
 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.
@@ -112,7 +112,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)"`.

data/attr_masker.gemspec

@@ -27,6 +27,8 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency("bundler", "~> 1.15")
   gem.add_development_dependency("combustion", "~> 0.7.0")
   gem.add_development_dependency("database_cleaner", "~> 1.6")
+  # 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")

data/gemfiles/Rails-4.0.gemfile

@@ -1,5 +1,3 @@
-source "https://rubygems.org"
+eval File.read "gemfiles/common.gemfile"
 
 gem "activerecord", "~> 4.0.0"
-
-gemspec path: ".."

data/gemfiles/Rails-4.1.gemfile

@@ -1,5 +1,3 @@
-source "https://rubygems.org"
+eval File.read "gemfiles/common.gemfile"
 
 gem "activerecord", "~> 4.1.0"
-
-gemspec path: ".."

data/gemfiles/Rails-4.2.gemfile

@@ -1,5 +1,3 @@
-source "https://rubygems.org"
+eval File.read "gemfiles/common.gemfile"
 
 gem "activerecord", "~> 4.2.0"
-
-gemspec path: ".."

data/gemfiles/Rails-5.0.gemfile

@@ -1,5 +1,3 @@
-source "https://rubygems.org"
+eval File.read "gemfiles/common.gemfile"
 
 gem "activerecord", "~> 5.0.0"
-
-gemspec path: ".."

data/gemfiles/Rails-5.1.gemfile

@@ -1,5 +1,3 @@
-source "https://rubygems.org"
+eval File.read "gemfiles/common.gemfile"
 
 gem "activerecord", "~> 5.1.0"
-
-gemspec path: ".."

data/gemfiles/Rails-head.gemfile

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

data/gemfiles/common.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "mongoid", require: false

data/lib/attr_masker.rb

@@ -12,7 +12,7 @@ module AttrMasker
 
   module Maskers
     autoload :Replacing, "attr_masker/maskers/replacing"
-    autoload :SIMPLE, "attr_masker/maskers/simple"
+    autoload :Simple, "attr_masker/maskers/simple"
   end
 
   require "attr_masker/railtie" if defined?(Rails)

data/lib/attr_masker/maskers/simple.rb

@@ -5,8 +5,10 @@ module AttrMasker
     # +opts+ is a Hash with the key :value that gives you the current attribute
     # value.
     #
-    SIMPLE = lambda do |_opts|
-      "(redacted)"
+    class Simple
+      def call(_opts)
+        "(redacted)"
+      end
     end
   end
 end

data/lib/attr_masker/model.rb

@@ -82,7 +82,7 @@ module AttrMasker
         marshaler: Marshal,
         dump_method: "dump",
         load_method: "load",
-        masker: AttrMasker::Maskers::SIMPLE,
+        masker: AttrMasker::Maskers::Simple.new,
       }
 
       options = args.extract_options!.

data/lib/attr_masker/performer.rb

@@ -2,12 +2,8 @@
 #
 module AttrMasker
   module Performer
-    class ActiveRecord
+    class Base
       def mask
-        unless defined? ::ActiveRecord
-          raise AttrMasker::Error, "ActiveRecord undefined. Nothing to do!"
-        end
-
         # Do not want production environment to be masked!
         #
         if Rails.env.production?
@@ -44,7 +40,7 @@ module AttrMasker
           acc.merge!(column_name => masker_value)
         end
 
-        klass.all.unscoped.update(instance.id, updates)
+        make_update instance, updates unless updates.empty?
       end
 
       def progressbar_for_model(klass)
@@ -59,10 +55,34 @@ module AttrMasker
       ensure
         bar.finish
       end
+    end
+
+    class ActiveRecord < Base
+      def dependencies_available?
+        defined? ::ActiveRecord
+      end
 
       def all_models
         ::ActiveRecord::Base.descendants.select(&:table_exists?)
       end
+
+      def make_update(instance, updates)
+        instance.class.all.unscoped.update(instance.id, updates)
+      end
+    end
+
+    class Mongoid < Base
+      def dependencies_available?
+        defined? ::Mongoid
+      end
+
+      def all_models
+        ::Mongoid.models
+      end
+
+      def make_update(instance, updates)
+        instance.class.all.unscoped.where(id: instance.id).update(updates)
+      end
     end
   end
 end

data/lib/attr_masker/version.rb

@@ -5,8 +5,8 @@ module AttrMasker
   # Contains information about this gem's version
   module Version
     MAJOR = 0
-    MINOR = 1
-    PATCH = 1
+    MINOR = 2
+    PATCH = 0
 
     # Returns a version string by joining <tt>MAJOR</tt>, <tt>MINOR</tt>, and
     # <tt>PATCH</tt> with <tt>'.'</tt>

data/lib/tasks/db.rake

@@ -16,6 +16,13 @@ namespace :db do
   # http://stackoverflow.com/questions/14163938/activerecordconnectionnotestablished-within-a-rake-task
   #
   task :mask => :environment do
-    AttrMasker::Performer::ActiveRecord.new.mask
+    performers = AttrMasker::Performer::Base.descendants.map(&:new)
+    performers.select!(&:dependencies_available?)
+
+    if performers.empty?
+      raise AttrMasker::Error, "No supported database!"
+    end
+
+    performers.each(&:mask)
   end
 end

data/spec/dummy/config/mongoid.yml

@@ -0,0 +1,33 @@
+# Heavily based on Mongoid's test suite
+# https://github.com/mongodb/mongoid/blob/v6.2.0/spec/config/mongoid.yml
+test:
+  clients:
+    default:
+      database: attr_masker_test
+      hosts:
+        - <%=ENV["MONGOID_SPEC_HOST"]%>:<%=ENV["MONGOID_SPEC_PORT"]%>
+      options:
+        auth_source: "admin"
+        read:
+          mode: :primary_preferred
+          tag_sets:
+            - use: web
+        max_pool_size: 1
+    reports:
+      database: reports
+      hosts:
+        - <%=ENV["MONGOID_SPEC_HOST"]%>:<%=ENV["MONGOID_SPEC_PORT"]%>
+      options:
+        user: "mongoid-user"
+        password: "password"
+        auth_source: "admin"
+  options:
+    include_root_in_json: false
+    include_type_for_serialization: false
+    preload_models: false
+    scope_overwrite_exception: false
+    raise_not_found_error: true
+    use_activesupport_time_zone: true
+    use_utc: false
+    log_level: :warn
+    app_name: 'testing'

data/spec/features/active_record_spec.rb

@@ -0,0 +1,28 @@
+# (c) 2017 Ribose Inc.
+#
+
+# No point in using ApplicationRecord here.
+# rubocop:disable Rails/ApplicationRecord
+
+require_relative "shared_examples"
+
+RSpec.describe "Attr Masker gem", :suppress_progressbar do
+  context "when used with ActiveRecord" do
+    before do
+      if ENV["WITHOUT_ACTIVE_RECORD"]
+        expect(defined?(::ActiveRecord)).to be(nil)
+        skip "Active Record specs disabled with WITHOUT_ACTIVE_RECORD shell " \
+          "variable"
+      end
+    end
+
+    before do
+      allow(ActiveRecord::Base).to receive(:descendants).
+        and_return([ActiveRecord::SchemaMigration, user_class_definition])
+    end
+
+    let(:user_class_definition) { Class.new(ActiveRecord::Base) }
+
+    include_examples "Attr Masker gem feature specs"
+  end
+end

data/spec/features/mongoid_spec.rb

@@ -0,0 +1,36 @@
+# (c) 2017 Ribose Inc.
+#
+
+require_relative "shared_examples"
+
+RSpec.describe "Attr Masker gem", :suppress_progressbar do
+  context "when used with Mongoid" do
+    before do
+      if ENV["WITHOUT_MONGOID"]
+        expect(defined?(::Mongoid)).to be(nil)
+        skip "Mongoid specs disabled with WITHOUT_MONGOID shell variable"
+      end
+    end
+
+    after do
+      # Remove the example-specific model from Mongoid.models
+      ::Mongoid.models.delete(user_class_definition)
+    end
+
+    let(:user_class_definition) do
+      Class.new do
+        include Mongoid::Document
+        include Mongoid::Timestamps
+
+        store_in collection: "users"
+
+        field :first_name
+        field :last_name
+        field :email
+        field :avatar
+      end
+    end
+
+    include_examples "Attr Masker gem feature specs"
+  end
+end

data/spec/{features_spec.rb → features/shared_examples.rb}

@@ -1,26 +1,20 @@
 # (c) 2017 Ribose Inc.
 #
 
-# No point in using ApplicationRecord here.
-# rubocop:disable Rails/ApplicationRecord
-
 # No point in ensuring a trailing comma in multiline argument lists here.
 # rubocop:disable Style/TrailingCommaInArguments
 
 require "spec_helper"
 
-RSpec.describe "Attr Masker gem", :suppress_progressbar do
+RSpec.shared_examples "Attr Masker gem feature specs" do
   before do
-    stub_const "User", Class.new(ActiveRecord::Base)
+    stub_const "User", user_class_definition
 
     User.class_eval do
       def jedi?
         email.ends_with? "@jedi.example.test"
       end
     end
-
-    allow(ActiveRecord::Base).to receive(:descendants).
-      and_return([ActiveRecord::SchemaMigration, User])
   end
 
   let!(:han) do

data/spec/spec_helper.rb

@@ -4,7 +4,7 @@
 require "bundler"
 Bundler.require :default, :development
 
-Dir[File.expand_path "../support/**/*.rb", __FILE__].each { |f| require f }
+Dir[File.expand_path "../support/**/*.rb", __FILE__].sort.each { |f| require f }
 
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure
@@ -17,5 +17,3 @@ RSpec.configure do |config|
     c.syntax = :expect
   end
 end
-
-require "rails/all"

data/spec/support/00_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 ENV["WITHOUT_MONGOID"]

data/spec/support/20_combustion.rb

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

data/spec/support/db_cleaner.rb

@@ -2,9 +2,18 @@ require "database_cleaner"
 
 RSpec.configure do |config|
   config.before(:suite) do
-    DatabaseCleaner.clean_with(:truncation)
+    unless ENV["WITHOUT_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 ENV["WITHOUT_MONGOID"]
+      DatabaseCleaner[:mongoid].strategy = :truncation, { only: "users" }
+    end
+
+    DatabaseCleaner.clean_with(:truncation)
   end
 
   config.around(:each) do |example|

data/spec/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)") }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attr_masker
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-07 00:00:00.000000000 Z
+date: 2017-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -86,6 +86,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !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
@@ -169,6 +183,7 @@ files:
 - gemfiles/Rails-5.0.gemfile
 - gemfiles/Rails-5.1.gemfile
 - gemfiles/Rails-head.gemfile
+- gemfiles/common.gemfile
 - lib/attr_masker.rb
 - lib/attr_masker/attribute.rb
 - lib/attr_masker/error.rb
@@ -180,12 +195,16 @@ files:
 - lib/attr_masker/version.rb
 - lib/tasks/db.rake
 - 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/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_mongoid_env.rb
+- spec/support/20_combustion.rb
 - spec/support/db_cleaner.rb
 - spec/support/matchers.rb
 - spec/support/rake.rb
@@ -220,12 +239,16 @@ specification_version: 4
 summary: Masking attributes
 test_files:
 - 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/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_mongoid_env.rb
+- spec/support/20_combustion.rb
 - spec/support/db_cleaner.rb
 - spec/support/matchers.rb
 - spec/support/rake.rb

data/spec/support/0_combustion.rb

@@ -1,5 +0,0 @@
-# (c) 2017 Ribose Inc.
-#
-
-Combustion.path = "spec/dummy"
-Combustion.initialize! :all