beta_feature 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36e35ed413407ffb4dd36efdff5529ec1936b79743fbffa17f9c5b80d42a6555
-  data.tar.gz: 19a14730baf92f0dc9a528a00de92e5bf4c49f2238e70b8c4d9567d616341cdf
+  metadata.gz: 6c7cc5f5d623ddf43ab03437b7d4e3d60a809efcbb4d005d23d11c5d45c23855
+  data.tar.gz: 86b211c78cbed4a06948920161baf3c4be571063d71f92c5913f96e74c8cf9da
 SHA512:
-  metadata.gz: 1d17b5545bf27f4d8a0512766540ddaa937b5d7d371166835244e2ebf9addb76d35d844c318bc1ffeefe3752e187fd3b0c961cf2bd8d29c629ccf57a3f4caeed
-  data.tar.gz: 780aa124b2e1c267b55b1653eac71bcbde04e48df42c77e5d0bbaec0f62953750062ed0b9abf71cca1f8dd5972a5743953ca63b29fdc0026181799dde75990f5
+  metadata.gz: 268c70d2c0b799cde5e5ffe057e85a822413e09b4de51ed08a59647c3c71d737ecbccd80691f855e4b47e94ea04e3dc99cf8edd6b1628d434cc2636e74c93d8e
+  data.tar.gz: cf3d62887f7dcaabfb1f13b6d3830998d0584feaccac5494a6dce1eb65404f9c46410d8d43c0615919634082565ef108c9365a8712f92ecd42686b6a22776448

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Ryan Lv
+
+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

@@ -1,6 +1,6 @@
 # beta_feature
 
