google_analytics_ab_test_on_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae6f2d7d1f36f7503c71c2cbd37f9257858e64c8
+  data.tar.gz: 1302cb7cd1dd389ade81b25649a4d6054b2733dd
+SHA512:
+  metadata.gz: 0f634fbb7956ecebdf176889af6b235813120cfe55cebce67300f9c1c361a188befa1cf3bc400b753367845cb042270f36638519764ff6da37a6c040a55e180d
+  data.tar.gz: 5f243c7cb88a20d651799203f8a2e62bb81dc719b331a5e8dff9593dca26d63bab1860c1686b21cb0c96475f1a040a94388e75feec982183cb1df70453a10caf

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 ykogure
+
+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,28 @@
+# GoogleAnalyticsAbTestOnRails
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'google_analytics_ab_test_on_rails'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install google_analytics_ab_test_on_rails
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'GoogleAnalyticsAbTestOnRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/views/google_analytics_ab_test_on_rails/_ab_test_manager.html.erb

@@ -0,0 +1,35 @@
+<% if ab_tests.present? %>
+  <div id="ab_test_manager" class="position_top">
+    <div id="ab_test_manager_main_window">
+      <div>
+        <% ab_tests.each do |ab_test_name, ab_test_values| %>
+          <div class="ab_test_manager_ab_tests">
+            <%= ab_test_name %>：
+            <% values = ab_test_values.is_a?(Hash) ? ab_test_values.keys : ab_test_values %>
+            <% values.each do |ab_test_value| %>
+              <% value_name = ab_test_values.is_a?(Hash) ? "#{ab_test_value}(#{ab_test_values[ab_test_value]})" : ab_test_value %>
+              <% if get_ab_test_value(ab_test_name) != ab_test_value %>
+                <% path = url_for(params.merge(ga_ab_test_force_change: {ab_test_name => ab_test_value}).permit!.to_h) %>
+                <span>
+                  <%= link_to "#{value_name}", path %>
+                </span>
+              <% else %>
+                <span>
+                  ✓<%= value_name %>
+                </span>
+              <% end %>
+            <% end %>
+          </div>
+        <% end %>
+      </div>
+    </div>
+    <div id="ab_test_manager_btn_window">
+      <div id="js_ab_test_manager_close_btn">
+        <div>ab test manager ▲</div>
+      </div>
+      <div id="js_ab_test_manager_open_btn" style="display: none;">
+        <div>ab test manager ▼</div>
+      </div>
+    </div>
+  </div>
+<% end %>

data/lib/generators/google_analytics_ab_test_on_rails/install_generator.rb

@@ -0,0 +1,22 @@
+module GoogleAnalyticsAbTestOnRails
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates a GoogleAnalytics A/B Test on Rails initializer to your application."
+
+      def copy_initializer
+        template "google_analytics_ab_test_on_rails.rb", "config/initializers/google_analytics_ab_test_on_rails.rb"
+      end
+
+      # def insert_javascript_tag
+      #   inject_into_file "app/views/layouts/application.html.erb", after: /<head[\s]?[^>]*>/ do
+      #     "\n    <%= render_gtm_on_rails_tag_in_head %>\n"
+      #   end
+      #   inject_into_file "app/views/layouts/application.html.erb", after: /<body[\s]?[^>]*>/ do
+      #     "\n    <%= render_gtm_on_rails_tag_in_body %>\n"
+      #   end
+      # end
+    end
+  end
+end

data/lib/generators/google_analytics_ab_test_on_rails/views_generator.rb

@@ -0,0 +1,37 @@
+module GoogleAnalyticsAbTestOnRails
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates/views", __FILE__)
+
+      argument :type, required: false, default: nil
+
+      public_task :copy_views
+
+      desc "Creates a GoogleAnalytics A/B Test on Rails initializer to your application."
+
+      def copy_views
+        case type
+        when 'bootstrap3'
+
+        when 'position_under'
+          copy_file "ab_test_manager/position_under.html.erb", "app/views/google_analytics_ab_test_on_rails/_ab_test_manager.html.erb"
+        when 'position_top'
+          copy_file "ab_test_manager/position_top.html.erb", "app/views/google_analytics_ab_test_on_rails/_ab_test_manager.html.erb"
+        when nil
+          copy_file "ab_test_manager/position_top.html.erb", "app/views/google_analytics_ab_test_on_rails/_ab_test_manager.html.erb"
+        else
+          raise NameError.new("'#{type}' is undefined template type.")
+        end
+      end
+
+      # def insert_javascript_tag
+      #   inject_into_file "app/views/layouts/application.html.erb", after: /<head[\s]?[^>]*>/ do
+      #     "\n    <%= render_gtm_on_rails_tag_in_head %>\n"
+      #   end
+      #   inject_into_file "app/views/layouts/application.html.erb", after: /<body[\s]?[^>]*>/ do
+      #     "\n    <%= render_gtm_on_rails_tag_in_body %>\n"
+      #   end
+      # end
+    end
+  end
+end

