chanko_ab 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b97fbd1349d68e6c318736e7fd0ad0ec0f86cfe8a731cb875ade20d6c785c72b
+  data.tar.gz: 92029f92c969fb816749987326dbb7be33d2e8813434193ebb3b611712eef6ce
+SHA512:
+  metadata.gz: 82b5a4eb5b35d016c6e0af2a0c13fff7f10a7c4dad52fb1379179e24113604b2c5d17d30701ab5b9f55b3008ed6f61551d82283c034d3b7a3e59f71433766938
+  data.tar.gz: a3615454afd6e4262931acf47f2ad08c33cced96f36293f27b8b03cf473e1d4732de30a8ad17df3f7adbc887afa155897109dd0f7a031af11ae45812f5ddcc07

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in chanko_ab.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,177 @@
+PATH
+  remote: .
+  specs:
+    chanko_ab (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activejob (= 7.0.3.1)
+      activerecord (= 7.0.3.1)
+      activestorage (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      actionview (= 7.0.3.1)
+      activejob (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.0)
+    actionpack (7.0.3.1)
+      actionview (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activerecord (= 7.0.3.1)
+      activestorage (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.0.3.1)
+      activesupport (= 7.0.3.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (7.0.3.1)
+      activesupport (= 7.0.3.1)
+      globalid (>= 0.3.6)
+    activemodel (7.0.3.1)
+      activesupport (= 7.0.3.1)
+    activerecord (7.0.3.1)
+      activemodel (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+    activestorage (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activejob (= 7.0.3.1)
+      activerecord (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    builder (3.2.4)
+    chanko (2.2.1)
+      rails (>= 4.0.0)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    digest (3.1.0)
+    erubi (1.11.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.18.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    mini_portile2 (2.8.0)
+    minitest (5.16.3)
+    net-imap (0.2.3)
+      digest
+      net-protocol
+      strscan
+    net-pop (0.1.1)
+      digest
+      net-protocol
+      timeout
+    net-protocol (0.1.3)
+      timeout
+    net-smtp (0.3.1)
+      digest
+      net-protocol
+      timeout
+    nio4r (2.5.8)
+    nokogiri (1.13.8)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    racc (1.6.0)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails (7.0.3.1)
+      actioncable (= 7.0.3.1)
+      actionmailbox (= 7.0.3.1)
+      actionmailer (= 7.0.3.1)
+      actionpack (= 7.0.3.1)
+      actiontext (= 7.0.3.1)
+      actionview (= 7.0.3.1)
+      activejob (= 7.0.3.1)
+      activemodel (= 7.0.3.1)
+      activerecord (= 7.0.3.1)
+      activestorage (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      bundler (>= 1.15.0)
+      railties (= 7.0.3.1)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.3)
+      loofah (~> 2.3)
+    railties (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    strscan (3.0.4)
+    thor (1.2.1)
+    timeout (0.3.0)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  chanko (>= 2.1.0)
+  chanko_ab!
+  rspec
+
+BUNDLED WITH
+   1.17.2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2018 shingo morita
+
+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,58 @@
+# ChankoAb
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chanko_ab'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chanko_ab
+
+## Usage
+```ruby
+# Define logging code and identifier
+# e.g.
+ChankoAb.set_logging do |name|
+  Rails.logger.debug(name)
+end
+
+ChankoAb.set_identifier do
+  cookies[:identifier]
+end
+```
+
+```ruby
+# And then, prepare ab test chanko unit.
+module MySplitTest
+  include Chanko::Unit
+  include ChankoAb
+
+  split_test.add(:default, {})
+  split_test.add(:pattern1, { partial: 'partial1'} )
+
+  split_test.log_tesmplate('show' ,'my_split_test.[name]')
+
+  split_test.define(:new_text, scope: :view) do
+    ab.log('show')
+
+    case ab.name
+    when 'default'
+      run_default
+    else
+      render ab.fetch(:partial)
+    end
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/eudoxa/chanko_ab.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "chanko_ab"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/chanko_ab.gemspec

@@ -0,0 +1,24 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "chanko_ab/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "chanko_ab"
+  spec.version       = ChankoAb::VERSION
+  spec.authors       = ["morita shingo"]
+  spec.email         = ["morita.shingo@gmail.com"]
+  spec.summary       = %q{ab test extension for chanko}
+  spec.description   = %q{ab test extension for chanko}
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+
+  spec.add_development_dependency "chanko", ">= 2.1.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/chanko_ab/version.rb

@@ -0,0 +1,3 @@
+module ChankoAb
+  VERSION = "0.1.1"
+end

data/lib/chanko_ab.rb

@@ -0,0 +1,235 @@
+require "chanko_ab/version"
+
+module ChankoAb
+  def self.set_logging(&block)
+    @logging_proc = block
+  end
+
+  def self.set_identifier(&block)
+    @identifier_proc = block
+  end
+
+  def self.identifier_proc
+    @identifier_proc
+  end
+
+  def self.log(caller_scope, name, options)
+    raise NotImplementedError unless @logging_proc
+    caller_scope.instance_exec(name, options, &@logging_proc)
+  end
+
+  module Process
+    class Base
+      def initialize(split_test, caller_scope, request, identifier, using_index)
+        @split_test = split_test
+        @caller_scope = caller_scope
+        @request = request
+        @identifier = identifier
+        @using_index = using_index || 0
+        @data = {}
+      end
+
+      def data(name, &block)
+        @data[name] ||= block.call
+      end
+
+      def should_run_default?
+        raise NotImplementedError
+      end
+      private :should_run_default?
+
+      def pattern_by_overwritten
+        overwritten_name = ChankoAb::Test.overwritten_name(@split_test.unit)
+        pattern = patterns.detect { |pt| pt[0] == overwritten_name }
+        pattern || raise("ChankoAb: specified no defined name '#{overwritten_name}'")
+      end
+      private :pattern_by_overwritten
+
+      def name
+        item[0]
+      end
+
+      def fetch(key)
+        item[1][key]
+      end
+
+      def log_key(template_name)
+        template = @split_test.fetch_template(template_name)
+        template.gsub('[name]', name)
+      end
+
+      def log(template_name)
+        ChankoAb.log(@caller_scope, log_key(template_name), request: @request, identifier: @identifier)
+      end
+
+      def item
+        if Rails.env.test? && ChankoAb::Test.overwritten?(@split_test.unit)
+          return pattern_by_overwritten
+        else
+          index = decide_pattern_index
+          return nil if index > patterns.size
+          return patterns[index]
+        end
+      end
+
+      def patterns
+        @split_test.patterns
+      end
+      private :patterns
+
+      def decide_pattern_index
+        #e.g
+        raise NotImplementedError
+      end
+      private :decide_pattern_index
+    end
+
+    class NumberIdentifier < Base
+      DEFAULT_JUST_PATTERN_SIZES = [1, 2, 5, 10]
+
+      def just_pattern_sizes
+        DEFAULT_JUST_PATTERN_SIZES
+      end
+
+      def should_run_default?
+        return true if !item
+        @identifier.blank?
+      end
+
+      def ab_index(identifier, size, using_index)
+        unless Rails.env.production?
+          raise "argument should be a divisor of 10 but #{size}" if !just_pattern_sizes.member?(size)
+          raise "identifier is blank" if identifier.blank?
+          raise "using_index error" if identifier.size < (using_index + 1)
+        end
+        using_number = identifier.slice(-(using_index + 1)).to_i
+        using_number % size
+      end
+
+      def decide_pattern_index
+        return 0 if patterns.size == 0
+        raise 'too large size' if patterns.size >= just_pattern_sizes.max
+        size = just_pattern_sizes.select { |size| size >= patterns.size }.min
+        ab_index(@identifier, size, @using_index)
+      end
+    end
+  end
+
+  class SplitTest
+    def initialize(unit)
+      @unit = unit
+      @patterns = []
+      @log_templates = {}
+
+      initialize_shared_methods
+    end
+
+    def process(caller_scope, request, identifier, &block)
+      process = ChankoAb::Process::NumberIdentifier.new(self, caller_scope, request, identifier, @using_index)
+
+      processes.push(process)
+      begin
+        block.call(process)
+      ensure
+        processes.pop
+      end
+    end
+
+    def unit
+      @unit
+    end
+
+    def add(name, attributes)
+      @patterns << [name, attributes]
+    end
+
+    def log_template(name, template)
+      @log_templates[name] = template
+    end
+
+    def patterns
+      @patterns
+    end
+
+    def fetch_template(name)
+      @log_templates[name]
+    end
+
+    def processes
+      @processes ||= []
+    end
+
+    def using_index(index)
+      @using_index = index
+    end
+
+    def use_user_via(&user_proc)
+      @user_proc = user_proc
+    end
+
+    def user_ab?
+      !!@user_proc
+    end
+
+    def define(key, options = {}, &block)
+      __split_test__ = self
+      unit.class_eval do
+        scope(options[:scope] || :view) do
+          function(key) do
+            __split_test__.process(self, request, identifier) do |process|
+              next run_default if process.should_run_default?
+              self.instance_eval(&block)
+            end
+          end
+        end
+      end
+    end
+
+    def initialize_shared_methods
+      __split_test__ = self
+      @unit.class_eval do
+        shared(:unit_name) do
+          @units.last.name
+        end
+
+        shared(:ab) do
+          __split_test__.processes.last
+        end
+
+        shared(:identifier) do
+          self.instance_eval(&ChankoAb.identifier_proc)
+        end
+      end
+    end
+    private :initialize_shared_methods
+  end
+
+  module Test
+    def self.overwritten_name(klass)
+      @overwritten_names[klass]
+    end
+
+    def self.overwrite(klass, name)
+      @overwritten_names ||= {}
+      @overwritten_names[klass] = name
+    end
+
+    def self.overwritten?(klass)
+      !!@overwritten_names[klass]
+    end
+
+    def self.reset!
+      @overwritten_names = {}
+    end
+  end
+
+  module ClassMethods
+    def split_test
+      @split_test ||= SplitTest.new(self)
+    end
+  end
+
+  def self.included(klass)
+    klass.extend(ClassMethods)
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: chanko_ab
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- morita shingo
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chanko
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.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: ab test extension for chanko
+email:
+- morita.shingo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- chanko_ab.gemspec
+- lib/chanko_ab.rb
+- lib/chanko_ab/version.rb
+homepage:
+licenses: []
+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: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: ab test extension for chanko
+test_files: []