flux_capacitor 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49cda02b4b59eeec057fe99708c69c9d33550ba7
-  data.tar.gz: 4106e315fe782950583290ac3c3e35e8b6227684
+  metadata.gz: d4107cf109861cb1776c98c445095f3570ed0e10
+  data.tar.gz: e2ec734dcb62f0d1f06a3de91b914cee9e53ef31
 SHA512:
-  metadata.gz: d7aba405e5ccf1bf730e30eb3f873568b3de30ce4054fde39c01dfa5615c466f6908354509dd545ec37ab098ec34ae86471d5b05a6d194ebb133cbe514e1c7f6
-  data.tar.gz: 5c07cf434a1de885608a0fe5cbe2fa3b2f24a996be6de0df6e2f9104e1ff6e554669b1fe5df9ad2993a277b322ec45ade27f2bf53185ab4edf0201d5606680a6
+  metadata.gz: 02ef0c049f13c79cb14cff6c2fcd699b4720f6cf6561b54de17e678daee5e4cdc9ffebb7ed05742d3176ce283d85ed4bee0e4094553dacd385db951d400afbcd
+  data.tar.gz: 457b0cc03af39e3a4dd1ddc38a01a0a6dbd3ffbd0d5d760d5bf6484162e7b5c881ccc5ac4a6847b9760019a00d4c96a2941ca0c01f7169a67c3888b19bd79665

data/flux_capacitor.gemspec

@@ -10,8 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["raphaeleidus@gmail.com"]
 
   spec.summary       = %q{Utility for progressively rolling out a feature to existing content}
-  spec.description   = %q{When you have some service that might not be able to handle a large transition of historical content, say a dynamic image service.
-    Instead of changing everything at once you can use the flux capacitor to progressively enable the new functionality based on content age.}
+  spec.description   = File.read('README.md')
   spec.homepage      = "https://github.com/raphaeleidus/flux_capacitor"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

data/lib/flux_capacitor/version.rb

@@ -1,3 +1,3 @@
 module Flux
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flux_capacitor
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Raphael Eidus
@@ -66,9 +66,82 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: |-
-  When you have some service that might not be able to handle a large transition of historical content, say a dynamic image service.
-      Instead of changing everything at once you can use the flux capacitor to progressively enable the new functionality based on content age.
+description: |
+  [![Gem Version](https://badge.fury.io/rb/flux_capacitor.svg)](https://badge.fury.io/rb/flux_capacitor)
+
+  # FluxCapacitor
+
+  Sometimes you want to change a feature or deploy a new feature but doing so all at once might take down some service. Enter Flux Capacitor. It allows you to gradually include more historical content in the new feature while allowing all future content to start out with the new feature already live.
+
+  ## Installation
+
+  Add this line to your application's Gemfile:
+
+  ```ruby
+  gem 'flux_capacitor'
+  ```
+
+  And then execute:
+
+      $ bundle
+
+  Or install it yourself as:
+
+      $ gem install flux_capacitor
+
+  ## Usage
+
+  ```ruby
+  require 'flux_capacitor'
+
+  pivot = DateTime.parse('2017/08/14 00:00:00-000') # when do you want to start rolling out the feature
+  oldest = MyModel.first.created_at # If you are using active record finding your oldest item is pretty easy
+  # otherwise if you know the date of your first item, just use that
+  end_point = DateTime.parse('2017/09/14') # The point where the feature is fully rolled out/safe to remove the Flux Capacitor.
+  # This dictates how quickly the feature rolls out. If you are concerned about overloading a required service set this to farther in the future
+
+  FEATURE_1_CAPACITOR = Flux::Capacitor.new(pivot, end_point, oldest)
+
+  def controller_method
+      model = MyModel.find(params[:id])
+      if FEATURE_1_CAPACITOR.travel_to?(model.created_at)
+          use_new_feature
+      else
+          use_old_feature
+      end
+  end
+  ```
+
+  If your feature doesn't map well to something where you have a date for each piece of content you can still use flux capacitor. It can also take strings and distribute them evenly over your rollout period using the murmur3 hashing algorithm.
+  ```ruby
+  require 'flux_capacitor'
+  pivot = DateTime.parse('2017/08/14 00:00:00-000') # when do you want to start rolling out the feature
+  end_point = DateTime.parse('2017/09/14') # when do you want the rollout to finish
+
+  # NOTE: We don't need an oldest date when using strings
+  FEATURE_1_CAPACITOR = Flux::Capacitor.new(pivot, end_point)
+
+  def controller_method
+      model = MyModel.find(params[:id])
+      if FEATURE_1_CAPACITOR.travel_to?(model.uuid)
+          use_new_feature
+      else
+          use_old_feature
+      end
+  end
+  ```
+
+  One note about using the string hashing method, new content could get the old feature for a while.
+
+  ## Development
+
+  After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/raphaeleidus/flux_capacitor.
 email:
 - raphaeleidus@gmail.com
 executables: []