config_default 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd56026f65a3563933736e9159c7e051b4fd4899300afe65c4430dbd451bdcc9
+  data.tar.gz: 38255f6582b3bd549af219f9c4ce45ac56085223b26fdee55f38c9743af6446e
+SHA512:
+  metadata.gz: 71bf47a44b41498644f8bf6209204d265975127e7732bdeb2be05cc3da92a1d44679651348abb190af19cd27638f50367a6bdd535377d94d4de6ed4e583699ff
+  data.tar.gz: 991e86e3c91f03abdab3e02e0a747a808fb05625c6fead718b4b3187941601696dba5d5c03e272939afc382e1e3d8c9ccaede17b703133af6c665a20de4d803b

data/.github/workflows/main.yml

@@ -0,0 +1,36 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - master
+
+  pull_request:
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3
+        bundler-cache: true
+    - name: Run rubocop
+      run: bundle exec rubocop
+
+  rspec:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby: [2.5, 2.6, 2.7, 3.0]
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run rspec
+      run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+config_default-*.gem

data/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_gem:
+  rubocop-config-umbrellio: lib/rubocop.yml
+
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.5

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+- Test version for publish and test workflow.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in config_default.gemspec
+gemspec
+
+gem "pry"
+gem "rails"
+gem "rake"
+gem "rspec"
+gem "rubocop-config-umbrellio"

data/Gemfile.lock

