active_remote-cached 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c89a29c20fea4fff1a59ab534285774e7758620a73fc4005866011326b67ddbe
-  data.tar.gz: 1fbb57ba895a2aedb8067e399ac747cd6428b2e11c18c043e0fc9fbd8e3a63a1
+  metadata.gz: b6ac1efd0991c3ee528e08b55099bf6f05a6c1eb243f290e4197be290b725dca
+  data.tar.gz: 34229f667ea990196cf2593fe31207532ddbc60fdd72904c8ff618a5e9b3c5c1
 SHA512:
-  metadata.gz: e07972d8b297ad00be81d09dc05330075db0f744d6d40f0323135f326368846325cc66975f8771260d14ba5cd96156c36e134e9bf500df4bff924d6bdcc9ef82
-  data.tar.gz: 5a1818958e13bac846e04616c1762f1fdbb3d7e5e664d8d7c56e86b36e1fa10d608bf242bd666e43ba1bea5eef6f3a17be01e2c1f715bab205413aabe3a764eb
+  metadata.gz: e38d49aedda27d13809af64e7f939bd2578dc8f45a3f0f657f0dabf4bae5e3f376078ae6b16bf8765a3e8e7d198f93fb7105e292e7555a1e86927d879c4992ad
+  data.tar.gz: 1c4f37e645e020daf1e4523e6788aa397a1d23a7bda1f59e4335bc17d1501eaaf5343ce7d94a72134d1f56a581099021456f391051dd3f841a432cb627c0d20b

data/.rubocop.yml

@@ -0,0 +1,55 @@
+AllCops:
+  TargetRubyVersion: 3.1
+  Exclude:
+    - 'gemfiles/**/*'
+
+Layout/AccessModifierIndentation:
+  Enabled: false
+Layout/CommentIndentation:
+  Enabled: false
+Layout/IndentationConsistency:
+  Enabled: false
+
+Style/AccessModifierDeclarations:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Naming/FileName:
+  Exclude:
+    - 'lib/active_remote-cached.rb'
+
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'lib/active_remote/cached.rb' # this module is big
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Naming/VariableNumber:
+  Enabled: false
+
+Style/HashSyntax:
+  Description: >-
+                 Prefer Ruby 1.8 hash syntax { :a => 1, :b => 2 }
+                 over 1.9 syntax { a: 1, b: 2 }.
+  StyleGuide: 'https://git.moneydesktop.com/dev/ruby-style-guide#hash-literals'
+  EnforcedStyle: hash_rockets
+  Exclude:
+    - 'Gemfile'
+
+# Use lambdas instead of stabbys
+Style/Lambda:
+  EnforcedStyle: lambda
+
+Style/MissingRespondToMissing:
+  Enabled: false

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in active_remote-cached.gemspec

data/Rakefile

@@ -1,10 +1,12 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
-  t.libs.push "lib"
-  t.libs.push "spec"
-  t.pattern = "spec/**/*_spec.rb"
+  t.libs.push 'lib'
+  t.libs.push 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
   t.verbose = true
 end
 

data/active_remote-cached.gemspec

@@ -1,27 +1,33 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+require 'English'
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'active_remote/cached/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "active_remote-cached"
+  gem.name          = 'active_remote-cached'
   gem.version       = ActiveRemote::Cached::VERSION
-  gem.authors       = ["Brandon Dewitt", "MXDevExperience"]
-  gem.email         = ["brandonsdewitt@gmail.com", "devexperience@mx.com"]
-  gem.description   = %q{ Provides "cached" finders and a DSL to enumerate which finders should have cached versions }
-  gem.summary       = %q{ Provides a configuration for caching mechanisms and finders on ActiveRemote models that are cached/cacheable }
-  gem.homepage      = ""
+  gem.authors       = ['Brandon Dewitt', 'MXDevExperience']
+  gem.email         = ['brandonsdewitt@gmail.com', 'devexperience@mx.com']
+  gem.description   = ' Provides "cached" finders and a DSL to enumerate which finders should have cached versions '
+  gem.summary       = ' Provides a configuration for caching mechanisms and finders on ActiveRemote models'
+  gem.homepage      = ''
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.required_ruby_version = '>= 2.6'
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  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.require_paths = ['lib']
 
