config_default 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd56026f65a3563933736e9159c7e051b4fd4899300afe65c4430dbd451bdcc9
-  data.tar.gz: 38255f6582b3bd549af219f9c4ce45ac56085223b26fdee55f38c9743af6446e
+  metadata.gz: b0e496b125200f0a672fbbc01b51ce0f2634f83d742384980a5e77300401de55
+  data.tar.gz: 367ebd46e430509331e964e31a463f237f29f9b73a81967a978a9875d41760bf
 SHA512:
-  metadata.gz: 71bf47a44b41498644f8bf6209204d265975127e7732bdeb2be05cc3da92a1d44679651348abb190af19cd27638f50367a6bdd535377d94d4de6ed4e583699ff
-  data.tar.gz: 991e86e3c91f03abdab3e02e0a747a808fb05625c6fead718b4b3187941601696dba5d5c03e272939afc382e1e3d8c9ccaede17b703133af6c665a20de4d803b
+  metadata.gz: 4463a3895be54cda1a391edf76b78c55a1389fb981b00e6529ce7643ec307fe98ea7acbc778ddb51b4d330046f07c5e345e1ab14a0e409c5c158c5ed0693f919
+  data.tar.gz: ff999b172f7971c4c0f891c8195155b1ac421ae74997e37bb71cb2b06e1e2e5c8d76794d1701b46cc9c8de37999e4a5dab8d85f2c82e13f388ccafde12a0983c

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.1.2
+
+- Move config struct option definition from `#method_missing` to `#define_singleton_method`
+
+## 0.1.1
+
+- Remove Rails dependency.
+
 ## 0.1.0
 
-- Test version for publish and test workflow.
+- Default behaviour.
+- Option `recursive` to `#load_struct`.
+- Option `allow_nil` to `#load_struct`.
+- Specs.
+- Documentation and examples.

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    config_default (0.1.0)
-      rails (~> 6)
+    config_default (0.2.1)
+      activesupport (~> 6)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -9,7 +9,7 @@ Maybe in future I'll remove Rails dependency (cause it's never cool) and leave o
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'config_default'
+gem "config_default"
 ```
 
 And then execute:
@@ -33,6 +33,14 @@ ConfigDefault.configure do |config|
 end
 ```
 
+If you want to implement Rails monkey patches for `Rails.application.config_for` and ability to
+separate `database.yml` file you need to apply `#init_rails_monkey_patch!` method in your
+`application.yml` file before application initialization.
+
+```ruby
+  ConfigDefault.init_rails_monkey_patch!
+```
+
 ## Usage
 
 ### Default behaviour
@@ -104,9 +112,9 @@ config = ConfigDefault.load(:app, key: nil) # Will not use key at all and result
 config = ConfigDefault.load(:app, key: "preprod") # Will search preprod key in file
 ```
 
-### Struct using
+### `#load_struct` method
 
-If you want to use configuration as an struct object you can use `#load_struct` method.
+If you want to use configuration as a struct object you can use `#load_struct` method.
 Let's see an example with `database.yaml` config above:
 
 ```ruby
@@ -156,6 +164,24 @@ config.first.second.to_hash
 # => { "third" => "option" }
 ```
 
+### Using `ConfigDefault::Struct` without configuration load
+
+You can use `ConfigDefault::Struct` to achive ability to create config object from Hash objects.
+Here an example of creation struct object on the fly:
+
+```ruby
+config_on_the_fly = { first: { second: { third: "option" } } }
+config = ConfigDefault::Struct.new(attributes: config_on_the_fly, recursive: true)
+config.first.to_hash
+# => { "second" => { "third" => "option" } }
+config.first.second.third
+# => "option"
+config.first.lolkek
+# => StandardError: There is no option :lolkek in configuration.
+```
+
+`ConfigDefault::Struct` supports `recursive` and `allow_nil` options.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/skirushkin/config_default.

