chanko_ab 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b97fbd1349d68e6c318736e7fd0ad0ec0f86cfe8a731cb875ade20d6c785c72b
-  data.tar.gz: 92029f92c969fb816749987326dbb7be33d2e8813434193ebb3b611712eef6ce
+  metadata.gz: a967e68060d36eb785d8fd8759e8222e82c9e484e731e837064568ed12e62371
+  data.tar.gz: 23454bd8fe55e33eb8cf75ae6c9ca755f36eae4aef583c8970363b934251b477
 SHA512:
-  metadata.gz: 82b5a4eb5b35d016c6e0af2a0c13fff7f10a7c4dad52fb1379179e24113604b2c5d17d30701ab5b9f55b3008ed6f61551d82283c034d3b7a3e59f71433766938
-  data.tar.gz: a3615454afd6e4262931acf47f2ad08c33cced96f36293f27b8b03cf473e1d4732de30a8ad17df3f7adbc887afa155897109dd0f7a031af11ae45812f5ddcc07
+  metadata.gz: e7c9cbdb8222de95783a790f7168918a7dbad6c43d683a7c9a4e483b838fec080a42bcf96023ad04fd113a1a878879aeba9668a941e397a2ba32567e63141a67
+  data.tar.gz: 77e2ddf77e4298023e7de46f892db281c094f32c2b776401f20bb4d584d6b41de2fd57f00e71c06a4dbe0df45f82d40dbd6942ad74b321d129f974d4a48a7c8c

data/.gitignore

@@ -0,0 +1 @@
+.rubocop-https---raw-githubusercontent-com-cookpad-styleguide-master--rubocop-yml

data/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx lint-staged

data/.rubocop.yml

@@ -0,0 +1,16 @@
+inherit_from: https://raw.githubusercontent.com/cookpad/styleguide/master/.rubocop.yml
+
+inherit_mode:
+  merge:
+    - Exclude
+    - Include
+
+require:
+  - rubocop-rspec
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Layout/LineLength:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Change Log
+
+## [0.2.0] (2022-09-07)
+### Added
+- Selectable logic to use identifier.
+- Add HexIdentifier logic to use identifier composed by hex numbers.

data/README.md

@@ -38,7 +38,7 @@ module MySplitTest
   split_test.add(:default, {})
   split_test.add(:pattern1, { partial: 'partial1'} )
 
-  split_test.log_tesmplate('show' ,'my_split_test.[name]')
+  split_test.log_tenmplate('show' ,'my_split_test.[name]')
 
   split_test.define(:new_text, scope: :view) do
     ab.log('show')
@@ -53,6 +53,15 @@ module MySplitTest
 end
 ```
 
+### Use HexIdentifier if identifier is composed by hex.
+```ruby
+module HexMySplitTest
+  ...
+  split_test.logic ChankoAb::Logic::HexIdentifier
+  ...
+end
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/eudoxa/chanko_ab.

data/lib/chanko_ab/logic/base.rb

@@ -0,0 +1,95 @@
+module ChankoAb
+  module Logic
+    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 just_pattern_sizes
+        raise NotImplementedError
+      end
+
+      def validate!
+        unless Rails.env.production?
+          raise "Argument should be a divisor of #{just_patterns_size.max}, but #{split_size} is given." if !just_patterns_size.member?(split_size)
+          raise "Identifier is blank" if @identifier.blank?
+          raise "Identifier is too short" if @identifier.size < (@using_index + 1)
+          raise 'Too large pattern size' if patterns.size >= just_pattern_sizes.max
+        end
+      end
+
+      def ab_index
+        assigned_number % split_size
+      end
+
+      def should_run_default?
+        return true if !item
+        @identifier.blank?
+      end
+
+      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
+        return 0 if patterns.size == 0
+        ab_index
+      end
+      private :decide_pattern_index
+
+      def split_size
+        just_pattern_sizes.select { |_size| _size >= patterns.size }.min
+      end
+      private :split_size
+
+      def assigned_number
+        raise NotImplementedNumber
+      end
+      private :assigned_number
+    end
+  end
+end

