app_configurable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2bbcefb59395aa424d071c1f2122d7f051e87571ff75d62eb56c80c4c3fc6ec4
+  data.tar.gz: b095757dfcf1351ed5fabe65106dcf8a8a039a7a62744f8b811620dd0ef537f6
+SHA512:
+  metadata.gz: ce77b5158704203937bc2460bf5020d4b34200598c3f85e4e5e832935f5ee29d4c784ed12ded51d159770e820ad64a74dcb9d4c5e004fa2cbc1064282901b805
+  data.tar.gz: d9335f684c5da7ea160030d0da4d28642f73dd779059508a60a9e9b89240353a79fdaf62313936337506979c2f89b377464d08283e9f94978ab79092545ddd49

data/.byebug_history

@@ -0,0 +1,6 @@
+exit
+::Rails
+Rails
+config
+exit
+self

data/.rspec

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

data/.rubocop/custom.yml

@@ -0,0 +1,97 @@
+Layout/BlockAlignment:
+  EnforcedStyleAlignWith: start_of_block
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: normal
+
+Layout/LineLength:
+  Max: 140
+
+Layout/MultilineHashKeyLineBreaks:
+  Enabled: true
+
+Layout/FirstHashElementLineBreak:
+  Enabled: true
+
+Layout/MultilineAssignmentLayout:
+  Enabled: true
+  EnforcedStyle: new_line
+
+Lint/Debugger: # don't leave binding.pry
+  Enabled: true
+  Exclude: []
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: true
+  Exclude:
+    - 'spec/**/*'
+
+Lint/EmptyBlock:
+  Enabled: true
+  Exclude:
+    - 'spec/factories/**/*'
+
+Lint/MissingSuper:
+  Enabled: true
+  Exclude:
+      - 'app/graphql/sources/**/*'
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 20
+  Exclude:
+    - lib/**/*.rake
+    - spec/support/fixtures_setup.rb
+
+Metrics/AbcSize:
+  CountRepeatedAttributes: false
+  Exclude:
+    - lib/**/*.rake
+    - spec/support/fixtures_setup.rb
+    - app/models/ability.rb
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - lib/**/*.rake
+
+Metrics/BlockLength:
+  Exclude:
+    - app/admin/**/*.rb
+    - app/views/admin/**/*.arb
+    - lib/**/*.rake
+    - config/initializers/*.rb
+    - config/routes.rb
+
+Naming/PredicateName:
+  Enabled: false
+
+Naming/VariableNumber:
+  Enabled: false
+
+Naming/BlockForwarding:
+  EnforcedStyle: explicit
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/FormatStringToken:
+  EnforcedStyle: template
+
+Style/ArgumentsForwarding:
+  UseAnonymousForwarding: false
+
+Style/GlobalVars:
+  AllowedVariables:
+    - $redis

data/.rubocop/rails.yml

@@ -0,0 +1,60 @@
+Rails:
+  Enabled: true
+
+Rails/SkipsModelValidations:
+  Enabled: false
+
+Rails/ReversibleMigration:
+  Enabled: false
+
+Rails/CreateTableWithTimestamps:
+  Enabled: false
+
+Rails/RakeEnvironment:
+  Enabled: false
+
+Rails/HasManyOrHasOneDependent:
+  Enabled: false
+
+Rails/HasAndBelongsToMany:
+  Enabled: false
+
+Rails/NotNullColumn:
+  Enabled: false
+
+Rails/Exit:
+  Enabled: false
+
+Rails/ApplicationController:
+  Enabled: false
+
+Rails/Output: # Don't leave puts-debugging
+  Enabled: true
+  Exclude: []
+
+Rails/OutputSafety:
+  Enabled: true
+  Exclude:
+    - app/admin/**/*
+    - app/helpers/admin/**/*
+    - app/views/admin/**/*
+    - app/inputs/**/*
+
+Rails/FindEach: # each could severely affect the performance, use find_each
+  Enabled: true
+  Exclude: []
+
+Rails/UniqBeforePluck: # uniq.pluck and not pluck.uniq
+  Enabled: true
+  Exclude: []
+
+Rails/UnknownEnv:
+  Environments:
+    - production
+    - staging
+    - development
+    - test
+
+Rails/I18nLocaleTexts:
+  Exclude:
+    - app/admin/**/*

data/.rubocop/rspec.yml

