the_force 0.1.0 → 0.2.0

data/Rakefile

@@ -7,13 +7,13 @@ exclude_file_globs = []
 
 spec = Gem::Specification.new do |s| 
   s.name              = "the_force"
-  s.version           = '0.1.0'
+  s.version           = '0.2.0'
   s.author            = "Ryan Ziegler"
   s.email             = "info@symbolforce.com"
   s.homepage          = "http://www.symbolforce.com"
   s.platform          = Gem::Platform::RUBY
   s.summary           = "Common code for Symbolforce"
-  s.description       = "Common code for Symbolforce. tests pass in 1.8.6, 1.8.7, 1.9.1, and jruby 1.4"
+  s.description       = "Common code for Symbolforce"
   s.files             = FileList[include_file_globs].to_a - FileList[exclude_file_globs].to_a
   s.require_path      = "lib"
   s.test_files        = FileList["test/**/test_*.rb"].to_a

data/lib/the_force/memoize.rb

@@ -0,0 +1,27 @@
+#CRZ - any reason to support parameters in the block? would need instance_exec, and maybe some compat instance_exec for pre-1.8.7 rubies...
+
+module TheForce
+  module ObjectSupport
+    module Memoization
+      def attr_memoize(attribute, &b)
+        raise ArgumentError, "attr_memoize requires a block" unless block_given?
+        
+        ivar = "@#{attribute}"
+        self.class_eval do
+          define_method attribute.to_sym do |*args|
+            refresh = !!args[0]
+            if not instance_variable_defined?(ivar) or refresh
+              instance_variable_set(ivar, instance_eval(&b))
+            else
+              instance_variable_get(ivar)
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+class Object
+  extend TheForce::ObjectSupport::Memoization 
+end

data/lib/the_force/object_support.rb

@@ -1,41 +1,21 @@
+#--
 #CRZ - imitate andand to a great degree. 
 #      Could have something more complex than if or unless, but they're enough, and didnt want to introduce proc overhead.
 #    - logic duplication, three ""inverted^ return ? caller : nil""s
 ###  - better behavior for args WITH a block?
 
-if Module.constants.include?('BasicObject')
-  class ConditionalReturningMe < BasicObject
-  end
-else
-  class ConditionalReturningMe
-    instance_methods.reject { |m| m =~ /^__/ }.each { |m| undef_method m }
-  end
-end
-
-class ConditionalReturningMe
-  def initialize(me, inverted)
-    super()
-    @me = me
-    @inverted = inverted
-  end
-
-  def method_missing(sym, *args, &b)
-    (@inverted ^ @me.send(sym, *args, &b)) ? @me : nil
-  end
-end
-
 module TheForce
   module ObjectSupport
-    def if(*args, &b)
-      ObjectSupport.conditional(self, false, *args, &b)
-    end
-
-    def unless(*args, &b)
-      ObjectSupport.conditional(self, true, *args, &b)
+    if Module.constants.include?('BasicObject')
+      class ConditionalReturningMe < BasicObject
+      end
+    else
+      class ConditionalReturningMe
+        instance_methods.reject { |m| m =~ /^__/ }.each { |m| undef_method m }
+      end
     end
-
-    private
-    def self.conditional(who, inverted, *args, &b)
+    
+    def self.conditional(who, inverted, *args, &b) # :doc:
       if block_given?
         (inverted ^ yield(who)) ? who : nil
       elsif args.length > 0
@@ -44,9 +24,65 @@ module TheForce
         ConditionalReturningMe.new(who, inverted)
       end
     end
+
+    # This is the blankslate object returned by the Object#if and Object#unless methods when called with no arguments or block.
+    class ConditionalReturningMe
+      def initialize(me, inverted)
+        super()
+        @me = me
+        @inverted = inverted
+      end
+
+      def method_missing(sym, *args, &b) # :doc:
+        (@inverted ^ @me.send(sym, *args, &b)) ? @me : nil
+      end
+    end
+
+    module InstanceMethods
+      # Will return a nil if the condition is false, otherwise it will return the receiver. The condition 
+      # can be specified in 3 ways, as a list of arguments which are sent to Object#send, a block, or via essentially a 
+      # delegate object, ala the andand gem.
+      #
+      # == Examples
+      # - 10.if(:>, 5)            => 10
+      # - 10.if {|x| x == 5)      => nil
+      # - 10.if.nonzero?          => 10
+      #
+      # == Usage
+      # This becomes useful to simplify logic when you want to specify a default value,
+      # (particularly in Rails views) or you have a receiver which is the result of a lengthy expression.
+      #
+      # * number_of_products.if.nonzero? || "Don't you want to buy something?"
+      # * lovers.sort.reverse.unless.empty? || "Where's the fever? :("
+      #
+      # == Warning
+      # Do not try to do:
+      #   
+      # * title.if.length > 20 || title.truncate[0,17] + "..."
+      #
+      # This would evaluate to:
+      #
+      # * title > 20 || title.truncate(17) + "..."
+      def if(*args, &b)
+        TheForce::ObjectSupport.conditional(self, false, *args, &b)
+      end
+
+      # Same as +if+, only with the predictably inverse logic.
+      #
+      # == Usage
+      # * title.unless.blank? || suggestion_html "please set your title on the edit page"
+      def unless(*args, &b)
+        TheForce::ObjectSupport.conditional(self, true, *args, &b)
+      end
+
+      def eigenclass #this could also be labeled 'self'?
+        class << self; self; end
+      end
+
+    end
   end
 end
 
 class Object
