arturo 2.4.1 → 2.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 79d3affcbb0dd1612baa5eebd1073a4325ab9436
-  data.tar.gz: 541f2ffa57e8eb6b3a7774789da148bb14bb0d2f
+SHA256:
+  metadata.gz: a92dc0b0221d1584220352d9ca7586f50449dd23bb6b4f2bfe9cc26fa30c7d1f
+  data.tar.gz: d59e9a44466d5ede3338873993f61ae8b11d009ff32eb5e55b1122090b3ad368
 SHA512:
-  metadata.gz: 76d162fc3dd78459ccddcd54902f5f68c09a2a354ea3468a3977b9b13fa213b579c2bad69cae936ea2a996ddf8ae0bca0f949a5760d8972fd47adc1613c62d94
-  data.tar.gz: bbe4b79c132ac8d9ef6fbf563da43553e85b9666a65383c4deecb6340af3971bde19914151de222acd7229eeb1408e473ce154209e7388e7bceb921b7df1fc20
+  metadata.gz: fe24d781cd0137148a5edc2b3f5fb67fb9d29995758fb0cbbcb026c0fd4b40960bf542bf31aa09a555f827c053e8f49d1f5f08553d55e68050758f714d6f53f7
+  data.tar.gz: 6df3e48141801e5007a14f7531a7bfea975a09a95ae59dd7ad2bb8e756b66a14e4903a34f3855f35fbda01465ad972e701381ecbdf321071d5f38f8fd3a689d1

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## Unreleased
+
+## v2.5.3
+
+Bug fix: Allow using Arturo with ActiveRecord, but without all of Rails.
+
+## v2.5.2
+
+Drop support for Rails 3.2.
+
+Add support for Rails 6.1.
+
+Switch CI from Travis to GitHub Actions.
+
 ## v2.2.0
 
 Bug fix: making a feature-update request that fails strict params checks now returns a sensible error instead of throwing an exception

data/README.md

@@ -102,6 +102,7 @@ rake db:migrate
 Open up the newly-generated `config/initializers/arturo_initializer.rb`.
 There are configuration options for the following:
 