@@ -0,0 +1,42 @@
+RSpec/BeforeAfterAll: # we use before/after blocks to setup es tests
+  Enabled: false
+
+RSpec/DescribeClass:
+  Enabled: true
+  Exclude:
+    - spec/lib/tasks/**/*
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 15
+
+RSpec/MultipleExpectations:
+  Max: 15
+
+RSpec/ExampleLength:
+  Max: 35
+
+RSpec/NestedGroups:
+  Max: 6
+
+RSpec/StubbedMock:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/LetSetup:
+  Enabled: false
+
+RSpec/Focus: # run ALL tests on CI
+  Enabled: true
+  Exclude: []
+
+RSpec/ImplicitSubject:
+  Exclude:
+    - spec/graphql/resolvers/**/*_spec.rb

data/.rubocop.yml

@@ -0,0 +1,38 @@
+require:
+  - rubocop-performance # https://docs.rubocop.org/rubocop-performance/cops_performance.html
+  - rubocop-rails # https://docs.rubocop.org/rubocop-rails/cops_rails.html
+  - rubocop-rspec # https://docs.rubocop.org/rubocop-rspec/cops_rspec.html
+  - rubocop-rspec_rails # https://docs.rubocop.org/rubocop-rspec/cops_rspec_rails.html
+
+inherit_mode:
+  merge:
+    - Exclude
+
+inherit_from:
+  - .rubocop/rails.yml
+  - .rubocop/rspec.yml
+  - .rubocop/custom.yml
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.1.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
+Metrics/ParameterLists:
+  CountKeywordArgs: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-11-14
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at dmytro.pasichnyk@omr.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in app_configurable.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,251 @@
+PATH
+  remote: .
+  specs:
+    app_configurable (0.1.0)
+      dotenv
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.2.2)
+      actionpack (= 7.2.2)
+      activesupport (= 7.2.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.2.2)
+      actionpack (= 7.2.2)
+      activejob (= 7.2.2)
+      activerecord (= 7.2.2)
+      activestorage (= 7.2.2)
+      activesupport (= 7.2.2)
+      mail (>= 2.8.0)
+    actionmailer (7.2.2)
+      actionpack (= 7.2.2)
+      actionview (= 7.2.2)
+      activejob (= 7.2.2)
+      activesupport (= 7.2.2)
+      mail (>= 2.8.0)
+      rails-dom-testing (~> 2.2)
+    actionpack (7.2.2)
+      actionview (= 7.2.2)
+      activesupport (= 7.2.2)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4, < 3.2)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    actiontext (7.2.2)
+      actionpack (= 7.2.2)
+      activerecord (= 7.2.2)
+      activestorage (= 7.2.2)
+      activesupport (= 7.2.2)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.2.2)
+      activesupport (= 7.2.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.2.2)
+      activesupport (= 7.2.2)
+      globalid (>= 0.3.6)
+    activemodel (7.2.2)
+      activesupport (= 7.2.2)
+    activerecord (7.2.2)
+      activemodel (= 7.2.2)
+      activesupport (= 7.2.2)
+      timeout (>= 0.4.0)
+    activestorage (7.2.2)
+      actionpack (= 7.2.2)
+      activejob (= 7.2.2)
+      activerecord (= 7.2.2)
+      activesupport (= 7.2.2)
+      marcel (~> 1.0)
+    activesupport (7.2.2)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+    ast (2.4.2)
+    base64 (0.2.0)
+    benchmark (0.4.0)
+    bigdecimal (3.1.8)
+    builder (3.3.0)
+    byebug (11.1.3)
+    concurrent-ruby (1.3.4)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    date (3.4.0)
+    diff-lcs (1.5.1)
+    dotenv (3.1.4)
+    drb (2.2.1)
+    erubi (1.13.0)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.6)
+      concurrent-ruby (~> 1.0)
+    io-console (0.7.2)
+    irb (1.14.1)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.7.6)
+    language_server-protocol (3.17.0.3)
+    logger (1.6.1)
+    loofah (2.23.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    mini_mime (1.1.5)
+    minitest (5.25.1)
+    net-imap (0.5.1)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.0)
+      net-protocol
+    nio4r (2.7.4)
+    nokogiri (1.16.7-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.7-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.24.0)
+    parser (3.3.6.0)
+      ast (~> 2.4.1)
+      racc
+    psych (5.2.0)
+      stringio
+    racc (1.8.1)
+    rack (3.1.8)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rackup (2.2.1)
+      rack (>= 3)
+    rails (7.2.2)
+      actioncable (= 7.2.2)
+      actionmailbox (= 7.2.2)
+      actionmailer (= 7.2.2)
+      actionpack (= 7.2.2)
+      actiontext (= 7.2.2)
+      actionview (= 7.2.2)
+      activejob (= 7.2.2)
+      activemodel (= 7.2.2)
+      activerecord (= 7.2.2)
+      activestorage (= 7.2.2)
+      activesupport (= 7.2.2)
+      bundler (>= 1.15.0)
+      railties (= 7.2.2)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.2.2)
+      actionpack (= 7.2.2)
+      activesupport (= 7.2.2)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rdoc (6.7.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.9.2)
+    reline (0.5.11)
+      io-console (~> 0.5)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.2)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.68.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.36.1)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.23.0)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rails (2.27.0)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.52.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rspec (3.2.0)
+      rubocop (~> 1.61)
+    rubocop-rspec_rails (2.30.0)
+      rubocop (~> 1.61)
+      rubocop-rspec (~> 3, >= 3.0.1)
+    ruby-progressbar (1.13.0)
+    securerandom (0.3.2)
+    stringio (3.1.2)
+    thor (1.3.2)
+    timeout (0.4.2)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.6.0)
+    useragent (0.16.10)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.18)
+
+PLATFORMS
+  arm64-darwin-23
+  arm64-darwin-24
+  x86_64-linux
+
+DEPENDENCIES
+  app_configurable!
+  byebug
+  rails (> 7.1)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-performance (~> 1.23.0)
+  rubocop-rails (~> 2.27.0)
+  rubocop-rspec (~> 3.2.0)
+  rubocop-rspec_rails (~> 2.30.0)
+
+BUNDLED WITH
+   2.4.12

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Dmytro Pasichnyk
+
+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,62 @@
+# AppConfigurable
+
+Single source of truth for app configuration.
+
+## Adding a new config
+
+There are 2 types of configs:
+ - Namespaced - used to store configs which could be grouped by attributes such as external service name e.g Hubspot. 
+ - Root-level configs - generic configs for the app such as `rails_serve_static_files`.
+
+Example of namespaced config:
+
+```ruby
+class AppConfig::Hubspot
+  include AppConfigurable
+
+  entry :access_token, default: 'secret'
+  entry :base_url, default: 'https://app-eu1.hubspot.com/contacts/26265873', production: 'https://app-eu1.hubspot.com/contacts/25696692'
+  entry :client_secret, default: 'secret'
+end
+```
+
+Then config entries could be accessed through: `AppConfig::Hubspot.base_url`.
+
+## Attributes
+Attributes are declared using `entry` directive.
+Example: `entry :rails_serve_static_files`.
+
+### Options
+`production/staging/development/test` - sets attributes per environment.
+
+`default`:
+- sets default attribute, used in `production/staging/development` environments as a fallback.
+- accepts `string`/`number`/`boolean` as well as `Proc`/`Lambda` as a parameter.
+- in `test` environment always falls back to a dummy value `some_super_dummy_#{namespaced_attribute_name}`
+
+#### Priority and lifecycle:
+  `production/staging/development`:
+   1) Tries to find a value in joint hash of `ENV` and `Rails.application.credentials`.
+   2) Gets value from specific environment attribute passed to `entry`.
+   3) Get's value from `default`.
+   4) Raises `AppConfig::Error::RequiredVarMissing` if no attribute found.
+
+   `testing`:
+   1) Tries to find a value in joint hash of `ENV` and `Rails.application.credentials`.
+   2) Gets value from `test` environment attribute.
+   3) Returns `some_super_dummy_#{namespaced_attribute_name}`, ignores specified `default` attribute.
+
+### Setting the environment
+You could set environment per namespace like so:
+
+Given namespace `AppConfig::MyNiceConfigClass` and `.env.staging`
+
+```bash
+APPCONFIG_MYNICEMODULE_ENV=staging rspec
+```
+
+*`.env.#{RAILS_ENV}` will be read per specific `AppConfig::SomeNiceClass` class.*
+
+### TODO:
+ - Read `Rails.application.credentials`
+    - Make dynamic switch possible, simillar to what we have with `ENV`.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/app_configurable/error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module AppConfigurable
+  class Error < StandardError
+    class InvalidValue < Error; end
+    class RequiredVarMissing < Error; end
+  end
+end

