remote_config 1.0.0.pre.beta.1 → 1.0.0.pre.beta.2

checksums.yaml

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

data/README.md

@@ -4,6 +4,27 @@ A gem for managing feature and release flags in the backend and providing them r
 
 ## Usage
 
+Add the following lines to your Gemfile:
+
+```rb
+gem "config"
+gem "remote_config"
+```
+
+Run the Config gem's install generator:
+
+```sh
+rails g config:install
+```
+
+Run this gem's install generator:
+
+```sh
+rails g remote_config:install
+```
+
+With a default Config gem setup you should be good to go! Review the `app/config/remote_config` initializer and make sure the release stages make sense for your setup.
+
 ### Feature Flagging
 
 Flagging allows checking of config values and doing different things based on their boolean value.
@@ -88,7 +109,7 @@ By default the feature flagging looks for values under under `features` and rele
 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:
+release_flags:
   coffee_ordering:
     _: uat
     pre_pay: development
@@ -98,7 +119,7 @@ releases:
 An example `app/config/settings.yml` might look like:
 
 ```yml
-releases:
+release_flags:
   loyalty: uat
   coffee_ordering:
     _: production
@@ -109,14 +130,6 @@ releases:
     v3:
       _: development
 
-features:
+feature_flags:
   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/bin/rails

@@ -3,7 +3,7 @@
 # installed from the root of your application.
 
 ENGINE_ROOT = File.expand_path("..", __dir__)
-ENGINE_PATH = File.expand_path("../lib/remote-config/engine", __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.

data/lib/generators/remote_config/install_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RemoteConfig
+  module Generators
+    # Adapter for fetching feature and release flags from a set up config using
+    # the Config gem (see https://github.com/rubyconfig/config).
+    class InstallGenerator < ::Rails::Generators::Base
+      desc "Generates a custom Rails RemoteConfig initializer file."
+
+      # rubocop:disable Naming/MemoizedInstanceVariableName
+      def self.source_root
+        @_config_source_root ||= File.expand_path("templates", __dir__)
+      end
+      # rubocop:enable Naming/MemoizedInstanceVariableName
+
+      def copy_initializer
+        template "remote_config.rb", "config/initializers/remote_config.rb"
+      end
+    end
+  end
+end

data/lib/generators/remote_config/templates/remote_config.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+RemoteConfig.configure do |config|
+  # Overwrite to change the adapter to fetch the flags from a different source.
+  # Currently, the gem only comes with the RubyConfigAdapter.
+  config.adapter = RemoteConfig::Adapters::RubyConfigAdapter
+
+  # Options to be provided to the specific adapters initialization.
+  config.adapter_options = {
+    const_name:        "Settings",
+    feature_flags_key: "feature_flags",
+    release_flags_key: "release_flags"
+  }
+
+  # Defines the release stages that are used to check release flags for their
+  # current environments release status.
+  #
+  # A release flag is true if the current environment is in the release stage
+  # configured for the flag.
+  # e.g.
+  # - if you have a release stage uat: [:uat, :dev, :development]
+  # - and release flag "coffee.pre_pay" is configured to "uat"
+  # - then it will return true when the Rails.env is either uat, dev or development
+  # - and it will return false on other environments, e.g. production, staging
+  config.release_stages = {
+    production:  %i[production development],
+    development: %i[development]
+  }
+end

data/lib/remote_config/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: remote_config
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta.1
+  version: 1.0.0.pre.beta.2
 platform: ruby
 authors:
 - Montgomery Anderson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-14 00:00:00.000000000 Z
+date: 2022-03-15 00:00:00.000000000 Z
 dependencies: []
 description: Remote Config for Ruby on Rails
 email: montgomery.c.anderson@gmail.com
@@ -28,6 +28,8 @@ files:
 - app/models/remote_config/application_record.rb
 - bin/rails
 - config/routes.rb
+- lib/generators/remote_config/install_generator.rb
+- lib/generators/remote_config/templates/remote_config.rb
 - lib/remote_config.rb
 - lib/remote_config/adapters/base.rb
 - lib/remote_config/adapters/ruby_config_adapter.rb