falls_back_on 0.0.3 → 0.1.1

data/.document

@@ -0,0 +1,11 @@
+# .document is used by rdoc and yard to know how to generate documentation 
+# for example, it can be used to control how rdoc gets built when you do `gem install foo`
+
+README.rdoc
+lib/**/*.rb
+bin/*
+
+# Files below this - are treated as 'extra files', and aren't parsed for ruby code
+- 
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,11 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in falls_back_on.gemspec
+gemspec

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Derek Kastner
+Copyright (c) 2011 Seamus Abshere, Derek Kastner
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -0,0 +1,25 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rake/rdoctask'
+  Rake::RDocTask.new do |rdoc|
+    rdoc.rdoc_dir = 'rdoc'
+    rdoc.title = 'falls_back_on'
+    rdoc.options << '--line-numbers' << '--inline-source'
+    rdoc.rdoc_files.include('README*')
+    rdoc.rdoc_files.include('lib/**/*.rb')
+  end
+rescue LoadError
+   puts "Rdoc is not available"
+end
+
+task :default => :test

data/falls_back_on.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "falls_back_on/version"
+
+Gem::Specification.new do |s|
+  s.name        = "falls_back_on"
+  s.version     = FallsBackOn::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Seamus Abshere', 'Derek Kastner']
+  s.email       = ["seamus@abshere.net"]
+  s.homepage    = 'http://github.com/dkastner/falls_back_on'
+  s.summary     = 'Adds ActiveRecord::Base.falls_back_on and ActiveRecord::Base.fallback'
+  s.description = 'ActiveRecord extension to intelligently fall back on another column when a given column is unavailable'
+
+  s.rubyforge_project = "falls_back_on"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency 'cache_method'
+  s.add_dependency 'lock_method'
+  s.add_development_dependency 'test-unit'
+  s.add_development_dependency 'memcached'
+  s.add_development_dependency 'activerecord'
+  s.add_development_dependency 'sqlite3-ruby'
+  s.add_development_dependency 'weighted_average'
+  if RUBY_VERSION >= '1.9'
+    s.add_development_dependency 'ruby-debug19'
+  else
+    s.add_development_dependency 'ruby-debug'
+  end
+end

data/lib/falls_back_on.rb

@@ -1,54 +1,36 @@
-module FallsBackOn
-  def falls_back_on(options = {})
-    class_eval do
-      class_inheritable_accessor :fallback_options
-    end
-    self.fallback_options = options
-    extend FallsBackOn::InstanceMethods
-  end
+require 'cache_method'
+require 'lock_method'
 
-  module InstanceMethods
-    def class_name
-      self.to_s
-    end
+require 'falls_back_on/version'
 
-    def fallback
-      Fallback.get_for(class_name)
-    end
-    
-    def fallback_value_for(k)
-      v = fallback_options[k]
-      case v
-      when :random
-        fallback_value_for_random(k)
-      when Numeric
-        v
-      when String
-        v.upcase.starts_with?('SELECT') ? ActiveRecord::Base.connection.select_value(v) : v
-      when Proc
-        v.call
-      end
-    end
-    
-    def fallback_value_for_name
-      { :name => "Fallback #{class_name.underscore.gsub('_', ' ')}" }
-    end
-    
-    def fallback_value_for_random(k)
-      random = rand(1e8)
-      return fallback_value_for_random(k) unless send("find_by_#{k}", random).nil?
-      random
-    end
-
-    def destroy_fallback
-      Fallback.destroy_for(class_name)
-    end
+module FallsBackOn
+  autoload :Definition, 'falls_back_on/definition'
 
-    def set_fallback
-      values = {}
-      values = values.merge(fallback_value_for_name) if column_names.include?('name')
-      values = fallback_options.keys.inject({}) { |memo, k| memo.merge(k => fallback_value_for(k)) }
-      Fallback.set_for(class_name, values)
+  def self.clear
+    ::FallsBackOn::Definition.all.each { |definition| definition.clear }
+  end
+  
+  def falls_back_on(attrs)
+    definition = ::FallsBackOn::Definition.new self
+    definition.attrs = attrs
+  end
+  
+  def fallback
+    obj = new
+    definition = ::FallsBackOn::Definition.new self
+    begin
+      definition.attrs.each do |k, v|
+        obj.send "#{k}=", v
+      end
+    rescue ::LockMethod::Locked
+      $stderr.puts "#{self.to_s} was locked, retrying in 0.5 seconds..."
+      sleep 0.5
+      retry
     end
