yandex_metrika 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Andrey "Zed" Zaikin
+
+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.rdoc

@@ -0,0 +1,18 @@
+= yandex_metrika
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Andrey "Zed" Zaikin. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,65 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "yandex_metrika"
+    gem.summary = "[Rails] Easily enable Yandex.Metrika support in your Rails application."
+    gem.description = 'By default this gem will output Yandex.Metrika code for ' +
+                      "every page automagically, if it's configured correctly. " +
+                      "This is done by adding:\n" +
+                      "Yandex::Metrika.counter_id = '123456'\n" +
+                      'to your `config/environment.rb`, inserting your own COUNTER_ID. ' +
+                      'This can be discovered by looking at the value of "new Ya.Metrika(123456)" ' +
+                      'in the Javascript code.'
+
+    gem.email = "zed.0xff@gmail.com"
+    gem.homepage = "http://github.com/zed-0xff/yandex_metrika"
+    gem.authors = ["Andrey \"Zed\" Zaikin"]
+    #gem.add_development_dependency "thoughtbot-shoulda"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.add_dependency 'actionpack', '>= 2.3.3'
+    gem.add_dependency 'activesupport', '>= 2.3.3'
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "yandex_metrika #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/yandex.rb

@@ -0,0 +1,2 @@
+module Yandex #:nodoc:
+end

data/lib/yandex/metrika.rb

