reference_tracking 0.0.1

data/lib/reference_tracking.rb

@@ -0,0 +1,13 @@
+require 'active_support/core_ext/kernel/singleton_class'
+require 'action_controller'
+
+module ReferenceTracking
+  TAGS_HEADER = 'rack-cache.tags'
+
+  autoload :ActionController, 'reference_tracking/action_controller'
+  autoload :IvarProxy,        'reference_tracking/ivar_proxy'
+  autoload :Tracker,          'reference_tracking/tracker'
+  autoload :References,       'reference_tracking/references'
+end
+
+ActionController::Base.send(:extend, ReferenceTracking::ActionController::ActMacro)

data/lib/reference_tracking/action_controller.rb

@@ -0,0 +1,40 @@
+module ReferenceTracking
+  module ActionController
+    module ActMacro
+      def tracks(*args)
+        unless tracks_references?
+          include ReferenceTracking::ActionController
+
+          class_inheritable_accessor :reference_tracking_options
+          self.reference_tracking_options = { :header => TAGS_HEADER }
+        end
+
+        options = args.extract_options!
+        actions = Array(options.delete(:only) || [:index, :show]) - Array(options.delete(:except))
+        args << options unless options.empty?
+
+        actions.map(&:to_sym).each do |action|
+          self.reference_tracking_options[action] ||= []
+          self.reference_tracking_options[action] += args
+        end
+      end
+
+      def tracks_references?
+        respond_to?(:reference_tracking_options) && reference_tracking_options.present?
+      end
+    end
+
+    # TODO could this hook into instrumentation?
+    # ActiveSupport::Notifications.instrument("render_template.action_view", ...)?
+
+    def render(*)
+      methods = reference_tracking_options[params[:action].to_sym] || {}
+      @_references = ReferenceTracking::References.new(self, methods)
+
+      result = super
+
+      headers[reference_tracking_options[:header]] = @_references.tags
+      result
+    end
+  end
+end

data/lib/reference_tracking/ivar_proxy.rb

@@ -0,0 +1,26 @@
+module ReferenceTracking
+  class IvarProxy
+    instance_methods.each { |m| undef_method(m) unless %w(__send__ __id__ inspect).include?(m) }
+
+    def initialize(owner, name, object, references)
+      @owner      = owner
+      @name       = name
+      @object     = object
+      @references = references
+    end
+
+    def respond_to?(method)
+      @object.respond_to?(method)
+    end
+
+    def method_missing(method, *args, &block)
+      respond_to?(method) ? __track__(method, *args, &block) : super
+    end
+
+    def __track__(method, *args, &block)
+      @references << [@object, nil]
+      @owner.instance_variable_set(@name, @object)
+      @object.send(method, *args, &block)
+    end
+  end
+end

data/lib/reference_tracking/references.rb

@@ -0,0 +1,13 @@
+module ReferenceTracking
+  class References < Array
+    def initialize(object, methods)
+      Tracker.setup(object, self, methods)
+    end
+
+    def tags
+      map do |object, method| 
+        "#{object.class.name.underscore}-#{object.id}#{":#{method}" if method}"
+      end.uniq
+    end
+  end
+end

data/lib/reference_tracking/tracker.rb

@@ -0,0 +1,56 @@
+# tracks :post                    # => tags post-1.*
+# tracks 'post.title'             # => tags post-1.title
+# tracks :post => :blog           # => tags blog-1.*
+# tracks :blog => :posts          # => tags post-1.*, post-1.*, ...
+
+require 'active_support/core_ext/array/wrap'
+
+module ReferenceTracking
+  module Tracker
+    class << self
+      def setup(object, references, targets, options = {})
+        Array.wrap(targets).each do |target|
+          if target.is_a?(Hash)
+            target.each { |target, nested| delegate_tracking(object, references, target, nested) }
+          elsif options[:delegated]
+            send(options[:delegated], object, references, target)
+          elsif target.to_s.include?('.')
+            delegate_tracking(object, references, *target.to_s.split('.') << :track_calls_to)
+          else
+            track_calls_on(object, references, target)
+          end
+        end
+      end
+
+      def tracker_for(object)
+        Module.new.tap { |tracker| object.singleton_class.send(:include, tracker) }
+      end
+
+      def track_calls_on(object, references, target)
+        tracker_for(object).send(:define_method, target) do |*args|
+          super.tap { |object| Array(object).each { |object| references << [object, nil] } }
+        end
+      end
+
+      def track_calls_to(object, references, method)
+        method = method.to_s.split('.').last if method.to_s.include?('.')
+        tracker_for(object).send(:define_method, method) do |*args|
+          references << [self, method]
+          super
+        end
+      end
+
+      def delegate_tracking(object, references, target, delegateds, method = :track_calls_on)
+        tracker_for(object).send(:define_method, target) do |*|
+          super.tap do |object| 
+            Array.wrap(delegateds).each do |delegated|
+              delegated = [delegated] if delegated.is_a?(Hash)
+              _method = delegated.to_s.start_with?('.') ? :track_calls_to : method
+              Tracker.setup(object, references, delegated, :delegated => _method)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/reference_tracking/version.rb

@@ -0,0 +1,3 @@
+module ReferenceTracking
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: reference_tracking
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Sven Fuchs
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-04 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: "[description]"
+email: svenfuchs@artweb-design.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/reference_tracking.rb
+- lib/reference_tracking/action_controller.rb
+- lib/reference_tracking/ivar_proxy.rb
+- lib/reference_tracking/references.rb
+- lib/reference_tracking/tracker.rb
+- lib/reference_tracking/version.rb
+has_rdoc: true
+homepage: http://github.com/svenfuchs/reference_tracking
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: "[none]"
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: "[summary]"
+test_files: []
+