figjam 1.5.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0ed678f68603cf0ac2b6a695ae0c0516626c229964edc3e1b8175e2a306e210
-  data.tar.gz: 46b53becca0e9b613496b1c5699fc7ba4d486d3a95ac841751eafaa9c2fbd91b
+  metadata.gz: c19765a2d3f1c74d94a252a078c81ee48082fab4c652e5c2a110dfbe6e8a6a10
+  data.tar.gz: 9960fa166227677f8bca0349f73252affb76bb9294ad58a23604f992b35f5da0
 SHA512:
-  metadata.gz: f8e492711470e7b4aaa1a999d00d2feedfb9e116d4f93a1393183ad9e4ff4f6c65283150d3ff3d0539b199be45c819db85f4b4f4132caac138ff69b5cd58d828
-  data.tar.gz: 96f49716a0ba722587c3553b2f2463ed9fa239c5bf498a4e82dd1642ada3a3c7d3e4ab55f9fb57136ca7f041c1fa59d1726c9d696a9ed71444feb50c98c09343
+  metadata.gz: 7076ad53317d9110da3111427213c3aa63ba8489071864914bc9330256dcc5cde40ad5810c7effd56b2de917e16339d3b080b59a70839ea1be7868df24f20b2f
+  data.tar.gz: f3cb38979cca5dbbc4f5ea5afa72ebe2d34b9f9f085e431e2c73c16dc1a10548a24c082f6fc3fd4c58626f9317b2184b8c35b88c96e2f265ef64843990b252e7

data/README.md

@@ -1,6 +1,13 @@
+<img align="right" width="150" src="jamjar.png">
+
 figjam
 ================
 