-  include TheForce::ObjectSupport
+  include TheForce::ObjectSupport::InstanceMethods
 end

data/lib/the_force/remote_includes.rb

@@ -0,0 +1,63 @@
+module TheForce
+  module RemoteIncludes
+    @@remotes = []
+    
+    def self.[](name)
+      @@remotes.detect {|remote| remote.name == name }
+    end
+    
+    def self.remotes
+      @@remotes
+    end
+    
+    def self.add(attrs)
+      attrs[:name] ||= attrs[:url]
+      @@remotes << RemoteInclude.new(attrs) unless attrs[:url].blank?
+    end
+    
+    def self.cache_url_with_partial_fallback(url, key, partial = nil)
+      begin
+        response = Net::HTTP.get_response(URI.parse(url))
+        Rails.cache.write(key, response.body) if response.class == Net::HTTPOK
+      rescue Exception => e
+      ensure
+        cache_from_partial(key, partial) if partial and not Rails.cache.read(key)
+      end
+    end
+    
+    def self.cache_from_partial(key, partial)
+      av = ActionView::Base.new(Rails::Configuration.new.view_path)
+      Rails.cache.write(key, av.render(:partial => partial))
+    end
+    
+    def self.recache!
+      Array(@@remotes).each do |remote|
+        remote.recache!
+      end
+    end
+  end
+  
+  class RemoteInclude < OpenStruct
+    def [](key)
+      self.send(key.to_sym)
+    end
+    
+    def key
+      name
+    end
+    
+    def value
+      Rails.cache.read(key)
+    end
+    
+    def recache!
+      RemoteIncludes.cache_url_with_partial_fallback(self.url, self.name, self.backup_partial)
+    end
+    
+    def last_cached_at
+      return nil unless Rails.cache.instance_of? ActiveSupport::Cache::FileStore
+
+      File.mtime(Rails.cache.instance_eval("real_file_path('#{self.key}')")) rescue nil
+    end
+  end
+end

data/lib/the_force.rb

@@ -3,4 +3,5 @@ require File.join(ROOT, 'keep_trying')
 require File.join(ROOT, 'thread_pool')
 require File.join(ROOT, 'timer')
 #require File.join(ROOT, 'object_support')
+require File.join(ROOT, 'remote_includes')
 true

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+#require 'active_support/testing/assertions'
+
+begin
+  require 'redgreen'
+rescue LoadError
+end

data/test/unit/test_memoize.rb

@@ -0,0 +1,65 @@
+require 'test/unit'
+require 'memoize'
+
+class Memoizer
+  def initialize
+    @value = 1
+    @other = 2
+  end
+  
+  def inc
+    @value +=1
+  end
+  
+  def meth
+    3
+  end
+  
+  attr_memoize :a do
+    @value
+  end
+  
+  attr_memoize :test_instance_variable_access do
+    @other
+  end
+  
+  attr_memoize :test_instance_method_access do
+    meth
+  end
+end
+
+class TestMemoize < Test::Unit::TestCase
+  def setup
+    @m = Memoizer.new
+  end
+  
+  def test_raises_error_with_no_block
+    assert_raise ArgumentError do
+      Memoizer.class_eval('attr_memoize :b')
+    end
+  end
+
+  def test_memoizes_first_time
+    assert_equal 1, @m.a
+  end
+
+  def test_can_refer_to_instance_variables_inside_block
+    assert_equal 2, @m.test_instance_variable_access
+  end
+
+  def test_can_call_instance_method_inside_block
+    assert_equal 3, @m.test_instance_method_access    
+  end
+  
+  def test_does_not_rememoize_second_time
+    @m.a
+    @m.inc
+    assert_equal 1, @m.a
+  end
+  
+  def test_memoizes_again_after_refresh
+    @m.a
+    @m.inc
+    assert_equal 2, @m.a(true)
+  end
+end

data/test/unit/test_object_support.rb

@@ -1,9 +1,5 @@
 require 'test/unit'
-begin
-  require File.join(File.dirname(__FILE__), '../../lib/the_force/object_support.rb') 
-rescue LoadError
-  require File.expand_path('../../lib/the_force/object_support.rb', __FILE__) 
-end
+require 'object_support'
 
 begin
   require 'active_support'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: the_force
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Ryan Ziegler
@@ -15,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-20 00:00:00 -04:00
+date: 2010-10-03 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
-description: Common code for Symbolforce. tests pass in 1.8.6, 1.8.7, 1.9.1, and jruby 1.4
+description: Common code for Symbolforce
 email: info@symbolforce.com
 executables: []
 
@@ -33,11 +33,15 @@ files:
 - Rakefile
 - init.rb
 - lib/the_force/keep_trying.rb
+- lib/the_force/memoize.rb
 - lib/the_force/object_support.rb
+- lib/the_force/remote_includes.rb
 - lib/the_force/thread_pool.rb
 - lib/the_force/timer.rb
 - lib/the_force.rb
+- test/test_helper.rb
 - test/unit/test_keep_trying.rb
+- test/unit/test_memoize.rb
 - test/unit/test_object_support.rb
 has_rdoc: true
 homepage: http://www.symbolforce.com
@@ -75,5 +79,7 @@ signing_key:
 specification_version: 3
 summary: Common code for Symbolforce
 test_files: 
+- test/test_helper.rb
 - test/unit/test_keep_trying.rb
+- test/unit/test_memoize.rb
 - test/unit/test_object_support.rb