xhive 1.4.0.pre → 1.5.0.pre

data/README.md

@@ -268,6 +268,26 @@ end
 
 Using this feature you can let the designers implement the HTML/CSS to display the posts in your site without your intervention.
 
+## Policy based mapping
+
+If you need more customization in the page mapping process, you can pass a policy class name as the last attribute.
+
+```ruby
+class MyPolicyClass
+  def call(opts={})
+    opts[:user].country == 'US' && opts[:user].age > 18
+  end
+end
+
+mapper = Xhive::Mapper.map_resource(site, posts_page, 'posts', 'index', post.id, 'MyPolicyClass')
+
+# It will only use the page if the user is an adult from the US
+render_page_with @post.id, :post => @post, :user => @user
+
+```
+Note: the mailer instance variables will be passed along to the policy class. This allows you to customize the email templates
+depending on the user properties. See below for ActionMailer integration.
+
 ## ActionMailer integration
 
 Using xhive you can extend the CMS capabilities to your system generated emails.
@@ -316,6 +336,9 @@ mapper.page = email_for_spanish_users
 mapper.save
 ```
 
+Note: the page title will be used as the email subject. You can also make use of the instance variables
+inside the page title as is treated as a Liquid template string.
+
 ### Inline stylesheets for your emails
 
 If you add the inline widget to your cell routes you can use inline stylesheets within your email pages:
@@ -346,14 +369,17 @@ Then you can add your inline page into your email page using the corresponding t
 
 `{% inline_page id:email_header %}`
 
-TODO
-====
+## TODO
 
 * Remove as many dependencies as possible
 * Improve test coverage
 
-Disclaimer
-==========
+## Disclaimer
+
 This is a work in progress and still a proof of concept. Use at your own risk.
 
 Please let me know of any problems, ideas, improvements, etc.
+
+## Special Thanks
+
+* Thanks to [Daniel Cadenas](https://github.com/dcadenas) for the Policy class inspiration.

data/app/helpers/xhive/application_helper.rb

@@ -17,7 +17,7 @@ module Xhive
     # Returns: the rendered page.
     #
     def render_page_with(key = nil, options={}, &block)
-      page = Xhive::Mapper.page_for(current_site, controller_path, action_name, key)
+      page = Xhive::Mapper.page_for(current_site, controller_path, action_name, key, options)
       if page.present?
         render :inline => page.present_content(options), :layout => true
       else

data/app/models/xhive/mapper.rb

@@ -2,7 +2,7 @@ module Xhive
   # Maps resources to pages.
   #
   class Mapper < ActiveRecord::Base
-    attr_accessible :action, :page_id, :site_id, :resource, :key
+    attr_accessible :action, :page_id, :site_id, :resource, :key, :policy
 
     belongs_to :site
     belongs_to :page
@@ -18,11 +18,12 @@ module Xhive
     # resource - The String containing the resource name filter.
     # action   - The String containing the action name filter.
     # key      - The String containing the key filter.
+    # opts     - The Hash containing extra values for policy-based filters.
     #
     # Returns: the mapped page or nil if not found.
     #
-    def self.page_for(site, resource, action, key = nil)
-      mapper = find_map(site, resource, action, key)
+    def self.page_for(site, resource, action, key = nil, opts = {})
+      mapper = find_map(site, resource, action, key, opts)
       page = mapper.try(:page)
     end
 
@@ -33,13 +34,17 @@ module Xhive
     # resource - The String containing the associated resource name.
     # action   - The String containing the associated action name.
     # key      - The String containing the associated key.
+    # policy   - The String containing the policy class.
     #
     # Returns: true if created. False otherwise.
     #
-    def self.map_resource(site, page, resource, action, key = nil)
-      mapper = find_map(site, resource, action, key)
+    def self.map_resource(site, page, resource, action, key = nil, policy = nil)
+      check_policy_class(policy) if policy.present?
+
+      mapper = find_exact_map(site, resource, action, key, policy)
       mapper = new(:site_id => site.id, :resource => resource,
-                   :action => action, :key => key.present? ? key : nil) unless mapper.present?
+                   :action => action, :policy => policy,
+                   :key => key.present? ? key : nil) unless mapper.present?
       mapper.page = page
       mapper.save
     end
@@ -55,6 +60,16 @@ module Xhive
       where(:site_id => site.id).where(:resource => resource)
     end
 
+    class InvalidPolicyError < StandardError
+      def initialize(name)
+        @name = name
+      end
+
+      def message
+        "#{@name} must implement a ::call method"
+      end
+    end
+
   private
 
     # Private: looks for a mapper object.
@@ -63,15 +78,75 @@ module Xhive
     # resource - The String containing the resource name filter.
     # action   - The String containing the action name filter.
     # key      - The String containing the key filter.
+    # opts     - The Hash containing extra values for policy-based filters.
+    #
+    # Returns:
+    #
+    #   - The mapper object if it finds a key.
+    #   - The default mapper if it does not find a key.
+    #   - Nil if there is no default mapper.
+    #
+    def self.find_map(site, resource, action, key, opts)
+      # Create filtering scopes
+      scope   = where(:site_id => site.id)
+      scope   = scope.where(:resource => resource)
+      scope   = scope.where(:action => action)
+
+      # Fetch mappers
+      mappers = scope.where(:key => key.present? ? key : nil)
+      mappers = scope.where(:key => nil) if mappers.empty?
+
+      # Check policies and select the first that passes
+      select_by_policy(mappers, opts)
+    end
+
+    # Private: looks for an exact mapper object.
+    #
+    # site     - The Site to look into.
+    # resource - The String containing the resource name filter.
+    # action   - The String containing the action name filter.
+    # key      - The String containing the key filter.
+    # policy   - The String containing the policy class.
     #
     # Returns: the mapper object or nil if not found.
     #
-    def self.find_map(site, resource, action, key)
+    def self.find_exact_map(site, resource, action, key, policy)
       mapper = where(:site_id => site.id)
       mapper = mapper.where(:resource => resource)
       mapper = mapper.where(:action => action)
       mapper = mapper.where(:key => key.present? ? key : nil)
+      mapper = mapper.where(:policy => policy.present? ? policy : nil)
       mapper.first
     end
+
+    # Private: selects the first mapper that fulfills the policy
+    #
+    # mappers - The Array containing the mapper objects.
+    # opts    - The Hash containing the policy filter data.
+    #
+    # Returns: the first matching mapper or nil if no one matches
+    #
+    def self.select_by_policy(mappers, opts)
+      mappers.sort_by {|m| m.policy.to_s }.reverse.select {|m| m.send(:verify_policy, opts) }.first
+    end
+
+    # Private: checks the mapper policy against its class
+    #
+    # opts - The Hash containing the policy filter data.
+    #
+    # Return: true if it fulfills the policy and false if it does not.
+    #
+    def verify_policy(opts)
+      result = policy.constantize.call(opts)
+    rescue NameError
+      result = true
+    ensure
+      return result
+    end
+
+    def self.check_policy_class(policy)
+      klass = policy.constantize
+      fail InvalidPolicyError.new(policy) unless klass.respond_to?(:call)
+    end
   end
 end

data/db/migrate/20121127230527_add_policy_to_xhive_mappers.rb

@@ -0,0 +1,5 @@
+class AddPolicyToXhiveMappers < ActiveRecord::Migration
+  def change
+    add_column :xhive_mappers, :policy, :string, :null => true, :default => nil
+  end
+end

data/lib/xhive/mailer.rb

@@ -1,6 +1,6 @@
 module Xhive
   class Mailer
-    attr :site, :resource, :action, :key, :mailer, :content, :page
+    attr :site, :resource, :action, :key, :mailer, :content, :page, :vars
 
     def initialize(site, mailer, key = nil)
       @site = site
@@ -8,7 +8,8 @@ module Xhive
       @mailer = mailer
       @action = mailer.action_name
       @key = key
-      @page = Xhive::Mapper.page_for(@site, @resource, @action, @key)
+      @vars = mailer_instance_variables(mailer)
+      @page = Xhive::Mapper.page_for(@site, @resource, @action, @key, @vars)
     end
 
     # Public: sends the email to the specified recipients.
@@ -38,7 +39,7 @@ module Xhive
     #
     def content
       return @content if @content.present?
-      @content = page.present? ? page.present_content(mailer_instance_variables(mailer)) : mailer.render
+      @content = page.present? ? page.present_content(vars) : mailer.render
     end
 
     # Public: returns the email subject.
@@ -46,7 +47,7 @@ module Xhive
     # Returns: the rendered template or the mapped page content body.
     #
     def subject
-      @subject = page.present? ? page.present_title(mailer_instance_variables(mailer)) : nil
+      @subject = page.present? ? page.present_title(vars) : nil
     end
 
   private

data/lib/xhive/version.rb

@@ -1,3 +1,3 @@
 module Xhive
-  VERSION = "1.4.0.pre"
+  VERSION = "1.5.0.pre"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xhive
 version: !ruby/object:Gem::Version
-  version: 1.4.0.pre
+  version: 1.5.0.pre
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-22 00:00:00.000000000 Z
+date: 2012-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -187,22 +187,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: debugger
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -264,6 +248,7 @@ files:
 - db/migrate/20121019185702_create_xhive_mappers.rb
 - db/migrate/20121031192552_add_key_to_xhive_mappers.rb
 - db/migrate/20121101124925_create_xhive_images.rb
+- db/migrate/20121127230527_add_policy_to_xhive_mappers.rb
 - lib/tasks/xhive_tasks.rake
 - lib/xhive/base_tag.rb
 - lib/xhive/controller.rb
@@ -298,7 +283,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 679411744217455480
+      hash: -2539444549338109190
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: