beta_feature 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 222c8c53af430f408ecfcd55d978ab59b4089af31302190912d0a596a5682bfa
+  data.tar.gz: c614987373dd1fd3844a883cb895941574da085d3a0afe83a9f95e1a02ef887e
+SHA512:
+  metadata.gz: 116211b838c40f3cbb8d03bbf7ed4d78b2cdf97a3e68dec7f6bdb5623fbaea2fa580c6892009351c22aec65536dbf6322f95cfcf73a89ade22020b01ab932b35
+  data.tar.gz: ca31eba01302373a7a5625cda951d1176c917f4d1bc5ecabc1a0d3108cb3ec03224ba5b05cacb222b1a531e99851e014b356f8dd9d754023c471c3a67d882312

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem
+*.swp
+.bundle
+.DS_Store
+.rvmrc
+/coverage
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubycop.yml

@@ -0,0 +1,24 @@
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3
+  Exclude:
+    - vendor/bundle/**/*
+    - gemfiles/vendor/bundle/**/*
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Gemspec/OrderedDependencies:
+  Enabled: false
+
+Layout:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+Naming:
+  Enabled: false
+
+Style:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,57 @@
+language: ruby
+cache: bundler
+rvm:
+  # - 2.3.7
+  # - 2.4.4
+  - 2.5.3
+  - 2.6.3
+env:
+  - DB=POSTGRES
+  # - DB=MYSQL
+addons:
+  postgresql: "9.4"
+services:
+  - mysql
+  - postgresql
+before_install:
+  - bundle install --jobs=3 --retry=3
+  # - mysql -e 'CREATE DATABASE beta_feature_test;'
+  # - psql -c 'create database beta_feature_test;' -U postgres
+  # https://github.com/travis-ci/travis-ci/issues/8978
+  # - "travis_retry gem update --system"
+  # # Rails 4.2 has a bundler 1.x requirement
+  # - if [ $BUNDLE_GEMFILE = $PWD/gemfiles/rails42.gemfile ]; then
+  #     rvm @global do gem uninstall bundler -a -x;
+  #     travis_retry gem install -v '< 2.0.0' bundler;
+  #   else
+  #     travis_retry gem install bundler;
+  #   fi
+
+gemfile:
+  - gemfiles/rails50.gemfile
+  - gemfiles/rails51.gemfile
+  - gemfiles/rails52.gemfile
+  - gemfiles/rails60.gemfile
+matrix:
+  # include:
+  #   - rvm: 2.6.3
+  #     script: bundle exec rubocop --parallel
+  #     env: DB=rubocop # make travis build display nicer
+  exclude:
+    # - rvm: 2.3.7
+    #   gemfile: gemfiles/rails60.gemfile
+    # - rvm: 2.4.4
+    #   gemfile: gemfiles/rails60.gemfile
+    - rvm: 2.6.3
+      gemfile: gemfiles/rails42.gemfile
+    - rvm: ruby-head
+      gemfile: gemfiles/rails42.gemfile
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true
+branches:
+  only:
+  - master
+
+script:
+  - rake

data/Appraisals

@@ -0,0 +1,18 @@
+# Include DB adapters matching the version requirements in
+# rails/activerecord/lib/active_record/connection_adapters/*adapter.rb
+
+appraise 'rails50' do
+  gem 'rails', '~> 5.0.0'
+end
+
+appraise 'rails51' do
+  gem 'rails', '~> 5.1.4'
+end
+
+appraise 'rails52' do
+  gem 'rails', '>= 5.2.0', '< 5.3'
+end
+
+appraise 'rails60' do
+  gem 'rails', '>= 6.0.0.rc1', '< 6.1'
+end

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at xiaorong.ruby@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 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

