moderate_parameters 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a3dab509d7471d97c25322b1998d917fdb04b41993a53b4550fe80b47bfcf51
-  data.tar.gz: 8e0cf544739a1ac9ad0c2153a231b4edafcff7ddc86ca861a3622673a4da1eca
+  metadata.gz: 025154d5fcf0e85640487bb165610bc71b9c57337bdc38f6dfb6180e5446a66a
+  data.tar.gz: 4e6ddfbc51cd37e463e01fee38b4ab167c9c391aeb2d5e3674ef5624c5dac353
 SHA512:
-  metadata.gz: c511925780bb70b27d3654ed9c13cbc41806b05bf8e6bcb2f6d5a154e5f66cd78c75afad4b43ea8df38edab3199d3d2549876e24ecc857340a8964d589d4811a
-  data.tar.gz: 3c0bb1b989d4b5bc20709d36854823050a0f28912fd098ecb4b8d96f279364dab02b1dc45200a3aea5dc0ebe2767599c172908ec6860b90ff50bc802183a83c0
+  metadata.gz: 9785b2538bfec4f143b9acfe1391f696e95e43bb4e837cc030a7669f1cf5c920157a0035aa8fa8ee7b9c3363712d8b71bac623b5f518fe529b8778e0c7246627
+  data.tar.gz: 53d7b1d10bff242410ca415b4f3e2c3aefa11eada31c7db50c1c4b3dd9dfa90e0a52ed1bccb88e52b20097bd330eacca811e10d4fe1d268345b8a69150506191

data/.circleci/config.yml

@@ -0,0 +1,70 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      - image: circleci/ruby:2.6.1
+        environment:
+          BUNDLE_JOBS: 3
+          BUNDLE_RETRY: 3
+          BUNDLE_PATH: vendor/bundle
+          RAILS_ENV: test
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "Gemfile.lock" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-dependencies-
+
+      - run:
+          name: Configure Bundler
+          command: |
+            echo 'export BUNDLER_VERSION=$(cat Gemfile.lock | tail -1 | tr -d " ")' >> $BASH_ENV
+            source $BASH_ENV
+            gem install bundler
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | \
+              circleci tests split --split-by=timings)"
+
+            bundle exec rspec \
+              --format progress \
+              --format RspecJunitFormatter \
+              --out /tmp/test-results/rspec.xml \
+              --format progress \
+              $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.rubocop.yml

@@ -0,0 +1,4 @@
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'moderate_parameters.gemspec'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    moderate_parameters (0.1.0)
+    moderate_parameters (0.1.1)
       actionpack (>= 3.0, < 6.1)
       activemodel (>= 3.0, < 6.1)
       activesupport (>= 3.0, < 6.1)
@@ -10,32 +10,33 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (5.2.3)
-      actionview (= 5.2.3)
-      activesupport (= 5.2.3)
+    actionpack (6.0.0)
+      actionview (= 6.0.0)
+      activesupport (= 6.0.0)
       rack (~> 2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.3)
-      activesupport (= 5.2.3)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.0.0)
+      activesupport (= 6.0.0)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activemodel (5.2.3)
-      activesupport (= 5.2.3)
-    activesupport (5.2.3)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activemodel (6.0.0)
+      activesupport (= 6.0.0)
+    activesupport (6.0.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
     builder (3.2.3)
     coderay (1.1.2)
     concurrent-ruby (1.1.5)
     crass (1.0.4)
     diff-lcs (1.3)
-    erubi (1.8.0)
+    erubi (1.9.0)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
     loofah (2.2.3)
@@ -43,7 +44,7 @@ GEM
       nokogiri (>= 1.5.9)
     method_source (0.9.2)
     mini_portile2 (2.4.0)
-    minitest (5.11.3)
+    minitest (5.12.0)
     nokogiri (1.10.4)
       mini_portile2 (~> 2.4.0)
     pry (0.12.2)
@@ -55,32 +56,35 @@ GEM
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.4)
+    rails-html-sanitizer (1.2.0)
       loofah (~> 2.2, >= 2.2.2)
-    railties (5.2.3)
-      actionpack (= 5.2.3)
-      activesupport (= 5.2.3)
+    railties (6.0.0)
+      actionpack (= 6.0.0)
+      activesupport (= 6.0.0)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.19.0, < 2.0)
+      thor (>= 0.20.3, < 2.0)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
       rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
+    rspec-core (3.8.2)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    rspec-expectations (3.8.4)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+    rspec-mocks (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+    rspec-support (3.8.2)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
     thor (0.20.3)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
+    zeitwerk (2.1.10)
 
 PLATFORMS
   ruby
@@ -91,6 +95,7 @@ DEPENDENCIES
   pry (~> 0.12.2)
   rake (~> 10.0)
   rspec (~> 3.0)
+  rspec_junit_formatter (= 0.4.1)
 
 BUNDLED WITH
    2.0.1

data/lib/generators/moderate_parameters/install_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module ModerateParameters
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __dir__)
+
+      desc 'Creates a ModerateParameters initializer.'
+
+      def copy_initializer
+        template 'moderate_parameters.rb', 'config/initializers/moderate_parameters.rb'
+      end
+    end
+  end
+end

