choices_settings 0.5.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3a6de46fadb0ee79f77c7b253f581c4edc118a33168081f639106c952dacda05
+  data.tar.gz: c89291d37abc73bfcda15fdf2636900701cd0a226861a95a77f76a43f5e427b6
+SHA512:
+  metadata.gz: 7dad7ea354ba9f0891422a281c2496df38ace7056229b12f11839660fef6dbd6fdf2d47086c70fc01fb816c8990e6809a7583b3e3e44e7c128c94e9ef86c4e23
+  data.tar.gz: 88f79228e9803902606b98b855a84811cef9536ee17151f9e30da70a22b54377025c0eaa40dd52884738ba7f54c69e6866af6942068bf43f40c8d30aeefa6d20

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2013 Mislav Marohnić
+
+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,67 @@
+ChoicesSettings for Rails _(Previously [Choices](https://github.com/mislav/choices))_
+=================
+
+_Forked from [mislav/choices](https://github.com/mislav/choices)_
+
+Easy-peasy external settings for your Rails app.
+
+~~~ rb
+# Gemfile
+gem 'choices_settings'
+~~~
+
+In your app initializer block:
+
+~~~ rb
+config.from_file 'settings.yml'
+~~~
+
+This will read configuration from "config/settings.yml" and, additionally,
+"settings.local.yml" if it exists. You should check the main file into version
+control, but not the ".local" file which is to be used for per-machine
+configuration: tweaks in development or private keys in production, for example.
+
+~~~
+# .gitignore
+config/settings.local.yml
+~~~
+
+Configuration files can contain ERB; this is useful for reading in dynamic
+config such as from environment variables:
+
+~~~ yaml
+# settings.yml
+defaults: &defaults
+  secret_token: <%= ENV['COOKIE_SECRET'] %>
+  heroku: <%= !!ENV['HEROKU_TYPE'] %>
+  mongodb:
+    uri: <%= ENV['MONGOHQ_URL'] %>
+
+development:
+  <<: *defaults
+
+test: &testing
+  <<: *defaults
+  secret_token: <%= "banana" * 5 %>
+  mongodb:
+    database: myapp_test
+
+cucumber:
+  <<: *testing
+~~~
+
+The ".local" file can contain overrides for your development environment:
+
+~~~ yaml
+# settings.local.yml
+development:
+  mongodb:
+    database: myapp_dev
+~~~
+
+Finally, the config keys can be read in your app as such:
+
+~~~ rb
+Rails.configuration.heroku              #=> false
+Rails.configuration.mongodb.database    #=> "myapp_dev"
+~~~

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+require 'rake/testtask'
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new do |t|
+end
+
+desc 'Run test suite'
+task :default => :test

data/lib/choices_settings/rails.rb

@@ -0,0 +1,67 @@
+require 'hashie/mash'
+require 'choices_settings'
+
+module ChoicesSettings::Rails
+  def self.included(base)
+    base.class_eval do
+      def initialize_with_choices(*args, &block)
+        initialize_without_choices(*args, &block)
+        @choices_settings = Hashie::Mash.new
+      end
+
+      alias_method :initialize_without_choices, :initialize
+      alias_method :initialize, :initialize_with_choices
+    end
+  end
+
+  def from_file(name)
+    root = respond_to?(:root) ? self.root : Rails.root
+    file = "#{root}/config/#{name}"
+
+    settings = ChoicesSettings.load_settings(file, Rails.respond_to?(:env) ? Rails.env : RAILS_ENV)
+    @choices_settings.update settings
+
+    settings.each do |key, value|
+      old_value = respond_to?(key) ? send(key) : nil
+
+      if 'Rails::OrderedOptions' == old_value.class.name
+        # convert from Array to a real Hash
+        old_value = old_value.each_with_object({}) do |(k, v), h|
+          h[k] = v
+        end
+      end
+
+      if value.is_a?(Hash) and old_value.is_a?(Hash)
+        # don't overwrite existing Hash values; deep update them
+        value = Hashie::Mash.new(old_value).update value
+      end
+
+      send("#{key}=", value)
+    end
+  end
+end
+
+if defined? Rails::Engine::Configuration
+  Rails::Engine::Configuration.include ChoicesSettings::Rails
+elsif defined? Rails::Configuration
+  Rails::Configuration.class_eval do
+    include ChoicesSettings::Rails
+    include(Module.new do
+      def respond_to?(method)
+        super or method.to_s =~ /=$/ or (method.to_s =~ /\?$/ and @choices_settings.key?(Regexp.last_match.pre_match))
+      end
+
+      private
+
+      def method_missing(method, *args, &block)
+        if method.to_s =~ /=$/ or (method.to_s =~ /\?$/ and @choices_settings.key?(Regexp.last_match.pre_match))
+          @choices_settings.send(method, *args)
+        elsif @choices_settings.key?(method)
+          @choices_settings[method]
+        else
+          super
+        end
+      end
+    end)
+  end
+end

data/lib/choices_settings.rb

@@ -0,0 +1,47 @@
+require 'hashie/mash'
+require 'erb'
+require 'yaml'
+
+module ChoicesSettings
+  extend self
+
+  def load_settings(filename, env)
+    mash = Hashie::Mash.new(load_settings_hash(filename))
+
+    with_local_settings(filename, '.local') do |local|
+      mash.update local
+    end
+
+    mash.fetch(env) do
+      raise IndexError, %(Missing key for "#{env}" in `#{filename}')
+    end
+  end
+
+  def load_settings_hash(filename)
+    yaml_content = ERB.new(IO.read(filename)).result
+    yaml_load(yaml_content)
+  end
+
+  def with_local_settings(filename, suffix)
+    local_filename = filename.sub(/(\.\w+)?$/, "#{suffix}\\1")
+    return unless File.exist? local_filename
+
+    hash = load_settings_hash(local_filename)
+    yield hash if hash
+  end
+
+  def yaml_load(content)
+    if defined?(YAML::ENGINE) && defined?(Syck)
+      # avoid using broken Psych in 1.9.2
+      old_yamler = YAML::ENGINE.yamler
+      YAML::ENGINE.yamler = 'syck'
+    end
+    begin
+      YAML.load(content, aliases: true)
+    ensure
+      YAML::ENGINE.yamler = old_yamler if defined?(YAML::ENGINE) && defined?(Syck)
+    end
+  end
+end
+
+require 'choices_settings/rails' if defined? Rails

data/test/settings/with_local.local.yml

@@ -0,0 +1,5 @@
+development:
+  name: 'Development'
+
+production:
+  name: 'Production local'

data/test/settings/with_local.yml

@@ -0,0 +1,6 @@
+defaults: &defaults
+  name: 'Defaults'
+
+production:
+  <<: *defaults
+

data/test/settings/without_local.yml

@@ -0,0 +1,13 @@
+defaults: &defaults
+  name: 'Defaults'
+
+development:
+  name: 'Development'
+
+production:
+  <<: *defaults
+  name: 'Production'
+
+test:
+  name: 'Test'
+

data/test/test_load_settings.rb

@@ -0,0 +1,32 @@
+gem 'minitest'
+require 'minitest/autorun'
+require 'choices_settings'
+require 'pathname'
+
+describe ChoicesSettings do
+  before do
+    path = Pathname.new(__FILE__)
+    @without_local = path + '../settings/without_local.yml'
+    @with_local = path + '../settings/with_local.yml'
+  end
+
+  describe 'when loading a settings file' do
+    it 'should return a mash for the specified environment' do
+      ChoicesSettings.load_settings(@without_local, 'defaults').name.must_equal 'Defaults'
+      ChoicesSettings.load_settings(@without_local, 'production').name.must_equal 'Production'
+    end
+
+    it 'should load the local settings' do
+      ChoicesSettings.load_settings(@with_local, 'defaults').name.must_equal 'Defaults'
+      ChoicesSettings.load_settings(@with_local, 'development').name.must_equal 'Development'
+      ChoicesSettings.load_settings(@with_local, 'production').name.must_equal 'Production local'
+    end
+
+    it 'should raise an exception if the environment does not exist' do
+      error = lambda {
+        ChoicesSettings.load_settings(@with_local, 'nonexistent')
+      }.must_raise(IndexError)
+      error.message.must_equal %(Missing key for "nonexistent" in `#{@with_local}')
+    end
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: choices_settings
+version: !ruby/object:Gem::Version
+  version: 0.5.2
+platform: ruby
+authors:
+- Mislav Marohnić
+- MonClubSportif
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.6
+description: Forked from mislav/choices (https://github.com/mislav/choices)
+email: info@monclubsportif.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/choices_settings.rb
+- lib/choices_settings/rails.rb
+- test/settings/with_local.local.yml
+- test/settings/with_local.yml
+- test/settings/without_local.yml
+- test/test_load_settings.rb
+homepage: https://github.com/monclubsportif/choices_settings
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key:
+specification_version: 4
+summary: Easy settings for your app
+test_files:
+- test/test_load_settings.rb