data/lib/config_default/init.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ConfigDefault::Init
+  extend self
+
+  def init_rails_monkey_patch!
+    return unless Object.const_defined?("Rails")
+    return unless Object.const_defined?("Rails::Application")
+    return unless Object.const_defined?("Rails::Application::Configuration")
+
+    Rails::Application.prepend(ConfigDefault::RailsApplicationExtension)
+    Rails::Application::Configuration.prepend(ConfigDefault::RailsApplicationConfigurationExtension)
+  end
+end

data/lib/config_default/{rails/application/configuration_extension.rb → rails_application_configuration_extension.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Rails::Application::ConfigurationExtension
+module ConfigDefault::RailsApplicationConfigurationExtension
   def load_database_yaml
     ConfigDefault.load(:database, key: nil)
   end
@@ -9,5 +9,3 @@ module Rails::Application::ConfigurationExtension
     load_database_yaml
   end
 end
-
-Rails::Application::Configuration.prepend(Rails::Application::ConfigurationExtension)

data/lib/config_default/{rails/application_extension.rb → rails_application_extension.rb}

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-module Rails::ApplicationExtension
+module ConfigDefault::RailsApplicationExtension
   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

@@ -1,17 +1,15 @@
 # frozen_string_literal: true
 
 class ConfigDefault::Struct
-  def initialize(attributes = {}, recursive: false, allow_nil: false)
+  RESERVED_METHODS = %i[method_missing respond_to_missing? to_hash].freeze
+
+  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
+    make_recursive!
+    define_methods!
 
     @attributes.freeze
   end
@@ -21,8 +19,8 @@ class ConfigDefault::Struct
   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
+    return if @allow_nil
+    raise StandardError.new("There is no option :#{method} in configuration.")
   end
 
   def respond_to_missing?(*_args)
@@ -41,4 +39,26 @@ class ConfigDefault::Struct
 
     dup
   end
+
+  private
+
+  def make_recursive!
+    return unless @recursive
+
+    @attributes.each do |key, value|
+      next unless value.is_a?(Hash)
+      @attributes[key] = self.class.new(
+        attributes: value,
+        recursive: @recursive,
+        allow_nil: @allow_nil,
+      )
+    end
+  end
+
+  def define_methods!
+    @attributes.each do |key, value|
+      next if RESERVED_METHODS.include?(key.to_sym)
+      define_singleton_method(key) { value }
+    end
+  end
 end

data/lib/config_default/version.rb

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

data/lib/config_default.rb

@@ -4,10 +4,10 @@ require "active_support/core_ext/hash"
 
 require "config_default/version"
 require "config_default/config"
+require "config_default/init"
 require "config_default/struct"
-
-require "config_default/rails/application/configuration_extension"
-require "config_default/rails/application_extension"
+require "config_default/rails_application_extension"
+require "config_default/rails_application_configuration_extension"
 
 module ConfigDefault
   extend self
@@ -20,11 +20,15 @@ module ConfigDefault
     yield(config) if block_given?
   end
 
+  def init_rails_monkey_patch!
+    ConfigDefault::Init.init_rails_monkey_patch!
+  end
+
   def load(name, key: Rails.env, symbolize_keys: false, deep_symbolize_keys: false)
-    base_config = load_file("#{name}.#{config.postfix}")
+    default_config = load_file("#{name}.#{config.postfix}")
     config = load_file(name)
 
-    data = base_config.deep_merge(config)
+    data = default_config.deep_merge(config)
     data = key ? data[key] : data
 
     if deep_symbolize_keys
@@ -44,7 +48,10 @@ module ConfigDefault
   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)
+    ConfigDefault::Struct.new(
+      attributes: load(name, key: key),
+      recursive: recursive,
+      allow_nil: allow_nil,
+    )
   end
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: config_default
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Stepan Kirushkin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-19 00:00:00.000000000 Z
+date: 2021-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -44,17 +44,11 @@ files:
 - 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/init.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

data/config/database.default.yml

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

data/config/database.yml

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

data/config/example1.default.yml

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

data/config/example1.yml

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

data/config/example2.default.yml

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

data/config/example3.yml

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

data/config/nested.yml

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