middleman-piwik 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ae00062f9ed70a7306aed9b3772656ec2881dbe
+  data.tar.gz: 53f4273cd2500bfcd647ced867c2965ddac5037f
+SHA512:
+  metadata.gz: 35cc140b3695c9c4067ab66418605dcd62bc20270dfdead858a689a432a08d75f2a5cc1f9324e71bc52ece9a971e848cee5be2d2728650fcf3f30d96fddf04ee
+  data.tar.gz: 54ea82894ff7ccf5cf6b37774092fa346de2fc4ba1eff1cece91a5bfaf9d16d6e344352bd8101dc624046c4a5dac393bea2972514d10103ad6721c540f2341f2

data/.gitignore

@@ -0,0 +1,6 @@
+Gemfile.lock
+pkg
+.*.swp
+tmp
+.yardoc
+doc

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby-19mode
+
+script: "bundle exec rake test"
+
+env: TEST=true

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+0.1
+---
+
+* Initial release

data/CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Contributing
+In the spirit of [free software][free-sw], **everyone** is encouraged to help
+improve this project.
+
+[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code (**no patch is too small**: fix typos, add comments, clean up
+  inconsistent whitespace)
+* by refactoring code
+* by closing [issues][]
+* by reviewing patches
+
+[issues]: https://github.com/middleman/middleman-syntax/issues
+
+## Submitting an Issue
+We use the [GitHub issue tracker][issues] to track bugs and features. Before
+submitting a bug report or feature request, check to make sure it hasn't
+already been submitted. When submitting a bug report, please include a [Gist][]
+that includes a stack trace and any details that may be necessary to reproduce
+the bug, including your gem version, Ruby version, and operating system.
+Ideally, a bug report should include a pull request with failing specs.
+
+[gist]: https://gist.github.com/
+
+## Submitting a Pull Request
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Add specs for your unimplemented feature or bug fix.
+4. Run `bundle exec rake test`. If your specs pass, return to step 3.
+5. Implement your feature or bug fix.
+6. Run `bundle exec rake test`. If your specs fail, return to step 5.
+7. Add, commit, and push your changes.
+8. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: http://learn.github.com/p/branching.html
+[pr]: http://help.github.com/send-pull-requests/

data/Gemfile

@@ -0,0 +1,17 @@
+source "https://rubygems.org"
+
+gem "middleman-core", :github => "middleman/middleman", :branch => 'v3-stable'
+
+# Specify your gem's dependencies in middleman-syntax.gemspec
+gemspec
+
+gem "rake",     "~> 10.1.0", :require => false
+gem "yard",     "~> 0.8.0", :require => false
+
+# Test tools
+gem "cucumber", "~> 1.3.1"
+gem "fivemat"
+gem "aruba"
+
+# Code Quality
+gem "cane", :platforms => [:mri_19, :mri_20], :require => false

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Michael Scherer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+# Middleman-Piwik
+
+`middleman-piwik` is an extension for the [Middleman](http://middlemanapp.com/) static site generator that ease the use of the [Piwik](http://piwik.org/) web analytics platform.
+
+## Installation
+
+Just add `gem "middleman-piwik"` to your existing Gemfile and run `bundle install`.
+
+## Configuration
+
+```ruby
+activate :piwik do |p|
+    p.id = 1
+    p.domain = 'piwik.example.net'
+end
+``` 
+
+id is the id of the site, as given by piwik. Usually, it start at 1.
+
+domain is the domain name of the piwik server. 
+
+## Helper
+
+The extension adds 3 new helper to Middleman to add the proper javascript and img in your website
+
+```erb
+<%= insert_piwik_tracker %>
+```
+
+The one that should be almost always be used is `insert_piwik_tracker`, which will try to insert the regular javascript code and a img tag as a fallback.
+
+The 2 others `insert_piwik_tracker_js` and `insert_piwik_tracker_img` will add only the javascript tracker or the img one.

data/Rakefile

@@ -0,0 +1,32 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  exempt_tags = ""
+  exempt_tags << "--tags ~@nojava " if RUBY_PLATFORM == "java"
+  t.cucumber_opts = "--color --tags ~@wip #{exempt_tags} --strict --format #{ENV['CUCUMBER_FORMAT'] || 'pretty'}"
+end
+
+require 'rake/clean'
+
+task :test => ["cucumber"]
+
+begin
+  require 'cane/rake_task'
+
+  desc "Run cane to check quality metrics"
+  Cane::RakeTask.new(:quality) do |cane|
+    cane.no_style = true
+    cane.no_doc = true
+    cane.abc_glob = "lib/middleman-piwik/**/*.rb"
+  end
+rescue LoadError
+  # warn "cane not available, quality task not provided."
+end
+
+desc "Build HTML documentation"
+task :doc do
+  sh 'bundle exec yard'
+end

data/features/piwik_helpers.feature

@@ -0,0 +1,44 @@
+Feature: Piwik helpers for js and img.
+
+  Scenario: Helpers works
+    Given a fixture app "test-app"
+    And a file named "config.rb" with:
+      """
+      activate :piwik do |f|
+        f.id = 3
+        f.domain = 'piwik.example.com'
+      end
+      """
+    Given the Server is running at "test-app"
+    When I go to "/piwik_both.html"
+    Then I should see "piwik.example.com/piwik.php?idsite=3"
+    Then I should see "setSiteId"
+    Then I should see "noscript"
+
+  Scenario: Helper for img work
+    Given a fixture app "test-app"
+    And a file named "config.rb" with:
+      """
+      activate :piwik do |f|
+        f.id = 4
+        f.domain = 'piwik_img.example.com'
+      end
+      """
+    Given the Server is running at "test-app"
+    When I go to "/piwik_img.html"
+    Then I should see "piwik_img.example.com/piwik.php?idsite=4"
+    Then I should not see "noscript"
+
+  Scenario: Helper for js work
+    Given a fixture app "test-app"
+    And a file named "config.rb" with:
+      """
+      activate :piwik do |f|
+        f.id = 5
+        f.domain = 'piwik_js.example.com'
+      end
+      """
+    Given the Server is running at "test-app"
+    When I go to "/piwik_js.html"
+    Then I should not see "noscript"
+    Then I should see 'setSiteId'

data/features/support/env.rb

@@ -0,0 +1,6 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+ENV['TEST'] = 'true'
+require "middleman-core"
+require "middleman-core/step_definitions"
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-piwik')
+

data/fixtures/test-app/config.rb

@@ -0,0 +1,4 @@
+activate :piwik do |f|
+    f.id = 3
+    f.domain = 'piwik.example.com'
+end

data/fixtures/test-app/source/piwik_both.html.erb

@@ -0,0 +1,2 @@
+<h1>Tracker with image and js
+<%= insert_piwik_tracker %>

data/fixtures/test-app/source/piwik_img.html.erb

@@ -0,0 +1,2 @@
+<h1>Tracker with image
+<%= insert_piwik_tracker_img %>

data/fixtures/test-app/source/piwik_js.html.erb

@@ -0,0 +1,2 @@
+<h1>Tracker with js
+<%= insert_piwik_tracker_js %>

data/lib/middleman-piwik/extension.rb

@@ -0,0 +1,40 @@
+module Middleman
+  module Piwik
+    class PiwikExtension < Extension
+      option :id, 1, 'Piwik site id'
+      option :domain, 'piwik.example.org', 'Piwik domain'
+      
+      def after_configuration
+        app.set :piwik_domain, options.domain
+        app.set :piwik_id, options.id
+      end
+
+      helpers do
+        def insert_piwik_tracker_img
+            "<p><img src=\"https://#{piwik_domain}/piwik.php?idsite=#{piwik_id}\" style=\"border:0;\" alt=\"\" /></p>"
+        end
+
+        def insert_piwik_tracker_js
+            <<END
+        <script type="test/javascript">
+        var _paq = _paq || [];
+        _paq.push(['trackPageView']);
+        _paq.push(['enableLinkTracking']);
+        (function() {
+        var u=(("https:" == document.location.protocol) ? "https" : "http") + "://#{piwik_domain}/";
+        _paq.push(['setTrackerUrl', u+'piwik.php']);
+        _paq.push(['setSiteId', #{piwik_id}]);
+        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
+        end
+
+        def insert_piwik_tracker
+            insert_piwik_tracker_js + "<noscript>" + insert_piwik_tracker_img + "</noscript>"
+        end
+      end
+    end
+  end
+end 

data/lib/middleman-piwik/middleman_extension.rb

@@ -0,0 +1 @@
+require 'middleman-piwik'

data/lib/middleman-piwik/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module Piwik
+    VERSION = "0.1"
+  end
+end

data/lib/middleman-piwik.rb

@@ -0,0 +1,7 @@
+require "middleman-core"
+require "middleman-piwik/version"
+
+::Middleman::Extensions.register(:piwik) do
+  require "middleman-piwik/extension"
+  ::Middleman::Piwik::PiwikExtension
+end

data/middleman-piwik.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "middleman-piwik/version"
+
+Gem::Specification.new do |s|
+  s.name = "middleman-piwik"
+  s.version = Middleman::Piwik::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.authors = ["Michael Scherer"]
+  s.email = ["mscherer@redhat.com"]
+  s.homepage = "https://github.com/mscherer/middleman-piwik"
+  s.summary = %q{Piwik tracker integration for Middleman}
+  s.description = %q{Piwik tracker integration for Middleman}
+  s.license = "MIT"
+  s.files = `git ls-files -z`.split("\0")
+  s.test_files = `git ls-files -z -- {fixtures,features}/*`.split("\0")
+  s.require_paths = ["lib"]
+  s.add_runtime_dependency("middleman-core", ["~> 3.2"])
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: middleman-piwik
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Michael Scherer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Piwik tracker integration for Middleman
+email:
+- mscherer@redhat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- features/piwik_helpers.feature
+- features/support/env.rb
+- fixtures/test-app/config.rb
+- fixtures/test-app/source/piwik_both.html.erb
+- fixtures/test-app/source/piwik_img.html.erb
+- fixtures/test-app/source/piwik_js.html.erb
+- lib/middleman-piwik.rb
+- lib/middleman-piwik/extension.rb
+- lib/middleman-piwik/middleman_extension.rb
+- lib/middleman-piwik/version.rb
+- middleman-piwik.gemspec
+homepage: https://github.com/mscherer/middleman-piwik
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Piwik tracker integration for Middleman
+test_files:
+- features/piwik_helpers.feature
+- features/support/env.rb
+- fixtures/test-app/config.rb
+- fixtures/test-app/source/piwik_both.html.erb
+- fixtures/test-app/source/piwik_img.html.erb
+- fixtures/test-app/source/piwik_js.html.erb
+has_rdoc: