yandex-metrika-rails 0.0.1 → 0.1.1

data/Gemfile

@@ -5,4 +5,5 @@ gemspec
 
 gem 'tconsole'
 gem 'simplecov'
+gem 'activesupport'
 gem 'coveralls', require: false

data/README.md

@@ -2,7 +2,7 @@
 [![Coverage
 Status](https://coveralls.io/repos/saratovsource/yandex-metrika-rails/badge.png?branch=master)](https://coveralls.io/r/saratovsource/yandex-metrika-rails)
 
-TODO: Write a gem description
+Yandex Metrika gem for Rails 3.x. It based on [google-analytics-rails]: https://github.com/bgarret/google-analytics-rails gem.
 
 ## Installation
 
@@ -14,13 +14,32 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Usage
 
-    $ gem install yandex-metrika-rails
+`config/environments/<environment>.rb`
 
-## Usage
+    YM.counter = "" # You shoul insert you Yandex Metrica code
+
+You must leave this field blank if you do not want to display the metric
+on the page for that environment.
+`app/views/layouts/application.html.haml`
+
+    = metrika_init
+
+You can manually specify those counters that you want to use.
+`config/environments/<environment>.rb`
+
+    YM.counter = "" # You shoul insert you Yandex Metrica code
+    YM.set_counters :webvisor, :trackLinks
+
+You can adjust the metric for the request asynchronously.
+
+    = metrika_init(async: true) # By default
+
+Or synchronously...
+
+    = metrika_init(async: false)
 
-TODO: Write usage instructions here
 
 ## Contributing
 

data/lib/yandex-metrika-rails.rb

@@ -2,6 +2,11 @@ require 'yandex-metrika/version'
 require 'yandex-metrika/counter'
 
 module YandexMetrika
+  DEFAULTS = {
+    webvisor: true,
+    clickmap: true,
+    trackLinks: true
+  }
 
   class << self
     def counter
@@ -19,6 +24,23 @@ module YandexMetrika
     def invalid_counter?
       counter.nil? || counter == ""
     end
+
+    def set_counters(*counters)
+      counters.each{|c| add_counter(c)}
+    end
+
+    def add_counter(counter)
+      @options ||= {}
+      @options[counter] = true
+    end
+
+    def options
+      @options ||= DEFAULTS
+    end
+
+    def reset!
+      @options = nil
+    end
   end
 
 end

data/lib/yandex-metrika/counter.rb

@@ -9,13 +9,14 @@ module YandexMetrika
     autoload :TemplateOptions, 'yandex-metrika/counter/template_options'
 
     def initialize(args = {})
-      @counter_types ||= []
+      @options_types ||= []
       prepare_view_options(args)
       append_counter_types(args)
-      @options_renderer = YandexMetrika::Counter::Renderer.new(@counter_types)
+      @options_renderer = YandexMetrika::Counter::Renderer.new(@options_types)
     end
 
     def to_s
+      return if YM.invalid_counter?
       template_name = @async ? "async" : "sync"
       @template ||= ::ERB.new ::File.read ::File.expand_path("../templates/#{template_name}.erb", __FILE__)
       @template.result(template_options.instance_eval { binding }).html_safe
@@ -33,13 +34,16 @@ module YandexMetrika
 
     def prepare_view_options(args)
       @local = args.delete(:local) || false
-      @async = args.delete(:async) || true
+      @async = true
+      @async = args.delete(:async) if args.include? :async
       @noscript = args.delete(:noscript) || true
     end
 
     def append_counter_types(args = {})
+      args = YM.options.merge(args)
+      @options_types << Kind.new(:id, YM.counter)
       args.each do |k,v|
-        @counter_types << Kind.new(k,v)
+        @options_types << Kind.new(k,v)
       end
     end
   end

data/lib/yandex-metrika/version.rb

@@ -1,3 +1,3 @@
 module YandexMetrika
-  VERSION = "0.0.1"
+  VERSION = "0.1.1"
 end

data/test/configure_metrika_test.rb

@@ -0,0 +1,14 @@
+require "test_helper"
+
+class ConfigurationBuilderTest < TestCase
+  def setup
+    YM.reset!
+  end
+
+  def test_should_have_specific_configuration
+    YM.set_counters :webvisor, :trackLinks
+    @options = {webvisor: true, trackLinks: true}
+    assert_equal @options, YM.options
+  end
+
+end

data/test/rails/advanced_options_test.rb

@@ -0,0 +1,22 @@
+require "test_helper"
+require "yandex-metrika/rails/view_helpers"
+
+class AdvancedOptionsTest < TestCase
+  include YandexMetrika::Rails::ViewHelpers
+
+  def setup
+    YM.counter = 123
+  end
+
+  def test_should_not_render_without_counter
+    YM.counter = ""
+    metrika_init_script = metrika_init
+    refute_match %r{w\.yaCounter}, metrika_init_script
+  end
+
+  def test_script_should_be_sync
+    metrika_init_script = metrika_init(async: false)
+    refute_match %r{w\.yaCounter}, metrika_init_script
+  end
+
+end

data/test/rails/views_helper_test.rb

@@ -4,9 +4,18 @@ require "yandex-metrika/rails/view_helpers"
 class ViewHelpersTest < TestCase
   include YandexMetrika::Rails::ViewHelpers
 
+  def setup
+    YM.counter = 123
+    YM.reset!
+  end
+
   def test_showl_have_default_options
     metrika_init_script = metrika_init
     assert_match %r{w\.yaCounter}, metrika_init_script
+    assert_match %r{id:#{YM.counter}}, metrika_init_script
+    assert_match %r{webvisor:true}, metrika_init_script
+    assert_match %r{trackLinks:true}, metrika_init_script
+    assert_match %r{clickmap:true}, metrika_init_script
     assert_match %r{\<\/noscript\>}, metrika_init_script
   end
 
@@ -34,5 +43,4 @@ class ViewHelpersTest < TestCase
     metrika_init_script = metrika_init(accurateTrackBounce: true)
     assert_match %r{accurateTrackBounce:true}, metrika_init_script
   end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yandex-metrika-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -66,6 +66,8 @@ files:
 - lib/yandex-metrika/templates/async.erb
 - lib/yandex-metrika/templates/sync.erb
 - lib/yandex-metrika/version.rb
+- test/configure_metrika_test.rb
+- test/rails/advanced_options_test.rb
 - test/rails/views_helper_test.rb
 - test/test_helper.rb
 - yandex-metrika-rails.gemspec
@@ -95,5 +97,7 @@ signing_key:
 specification_version: 3
 summary: Rails 3 helpers to manage Yandex Metrika and other services.
 test_files:
+- test/configure_metrika_test.rb
+- test/rails/advanced_options_test.rb
 - test/rails/views_helper_test.rb
 - test/test_helper.rb