snake-eyes 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88a300e546ae808376833e94ab9b17f2b33adf32
-  data.tar.gz: '09c35643682438b1b4101d50eefa73fb9de5e7fa'
+  metadata.gz: ba7e12d594cec3ed457677a40f4396e5822f759c
+  data.tar.gz: 111a3c36a1d94e507f509f2fc6bd0dc3f5692d43
 SHA512:
-  metadata.gz: 41c5b9cadc36ab390107ee6e9f289a0b1038174a77b16ab4f5284ac024e9e6ee8268f625c3408c13fd42bea5e1956bdbabfe8fbd9dba949a3d03760c4449cd7a
-  data.tar.gz: 5dc4f29e0f87bd583b7649e4e5d46f5328a28d4e313638751be7b7985deeff611f7cb76bbb1afe4940d2f1e676946f919aec15671e9aff37044e10af1ee550a6
+  metadata.gz: ad81a0db80a6af2c9fb59a7a51aaf49438dbd60985d72db73ed49e062fdea3eca2547c1d90ff8c986572b19712412b924e9f73825cd42da7e545656c154fa2f5
+  data.tar.gz: 5002052f44301fb3c2eecc10e4c08f5928a4f91ad4ca43e8723c9d5d4806a78e44b7067bed29dced07724466bf9b38e8b02ae782bdb68391061b0934a547fdf8

data/README.md

@@ -32,7 +32,7 @@ end
 
 ### Dealing with nested params
 
