yandex-metrica-rails 0.1.3

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: 7XAqRDzxWmghPK1B8UcBIhHnDxULfAuzj

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yandex-metrika-rails.gemspec
+gemspec
+
+gem 'tconsole'
+gem 'simplecov'
+gem 'activesupport'
+gem 'coveralls', require: false

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kirillov Alexander
+
+MIT License
+
+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,60 @@
+# Yandex::Metrica::Rails
+[![Coverage
+Status](https://coveralls.io/repos/saratovsource/yandex-metrica-rails/badge.png?branch=master)](https://coveralls.io/r/saratovsource/yandex-metrica-rails)
+
+Yandex Metrica gem for Rails 3.x. It based on [google-analytics-rails]: https://github.com/bgarret/google-analytics-rails gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'yandex-metrica-rails'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+`config/environments/<environment>.rb`
+
+    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`
+
+    = metrica_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.
+
+    = metrica_init(async: true) # By default
+
+Or synchronously...
+
+    = metrica_init(async: false)
+
+#### Available settings:
+
+    = metrica_init(async: false, clickmap: true, noscript: false)
+
+`webvisor`   : WebVisor
+`clickmap`   : Click map
+`trackLinks` : External links, file downloads and "Share" button report
+`trackHash`  : Hash tracking in the browser address window
+`accurateTrackBounce` : Accurate bounce rate
+`noscript`   : Show `noscript` tag at the page. `true` by default.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/yandex-metrica-rails.rb

@@ -0,0 +1,52 @@
+require 'yandex-metrica/version'
+require 'yandex-metrica/counter'
+
+module YandexMetrica
+  DEFAULTS = {
+    webvisor: true,
+    clickmap: true,
+    trackLinks: true
+  }
+
+  class << self
+    def counter
+      @counter || nil
+    end
+
+    def counter=(counter)
+      @counter = counter
+    end
+
+    def valid_counter?
+      !invalid_counter?
+    end
+
+    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
+
+YM = YandexMetrica
+if defined?(Rails)
+  require 'yandex-metrica/rails/railtie'
+  YMR = YandexMetrica::Rails
+end

data/lib/yandex-metrica/counter.rb

@@ -0,0 +1,52 @@
+require 'active_support/core_ext/string/output_safety'
+require 'erb'
+module YandexMetrica
+  class Counter
+    attr_reader :local, :counter_types, :noscript, :async
+
+    autoload :Kind, 'yandex-metrica/counter/kind'
+    autoload :Renderer, 'yandex-metrica/counter/renderer'
+    autoload :TemplateOptions, 'yandex-metrica/counter/template_options'
+
+    def initialize(args = {})
+      @options_types ||= []
+      prepare_view_options(args)
+      append_counter_types(args)
+      @options_renderer = YandexMetrica::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
+    end
+    alias_method :render, :to_s
+
+    protected
+
+    def template_options
+      TemplateOptions.new({
+        counter_name: "yaCounter#{YM.counter}",
+        counter_options: @options_renderer.to_s,
+        noscript: @noscript
+      })
+    end
+
+    def prepare_view_options(args)
+      @local = args.delete(:local) || false
+      @async = true
+      @async = args.delete(:async) if args.include? :async
+      @noscript = true
+      @noscript = args.delete(:noscript) if args.include? :noscript
+    end
+
+    def append_counter_types(args = {})
+      args = YM.options.merge(args)
+      @options_types << Kind.new(:id, YM.counter)
+      args.each do |k,v|
+        @options_types << Kind.new(k,v)
+      end
+    end
+  end
+end

data/lib/yandex-metrica/counter/kind.rb

@@ -0,0 +1,12 @@
+module YandexMetrica
+  class Counter::Kind
+    attr_reader :name, :value
+    def initialize(name, value)
+      @name, @value = name, value
+    end
+
+    def to_s
+      "#{@name}:#{@value}"
+    end
+  end
+end

data/lib/yandex-metrica/counter/renderer.rb

@@ -0,0 +1,15 @@
+module YandexMetrica
+  class Counter::Renderer
+    attr_reader :counter_types_collection
+    DELIMITER = ', '
+    def initialize(counter_types_collection)
+      @counter_types_collection = counter_types_collection
+    end
+
+    def to_s
+      @counter_types_collection.map{|ct| ct.to_s}.join(DELIMITER)
+    end
+    alias_method :render, :to_s
+
+  end
+end

data/lib/yandex-metrica/counter/template_options.rb

@@ -0,0 +1,4 @@
+module YandexMetrica
+  class Counter::TemplateOptions < OpenStruct
+  end
+end

data/lib/yandex-metrica/rails/railtie.rb

@@ -0,0 +1,7 @@
+module YandexMetrica::Rails
+  class Railtie < ::Rails::Railtie
+    initializer "yandex-metrica-rails" do
+      ActionView::Base.send :include, ViewHelpers
+    end
+  end
+end

data/lib/yandex-metrica/rails/view_helpers.rb

@@ -0,0 +1,8 @@
+module YandexMetrica::Rails
+  module ViewHelpers
+
+    def metrica_init(options = {})
+      YandexMetrica::Counter.new(options).to_s
+    end
+  end
+end

data/lib/yandex-metrica/templates/async.erb

@@ -0,0 +1,22 @@
+<script type="text/javascript">
+(function (d, w, c) {
+    (w[c] = w[c] || []).push(function() {
+      try { w.<%= counter_name %> = new Ya.Metrika(<%= counter_options %>);
+      } catch(e) { }
+    });
+
+    var n = d.getElementsByTagName("script")[0],
+        s = d.createElement("script"),
+        f = function () { n.parentNode.insertBefore(s, n); };
+    s.type = "text/javascript";
+    s.async = true;
+    s.src = (d.location.protocol == "https:" ? "https:" : "http:") + "//mc.yandex.ru/metrika/watch.js";
+
+    if (w.opera == "[object Opera]") {
+        d.addEventListener("DOMContentLoaded", f, false);
+    } else { f(); }
+})(document, window, "yandex_metrika_callbacks");
+</script>
+<% if noscript %>
+  <noscript><div><img src="//mc.yandex.ru/watch/<%= counter %>" style="position:absolute; left:-9999px;" alt="" /></div></noscript>
+<% end %>

data/lib/yandex-metrica/templates/sync.erb

@@ -0,0 +1,8 @@
+<script src="//mc.yandex.ru/metrika/watch.js" type="text/javascript"></script>
+<script type="text/javascript">
+try { var <%= counter_name %> = new Ya.Metrika(<%= counter_options %>);
+} catch(e) { }
+</script>
+<% if noscript %>
+  <noscript><div><img src="//mc.yandex.ru/watch/<%= counter %>" style="position:absolute; left:-9999px;" alt="" /></div></noscript>
+<% end %>

data/lib/yandex-metrica/version.rb

@@ -0,0 +1,3 @@
+module YandexMetrica
+  VERSION = "0.1.3"
+end

data/test/configure_metrica_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-metrica/rails/view_helpers"
+
+class AdvancedOptionsTest < TestCase
+  include YandexMetrica::Rails::ViewHelpers
+
+  def setup
+    YM.counter = 123
+  end
+
+  def test_should_not_render_without_counter
+    YM.counter = ""
+    metrica_init_script = metrica_init
+    refute_match %r{w\.yaCounter}, metrica_init_script
+  end
+
+  def test_script_should_be_sync
+    metrica_init_script = metrica_init(async: false)
+    refute_match %r{w\.yaCounter}, metrica_init_script
+  end
+
+end

data/test/rails/views_helper_test.rb

@@ -0,0 +1,51 @@
+require "test_helper"
+require "yandex-metrica/rails/view_helpers"
+
+class ViewHelpersTest < TestCase
+  include YandexMetrica::Rails::ViewHelpers
+
+  def setup
+    YM.counter = 123
+    YM.reset!
+  end
+
+  def test_showl_have_default_options
+    metrica_init_script = metrica_init
+    assert_match %r{w\.yaCounter}, metrica_init_script
+    assert_match %r{id:#{YM.counter}}, metrica_init_script
+    assert_match %r{webvisor:true}, metrica_init_script
+    assert_match %r{trackLinks:true}, metrica_init_script
+    assert_match %r{clickmap:true}, metrica_init_script
+    assert_match %r{\<\/noscript\>}, metrica_init_script
+  end
+
+  def test_metrica_should_not_have_noscript_tag
+    metrica_init_script = metrica_init(noscript: false)
+    refute_match %r{\<\/noscript\>}, metrica_init_script
+  end
+
+  def test_metrica_should_have_webvisor
+    metrica_init_script = metrica_init(webvisor: true)
+    assert_match %r{webvisor:true}, metrica_init_script
+  end
+
+  def test_metrica_should_have_track_links
+    metrica_init_script = metrica_init(trackLinks: true)
+    assert_match %r{trackLinks:true}, metrica_init_script
+  end
+
+  def test_metrica_should_have_track_hash
+    metrica_init_script = metrica_init(trackHash: true)
+    assert_match %r{trackHash:true}, metrica_init_script
+  end
+
+  def test_metrica_should_have_clickmap
+    metrica_init_script = metrica_init(clickmap: true)
+    assert_match %r{clickmap:true}, metrica_init_script
+  end
+
+  def test_metrica_should_have_accurate_track_bounce
+    metrica_init_script = metrica_init(accurateTrackBounce: true)
+    assert_match %r{accurateTrackBounce:true}, metrica_init_script
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'yandex-metrica-rails'
+require 'test/unit'
+require 'simplecov'
+require 'coveralls'
+Coveralls.wear!
+
+ENV["COVERAGE"] = "true"
+SimpleCov.start if ENV["COVERAGE"]
+
+YM.counter = "123"
+class TestCase < MiniTest::Unit::TestCase
+end

data/yandex-metrica-rails.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yandex-metrica/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yandex-metrica-rails"
+  spec.version       = YandexMetrica::VERSION
+  spec.authors       = ["Kirillov Alexander"]
+  spec.email         = ["saratovsource@gmail.com"]
+  spec.description   = %q{Rails 3 helpers to manage Yandex Metrica and other services.}
+  spec.summary       = %q{Rails 3 helpers to manage Yandex Metrica and other services.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: yandex-metrica-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+  prerelease: 
+platform: ruby
+authors:
+- Kirillov Alexander
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rails 3 helpers to manage Yandex Metrica and other services.
+email:
+- saratovsource@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .coveralls.yml
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/yandex-metrica-rails.rb
+- lib/yandex-metrica/counter.rb
+- lib/yandex-metrica/counter/kind.rb
+- lib/yandex-metrica/counter/renderer.rb
+- lib/yandex-metrica/counter/template_options.rb
+- lib/yandex-metrica/rails/railtie.rb
+- lib/yandex-metrica/rails/view_helpers.rb
+- lib/yandex-metrica/templates/async.erb
+- lib/yandex-metrica/templates/sync.erb
+- lib/yandex-metrica/version.rb
+- test/configure_metrica_test.rb
+- test/rails/advanced_options_test.rb
+- test/rails/views_helper_test.rb
+- test/test_helper.rb
+- yandex-metrica-rails.gemspec
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Rails 3 helpers to manage Yandex Metrica and other services.
+test_files:
+- test/configure_metrica_test.rb
+- test/rails/advanced_options_test.rb
+- test/rails/views_helper_test.rb
+- test/test_helper.rb