-[![Build Status](https://secure.travis-ci.org/helloworld1812/beta_feature.svg)](http://travis-ci.org/helloworld1812/beta_feature)
+[![CircleCI Build Status](https://circleci.com/gh/helloworld1812/beta_feature.svg?style=svg)](https://circleci.com/gh/helloworld1812/beta_feature)
 
 **beta_feature** is a database-based feature flag tool for Ruby on Rails, which allows you check in incomplete features without affecting users.
 
@@ -33,6 +33,13 @@ Or install it yourself as:
     $ gem install beta_feature
 
 
+Then, To make the engine's functionality accessible from within an application, it needs to be mounted in that application's config/routes.rb file:
+
+```ruby
+mount BetaFeature::Engine, at: "/beta_feature"
+```
+
+
 Then, from your Rails app directory, run the following command to complete the setup.
 
 
@@ -112,13 +119,13 @@ The instance of Company will have the ability to toggle feature in company level
 company = Company.find(2)
 
 #enable the feature flag dark_mode for this company.
-user.enable_beta!(:dark_mode)
+company.enable_beta!(:dark_mode)
 
 #remove the feature flag landing_page_ux_improvement from this company's feature flags.
-user.remove_beta!(:landing_page_ux_improvement)
+company.remove_beta!(:landing_page_ux_improvement)
 
 # check whether a feature is active for this company.
-user.can_access_beta?(:dark_mode) # => true/false
+company.can_access_beta?(:dark_mode) # => true/false
 ```
 
 Controll the logic based on feature flag.
@@ -171,7 +178,55 @@ dark_mode:
 user.can_access_beta?(:dark_mode) # => always return true
 ```
 
+## API
+
+this engine provides three API for the frontend to list all available betas or toggle beta features for a paticular class.
+
+### List all available beta features in the beta_features.yml
+
+GET /beta_feature/all
+
+Response
+
+```json
+{
+  "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."
+  }
+}
+```
+
+### List all enabled beta features for a particular object.
+
+GET /beta_feature/:object_class/:object_id/setting
 
+### toggle beta feature
+
+PUT /beta_feature/:object_class/:object_id/setting
+
+Parameter
+```json
+{
+ "betas": {
+    "landing_page_ux_improvement": true,
+    "dark_mode": false
+}
+```
 
 ## Alternative
 

data/Rakefile

@@ -1,7 +1,12 @@
+require "bundler/setup"
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
-require 'appraisal'
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task :default => :spec

data/app/controllers/beta_feature/application_controller.rb

@@ -0,0 +1,4 @@
+module BetaFeature
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/beta_feature/configurations_controller.rb

@@ -0,0 +1,9 @@
+require_dependency "beta_feature/application_controller"
+
+module BetaFeature
+  class ConfigurationsController < ApplicationController
+    def index
+      render json: BetaFeature.all_betas.to_json
+    end
+  end
+end

data/app/controllers/beta_feature/settings_controller.rb

@@ -0,0 +1,59 @@
+require_dependency "beta_feature/application_controller"
+
+module BetaFeature
+  class SettingsController < ApplicationController
+    before_action :set_object
+
+    rescue_from ActiveRecord::RecordNotFound do |e|
+      msg = "Couldn't find this record: #{params[:object_class]}/#{params[:object_id]}"
+      render json: { error: msg }, status: :not_found
+    end
+
+    # GET /beta_feature/:object_class/:object_id/setting
+    def show
+      render json: {
+        object_class: @object_class,
+        object_id: @object_id,
+        betas: @object.all_betas
+      }
+    end
+
+    # PUT /beta_feature/:object_class/:object_id/setting 
+    # Params:
+    # {
+    #   betas: {
+    #     custom_domain: true,
+    #     dark_mode: false,
+    #     ux_improvement_2021: true
+    #   }
+    # }
+    def update
+      betas = params.permit![:betas]
+
+      enabled_betas = betas.select {|k, v| v.to_s == "true"}.keys
+      disabled_betas = betas.select {|k, v| v.to_s == "false"}.keys
+
+      @object.enable_beta!(*enabled_betas) if enabled_betas.present?
+      @object.remove_beta!(*disabled_betas) if disabled_betas.present?
+
+     render json: {
+      object_class: @object_class,
+      object_id: @object_id,
+      betas: @object.all_betas
+     } 
+    end
+
+    private
+
+    def set_object
+      @object_class = params.require(:object_class)
+      @object_id = params.require(:object_id)
+
+      @klass = @object_class.constantize 
+      @object = @klass.find(@object_id)
+    rescue NameError
+      msg = "class '#{params[:object_class]}' does not exist."
+      render json: { error: msg}, status: :unprocessable_entity
+    end
+  end
+end

data/app/models/beta_feature/application_record.rb

@@ -0,0 +1,5 @@
+module BetaFeature
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/{lib → app/models}/beta_feature/setting.rb

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

data/app/views/layouts/beta_feature/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Beta feature</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "beta_feature/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,10 @@
+BetaFeature::Engine.routes.draw do
+  # list all beta features
+  get "all", to: 'configurations#index'
+
+  # list all betas of a particular object
+  get ":object_class/:object_id/setting", to: 'settings#show'
+
+  # toggle betas for a particular object
+  put ":object_class/:object_id/setting", to: 'settings#update'
+end

data/db/migrate/20210102124824_create_beta_feature_settings.rb

@@ -0,0 +1,18 @@
+class CreateBetaFeatureSettings < ActiveRecord::Migration[5.1]
+  def up
+    if !ActiveRecord::Base.connection.data_source_exists? 'beta_feature_settings'
+      create_table :beta_feature_settings, if_not_exists: true do |t|
+        t.bigint :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
+  end
+
+  def down
+    drop_table :beta_feature_settings if ActiveRecord::Base.connection.data_source_exists? 'beta_feature_settings'
+  end
+end

data/lib/beta_feature.rb

@@ -1,15 +1,11 @@
-require 'active_record'
-require 'active_support'
-require 'yaml'
-
 require "beta_feature/version"
-require "beta_feature/flagger"
-require "beta_feature/setting"
+require "beta_feature/engine"
 require "beta_feature/error"
+require "beta_feature/flagger"
 
 module BetaFeature
   def self.all_betas
-    @@all_betas ||= YAML.load_file("#{Rails.root}/config/beta_features.yml")
+    @@all_betas ||= YAML.load_file("#{Rails.root}/config/beta_features.yml").with_indifferent_access
   end
 
   def self.in_progress
@@ -20,5 +16,3 @@ module BetaFeature
     @@released_betas ||= all_betas.select {|k, v| v["status"] == 'released'}
   end
 end
-
-::ActiveRecord::Base.send :include, BetaFeature::Flagger

data/lib/beta_feature/engine.rb

@@ -0,0 +1,25 @@
+module BetaFeature
+  class Engine < ::Rails::Engine
+    isolate_namespace BetaFeature
+
+    initializer :append_migrations do |app|
+      unless app.root.to_s.match(root.to_s)
+        config.paths["db/migrate"].expanded.each do |expanded_path|
+          app.config.paths["db/migrate"] << expanded_path
+        end
+      end
+    end
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_bot
+      g.factory_bot dir: 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+
+    config.after_initialize do
+      ::ActiveRecord::Base.send :include, BetaFeature::Flagger
+    end
+  end
+end

data/lib/beta_feature/flagger.rb

@@ -26,9 +26,8 @@ module BetaFeature
       def enable_beta!(*betas)
         betas = betas.map(&:to_s)
         validate_beta_name(*betas)
-        betas = (find_or_create_beta_feature_setting.betas + betas).uniq
+        betas = clean_betas(find_or_create_beta_feature_setting.betas + betas)
         beta_feature_setting.update(betas: betas)
-
         flush_beta_cache
       end
 
@@ -36,8 +35,7 @@ module BetaFeature
       def remove_beta!(*betas)
         betas = betas.map(&:to_s)
         validate_beta_name(*betas)
-
-        betas = (find_or_create_beta_feature_setting.betas - betas).uniq
+        betas = clean_betas(find_or_create_beta_feature_setting.betas - betas)
         beta_feature_setting.update(betas: betas)
 
         flush_beta_cache
@@ -45,7 +43,7 @@ module BetaFeature
 
       def all_betas
         @__all_betas__ ||= begin
-          find_or_create_beta_feature_setting.betas.to_set + BetaFeature.released.keys.to_set
+          clean_betas(find_or_create_beta_feature_setting.betas + BetaFeature.released.keys).to_set
         end
       end
 
@@ -67,6 +65,12 @@ module BetaFeature
       def flush_beta_cache
         remove_instance_variable(:@__all_betas__) if defined? @__all_betas__
       end
+
+      def clean_betas(betas)
+        betas.map(&:to_s).uniq.compact.select{ |beta| BetaFeature.all_betas.key?(beta) }
+      end
     end
   end
-end
+end
+
+::ActiveRecord::Base.send :include, BetaFeature::Flagger

data/lib/beta_feature/version.rb

@@ -1,3 +1,3 @@
 module BetaFeature
-  VERSION = "0.1.2"
+  VERSION = '0.2.0'
 end

data/lib/generators/beta_feature/install_generator.rb

@@ -1,24 +1,13 @@
 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
+end

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

@@ -14,5 +14,4 @@ custom_domain:
   developer: 'max@corp.com'
   qa: 'daniel@corp.com'
   status: released
-  description: 'Support custom domain for Pro user.'
-  
+  description: 'Support custom domain for Pro user.'

data/lib/tasks/beta_feature_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :beta_feature do
+#   # Task goes here
+# end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beta_feature
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Ryan Lv
-- Windy Liu
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2020-04-20 00:00:00.000000000 Z
+date: 2021-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,22 +16,16 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '4.0'
   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'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -46,33 +39,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -87,68 +80,6 @@ dependencies:
     - - ">="
       - !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
@@ -156,38 +87,25 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubycop.yml"
-- ".travis.yml"
-- Appraisals
-- CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
-- LICENSE.txt
+- MIT-LICENSE
 - 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
+- app/controllers/beta_feature/application_controller.rb
+- app/controllers/beta_feature/configurations_controller.rb
+- app/controllers/beta_feature/settings_controller.rb
+- app/models/beta_feature/application_record.rb
+- app/models/beta_feature/setting.rb
+- app/views/layouts/beta_feature/application.html.erb
+- config/routes.rb
+- db/migrate/20210102124824_create_beta_feature_settings.rb
 - lib/beta_feature.rb
+- lib/beta_feature/engine.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
+- lib/tasks/beta_feature_tasks.rake
 homepage: https://github.com/helloworld1812/beta_feature
 licenses:
 - MIT
@@ -195,7 +113,7 @@ 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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -203,7 +121,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -211,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Rails feature toggle for trunk based development.
 test_files: []