data/lib/generators/templates/google_analytics_ab_test_on_rails.rb

@@ -0,0 +1,10 @@
+GoogleAnalyticsAbTestOnRails.configure do |config|
+  # Settings that use Google Tag Manager or analytics.js when send events Google Analytics.
+  config.sender = :gtm # :gtm or :analytics_js
+
+  # Google Analytics Tracking Event Settings
+  # Event Category is "#{controller_path}##{action_name}" if set nil.
+  config.tracking_event_category = nil
+  config.tracking_event_action   = 'ab_test'
+  config.tracking_event_label    = 'ABテスト_{ab_test_name}-{ab_test_value}'
+end

data/lib/generators/templates/views/ab_test_manager/position_top.html.erb

@@ -0,0 +1,35 @@
+<% if ab_tests.present? %>
+  <div id="ab_test_manager" class="position_top">
+    <div id="ab_test_manager_main_window">
+      <div>
+        <% ab_tests.each do |ab_test_name, ab_test_values| %>
+          <div class="ab_test_manager_ab_tests">
+            <%= ab_test_name %>：
+            <% values = ab_test_values.is_a?(Hash) ? ab_test_values.keys : ab_test_values %>
+            <% values.each do |ab_test_value| %>
+              <% value_name = ab_test_values.is_a?(Hash) ? "#{ab_test_value}(#{ab_test_values[ab_test_value]})" : ab_test_value %>
+              <% if get_ab_test_value(ab_test_name) != ab_test_value %>
+                <% path = url_for(params.merge(ga_ab_test_force_change: {ab_test_name => ab_test_value}).permit!.to_h) %>
+                <span>
+                  <%= link_to "#{value_name}", path %>
+                </span>
+              <% else %>
+                <span>
+                  ✓<%= value_name %>
+                </span>
+              <% end %>
+            <% end %>
+          </div>
+        <% end %>
+      </div>
+    </div>
+    <div id="ab_test_manager_btn_window">
+      <div id="js_ab_test_manager_close_btn">
+        <div>ab test manager ▲</div>
+      </div>
+      <div id="js_ab_test_manager_open_btn" style="display: none;">
+        <div>ab test manager ▼</div>
+      </div>
+    </div>
+  </div>
+<% end %>

data/lib/generators/templates/views/ab_test_manager/position_under.html.erb

@@ -0,0 +1,35 @@
+<% if ab_tests.present? %>
+  <div id="ab_test_manager" class="position_under">
+    <div id="ab_test_manager_btn_window">
+      <div id="js_ab_test_manager_close_btn">
+        <div>ab test manager ▼</div>
+      </div>
+      <div id="js_ab_test_manager_open_btn" style="display: none;">
+        <div>ab test manager ▲</div>
+      </div>
+    </div>
+    <div id="ab_test_manager_main_window">
+      <div>
+        <% ab_tests.each do |ab_test_name, ab_test_values| %>
+          <div class="ab_test_manager_ab_tests">
+            <%= ab_test_name %>：
+            <% values = ab_test_values.is_a?(Hash) ? ab_test_values.keys : ab_test_values %>
+            <% values.each do |ab_test_value| %>
+              <% value_name = ab_test_values.is_a?(Hash) ? "#{ab_test_value}(#{ab_test_values[ab_test_value]})" : ab_test_value %>
+              <% if get_ab_test_value(ab_test_name) != ab_test_value %>
+                <% path = url_for(params.merge(ga_ab_test_force_change: {ab_test_name => ab_test_value}).permit!.to_h) %>
+                <span>
+                  <%= link_to "#{value_name}", path %>
+                </span>
+              <% else %>
+                <span>
+                  ✓<%= value_name %>
+                </span>
+              <% end %>
+            <% end %>
+          </div>
+        <% end %>
+      </div>
+    </div>
+  </div>
+<% end %>

data/lib/google_analytics_ab_test_on_rails.rb