+[![Gem Version](https://img.shields.io/gem/v/figjam?color=green)](https://rubygems.org/gems/figjam)
+[![specs workflow](https://github.com/hlascelles/figjam/actions/workflows/specs.yml/badge.svg)](https://github.com/hlascelles/figjam/actions)
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+
 Figjam makes it easy to configure ruby and Rails apps `ENV` values by just using a single YAML file.
 
 PRs to applications often need to come with default configuration values, but hardcoding these into
@@ -11,16 +18,35 @@ Figjam encourages you to commit default ENV values to a yaml file in your PRs. T
 loaded at runtime, but, crucially, can be overridden at any time by supplying a real ENV. This
 brings the ease of PR creation with the flexibility of runtime ENV changes.
 
+An example configuration file might look like this:
+
+```yaml
+GOOGLE_TAG_MANAGER_ID: GTM-12345
+PAYMENT_ENDPOINT: https://payments.localhost
+
+prelive:
+  GOOGLE_TAG_MANAGER_ID: GTM-54321
+  PAYMENT_ENDPOINT: https://payments-prelive.example.com
+
+production:
+  GOOGLE_TAG_MANAGER_ID: GTM-34343
+  PAYMENT_ENDPOINT: https://payments.example.com
+```
 
-### Usage
+### Installation
 
-Add Figjam to your Gemfile and `bundle install`:
+Figjam can be used with or without Rails. If using Bundler, add Figjam to your Gemfile and `bundle install`:
 
 ```ruby
 gem "figjam"
 ```
 
-Then:
+### Usage with Rails 
+
+Figjam will load itself automatically if you are using Rails. It will look for a
+`config/application.yml` file for ENV configuration.
+
+You can create a default configuration file by running:
 
 ```bash
 $ bundle exec figjam install
@@ -30,10 +56,39 @@ This creates a commented `config/application.yml` file which you can add default
 Add your own configuration to this file for all environments, and any specific environment
 overrides.
 
-### Example
+### Usage in Rails engines
+
+Figjam is perfect for Rails engines. They can have their own configuration file, and
+they can be loaded independently or in addition of the main application. To do this,
+you can create a `config/application.yml` file in your engine, and add this initializer:
+
+```ruby
+Figjam::Application.new(
+  environment: ::Rails.env,
+  path: File.expand_path("../application.yml", __dir__)
+).load
+```
+
+### Usage without Rails
 
-Given the following configuration file, the default value at the top will be used unless
-RAILS_ENV matches any of the subsequent keys (like `test`, `prelive`, `produciton`).
+If you are not using Rails, you can load Figjam in your gem. Note, you can
+do this as many times as you like. If you have multiple internal gems, they can
+all use `figjam` to load their own configuration independently.
+
+```ruby
+Figjam::Application.new(
+  environment: "some_environment_key",
+  path: "#{__dir__}/application.yml"
+).load
+```
+
+### How the loaded configuration is used 
+
+The configuration file is loaded by `figjam` into `ENV` at runtime. If any of the keys are already
+set in the process ENV, then the ENV value will take precedence.
+
+In terms of the file itself, the non-indented values at the top are the default values and will be
+used unless RAILS_ENV matches any of the subsequent keys (like `test`, `prelive`, `production`).
 
 ```yaml
 # config/application.yml
@@ -64,8 +119,35 @@ var gtm_id = <%= ENV.fetch("GOOGLE_TAG_MANAGER_ID") %>
 
 Note, secrets are not to be provided by figjam, so do not add them to your `application.yml`.
 
-**Please note:** `ENV` is a simple key/value store. All values will be converted
-to strings. Deeply nested configuration structures are not possible.
+Deeply nested configuration structures are not possible.
+
+## Silencing type conversion warnings
+
+Remember that `ENV` in ruby is a simple key/value store. All values will always be strings.
+This means that the following code will produce string values:
+
+```yaml
+SOME_NUMBER: 3
+SOME_BOOLEAN: true
+```
+
+```ruby
+# WARNING: Use strings for Figjam configuration. 3 was converted to "3"
+# WARNING: Use strings for Figjam configuration. true was converted to "true"
+
+ENV["SOME_NUMBER"] == 3 # => false
+ENV["SOME_NUMBER"] == "3" # => true
+ENV["SOME_BOOLEAN"] == true # => false
+ENV["SOME_BOOLEAN"] == "true" # => true
+```
+
+Because this is a possible cause of sleeper bugs, Figjam emits a warning when it does this
+conversion to a string. If you are confident in your abilities, you can silence it by adding this
+to the top of your `application.yml`:
+
+```yaml
+FIGJAM_SILENCE_STRING_WARNINGS: true
+```
 
 ### Using `Figjam.env`
 
@@ -93,6 +175,10 @@ Figjam.env.something_else # => nil
 Figjam.env.something_else? # => false
 ```
 
+If you wish to use `ENV` in specs and want to temporarily change what it returns, you should
+definitely look at using the excellent [climate_control](https://github.com/thoughtbot/climate_control)
+gem.
+
 ### Required Keys
 
 If a particular configuration value is required but not set, it's appropriate to
@@ -132,8 +218,8 @@ Figjam and dotenv are similar:
 ### Differences
 
 * Configuration File
-  * Figjam expects a single file.
-  * Dotenv supports separate files for each environment.
+  * Figjam only needs a single file.
+  * Dotenv must use separate files for each environment.
 * Configuration File Format
   * Figjam expects YAML containing key/value pairs.
   * Dotenv convention is a collection of `KEY=VALUE` pairs.
@@ -161,7 +247,8 @@ If you're using Spring add `config/application.yml` to the watch list:
 
 ## Figjam origins
 
-Figjam started as a direct fork of the [figaro](https://github.com/laserlemon/figaro) rubygem.
+Figjam started as a direct fork of the [figaro](https://github.com/laserlemon/figaro) rubygem. Thanks
+to @laserlemon for the great work on that gem.
 
 There are some key differences in philosophy:
 
@@ -182,3 +269,5 @@ It even aliases the `Figaro` to `Figjam` module namespace for drop-in compatibil
 
 Figjam is open source and contributions from the community are encouraged! No
 contribution is too small.
+
+Jam jar image from https://vectorportal.com/

data/lib/figjam/application.rb

@@ -3,17 +3,18 @@ require "yaml"
 require "figjam/figaro_alias"
 
 module Figjam
+  # :reek:TooManyMethods
   class Application
-    FIGARO_ENV_PREFIX = "_FIGARO_"
+    FIGARO_ENV_PREFIX = "_FIGARO_".freeze
     SILENCE_STRING_WARNINGS_KEYS = %i[
       FIGARO_SILENCE_STRING_WARNINGS
       FIGJAM_SILENCE_STRING_WARNINGS
-    ]
+    ].freeze
 
     include Enumerable
 
     def initialize(options = {})
-      @options = options.inject({}) { |m, (k, v)| m[k.to_sym] = v; m }
+      @options = options.transform_keys(&:to_sym)
     end
 
     def path
@@ -26,7 +27,7 @@ module Figjam
 
     def environment
       environment = @options.fetch(:environment) { default_environment }
-      environment.nil? ? nil : environment.to_s
+      environment&.to_s
     end
 
     def environment=(environment)
@@ -39,7 +40,7 @@ module Figjam
 
     def load
       each do |key, value|
-        skip?(key) ? key_skipped!(key) : set(key, value)
+        skip?(key) ? key_skipped(key) : set(key, value)
       end
     end
 
@@ -47,58 +48,66 @@ module Figjam
       configuration.each(&block)
     end
 
-    private
-
-    def default_path
+    private def default_path
       raise NotImplementedError
     end
 
-    def default_environment
+    private def default_environment
       nil
     end
 
-    def raw_configuration
+    private def raw_configuration
       (@parsed ||= Hash.new { |hash, path| hash[path] = parse(path) })[path]
     end
 
-    def parse(path)
-      File.exist?(path) && YAML.load(ERB.new(File.read(path)).result) || {}
+    private def parse(path)
+      (File.exist?(path) && load_yaml(ERB.new(File.read(path)).result)) || {} # nosemgrep
+    end
+
+    # rubocop:disable Security/YAMLLoad
+    private def load_yaml(source)
+      # https://bugs.ruby-lang.org/issues/17866
+      # https://github.com/rails/rails/commit/179d0a1f474ada02e0030ac3bd062fc653765dbe
+      YAML.load(source, aliases: true) || {}
+    rescue ArgumentError
+      YAML.load(source) || {}
     end
+    # rubocop:enable Security/YAMLLoad
 
-    def global_configuration
+    private def global_configuration
       raw_configuration.reject { |_, value| value.is_a?(Hash) }
     end
 
-    def environment_configuration
+    private def environment_configuration
       raw_configuration[environment] || {}
     end
 
-    def set(key, value)
+    private def set(key, value)
       unless non_string_warnings_silenced?
-        non_string_configuration!(key) unless key.is_a?(String)
-        non_string_configuration!(value) unless value.is_a?(String) || value.nil?
+        non_string_configuration(key) unless key.is_a?(String)
+        non_string_configuration(value) unless value.is_a?(String) || value.nil?
       end
 
       ::ENV[key.to_s] = value.nil? ? nil : value.to_s
-      ::ENV[FIGARO_ENV_PREFIX + key.to_s] = value.nil? ? nil: value.to_s
+      ::ENV[FIGARO_ENV_PREFIX + key.to_s] = value.nil? ? nil : value.to_s
     end
 
-    def skip?(key)
+    private def skip?(key)
       ::ENV.key?(key.to_s) && !::ENV.key?(FIGARO_ENV_PREFIX + key.to_s)
     end
 
-    def non_string_warnings_silenced?
+    private def non_string_warnings_silenced?
       SILENCE_STRING_WARNINGS_KEYS.any? { |key|
         # Allow the silence configuration itself to use non-string keys/values.
-        configuration.values_at(key.to_s, key).any? { |cv| cv.to_s == 'true' }
+        configuration.values_at(key.to_s, key).any? { |cv| cv.to_s == "true" }
       }
     end
 
-    def non_string_configuration!(value)
-      warn "WARNING: Use strings for Figjam configuration. #{value.inspect} was converted to #{value.to_s.inspect}."
+    private def non_string_configuration(value)
+      warn "WARNING: Use strings for Figjam configuration. #{value.inspect} was converted to #{value.to_s.inspect}." # rubocop:disable Layout/LineLength
     end
 
-    def key_skipped!(key)
+    private def key_skipped(key)
       warn "WARNING: Skipping key #{key.inspect}. Already set in ENV."
     end
   end

data/lib/figjam/cli/install.rb

@@ -6,12 +6,12 @@ module Figjam
       include Thor::Actions
 
       class_option "path",
-        aliases: ["-p"],
-        default: "config/application.yml",
-        desc: "Specify a configuration file path"
+                   aliases: ["-p"],
+                   default: "config/application.yml",
+                   desc: "Specify a configuration file path"
 
       def self.source_root
-        File.expand_path("../install", __FILE__)
+        File.expand_path("install", __dir__)
       end
 
       def create_configuration

data/lib/figjam/cli/task.rb

@@ -13,17 +13,15 @@ module Figjam
         @options = options
       end
 
-      private
-
-      def env
+      private def env
         ENV.to_hash.update(configuration)
       end
 
-      def configuration
+      private def configuration
         application.configuration
       end
 
-      def application
+      private def application
         @application ||= Figjam::Application.new(options)
       end
 

data/lib/figjam/cli.rb

@@ -8,9 +8,9 @@ module Figjam
     desc "install", "Install Figjam"
 
     method_option "path",
-      aliases: ["-p"],
-      default: "config/application.yml",
-      desc: "Specify a configuration file path"
+                  aliases: ["-p"],
+                  default: "config/application.yml",
+                  desc: "Specify a configuration file path"
 
     def install
       require "figjam/cli/install"

data/lib/figjam/env.rb

@@ -6,15 +6,14 @@ module Figjam
       key, punctuation = extract_key_from_method(method)
 
       case punctuation
-      when "!" then has_key?(key) || super
+      when "!" then has_key?(key) || super # rubocop:disable Style/PreferredHashMethods
       when "?", nil then true
       else super
       end
     end
 
-    private
-
-    def method_missing(method, *)
+    # rubocop:disable Style/MissingRespondToMissing
+    private def method_missing(method, *)
       key, punctuation = extract_key_from_method(method)
 
       case punctuation
@@ -24,20 +23,23 @@ module Figjam
       else super
       end
     end
+    # rubocop:enable Style/MissingRespondToMissing
 
-    def extract_key_from_method(method)
+    private def extract_key_from_method(method)
       method.to_s.downcase.match(/^(.+?)([!?=])?$/).captures
     end
 
-    def has_key?(key)
+    # rubocop:disable Naming/PredicateName
+    private def has_key?(key)
       ::ENV.any? { |k, _| k.downcase == key }
     end
+    # rubocop:enable Naming/PredicateName
 
-    def missing_key!(key)
-      raise MissingKey.new(key)
+    private def missing_key!(key)
+      raise MissingKey, key
     end
 
-    def get_value(key)
+    private def get_value(key)
       _, value = ::ENV.detect { |k, _| k.downcase == key }
       value
     end

data/lib/figjam/rails/application.rb

@@ -1,19 +1,17 @@
 module Figjam
   module Rails
     class Application < Figjam::Application
-      private
-
-      def default_path
-        rails_not_initialized! unless ::Rails.root
+      private def default_path
+        rails_not_initialized unless ::Rails.root
 
         ::Rails.root.join("config", "application.yml")
       end
 
-      def default_environment
+      private def default_environment
         ::Rails.env
       end
 
-      def rails_not_initialized!
+      private def rails_not_initialized
         raise RailsNotInitialized
       end
     end

data/lib/figjam/rails.rb

@@ -3,10 +3,10 @@ require "figjam/figaro_alias"
 begin
   require "rails"
 rescue LoadError
+  # Cater for no Rails
 else
   require "figjam/rails/application"
 
   Figjam.adapter = Figjam::Rails::Application
   require "figjam/rails/railtie"
 end
-

data/lib/figjam/version.rb

@@ -1,3 +1,3 @@
 module Figjam
-  VERSION = "1.5.0"
+  VERSION = "1.6.1".freeze
 end

data/lib/figjam.rb

@@ -7,7 +7,7 @@ require "figjam/env"
 require "figjam/application"
 
 module Figjam
-  extend self
+  extend self # rubocop:disable Style/ModuleFunction
 
   attr_writer :adapter, :application
 
@@ -29,7 +29,7 @@ module Figjam
 
   def require_keys(*keys)
     missing_keys = keys.flatten - ::ENV.keys
-    raise MissingKeys.new(missing_keys) if missing_keys.any?
+    raise MissingKeys, missing_keys if missing_keys.any?
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: figjam
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Harry Lascelles
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-30 00:00:00.000000000 Z
+date: 2024-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -114,6 +114,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -129,7 +143,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -170,6 +184,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -235,7 +263,7 @@ metadata:
   source_code_uri: https://github.com/hlascelles/figjam/
   bug_tracker_uri: https://github.com/hlascelles/figjam/issues
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -243,15 +271,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: ENV configuration for ruby using yaml files
 test_files: []