beta_feature 0.1.0

data/gemfiles/rails60.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", ">= 6.0.0.rc1", "< 6.1"
+
+gemspec path: "../"

data/gemfiles/rails60.gemfile.lock

@@ -0,0 +1,199 @@
+PATH
+  remote: ..
+  specs:
+    beta_feature (0.1.0)
+      rails (>= 4.2, < 6.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      activejob (= 6.0.2.2)
+      activerecord (= 6.0.2.2)
+      activestorage (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+      mail (>= 2.7.1)
+    actionmailer (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      actionview (= 6.0.2.2)
+      activejob (= 6.0.2.2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.2.2)
+      actionview (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      activerecord (= 6.0.2.2)
+      activestorage (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.2.2)
+      activesupport (= 6.0.2.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.2.2)
+      activesupport (= 6.0.2.2)
+      globalid (>= 0.3.6)
+    activemodel (6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activerecord (6.0.2.2)
+      activemodel (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activestorage (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      activejob (= 6.0.2.2)
+      activerecord (= 6.0.2.2)
+      marcel (~> 0.3.1)
+    activesupport (6.0.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.0)
+    builder (3.2.4)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
+    diff-lcs (1.3)
+    erubi (1.9.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    loofah (2.5.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.4)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.0)
+    mysql2 (0.5.3)
+    nio4r (2.5.2)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.19.1)
+    parser (2.7.1.1)
+      ast (~> 2.4.0)
+    pg (1.2.3)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.2)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.2.2)
+      actioncable (= 6.0.2.2)
+      actionmailbox (= 6.0.2.2)
+      actionmailer (= 6.0.2.2)
+      actionpack (= 6.0.2.2)
+      actiontext (= 6.0.2.2)
+      actionview (= 6.0.2.2)
+      activejob (= 6.0.2.2)
+      activemodel (= 6.0.2.2)
+      activerecord (= 6.0.2.2)
+      activestorage (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+      bundler (>= 1.3.0)
+      railties (= 6.0.2.2)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-rails (3.9.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.82.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    ruby-progressbar (1.10.1)
+    sprockets (4.0.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  beta_feature!
+  mysql2 (>= 0.3.20)
+  pg (>= 0.18, < 2.0)
+  pry
+  rails (>= 6.0.0.rc1, < 6.1)
+  rake (>= 12.3.3)
+  rspec (>= 3.0)
+  rspec-rails (>= 3.5)
+  rubocop (>= 0.54.0)
+
+BUNDLED WITH
+   1.17.3

data/lib/beta_feature.rb

@@ -0,0 +1,24 @@
+require 'active_record'
+require 'active_support'
+require 'yaml'
+
+require "beta_feature/version"
+require "beta_feature/flagger"
+require "beta_feature/setting"
+require "beta_feature/error"
+
+module BetaFeature
+  def self.all_betas
+    @@__all_betas__ ||= YAML.load_file("#{Rails.root}/config/beta_features.yml")
+  end
+
+  def self.in_progress
+    @@__in_progress_betas__ ||= all_betas.select {|k, v| v["status"] == 'in_progress'}
+  end
+
+  def self.released
+    @@__released_betas__ ||= all_betas.select {|k, v| v["status"] == 'released'}
+  end
+end
+
+::ActiveRecord::Base.send :include, BetaFeature::Flagger

data/lib/beta_feature/error.rb

@@ -0,0 +1,4 @@
+module BetaFeature
+  class Error < StandardError; end
+  class BetaNotDefined < Error; end
+end

data/lib/beta_feature/flagger.rb

@@ -0,0 +1,70 @@
+require 'set'
+
+module BetaFeature
+
+  module Flagger
+    extend ::ActiveSupport::Concern
+
+    module ClassMethods
+      def flagger
+        return if included_modules.include?(::BetaFeature::Flagger::BetaFeatureInstanceMethods)
+
+        include ::BetaFeature::Flagger::BetaFeatureInstanceMethods
+
+        has_one :beta_feature_setting, class_name: "BetaFeature::Setting", as: :betable
+      end
+    end
+
+    module BetaFeatureInstanceMethods
+      def can_access_beta?(*betas)
+        betas = betas.map(&:to_s)
+        validate_beta_name(*betas)
+        betas.all? {|key| all_betas.include?(key) }
+      end
+
+      # add feature flags.
+      def enable_beta!(*betas)
+        betas = betas.map(&:to_s)
+        validate_beta_name(*betas)
+        betas = (find_or_create_beta_feature_setting.betas + betas).uniq
+        beta_feature_setting.update(betas: betas)
+
+        flush_beta_cache
+      end
+
+      #remove feature flags
+      def remove_beta!(*betas)
+        betas = betas.map(&:to_s)
+        validate_beta_name(*betas)
+
+        betas = (find_or_create_beta_feature_setting.betas - betas).uniq
+        beta_feature_setting.update(betas: betas)
+
+        flush_beta_cache
+      end
+
+      def all_betas
+        @__all_betas__ ||= find_or_create_beta_feature_setting.betas.to_set
+      end
+
+      private
+
+      def validate_beta_name(*betas)
+        betas.each do |beta|
+          if !BetaFeature.all_betas.key?(beta)
+            msg = "Please define #{beta} in config/beta_features.yml"
+            raise BetaFeature::BetaNotDefined.new(msg)
+          end
+        end
+      end
+
+      def find_or_create_beta_feature_setting
+        beta_feature_setting || create_beta_feature_setting
+      end
+
+      def flush_beta_cache
+        remove_instance_variable(:@__all_betas__) if defined? @__all_betas__
+      end
+    end
+  end
+end

data/lib/beta_feature/setting.rb

@@ -0,0 +1,16 @@
+
+module BetaFeature
+  class Setting < ::ActiveRecord::Base
+    self.table_name = "beta_feature_settings"
+
+    validates :betable_type, presence: true
+    validates :betable_id, presence: true, uniqueness: { scope: :betable_type }
+
+    belongs_to :betable, polymorphic: true
+
+
+    def clean_invalid_betas!
+      #TODO
+    end
+  end
+end

data/lib/beta_feature/version.rb

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

data/lib/generators/beta_feature/install_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'active_record'
+require 'rails/generators/active_record'
+require 'generators/beta_feature/migration'
+require 'generators/beta_feature/migration_helper'
+
+
+module BetaFeature
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      include BetaFeature::Generators::MigrationHelper
+      extend BetaFeature::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_migrateion
+        migration_template 'install.rb', 'db/migrate/install_beta_feature.rb'
+        copy_file 'beta_features.yml', 'config/beta_features.yml'
+      end
+    end
+  end
+end

data/lib/generators/beta_feature/migration.rb

@@ -0,0 +1,15 @@
+module BetaFeature
+  module Generators
+    module Migration
+      # Implement the required interface for Rails::Generators::Migration.
+      def next_migration_number(dirname) #:nodoc:
+        next_migration_number = current_migration_number(dirname) + 1
+        if ::ActiveRecord::Base.timestamped_migrations
+          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+        else
+          "%.3d" % next_migration_number
+        end
+      end
+    end
+  end
+end

data/lib/generators/beta_feature/migration_helper.rb

@@ -0,0 +1,13 @@
+module BetaFeature
+  module Generators
+    module MigrationHelper
+      def migration_parent
+        if Rails::VERSION::MAJOR == 4 
+          'ActiveRecord::Migration' 
+        else
+         "ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]"
+       end
+     end
+   end
+ end
+end

data/lib/generators/beta_feature/templates/beta_features.yml

@@ -0,0 +1,18 @@
+landing_page_ux_improvement:
+  developer: 'ryan@corp.com'
+  qa: 'windy@corp.com'
+  status: 'in_progress'
+  description: 'This is a demo feature flag.'
+
+dark_mode:
+  developer: 'max@corp.com'
+  qa: 'daniel@corp.com'
+  status: 'in_progress'
+  description: 'Build dark mode on our website.'
+
+custom_domain:
+  developer: 'max@corp.com'
+  qa: 'daniel@corp.com'
+  status: released
+  description: 'Support custom domain for Pro user.'
+  

data/lib/generators/beta_feature/templates/install.rb

@@ -0,0 +1,16 @@
+class <%= migration_class_name %> < <%= migration_parent %>
+  def self.up
+    create_table :beta_feature_settings, force: true do |t|
+      t.integer :betable_id, null: false
+      t.string :betable_type, null: false
+      t.string :betas, array: true, default: [], null: false
+      t.timestamps
+
+      t.index [:betable_type, :betable_id], unique: true
+    end
+  end
+
+  def self.down
+    drop_table :beta_feature_settings
+  end
+end

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: beta_feature
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Lv
+- Windy Liu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.54.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.54.0
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.20
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.20
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.18'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.18'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Rails feature toggle for trunk based development.
+email:
+- tech@workstream.is
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubycop.yml"
+- ".travis.yml"
+- Appraisals
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- beta_feature.gemspec
+- bin/console
+- bin/setup
+- gemfiles/rails50.gemfile
+- gemfiles/rails50.gemfile.lock
+- gemfiles/rails51.gemfile
+- gemfiles/rails51.gemfile.lock
+- gemfiles/rails52.gemfile
+- gemfiles/rails52.gemfile.lock
+- gemfiles/rails60.gemfile
+- gemfiles/rails60.gemfile.lock
+- lib/beta_feature.rb
+- lib/beta_feature/error.rb
+- lib/beta_feature/flagger.rb
+- lib/beta_feature/setting.rb
+- lib/beta_feature/version.rb
+- lib/generators/beta_feature/install_generator.rb
+- lib/generators/beta_feature/migration.rb
+- lib/generators/beta_feature/migration_helper.rb
+- lib/generators/beta_feature/templates/beta_features.yml
+- lib/generators/beta_feature/templates/install.rb
+homepage: https://github.com/helloworld1812/beta_feature
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/helloworld1812/beta_feature
+  source_code_uri: https://github.com/helloworld1812/beta_feature
+  changelog_uri: https://github.com/helloworld1812/beta_feature/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Rails feature toggle for trunk based development.
+test_files: []