@@ -0,0 +1,4 @@
+require "google_analytics_ab_test_on_rails/engine"
+
+module GoogleAnalyticsAbTestOnRails
+end

data/lib/google_analytics_ab_test_on_rails/config.rb

@@ -0,0 +1,9 @@
+module GoogleAnalyticsAbTestOnRails
+  class Config
+    # Variables detail is writen in lib/generators/templates/gtm_on_rails.rb.
+    attr_accessor :sender
+    attr_accessor :tracking_event_category
+    attr_accessor :tracking_event_action
+    attr_accessor :tracking_event_label
+  end
+end

data/lib/google_analytics_ab_test_on_rails/controllers/ab_test_methods.rb

@@ -0,0 +1,124 @@
+module GoogleAnalyticsAbTestOnRails
+  module Controllers
+    module AbTestMethods
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :ab_test_start
+        helper_method :ab_tests
+        helper_method :get_ab_test_value
+      end
+      
+      def ab_test_start(ab_test_name, ab_test_values = ['true', 'false'], **args, &block)
+        ab_test_session_key = :"ga_ab_test_#{ab_test_name}"
+
+        # ABテスト一覧をABテストマネージャに表示する用
+        # 既に同じビューやコントローラ内で実行されている場合は再度処理は行わない
+        @ab_tests ||= {}
+        @ab_tests[ab_test_name] = ab_test_values if @ab_tests[ab_test_name].blank?
+
+        value = get_ga_ab_test_value(ab_test_name, ab_test_values, params)
+        if value
+          session[ab_test_session_key] = value
+
+          # GoogleAnalyticsではセッションが30分で切れてしまうため、30分毎にABテストイベントを再送信するためのcookie情報
+          cookies[:"#{ab_test_session_key}_for_ga_session"] = {value: true, expires: 30.minutes.from_now}
+
+          event_category = get_event_category(args)
+          event_action   = get_event_action(args)
+          event_label    = get_event_label(ab_test_name, value, args)
+          case GoogleAnalyticsAbTestOnRails.config.sender
+          when :gtm
+            @gtm_on_rails_data_layer.push({
+              event:          'ga_event',
+              event_category: event_category,
+              event_action:   event_action,
+              event_label:    event_label
+            })
+          when :analytics_js
+            @analytics_js_codes ||= []
+            @analytics_js_codes << "ga('send', 'event', {eventCategory: '#{event_category}', eventAction: '#{event_action}', eventLabel: '#{event_label}'});"
+          end
+        end
+
+        # GoogleAnalyticsではセッションが30分で切れてしまうため、30分毎にABテストイベントを再送信する
+        if cookies[:"#{ab_test_session_key}_for_ga_session"].blank?
+          cookies[:"#{ab_test_session_key}_for_ga_session"] = {value: true, expires: 30.minutes.from_now}
+
+          event_category = get_event_category(args)
+          event_action   = get_event_action(args)
+          event_label    = get_event_label(ab_test_name, value, args)
+          case GoogleAnalyticsAbTestOnRails.config.sender
+          when :gtm
+            @gtm_on_rails_data_layer.push({
+              event:          'ga_event',
+              event_category: event_category,
+              event_action:   event_action,
+              event_label:    event_label
+            })
+          when :analytics_js
+            @analytics_js_codes ||= []
+            @analytics_js_codes << "ga('send', 'event', {eventCategory: '#{event_category}', eventAction: '#{event_action}', eventLabel: '#{event_label}'});"
+          end
+        end
+
+        if block_given?
+          yield(session[ab_test_session_key])
+        else
+          return session[ab_test_session_key]
+        end
+      end
+
+      def ab_tests
+        @ab_tests ||= []
+      end
+
+      def get_ab_test_value(ab_test_name)
+        session["ga_ab_test_#{ab_test_name}"]
+      end
+      
+      private
+        def get_ga_ab_test_value(ab_test_name, ab_test_values, params)
+          ab_test_session_key = :"ga_ab_test_#{ab_test_name}"
+          if (params.dig(:ga_ab_test_force_change, ab_test_name).present? && session[ab_test_session_key] != params.dig(:ga_ab_test_force_change, ab_test_name))
+            value = params.dig(:ga_ab_test_force_change, ab_test_name)
+          elsif session[ab_test_session_key].blank?
+            # 確率設定
+            if ab_test_values.is_a?(Hash)
+              values = ab_test_values.map{|value, count| count.times.map{value}}.flatten
+            else
+              values = ab_test_values
+            end
+            value = values.sample
+          end
+          value
+        end
+
+        def get_event_category(args)
+          if args[:event_category].present?
+            args[:event_category]
+          else
+            GoogleAnalyticsAbTestOnRails.config.tracking_event_category || "#{controller_path}##{action_name}"
+          end
+        end
+
+        def get_event_action(args)
+          if args[:event_action].present?
+            args[:event_action]
+          else
+            GoogleAnalyticsAbTestOnRails.config.tracking_event_action || 'ab_test'
+          end
+        end
+
+        def get_event_label(ab_test_name, ab_test_value, args)
+          if args[:event_label].present?
+            label = args[:event_label]
+          else
+            label = GoogleAnalyticsAbTestOnRails.config.tracking_event_label || 'ab_test'
+          end
+
+          label.gsub(/\{ab_test_name\}/, ab_test_name.to_s).gsub(/\{ab_test_value\}/, ab_test_value.to_s)
+        end
+    end
+  end
+end

