split-builder 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e671e123b348093ce0bb0b5683eb15c07f05ddea
+  data.tar.gz: 02e5187bbf695c0d879e187d018ba677c664b0f7
+SHA512:
+  metadata.gz: 95daef950f43e6185a35c271c1f9fbcdb0d39bf08a2b1446727ed0daf2a88e720a8e6009ee3f79ef02d5b29a721c71700da3649af5dcf927d16eafdfd92aa9e1
+  data.tar.gz: 5bd21f33ef50d28c11a8e718cd4447fe249cf7507cb013c5340eaf0c6a59787e6414eeb10477bf7e188e2100e154a6206578760b8b35e3e3a3642395df8d66df

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.8
+before_install: gem install bundler -v 1.13.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mark.allen@vydia.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Vydia, Inc.
+
+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,37 @@
+# SplitBuilder
+
+Keep your Routes, Controllers and Models thin.
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'split-builder'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install split-builder
+
+## Usage
+
+TODO
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/Vydia/split-builder. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["spec/**/*_spec.rb"]
+end
+
+task :spec => :test
+task :default => :test

data/bin/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "split-builder"
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/builder/errors.rb

@@ -0,0 +1,6 @@
+module SplitBuilder
+  class BuilderError < StandardError; end
+  class MetricAlreadyDefinedError < BuilderError; end
+  class ExperimentAlreadyHasMetricError < BuilderError; end
+  class UndefinedGoalError < BuilderError; end
+end

data/lib/builder/experiment.rb

@@ -0,0 +1,37 @@
+module SplitBuilder
+  class Experiment
+
+    def self.define(experiment_name, &block)
+      new(experiment_name, &block)
+    end
+
+    attr_reader :name, :metric_name
+
+    def initialize(experiment_name, &block)
+      @name = experiment_name
+      instance_exec(&block)
+    end
+
+    def alternatives
+      @alternatives ||= []
+    end
+
+    private
+
+    # Builder DSL
+
+    def metric(metric_name, &block)
+      if @metric_name
+        raise ExperimentAlreadyHasMetricError, "An experiment may not have more than one metric."
+      end
+
+      @metric_name = metric_name
+    end
+
+    def alternative(alternative_name, options = {})
+      # TODO: class Alternative
+      alternatives << options.merge(:name => alternative_name)
+    end
+
+  end
+end

data/lib/builder/metric.rb

@@ -0,0 +1,29 @@
+module SplitBuilder
+  class Metric
+
+    def self.define(metric_name, &block)
+      new(metric_name, &block)
+    end
+
+    attr_reader :name
+
+    def initialize(metric_name, &block)
+      @name = metric_name
+      instance_exec(&block) if block_given?
+      goal(metric_name) if goals.empty?
+    end
+
+    def goals
+      @goals ||= []
+    end
+
+    private
+
+    # Builder DSL
+
+    def goal(goal_name)
+      goals << goal_name
+    end
+
+  end
+end

data/lib/builder/schema.rb

@@ -0,0 +1,51 @@
+module SplitBuilder
+  class Schema
+
+    def self.define(&block)
+      new(&block)
+    end
+
+    def initialize(&block)
+      instance_exec(&block)
+    end
+
+    public
+
+    def get_metric_by_name(metric_name)
+      metrics.fetch(metric_name)
+    end
+
+    def goals
+      @goals ||= []
+    end
+
+    def metrics
+      @metrics ||= {}
+    end
+
+    def experiments
+      @experiments ||= []
+    end
+
+    private
+
+    # Builder DSL
+
+    def goal(goal_name)
+      goals << goal_name
+    end
+
+    def metric(metric_name, &block)
+      if metrics.key?(metric_name)
+        raise MetricAlreadyDefinedError, "Can't define another metric with the same name: #{metric_name.inspect}"
+      end
+
+      metrics[metric_name] = Metric.define(metric_name, &block)
+    end
+
+    def experiment(experiment_name, &block)
+      experiments << Experiment.define(experiment_name, &block)
+    end
+
+  end
+end

data/lib/builder/version.rb

@@ -0,0 +1,3 @@
+module SplitBuilder
+  VERSION = "0.0.1".freeze
+end

data/lib/split-builder.rb

@@ -0,0 +1,46 @@
+module SplitBuilder
+
+  module_function
+
+  # Given a SplitBuilder::Schema, get an experiments hash formatted for Split gem.
+  def dump_experiments(schema)
+    schema.experiments.each_with_object({}) do |experiment, experiments|
+      metric = schema.get_metric_by_name(experiment.metric_name)
+
+      experiments[experiment.name.to_s] = {
+        :metric => metric.name,
+        :goals => dump_goals(metric.goals, schema.goals),
+        :alternatives => dump_alternatives(experiment.alternatives),
+        :resettable => false # TODO: Pull from a default config.
+      }
+    end
+  end
+
+  # Private
+
+  def dump_goals(metric_goals, schema_goals)
+    undefined_goals = metric_goals - schema_goals
+
+    if undefined_goals.any?
+      raise UndefinedGoalError, "Goals #{undefined_goals.inspect} must be present in schema's defined goals: #{schema_goals.inspect}"
+    end
+
+    metric_goals.map(&:to_s)
+  end
+
+  def dump_alternatives(alternatives)
+    alternatives.map do |options|
+      {
+        :name => options.fetch(:name).to_s,
+        :percent => options.fetch(:percent, 50)
+      }
+    end
+  end
+
+end
+
+require "builder/version"
+require "builder/errors"
+require "builder/experiment"
+require "builder/metric"
+require "builder/schema"

data/split-builder.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "builder/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "split-builder"
+  spec.version       = SplitBuilder::VERSION
+  spec.authors       = ["TSMMark"]
+  spec.email         = ["dev@vydia.com"]
+
+  spec.summary       = %q{A nice DSL for defining Experiments for the Split gem.}
+  spec.description   = %q{No more struggling with big dumb Hashes when defining your Split Tests.}
+  spec.homepage      = "http://github.com/Vydia/split-builder"
+  spec.license       = "MIT"
+
+  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.add_development_dependency "pry", "~>0.10"
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: split-builder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- TSMMark
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: No more struggling with big dumb Hashes when defining your Split Tests.
+email:
+- dev@vydia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/builder/errors.rb
+- lib/builder/experiment.rb
+- lib/builder/metric.rb
+- lib/builder/schema.rb
+- lib/builder/version.rb
+- lib/split-builder.rb
+- split-builder.gemspec
+homepage: http://github.com/Vydia/split-builder
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A nice DSL for defining Experiments for the Split gem.
+test_files: []