data/lib/generators/templates/moderate_parameters.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+ModerateParameters.configure do |config|
+  # Enables/Disables logging occurrences of
+  # reading/writing from ActionController::Parameters.
+  config.breadcrumbs_enabled = false
+end

data/lib/moderate_parameters/breadcrumbs.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module ModerateParameters
+  module Breadcrumbs
+    def [](key)
+      internal_param_logging(key, 'read', caller_locations) if ModerateParameters.breadcrumbs_enabled
+      super
+    end
+
+    def []=(key, value)
+      internal_param_logging(key, 'overwritten', caller_locations) if ModerateParameters.breadcrumbs_enabled
+      super
+    end
+
+    def extract!(*keys)
+      internal_method_logging('extract!', keys, caller_locations) if ModerateParameters.breadcrumbs_enabled
+      super
+    end
+
+    private
+
+    def internal_param_logging(key, action, stack_array)
+      ActiveSupport::Notifications.instrument('moderate_parameters') do |payload|
+        payload[:caller_locations] = stack_array
+        payload[:message] = "#{key} is being #{action} on: #{stack_array.join("\n")}"
+      end
+    end
+
+    def internal_method_logging(method, keys, stack_array)
+      ActiveSupport::Notifications.instrument('moderate_parameters') do |payload|
+        payload[:caller_locations] = stack_array
+        payload[:message] = "#{method} is being called with #{keys} on: #{stack_array.join("\n")}"
+      end
+    end
+  end
+end

data/lib/moderate_parameters/logger.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-$moderate_parameters_logger = Logger.new('log/moderate_parameters.log')
+$moderate_parameters_logger = ActiveSupport::Logger.new('log/moderate_parameters.log')
 
-ActiveSupport::Notifications.subscribe('moderate_parameters') do |name, start, finish, id, payload|
+ActiveSupport::Notifications.subscribe('moderate_parameters') do |_, _, _, _, payload|
   $moderate_parameters_logger.info "#{payload[:controller]}##{payload[:action]} #{payload[:message]}"
 end

data/lib/moderate_parameters/{moderate_parameters.rb → parameters.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-module ActionController
-  class Parameters
+module ModerateParameters
+  module Parameters
     def moderate(controller_name, action, *filters)
       params = self.class.new
 
@@ -14,13 +14,13 @@ module ActionController
         end
       end
 
-      custom_logging(params, controller_name, action)
+      incoming_params_logging(params, controller_name, action)
       permit!
     end
 
     private
 
-    def custom_logging(params, controller_name, action)
+    def incoming_params_logging(params, controller_name, action)
       unpermitted_keys(params).each do |k|
         ActiveSupport::Notifications.instrument('moderate_parameters') do |payload|
           payload[:controller] = controller_name

data/lib/moderate_parameters/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ModerateParameters
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/lib/moderate_parameters.rb

@@ -1,8 +1,24 @@
 # frozen_string_literal: true
 
-require "moderate_parameters/version"
-require "moderate_parameters/logger"
-require "moderate_parameters/moderate_parameters"
+require 'action_controller'
+require 'active_support'
+require 'moderate_parameters/version'
+require 'moderate_parameters/logger'
+require 'moderate_parameters/parameters'
+require 'moderate_parameters/breadcrumbs'
 
 module ModerateParameters
+  mattr_accessor :breadcrumbs_enabled
+  @@breadcrumbs_enabled = false
+
+  def self.configure
+    yield self
+  end
+end
+
+module ActionController
+  class Parameters
+    prepend ModerateParameters::Breadcrumbs
+    prepend ModerateParameters::Parameters
+  end
 end

data/moderate_parameters.gemspec

@@ -45,4 +45,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry', '~> 0.12.2'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec_junit_formatter', '0.4.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moderate_parameters
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Kyle Boe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-26 00:00:00.000000000 Z
+date: 2019-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -146,6 +146,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.1
 description: A tool for migrating Rails applications from Protected Attributes to
   Strong Parameters.
 email:
@@ -156,9 +170,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -168,10 +183,14 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/generators/moderate_parameters/install_generator.rb
+- lib/generators/templates/moderate_parameters.rb
 - lib/moderate_parameters.rb
+- lib/moderate_parameters/breadcrumbs.rb
 - lib/moderate_parameters/logger.rb
-- lib/moderate_parameters/moderate_parameters.rb
+- lib/moderate_parameters/parameters.rb
 - lib/moderate_parameters/version.rb
+- log/.gitkeep
 - moderate_parameters.gemspec
 homepage: https://github.com/hintmedia/moderate_parameters
 licenses:

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.0
-before_install: gem install bundler -v 1.17.2