-  gem.add_dependency "active_remote"
-  gem.add_dependency "activesupport"
+  gem.add_dependency 'active_remote', '>= 6.1'
+  gem.add_dependency 'activesupport'
 
-  gem.add_development_dependency "bundler"
-  gem.add_development_dependency "mocha"
-  gem.add_development_dependency "pry"
-  gem.add_development_dependency "rake"
+  gem.add_development_dependency 'bundler'
+  gem.add_development_dependency 'mocha'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec', '>= 3.0'
+  gem.add_development_dependency 'rubocop'
 end

data/lib/active_remote/cached/argument_keys.rb

@@ -1,57 +1,60 @@
-module ActiveRemote::Cached
-  class ArgumentKeys
-    attr_reader :arguments, :argument_string, :options
-
-    REMOVE_CHARACTERS = /[[:space:]+=><{}\[\];:\-,]/
-    REPLACE_MAP = [
-      [" ", "SP"],
-      ["+", "PL"],
-      ["=", "EQ"],
-      [">", "GT"],
-      ["<", "LT"],
-      ["{", "LB"],
-      ["}", "RB"],
-      ["[", "LB2"],
-      ["]", "RB2"],
-      [";", "SC"],
-      [":", "CO"],
-      ["-", "DA"],
-      [",", "COM"],
-    ].freeze
-
-    def initialize(*arguments, options)
-      @options = options
-      @arguments = arguments.flatten.compact
-      @argument_string = ""
-
-      @arguments.each do |argument|
-        @argument_string << "#{argument}"
+module ActiveRemote
+  module Cached
+    class ArgumentKeys
+      attr_reader :arguments, :argument_string, :options
+
+      REMOVE_CHARACTERS = /[[:space:]+=><{}\[\];:\-,]/
+      REPLACE_MAP = [
+        [' ', 'SP'],
+        ['+', 'PL'],
+        ['=', 'EQ'],
+        ['>', 'GT'],
+        ['<', 'LT'],
+        ['{', 'LB'],
+        ['}', 'RB'],
+        ['[', 'LB2'],
+        [']', 'RB2'],
+        [';', 'SC'],
+        [':', 'CO'],
+        ['-', 'DA'],
+        [',', 'COM']
+      ].freeze
+
+      def initialize(*arguments, options)
+        @options = options
+        @arguments = arguments.flatten.compact
+        @argument_string = ''
+
+        @arguments.each do |argument|
+          @argument_string << argument.to_s
+        end
       end
-    end
 
-    def cache_key
-      return @argument_string.gsub(REMOVE_CHARACTERS, "") if remove_characters?
-      if replace_characters?
-        REPLACE_MAP.each do |character, replacement|
-          @argument_string.gsub!(character, replacement)
+      def cache_key
+        return @argument_string.gsub(REMOVE_CHARACTERS, '') if remove_characters?
+
+        if replace_characters?
+          REPLACE_MAP.each do |character, replacement|
+            @argument_string.gsub!(character, replacement)
+          end
         end
-      end
 
-      @argument_string
-    end
+        @argument_string
+      end
 
-    def to_s
-      cache_key
-    end
+      def to_s
+        cache_key
+      end
 
-    private
+      private
 
-    def remove_characters?
-      options.fetch(:active_remote_cached_remove_characters, false)
-    end
+      def remove_characters?
+        options.fetch(:active_remote_cached_remove_characters, false)
+      end
 
-    def replace_characters?
-      options.fetch(:active_remote_cached_replace_characters, false)
+      def replace_characters?
+        options.fetch(:active_remote_cached_replace_characters, false)
+      end
     end
   end
 end

data/lib/active_remote/cached/cache.rb

@@ -1,72 +1,73 @@
+# frozen_string_literal: true
+
 require 'delegate'
 
-module ActiveRemote::Cached
-  class Cache < ::SimpleDelegator
-    attr_reader :cache_provider
+module ActiveRemote
+  module Cached
+    class Cache < ::SimpleDelegator
+      attr_reader :cache_provider
 
-    def initialize(new_cache_provider)
-      @cache_provider = new_cache_provider
-      @nested_cache_provider = ::ActiveSupport::Cache::NullStore.new
+      def initialize(new_cache_provider)
+        @cache_provider = new_cache_provider
+        @nested_cache_provider = ::ActiveSupport::Cache::NullStore.new
 