+    obj
   end
 end
+
+unless ::Class.method_defined?(:falls_back_on)
+  ::Class.send :include, ::FallsBackOn
+end

data/lib/falls_back_on/definition.rb

@@ -0,0 +1,50 @@
+module FallsBackOn
+  class Definition
+    autoload :Storage, 'falls_back_on/definition/storage'
+    
+    def self.all
+      Storage.instance.keys.map { |parent| new parent }
+    end
+    
+    attr_reader :parent
+    
+    def initialize(parent)
+      @parent = parent.to_s
+    end
+    
+    def clear
+      clear_method_cache :calculate
+      clear_method_cache :attrs
+      clear_method_lock :attrs
+    end
+    
+    def attrs=(attrs)
+      Storage.instance[parent] = attrs
+    end
+    
+    def attrs
+      Storage.instance[parent].inject({}) do |memo, (k, v)|
+        memo[k] = calculate k
+        memo
+      end
+    end
+    lock_method :attrs
+    cache_method :attrs
+        
+    def calculate(k)
+      v = Storage.instance[parent][k]
+      case v
+      when Proc
+        v.call
+      else
+        v
+      end
+    end
+    cache_method :calculate
+    
+    # for cache_method and lock_method
+    def hash
+      parent.hash
+    end
+  end
+end

data/lib/falls_back_on/definition/storage.rb

@@ -0,0 +1,8 @@
+require 'singleton'
+module FallsBackOn
+  class Definition
+    class Storage < ::Hash
+      include ::Singleton
+    end
+  end
+end

data/lib/falls_back_on/version.rb

@@ -0,0 +1,3 @@
+module FallsBackOn
+  VERSION = '0.1.1'
+end

data/test/helper.rb

@@ -0,0 +1,40 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+require 'test/unit'
+require 'active_record'
+require 'active_support/all'
+require 'weighted_average'
+require 'memcached'
+require 'timeout'
+require 'ruby-debug'
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'falls_back_on'
+
+# thanks authlogic!
+ActiveRecord::Schema.verbose = false
+begin
+  ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+rescue ArgumentError
+  ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+end
+
+my_client = Memcached.new
+CacheMethod.config.storage = my_client
+LockMethod.config.storage = my_client
+
+class Test::Unit::TestCase
+  def setup
+    CacheMethod.config.storage.flush
+    LockMethod.config.storage.flush
+    @old_abort_on_exception = Thread.abort_on_exception
+    Thread.abort_on_exception = true
+  end
+  
+  def teardown
+    Thread.abort_on_exception = @old_abort_on_exception
+  end
+end
+
+ENV['FALLS_BACK_ON_DEBUG'] = 'true'

data/test/test_falls_back_on.rb

