context_exposer 0.1.0 → 0.3.0

data/lib/context_exposer/cached_resource_controller.rb

@@ -0,0 +1,10 @@
+module ContextExposer::CachedResourceController
+  extend ActiveSupport::Concern
+  include ContextExposer::ResourceController
+
+  module ClassMethods
+    def _exposing name, options = {}, &block
+      expose_cached name, options, &block
+    end
+  end
+end

data/lib/context_exposer/integrations.rb

@@ -0,0 +1,8 @@
+module ContextExposer
+  module Integrations
+  end
+end
+
+%w{base key_filter with_decent_exposure with_decorates_before with_instance_vars}.each do |name|
+  require "context_exposer/integrations/#{name}"
+end

data/lib/context_exposer/integrations/base.rb

@@ -0,0 +1,15 @@
+module ContextExposer
+  module Integrations
+    module Base
+      extend ActiveSupport::Concern
+      
+      protected
+
+      module ClassMethods
+        def _exposure_filter keys, options = {}
+          ::ContextExposer::Integrations::KeyFilter.new(keys, options).filter
+        end
+      end
+    end
+  end
+end

data/lib/context_exposer/integrations/key_filter.rb

@@ -0,0 +1,30 @@
+module ContextExposer
+  module Integrations
+    class KeyFilter
+      attr_reader :keys, :options
+
+      def initialize keys, options = {}
+        @keys = keys || []
+        @options = options
+      end
+
+      # expose all exposures exposed by decent_exposure to context
+      def filter
+        the_keys = keys - except
+        only.empty? ? the_keys : the_keys.select {|k| only.include? k.to_sym } 
+      end
+
+      def except
+        @except ||= symbolize_opts :except
+      end
+
+      def only
+        @only ||= symbolize_opts :only
+      end
+
+      def symbolize_opts name 
+        (options[name.to_sym] || {}).map(&:to_sym)
+      end
+    end
+  end
+end

data/lib/context_exposer/integrations/with_decent_exposure.rb

@@ -0,0 +1,19 @@
+module ContextExposer::Integrations
+  module WithDecentExposure
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # expose all exposures exposed by decent_exposure to context
+      def context_expose_decently options = {}
+        expose_keys = _exposures.keys
+
+        _exposure_filter(expose_keys, options).each do |exposure|
+          exposed exposure do
+            send(exposure)
+          end
+        end
+      end
+      alias_method :expose_decently, :context_expose_decently       
+    end
+  end
+end

data/lib/context_exposer/integrations/with_decorates_before.rb

@@ -0,0 +1,31 @@
+module ContextExposer::Integrations
+  module WithDecoratesBefore
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # expose all exposures exposed by decent_exposure to context
+      def context_expose_decorated_instance_vars options = {}
+        coll_decorates  = __decorates_collection__[0..-1]
+        basic_decorates = __decorates__[0..-1]
+
+        all_decorates  = case options[:for]
+        when :collection
+          coll_decorates
+        when :non_collection
+          basic_decorates
+        else
+          coll_decorates + basic_decorates
+        end
+        
+        expose_keys     = all_decorates.map {|v| v[1..-1]}
+
+        _exposure_filter(keys, options).each do |exposure|
+          exposed exposure do
+            send("@#{exposure}")
+          end
+        end
+      end
+      alias_method :expose_decorated_instance_vars, :context_expose_decorated_instance_vars
+    end
+  end
+end

data/lib/context_exposer/integrations/with_instance_vars.rb

@@ -0,0 +1,19 @@
+module ContextExposer::Integrations
+  module WithInstanceVars
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # expose all exposures exposed by decent_exposure to context
+      def context_expose_instance_vars options = {}
+        expose_keys = self.instance_variables.map {|v| v[1..-1]}
+
+        _exposure_filter(expose_keys, options).each do |exposure|
+          exposed exposure do
+            send("@#{exposure}")
+          end
+        end
+      end
+      alias_method :expose_instance_vars, :context_expose_instance_vars
+    end
+  end
+end

data/lib/context_exposer/macros.rb

