omniturize 0.0.4 → 1.0.0

data/README.markdown

@@ -1,17 +1,20 @@
 # Omniturize
-This gem integrates Omniture SiteCatalyst into your web app. 
+This gem integrates Omniture SiteCatalyst into your web app.
+
+## Dependencies
+This gem depends on [meta_vars](https://github.com/eLafo/meta_vars "eLafo's meta_vars") gem
 
 ## Installation
     gem install omniturize
 
 ## Based on and unaware collaborators
-This is gem is based on [activenetwork's OmnitureClient gem](https://github.com/activenetwork/omniture_client, "activenetwork's OmnitureClient"), which was forked from [acatighera's](https://github.com/acatighera/omniture_client, "acatighera's OmnitureClient").
+This is gem is based on [activenetwork's OmnitureClient gem](https://github.com/activenetwork/omniture_client "activenetwork's OmnitureClient"), which was forked from [acatighera's](https://github.com/acatighera/omniture_client, "acatighera's OmnitureClient").
 
 There is some borrowed code from unawared coders. So thank you to
 
-*   [acatighera](https://github.com/acatighera, "acatighera github homepage")
-*   [activenetwork](https://github.com/activenetwork, "activenetwork github homepage")
-*   [John Nunemaker](http://railstips.org/about, "railstips") for his [ClassLevelInheritableAttributes solution](http://railstips.org/blog/archives/2006/11/18/class-and-instance-variables-in-ruby/, "Class and instance variables in ruby")
+*   [acatighera](https://github.com/acatighera "acatighera github homepage")
+*   [activenetwork](https://github.com/activenetwork "activenetwork github homepage")
+*   [John Nunemaker](http://railstips.org/about "railstips") for his [ClassLevelInheritableAttributes solution](http://railstips.org/blog/archives/2006/11/18/class-and-instance-variables-in-ruby/ "Class and instance variables in ruby")
 
 ## Configuration
 You must configure the Omniture namespace, suite(s), version that you wish to use.
@@ -65,33 +68,27 @@ You can define a var by giving it a name and defining a block
 	end
 
 
-You can define a var to be present in or excluded from some actions.
+You can define a var to be present only in given actions.
 
 	#This var will be present only in index and new actions
-	var :my_var, :only => [:index, :new] do
+	var :my_var,  'index', 'new' do
 		'value_for_my_var'
 	end
 
-	#this var will be excluded from index, new, create, update and destroy actions
-
-	var :my_var, :except => [:index, :new, :create, :update, :destroy] do
-		params[:id]
-	end
-
 
-If no :only or :excluded options are passed, the defined var will be available in every action.
+If no namespaces are passed, the defined var will be available in every action.
 
 ###Events
-You can define an event the same way you define a var, except that you don't have to give a name for the event
+You can define an event the same way you define a var
 
-	event, :only => [:search] do
+	event :my_event, 'search' do
 		'my_event'
 	end
 
 ###Custom javascript
 You can define custom javascript code the same way you define an event
 
-	js_snippet, :only => [:search] do
+	js_snippet :my_snippet 'search' do
 		's.server = window.location.host;'
 	end
 
@@ -133,7 +130,8 @@ Somewhere in your view -probably in one of your layouts- you should add the next
 ##More info
 Since this gem has been created for a very specific use, it may be that this documentation is not enough for you. I have tried to keep the most code from the original sources, so you would want to take a look to the code itself or to the original sources where I took the code
 
-* [OmnitureClient gem](https://github.com/acatighera/omniture_client, "acathigera's OmnitureClient")
-* [activenetwork's fork](https://github.com/activenetwork/omniture_client, "activenetwork's OmnitureClient")
+* [OmnitureClient gem](https://github.com/acatighera/omniture_client "acathigera's OmnitureClient")
+* [activenetwork's fork](https://github.com/activenetwork/omniture_client "activenetwork's OmnitureClient")
+* [meta_vars gem](https://github.com/eLafo/meta_vars "eLafo's meta_vars")
 
 ##### Copyright (c) 2011 Javier Lafora, released under MIT license

data/lib/omniturize.rb

@@ -1,10 +1,7 @@
+require 'meta_vars'
 require "omniturize/version"
-require File.dirname(__FILE__) + '/class_level_inheritable_attributes'
 require File.dirname(__FILE__) + '/omniturize/printer'
 require File.dirname(__FILE__) + '/omniturize/base'
-require File.dirname(__FILE__) + '/omniturize/var'
-require File.dirname(__FILE__) + '/omniturize/meta_js'
-require File.dirname(__FILE__) + '/omniturize/meta_var'
 require 'cgi'
 
 module Omniturize

data/lib/omniturize/base.rb

@@ -1,110 +1,21 @@
 module Omniturize
   class Base
 
-    include Omniturize::ClassLevelInheritableAttributes
     include Omniturize::Printer
-    inheritable_attributes :meta_vars, :meta_js_events, :meta_js_snippets
-    
-    attr_reader  :controller
+    include MetaVars
 
-    @meta_vars = []
-    @meta_js_events = []
-    @meta_js_snippets   = []
+    has_meta_var :var, :default_namespace => 'default', :inheritable => true
+    has_meta_var :event, :default_namespace => 'default', :inheritable => true
+    has_meta_var :js_snippet, :default_namespace => 'default', :inheritable => true
 
+    attr_reader  :controller
 
     class << self
-      attr_accessor :meta_vars, :meta_js_events, :meta_js_snippets
       @@controller = nil
-
-      def var(name, options={}, &block)
-        meta_var = Omniturize::MetaVar.new(name.to_s, options)
-        meta_var.add_var(block)
-        meta_vars.insert(0, meta_var) unless meta_vars.include?(meta_var)
-        meta_var
-      end
-
-      def event(options = {}, &block)
-        meta_js(meta_js_events, block, options)
-      end
-
-      def js_snippet(options = {}, &block)
-        meta_js(meta_js_snippets, block, options)
-      end
-
-      def find_meta_vars(name, action = nil)
-        filter_collection_for_action(meta_vars.select{|x|x.matches_name?(name)}, action).uniq_by(:name)
-      end
-
-      def filter_collection_for_action(collection, action)
-        return collection if action.blank?
-        collection.select do |element|
-          element.passes_filter?(action)
-        end
-      end
-
-      protected
-
-      def meta_js(collection, block, options = {})
-        meta_js = Omniture::MetaJs.new(options)
-        meta_js.add_js(block)
-        collection.insert(0, meta_js)
-        meta_js
-      end
-
     end
 
     def initialize(controller)
       @controller = controller
     end
-
-    def vars(options = {})
-      meta_collection_to_values(self.class.meta_vars, options[:action]).uniq_by(:name)
-    end
-    
-    def js_events(options = {})
-      meta_collection_to_values(self.class.meta_js_events, options[:action]).uniq
-    end
-
-    def js_snippets(options = {})
-      meta_collection_to_values(self.class.meta_js_snippets, options[:action]).uniq
-    end
-
-    def add_var(name, value)
-      self.class.var(name) do
-        value
-      end
-    end
-
-    def find_vars(name, options = {})
-      meta_vars_to_vars(self.class.find_meta_vars(name, options))
-    end
-
-    def find_var(name, options = {})
-      find_vars(name, options).first
-    end
-
-    def find_values(name, options = {})
-      find_vars(name, options).map(&:value)
-    end
-
-    def meta_vars_to_vars(meta_vars)
-      meta_vars.inject([]) do |vars, meta_var|
-        vars << (meta_var.value(controller) if meta_var) rescue nil
-        vars
-      end
-    end
-
-    protected
-
-    def build_js_collection(procs_collection)
-      procs_collection.inject([]) do |code, js|
-        code << controller.instance_eval(&js)
-        code
-      end
-    end
-
-    def meta_collection_to_values(collection, action = nil)
-      action.present? ? meta_vars_to_vars(self.class.filter_collection_for_action(collection, action)): meta_vars_to_vars(collection)
-    end
   end
 end

data/lib/omniturize/printer.rb

@@ -13,28 +13,30 @@ module Omniturize
       output = <<-JS
         <script type="text/javascript" language="JavaScript" src="#{Omniturize::js_src}"></script>
         <script type="text/javascript" language="JavaScript" #{html_options.join(' ')}>
-          #{js_vars(options)}
-          #{print_js_events(options)}
-          #{print_js_snippets(options)}
+          #{js_vars(options[:action])}
+          #{print_js_events(options[:action])}
+          #{print_js_snippets(options[:action])}
           var s_code=s.t();if(s_code)document.write(s_code)
         </script>
       JS
     end
     
     def query(options = {})
-      vars(options).inject([]) do |query, var|
+      vars(controller).inject([]) do |query, var|
         query << var_to_query(var) if var.value && var.value != ""
         query
       end.join('&')
     end
     
-    def js_vars(options = {})
-      vars(options).inject([]) do |query, var|
-        query << var_to_js(var) if var.value && var.value != ""
+    def js_vars(action)
+      output = (find_meta_vars(action) + find_meta_vars).uniq_by(&:name).map{|x| x.to_var(controller)}.inject([]) do |query, var|
+        query << var_to_js(var) if var.value.present?
         query
-      end.join(";\n") + ';'
+      end.join(";\n")
+
+      output.blank? ? nil : output + ';'
     end
-    
+
     def raw_vars(options = {})
       vars(options).inject([]) do |query, var|
         query << { var.name.to_sym => var.value } if var.value && var.value != ""
@@ -42,13 +44,17 @@ module Omniturize
       end
     end
 
-    def print_js_events(options = {})
-      values = js_events(options).join(',')
-      values.blank? ? nil : "s.events=\"#{values}\""
+    def print_js_events(action)
+      events = (find_meta_events(action) + find_meta_events).uniq_by(&:name).map{|event| event.to_var(controller)}.inject([]) do |values, event|
+        (values << event.value) if event.value.present?
+      end.join(',')
+      events.blank? ? nil : "s.events=\"#{events}\";"
     end
 
-    def print_js_snippets(options = {})
-      js_snippets(options).join("\n")
+    def print_js_snippets(action)
+      (find_meta_js_snippets(action) + find_meta_js_snippets).uniq_by(&:name).map{|snippet| snippet.to_var(controller)}.inject([]) do |snippets, snippet|
+        (snippets << snippet.value) if snippet.value.present?
+      end.join("\n")
     end
     
     private
@@ -58,7 +64,11 @@ module Omniturize
     end
     
     def var_to_js(var)
-      %Q{\t#{Omniturize::var_prefix + '.' if Omniturize::var_prefix}#{var.name}="#{var.value}"} if var
+      %Q{\t#{Omniturize::var_prefix + '.' if Omniturize::var_prefix}#{var_name(var)}="#{var.value}"} if var
+    end
+
+    def var_name(var)
+      Omniturize::aliases && Omniturize::aliases[var.name.to_s] ? Omniturize::aliases[var.name.to_s] : var.name
     end
   end
 end

data/lib/omniturize/version.rb

@@ -1,3 +1,3 @@
 module Omniturize
-  VERSION = "0.0.4"
+  VERSION = "1.0.0"
 end

data/omniturize.gemspec

@@ -17,4 +17,6 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+  s.requirements << 'meta_vars 1.0.0'
+  s.add_dependency('meta_vars', '1.0.0')
 end

metadata

@@ -4,10 +4,10 @@ version: !ruby/object:Gem::Version
   hash: 23
   prerelease: 
   segments: 
+  - 1
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors: 
 - eLafo
@@ -15,9 +15,24 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-17 00:00:00 Z
-dependencies: []
-
+date: 2011-10-21 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: meta_vars
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id001
 description: This gem integrates Omniture SiteCatalyst into your web app. You can specify vars, events and custom javascript for every action of a controller. This gem is proudly based on the omniture_client gem, from which it takes much code and ideas
 email: 
 - javierlafora@gmail.com
@@ -33,13 +48,9 @@ files:
 - MIT-LICENSE
 - README.markdown
 - Rakefile
-- lib/class_level_inheritable_attributes.rb
 - lib/omniturize.rb
 - lib/omniturize/base.rb
-- lib/omniturize/meta_js.rb
-- lib/omniturize/meta_var.rb
 - lib/omniturize/printer.rb
-- lib/omniturize/var.rb
 - lib/omniturize/version.rb
 - lib/omniturize_rails.rb
 - omniturize.gemspec
@@ -69,8 +80,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       segments: 
       - 0
       version: "0"
-requirements: []
-
+requirements: 
+- meta_vars 1.0.0
 rubyforge_project: omniturize
 rubygems_version: 1.8.10
 signing_key: 

data/lib/class_level_inheritable_attributes.rb

@@ -1,31 +0,0 @@
-# This code was proudly and shamelessly copied from
-# http://railstips.org/blog/archives/2006/11/18/class-and-instance-variables-in-ruby/
-# so let's all thank John Nunemaker with a loud and strong applause: PLAS!!!!'
-
-module Omniturize
-  module ClassLevelInheritableAttributes
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-
-    module ClassMethods
-      def inheritable_attributes(*args)
-        @omniture_inheritable_attributes ||= [:omniture_inheritable_attributes]
-        @omniture_inheritable_attributes += args
-        args.each do |arg|
-          class_eval %(
-            class << self; attr_accessor :#{arg} end
-          )
-        end
-        @omniture_inheritable_attributes
-      end
-
-      def inherited(subclass)
-        @omniture_inheritable_attributes.each do |inheritable_attribute|
-          instance_var = "@#{inheritable_attribute}"
-          subclass.instance_variable_set(instance_var, instance_variable_get(instance_var))
-        end
-      end
-    end
-  end
-end

data/lib/omniturize/meta_js.rb

@@ -1,56 +0,0 @@
-module Omniture
-  class MetaJs
-    attr_reader :cache_key, :expires_in, :only, :except, :delimiter
-    attr_accessor :value_procs
-
-    DEFAULT_OPTIONS = { :unique => nil,
-                        :expires_in => 0,
-                        :only => [],
-                        :except => [],
-                        :delimiter => ','
-    }
-
-    def initialize(options = {})
-      options = DEFAULT_OPTIONS.merge(options)
-      
-      @value_procs = []
-      @cache_key = "omniture/#{Time.now.to_i}/#{options[:unique]}"
-      @expires_in = options[:expires_in]
-      @only = options[:only]
-      @except = options[:except]
-    end
-
-    def add_js(value_proc)
-      value_procs << value_proc
-    end
-
-    def value(scope)
-      if @expires_in > 0
-        Rails.cache.fetch(@cache_key, :expires_in => @expires_in) do
-          return_var(scope)
-        end
-      else
-        return_var(scope)
-      end
-    end
-
-    def return_var(scope)
-      value_procs.map{ |p| scope.instance_eval(&p) }.flatten.uniq.join(delimiter)
-    end
-
-    def passes_filter?(filter)
-      passes_only_filter?(filter) && passes_except_filter?(filter)
-    end
-
-    private
-
-    def passes_only_filter?(filter)
-      only.blank? || only.detect{|x| x.is_a?(Regexp) ? filter.match(x) : filter.to_sym == x.to_sym}.present?
-    end
-
-    def passes_except_filter?(filter)
-      except.blank? || except.detect{|x| x.is_a?(Regexp) ? filter.match(x) : filter.to_sym == x.to_sym}.blank?
-    end
-
-  end
-end

data/lib/omniturize/meta_var.rb

@@ -1,67 +0,0 @@
-module Omniturize
-  class MetaVar
-
-    DEFAULT_OPTIONS = { :delimiter => ',',
-                        :unique => nil,
-                        :expires_in => 0,
-                        :only => [],
-                        :except => []
-    }
-
-    attr_reader :name, :delimiter, :cache_key, :expires_in, :only, :except
-    attr_accessor :value_procs
-
-    def initialize(name, options = {})
-      options = DEFAULT_OPTIONS.merge(options)
-      @name = name
-      @value_procs = []
-      @delimiter = options[:delimiter]
-      @cache_key = "omniture/#{name}/#{options[:unique]}"
-      @expires_in = options[:expires_in]
-      @only = Array(options[:only])
-      @except = Array(options[:except])
-    end
-
-    def add_var(value_proc)
-      value_procs << value_proc
-    end
-
-    # wrap up the value in a Var object and cache if needed
-    def value(scope)
-      if @expires_in > 0
-        Rails.cache.fetch(@cache_key, :expires_in => @expires_in) do
-          return_var(scope)
-        end
-      else
-        return_var(scope)
-      end
-    end
-    
-    def return_var(scope)
-      Var.new(name, value_procs.map{ |p| scope.instance_eval(&p) }.flatten.uniq.join(delimiter))
-    end
-
-    def matches_name?(name)
-      select_condition = case name
-        when Regexp then self.name.match(name)
-        when String then self.name == name
-        else raise ArgumentError.new('name must be a String or a Regexp')
-      end
-    end
-
-    def passes_filter?(filter)
-      passes_only_filter?(filter) && passes_except_filter?(filter)
-    end
-
-    private
-
-    def passes_only_filter?(filter)
-      only.blank? || only.detect{|x| x.is_a?(Regexp) ? filter.match(x) : filter.to_sym == x.to_sym}.present?
-    end
-
-    def passes_except_filter?(filter)
-      except.blank? || except.detect{|x| x.is_a?(Regexp) ? filter.match(x) : filter.to_sym == x.to_sym}.blank?
-    end
-
-  end
-end

data/lib/omniturize/var.rb

@@ -1,22 +0,0 @@
-module Omniturize
-  class Var
-    attr_reader :name, :value
-    def initialize(name, value)
-      if Omniturize::aliases && Omniturize::aliases[name.to_s]
-        @name = Omniturize::aliases[name.to_s]
-      else
-        @name = name.to_s
-      end
-      @value = value
-    end
-
-    def matches_name?(name)
-      select_condition = case name
-        when Regexp then self.name.match(name)
-        when String then self.name == name
-        else raise ArgumentError.new('name must be a String or a Regexp')
-      end
-    end
-
-  end
-end