@@ -0,0 +1,209 @@
+PATH
+  remote: .
+  specs:
+    config_default (0.1.0)
+      rails (~> 6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      mail (>= 2.7.1)
+    actionmailer (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      actionview (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.4.1)
+      actionview (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.4.1)
+      activesupport (= 6.1.4.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.4.1)
+      activesupport (= 6.1.4.1)
+      globalid (>= 0.3.6)
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activerecord (6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activestorage (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      marcel (~> 1.0.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.10.0)
+    globalid (0.5.2)
+      activesupport (>= 5.0)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    loofah (2.12.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    minitest (5.14.4)
+    nio4r (2.5.8)
+    nokogiri (1.12.5-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.12.5-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.6.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.4.1)
+      actioncable (= 6.1.4.1)
+      actionmailbox (= 6.1.4.1)
+      actionmailer (= 6.1.4.1)
+      actionpack (= 6.1.4.1)
+      actiontext (= 6.1.4.1)
+      actionview (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      bundler (>= 1.15.0)
+      railties (= 6.1.4.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      method_source
+      rake (>= 0.13)
+      thor (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.13.0)
+      parser (>= 3.0.1.1)
+    rubocop-config-umbrellio (1.17.0.53)
+      rubocop (= 1.17.0)
+      rubocop-performance (= 1.10.0)
+      rubocop-rails (= 2.9.1)
+      rubocop-rake (= 0.5.1)
+      rubocop-rspec (= 2.2.0)
+      rubocop-sequel (= 0.2.0)
+    rubocop-performance (1.10.0)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.9.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 0.90.0, < 2.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.2.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    rubocop-sequel (0.2.0)
+      rubocop (~> 1.0)
+    ruby-progressbar (1.11.0)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.4.0)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.5.1)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  config_default!
+  pry
+  rails
+  rake
+  rspec
+  rubocop-config-umbrellio
+
+BUNDLED WITH
+   2.2.28

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 ash
+
+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,165 @@
+# ConfigDefault
+
+ConfigDefault is a simple way to separate your test/development config from your staging/production config.
+Designed to work with [Rails](https://github.com/rails/rails). It depends on `ActiveSupport`.
+Maybe in future I'll remove Rails dependency (cause it's never cool) and leave only ActiveSupport.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'config_default'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install config_default
+
+## Configuration
+
+You can control your configuration path and postfix which ConfigDefault will use.
+Please use it in your `application.rb` file.
+This example implement default values:
+
+```ruby
+ConfigDefault.configure do |config|
+  config.config_path = "./config"
+  config.postfix = "default"
+end
+```
+
+## Usage
+
+### Default behaviour
+
+First you need to separate you configuration to default and not.
+Let's check an example for Rails default config file `config/database.yml`:
+
+```yaml
+# config/database.default.yml
+default: &default
+  adapter: postgres
+  max_connections: 5
+  host: postgres
+  database: db
+
+development:
+  <<: *default
+  database: db_development
+
+test:
+  <<: *default
+  database: db_test
+
+staging: *default
+
+production: *default
+
+public_production: *default
+```
+
+So this config file is enough for development/test environment.
+But in staging/production you need to add other SECRET variables to this config.
+Now you can do in your secret repository this:
+
+```yaml
+# config/database.yml
+production:
+  user: db_superuser
+  password: db_password
+```
+
+All you need after creating this file in your secret location is to place this file near with
+previous one. ConfigDefault will merge them automatically on startup.
+
+### Your application configuration
+
+Also `ConfigDefault` can help you with your application config and secrets.
+Just create `config/app.default.yml` (test/staging) and `config/app.yml` (staging/production) files.
+And then in your application load it:
+
+```ruby
+config = ConfigDefault.load(:app)
+```
+
+It will load result hash with merging `app.yml` and `app.default.yml` files.
+By default `ConfigDefault` load YAML files as is.
+So it's mean that what key (string or symbol) you will define in the YAML file => it'll be the same on `#load` result.
+
+You can change this behaviour with `#load` options:
+```ruby
+config = ConfigDefault.load(:app, symbolize_keys: true) # Hash with symbolized first keys
+config = ConfigDefault.load(:app, deep_symbolize_keys: true) # Hash with symbolized all keys
+```
+
+By default `ConfigDefault` using `Rails.env` to determnine what key you need from you config file.
+You can pass this key by your own:
+```ruby
+config = ConfigDefault.load(:app, key: nil) # Will not use key at all and result by full file
+config = ConfigDefault.load(:app, key: "preprod") # Will search preprod key in file
+```
+
+### Struct using
+
+If you want to use configuration as an struct object you can use `#load_struct` method.
+Let's see an example with `database.yaml` config above:
+
+```ruby
+config = ConfigDefault.load_struct(:database)
+config.host
+# => "postgres"
+config.lolkek
+# => StandardError: There is no option :lolkek in configuration.
+```
+
+If your want to not raise an error on wrong key using (sometimes it's helpful) please use `allow_nil` option:
+
+```ruby
+config = ConfigDefault.load_struct(:database, allow_nil: true)
+config.host
+# => "postgres"
+config.lolkek
+# => nil
+```
+
+If your need nested object using use `recursive` option on configuration load:
+
+```yaml
+# config/app.default.yml
+first:
+  second:
+    third: "option"
+```
+
+```ruby
+config = ConfigDefault.load_struct(:app, key: nil, recursive: true)
+config.first.second.third
+# => "option"
+```
+
+At any setting you can use `#to_hash` method to get a `Hash` for this configuration branch.
+It will be `ActiveSupport::HashWithIndifferentAccess`.
+Example with `app.default.yml` from above:
+
+```ruby
+config = ConfigDefault.load_struct(:app, key: nil, recursive: true)
+config.to_hash
+# => { "first" => { "second" => { "third" => "option" } } }
+config.first.to_hash
+# => { "second" => { "third" => "option" } }
+config.first.second.to_hash
+# => { "third" => "option" }
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/skirushkin/config_default.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rails"
+require "config_default"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/database.default.yml

@@ -0,0 +1,2 @@
+development:
+  host: localhost

data/config/database.yml

@@ -0,0 +1,2 @@
+development:
+  database: example

data/config/example1.default.yml

@@ -0,0 +1,3 @@
+development:
+  first: one
+  second: two

data/config/example1.yml

@@ -0,0 +1,2 @@
+development:
+  second: example

data/config/example2.default.yml

@@ -0,0 +1,2 @@
+development:
+  first: one

data/config/example3.yml

@@ -0,0 +1,2 @@
+development:
+  second: two

data/config/nested.yml

@@ -0,0 +1,4 @@
+development:
+  first:
+    second:
+      third: "three"

data/lib/config_default/config.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+ConfigDefault::Config = Struct.new(:config_path, :postfix) do
+  def initialize
+    self.config_path = "./config"
+    self.postfix = "default"
+  end
+end

data/lib/config_default/rails/application/configuration_extension.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Rails::Application::ConfigurationExtension
+  def load_database_yaml
+    ConfigDefault.load(:database, key: nil)
+  end
+
+  def database_configuration
+    load_database_yaml
+  end
+end
+
+Rails::Application::Configuration.prepend(Rails::Application::ConfigurationExtension)

data/lib/config_default/rails/application_extension.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Rails::ApplicationExtension
+  def config_for(name, env: Rails.env)
+    data = ConfigDefault.load(name, key: env, deep_symbolize_keys: true)
+    ActiveSupport::OrderedOptions.new.merge(data)
+  end
+end
+
+Rails::Application.prepend(Rails::ApplicationExtension)

data/lib/config_default/struct.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+class ConfigDefault::Struct
+  def initialize(attributes = {}, recursive: false, allow_nil: false)
+    @attributes = ActiveSupport::HashWithIndifferentAccess.new(attributes)
+    @allow_nil = allow_nil
+    @recursive = recursive
+
+    if @recursive
+      @attributes.each do |key, value|
+        next unless value.is_a?(Hash)
+        @attributes[key] = self.class.new(value, recursive: @recursive, allow_nil: @allow_nil)
+      end
+    end
+
+    @attributes.freeze
+  end
+
+  def [](key)
+    @attributes[key]
+  end
+
+  def method_missing(method, *_args)
+    return @attributes[method] if @attributes.key?(method)
+    raise StandardError.new("There is no option :#{method} in configuration.") unless @allow_nil
+  end
+
+  def respond_to_missing?(*_args)
+    true
+  end
+
+  def to_hash
+    dup = @attributes.dup
+
+    if @recursive
+      dup.each do |key, value|
+        next unless value.is_a?(self.class)
+        dup[key] = value.to_hash
+      end
+    end
+
+    dup
+  end
+end

data/lib/config_default/version.rb

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

data/lib/config_default.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/hash"
+
+require "config_default/version"
+require "config_default/config"
+require "config_default/struct"
+
+require "config_default/rails/application/configuration_extension"
+require "config_default/rails/application_extension"
+
+module ConfigDefault
+  extend self
+
+  attr_accessor :config
+
+  @config = ConfigDefault::Config.new
+
+  def configure
+    yield(config) if block_given?
+  end
+
+  def load(name, key: Rails.env, symbolize_keys: false, deep_symbolize_keys: false)
+    base_config = load_file("#{name}.#{config.postfix}")
+    config = load_file(name)
+
+    data = base_config.deep_merge(config)
+    data = key ? data[key] : data
+
+    if deep_symbolize_keys
+      data.deep_symbolize_keys
+    elsif symbolize_keys
+      data.symbolize_keys
+    else
+      data
+    end
+  end
+
+  def load_file(name)
+    file_name = File.join(config.config_path, "#{name}.yml")
+    ActiveSupport::ConfigurationFile.parse(file_name)
+  rescue
+    {}
+  end
+
+  def load_struct(name, key: Rails.env, recursive: false, allow_nil: false)
+    attributes = load(name, key: key)
+    ConfigDefault::Struct.new(attributes, recursive: recursive, allow_nil: allow_nil)
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: config_default
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stepan Kirushkin
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+description: |2
+      ConfigDefault add an ability to separate your configuration on *.default.yml and *.yml files.
+      It's very useful to mix in configuration when you deploy your application.
+email:
+- stepan.kirushkin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/database.default.yml
+- config/database.yml
+- config/example1.default.yml
+- config/example1.yml
+- config/example2.default.yml
+- config/example3.yml
+- config/nested.yml
+- lib/config_default.rb
+- lib/config_default/config.rb
+- lib/config_default/rails/application/configuration_extension.rb
+- lib/config_default/rails/application_extension.rb
+- lib/config_default/struct.rb
+- lib/config_default/version.rb
+homepage: https://github.com/skirushkin/config_default
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/skirushkin/config_default
+  source_code_uri: https://github.com/skirushkin/config_default
+  changelog_uri: https://github.com/skirushkin/config_default/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: A simple way to manage default and env configuration in Rails.
+test_files: []