flip_fab 1.0.0 → 1.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c662a0d2b36601ff4d1f9c1424d966ae7419bca0
-  data.tar.gz: 5ed8d698d9acee0615df1b146e2048b87743ba18
+SHA256:
+  metadata.gz: f7f880a207dde1105f807623c68b6f3911883cab9f930760b33b372addc7aa5c
+  data.tar.gz: 38824c24a924aab3f4bd486c3595e83a98630420a300afc89d1f554e38c4d930
 SHA512:
-  metadata.gz: ccbe037678c9b7d1c8e6eb5e6dde83f70733159485dfbdf47ccb2a8070ce356f9b3204807bf5e346f3fb877abe5a7328b8041001a6961f327c40ea2167a198e5
-  data.tar.gz: 87b1d482757418bcc5c77b0bcb6868c001cd3d35149dd4f470144fb0012a2bd97eeae5d40e9bdfe97fb00219a8a3327a0cff333130384b88b3f6adf716375a0a
+  metadata.gz: 6854f1e7fab3aa484661e0228808e40f04a5cc39be460d1d543c44ee828aa4aba01aea6338c27c1f96749a563483d20a2d8bc71c5f22c7388af385a4e7dc26fa
+  data.tar.gz: 610b9b7ae75eaafbc3bcc02076fc4bb519d08727cc75909a93f9d51cd0ea1a0ffe03a93a870fa2be1d4bdadad1fa1c1d7c74f0883c7c9f38072c8a04451d4344

data/.github/dependabot.yml

@@ -0,0 +1,18 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "07:00"
+    open-pull-requests-limit: 99
+    labels:
+      - dependencies
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "07:00"
+    open-pull-requests-limit: 99
+    labels:
+      - dependencies

data/.github/workflows/dobby-actions.yml

@@ -0,0 +1,29 @@
+
+name: "Dobby action"
+on:
+  issue_comment:
+    types: [created]
+permissions:
+  contents: read
+jobs:
+  pr_commented:
+    runs-on: ubuntu-20.04
+    if: startsWith(github.event.comment.body, '/dobby')
+    env:
+      BUNDLE_WITHOUT: "development:test"
+    steps:
+      - name: Chekcout action
+        uses: actions/checkout@v3
+        with:
+          repository: 'simplybusiness/dobby'
+          ref: 'v3.0.1'
+      - name: Set up ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - name: Bump version
+        uses: simplybusiness/dobby@v3.0.1
+        env:
+          DOBBY_APP_ID: ${{ secrets.DOBBY_APP_ID }}
+          DOBBY_PRIVATE_KEY: ${{ secrets.DOBBY_PRIVATE_KEY }}
+          VERSION_FILE_PATH: lib/flip_fab/version.rb

data/.github/workflows/gem-publish.yml

@@ -0,0 +1,46 @@
+name: Publish Ruby Gem
+
+on:
+  push:
+    branches: [ master ]
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    name: Build and Publish
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
+      - name: Get Gem Version
+        id: get-gem-version
+        run: echo "::set-output name=GEM_VERSION::$(bundle exec ruby -e 'puts FlipFab::VERSION')"
+      - name: Create Release
+        uses: actions/github-script@v6
+        env:
+          GEM_VERSION: ${{ steps.get-gem-version.outputs.GEM_VERSION }}
+        with:
+          result-encoding: string
+          script: |
+            const { GEM_VERSION } = process.env
+            github.rest.repos.createRelease({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              tag_name: GEM_VERSION,
+              generate_release_notes: true,
+            })

data/.github/workflows/version-forget-me-not.yml

@@ -0,0 +1,19 @@
+name: Check version
+
+on:
+  pull_request:
+    branches:
+      - master
+    types: [opened, synchronize]
+permissions:
+  contents: read
+  statuses: write
+jobs:
+  build:
+    runs-on: ubuntu-18.04
+
+    steps:
+      - uses: simplybusiness/version-forget-me-not@v2.3.0
+        env:
+          ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          VERSION_FILE_PATH: "lib/flip_fab/version.rb"

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,31 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+
+Lint/EndAlignment:
+  Enabled: true
+
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/flip_fab/persistence.rb'
+
+Metrics/AbcSize:
+  Exclude:
+    - 'spec/support/test_app.rb'
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'spec/lib/flip_fab/contextual_feature_spec.rb'
+
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'example/rails_app/test/test_helper.rb'
+
+Style/Documentation:
+  Enabled: false
+

data/.rubocop_todo.yml