-Once `snake_eyes_params` has been enabled for a controllor, `params` accepts an options hash, which can be used to specify which attributes should have the `_attributes` suffix appended.
+Once `snake_eyes_params` has been enabled for a controller, `params` accepts an options hash, which can be used to specify which attributes should have the `_attributes` suffix appended.
 
  ```ruby
  class WithoutSnakeEyesController < ApplicationController

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -14,17 +16,17 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
 load 'rails/tasks/engine.rake'
 
 Bundler::GemHelper.install_tasks
 
-Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each(&method(:load))
 
 require 'rspec/core'
 require 'rspec/core/rake_task'
 
-desc "Run all specs in spec directory (excluding plugin specs)"
-RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
 
-task :default => :spec
+task default: :spec

data/lib/snake-eyes.rb

@@ -1,17 +1,17 @@
-require "snake-eyes/version"
-require "snake-eyes/interface_changes"
+# frozen_string_literal: true
+
+require 'snake_eyes/version'
+require 'snake_eyes/interface_changes'
 
 module SnakeEyes
   class << self
     attr_accessor :log_snake_eyes_parameters
 
     def configuration
-      if block_given?
-        yield(SnakeEyes)
-      end
+      yield(SnakeEyes) if block_given?
     end
 
-    alias :config :configuration
+    alias config configuration
   end
 
   @log_snake_eyes_parameters = true

data/lib/snake_eyes/compatibility.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module SnakeEyes
+  module Compatibility
+    if Rails::VERSION::MAJOR >= 5
+      def _prepare(transformed_params)
+        # We permit all parameter values so that we many convert it to a hash,
+        # to work with ActionPack 5.2's ActionController::Parameters initializer
+        params_duplicate = transformed_params.dup
+        params_duplicate.permit!
+        params_duplicate.to_h
+      end
+    else
+      def _prepare(transformed_params)
+        transformed_params
+      end
+    end
+  end
+end

data/lib/snake_eyes/configuration.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module SnakeEyes
+  module Configuration
+    protected
+
+    def validate_options(options)
+      options.keys.each do |key|
+        if key != :nested_attributes && key != :substitutions
+          raise ArgumentError,
+                "SnakeEyes: params received unrecognised option '#{key}'"
+        end
+      end
+    end
+
+    def add_nested_attributes!(options)
+      options[:nested_attributes] =
+        build_options_schema(options[:nested_attributes] || {}, '') do |target, parent_name|
+          # noinspection RubyResolve
+          if parent_name.empty? || parent_name.starts_with?('_')
+            target
+          else
+            target.merge(_attributes_suffix: true)
+          end
+        end
+    end
+
+    def build_options_schema(attributes_list = [], parent_name = '', options = {}, &block)
+      if attributes_list.is_a?(Array)
+        attributes_array = attributes_list.inject({}) do |memo, nested_attribute|
+          memo.merge(build_options_schema(nested_attribute, parent_name, options, &block))
+        end
+
+        yield(attributes_array, parent_name)
+      elsif attributes_list.is_a?(Hash) && (
+      !options[:internal_attributes] ||
+        (attributes_list.keys && options[:internal_attributes]).length > options[:internal_attributes].length)
+
+        attributes_hash = attributes_list.each_with_object({}) do |key_and_value, memo|
+          key, value = key_and_value
+
+          memo[key.to_s] = yield(build_options_schema(value, '', options, &block), key.to_s)
+        end
+
+        yield(attributes_hash, parent_name)
+      else
+        {
+          attributes_list.to_s.underscore => yield({}, attributes_list.to_s.underscore)
+        }
+      end
+    end
+  end
+end

data/lib/{snake-eyes → snake_eyes}/engine.rb

@@ -1,12 +1,12 @@
+# frozen_string_literal: true
+
 module SnakeEyes
   class Engine < ::Rails::Engine
-
     config.generators do |g|
-      g.test_framework :rspec, :fixture => false
-      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.test_framework :rspec, fixture: false
+      g.fixture_replacement :factory_girl, dir: 'spec/factories'
       g.assets false
       g.helper false
     end
-
   end
 end

data/lib/snake_eyes/interface_changes.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require File.expand_path('configuration', __dir__)
+require File.expand_path('memoization', __dir__)
+require File.expand_path('compatibility', __dir__)
+require File.expand_path('logging', __dir__)
+require File.expand_path('transform', __dir__)
+
+module SnakeEyes
+  module InterfaceChanges
+    include Configuration
+    include Memoization
+    include Compatibility
+    include Logging
+    include Transform
+
+    KEYS_ALWAYS_PRESENT = %w[controller action].freeze
+
+    def self.included(base)
+      base.class_eval do
+        alias_method :old_params, :params
+
+        def params(options = {})
+          # noinspection RubyResolve
+          original_params = old_params
+
+          return original_params unless keys_to_snakeize?(original_params)
+
+          validate_options(options)
+          add_nested_attributes!(options)
+
+          return params_from_cache(options) if params_in_cache?(options)
+
+          @snake_eyes_params = transform(original_params, options)
+
+          log(@snake_eyes_params)
+
+          cache!(options, @snake_eyes_params)
+        end
+
+        private
+
+        def keys_to_snakeize?(params)
+          (params.keys || KEYS_ALWAYS_PRESENT).length > KEYS_ALWAYS_PRESENT.length
+        end
+      end
+    end
+  end
+end

data/lib/snake_eyes/logging.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module SnakeEyes
+  module Logging
+    private
+
+    def log(snake_eyes_params)
+      return unless SnakeEyes.log_snake_eyes_parameters
+
+      ignored_params = ActionController::LogSubscriber::INTERNAL_PARAMS
+      filtered_params =
+        request.send(:parameter_filter).filter(
+          snake_eyes_params.except(*ignored_params)
+        )
+
+      logger.info "  SnakeEyes Parameters: #{_prepare(filtered_params).inspect}"
+    end
+  end
+end

data/lib/snake_eyes/memoization.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module SnakeEyes
+  module Memoization
+    def self.included(base)
+      base.class_eval do
+        private
+
+        def params_from_cache(key)
+          previous_params[key]
+        end
+
+        def params_in_cache?(key)
+          previous_params.key?(key)
+        end
+
+        def cache!(key, value)
+          previous_params[key] = value
+        end
+
+        def previous_params
+          @previous_params ||= {}
+        end
+      end
+    end
+  end
+end

data/lib/snake_eyes/transform.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+module SnakeEyes
+  module Transform
+    def transform(original_params, options)
+      ActionController::Parameters.new(
+        deep_transform(_prepare(original_params), options)
+      )
+    end
+
+    private
+
+    def deep_transform(target, options = {})
+      case target
+      when Array
+        deep_transform_array(
+          target,
+          nested_attributes(options),
+          substitutions(options)
+        )
+      when Hash
+        deep_transform_hash(
+          target,
+          nested_attributes(options),
+          substitutions(options)
+        )
+      else
+        perform_substitution(target, substitutions(options))
+      end
+    end
+
+    def nested_attributes(options)
+      options[:nested_attributes] || {}
+    end
+
+    def substitutions(options)
+      if options[:substitutions].is_a?(Array)
+        options[:substitutions].map(&:stringify_keys)
+      else
+        (options[:substitutions] || {}).stringify_keys
+      end
+    end
+
+    def deep_transform_array(target, nested_attributes, substitutions)
+      target.map do |target_element|
+        array_nested_attributes = nested_attributes['*']
+
+        array_substitutions =
+          substitutions.is_a?(Array) ? {} : substitutions['*']
+
+        deep_transform(
+          target_element,
+          nested_attributes: array_nested_attributes,
+          substitutions: array_substitutions
+        )
+      end
+    end
+
+    def snakeize(key)
+      key.to_s.underscore.gsub(/(\d+)/, '_\1')
+    end
+
+    def deep_transform_hash(target, nested_attributes, substitutions)
+      target.each_with_object({}) do |(key, value), memo|
+
+        transformed_key_base = snakeize(key)
+
+        # Append the '_attributes' suffix if the original params key has the
+        # same name and is nested in the same place as one mentioned in the
+        # nested_attributes option
+        transformed_key =
+          if nested_attributes[transformed_key_base] &&
+            nested_attributes[transformed_key_base][:_attributes_suffix]
+
+            transformed_key_base + '_attributes'
+          else
+            transformed_key_base
+          end
+
+        hash_nested_attributes =
+          nested_attributes[transformed_key_base] || nested_attributes['_' + transformed_key_base]
+
+        hash_substitutions =
+          substitutions.is_a?(Array) ? {} : substitutions[transformed_key_base]
+
+        transformed_hash = deep_transform(
+          value,
+          nested_attributes: hash_nested_attributes,
+          substitutions: hash_substitutions
+        )
+
+        memo[transformed_key] =
+          if memo.key?(transformed_key) && memo[transformed_key].is_a?(Hash)
+            memo[transformed_key].deep_merge(transformed_hash)
+          else
+            transformed_hash
+          end
+      end
+    end
+
+    def perform_substitution(target, substitution)
+      if substitution.is_a?(Array)
+        matching_substitution = substitution.find do |substitution_item|
+          substitution_keys?(substitution_item) && target == substitution_item['replace']
+        end
+
+        if matching_substitution
+          matching_substitution['with']
+        else
+          target
+        end
+
+      elsif substitution_keys?(substitution)
+        target == substitution['replace'] ? substitution['with'] : target
+      else
+        target
+      end
+    end
+
+    def substitution_keys?(substitution)
+      substitution.key?('replace') && substitution.key?('with')
+    end
+  end
+end

data/lib/snake_eyes/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SnakeEyes
+  VERSION = '2.0.0'
+end

data/spec/dummy/Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
-require File.expand_path('../config/application', __FILE__)
+require File.expand_path('config/application', __dir__)
 
 Rails.application.load_tasks

data/spec/dummy/app/controllers/application_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ApplicationController < ActionController::Base
   # Prevent CSRF attacks by raising an exception.
   # For APIs, you may want to use :null_session instead.

data/spec/dummy/app/helpers/application_helper.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 module ApplicationHelper
 end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html>
+<html lang="en">
 <head>
   <title>Dummy</title>
   <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>

data/spec/dummy/bin/bundle

@@ -1,3 +1,5 @@
 #!/usr/bin/env ruby
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+# frozen_string_literal: true
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
 load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
-APP_PATH = File.expand_path('../../config/application', __FILE__)
+# frozen_string_literal: true
+
+APP_PATH = File.expand_path('../config/application', __dir__)
 require_relative '../config/boot'
 require 'rails/commands'