-      validate_provider_method_present(:delete)
-      validate_provider_method_present(:exist?)
-      validate_provider_method_present(:fetch)
-      validate_provider_method_present(:read)
-      validate_provider_method_present(:write)
+        validate_provider_method_present(:delete)
+        validate_provider_method_present(:exist?)
+        validate_provider_method_present(:fetch)
+        validate_provider_method_present(:read)
+        validate_provider_method_present(:write)
 
-      super(@cache_provider)
-    end
+        super(@cache_provider)
+      end
 
-    def delete(*args)
-      nested_cache_provider.delete(*args)
-      super
-    end
+      def delete(*args)
+        nested_cache_provider.delete(*args)
+        super
+      end
 
-    def enable_nested_caching!
-      @nested_cache_provider = ::ActiveSupport::Cache::MemoryStore.new
-    end
+      def enable_nested_caching!
+        @nested_cache_provider = ::ActiveSupport::Cache::MemoryStore.new
+      end
 
-    def exist?(*args)
-      nested_cache_provider.exist?(*args) || super
-    end
+      def exist?(*args)
+        nested_cache_provider.exist?(*args) || super
+      end
+
+      def fetch(name, options = {})
+        fetch_value = nested_cache_provider.fetch(name, options) { super }
 
-    def fetch(name, options = {})
-      fetch_value = nested_cache_provider.fetch(name, options) { super }
+        delete(name) unless valid_fetched_value?(fetch_value, options)
 
-      unless valid_fetched_value?(fetch_value, options)
-        delete(name)
+        fetch_value
       end
 
-      return fetch_value
-    end
+      def read(*args)
+        nested_cache_provider.read(*args) || super
+      end
 
-    def read(*args)
-      nested_cache_provider.read(*args) || super
-    end
+      def write(*args)
+        nested_cache_provider.write(*args)
+        super
+      end
 
-    def write(*args)
-      nested_cache_provider.write(*args)
-      super
-    end
+      private
 
-  private
+      attr_reader :nested_cache_provider
 
-    def nested_cache_provider
-      @nested_cache_provider
-    end
+      def valid_fetched_value?(value, options = {})
+        return false if value.nil? && !options.fetch(:allow_nil, false)
+        return false if !options.fetch(:allow_empty, false) && value.respond_to?(:empty?) && value.empty?
 
-    def valid_fetched_value?(value, options = {})
-      return false if value.nil? && !options.fetch(:allow_nil, false)
-      return false if !options.fetch(:allow_empty, false) && value.respond_to?(:empty?) && value.empty?
-      return true
-    end
+        true
+      end
+
+      def validate_provider_method_present(method_name)
+        return if cache_provider.respond_to?(method_name)
 
-    def validate_provider_method_present(method_name)
-      unless self.cache_provider.respond_to?(method_name)
-        raise <<-CACHE_METHOD
+          raise <<-CACHE_METHOD
           ActiveRemote::Cached::Cache must respond_to? #{method_name}
           in order to be used as a caching interface for ActiveRemote
-        CACHE_METHOD
+          CACHE_METHOD
       end
     end
   end

data/lib/active_remote/cached/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/ordered_options'
 
 module ActiveRemote
@@ -5,18 +7,16 @@ module ActiveRemote
     class Railtie < ::Rails::Railtie
       config.active_remote_cached = ::ActiveSupport::OrderedOptions.new
 
-      initializer "active_remote-cached.initialize_cache" do |app|
+      initializer 'active_remote-cached.initialize_cache' do |_app|
         config.active_remote_cached.expires_in ||= 5.minutes
         config.active_remote_cached.race_condition_ttl ||= 5.seconds
 
         ::ActiveRemote::Cached.cache(Rails.cache)
 
-        if config.active_remote_cached.enable_nested_caching
-          ::ActiveRemote::Cached.cache.enable_nested_caching!
-        end
+        ::ActiveRemote::Cached.cache.enable_nested_caching! if config.active_remote_cached.enable_nested_caching
 
         ::ActiveRemote::Cached.default_options(
-          :expires_in         => config.active_remote_cached.expires_in,
+          :expires_in => config.active_remote_cached.expires_in,
           :race_condition_ttl => config.active_remote_cached.race_condition_ttl
         )
       end

data/lib/active_remote/cached/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module ActiveRemote
   module Cached
-    VERSION = "1.0.0"
+    VERSION = '1.1.1'
   end
 end