+ * logging capabilities (see [logging](#logging))
  * the method that determines whether a user has permission to manage features
    (see [admin permissions](#adminpermissions))
  * the method that returns the object that has features
@@ -126,6 +127,15 @@ work with you on support for your favorite framework.
 
 ## Deep-Dive
 
+### <span id='logging'>Logging</span>
+
+You can provide a logger in order to inspect Arturo usage.
+A potential implementation for Rails would be:
+
+```Ruby
+Arturo.logger = Rails.logger
+```
+
 ### <span id='adminpermissions'>Admin Permissions</span>
 
 `Arturo::FeatureManagement#may_manage_features?` is a method that is run in
@@ -314,6 +324,11 @@ Arturo::Feature.warm_cache!
 
 This will pre-fetch all `Feature`s and put them in the cache.
 
+To use the current cache state when you can't fetch updates from origin:
+
+```Ruby
+Arturo::Feature.extend_cache_on_failure = true
+```
 
 The following is the **intended** support for integration with view caching:
 
@@ -331,6 +346,6 @@ on [Sliders](http://en.wikipedia.org/wiki/Sliders).
 
 ## Quality Metrics
 
-[![Build Status](https://travis-ci.org/zendesk/arturo.png?branch=master)](https://travis-ci.org/zendesk/arturo)
+[![Build Status](https://github.com/zendesk/arturo/workflows/CI/badge.svg)](https://github.com/zendesk/arturo/actions?query=workflow%3ACI)
 
 [![Code Quality](https://codeclimate.com/github/zendesk/arturo.png)](https://codeclimate.com/github/zendesk/arturo)

data/app/controllers/arturo/features_controller.rb

@@ -37,7 +37,7 @@ module Arturo
         feature = Arturo::Feature.find_by_id(id)
         if feature.blank?
           errors << t('arturo.features.flash.no_such_feature', :id => id)
-        elsif feature.update_attributes(attributes)
+        elsif feature.update(attributes)
           updated_count += 1
         else
           errors << t('arturo.features.flash.error_updating', :id => id, :errors => feature.errors.full_messages.to_sentence)
@@ -76,7 +76,7 @@ module Arturo
     end
 
     def update
-      if @feature.update_attributes(feature_params)
+      if @feature.update(feature_params)
         flash[:notice] = t('arturo.features.flash.updated', :name => @feature.to_s)
         redirect_to arturo_engine.feature_path(@feature)
       else

data/lib/arturo.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 module Arturo
-
+  require 'arturo/null_logger'
   require 'arturo/special_handling'
   require 'arturo/feature_availability'
   require 'arturo/feature_management'
   require 'arturo/feature_caching'
-  require 'arturo/engine' if defined?(Rails::VERSION::MAJOR) && Rails::VERSION::MAJOR >= 3
+  require 'arturo/engine' if defined?(Rails)
 
   class << self
     # Quick check for whether a feature is enabled for a recipient.
@@ -16,5 +16,13 @@ module Arturo
       f = self::Feature.to_feature(feature_name)
       f && f.enabled_for?(recipient)
     end
+
+    def logger=(logger)
+      @logger = logger
+    end
+
+    def logger
+      @logger || NullLogger.new
+    end
   end
 end

data/lib/arturo/feature.rb

@@ -11,11 +11,10 @@ module Arturo
     Arturo::Feature::SYMBOL_REGEX = /^[a-zA-z][a-zA-Z0-9_]*$/
     DEFAULT_ATTRIBUTES = { :deployment_percentage => 0 }.with_indifferent_access
 
-    attr_accessible :symbol, :deployment_percentage if ActiveRecord::VERSION::MAJOR < 4
     attr_readonly :symbol
 
     validates_presence_of :symbol, :deployment_percentage
-    validates_uniqueness_of :symbol, :allow_blank => true
+    validates_uniqueness_of :symbol, :allow_blank => true, :case_sensitive => false
     validates_numericality_of :deployment_percentage,
                                             :only_integer => true,
                                             :allow_blank => true,

data/lib/arturo/feature_caching.rb

@@ -37,15 +37,21 @@ module Arturo
       class << base
         prepend PrependMethods
         attr_accessor :cache_ttl, :feature_cache, :feature_caching_strategy
+        attr_writer :extend_cache_on_failure
       end
       base.send(:after_save) do |f|
         f.class.feature_caching_strategy.expire(f.class.feature_cache, f.symbol.to_sym) if f.class.caches_features?
       end
       base.cache_ttl = 0
+      base.extend_cache_on_failure = false
       base.feature_cache = Arturo::FeatureCaching::Cache.new
       base.feature_caching_strategy = AllStrategy
     end
 
+    def extend_cache_on_failure?
+      !!@extend_cache_on_failure
+    end
+
     def caches_features?
       self.cache_ttl.to_i > 0
     end
@@ -56,13 +62,20 @@ module Arturo
 
     class AllStrategy
       class << self
+        ##
+        # @param cache [Arturo::Cache] cache backend
+        # @param symbol [Symbol] arturo identifier
+        # @return [Arturo::Feature, Arturo::NoSuchFeature] 
+        #
         def fetch(cache, symbol, &block)
-          features = cache.read("arturo.all")
-
-          unless cache_is_current?(cache, features)
-            features = Hash[Arturo::Feature.all.map { |f| [f.symbol.to_sym, f] }]
-            mark_as_current!(cache)
-            cache.write("arturo.all", features, :expires_in => Arturo::Feature.cache_ttl * 10)
+          existing_features = cache.read("arturo.all")
+
+          features = if cache_is_current?(cache, existing_features)
+            existing_features
+          else
+            arturos_from_origin(fallback: existing_features).tap do |updated_features|
+              update_and_extend_cache!(cache, updated_features)
+            end
           end
 
           features[symbol] || Arturo::NoSuchFeature.new(symbol)
@@ -74,15 +87,85 @@ module Arturo
 
         private
 
+        ##
+        # @param fallback [Hash] features to use on database failure
+        # @return [Hash] updated features from origin or fallback
+        # @raise [ActiveRecord::ActiveRecordError] on database failure
+        #   without cache extension option
+        #
+        def arturos_from_origin(fallback:)
+          Hash[Arturo::Feature.all.map { |f| [f.symbol.to_sym, f] }]
+        rescue ActiveRecord::ActiveRecordError
+          raise unless Arturo::Feature.extend_cache_on_failure?
+
+          if fallback.blank?
+            log_empty_cache
+            raise
+          else
+            log_stale_cache
+            fallback
+          end
+        end
+
+        ##
+        # @return [Boolean] whether the current cache has to be updated from origin
+        # @raise [ActiveRecord::ActiveRecordError] on database failure
+        #   without cache extension option
+        #
         def cache_is_current?(cache, features)
           return unless features
           return true if cache.read("arturo.current")
-          return false if features.values.map(&:updated_at).compact.max != Arturo::Feature.maximum(:updated_at)
+
+          begin
+            return false if origin_changed?(features)  
+          rescue ActiveRecord::ActiveRecordError
+            raise unless Arturo::Feature.extend_cache_on_failure?
+
+            if features.blank?
+              log_empty_cache
+              raise
+            else
+              log_stale_cache
+              update_and_extend_cache!(cache, features)
+            end
+
+            return true
+          end
           mark_as_current!(cache)
         end
 
+        def formatted_log(namespace, msg)
+          "[Arturo][#{namespace}] #{msg}"
+        end
+
+        def log_empty_cache
+          Arturo.logger.error(formatted_log('extend_cache_on_failure', 'Fallback cache is empty'))
+        end
+
+        def log_stale_cache
+          Arturo.logger.warn(formatted_log('extend_cache_on_failure', 'Falling back to stale cache'))
+        end
+
+        ##
+        # @return [True]
+        #
         def mark_as_current!(cache)
-          cache.write("arturo.current", true, :expires_in => Arturo::Feature.cache_ttl)
+          cache.write("arturo.current", true, expires_in: Arturo::Feature.cache_ttl)
+        end
+
+        ##
+        # The Arturo origin might return a big payload, so checking for the latest
+        # update is a cheaper operation.
+        #
+        # @return [Boolean] if origin has been updated since the last cache update.
+        #
+        def origin_changed?(features)
+          features.values.map(&:updated_at).compact.max != Arturo::Feature.maximum(:updated_at)
+        end
+
+        def update_and_extend_cache!(cache, features)
+          mark_as_current!(cache)
+          cache.write("arturo.all", features, expires_in: Arturo::Feature.cache_ttl * 10)
         end
       end
     end
@@ -92,7 +175,7 @@ module Arturo
         if feature = cache.read("arturo.#{symbol}")
           feature
         else
-          cache.write("arturo.#{symbol}", yield || Arturo::NoSuchFeature.new(symbol), :expires_in => Arturo::Feature.cache_ttl)
+          cache.write("arturo.#{symbol}", yield || Arturo::NoSuchFeature.new(symbol), expires_in: Arturo::Feature.cache_ttl)
         end
       end
 

data/lib/arturo/feature_factories.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-FactoryGirl.define do
+FactoryBot.define do
   sequence(:feature_symbol) { |n| "feature_#{n}".to_sym }
 
   factory :feature, :class => Arturo::Feature do

data/lib/arturo/null_logger.rb

@@ -0,0 +1,8 @@
+module Arturo
+  class NullLogger
+    %w[info debug error fatal warn].each do |level|
+      define_method level do |_message|
+      end
+    end
+  end
+end

data/lib/arturo/test_support.rb

@@ -10,7 +10,7 @@ Arturo.instance_eval do
   def enable_feature!(name)
     if feature = Arturo::Feature.find_feature(name)
       feature = feature.class.find(feature.id) if feature.frozen?
-      feature.update_attributes(:deployment_percentage => 100)
+      feature.update(:deployment_percentage => 100)
     else
       Arturo::Feature.create!(:symbol => name, :deployment_percentage => 100)
     end
@@ -25,7 +25,7 @@ Arturo.instance_eval do
   def disable_feature!(name)
     if feature = Arturo::Feature.find_feature(name)
       feature = feature.class.find(feature.id) if feature.frozen?
-      feature.update_attributes(:deployment_percentage => 0)
+      feature.update(:deployment_percentage => 0)
     end
   end
 

data/lib/arturo/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Arturo
-  VERSION = '2.4.1'
+  VERSION = '2.5.3'
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: arturo
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.5.3
 platform: ruby
 authors:
 - James A. Rosen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-09-13 00:00:00.000000000 Z
+date: 2021-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -79,7 +79,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: factory_girl
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -106,20 +106,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: wwtd
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bump
   requirement: !ruby/object:Gem::Requirement
@@ -168,6 +154,7 @@ files:
 - lib/arturo/feature_params_support.rb
 - lib/arturo/middleware.rb
 - lib/arturo/no_such_feature.rb
+- lib/arturo/null_logger.rb
 - lib/arturo/special_handling.rb
 - lib/arturo/test_support.rb
 - lib/arturo/version.rb
@@ -182,7 +169,7 @@ homepage: http://github.com/zendesk/arturo
 licenses:
 - APLv2
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -197,9 +184,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.2.2
+signing_key:
 specification_version: 4
 summary: Feature sliders, wrapped up in an engine
 test_files: []