arturo 0.2.3.4 → 0.2.3.6

data/README.md

@@ -256,6 +256,20 @@ The latter can be used like so:
       widgets
     end
 
+#### Outside a Controller
+
+If you want to check availability outside of a controller or view (really
+outside of something that has `Arturo::FeatureAvailability` mixed in), you
+can ask either
+
+    Arturo.feature_enabled_for?(:foo, recipient)
+
+or the slightly fancier
+
+    Arturo.foo_enabled_for?(recipient)
+
+Both check whether the `foo` feature exists and is enabled for `recipient`.
+
 #### Caching
 
 **Note**: Arturo does not yet have caching support. Be very careful when

data/lib/arturo.rb

@@ -3,8 +3,35 @@ module Arturo
   require 'arturo/special_handling'
   require 'arturo/feature_availability'
   require 'arturo/feature_management'
+  require 'arturo/feature_caching'
   require 'arturo/controller_filters'
   require 'arturo/range_form_support'
   require 'arturo/engine' if defined?(Rails) && Rails::VERSION::MAJOR == 2 && Rails::VERSION::MINOR == 3
 
+  class <<self
+
+    # Quick check for whether a feature is enabled for a recipient.
+    # @param [String, Symbol] feature_name
+    # @param [#id] recipient
+    # @return [true,false] whether the feature exists and is enabled for the recipient
+    def feature_enabled_for?(feature_name, recipient)
+      f = self::Feature.to_feature(feature_name)
+      f && f.enabled_for?(recipient)
+    end
+
+    ENABLED_FOR_METHOD_NAME = /^(\w+)_enabled_for\?$/
+
+    def respond_to?(symbol)
+      symbol.to_s =~ ENABLED_FOR_METHOD_NAME || super(symbol)
+    end
+
+    def method_missing(symbol, *args, &block)
+      if (args.length == 1 && match = ENABLED_FOR_METHOD_NAME.match(symbol.to_s))
+        feature_enabled_for?(match[1], args[0])
+      else
+        super(symbol, *args, &block)
+      end
+    end
+
+  end
 end

data/lib/arturo/feature_caching.rb

@@ -0,0 +1,81 @@
+module Arturo
+
+  # To be extended by Arturo::Feature if you want to enable
+  # in-memory caching.
+  # NB: Arturo's feature caching only works when using
+  # Arturo::Feature.to_feature or when using the helper methods
+  # in Arturo and Arturo::FeatureAvailability.
+  # NB: if you have multiple application servers, you almost certainly
+  # want to clear this cache after each request:
+  #
+  #   class ApplicationController < ActionController::Base
+  #     after_filter { Arturo::Feature.clear_feature_cache }
+  #   end
+  #
+  # Alternatively, you could redefine Arturo::Feature.feature_cache
+  # to use a shared cache like Memcached.
+  module FeatureCaching
+
+    def self.extended(base)
+      class <<base
+        alias_method_chain :to_feature, :caching
+        attr_accessor :cache_ttl, :feature_cache
+      end
+      base.cache_ttl = 0
+      base.feature_cache = Arturo::FeatureCaching::Cache.new
+    end
+
+    def caches_features?
+      self.cache_ttl.to_i > 0
+    end
+
+    # Wraps Arturo::Feature.to_feature with in-memory caching.
+    def to_feature_with_caching(feature_or_symbol)
+      if !self.caches_features?
+        return to_feature_without_caching(feature_or_symbol)
+      elsif (feature_or_symbol.kind_of?(Arturo::Feature))
+        feature_cache.write(feature_or_symbol.symbol, feature_or_symbol, :expires_in => cache_ttl)
+        feature_or_symbol
+      elsif (cached_feature = feature_cache.read(feature_or_symbol.to_sym))
+        cached_feature
+      elsif (f = to_feature_without_caching(feature_or_symbol))
+        feature_cache.write(f.symbol, f, :expires_in => cache_ttl)
+        f
+      end
+    end
+
+    protected
+
+    # Quack like a Rails cache.
+    class Cache
+      def initialize
+        @data = {} # of the form {key => [value, expires_at or nil]}
+      end
+      def read(name, options = nil)
+        name = name.to_s
+        value, expires_at = *@data[name]
+        if value && (expires_at.blank? || expires_at > Time.now)
+          value
+        else
+          nil
+        end
+      end
+      def write(name, value, options = nil)
+        name = name.to_s
+        expires_at = if options && options.respond_to?(:[]) && options[:expires_in]
+          Time.now + options.delete(:expires_in)
+        else
+          nil
+        end
+        value.freeze.tap do |val|
+          @data[name] = [value, expires_at]
+        end
+      end
+      def clear
+        @data.clear
+      end
+    end
+
+  end
+
+end

data/lib/arturo/test_support.rb

@@ -0,0 +1,30 @@
+Arturo.class_eval do
+
+  # Enable a feature; create it if necessary.
+  # For use in testing. Not auto-required on load. To load,
+  #
+  #   require 'arturo/test_support'
+  #
+  # @param [Symbol, String] name the feature name
+  def enable_feature!(name)
+    feature = Arturo::Feature.find_by_symbol(name)
+    if feature
+      feature.update_attributes(:deployment_percentage => 100)
+    else
+      Arturo::Feature.create(:symbol => name, :deployment_percentage => 100)
+    end
+  end
+
+  # Disable a feature if it exists.
+  # For use in testing. Not auto-required on load. To load,
+  #
+  #   require 'arturo/test_support'
+  #
+  # @param [Symbol, String] name the feature name
+  def disable_feature!(name)
+    if (feature = Arturo::Feature.find_by_symbol(name))
+      feature.update_attributes(:deployment_percentage => 0)
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: arturo
 version: !ruby/object:Gem::Version 
-  hash: 91
+  hash: 95
   prerelease: false
   segments: 
   - 0
   - 2
   - 3
-  - 4
-  version: 0.2.3.4
+  - 6
+  version: 0.2.3.6
 platform: ruby
 authors: 
 - James A. Rosen
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-04 00:00:00 -07:00
+date: 2011-04-05 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -108,6 +108,21 @@ dependencies:
         version: "1.3"
   type: :development
   version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: timecop
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 3
+        version: "0.3"
+  type: :development
+  version_requirements: *id007
 description: Deploy features incrementally to your users
 email: james.a.rosen@gmail.com
 executables: []
@@ -120,10 +135,12 @@ files:
 - lib/arturo/controller_filters.rb
 - lib/arturo/engine.rb
 - lib/arturo/feature_availability.rb
+- lib/arturo/feature_caching.rb
 - lib/arturo/feature_factories.rb
 - lib/arturo/feature_management.rb
 - lib/arturo/range_form_support.rb
 - lib/arturo/special_handling.rb
+- lib/arturo/test_support.rb
 - lib/arturo.rb
 - lib/generators/arturo/arturo_generator.rb
 - lib/generators/arturo/templates/arturo.css