remote_config 1.0.0.pre.beta.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 31d21488e0ffa05436025e157209cc9d44dc1e3fabb307a2e9d71c220bdb7069
+  data.tar.gz: 0bd6482ddcbdb2ab5abe5286997ea029134f46b42bd5a1f695206904634c3bc1
+SHA512:
+  metadata.gz: 164e299f5dcd5585d136d3aafecb8d49d98a8555ec0330de972803fe798c2e763c76c6af188c8f24468890f36407aa04fc3a7c241129738315eee2b49f0dda80
+  data.tar.gz: 51a8988537d414973c5a3473a0aaaba25c0458ccc39352f565d2b0edd075866437409f3add830a3e2377a95f7819db8dbddd5826810979e6ec9ed5e482f5d304

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,13 @@
+<!--
+List of related JIRAs:
+e.g. [[MISC-123]](https://paperkite.atlassian.net/browse/MISC-123)
+-->
+
+### Description
+<!-- explanation of the change and your thinking behind the implementation -->
+
+### How to test
+<!-- explanation of how to test / perform acceptance over the changes -->
+
+### Resources
+<!-- attach screenshots of change or links to relevant resources when applicable -->

data/.github/workflows/continuous-deployment.yml

@@ -0,0 +1,34 @@
+name: Continuous Deployment
+
+on:
+  push:
+    tags:
+      - v[0-9]+.[0-9]+.[0-9]+ # e.g. 2.7.1
+      - v[0-9]+.[0-9]+.[0-9]+-[a-z]+ # e.g. v2.7.1-beta
+      - v[0-9]+.[0-9]+.[0-9]+-[a-z]+.[0-9]+ # e.g. v2.7.1-beta.1
+
+jobs:
+
+  publish_to_rubygems:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1.1
+      - name: Install bundler and bundle
+        run: |
+          gem install bundler
+          bundle
+      - name: Set up Rubygems credentials
+        run: |
+          mkdir -p ~/.gem
+          cat > ~/.gem/credentials << ENDOFFILE
+          ---
+          :github: Bearer ${{ github.token }}
+          :rubygems_api_key: ${{ secrets.RUBYGEMS_API_KEY }}
+          ENDOFFILE
+
+          chmod 0600 ~/.gem/credentials
+      - name: Publish to Rubygems
+        run: rake publish

data/.github/workflows/continuous-integration.yml

@@ -0,0 +1,45 @@
+name: Continuous Integration
+
+on:
+  pull_request:
+    branches:
+      - main
+      - develop
+      - epic/*
+
+jobs:
+
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.1
+      - name: Install PK Rubocop gem
+        run: |
+          gem install paperkite-rubocop --pre
+      - name: Run Rubocop
+        run: |
+          rubocop
+
+  rspec:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [2.7.4, 3.0.1, 3.1.1]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install bundler and bundle
+        run: |
+          gem install bundler
+          bundle
+      - name: Run RSpec
+        env:
+          RAILS_ENV: test
+        run: |
+          bundle exec rails db:test:prepare
+          bundle exec rspec

data/.gitignore

@@ -0,0 +1,58 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/spec/rails_app/db/*.sqlite3
+/spec/rails_app/log
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/.rubocop.yml

@@ -0,0 +1,9 @@
+inherit_gem:
+  paperkite-rubocop: config/base.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - spec/rails_app/**/*
+    - bin/*
+    - Rakefile

data/Gemfile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+ruby RUBY_VERSION
+
+gemspec
+
+gem "config"
+gem "rails"
+
+group :test do
+  gem "rspec-rails"
+  gem "sqlite3"
+end
+
+group :test, :development do
+  gem "pry"
+end
+
+group :development do
+  gem "paperkite-rubocop", tag: "v1.0.0-beta.6"
+end

data/README.md

@@ -0,0 +1,122 @@
+# Remote config
+
+A gem for managing feature and release flags in the backend and providing them remotely to a front-end.
+
+## Usage
+
+### Feature Flagging
+
+Flagging allows checking of config values and doing different things based on their boolean value.
+
+By including the flagging module you'll have access to the following methods:
+
+```rb
+include RemoteConfig::Flagging
+```
+
+```rb
+caffeinate if feature_enabled? "coffee.caffeinated"
+```
+
+```rb
+feature_enabled? "coffee.caffeinated" do
+  caffeinate
+end
+```
+
+The `RemoteConfig::Flagging` module is included into the rails route mapper so you can use flagging at route setup. This allows the deployment of unreleased endpoints that aren't routable until they are released.
+
+```rb
+routes do
+  feature_enabled? "coffee_ordering" do
+    resource :coffee
+  end
+end
+```
+
+### Release flags
+
+Release flags work with the same syntax (replace `feature?` with `released?`), however instead of checking for boolean truthfulness, the value of the falg corresponds to a stage that it is released to. The `released?` method will then be checking if the current environment is in that release stage and returning true if so.
+
+For example, if your configured release stages are:
+```rb
+RemoteConfig.configure do |config|
+  config.release_stages = {
+    production:  %s[production qa dev development],
+    qa:          %s[qa dev development],
+    development: %s[dev development]
+  }
+```
+
+Then the following values are returned:
+
+|             | development | uat   | production |
+| ----------- | ----------- | ----- | ---------- |
+| dev         | true        | true  | true       |
+| development | true        | true  | true       |
+| qa          | false       | true  | true       |
+| production  | false       | false | true       |
+
+*Current environments down the left VS the release stages along the top.*
+
+Alternatively, if you wanted to release to specific environments instead of progressing through them, you can return an array of the exact environment(s) that you want it released on.
+
+e.g. if the value is `[:qa]`, them it'll be `false` on development, dev and production, while true on qa.
+
+By including the flagging module you'll have access to the following methods:
+
+```rb
+include RemoteConfig::Flagging
+```
+
+```rb
+prompt_for_coffee_ordering if released? "coffee_ordering.cta"
+```
+
+```rb
+released? "coffee_ordering.cta" do
+  prompt_for_coffee_ordering
+end
+```
+
+### Adapters
+
+Where the feature and release flags are sorted from depends on what adapter is used. Currently, the only adapater is the `RemoteConfig::Adapters::RubyConfigAdapter`, which sources from a local YML file using the [Config](https://github.com/rubyconfig/config) gem.
+
+By default the feature flagging looks for values under under `features` and release flagging looks for values under `releases`.
+
+If you want to nest a flag under another, for example, you have a `coffee_ordering` release flag and you want to add a `coffee_ordernig.pre_pay` release flag. Then you can nest the new flag under the old one and add a `_` key underneath it for it's own value, e.g:
+
+```yml
+releases:
+  coffee_ordering:
+    _: uat
+    pre_pay: development
+
+```
+
+An example `app/config/settings.yml` might look like:
+
+```yml
+releases:
+  loyalty: uat
+  coffee_ordering:
+    _: production
+    pre_pay: production
+    v2:
+      _: uat
+      pre_pay: development
+    v3:
+      _: development
+
+features:
+  pay_in_car: true
+```
+
+NOTE: it may be useful to split out your releases and features YML into different files and load them in.
+
+`app/config/releases.yml`
+`app/config/features.yml`
+
+TODO: provide ruby snippet of how to set this up in the initializers
+

data/Rakefile

@@ -0,0 +1,24 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/rails_app/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+require_relative "./lib/remote_config/version"
+
+task :publish do
+  if ENV["GITHUB_REF"] == "refs/tags/v#{RemoteConfig::VERSION}"
+    puts "Release ref \"#{ENV["GITHUB_REF"]}\" matches gem version \"#{RemoteConfig::VERSION}\""
+
+    sh "gem build"
+    sh "ls *.gem | xargs gem push"
+
+    puts "Bult and pushed version #{RemoteConfig::VERSION} to rubygems"
+    exit 0
+  else
+    puts "Release ref \"#{ENV["GITHUB_REF"]}\" does not match gem version \"#{RemoteConfig::VERSION}\""
+    exit 1
+  end
+end

data/app/controllers/remote_config/application_controller.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RemoteConfig
+  class ApplicationController < ActionController::Base; end
+end

data/app/models/remote_config/application_record.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module RemoteConfig
+  # Base class for all RemoteConfig models
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/bin/rails

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path("..", __dir__)
+ENGINE_PATH = File.expand_path("../lib/remote-config/engine", __dir__)
+APP_PATH = File.expand_path("../spec/rails_app/config/application", __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+
+require "rails/all"
+require "rails/engine/commands"

data/config/routes.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+RemoteConfig::Engine.routes.draw {} # rubocop:disable Lint/EmptyBlock

data/lib/remote_config/adapters/base.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RemoteConfig
+  module Adapters
+    # Adapters are the interface for fetching the feature and release flags from
+    # varying sources.
+    class Base
+      attr_reader :options
+
+      def initialize(options)
+        @options = options
+      end
+
+      def fetch_feature_flag(key)
+        raise NotImplementedError
+      end
+
+      def fetch_release_flag(key)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/remote_config/adapters/ruby_config_adapter.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module RemoteConfig
+  module Adapters
+    # Adapter for fetching feature and release flags from a set up config using
+    # the Config gem (see https://github.com/rubyconfig/config).
+    class RubyConfigAdapter < Base
+      def fetch_feature_flag(key)
+        fetch_flag(options[:feature_flags_key], key)
+      end
+
+      def fetch_release_flag(key)
+        fetch_flag(options[:release_flags_key], key)
+      end
+
+    private
+
+      def fetch_flag(root_key, key)
+        value = config_class.dig(root_key, *key.split("."))
+        return value._ if value.is_a? Config::Options
+
+        value
+      rescue TypeError
+        nil
+      end
+
+      def config_class
+        options[:const_name].constantize
+      end
+    end
+  end
+end

data/lib/remote_config/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RemoteConfig
+  class Engine < ::Rails::Engine
+    isolate_namespace RemoteConfig
+  end
+end

data/lib/remote_config/exceptions.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# rubocop:disable Style/Documentation
+module RemoteConfig
+  class FlagError < StandardError
+    attr_reader :key
+
+    def initialize(key)
+      @key = key
+
+      super
+    end
+  end
+
+  class UnknownFeatureFlagError < FlagError
+    def message
+      "Unknown feature flag: #{key}"
+    end
+  end
+
+  class NonBooleanFeatureFlagError < FlagError
+    def message
+      "Non-boolean feature flag: #{key}"
+    end
+  end
+
+  class UnknownReleaseFlagError < FlagError
+    def message
+      "Unknown release flag: #{key}"
+    end
+  end
+
+  class UnknownReleaseStageError < FlagError
+    attr_reader :value
+
+    def initialize(key, value)
+      @value = value
+
+      super(key)
+    end
+
+    def message
+      "Unknown release stage \"#{value}\" for release flag: #{key}"
+    end
+  end
+end
+# rubocop:enable Style/Documentation

data/lib/remote_config/flagging.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RemoteConfig
+  # Module to be included into the using application to allow for checking
+  # for feature and release flags.
+  module Flagging
+    def feature_enabled?(key)
+      enabled = RemoteConfig.adapter.fetch_feature_flag(key)
+      raise RemoteConfig::UnknownFeatureFlagError, key if enabled.nil?
+      raise RemoteConfig::NonBooleanFeatureFlagError, key unless enabled.in? [true, false]
+
+      yield if block_given? && enabled
+
+      enabled
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    def released?(key)
+      release_stage = RemoteConfig.adapter.fetch_release_flag(key)
+      raise RemoteConfig::UnknownReleaseFlagError, key if release_stage.nil?
+
+      release_stages_envs = RemoteConfig.configuration.release_stages[release_stage.to_sym]
+      raise RemoteConfig::UnknownReleaseStageError.new(key, release_stage) if release_stages_envs.nil?
+
+      is_released = release_stages_envs.map(&:to_s).include? Rails.env
+
+      yield if block_given? && is_released
+
+      is_released
+    end
+    # rubocop:enable Metrics/AbcSize
+  end
+end

data/lib/remote_config/rails/routes.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ActionDispatch
+  module Routing
+    # Re-open the ActionDispatch::Routing::Mapping class and include the methods
+    # for flagging.
+    class Mapper
+      include RemoteConfig::Flagging
+    end
+  end
+end

data/lib/remote_config/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RemoteConfig
+  VERSION = "1.0.0-beta.1"
+end

data/lib/remote_config.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "remote_config/version"
+require "remote_config/engine"
+require "remote_config/flagging"
+require "remote_config/exceptions"
+require "remote_config/adapters/base"
+require "remote_config/adapters/ruby_config_adapter"
+
+# Root gem module containing config and adapter setup.
+module RemoteConfig
+  Configuration = Struct.new(
+    # The adapter to be used for fetching the flags.
+    :adapter,
+    # The options hash to be passed to the adapter at initialization.
+    :adapter_options,
+    # An hash of release stages to an array of rails environments that will have
+    # the it will release to.
+    :release_stages,
+    keyword_init: true
+  )
+
+  class << self
+    def configure
+      yield configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new(
+        adapter:         Adapters::RubyConfigAdapter,
+        adapter_options: {
+          const_name:        "Settings",
+          feature_flags_key: "feature_flags",
+          release_flags_key: "release_flags"
+        },
+
+        release_stages:  {
+          production:  %i[production development],
+          development: %i[development]
+        }
+      )
+    end
+
+    def adapter
+      @adapter ||= configuration.adapter.new(configuration.adapter_options)
+    end
+  end
+end
+
+require "remote_config/rails/routes" if defined? ::Rails

data/remote-config.gemspec

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "remote_config/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "remote_config"
+  spec.version     = RemoteConfig::VERSION
+  spec.authors     = ["Montgomery Anderson"]
+  spec.email       = "montgomery.c.anderson@gmail.com"
+
+  spec.summary     = "Remote Config for Ruby on Rails"
+  spec.description = "Remote Config for Ruby on Rails"
+  spec.homepage    = "https://github.com/paperkite/rails-remote-config"
+
+  spec.require_paths         = ["lib"]
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+end

data/spec/rails_app/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/spec/rails_app/Rakefile

@@ -0,0 +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_relative "config/application"
+
+Rails.application.load_tasks

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

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

data/spec/rails_app/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/rails_app/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/rails_app/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/rails_app/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/rails_app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end