@@ -0,0 +1,58 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2021-11-22 12:55:16 UTC using RuboCop version 1.12.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'flip_fab.gemspec'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: AllowComments.
+Lint/UselessMethodDefinition:
+  Exclude:
+    - 'lib/flip_fab/cookie_persistence.rb'
+    - 'spec/support/test_multiple_persistence.rb'
+    - 'spec/support/test_persistence.rb'
+
+# Offense count: 13
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+# IgnoredMethods: refine
+Metrics/BlockLength:
+  Max: 262
+
+# Offense count: 58
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/HashTransformValues:
+  Exclude:
+    - 'lib/flip_fab/features_by_name.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: literals, strict
+Style/MutableConstant:
+  Exclude:
+    - 'lib/flip_fab/cookie_persistence.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: ConvertCodeThatCanStartToReturnNil, AllowedMethods.
+# AllowedMethods: present?, blank?, presence, try, try!
+Style/SafeNavigation:
+  Exclude:
+    - 'lib/flip_fab/cookie_persistence.rb'

data/.ruby-version

@@ -0,0 +1 @@
+3.0.4

data/.semaphore/semaphore.yml

@@ -0,0 +1,49 @@
+version: v1.0
+name: Semaphore v2 tests
+agent:
+  machine:
+    type: e1-standard-2
+    os_image: ubuntu2004
+auto_cancel:
+  running:
+    when: branch != 'master'
+global_job_config:
+  prologue:
+    commands:
+      - checkout
+      - sem-version ruby $RUBY_VERSION -f
+      - gem update --system
+      - bundle config set --local path 'vendor/bundle'
+      - cache restore bundle-$RUBY_VERSION-$SEMAPHORE_GIT_BRANCH-$SEMAPHORE_WORKFLOW_ID,bundle-$RUBY_VERSION-$SEMAPHORE_GIT_BRANCH,bundle-$RUBY_VERSION-master
+      - bundle install
+      - bundle clean --force
+      - cache store bundle-$RUBY_VERSION-$SEMAPHORE_GIT_BRANCH-$SEMAPHORE_WORKFLOW_ID vendor/bundle
+  secrets:
+    - name: bundler-global
+blocks:
+  - name: Semaphore v2 tests
+    dependencies: []
+    execution_time_limit:
+      minutes: 30
+    task:
+      jobs:
+        - name: Tests
+          matrix:
+            - env_var: RUBY_VERSION
+              values: ["2.7", "3.0"]
+          commands:
+            - bundle exec rspec
+  - name: Semaphore v2 Compliance
+    dependencies: []
+    skip:
+      when: branch = 'master'
+    execution_time_limit:
+      minutes: 10
+    task:
+      jobs:
+        - name: Rubocop
+          commands:
+            - bundle exec rubocop
+      env_vars:
+        - name: RUBY_VERSION
+          value: 2.6.5

data/CODEOWNERS

@@ -0,0 +1,3 @@
+# Add your project owners info here
+# More information: https://help.github.com/articles/about-codeowners/
+* @simplybusiness/alchemists

data/Gemfile

@@ -2,15 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in flip_fab.gemspec
 gemspec
-
-group :development, :test do
-  gem 'pry-plus'
-end
-
-group :test do
-  gem 'rack'
-  gem 'rack-test'
-  gem 'rspec'
-  gem 'rutabaga'
-  gem 'timecop'
-end

data/README.md

@@ -1,5 +1,4 @@
-Flip Fab
---------
+# Flip Fab
 
 **Feature flipping... Made FaBuLoUs!**
 
@@ -166,3 +165,10 @@ Perform the following to try the example:
 1. Start rails: `bundle exec rails s`
 1. View the page with the feature disabled: `open 'http://localhost:3000/beavers?justin_beaver=disabled'`
 1. View the page with the feature enabled: `open 'http://localhost:3000/beavers?justin_beaver=enabled'`
+
+## Contributing
+
+1. Make your changes in a branch
+1. Update the version using semantic versioning in `lib/flip_fab/version.rb`
+1. Once signed off, merge
+1. The gem will automatically be pushed to gemstash

data/_pipeline/step_build_gem.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+source "/opt/sb/sb-pipeline.sh"
+set -e
+
+gem_deploy flip_fab.gemspec

data/_pipeline/step_test_gem.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+source "/opt/sb/sb-pipeline.sh"
+set -e
+
+bundle install
+bundle exec rspec

data/catalog-info.yaml

@@ -0,0 +1,8 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: flip_fab
+  description: A gem providing persistent, per-user feature flipping to Rack applications
+spec:
+  type: library
+  lifecycle: production

data/example/rails_app/Gemfile

