rails_current 1.3.0 → 1.4.0

data/README.md

@@ -13,34 +13,49 @@ DESCRIPTION
 --------------------------------
 SYNOPSIS
 --------------------------------
+
   most rails apps scatter a bunch of @current_foobar vars everywhere.  don't do
   that.  it's fugly.  instead, do this.
 
+  declare the current_XXX variables you'll want tracked.  you can pass a block
+  for lazy computation
+
     class ApplicationController
 
       Current(:user){ User.find session[:current_user }
       Current(:account)
 
-      include Current
-
     end
 
-    ...
+  you can now access the current state two ways
+  
 
+  1) globally from anywhere in your code base
+  
 
-    if current_user
+    if Current.user
 
       ...
 
     end
 
+    Current.user = User.find(id)
+
+  2) or using the current_ methods that are added by including the Current
+  module into any class (ActionController::Base and ActionView::Base
+  automatically include it)
+  
 
-    self.current_account = Account.find(id)
+    if current_user
+
+      ...
+
+    end
 
+    self.current_user = User.find(id)
 
-  etc.
 
-  out of the box it's loaded with Current.controller
+  the Current module is cleared out before every request and is thread safe.
 
 --------------------------------
 INSTALL

data/lib/rails_current.rb

@@ -4,7 +4,7 @@ require 'map'
 
 module Current
   def Current.version
-    '1.3.0'
+    '1.4.0'
   end
 
   def Current.data
@@ -17,27 +17,45 @@ module Current
   end
 
   def Current.reset
-    calls.keys.each{|name, block| undefine_attribute_method(name) }
-    data.clear
-    calls.clear
-    self
+    attribute_names.each{|name| undefine_attribute_method(name)}
+    attribute_names.clear
+    generators.clear
+    clear
+  end
+
+  def Current.generators
+    @generators ||= Map.new
   end
 
   def Current.attribute(name, *args, &block)
-    options = Map.options_for(args)
+    options = Map.options_for!(args)
 
     name = name.to_s
-    default = options.has_key?(:default) ? options[:default] : args.shift
 
-    block ||= proc{ default }
-    calls[name] = block
+    attribute_names.push(name)
+    attribute_names.uniq!
+
+    if options.has_key?(:default)
+      default = options[:default]
+      if default.respond_to?(:call)
+        block ||= default
+      else
+        data[name] = default
+      end
+    end
+
+    if !args.empty?
+      value = args.shift
+      data[name] = value
+    end
+
+    if block
+      generators[name] = block
+    end
 
     define_attribute_method(name)
-    self
-  end
 
-  def Current.calls
-    @calls ||= Map.new
+    self
   end
 
   def Current.define_attribute_method(name)
@@ -47,7 +65,10 @@ module Current
           if data.has_key?(name)
             data[name]
           else
-            data[name] = calls[name].call
+            if generator = generators[name]
+              value = generator.call
+              data[name] = value
+            end
           end
         end
 
@@ -77,11 +98,11 @@ module Current
   end
 
   def Current.attribute?(name)
-    calls.has_key?(name)
+    attribute_names.include?(name.to_s)
   end
 
   def Current.attribute_names
-    calls.keys
+    @attribute_names ||= []
   end
 
   def Current.attributes
@@ -93,7 +114,7 @@ module Current
       when /^(.*)[=]$/
         name = $1
         value = args.shift
-        attribute(name){ value }
+        attribute(name, value)
         value
 
       when /^(.*)[?]$/
@@ -128,20 +149,33 @@ end
 
 if defined?(Rails)
 
+##
+#
   module Current
     attribute(:controller)
     attribute(:user)
+  end
 
+##
+#
+  module Current
     def Current.install_before_filter!
-      ::ActionController::Base.module_eval do
-        prepend_before_filter do |controller|
-          Current.clear
-          Current.controller = controller
+      if defined?(::ActionController::Base)
+        ::ActionController::Base.module_eval do
+          prepend_before_filter do |controller|
+            Current.clear
+            Current.controller = controller
+          end
+
+          include Current
+          helper{ include Current }
         end
-      end if defined?(::ActionController::Base)
+      end
     end
   end
 