@@ -0,0 +1,17 @@
+module ContextExposer
+  module Macros
+    def context_exposer name = :base, options = {}
+      self.send :include, "ContextExposer::#{name.to_s.camelize}Controller".constantize
+      
+      integrates_with [options[:with]].flatten if options[:with]
+    end
+
+    def decorates_before_rendering
+      unless defined? ::DecoratesBeforeRendering
+        raise "DecoratesBeforeRendering not found, please include the gem 'decorates_before_rendering'"
+      end
+      self.send :include, DecoratesBeforeRendering
+    end
+    alias_method :decorates_before_render, :decorates_before_rendering
+  end
+end

data/lib/context_exposer/patch/decorates_before_rendering.rb

@@ -0,0 +1,179 @@
+module DecoratesBeforeRendering  
+  class FindModelError < StandardError; end
+  class DecoratorError < StandardError; end
+
+  def render *args
+    __auto_decorate_exposed_ones_
+    super(*args)
+  end
+
+  def __auto_decorate_exposed_ones_
+    __decorate_ivars__
+    __decorate_exposed_ones_
+    __decorate_ctx_exposed_ones_    
+  rescue StandardError => e
+    __handle_decorate_error_(e)
+  end
+
+  def __handle_decorate_error_ e 
+    # puts "Error: #{e}"
+
+    if defined?(::Rails) && (Rails.respond_to? :logger)
+      Rails.logger.warn 'decorates_before_render: auto_decorate error: #{e}'
+    end
+  end
+
+  def __exposed_ones_
+    return [] unless self.class.respond_to? :_exposures
+    @__exposed_ones_ ||= self.class._exposures.keys
+  end
+
+  def __ctx_exposed_ones_
+    return [] unless self.class.respond_to? :_exposure_storage
+    @__ctx_exposed_ones_ ||= self.class._exposure_storage.keys
+  end
+
+  def __decorate_exposed_ones_
+    __exposed_ones_.each do |name|
+      ivar_name = "@#{name}"
+      obj = send(name)
+      decorated = __attempt_to_decorate_(obj)
+
+      decorated = case objs
+      when Array
+        __attempt_to_decorate_list_ objs        
+      else
+        __attempt_to_decorate_ objs
+      end
+
+      send(:instance_variable_set, ivar_name, decorated)  # if decorated
+    end
+  end
+
+  def __decorate_ctx_exposed_ones_
+    __ctx_exposed_ones_.each do |name|
+      ivar_name = "@#{name}"
+      objs = ctx.send(name)
+
+      decorated = case objs
+      when Array
+        __attempt_to_decorate_list_ objs        
+      else
+        __attempt_to_decorate_ objs
+      end
+
+      ctx.send(:instance_variable_set, ivar_name, decorated) # if decorated
+    end
+  end
+
+  def __attempt_to_decorate_list_ objs
+    [objs].flatten.compact.map do |obj|
+      __attempt_to_decorate_(obj)      
+    end    
+  end
+
+  def __attempt_to_decorate_ obj
+    if obj
+      src = __src_for__(obj)
+      decorator = __normalized_decorator_for__(src)
+      __do_decoration_ decorator, obj
+    end
+  end    
+
+  def __do_decoration_ decorator, obj
+    return if !decorator || !obj
+    __validate_decorator!(decorator)
+    decorator.decorate(obj)
+  end
+
+
+  def __validate_decorator! decorator
+    unless decorator.respond_to? :decorate
+      raise DecoratorError, "Decorator: #{decorator} must have a #decorate method"
+    end
+  end
+
+  def __decorate_error! decorator
+    raise DecoratorError, "Decorator: #{decorator} must have a #decorate method"
+  end
+
+  def __src_for__ obj
+    case obj
+    when Class
+      obj.class
+    else 
+      obj      
+    end
+  end    
+
+  def __normalized_decorator_for__(obj)
+    decorator = __decorator_for__(obj)
+
+    case decorator
+    when String
+      decorator.constantize.new obj
+    when Class
+      decorator.new obj
+    else
+      decorator
+    end
+  end    
+
+  def __decorator_for__(obj)
+    return obj.decorator(self) if obj.respond_to? :decorator
+      __decorator_name_for__(obj).constantize
+  rescue FindModelError => e
+    nil
+  end
+
+  def __decorator_name_for__(obj)
+    "#{__model_name_for__(obj)}Decorator"
+  end
+
+  def __model_name_for__(obj)
+    return obj.model_name if obj.respond_to?(:model_name)
+    raise FindModelError, "#{obj} does not have an associated model"
+  end  
+
+  def __decorate_ivars__
+    __validate_decorates_present_
+    return if __decorates_blank?
+    __decorates__ivars
+    __decorates_collection_ivars__
+  end
+
+  def __validate_decorates_present_
+    unless __has_decorates?
+      raise "Internal method '__decorates__' not found. You need to include the 'decorates_before_render' gem " 
+    end
+  end
+
+  def __has_decorates?
+    respond_to?(:__decorates__)
+  end
+
+  def __decorates_blank?
+    __decorates__.blank? and __decorates_collection__.blank?
+  end
+
+  def __decorates_collection_ivars__
+    if !__decorates_collection__.nil?
+      __decorate_ivar_names__(__decorates_collection__) do |ivar_name, ivar, options|
+        decorated = options.fetch(:with).decorate_collection(ivar)
+        instance_variable_set(ivar_name, decorated) if decorated
+      end
+    end
+  end
+
+  def __decorates__ivars
+    if !__decorates__.nil?
+      __decorate_ivar_names__(__decorates__) do |ivar_name, ivar, options|
+        decorator = options.key?(:with) ? options.fetch(:with) : __decorator_for__(ivar)
+        if decorator
+          decorated = __do_decoration_(decorator, ivar)
+          instance_variable_set(ivar_name, decorated)
+        end
+      end
+    end
+  end   
+end 