@@ -1,36 +1,19 @@
 source 'https://rubygems.org'
 
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
-gem 'rails', '4.2.0'
+gem 'rails', '~> 5.0'
 # Use sqlite3 as the database for Active Record
 gem 'sqlite3'
 # Use SCSS for stylesheets
-gem 'sass-rails', '~> 4.0.3'
+gem 'sass-rails'
 # Use Uglifier as compressor for JavaScript assets
 gem 'uglifier', '>= 1.3.0'
 # Use CoffeeScript for .js.coffee assets and views
-gem 'coffee-rails', '~> 4.0.0'
-# See https://github.com/sstephenson/execjs#readme for more supported runtimes
-# gem 'therubyracer',  platforms: :ruby
-
+gem 'coffee-rails'
 # Use jquery as the JavaScript library
 gem 'jquery-rails'
-# Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
-gem 'turbolinks'
-# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
-gem 'jbuilder', '~> 2.0'
-# bundle exec rake doc:rails generates the API under doc/api.
-gem 'sdoc', '~> 0.4.0',          group: :doc
-
-# Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
-gem 'spring',        group: :development
-
-# Use unicorn as the app server
-gem 'unicorn'
-
-# Use Capistrano for deployment
-# gem 'capistrano-rails', group: :development
 
 gem 'flip_fab', path: '../../'
 
+gem 'rails-controller-testing', group: :test
 gem 'rspec-rails', group: :test

data/example/rails_app/Rakefile

@@ -1,6 +1,6 @@
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
-require File.expand_path('../config/application', __FILE__)
+require File.expand_path('config/application', __dir__)
 
 Rails.application.load_tasks

data/example/rails_app/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/example/rails_app/app/assets/javascripts/application.js

@@ -12,5 +12,4 @@
 //
 //= require jquery
 //= require jquery_ujs
-//= require turbolinks
 //= require_tree .

data/example/rails_app/app/controllers/beavers_controller.rb

@@ -1,5 +1,5 @@
 class BeaversController < ApplicationController
-  before_action :set_beaver, only: [:show, :edit, :update, :destroy]
+  before_action :set_beaver, only: %i[show edit update destroy]
 
   # GET /beavers
   # GET /beavers.json
@@ -9,8 +9,7 @@ class BeaversController < ApplicationController
 
   # GET /beavers/1
   # GET /beavers/1.json
-  def show
-  end
+  def show; end
 
   # GET /beavers/new
   def new
@@ -18,8 +17,7 @@ class BeaversController < ApplicationController
   end
 
   # GET /beavers/1/edit
-  def edit
-  end
+  def edit; end
 
   # POST /beavers
   # POST /beavers.json
@@ -62,13 +60,14 @@ class BeaversController < ApplicationController
   end
 
   private
-    # Use callbacks to share common setup or constraints between actions.
-    def set_beaver
-      @beaver = Beaver.find(params[:id])
-    end
 
-    # Never trust parameters from the scary internet, only allow the white list through.
-    def beaver_params
-      params.require(:beaver).permit(:name)
-    end
+  # Use callbacks to share common setup or constraints between actions.
+  def set_beaver
+    @beaver = Beaver.find(params[:id])
+  end
+
+  # Never trust parameters from the scary internet, only allow the white list through.
+  def beaver_params
+    params.require(:beaver).permit(:name)
+  end
 end

data/example/rails_app/bin/bundle

@@ -1,3 +1,3 @@
 #!/usr/bin/env ruby
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
 load Gem.bin_path('bundler', 'bundle')

data/example/rails_app/bin/rails

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-APP_PATH = File.expand_path('../../config/application',  __FILE__)
+APP_PATH = File.expand_path('../config/application', __dir__)
 require_relative '../config/boot'
 require 'rails/commands'

data/example/rails_app/config/application.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../boot', __FILE__)
+require File.expand_path('boot', __dir__)
 
 require 'rails/all'
 
@@ -20,6 +20,6 @@ module RailsApp
     # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
     # config.i18n.default_locale = :de
 
-    config.eager_load_paths += %W(#{config.root}/lib)
+    config.eager_load_paths += %W[#{config.root}/lib]
   end
 end

data/example/rails_app/config/boot.rb

@@ -1,4 +1,4 @@
 # Set up gems listed in the Gemfile.
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
 
 require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])

data/example/rails_app/config/environment.rb

@@ -1,5 +1,5 @@
 # Load the Rails application.
-require File.expand_path('../application', __FILE__)
+require File.expand_path('application', __dir__)
 
 # Initialize the Rails application.
 Rails.application.initialize!

data/example/rails_app/config/environments/development.rb

@@ -20,7 +20,7 @@ Rails.application.configure do
   # config.action_dispatch.rack_cache = true
 
   # Disable Rails's static asset server (Apache or nginx will already do this).
