step_by_step 0.0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 914546dc63e40d0896c7b86b82b42671ae777299
+  data.tar.gz: 95cf8bf3d06b7c14d629669f214a23e4fae5c76a
+SHA512:
+  metadata.gz: 1d06e4a64e8249df4fa010ab93952490c8fb1aecabaa01c0d17ff1ac7cc64a3bc926a2bb18f091805f18994a7b5b6fc2927b7883acc5eb18624db7208fbd1fdb
+  data.tar.gz: 5ce8f9b3a8b4a796242ea15e6b0d8722de1c1c80a0e0250b5c7fe20468029509631cacfd89547843b7a25a4a10fa13e28f0f3f9ba61ddfc259353acbbc8887b1

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in step_by_step.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 CrowdCurity
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Dennis Charles Hackethal
+
+MIT License
+
+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,190 @@
+# StepByStep
+
+This gem is largely inspired by the [Railscast on rollouts and degrading](http://railscasts.com/episodes/315-rollout-and-degrade), as well as the [Rollout gem](https://github.com/FetLife/rollout) that is covered in aforementioned Railscast. While very comprehensive, it uses a Redis backend, that might not be desirable to everyone. Though there are some alternatives out there, most of them are either outdated or not as comprehensive as the rollout gem itself.
+
+StepByStep uses ActiveRecord as backend instead and tries to cover as many use cases and features as the original rollout gem. It is easy to use since no additional backend needs to be set up, and adds some helpful methods that shall assist you in rolling out and degrading features reliably.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'step_by_step'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install step_by_step
+    
+Since StepByStep uses ActiveRecord, you need to create the following migration:
+
+    $ rails g migration create_rollouts name group user_id:integer percentage:integer failure_count:integer
+    
+Then migrate your database.
+
+## Usage
+
+Let's say you have this new commenting feature that you would like to deploy to production, but you only want a subset of your users to be able to see it. Also, you may want to degrade a feature later, or disable it again altogether.
+
+### Rolling Out Features
+
+#### Rolling Out To A Group Of Users
+
+You can define groups with any custom logic like this:
+
+```ruby
+StepByStep::Rollout.define_group :admins do |user|
+  user.admin?
+end
+```
+
+Consider putting this in an initializer, such as `config/initializers/step_by_step.rb`.
+
+Roll out your feature to your group:
+
+```ruby
+StepByStep::Rollout.activate_group(:comments, :admins)
+```
+
+#### Rolling Out To A Fraction Of Users
+
+```ruby
+StepByStep::Rollout.activate_percentage(:comments, 20)
+end
+```
+
+Now 20% of your users can see the comments feature. As in the original gem, this is based on the following algorithm:
+
+```
+CRC32(user.id) % 100 < percentage # pseudocode
+```
+
+So, for 20%, a feature will be rolled out to users with ids 0, 1, 10, 11, 20, 21, etc. These users also remain as the percentage increases.
+
+#### Rolling Out To A Specific User
+
+```ruby
+StepByStep::Rollout.activate_user(:comments, User.first)
+```
+
+Now your first user can see the comments feature.
+
+#### Rolling Out To Everyone
+
+```ruby
+StepByStep::Rollout.activate(:comments)
+```
+
+Now everyone can see the comments feature. This is theoretically the same as activating a percentage with value 100 or defining a group with a block that always returns true.
+
+Activating a feature for everyone is common after you have determined that your rollout phase was successful.
+
+### Deactivating Features
+
+You can easily deactivate new features depending on your needs.
+
+#### Deactivating A Feature For Everyone
+
+```ruby
+StepByStep::Rollout.deactivate(:comments)
+```
+
+Nobody can see your new comments feature anymore.
+
+#### Deactivating A Group Feature
+
+Your admins shouldn't be able to see the comments anymore? Easy:
+
+```ruby
+StepByStep::Rollout.deactivate_group(:comments, :admins)
+```
+
+#### Deactivating A Single User Feature
+
+And there this one user who could see the comments. Let's hide them from him again:
+
+```ruby
+StepByStep::Rollout.deactivate_user(:comments, User.first)
+```
+
+#### Deactivating A Feature For A Fraction Of Users
+
+Remember those 20% who could see your new feature? Let's get rid of them, too:
+
+```ruby
+StepByStep::Rollout.deactivate_percentage(:comments)
+```
+
+### Displaying Features
+
+StepByStep comes with a few helper methods, one of which is called `rollout?`. It's available in your controllers as well as in your views. You just pass it the feature name to check if it has been rolled out to your `current_user`.
+
+#### View Example
+
+It's as simple as:
+
+```erb
+<% if rollout?(:comments) %>
+  <%= # your awesome feature here %>
+<% end %>
+```
+
+#### Controller Example
+
+Sometimes, you may want to hide a view completely. You can either do this directly in a controller action:
+
+```ruby
+def show
+  unless rollout?(:comments)
+    redirect_to root_path, notice: 'Access denied'
+  end
+end
+```
+
+or preferably using before actions:
+
+```ruby
+before_action :rollout
+
+private
+def rollout
+  unless rollout?(:comments)
+    redirect_to root_path, notice: 'Access denied'
+  end
+end
+```
+
+### Degrading A Feature
+
+Every rollout comes with a `failure_count`. A helper method is added to your application controller that allows you to track exceptions and increments the failure count for your feature. A failure count of 1 or higher disables your feature.
+
+For instance, you could degrade a feature doing the following in your feature controller:
+
+```ruby
+around_action :degrade
+
+private
+def degrade
+  degrade_feature(:comments) { yield }
+end
+```
+
+## Foolish Assumptions
+
+- You have a `current_user` method in your application controller that returns the authenticated user or nil if not authenticated (standard behavior, used e.g. by Devise)
+- You are using Rails
+- Your user model's primary key is `id` (Rails default)
+
+## Dependencies
+
+StepByStep requires Rails 3.2 or higher.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/step_by_step/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/step_by_step.rb

@@ -0,0 +1,13 @@
+require "active_record"
+require "rails"
+require "step_by_step/version"
+require "step_by_step/rollout"
+require "step_by_step/controller"
+
+module StepByStep
+  class Engine < ::Rails::Engine
+    initializer 'step_by_step.controllers' do |app|
+      ActionController::Base.send :include, StepByStep::Controller
+    end
+  end
+end

data/lib/step_by_step/controller.rb

@@ -0,0 +1,27 @@
+module StepByStep
+  module Controller
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :rollout?
+      hide_action :rollout?
+
+      hide_action :degrade_feature
+    end
+
+    def rollout?(name)
+      Rollout.where(name: name).any? do |rollout|
+        rollout.match?(current_user)
+      end
+    end
+
+    def degrade_feature(name)
+      yield
+    rescue StandardError => e
+      Rollout.where(name: name).each do |rollout|
+        rollout.increment!(:failure_count)
+      end
+      raise e
+    end
+  end
+end

data/lib/step_by_step/rollout.rb

@@ -0,0 +1,86 @@
+module StepByStep
+  class Rollout < ActiveRecord::Base
+    def match?(user)
+      user && enabled? && (match_group?(user) || match_user?(user) || match_percentage?(user))
+    end
+
+    # Activates a feature for everyone
+    def self.activate(name)
+      create! name: name, group: :all
+    end
+
+    # Activates a feature for a specific group
+    def self.activate_group(name, group)
+      create! name: name, group: group
+    end
+
+    # Activates a feature for a fraction of users
+    def self.activate_percentage(name, percentage)
+      create! name: name, percentage: percentage
+    end
+
+    # Activates a feature for a specific user
+    def self.activate_user(name, user)
+      create! name: name, user_id: user.id
+    end
+
+    # Deactivates a feature for everyone
+    def self.deactivate(name)
+      where(name: name).destroy_all
+    end
+
+    # Deactivates a feature for a specific group
+    def self.deactivate_group(name, group)
+      where(name: name, group: group).destroy_all
+    end
+
+    # Deactivates a feature for a specific user
+    def self.deactivate_user(name, user)
+      where(name: name, user_id: user.id).destroy_all
+    end
+
+    # Deactivates a feature for a fraction of users
+    def self.deactivate_percentage(name)
+      where('name = ? AND percentage IS NOT NULL', name).destroy_all
+    end
+
+    # Define groups
+    def self.define_group(group, &block)
+      @@groups ||= []
+      @@groups << [group.to_sym, ->(user){ yield(user) }]
+    end
+
+    define_group(:all) do
+      true
+    end
+
+  private
+    def enabled?
+      failure_count.to_i < 1
+    end
+
+    def match_group?(user)
+      if group
+        # Find the group whose block should be evaluated based on its name
+        g = @@groups.select { |i| i.first.to_sym == group.to_sym }
+
+        # There could theoretically be multiple groups with the same name;
+        # only take the last one
+        g = g.last
+
+        # g is now an array that looks like this:
+        # [:group_name, code_block]
+        # Call the code block here with the user
+        g.last.call(user)
+      end
+    end
+
+    def match_user?(user)
+      user_id ? user_id == user.id : false
+    end
+
+    def match_percentage?(user)
+      percentage ? Zlib::crc32(user.id.to_s) % 100 < percentage : false
+    end
+  end
+end

data/lib/step_by_step/version.rb

@@ -0,0 +1,3 @@
+module StepByStep
+  VERSION = "0.0.1.5"
+end

data/spec/rollout_spec.rb

@@ -0,0 +1,79 @@
+require "spec_helper"
+
+module StepByStep
+  describe Rollout do
+    let!(:user) { Struct.new(:id, :email) }
+
+    # User who matches
+    let!(:user_1) { user.new(1, 'test@test.com') }
+
+    # User who doesn't match
+    let!(:user_2) { user.new(2, 'nope@test.com') }
+
+    # User who is not logged in (current user will return nil if nobody is logged in)
+    let!(:user_3) { nil }
+
+    before :all do
+      Rollout.define_group(:admins) do |user|
+        emails = [
+          'test@test.com'
+        ]
+        emails.include?(user.email)
+      end
+    end
+
+    it 'rolls out to all' do
+      rollout = Rollout.activate(:feature)
+      expect(rollout.match?(user_1)).to be_truthy
+      expect(rollout.match?(user_2)).to be_truthy
+    end
+
+    it 'rolls out to a group' do
+      rollout = Rollout.activate_group(:feature, :admins)
+      expect(rollout.match?(user_1)).to be_truthy
+      expect(rollout.match?(user_2)).to be_falsey
+    end
+
+    it 'rolls out to a user' do
+      rollout = Rollout.activate_user(:feature, user_1)
+      expect(rollout.match?(user_1)).to be_truthy
+      expect(rollout.match?(user_2)).to be_falsey
+    end
+
+    it 'rolls out to a percentage' do
+      rollout = Rollout.activate_percentage(:feature, 50)
+
+      expect(rollout.match?(user_1)).to be_falsey
+      expect(rollout.match?(user_2)).to be_truthy
+    end
+
+    it 'handles users who are not logged in' do
+      rollout = Rollout.activate_group(:feature, :admins)
+      expect(rollout.match?(user_3)).to be_falsey
+    end
+
+    it 'deactivates all' do
+      Rollout.activate_group(:feature, :all)
+      Rollout.deactivate(:feature)
+      expect(Rollout.where(name: :feature).any?).to be_falsey
+    end
+
+    it 'deactivates a group' do
+      Rollout.activate_group(:feature, :admins)
+      Rollout.deactivate_group(:feature, :admins)
+      expect(Rollout.where(name: :feature, group: :admins).any?).to be_falsey
+    end
+
+    it 'deactivates a user' do
+      Rollout.activate_user(:feature, user_1)
+      Rollout.deactivate_user(:feature, user_1)
+      expect(Rollout.where(name: :feature, user_id: user_1.id).any?).to be_falsey
+    end
+
+    it 'deactivates a percentage' do
+      Rollout.activate_percentage(:feature, 50)
+      Rollout.deactivate_percentage(:feature)
+      expect(Rollout.where('name = ? AND percentage IS NOT NULL', :feature).any?).to be_falsey
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "step_by_step"
+
+# Establish a connection to db
+ActiveRecord::Base.establish_connection(
+  adapter: "sqlite3",
+  database: File.dirname(__FILE__) + "/step_by_step.sqlite3"
+)
+
+# Load schema every time the specs are run
+load File.dirname(__FILE__) + '/support/schema.rb'

data/spec/support/schema.rb

@@ -0,0 +1,13 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :rollouts, force: true do |t|
+    t.string :name
+    t.string :group
+    t.integer :user_id
+    t.integer :percentage
+    t.integer :failure_count
+
+    t.timestamps
+  end
+end

data/step_by_step.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'step_by_step/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "step_by_step"
+  spec.version       = StepByStep::VERSION
+  spec.authors       = ["Dennis Charles Hackethal"]
+  spec.email         = ["dennis.hackethal@gmail.com"]
+  spec.summary       = %q{Active Record alternative to https://github.com/FetLife/rollout.}
+  spec.description   = %q{Alternative to https://github.com/FetLife/rollout, with an Active Record backend and additional helpers, partially based on Ryan Bates's custom solution in http://railscasts.com/episodes/315-rollout-and-degrade.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "pry"
+  spec.add_dependency 'rails', '>= 3.2'
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: step_by_step
+version: !ruby/object:Gem::Version
+  version: 0.0.1.5
+platform: ruby
+authors:
+- Dennis Charles Hackethal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Alternative to https://github.com/FetLife/rollout, with an Active Record
+  backend and additional helpers, partially based on Ryan Bates's custom solution
+  in http://railscasts.com/episodes/315-rollout-and-degrade.
+email:
+- dennis.hackethal@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/step_by_step.rb
+- lib/step_by_step/controller.rb
+- lib/step_by_step/rollout.rb
+- lib/step_by_step/version.rb
+- spec/rollout_spec.rb
+- spec/spec_helper.rb
+- spec/step_by_step.sqlite3
+- spec/support/schema.rb
+- step_by_step.gemspec
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Active Record alternative to https://github.com/FetLife/rollout.
+test_files:
+- spec/rollout_spec.rb
+- spec/spec_helper.rb
+- spec/step_by_step.sqlite3
+- spec/support/schema.rb