data/lib/google_analytics_ab_test_on_rails/engine.rb

@@ -0,0 +1,29 @@
+require 'google_analytics_ab_test_on_rails/config'
+require 'google_analytics_ab_test_on_rails/controllers/ab_test_methods'
+require 'google_analytics_ab_test_on_rails/helpers/ab_test_manager_helper'
+
+module GoogleAnalyticsAbTestOnRails
+  def self.config
+    @config ||= GoogleAnalyticsAbTestOnRails::Config.new
+  end
+ 
+  def self.configure(&block)
+    yield(config) if block_given?
+  end
+  
+  class Engine < ::Rails::Engine
+    isolate_namespace GoogleAnalyticsAbTestOnRails
+
+    initializer 'gtm_on_rails.action_controller_extension' do
+      ActiveSupport.on_load :action_controller do
+        include GoogleAnalyticsAbTestOnRails::Controllers::AbTestMethods
+      end
+    end
+
+    initializer 'gtm_on_rails.action_view_helpers' do
+      ActiveSupport.on_load :action_view do
+        include GoogleAnalyticsAbTestOnRails::Helpers::AbTestManagerHelper
+      end
+    end
+  end
+end

data/lib/google_analytics_ab_test_on_rails/helpers/ab_test_manager_helper.rb

@@ -0,0 +1,15 @@
+module GoogleAnalyticsAbTestOnRails
+  module Helpers
+    module AbTestManagerHelper
+      def render_ab_test_manager
+        tags = []
+        tags << render(partial: 'google_analytics_ab_test_on_rails/ab_test_manager')
+        tags.join.html_safe
+      end
+
+      def render_ab_test_analytics_js
+        "<script type=\"text/javascript\">#{(@analytics_js_codes || []).join}</script>".html_safe
+      end
+    end
+  end
+end

data/lib/google_analytics_ab_test_on_rails/version.rb

@@ -0,0 +1,3 @@
+module GoogleAnalyticsAbTestOnRails
+  VERSION = '0.1.0'
+end

data/lib/tasks/google_analytics_ab_test_on_rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :google_analytics_ab_test_on_rails do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: google_analytics_ab_test_on_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ykogure
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: gtm_on_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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: gtm_on_rails
+  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: This gem enables you to do A/B testing easy with Rails application.
+email:
+- renkin1008@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/views/google_analytics_ab_test_on_rails/_ab_test_manager.html.erb
+- lib/generators/google_analytics_ab_test_on_rails/install_generator.rb
+- lib/generators/google_analytics_ab_test_on_rails/views_generator.rb
+- lib/generators/templates/google_analytics_ab_test_on_rails.rb
+- lib/generators/templates/views/ab_test_manager/position_top.html.erb
+- lib/generators/templates/views/ab_test_manager/position_under.html.erb
+- lib/google_analytics_ab_test_on_rails.rb
+- lib/google_analytics_ab_test_on_rails/config.rb
+- lib/google_analytics_ab_test_on_rails/controllers/ab_test_methods.rb
+- lib/google_analytics_ab_test_on_rails/engine.rb
+- lib/google_analytics_ab_test_on_rails/helpers/ab_test_manager_helper.rb
+- lib/google_analytics_ab_test_on_rails/version.rb
+- lib/tasks/google_analytics_ab_test_on_rails_tasks.rake
+homepage: https://github.com/ykogure/google_analytics_ab_test_on_rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: This gem enables you to do A/B testing easy with Rails application.
+test_files: []