-  config.serve_static_files = false
+  config.public_file_server.enabled = false
 
   # Compress JavaScripts and CSS.
   config.assets.js_compressor = :uglifier

data/example/rails_app/config/environments/test.rb

@@ -13,8 +13,8 @@ Rails.application.configure do
   config.eager_load = false
 
   # Configure static asset server for tests with Cache-Control for performance.
-  config.serve_static_files  = true
-  config.static_cache_control = 'public, max-age=3600'
+  config.public_file_server.enabled = true
+  config.public_file_server.headers = { 'Cache-Control' => 'public, max-age=3600' }
 
   # Show full error reports and disable caching.
   config.consider_all_requests_local       = true

data/example/rails_app/config/initializers/cookies_serializer.rb

@@ -1,3 +1,3 @@
 # Be sure to restart your server when you modify this file.
 
-Rails.application.config.action_dispatch.cookies_serializer = :json
+Rails.application.config.action_dispatch.cookies_serializer = :json

data/example/rails_app/config.ru

@@ -1,4 +1,4 @@
 # This file is used by Rack-based servers to start the application.
 
-require ::File.expand_path('../config/environment',  __FILE__)
+require ::File.expand_path('config/environment', __dir__)
 run Rails.application

data/example/rails_app/db/schema.rb

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 # This file is auto-generated from the current state of the database. Instead
 # of editing this file, please use the migrations feature of Active Record to
 # incrementally modify your database, and then regenerate this schema definition.
@@ -11,12 +10,10 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20140424102400) do
-
-  create_table "beavers", force: true do |t|
-    t.string   "name"
-    t.datetime "created_at"
-    t.datetime "updated_at"
+ActiveRecord::Schema.define(version: 20_140_424_102_400) do
+  create_table 'beavers', force: true do |t|
+    t.string   'name'
+    t.datetime 'created_at'
+    t.datetime 'updated_at'
   end
-
 end

data/example/rails_app/spec/rails_helper.rb

@@ -1,7 +1,7 @@
 # This file is copied to spec/ when you run 'rails generate rspec:install'
-ENV["RAILS_ENV"] ||= 'test'
+ENV['RAILS_ENV'] ||= 'test'
 require 'spec_helper'
-require File.expand_path("../../config/environment", __FILE__)
+require File.expand_path('../config/environment', __dir__)
 require 'rspec/rails'
 # Add additional requires below this line. Rails is not loaded until this point!
 

data/example/rails_app/spec/spec_helper.rb

@@ -1,5 +1,4 @@
 RSpec.configure do |config|
-
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing
   # the seed, which is printed after each run.

data/example/rails_app/test/controllers/beavers_controller_test.rb

@@ -5,43 +5,43 @@ class BeaversControllerTest < ActionController::TestCase
     @beaver = beavers(:one)
   end
 
-  test "should get index" do
+  test 'should get index' do
     get :index
     assert_response :success
     assert_not_nil assigns(:beavers)
   end
 
-  test "should get new" do
+  test 'should get new' do
     get :new
     assert_response :success
   end
 
-  test "should create beaver" do
+  test 'should create beaver' do
     assert_difference('Beaver.count') do
-      post :create, beaver: { name: @beaver.name }
+      post :create, params: { beaver: { name: @beaver.name } }
     end
 
     assert_redirected_to beaver_path(assigns(:beaver))
   end
 
-  test "should show beaver" do
-    get :show, id: @beaver
+  test 'should show beaver' do
+    get :show, params: { id: @beaver }
     assert_response :success
   end
 
-  test "should get edit" do
-    get :edit, id: @beaver
+  test 'should get edit' do
+    get :edit, params: { id: @beaver }
     assert_response :success
   end
 
-  test "should update beaver" do
-    patch :update, id: @beaver, beaver: { name: @beaver.name }
+  test 'should update beaver' do
+    patch :update, params: { id: @beaver, beaver: { name: @beaver.name } }
     assert_redirected_to beaver_path(assigns(:beaver))
   end
 
-  test "should destroy beaver" do
+  test 'should destroy beaver' do
     assert_difference('Beaver.count', -1) do
-      delete :destroy, id: @beaver
+      delete :destroy, params: { id: @beaver }
     end
 
     assert_redirected_to beavers_path

data/example/rails_app/test/test_helper.rb

@@ -1,5 +1,5 @@
 ENV['RAILS_ENV'] ||= 'test'
-require File.expand_path('../../config/environment', __FILE__)
+require File.expand_path('../config/environment', __dir__)
 require 'rails/test_help'
 
 class ActiveSupport::TestCase