date_range_rollout 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 73cde61347df868f2cbb1b74b5ec0e04dc3f831e10b62afa2999158f19d209c3
+  data.tar.gz: 5e4e2bf729d43a9b25c260988fb3412410af37642ad158466584cd39fbcc8182
+SHA512:
+  metadata.gz: addd646c365bea6a36f89cf6aefdf5b1ab3759b3678da0e50f8b6b3a3f5c3b4b9ab38af28dadf664d8aa7f73205a4c4a31b9443668b281f6e23b40cfb3d1d66e
+  data.tar.gz: 8848fb9685a7ccdc03935dd6d49dccbb0e6cfa390535fa02e7ef120cae0fe58565380e0db1b50b7b8f283ebdd1922be255dc332bac79e4f4a229ae6f530d8208

data/.github/workflows/test.yml

@@ -0,0 +1,28 @@
+name: Run Tests
+on: [push, pull_request]
+
+jobs:
+  tests:
+    name: Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - name: Ruby gem cache
+        uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-
+      - name: Install gems
+        run: |
+          bundle config path vendor/bundle
+          bundle install --retry 3
+      - name: Run tests
+        run: bundle exec rake test

data/.gitignore

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

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 date_range_rollout.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Netlify
+
+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,67 @@
+# DateRangeRollout
+
+Gradual transition from one value to another between two dates.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'date_range_rollout'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install date_range_rollout
+
+## Usage
+
+Example: Get the percentage of time elapsed in the year:
+```ruby
+start_value = 0
+start_date = Time.parse("2020-01-01")
+end_value = 100
+end_date = Time.parse("2020-12-31")
+
+DateRangeRollout.build(start_value, start_date, end_value, end_date).get
+```
+
+Example: Slowly increase the numbers of jobs per day over the course of a month.
+Imagine this class being run every day. This will perform 100 (`start_value`)
+jobs until `start_date`, slowly increase the number until `end_date`, and stay
+at 500 (`end_value`) after that date.
+Since `get` returns a float, we want to round that value to the nearest integer.
+```ruby
+class SomeWorker
+  def perform
+    start_value = 100
+    start_date = Time.parse("2020-02-17")
+    end_value = 500
+    end_date = Time.parse("2020-03-17")
+
+    jobs_count = DateRangeRollout.build(start_value, start_date, end_value, end_date).get
+
+    jobs_count.round.times do
+      JobClass.do_something
+    end
+  end
+end
+```
+
+## 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/netlify/date_range_rollout.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "date_range_rollout"
+
+# 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/date_range_rollout.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "date_range_rollout/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "date_range_rollout"
+  spec.version       = DateRangeRollout::VERSION
+  spec.authors       = ["Mike Heffner", "Esteban Pastorino"]
+  spec.email         = ["mike.heffner@netlify.com", "esteban@netlify.com"]
+
+  spec.summary       = %q{Gradual transition from one value to another based on dates}
+  spec.description   = %q{Gradual transition from one value to another based on dates}
+  spec.homepage      = "https://github.com/netlify/date_range_rollout"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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 "bundler", ">= 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "timecop", "~> 0.9.1"
+end

data/lib/date_range_rollout.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "date_range_rollout/version"
+require "date_range_rollout/rollout"
+
+module DateRangeRollout
+  class Error < StandardError; end
+  class DateRangeError < Error; end
+
+  def self.build(start_duration, start_date, end_duration, end_date)
+    Rollout.new(start_duration, start_date, end_duration, end_date)
+  end
+end

data/lib/date_range_rollout/rollout.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "time"
+
+module DateRangeRollout
+  class Rollout
+    def initialize(start_duration, start_date, end_duration, end_date)
+      if start_date > end_date
+        raise DateRangeError, "Start date should be before end date"
+      end
+
+      @start_duration = start_duration
+      @start_date = start_date
+      @end_duration = end_duration
+      @end_date = end_date
+    end
+
+    def get
+      now = Time.now
+
+      if now <= @start_date
+        return @start_duration.to_f
+      end
+
+      if now >= @end_date
+        return @end_duration.to_f
+      end
+
+      offset = now.to_f - @start_date.to_f
+      pct = offset / (@end_date.to_f - @start_date.to_f)
+
+      pct * (@end_duration - @start_duration) + @start_duration
+    end
+  end
+end

data/lib/date_range_rollout/version.rb

@@ -0,0 +1,3 @@
+module DateRangeRollout
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: date_range_rollout
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Heffner
+- Esteban Pastorino
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+description: Gradual transition from one value to another based on dates
+email:
+- mike.heffner@netlify.com
+- esteban@netlify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- date_range_rollout.gemspec
+- lib/date_range_rollout.rb
+- lib/date_range_rollout/rollout.rb
+- lib/date_range_rollout/version.rb
+homepage: https://github.com/netlify/date_range_rollout
+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: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Gradual transition from one value to another based on dates
+test_files: []