+##
+#
   if defined?(Rails::Engine)
     class Engine < Rails::Engine
       config.before_initialize do
@@ -156,7 +190,6 @@ if defined?(Rails)
 
 end
 
-
 ::Rails_current = ::Current
 
 BEGIN {

data/rails_current.gemspec

@@ -3,7 +3,7 @@
 
 Gem::Specification::new do |spec|
   spec.name = "rails_current"
-  spec.version = "1.3.0"
+  spec.version = "1.4.0"
   spec.platform = Gem::Platform::RUBY
   spec.summary = "rails_current"
   spec.description = "description: rails_current kicks the ass"

data/test/rails_current_test.rb

@@ -122,6 +122,21 @@ Testing Current do
     assert{ Current.bar == 'forty-two' }
   end
 
+##
+#
+  test 'that dynamically added data clears cleverly' do
+    assert{ Current.foo = 42 }
+    assert{ Current.bar{ 42.0 } }
+
+    assert{ Current.foo == 42 }
+    assert{ Current.bar == 42.0 }
+
+    assert{ Current.clear }
+
+    assert{ Current.foo == nil }
+    assert{ Current.bar == 42.0 }
+  end
+
 ##
 #
   test 'that query methods on Current werky' do
@@ -132,21 +147,48 @@ Testing Current do
 
 ##
 #
-  test 'that loading Current into a rails app creates Current.user and Current.controller' do
+  test 'that loading Current into an old skool rails app creates Current.user and Current.controller' do
     mock_rails! do
       assert{ Current.attributes =~ {:user => nil, :controller => nil} }
+
+      assert do
+        Current.user = :user
+        Current.controller = :controller
+      end
+
+      assert{ ActionController::Base.new.current_user == :user }
+      assert{ ActionController::Base.new.current_controller == :controller }
+
+      assert{ ActionView::Base.new.current_user == :user }
+      assert{ ActionView::Base.new.current_controller == :controller }
     end
+  end
 
+##
+#
+  test 'that loading Current into a new skool rails app creates Current.user and Current.controller' do
     mock_rails_engine! do
       assert{ Current.attributes =~ {:user => nil, :controller => nil} }
+
       assert{ $before_initialize_called }
-      assert{ $before_filter_called }
+      assert{ $prepend_before_filter_called }
+
+      assert do
+        Current.user = :user
+        Current.controller = :controller
+      end
+
+      assert{ ActionController::Base.new.current_user == :user }
+      assert{ ActionController::Base.new.current_controller == :controller }
+
+      assert{ ActionView::Base.new.current_user == :user }
+      assert{ ActionView::Base.new.current_controller == :controller }
     end
   end
 
 ##
 #
-  teardown do
+  setup do
     assert{ Current.reset }
   end
 
@@ -156,6 +198,25 @@ private
     Object.module_eval <<-__
       module Rails
       end
+
+      module ActionController
+        class Base
+          def Base.prepend_before_filter(*args, &block)
+            block.call
+          ensure
+            $prepend_before_filter_called = true
+          end
+
+          def Base.helper(&block)
+            ActionView::Base.module_eval(&block)
+          end
+        end
+      end
+
+      module ActionView
+        class Base
+        end
+      end
     __
     $load.call()
     yield
@@ -182,13 +243,28 @@ private
 
       module ActionController
         class Base
-          def Base.before_filter(*args, &block)
-            block.call()
+          def Base.prepend_before_filter(*args, &block)
+            block.call
           ensure
-            $before_filter_called = true
+            $prepend_before_filter_called = true
+          end
+
+          def Base.helper(&block)
+            ActionView::Base.module_eval(&block)
           end
         end
       end
+
+      module ActionView
+        class Base
+        end
+      end
+
+      module ActiveSupport
+        def ActiveSupport.on_load(*args, &block)
+          block.call()
+        end
+      end
     __
     $load.call()
     yield

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_current
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-13 00:00:00.000000000 Z
+date: 2012-01-15 00:00:00.000000000 Z
 dependencies: []
 description: ! 'description: rails_current kicks the ass'
 email: ara.t.howard@gmail.com