piwik_analytics 0.9.1 → 1.0.0

data/README.rdoc

@@ -1,28 +1,38 @@
 = PiwikAnalytics
 
- This plugin enables support for Piwik in your Rails application. By default
-it will output the synchronous piwik tracking code for every page automatically
-(given that it is configured correctly). Configuring this plugin is easy:
+**Note:** This Gem has undergone a major rewrite in 1.x compared to 0.9.x.
 
-    PiwikAnalytics::Config.id_site = <Site ID>
-    PiwikAnalytics::Config.url = <Piwik-URL>
+The piwik_analytics gem provides an easy way to include Piwik into your application.
+By default it will output the synchronous piwik tracking code for every page
+(given that it is configured correctly).
 
-Where the <Site ID> the ID of your website inside Piwik. You can look it up
-under Settings -> Websites. <Piwik-URL> must be replaced by the URL to your
-Piwik installation.
+== Installation
 
-If you want PiwikAnalytics to use the asynchronous tracking code which was
-introduced in Piwik 1.1 you can add the folliwing line:
+Add `piwik_analytics` to Gemfile:
 
-    PiwikAnalytics::Config.use_async = true
+    gem 'piwik_analytics', '~> 1.0.0'
 
-If you want to disable the tracking code for particular controllers simply add
-the following line to those controllers:
+Run the generator:
 
-    skip_after_filter :add_piwik_analytics_tracking
+    rails g piwik_analytics:install
+
+This will install a piwik.yml configuration file into the `config` directory
+of your application.
+
+
+== Configuration
+
+Open up `config/piwik.yml` and edit the settings. Each setting is described in
+the config file itself.
+
+== Usage
+
+Inside your `application.html.erb` (or haml, slim) simply add
+
+    <%= piwik_tracking_tag %>
 
 Enjoy :)
 
 
 = Licence
-Copyright(c) 2010-2011 Fabian Becker, released under MIT licence.
+Copyright(c) 2010-2012 Fabian Becker, released under MIT licence.

data/Rakefile

@@ -1,6 +1,6 @@
 require 'rake'
 require 'rake/testtask'
-require 'rake/rdoctask'
+require 'rdoc/task'
 
 desc 'Default: run unit tests.'
 task :default => :test
@@ -20,4 +20,4 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.options << '--line-numbers' << '--inline-source'
   rdoc.rdoc_files.include('README')
   rdoc.rdoc_files.include('lib/**/*.rb')
-end
+end

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/lib/piwik_analytics"

data/lib/generators/piwik_analytics.rb

@@ -0,0 +1,7 @@
+module PiwikAnalytics
+  module Generators
+    class Base < Rails::Generators::NamedBase
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'piwik_analytics', generator_name, 'templates'))
+    end
+  end
+end

data/lib/generators/piwik_analytics/install/install_generator.rb

@@ -0,0 +1,12 @@
+module PiwikAnalytics
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      def self.source_root
+        @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+      end
+      def copy_config_file
+        template 'config/piwik.yml'
+      end
+    end
+  end
+end

data/lib/generators/piwik_analytics/install/templates/config/piwik.yml

@@ -0,0 +1,33 @@
+# Configuration:
+# 
+# disabled
+#   false if tracking tag should be shown
+# use_async
+#   Set to true if you want to use asynchronous tracking
+# url
+#   The url of your piwik instance (e.g. localhost/piwik/
+# id_site
+#   The id of your website inside Piwik
+#
+production:
+  piwik:
+    id_site: 1
+    url: localhost
+    use_async: false
+    disabled: false
+
+development:
+  piwik:
+    id_site: 1
+    url: localhost
+    disabled: true
+    use_async: false
+    hostname: localhost
+
+test:
+  piwik:
+    id_site: 1
+    url: localhost
+    disabled: true
+    use_async: false
+    hostname: localhost

data/lib/piwik_analytics.rb

@@ -1,81 +1,13 @@
-# PiwikAnalytics
-require 'active_support'
+require File.join(File.dirname(__FILE__), 'piwik_analytics', 'configuration')
 
 module PiwikAnalytics