data/lib/app_configurable/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AppConfigurable
+  VERSION = '0.1.0'
+end

data/lib/app_configurable.rb

@@ -0,0 +1,258 @@
+# frozen_string_literal: true
+
+require_relative 'app_configurable/version'
+
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/string_inquirer'
+
+require 'dotenv'
+
+module AppConfigurable
+  @@available_config_attributes = [] # rubocop:disable Style/ClassVars
+
+  def self.included(owner)
+    owner.extend ClassMethods
+    owner.include InstanceMethods
+  end
+
+  def self.available_config_attributes
+    @@available_config_attributes
+  end
+
+  # Report missing required `ENV` variables.
+  # @return [Array]
+  def self.missing_required_vars
+    out = []
+
+    available_config_attributes.each do |method|
+      method.call
+    rescue Error::RequiredVarMissing
+      out << "#{method.receiver.name}.#{method.name}"
+    end
+    out
+  end
+
+  module ClassMethods
+    #--------------------------------------- Service
+    # return [Array]
+    def config_attributes
+      @config_attributes
+    end
+
+    # @param value [String]
+    # return [Boolean]
+    def env_value_boolean?(value)
+      env_value_truthy?(value) || env_value_falsey?(value)
+    end
+
+    # `true` if value is falsey.
+    #
+    #   # These are falsey.
+    #   DEBUG=0
+    #   DEBUG=-1
+    #   DEBUG=false
+    #   DEBUG=f
+    #   DEBUG=no
+    #   DEBUG=disabled
+    #
+    # @param value [String]
+    # @return [Boolean]
+    def env_value_falsey?(value)
+      %w[0 -1 false f n no disabled].include? value.to_s.downcase
+    end
+
+    # `true` if value is truthy.
+    #
+    #   # These are truthy.
+    #   DEBUG=1
+    #   DEBUG=true
+    #   DEBUG=y
+    #   DEBUG=yes
+    #   DEBUG=enabled
+    #
+    # @param value [String]
+    # @return [Boolean]
+    def env_value_truthy?(value)
+      %w[1 true y yes enabled].include? value.to_s.downcase
+    end
+
+    # @param name [Symbol/String]
+    # @param default [Proc/String]
+    # @param development [String]
+    # @param production [String]
+    # @param staging [String]
+    # @param test [String]
+    # @return [void] Defines a class/instance getters for `name`.
+    def entry(name, default: nil, development: nil, production: nil, staging: nil, test: nil) # rubocop:disable Metrics/AbcSize
+      defined?(@config_attributes) ? @config_attributes << name : @config_attributes = [name]
+
+      define_method(name) do
+        preset_value = { development:, production:, staging:, test: }[rails_env.to_sym]
+
+        if instance_variable_defined?(:"@#{name}")
+          instance_variable_get(:"@#{name}")
+        else
+          instance_variable_set(:"@#{name}", per_env_value_fallback_for(name, default:, preset: preset_value))
+        end
+      end
+
+      define_singleton_method(name.to_s, -> { instance.public_send(name) })
+      AppConfigurable.available_config_attributes << method(name)
+    end
+
+    # @return [AppConfigurable]
+    def instance
+      @instance ||= new
+    end
+
+    delegate :rails_env, to: :instance
+  end
+
+  module InstanceMethods
+    require_relative 'app_configurable/error'
+
+    def initialize(attrs = {})
+      attrs.each { |k, v| public_send(:"#{k}=", v) }
+    end
+
+    # A *copy* of the credentials for value-reading purposes.
+    # @return [Hash]
+    def credentials
+      @credentials ||= ::Rails.application&.credentials.to_h
+    end
+
+    # A *copy* of the environment for value-reading purposes.
+    # @return [Hash]
+    def env
+      @env ||= ::Rails.env == rails_env ? ENV.to_h : ::Dotenv.parse(".env.#{rails_env}")
+    end
+
+    # @!attribute rails_env
+    # @return [ActiveSupport::StringInquirer] Default is `Rails.env`.
+    def rails_env
+      @rails_env ||= submodule_env || ::Rails.env
+    end
+
+    def rails_env=(value)
+      @rails_env =
+        begin
+          wrapper_klass = ActiveSupport::StringInquirer
+          value.is_a?(wrapper_klass) ? value : wrapper_klass.new(value)
+        end
+      recalculate_env
+      recalculate_values
+    end
+
+    # @return [ActiveSupport::StringInquirer/nil]
+    def submodule_env
+      @submodule_env ||=
+        begin
+          class_name = self.class.name
+          if class_name
+            selector = "#{class_name.parameterize(separator: "_")}_ENV"
+            env_string = ENV.fetch(selector.upcase, nil)
+            ActiveSupport::StringInquirer.new(env_string) if env_string
+          end
+        end
+    end
+
+    #--------------------------------------- `ENV` management
+    private
+
+    # @see #env_truthy?
+    # @param [String]
+    # @return [Boolean]
+    def env_boolean?(key)
+      env_falsey?(key) || env_truthy?(key)
+    end
+
+    # @see #env_truthy?
+    def env_falsey?(key)
+      self.class.env_value_falsey?(secrets[key.to_s])
+    end
+
+    # @param key [String/Symbol]
+    # @return [String/Boolean] The value of the environment variable, converts `bolean`'ish values into boolean.
+    def env_value(key)
+      v = secrets.dig(*key)
+      v = env_truthy?(key) if env_boolean?(key)
+      v
+    end
+
+    # `true` if environment variable `key` is truthy.
+    #
+    #   env_truthy? "WITH_HTTP"   # => `true` or `false`
+    #   env_truthy? :WITH_HTTP    # same as above
+    #
+    # @param key [String]
+    # @return [Boolean]
+    def env_truthy?(key)
+      self.class.env_value_truthy?(secrets[key.to_s])
+    end
+
+    # @param name [Symbol/String]
+    # @param default [Proc/String]
+    # @param preset [String]
+    # @raise [Error::RequiredVarMissing]
+    # @return [String]
+    def per_env_value_fallback_for(name, default: nil, preset: nil)
+      namespace = self.class.name&.[](/(?<=::).*$/)&.underscore.to_s
+      key = namespace.empty? ? name : "#{namespace}_#{name}"
+      default_value = per_env_default_value_fallback(default)
+      dummy_value = "some_super_dummy_#{key}"
+
+      result = env_value(key)
+      result = preset if result.nil?
+      result = default_value.call(dummy_value) if result.nil?
+      if result.nil?
+        raise Error::RequiredVarMissing,
+              "Required ENV variable or credential missing: #{self.class.name}.#{name}"
+      end
+
+      result
+    end
+
+    # @param default [Proc/String]
+    # @return [Proc]
+    def per_env_default_value_fallback(default)
+      if rails_env.test?
+        ->(dummy) { dummy }
+      else
+        default.is_a?(Proc) ? default : ->(_) { default }
+      end
+    end
+
+    # Recalculates the `env` hash.
+    # @return [void]
+    def recalculate_env
+      remove_instance_variable(:@env) if instance_variable_defined?(:@env)
+      send(:env)
+    end
+
+    # TODO: Implement this. Currently it's not re-reading secrets after enviromnemt change.
+    # Recalculates the `credentials` hash.
+    # @return [void]
+    def recalculate_credentials
+      remove_instance_variable(:@credentials) if instance_variable_defined?(:@credentials)
+      send(:credentials)
+    end
+
+    # Recalculates the values of all the attributes.
+    # @return [void]
+    def recalculate_values
+      self.class.config_attributes.each do |a|
+        remove_instance_variable(:"@#{a}") if instance_variable_defined?(:"@#{a}")
+        send(a)
+      end
+    end
+
+    # Joint hash of `ENV` and `Rails.application.credentials`
+    # @return [HashWithIndifferentAccess]
+    def secrets
+      { **env }.deep_transform_keys!(&:downcase).with_indifferent_access
+    end
+  end
+end

data/sig/app_configurable.rbs

@@ -0,0 +1,4 @@
+module AppConfigurable
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: app_configurable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dmytro Pasichnyk
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.23.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.23.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.27.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.27.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.30.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.30.0
+description: AppConfigurable allows you to configure your application with a simple
+  DSL including environment-specific configuration, define fallbacks etc.
+email:
+- dmytro.pasichnyk@omr.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".byebug_history"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop/custom.yml"
+- ".rubocop/rails.yml"
+- ".rubocop/rspec.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/app_configurable.rb
+- lib/app_configurable/error.rb
+- lib/app_configurable/version.rb
+- sig/app_configurable.rbs
+homepage: https://github.com/ramp106/app_configurable.git
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ramp106/app_configurable.git
+  source_code_uri: https://github.com/ramp106/app_configurable.git
+  changelog_uri: https://github.com/ramp106/app_configurable/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.27
+signing_key: 
+specification_version: 4
+summary: AppConfigurable allows you to configure your application with a simple DSL
+  including environment-specific configuration, define fallbacks etc.
+test_files: []