data/lib/chanko_ab/logic/hex_identifier.rb

@@ -0,0 +1,15 @@
+require "chanko_ab/version"
+
+module ChankoAb
+  module Logic
+    class HexIdentifier < Base
+      def just_pattern_sizes
+        [1, 2, 4, 8, 16]
+      end
+
+      def assigned_number
+        @identifier.slice(-(@using_index + 1)).to_i(16)
+      end
+    end
+  end
+end

data/lib/chanko_ab/logic/number_identifier.rb

@@ -0,0 +1,15 @@
+require "chanko_ab/version"
+
+module ChankoAb
+  module Logic
+    class NumberIdentifier < Base
+      def just_pattern_sizes
+        [1, 2, 5, 10]
+      end
+
+      def assigned_number
+        @identifier.slice(-(@using_index + 1)).to_i
+      end
+    end
+  end
+end

data/lib/chanko_ab/split_test.rb

@@ -0,0 +1,94 @@
+module ChankoAb
+  class SplitTest
+    def initialize(unit)
+      @unit = unit
+      @patterns = []
+      @log_templates = {}
+
+      initialize_shared_methods
+    end
+
+    def process(caller_scope, request, identifier, &block)
+      process = logic_klass.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 logic(logic)
+      @logic = logic
+    end
+
+    def logic_klass
+      @logic || ChankoAb.default_logic || ChankoAb::Logic::NumberIdentifier
+    end
+
+    def add(name, attributes)
+      @patterns << [name, attributes]
+    end
+
+    def reset_patterns
+      @patterns = []
+    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 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
+end

data/lib/chanko_ab/test.rb

@@ -0,0 +1,20 @@
+module ChankoAb
+  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
+end

data/lib/chanko_ab/version.rb

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

data/lib/chanko_ab.rb

@@ -1,6 +1,20 @@
 require "chanko_ab/version"
+require "chanko_ab/split_test"
+require "chanko_ab/logic/base"
+require "chanko_ab/logic/number_identifier"
+require "chanko_ab/logic/hex_identifier"
 
 module ChankoAb
+  module ClassMethods
+    def split_test
+      @split_test ||= SplitTest.new(self)
+    end
+  end
+
+  def self.included(klass)
+    klass.extend(ClassMethods)
+  end
+
   def self.set_logging(&block)
     @logging_proc = block
   end
@@ -13,223 +27,16 @@ module ChankoAb
     @identifier_proc
   end
 
-  def self.log(caller_scope, name, options)
-    raise NotImplementedError unless @logging_proc
-    caller_scope.instance_exec(name, options, &@logging_proc)
+  def self.default_logic
+    @default_logic
   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
+  def self.set_default_logic(logic)
+    @default_logic = logic
   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)
+  def self.log(caller_scope, name, options)
+    raise 'Should implement logging proc via ChankoAb.set_logging {}' unless @logging_proc
+    caller_scope.instance_exec(name, options, &@logging_proc)
   end
 end

data/package.json

@@ -0,0 +1,13 @@
+{
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+
+  "lint-staged": {
+    "*.{rb,rake}": [
+      "rubocop -a"
+    ]
+  }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chanko_ab
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - morita shingo
@@ -45,6 +45,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".husky/pre-commit"
+- ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -54,7 +58,13 @@ files:
 - bin/setup
 - chanko_ab.gemspec
 - lib/chanko_ab.rb
+- lib/chanko_ab/logic/base.rb
+- lib/chanko_ab/logic/hex_identifier.rb
+- lib/chanko_ab/logic/number_identifier.rb
+- lib/chanko_ab/split_test.rb
+- lib/chanko_ab/test.rb
 - lib/chanko_ab/version.rb
+- package.json
 homepage:
 licenses: []
 metadata: {}