yandex_metrika 0.0.0 → 0.0.1

data/CREDITS

@@ -0,0 +1,5 @@
+Most of the code are taken from Google Analytics plugin if Rubaidh Ltd.
+( http://github.com/rubaidh/google_analytics )
+
+So, thanks to all developers of Rubaidh, and all folks from
+http://github.com/rubaidh/google_analytics/blob/master/CREDITS

data/README.rdoc

@@ -1,6 +1,75 @@
-= yandex_metrika
+= Yandex.Metrika [ru]
+(skip to next chapter for description in English)
+
+== Установка
+
+Добавьте в <tt>config/environment.rb</tt>:
+
+    config.gem "yandex_metrika", :lib => "yandex/metrika", :source => "http://gemcutter.org"
+
+и выполните команду:
+
+    rake gems:install
+
+== Описание
+
+Быстрая интеграция Яндекс.Метрики в ваше Rails-приложение.
+
+По умолчанию код метрики автоматически вставляется в каждую страницу перед
+закрывающим тэгом \</body>.
+Но сначала нужно корректно сконфигурировать плагин, иначе он будет ругаться.
+
+== Конфигурация
+
+Для этого добавьте следующий код в <tt>config/environment.rb</tt>:
+
+    if defined?Yandex::Metrika
+        Yandex::Metrika.counter_id = '123456'
+    end
+
+А для избежания замусоривания <tt>environment.rb</tt> всякими плагинами -
+можно добавить этот конфиг в <tt>config/initializers/yandex_metrika.rb</tt>
+
+Вместо '123456' нужно вставить ваш личный COUNTER_ID, который можно вытащить
+из javascript-кода, предоставляемого Яндексом: "<tt>new Ya.Metrika(123456)</tt>",
+тут 123456 и есть искомый код.
+
+По умолчанию код метрики вставляется в страницы только при использовании
+*production* окружения. Для активации кода и в *development* нужно сделать так:
+
+    Yandex::Metrika.environments = %w'production development'
+
+Если есть необходимость для каких-то страниц выключить код Яндекс.Метрики - то
+добавть следующий код в соответствующий класс контроллера:
+
+    skip_after_filter :add_yandex_metrika_code
+
+
+= Yandex.Metrika [en]
+
+This plugin enables Yandex.Metrika support in your application. By default
+it will output the metrika code for every single page automatically, if it
+is configured correctly. This is done by adding:
+
+    Yandex::Metrika.counter_id = '123456'
+
+to your <tt>config/environment.rb</tt>, inserting your own COUNTER_ID. This
+can be discovered by looking at the value of "new Ya.Metrika(123456)" in the
+Javascript code.
+
+If you want to disable the code insertion for particular pages, add the
+following to controllers that don't want it:
+
+    skip_after_filter :add_yandex_metrika_code
+
+If you are running rails 2.1 or above add install this by adding:
+
+    config.gem "yandex_metrika", :lib => "yandex/metrika", :source => "http://gemcutter.org"
+
+and run:
+
+    rake gems:install
 
-Description goes here.
 
 == Note on Patches/Pull Requests
  

data/Rakefile

@@ -6,17 +6,18 @@ begin
   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 ' +
+    gem.description = gem.summary + "\n<br/><br/>\n" + 
+                      '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" +
+                      "This is done by adding: <br/>\n" +
+                      "Yandex::Metrika.counter_id = '123456' <br/>\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.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'

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.0.1

data/lib/yandex/metrika.rb

@@ -8,14 +8,14 @@ module Yandex # :nodoc:
     # 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+
+      # Normally you won't need to call this directly; the +add_yandex_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
+      def add_yandex_metrika_code
         if Metrika.defer_load
           response.body.sub! /<\/[bB][oO][dD][yY]>/, "#{metrika_code}</body>" if response.body.respond_to?(:sub!)
         else
@@ -24,7 +24,13 @@ module Yandex # :nodoc:
       end
     end
 
-    class ConfigurationError < StandardError; end
+    class ConfigurationError < StandardError #:nodoc:
+      DEFAULT_MESSAGE = "Yandex::Metrika.counter_id is not set in config/environment.rb or config/initializers/yandex_metrika.rb"
+
+      def initialize(message = nil)
+        super(message || DEFAULT_MESSAGE)
+      end
+    end
 
     @@counter_id = nil
     ##

data/rails/init.rb

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

data/test/test_helper.rb

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

data/test/yandex_metrika_test.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
 require 'test/unit'
-require 'rubygems'
+#require 'rubygems'
 require 'mocha'
 RAILS_ENV = 'test'
 
@@ -81,41 +81,41 @@ class MetrikaTest < Test::Unit::TestCase
 
   # 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
+  def test_add_yandex_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
+    mixin.add_yandex_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
+    mixin.add_yandex_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
+    mixin.add_yandex_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
+    mixin.add_yandex_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
+    mixin.add_yandex_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
+    mixin.add_yandex_metrika_code
     assert_equal mixin.response.body, '<body style="background-color:red"><p>some text</p>Sample Code</body>'
   end
 

data/yandex_metrika.gemspec

@@ -5,13 +5,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{yandex_metrika}
-  s.version = "0.0.0"
+  s.version = "0.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Andrey \"Zed\" Zaikin"]
+  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'
+  s.description = %q{[Rails] Easily enable Yandex.Metrika support in your Rails application.
+<br/><br/>
+By default this gem will output Yandex.Metrika code for every page automagically, if it's configured correctly. This is done by adding: <br/>
+Yandex::Metrika.counter_id = '123456' <br/>
 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 = [
@@ -21,6 +23,7 @@ to your `config/environment.rb`, inserting your own COUNTER_ID. This can be disc
   s.files = [
     ".document",
      ".gitignore",
+     "CREDITS",
      "LICENSE",
      "README.rdoc",
      "Rakefile",

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
 name: yandex_metrika
 version: !ruby/object:Gem::Version 
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors: 
-- Andrey "Zed" Zaikin
+- Andrey 'Zed' Zaikin
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -33,8 +33,10 @@ dependencies:
         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'
+  [Rails] Easily enable Yandex.Metrika support in your Rails application.
+  <br/><br/>
+  By default this gem will output Yandex.Metrika code for every page automagically, if it's configured correctly. This is done by adding: <br/>
+  Yandex::Metrika.counter_id = '123456' <br/>
   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: []
@@ -47,6 +49,7 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
+- CREDITS
 - LICENSE
 - README.rdoc
 - Rakefile