data/lib/context_exposer/rails_config.rb

@@ -0,0 +1,3 @@
+ActiveSupport.on_load(:action_controller) do
+  extend ContextExposer::Macros
+end

data/lib/context_exposer/resource_controller.rb

@@ -3,18 +3,35 @@ module ContextExposer::ResourceController
   include ContextExposer::BaseController
 
   included do
-    puts "included: #{_normalized_resource_name}"
-
-    exposed(_normalized_resource_name.singularize) do
-      find_single_resource
-    end
-
-    exposed(_normalized_resource_name.pluralize)    { find_all_resources }
-    exposed(_normalized_resource_list)              { find_all_resources.to_a }
+    expose_resources
   end
 
   protected
 
+  module ClassMethods
+    def expose_resources *types
+      types = types.flatten
+      types = types.empty? ? [:all] : types
+
+      unless expose_resource_method? :one, types
+        _exposing(_normalized_resource_name.singularize)  { find_single_resource    }
+      end
+
+      unless expose_resource_method? :many, types
+        _exposing(_normalized_resource_name.pluralize)    { find_all_resources      }
+      end
+
+      unless expose_resource_method? :list, types
+        _exposing(_normalized_resource_list)              { find_all_resources.to_a }
+      end
+    end    
+
+    def expose_resource_method? type, types
+      ([type, :all] & types).empty?
+    end
+  end  
+
+
   def resource_id
     params[:id]
   end
@@ -28,6 +45,11 @@ module ContextExposer::ResourceController
   end
 
   module ClassMethods
+    # for use in ResourceController
+    def _exposing name, options = {}, &block
+      exposed name, options, &block
+    end
+    
     def _the_resource
       clazz_name = self.to_s.sub(/Controller$/, '').singularize
       clazz_name.constantize

data/lib/context_exposer/version.rb

@@ -1,3 +1,3 @@
 module ContextExposer
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/context_exposer/view_context.rb

@@ -10,5 +10,5 @@ class ContextExposer::ViewContext
   def define_singleton_method(name, &block)
     eigenclass = class<<self; self end
     eigenclass.class_eval {define_method name, block}
-  end    
+  end
 end

data/spec/app/items_spec.rb

@@ -0,0 +1,36 @@
+# Run Capybara Spec on Dummy app PostsController
+
+require 'dummy_spec_helper'
+
+feature 'show list of items' do
+  let(:names) { ['Item 1', 'Item 2'] }
+  let(:name)  { names.first }
+
+
+  before :each do
+    names.each{|n| Item.new n }
+
+    visit items_path
+  end
+
+  context '2 items' do
+    scenario 'display item 1 and 2' do
+      page.should have_content names.first
+      page.should have_content names.last
+    end
+  end
+end
+
+feature 'show item' do
+  let(:name)  { 'Item 1' }
+
+  before do
+    Item.new name
+  end
+
+  scenario 'display one item' do
+    visit item_path(1)
+
+    page.should have_content "A very nice #{name}"
+  end
+end