@@ -0,0 +1,188 @@
+# beta_feature
+
+[![Build Status](https://secure.travis-ci.org/helloworld1812/beta_feature.svg)](http://travis-ci.org/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.
+
+
+## Supported ORMs
+
+beta_feature is currently ActiveRecord only.
+
+## Supported Database
+
+- PostgreSQL ✅
+- MySQL ❌(Working in Progress)
+- SQLite ❌(Working in Progress)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'beta_feature'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install beta_feature
+
+
+Then, from your Rails app directory, run the following command to complete the setup.
+
+
+    $ rails generate beta_feature:install
+    $ rake db:migrate
+
+Then, add your feature sets in `config/beta_features.yml`
+
+```yml
+dark_mode:
+  developer: 'ryan@corp.com'
+  qa: 'windy@corp.com'
+  status: 'in_progress'
+  description: 'Building dark mode for my website.'
+```
+
+
+## Usage
+
+### Example: User Level feature toggle
+
+Simply call `flagger` on your `User` model:
+
+```ruby
+class User < ActiveRecord::Base
+  flagger
+
+end
+
+```
+
+The instance of User will have the ability to toggle feature flags.
+
+
+```ruby
+user = User.find(327199)
+
+#enable the feature flag dark_mode for this user.
+user.enable_beta!(:dark_mode)
+
+#remove landing_page_ux_improvement from this user's feature flags.
+user.remove_beta!(:landing_page_ux_improvement)
+
+# check whether a feature is active for a particular user.
+user.can_access_beta?(:dark_mode) # => true/false
+```
+
+
+Controll the logic based on feature flag.
+
+```ruby
+
+if current_user.can_access_beta?(:dark_mode)
+  render 'home', layout: 'dark'
+else
+  render 'home'
+end
+```
+
+
+## Example: Company Level feature toggle
+
+For enterprise application, you might want to enable a beta feature for all the employees of specific company. You can do it in this way.
+
+Simply call `flagger` on your `Company` model:
+
+```ruby
+class Company < ActiveRecord::Base
+  flagger
+
+end
+```
+
+The instance of Company will have the ability to toggle feature in company level.
+
+```ruby
+company = Company.find(2)
+
+#enable the feature flag dark_mode for this company.
+user.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)
+
+# check whether a feature is active for this company.
+user.can_access_beta?(:dark_mode) # => true/false
+```
+
+Controll the logic based on feature flag.
+
+```ruby
+if company.can_access_beta?(:landing_page_ux_improvement)
+  render 'landing_page_v2'
+else
+  render 'landing_page'
+end
+```
+
+## Granularity
+
+User level and company level beta toggles could meet most applications. But if you have special requirements, you can enable feature toggle to any models by calling `flagger`.
+
+
+```ruby
+class Group < ActiveRecord::Base
+  flagger
+
+end
+
+group = Group.find(397)
+
+#enable the feature flag dark_mode for this group.
+group.enable_beta!(:dark_mode)
+
+#remove the feature flag landing_page_ux_improvement from this group's feature flags.
+group.remove_beta!(:landing_page_ux_improvement)
+
+# check whether a feature is active for this group.
+group.can_access_beta?(:dark_mode) # => true/false
+```
+
+
+
+## Alternative
+
+- [rollout](https://github.com/fetlife/rollout), a redis based feature flags.
+- [flipper](https://github.com/jnunemaker/flipper)
+
+
+## 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/helloworld1812/beta_feature. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Brought to you by
+
+| pic | @mention | area |
+|:--|:--|:--|
+| ![](https://avatars2.githubusercontent.com/u/1224077?s=64) | @xiaoronglv | most things. |
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the BetaFeature project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/beta_feature/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'appraisal'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/beta_feature.gemspec

@@ -0,0 +1,52 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "beta_feature/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "beta_feature"
+  spec.version       = BetaFeature::VERSION
+  spec.authors       = ["Ryan Lv", "Windy Liu"]
+  spec.email         = ["tech@workstream.is"]
+
+  spec.summary       = %q{Rails feature toggle for trunk based development.}
+  spec.description   =  spec.summary 
+  spec.homepage      = "https://github.com/helloworld1812/beta_feature"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/helloworld1812/beta_feature"
+    spec.metadata["changelog_uri"] = "https://github.com/helloworld1812/beta_feature/blob/master/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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.required_ruby_version = '>= 2.3.0'
+
+  # spec.add_runtime_dependency 'activerecord', '>= 4.2', '< 6.1'
+  # spec.add_runtime_dependency 'activesupport', '>= 4.2', '< 6.1'
+  spec.add_runtime_dependency 'rails', '>= 4.2', '< 6.1'
+
+  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency "rspec", ">= 3.0"
+  spec.add_development_dependency 'rspec-rails', '>= 3.5'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency 'rubocop', '>= 0.54.0'
+  spec.add_development_dependency 'mysql2', '>= 0.3.20'
+  spec.add_development_dependency 'pg', '>= 0.18', '< 2.0'
+end