-  module PiwikAnalyticsMixin
-    def piwik_tracking_js
-      if Config.use_async
-        <<-code
-        <!-- Piwik -->
-        <script type="text/javascript">
-        var _paq = _paq || [];
-        (function(){
-            var u=(("https:" == document.location.protocol) ? "https://#{Config.url}" : "http://#{Config.url}");
-            _paq.push(['setSiteId', #{Config.id_site}]);
-            _paq.push(['setTrackerUrl', u+'piwik.php']);
-            _paq.push(['trackPageView']);
-            var d=document,
-                g=d.createElement('script'),
-                s=d.getElementsByTagName('script')[0];
-                g.type='text/javascript';
-                g.defer=true;
-                g.async=true;
-                g.src=u+'piwik.js';
-                s.parentNode.insertBefore(g,s);
-        })();
-        </script>
-        <!-- End Piwik Tag -->
-        code
-      else
-        <<-code
-        <!-- Piwik -->
-        <script type="text/javascript">
-        var pkBaseURL = (("https:" == document.location.protocol) ? "https://#{Config.url}" : "http://#{Config.url}");
-        document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
-        </script><script type="text/javascript">
-        try {
-                var piwikTracker = Piwik.getTracker(pkBaseURL + "piwik.php", #{Config.id_site});
-                piwikTracker.trackPageView();
-                piwikTracker.enableLinkTracking();
-        } catch( err ) {}
-        </script>
-        <!-- End Piwik Tag -->
-        code
-      end
-    end
-
-    def add_piwik_analytics_tracking
-      if Config.enabled? request.format
-        if Config.use_async
-          self.response.body= response.body.sub /<\/[hH][eE][aA][dD]>/, "#{piwik_tracking_js}</head>" if response.body.respond_to?(:sub!)
-        else
-          self.response.body= response.body.sub! /<\/[bB][oO][dD][yY]>/, "#{piwik_tracking_js}</body>" if response.body.respond_to?(:sub!)
-        end
-      end
-    end
-  end
-
-  class PiwikAnalyticsConfigurationError < StandardError; end
-
-  class Config
-    @@id_site = nil
-    cattr_accessor :id_site
-
-    @@url = nil
-    cattr_accessor :url
-
-    @@use_async = false
-    cattr_accessor :use_async
-
-    @@environments = ["production"]
-    cattr_accessor :environments
+  require 'piwik_analytics/railtie' if defined?(Rails)
 
-    @@formats = [:html, :all]
-    cattr_accessor :formats
+  class <<self
+    attr_writer :configuration
 
-    def self.enabled?(format)
-      raise PiwikAnalytics::PiwikAnalsyticsConfigurationError if id_site.blank? || url.blank?
-      environments.include?(Rails.env) && formats.include?(format.to_sym)
+    def configuration
+      @configuration ||= PiwikAnalytics::Configuration.new
     end
   end
 end

data/lib/piwik_analytics/configuration.rb

@@ -0,0 +1,74 @@
+
+module PiwikAnalytics
+  class Configuration
+
+    #
+    # The url of the Piwik instance
+    # Defaults to localhost
+    #
+    def url
+      @url ||= (user_configuration_from_key('url') || 'localhost')
+    end
+
+    #
+    # The ID of the tracked website
+    # Defaults to 1
+    #
+    def id_site
+      @id_size ||= (user_configuration_from_key('id_size') || 1)
+    end
+
+    #
+    # Whether or not to use the async tracking
+    # Defaults to false
+    #
+    def use_async?
+      @use_async ||= (user_configuration_from_key('use_async') || false)
+    end
+
+    #
+    # Whether or not to disable Piwik.
+    # Defaults to false.
+    #
+    def disabled?
+      @disabled ||= (user_configuration_from_key('disabled') || false)
+    end
+
+    private
+
+    # 
+    # return a specific key from the user configuration in config/piwik.yml
+    #
+    # ==== Returns
+    #
+    # Mixed:: requested_key or nil
+    #
+    def user_configuration_from_key( *keys )
+      keys.inject(user_configuration) do |hash, key|
+        hash[key] if hash
+      end
+    end
+
+    #
+    # Memoized hash of configuration options for the current Rails environment
+    # as specified in config/piwik.yml
+    #
+    # ==== Returns
+    #
+    # Hash:: configuration options for current environment
+    #
+    def user_configuration
+      @user_configuration ||= begin
+        path = File.join(::Rails.root, 'config', 'piwik.yml')
+        if File.exist?(path)
+          File.open(path) do |file|
+            processed = ERB.new(file.read).result
+            YAML.load(processed)[::Rails.env]['piwik']
+          end
+        else
+          {}
+        end
+      end
+    end
+  end
+end

data/lib/piwik_analytics/helpers.rb

@@ -0,0 +1,49 @@
+module PiwikAnalytics
+  module Helpers
+    def piwik_tracking_tag
+      config = PiwikAnalytics.configuration
+      return if config.disabled?
+
+      if config.use_async?
+        tag = <<-CODE
+        <!-- Piwik -->
+        <script type="text/javascript">
+        var _paq = _paq || [];
+        (function(){
+            var u=(("https:" == document.location.protocol) ? "https://#{config.url}" : "http://#{config.url}");
+            _paq.push(['setSiteId', #{config.id_site}]);
+            _paq.push(['setTrackerUrl', u+'piwik.php']);
+            _paq.push(['trackPageView']);
+            var d=document,
+                g=d.createElement('script'),
+                s=d.getElementsByTagName('script')[0];
+                g.type='text/javascript';
+                g.defer=true;
+                g.async=true;
+                g.src=u+'piwik.js';
+                s.parentNode.insertBefore(g,s);
+        })();
+        </script>
+        <!-- End Piwik Tag -->
+        CODE
+        tag.html_safe
+      else
+        tag = <<-CODE
+        <!-- Piwik -->
+        <script type="text/javascript">
+        var pkBaseURL = (("https:" == document.location.protocol) ? "https://#{config.url}" : "http://#{config.url}");
+        document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
+        </script><script type="text/javascript">
+        try {
+                var piwikTracker = Piwik.getTracker(pkBaseURL + "piwik.php", #{config.id_site});
+                piwikTracker.trackPageView();
+                piwikTracker.enableLinkTracking();
+        } catch( err ) {}
+        </script>
+        <!-- End Piwik Tag -->
+        CODE
+        tag.html_safe
+      end
+    end
+  end
+end

data/lib/piwik_analytics/init.rb

@@ -0,0 +1 @@
+ActionView::Base.send :include, PiwikAnalytics::Helpers

data/lib/piwik_analytics/railtie.rb

@@ -0,0 +1,18 @@
+# PiwikAnalytics
+require 'active_support'
+
+module PiwikAnalytics
+
+  class Railtie < Rails::Railtie
+    railtie_name :piwik_analytics
+
+    generators do
+      load "generators/piwik_analytics.rb"
+    end
+
+    initializer "piwik_analytics.init", :before=> :load_config_initializers do
+      require "piwik_analytics/helpers"
+      load "piwik_analytics/init.rb"
+    end
+  end
+end

data/piwik_analytics.gemspec

@@ -0,0 +1,24 @@
+spec = Gem::Specification.new do |s|
+  s.name              = 'piwik_analytics'
+  s.version           = '1.0.0'
+  s.date              = Time.now.strftime "%Y-%m-%d"
+  s.author            = 'Fabian Becker'
+  s.email             = 'halfdan@xnorfz.de'
+  s.homepage          = 'https://github.com/halfdan/piwik_analytics/'
+  s.summary           = "[Rails] Easily include Piwik tracking in your Rails application."
+
+  s.description = <<-DESC
+    The piwik_analytics gem provides an easy way to include Piwik into your application.
+    By default it will output the synchronous piwik tracking code for every page
+    (given that it is configured correctly).    
+  DESC
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+                
+  s.add_runtime_dependency 'rails', '>= 3.0.0'
+  s.add_dependency 'actionpack'
+  s.add_dependency 'activesupport'
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: piwik_analytics
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,27 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2010-12-30 00:00:00.000000000 +01:00
-default_executable: 
+date: 2012-10-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &74842040 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +37,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *74842040
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &74841820 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,15 +53,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *74841820
-description: ! 'By default this gem will output piwik analytics code forevery page
-  automatically, if it''s configured correctly.This is done by adding:
-
-  PiwikAnalytics.IdSite = 1
-
-  PiwikAnalytics.URL = <Piwik-URL>
-
-'
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "    The piwik_analytics gem provides an easy way to include Piwik
+  into your application.\n    By default it will output the synchronous piwik tracking
+  code for every page\n    (given that it is configured correctly).    \n"
 email: halfdan@xnorfz.de
 executables: []
 extensions: []
@@ -50,10 +70,18 @@ files:
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
+- init.rb
+- lib/generators/piwik_analytics.rb
+- lib/generators/piwik_analytics/install/install_generator.rb
+- lib/generators/piwik_analytics/install/templates/config/piwik.yml
+- lib/piwik_analytics.rb
+- lib/piwik_analytics/configuration.rb
+- lib/piwik_analytics/helpers.rb
+- lib/piwik_analytics/init.rb
+- lib/piwik_analytics/railtie.rb
+- piwik_analytics.gemspec
 - test/piwik_analytics_test.rb
 - test/test_helper.rb
-- lib/piwik_analytics.rb
-has_rdoc: true
 homepage: https://github.com/halfdan/piwik_analytics/
 licenses: []
 post_install_message: 
@@ -74,8 +102,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: ! '[Rails] Easily enable Google Analytics support in your Rails application.'
+summary: ! '[Rails] Easily include Piwik tracking in your Rails application.'
 test_files: []