@@ -0,0 +1,108 @@
+require 'helper'
+
+class Car1
+  attr_accessor :fuel
+  attr_accessor :random_number
+  attr_accessor :some_place_in_the_mall
+  falls_back_on :fuel => 'gasoline',
+                :random_number => lambda { rand },
+                :some_place_in_the_mall => lambda { some_place_in_the_mall }
+  def self.some_place_in_the_mall
+    "Orange Julius at #{Time.now}"
+  end
+end
+
+class Car2 < ActiveRecord::Base
+  set_table_name :cars2
+  def self.create_table
+    connection.create_table :cars2, :force => true do |t|
+      t.string :fuel
+      t.float :efficiency
+      t.integer :popularity
+    end
+  end
+  
+  attr_accessor :efficiency2
+  
+  falls_back_on  :fuel => 'diesel',
+                 :efficiency => lambda { calculate(:average, :efficiency) },
+                 :efficiency2 => lambda { weighted_average(:efficiency, :weighted_by => :popularity ) }
+end
+
+Car2.create_table
+Car2.create! :efficiency => 10.0, :popularity => 1_000_000
+Car2.create! :efficiency => 1.0, :popularity => 1
+
+class Car3
+  attr_accessor :long_running_calculation
+  falls_back_on :long_running_calculation => lambda { sleep 3 }
+end
+
+class TestFallsBackOn < Test::Unit::TestCase
+  def test_fallback
+    assert_equal 'gasoline', Car1.fallback.fuel
+  end
+  
+  def test_active_record
+    assert_equal 'diesel', Car2.fallback.fuel
+  end
+  
+  def test_proc
+    assert Car1.fallback.random_number.is_a?(Numeric)
+  end
+  
+  def test_proc_calling_class_method
+    assert(Car1.fallback.some_place_in_the_mall =~ /Orange Julius/)
+  end
+  
+  def test_active_record_calculations
+    assert_equal 5.5, Car2.fallback.efficiency
+  end
+  
+  def test_weighted_average
+    assert_equal 10, Car2.fallback.efficiency2.round
+  end
+  
+  def test_cache
+    random_number = Car1.fallback.random_number
+    assert_equal random_number, Car1.fallback.random_number
+    assert_equal random_number, Car1.fallback.random_number
+  end
+  
+  def test_retries_if_lock
+    blocker = Thread.new { Car3.fallback.long_running_calculation }
+  
+    assert_raises(::Timeout::Error) do
+      Timeout.timeout(2) do
+        Car3.fallback.long_running_calculation
+      end
+    end
+    
+    blocker.join
+  end
+  
+  def test_caches_calculations_separately
+    definition = ::FallsBackOn::Definition.new Car3
+    definition.calculate :long_running_calculation
+  end
+  
+  def test_clear
+    # sanity check
+    assert_nothing_raised do
+      Timeout.timeout(4) do
+        blocker = Thread.new { Car3.fallback.long_running_calculation }
+        sleep 1
+        Car3.fallback.long_running_calculation
+      end
+    end
+    
+    assert_raises(Timeout::Error) do
+      Timeout.timeout(4) do
+        blocker = Thread.new { Car3.fallback.long_running_calculation }
+        sleep 1
+        clearer = Thread.new { ::FallsBackOn.clear }
+        Car3.fallback.long_running_calculation
+      end
+    end
+  end
+end

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 0
-  - 3
-  version: 0.0.3
+  - 1
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Seamus Abshere
@@ -16,14 +16,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-31 00:00:00 -04:00
+date: 2011-02-24 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  name: cache_method
   prerelease: false
-  name: activerecord
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -32,12 +31,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id001
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  type: :development
+  name: lock_method
   prerelease: false
-  name: rake
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -46,12 +45,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id002
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  type: :development
+  name: test-unit
   prerelease: false
-  name: jeweler
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -60,12 +59,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id003
-- !ruby/object:Gem::Dependency 
   type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: memcached
   prerelease: false
-  name: bundler
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -74,12 +73,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id004
-- !ruby/object:Gem::Dependency 
   type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: activerecord
   prerelease: false
-  name: sqlite3-ruby
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -88,69 +87,81 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id005
+  type: :development
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: weighted_average
   prerelease: false
-  name: rspec
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 62196427
+        hash: 3
         segments: 
-        - 2
         - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
         - 0
