jekyll-metrics 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cca79edf5493463c41e66e3880cd3f10014c85a22bc6f9297bcca43c0b0553cc
+  data.tar.gz: e1700fae8cd2fbd2294d552e5a8327a3b90f97eaed5de354191e4c2c8b071015
+SHA512:
+  metadata.gz: 5e64fa202273407eed86e0ad177dc6f38a60d02490bdc2dd6cc3eac8ef71c0e4c1eb9892c1470fb054a6a3267d72e886eddfd683ee6f4882db2ee4411a2b44a3
+  data.tar.gz: 93ca011990065383140c1ac3188af678627ca962e9c85de485972c50b3c9978cbd292d93375e326c5a5a689c1f8e22f4aa9a3b678834321c4cc70662725da8e8

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Ivan Zinovyev
+
+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,44 @@
+# JekyllMetrics
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/jekyll-metrics`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll-metrics'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jekyll-metrics
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jekyll-metrics. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/jekyll-metrics/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the JekyllMetrics project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/jekyll-metrics/blob/master/CODE_OF_CONDUCT.md).

data/lib/jekyll-metrics.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'jekyll'
+require File.expand_path('jekyll-metrics/version', __dir__)
+require File.expand_path('jekyll-metrics/config', __dir__)
+require File.expand_path('jekyll-metrics/hook', __dir__)
+
+module JekyllMetrics
+  class ConfigurationError < StandardError; end
+end
+
+# Register the hook
+Jekyll::Hooks.register [:documents, :pages], :post_render do |page|
+  JekyllMetrics::Hook.new(page) { |_page, metrics| metrics.inject_scripts }
+end

data/lib/jekyll-metrics/config.rb

@@ -0,0 +1,68 @@
+module JekyllMetrics
+  # Hold the configuration needed for {JekyllMetrics::Hook} to work
+  class Config
+    CONFIG_NAME = 'jekyll_metrics'.freeze
+    DEFAULT_TEMPLATE_PATH = 'lib/jekyll-metrics/includes/metrics.html.liquid'.freeze
+    DEFAULT_CONFIG = {
+      'template' => DEFAULT_TEMPLATE_PATH,
+      'yandex_metrica_id' => 'XXXXXXXX',
+      'google_analytics_id' => 'XX-XXXXXXXXX-X'
+    }.freeze
+
+    class << self
+      def instance(site)
+        @instance ||= Config.new(site)
+      end
+    end
+
+    attr_accessor :site
+
+    def initialize(site)
+      @site = site
+    end
+
+    def template_path
+      @template_path ||= build_template_path
+    end
+
+    def plugin_vars
+      @plugin_vars ||= DEFAULT_CONFIG.merge(plugin_config)
+    end
+
+    private
+
+    def build_template_path
+      custom_path = plugin_config['template']
+
+      return default_template_path if custom_path.nil?
+
+      if custom_path.match?(%r{^\/})
+        Pathname.new(custom_path)
+      else
+        site_root_path.join(custom_path)
+      end
+    end
+
+    def default_template_path
+      plugin_root_path.join(DEFAULT_TEMPLATE_PATH)
+    end
+
+    def plugin_root_path
+      Pathname.new(File.expand_path('../..', __dir__))
+    end
+
+    def site_root_path
+      raise ConfigurationError, 'Couldn\'t access site.source' unless site.source
+
+      Pathname.new(site.source)
+    end
+
+    def plugin_config
+      @plugin_config ||= site_config[CONFIG_NAME].to_h.transform_keys(&:to_s)
+    end
+
+    def site_config
+      site.config
+    end
+  end
+end

data/lib/jekyll-metrics/hook.rb

@@ -0,0 +1,46 @@
+module JekyllMetrics
+  # Compile metrics template and inject it into the page code
+  class Hook
+    attr_accessor :page
+
+    def initialize(page)
+      @page = page
+      yield(@page, self) if block_given? && injectable?
+    end
+
+    def injectable?
+      ['Jekyll::Document', 'Jekyll::Page'].include?(page.class.name) || page.write? &&
+        (page.output_ext == '.html' || page.permalink&.end_with?('/'))
+    end
+
+    def inject_scripts
+      page.output.gsub!(%r{<\/head>}, load_scripts)
+    end
+
+    private
+
+    def prepare_scripts_for(closing_tag)
+      [load_scripts, "</#{closing_tag}>"].compact.join("\n")
+    end
+
+    def load_scripts
+      verify_path!(config.template_path)
+
+      render_template(File.read(config.template_path))
+    end
+
+    def verify_path!(path)
+      return if path && File.exist?(path)
+
+      raise ConfigurationError, "Template not found in path \"#{path}\""
+    end
+
+    def render_template(file)
+      Liquid::Template.parse(file).render(config.plugin_vars)
+    end
+
+    def config
+      @config ||= Config.instance(page.site)
+    end
+  end
+end

data/lib/jekyll-metrics/includes/metrics.html.liquid

@@ -0,0 +1,25 @@
+<!-- Global site tag (gtag.js) - Google Analytics -->
+<script async src="https://www.googletagmanager.com/gtag/js?id={{ google_analytics_id }}"></script>
+<script>
+  window.dataLayer = window.dataLayer || [];
+  function gtag(){dataLayer.push(arguments);}
+  gtag('js', new Date());
+
+  gtag('config', '{{ google_analytics_id }}');
+</script>
+<!-- End Global site tag (gtag.js) - Google Analytics -->
+
+<!-- Yandex.Metrika counter -->
+<script type="text/javascript" >
+   (function(m,e,t,r,i,k,a){m[i]=m[i]||function(){(m[i].a=m[i].a||[]).push(arguments)};
+   m[i].l=1*new Date();k=e.createElement(t),a=e.getElementsByTagName(t)[0],k.async=1,k.src=r,a.parentNode.insertBefore(k,a)})
+   (window, document, "script", "https://mc.yandex.ru/metrika/tag.js", "ym");
+
+   ym({{ yandex_metrica_id }}, "init", {
+        clickmap:true,
+        trackLinks:true,
+        accurateTrackBounce:true
+   });
+</script>
+<noscript><div><img src="https://mc.yandex.ru/watch/{{ yandex_metrica_id }}" style="position:absolute; left:-9999px;" alt="" /></div></noscript>
+<!-- /Yandex.Metrika counter -->

data/lib/jekyll-metrics/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JekyllMetrics
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-metrics
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ivan Zinovyev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Metrics plugin for Jekyll. Supports Yandex Metrics and Google Analytics
+  out of the box.
+email:
+- ivan@zinovyev.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+files:
+- LICENSE.txt
+- README.md
+- lib/jekyll-metrics.rb
+- lib/jekyll-metrics/config.rb
+- lib/jekyll-metrics/hook.rb
+- lib/jekyll-metrics/includes/metrics.html.liquid
+- lib/jekyll-metrics/version.rb
+homepage: https://github.com/zinovyev/jekyll-metrics
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/zinovyev/jekyll-metrics
+  source_code_uri: https://github.com/zinovyev/jekyll-metrics
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Metrics plugin for Jekyll
+test_files: []