@@ -0,0 +1,81 @@
+require 'active_support'
+require 'action_pack'
+require 'action_view'
+
+module Yandex # :nodoc:
+  class Metrika
+
+    # This module gets mixed in to ActionController::Base
+    module Mixin
+      # The javascript code to enable Yandex.Metrika on the current page.
+      # Normally you won't need to call this directly; the +add_metrika_code+
+      # after filter will insert it for you.
+      def metrika_code
+        Metrika.code if Metrika.enabled?(request.format)
+      end
+      
+      # An after_filter to automatically add the metrika code.
+      def add_metrika_code
+        if Metrika.defer_load
+          response.body.sub! /<\/[bB][oO][dD][yY]>/, "#{metrika_code}</body>" if response.body.respond_to?(:sub!)
+        else
+          response.body.sub! /(<[bB][oO][dD][yY][^>]*>)/, "\\1#{metrika_code}" if response.body.respond_to?(:sub!)
+        end
+      end
+    end
+
+    class ConfigurationError < StandardError; end
+
+    @@counter_id = nil
+    ##
+    # :singleton-method:
+    # Specify the Yandex.Metrika COUNTER_ID for this web site. This can be found
+    # as the value of "new Ya.Metrika(123456)", where 123456 is the actual ID.
+    cattr_accessor :counter_id  
+
+    @@environments = ['production']
+    ##
+    # :singleton-method:
+    # The environments in which to enable the Yandex.Metrika code. Defaults
+    # to 'production' only. Supply an array of environment names to change this.
+    cattr_accessor :environments
+    
+    @@formats = [:html, :all]
+    ##
+    # :singleton-method:
+    # The request formats where tracking code should be added. Defaults to +[:html, :all]+. The entry for
+    # +:all+ is necessary to make Yandex recognize that tracking is installed on a
+    # site; it is not the same as responding to all requests. Supply an array
+    # of formats to change this.
+    cattr_accessor :formats
+
+    @@defer_load = true
+    ##
+    # :singleton-method:
+    # Set this to true (the default) if you want to load the Metrika javascript at 
+    # the bottom of page. Set this to false if you want to load the Metrika
+    # javascript at the top of the page. The page will render faster if you set this to
+    # true.
+    cattr_accessor :defer_load
+    
+    # Return true if the Yandex.Metrika system is enabled and configured
+    # correctly for the specified format
+    def self.enabled?(format)
+      raise ConfigurationError if counter_id.blank?
+      environments.include?(RAILS_ENV) && formats.include?(format.to_sym)
+    end
+    
+    # Construct the javascript code to be inserted on the calling page.
+    def self.code
+      <<-EOHTML
+        <!-- Yandex.Metrika -->
+        <script src="//mc.yandex.ru/resource/watch.js" type="text/javascript"></script>
+        <script type="text/javascript">
+        try { var yaCounter#{counter_id} = new Ya.Metrika(#{counter_id}); } catch(e){}
+        </script>
+        <noscript><div style="position: absolute;"><img src="//mc.yandex.ru/watch/#{counter_id}" alt="" /></div></noscript>
+        <!-- /Yandex.Metrika -->
+      EOHTML
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,3 @@
+require 'yandex/metrika'
+ActionController::Base.send :include, Yandex::Metrika::Mixin
+ActionController::Base.send :after_filter, :add_metrika_code

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+ENV['RAILS_ENV'] = 'test'
+
+require 'rubygems'
+require 'test/unit'
+
+require File.expand_path(File.dirname(__FILE__) + '/../lib/yandex/metrika.rb')
+

data/test/yandex_metrika_test.rb

@@ -0,0 +1,122 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+require 'test/unit'
+require 'rubygems'
+require 'mocha'
+RAILS_ENV = 'test'
+
+class TestMixin
+  class MockRequest
+    attr_accessor :format
+  end
+  class MockResponse
+    attr_accessor :body
+  end
+
+  include Yandex::Metrika::Mixin
+  attr_accessor :request, :response
+
+  def initialize
+    self.request = MockRequest.new
+    self.response = MockResponse.new
+  end
+
+  # override the mixin's method
+  def metrika_code
+    "Sample Code"
+  end
+end
+
+
+class MetrikaTest < Test::Unit::TestCase
+  def setup
+    @ga = Yandex::Metrika.new
+    @ga.counter_id = "the tracker id"
+  end
+  
+  def test_createable
+    assert_not_nil(@ga)
+  end
+  
+  def test_default_environments
+    assert_equal(false, @ga.environments.include?('test'))
+    assert_equal(false, @ga.environments.include?('development'))
+    assert_equal(true, @ga.environments.include?('production'))
+  end
+  
+  def test_default_formats
+    assert_equal(false, @ga.formats.include?(:xml))
+    assert_equal(true, @ga.formats.include?(:html))
+  end
+
+  def test_defer_load_defaults_to_true
+    assert_equal(true, @ga.defer_load)
+  end
+  
+  # test self.enabled
+  def test_enabled_requires_counter_id
+    Yandex::Metrika.stubs(:counter_id).returns(nil)
+    assert_raise(Yandex::Metrika::ConfigurationError) { Yandex::Metrika.enabled?(:html) }
+  end
+  
+  def test_enabled_returns_false_if_current_environment_not_enabled
+    Yandex::Metrika.stubs(:environments).returns(['production'])
+    assert_equal(false, Yandex::Metrika.enabled?(:html))
+  end
+  
+  def test_enabled_with_default_format
+    Yandex::Metrika.stubs(:environments).returns(['test'])
+    assert_equal(true, Yandex::Metrika.enabled?(:html))
+  end
+  
+  def test_enabled_with_not_included_format
+    Yandex::Metrika.stubs(:environments).returns(['test'])
+    assert_equal(false, Yandex::Metrika.enabled?(:xml))
+  end
+  
+  def test_enabled_with_added_format
+    Yandex::Metrika.stubs(:environments).returns(['test'])
+    Yandex::Metrika.stubs(:formats).returns([:xml])
+    assert_equal(true, Yandex::Metrika.enabled?(:xml))
+  end
+
+  # Test the before_filter method does what we expect by subsituting the body tags and inserting
+  # some code for us automagically.
+  def test_add_metrika_code
+    # setup our test mixin
+    mixin = TestMixin.new
+
+    # bog standard body tag
+    Yandex::Metrika.defer_load = false
+    mixin.response.body = "<body><p>some text</p></body>"
+    mixin.add_metrika_code
+    assert_equal mixin.response.body, '<body>Sample Code<p>some text</p></body>'
+
+    Yandex::Metrika.defer_load = true
+    mixin.response.body = "<body><p>some text</p></body>"
+    mixin.add_metrika_code
+    assert_equal mixin.response.body, '<body><p>some text</p>Sample Code</body>'
+
+    # body tag upper cased (ignoring this is semantically incorrect)
+    Yandex::Metrika.defer_load = false
+    mixin.response.body = "<BODY><p>some text</p></BODY>"
+    mixin.add_metrika_code
+    assert_equal mixin.response.body, '<BODY>Sample Code<p>some text</p></BODY>'
+
+    Yandex::Metrika.defer_load = true
+    mixin.response.body = "<BODY><p>some text</p></BODY>"
+    mixin.add_metrika_code
+    assert_equal mixin.response.body, '<BODY><p>some text</p>Sample Code</body>'
+
+    # body tag has additional attributes
+    Yandex::Metrika.defer_load = false
+    mixin.response.body = '<body style="background-color:red"><p>some text</p></body>'
+    mixin.add_metrika_code
+    assert_equal mixin.response.body, '<body style="background-color:red">Sample Code<p>some text</p></body>'
+
+    Yandex::Metrika.defer_load = true
+    mixin.response.body = '<body style="background-color:red"><p>some text</p></body>'
+    mixin.add_metrika_code
+    assert_equal mixin.response.body, '<body style="background-color:red"><p>some text</p>Sample Code</body>'
+  end
+
+end

data/yandex_metrika.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{yandex_metrika}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andrey \"Zed\" Zaikin"]
+  s.date = %q{2009-10-12}
+  s.description = %q{By default this gem will output Yandex.Metrika code for every page automagically, if it's configured correctly. This is done by adding:
+Yandex::Metrika.counter_id = '123456'
+to your `config/environment.rb`, inserting your own COUNTER_ID. This can be discovered by looking at the value of "new Ya.Metrika(123456)" in the Javascript code.}
+  s.email = %q{zed.0xff@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/yandex.rb",
+     "lib/yandex/metrika.rb",
+     "rails/init.rb",
+     "test/test_helper.rb",
+     "test/yandex_metrika_test.rb",
+     "yandex_metrika.gemspec"
+  ]
+  s.homepage = %q{http://github.com/zed-0xff/yandex_metrika}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{[Rails] Easily enable Yandex.Metrika support in your Rails application.}
+  s.test_files = [
+    "test/yandex_metrika_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<actionpack>, [">= 2.3.3"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.3.3"])
+    else
+      s.add_dependency(%q<actionpack>, [">= 2.3.3"])
+      s.add_dependency(%q<activesupport>, [">= 2.3.3"])
+    end
+  else
+    s.add_dependency(%q<actionpack>, [">= 2.3.3"])
+    s.add_dependency(%q<activesupport>, [">= 2.3.3"])
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: yandex_metrika
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Andrey "Zed" Zaikin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-12 00:00:00 +06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.3
+    version: 
+description: |-
+  By default this gem will output Yandex.Metrika code for every page automagically, if it's configured correctly. This is done by adding:
+  Yandex::Metrika.counter_id = '123456'
+  to your `config/environment.rb`, inserting your own COUNTER_ID. This can be discovered by looking at the value of "new Ya.Metrika(123456)" in the Javascript code.
+email: zed.0xff@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/yandex.rb
+- lib/yandex/metrika.rb
+- rails/init.rb
+- test/test_helper.rb
+- test/yandex_metrika_test.rb
+- yandex_metrika.gemspec
+has_rdoc: true
+homepage: http://github.com/zed-0xff/yandex_metrika
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: "[Rails] Easily enable Yandex.Metrika support in your Rails application."
+test_files: 
+- test/yandex_metrika_test.rb
+- test/test_helper.rb