-        - beta
-        - 20
-        version: 2.0.0.beta.20
-  requirement: *id006
-description: |
-  = falls_back_on
-  
-  Description goes here.
-  
-  == Note on Patches/Pull Requests
-   
-  * Fork the project.
-  * Make your feature addition or bug fix.
-  * Add tests for it. This is important so I don't break it in a
-    future version unintentionally.
-  * Commit, do not mess with rakefile, version, or history.
-    (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-  * Send me a pull request. Bonus points for topic branches.
-  
-  == Copyright
-  
-  Copyright (c) 2010 Derek Kastner. See LICENSE for details.
-
-email: seamus@brighterplanet.com
+        version: "0"
+  type: :development
+  version_requirements: *id008
+description: ActiveRecord extension to intelligently fall back on another column when a given column is unavailable
+email: 
+- seamus@abshere.net
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
+extra_rdoc_files: []
+
+files: 
+- .document
+- .gitignore
+- Gemfile
 - LICENSE
 - README.rdoc
-files: 
+- Rakefile
+- falls_back_on.gemspec
 - lib/falls_back_on.rb
-- lib/falls_back_on/active_record_ext.rb
-- lib/falls_back_on/app/models/fallback.rb
+- lib/falls_back_on/definition.rb
+- lib/falls_back_on/definition/storage.rb
+- lib/falls_back_on/version.rb
 - rails/init.rb
-- LICENSE
-- README.rdoc
-- spec/lib/falls_back_on/app/models/fallback_spec.rb
-- spec/lib/falls_back_on_spec.rb
-- spec/spec_helper.rb
+- test/helper.rb
+- test/test_falls_back_on.rb
 has_rdoc: true
 homepage: http://github.com/dkastner/falls_back_on
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -173,12 +184,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: falls_back_on
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: ActiveRecord extension to intelligently fall back on another column when a given column is unavailable
+summary: Adds ActiveRecord::Base.falls_back_on and ActiveRecord::Base.fallback
 test_files: 
-- spec/lib/falls_back_on/app/models/fallback_spec.rb
-- spec/lib/falls_back_on_spec.rb
-- spec/spec_helper.rb
+- test/helper.rb
+- test/test_falls_back_on.rb

data/lib/falls_back_on/active_record_ext.rb

@@ -1,5 +0,0 @@
-require 'falls_back_on/app/models/fallback'
-
-ActiveRecord::Base.class_eval do
-  extend FallsBackOn
-end

data/lib/falls_back_on/app/models/fallback.rb

@@ -1,35 +0,0 @@
-class Fallback < ActiveRecord::Base
-  index :name if respond_to? :index
-  
-  serialize :values
-  
-  class << self
-    def get_for(name)
-      klass = name.constantize
-      if fallback = find_by_name(name)
-        begin
-          f = klass.new(fallback.values)
-        rescue ActiveRecord::UnknownAttributeError
-          raise $!, "while trying to use #{fallback.values.inspect} with #{name} #{$!.inspect}"
-        end
-        f.readonly!
-        f
-      elsif klass.set_fallback
-        get_for(name)
-      end
-    end
-    
-    def set_for(name, values = {})
-      raise "fallback race condition" if Fallback.count > 100
-      fallback = find_or_create_by_name(name)
-      fallback.update_attributes(:values => values)
-      true
-    end
-    
-    def destroy_for(name)
-      fallback = find_by_name(name.to_s)
-      fallback.destroy unless fallback.nil?
-      true
-    end
-  end
-end

data/spec/lib/falls_back_on/app/models/fallback_spec.rb

@@ -1,19 +0,0 @@
-require 'spec_helper'
-
-class Arcade < ActiveRecord::Base
-  attr_accessor :pinball_count, :video_game_count
-
-  falls_back_on :pinball_count => 73
-end
-
-describe Fallback do
-  describe '.destroy_for' do
-    it 'should destroy a fallback' do
-      Fallback.create :name => 'Arcade'
-      expect do
-        Fallback.destroy_for Arcade
-      end.should change(Fallback, :count).by(-1)
-    end
-  end
-end
-

data/spec/lib/falls_back_on_spec.rb

@@ -1,24 +0,0 @@
-require 'spec_helper'
-
-class State < ActiveRecord::Base
-  falls_back_on :area => 10000
-end
-
-describe FallsBackOn do
-  describe '.class_name' do
-    it 'should return the class name' do
-      State.class_name.should == 'State'
-    end
-  end
-
-  describe '.set_fallback' do
-    it 'should create a Fallback for a class' do
-      State.set_fallback
-
-      fallback = Fallback.find_by_name 'State'
-      fallback.should be_an_instance_of(Fallback)
-      fallback.values.should == {:area => 10000 }
-    end
-  end
-end
-

data/spec/spec_helper.rb

@@ -1,33 +0,0 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-
-require 'active_record'
-require 'logger'
-
-$:.unshift File.expand_path('../lib', __FILE__)
-require 'falls_back_on'
-require 'falls_back_on/active_record_ext'
-require 'falls_back_on/app/models/fallback'
-
-ActiveRecord::Base.logger = Logger.new nil
-ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => ':memory:'
-
-ActiveRecord::Schema.define(:version => 1) do
-  create_table "fallbacks", :force => true do |t|
-    t.string   "name"
-    t.text     "values"
-    t.datetime "created_at"
-    t.datetime "updated_at"
-  end
-
-  create_table 'states' do |t|
-    t.integer 'area'
-  end
-end