api-config 0.4.8 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f3bf49d401da5c550c46834568a952118971358ce165aa6daedee6057e1b798
-  data.tar.gz: 28b1627e6eb78ed84a3365bc7257d9bfc8a927095f18d903f8199ffd6150f8a3
+  metadata.gz: 45c4501fac89421b7cbb3052abe9a93c4886d2dbccf8fd1021750ed2eaecb2b9
+  data.tar.gz: 8422c09fef720146c518e24ae7194a6698f7ea9bc2c5f4c583c61e549ebf4c84
 SHA512:
-  metadata.gz: 0d8d3dcde843794eb06b3de8de30151fc30cbf449f01e2dbb59d6f2e20f16f214d4f46e04f205743bb7a9e515fb78e3c2da835ecf392080eb1c360f0cc3b9b04
-  data.tar.gz: 14f770d1248c73bfc18577a1745a0b69588d1f3a7a7a996520b1b30f1bd90342cd148874ccb6c8c9979deb5f6cf5e4a09e8f7764f97adc416e241ea54077c931
+  metadata.gz: e3c89ab970f1e276522d2177f72b26cc380e56fc284d7ef6448143ca8355fc36ca8e66db74bc5792dded91186c59136961e756dffb1f0812d3a3b06b50fc80d9
+  data.tar.gz: c1333cad42d553fa9e9bad25524b5db5624751d1161f6259854cbac2fdbf3e812526f64fb243bfb7ba2a1878a8580b217eb635751a9c13e821d69086099fab2c

data/README.md

@@ -1,5 +1,6 @@
 
 [![Build Status](https://github.com/ifad/api-config/actions/workflows/ruby.yml/badge.svg)](https://github.com/ifad/api-config/actions)
+[![RuboCop](https://github.com/ifad/api-config/actions/workflows/rubocop.yml/badge.svg)](https://github.com/ifad/api-config/actions/workflows/rubocop.yml)
 
 # Api::Config
 
@@ -24,19 +25,8 @@ Or install it yourself as:
 ## Usage
 
 ```Ruby
-APIConfig.foo
-APIConfig.bar.goo
-```
-
-## Ruby 3.0.x
-
-An issue with the `ostruct` version shipped with Ruby 3.0.x does not allow
-`Api::Config` to work properly.
-
-If you are using Ruby 3.0.x, please add to your Gemfile
-
-```rb
-gem 'ostruct', '> 0.3.1'
+ApiConfig.foo
+ApiConfig.bar.goo
 ```
 
 ## Contributing

data/lib/api-config/version.rb

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

data/lib/api-config.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
+
 require 'erb'
 require 'ostruct'
 require 'yaml'
 
-module APIConfig
-
-  VERSION = '0.4.8'
+require_relative 'api-config/version'
 
+module APIConfig
   class << self
     def env
       environment || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
@@ -47,38 +48,33 @@ module APIConfig
     end
 
     protected
-      def environment
-        @@env ||= nil
-      end
 
-      def configuration
-        @_configuration ||= {}
-      end
+    def environment
+      @@env ||= nil
+    end
 
-      def files
-        @_files ||= { default: 'config/api.yml' }
-      end
+    def configuration
+      @configuration ||= {}
+    end
 
-      def configuration_for(which)
-        configuration.fetch(which) do
-          source = files.fetch(which)
-          configuration[which] = parse(source)
-        end
-      end
+    def files
+      @files ||= { default: 'config/api.yml' }
+    end
 
-      def parse(source)
-        erb_result = ERB.new(File.read(source)).result
-        config =
-          if YAML::VERSION >= '4.0'
-            YAML.safe_load(erb_result, aliases: true).fetch(APIConfig.env)
-          else
-            YAML.load(erb_result).fetch(APIConfig.env)
-          end
-        DeepStruct.new(config, source)
-
-      rescue => e
-        raise Error, "#{source}: #{e.message}"
+    def configuration_for(which)
+      configuration.fetch(which) do
+        source = files.fetch(which)
+        configuration[which] = parse(source)
       end
+    end
+
+    def parse(source)
+      erb_result = ERB.new(File.read(source)).result
+      config = YAML.safe_load(erb_result, aliases: true).fetch(APIConfig.env)
+      DeepStruct.new(config, source)
+    rescue StandardError => e
+      raise Error, "#{source}: #{e.message}"
+    end
   end
 
   class Error < StandardError
@@ -92,18 +88,18 @@ module APIConfig
       @parent     = parent
       @branch     = branch
 
-      (hash || []).each do |k,v|
+      (hash || []).each do |k, v|
         @table[k.to_sym]      = (v.is_a?(Hash) ? self.class.new(v, file, self, k) : v)
         @hash_table[k.to_sym] = v
       end
     end
 
-    def each(&block)
-      @table.each(&block)
+    def each(&)
+      @table.each(&)
     end
 
-    def map(&block)
-      @table.map(&block)
+    def map(&)
+      @table.map(&)
     end
 
     def to_h
@@ -114,15 +110,14 @@ module APIConfig
       [(@parent ? @parent.path_for(@branch) : APIConfig.env), key].compact.join('.')
     end
 
-    def method_missing(meth, *args, &block)
+    def method_missing(meth, *args, &)
       if meth.to_s =~ /\A(.+)!\Z/
-        setting = $1.intern
+        setting = ::Regexp.last_match(1).intern
 
         @table.fetch(setting) { raise Error, "API Setting `#{path_for(setting)}' not found in #{@file}" }
       else
         super
       end
     end
-
   end
 end

data/lib/api_config.rb

@@ -1 +1,3 @@
-require 'api-config'
+# frozen_string_literal: true
+
+require_relative 'api-config'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api-config
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 0.5.0
 platform: ruby
 authors:
 - Lleir Borras Metje
@@ -11,7 +11,7 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: ostruct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -24,34 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  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: rspec
-  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'
 description: A nice way to configure api url's and configuratios for a ruby app.
 email:
 - l.borrasmetje@ifad.org
@@ -60,27 +32,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/dependabot.yml"
-- ".github/workflows/ruby.yml"
-- ".gitignore"
-- ".rspec"
-- Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
-- Rakefile
-- api-config.gemspec
-- config/api.yml
 - lib/api-config.rb
+- lib/api-config/version.rb
 - lib/api_config.rb
-- spec/api_config_spec.rb
-- spec/config/api.yml
-- spec/config/foo.yml
-- spec/deep_strucure_spec.rb
-- spec/spec_helper.rb
-homepage: http://code.ifad.org/api-config
+homepage: https://github.com/ifad/api-config
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -88,19 +49,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.3
 specification_version: 4
 summary: A nice way to configure api url's and configuratios for a ruby app.
-test_files:
-- spec/api_config_spec.rb
-- spec/config/api.yml
-- spec/config/foo.yml
-- spec/deep_strucure_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.github/dependabot.yml

@@ -1,6 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: github-actions
-    directory: /
-    schedule:
-      interval: weekly

data/.github/workflows/ruby.yml

@@ -1,41 +0,0 @@
-name: Ruby specs
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-permissions:
-  contents: read
-
-jobs:
-  test:
-    name: Specs
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        ruby-version: ['2.0', '2.1', '2.2', '2.3', '2.4', '2.5', '2.6', '2.7', '3.0', '3.1', '3.2', '3.3', '3.4']
-        channel: ['stable']
-        os: ['ubuntu-latest']
-
-        include:
-          - ruby-version: 'head'
-            channel: 'experimental'
-            os: 'ubuntu-latest'
-
-          - ruby-version: '1.9.3'
-            channel: 'stable'
-            os: 'ubuntu-22.04'
-
-    continue-on-error: ${{ matrix.channel != 'stable' }}
-
-    steps:
-    - uses: actions/checkout@v6
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true
-    - name: Run specs
-      run: bundle exec rake

data/.gitignore

@@ -1,14 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/Gemfile

@@ -1,9 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in api-config.gemspec
-gemspec
-
-# TODO: Workaround for ifad/api-config#4
-if RUBY_VERSION >= '3.0.0'
-  gem 'ostruct', '!= 0.3.1'
-end

data/Rakefile

@@ -1,15 +0,0 @@
-require "bundler"
-Bundler::GemHelper.install_tasks
-
-# RSpec
-require 'rspec/core'
-require 'rspec/core/rake_task'
-
-task :default => :rspec
-RSpec::Core::RakeTask.new(:rspec)
-
-# YARD
-# require 'yard'
-# require 'yard/rake/yardoc_task'
-# YARD::Rake::YardocTask.new
-

data/api-config.gemspec

@@ -1,25 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'api-config'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'api-config'
-  spec.version       = APIConfig::VERSION
-  spec.authors       = ['Lleir Borras Metje', 'Marcello Barnaba']
-  spec.email         = ['l.borrasmetje@ifad.org', 'm.barnaba@ifad.org']
-  spec.summary       = %q{A nice way to configure api url's and configuratios for a ruby app.}
-  spec.description   = %q{A nice way to configure api url's and configuratios for a ruby app.}
-  spec.homepage      = 'http://code.ifad.org/api-config'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
-
-  spec.add_dependency 'bundler'
-  spec.add_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-end

data/config/api.yml

@@ -1,12 +0,0 @@
-development: &development
-  mycalls: 'http://mine.ifad.org/mycalls/'
-  quasar: 'http://mine.ifad.org/quasar/'
-  people_soft: 'http://mine.ifad.org/ps/'
-  people: 'http://people.staging.ifad.org/'
-  ciao:
-    url: 'http://ciao.staging.ifad.org/'
-    token: 'c028418c171d339d644b2097f493044443495e6676bb721110cf2f64f9193af1'
-
-test: *development
-production: *development
-staging: *development

data/spec/api_config_spec.rb

@@ -1,97 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe APIConfig do
-  before do
-    described_class.set_file(:default, 'spec/config/api.yml')
-  end
-
-  describe '.env' do
-    it 'uses RAILS_ENV' do
-      expect(ENV).to receive(:[]).with('RAILS_ENV').and_return('foo')
-
-      expect(described_class.env).to eq('foo')
-
-    end
-
-    it 'uses RACK_ENV' do
-      expect(ENV).to receive(:[]).with('RAILS_ENV').and_return(nil)
-      expect(ENV).to receive(:[]).with('RACK_ENV').and_return('bars')
-
-      expect(described_class.env).to eq('bars')
-    end
-
-    it 'defaults to development' do
-      expect(ENV).to receive(:[]).with('RAILS_ENV').and_return(nil)
-      expect(ENV).to receive(:[]).with('RACK_ENV').and_return(nil)
-
-      expect(described_class.env).to eq('development')
-    end
-  end
-
-  describe '.env=' do
-    before do
-      described_class.env = 'foobarbaz'
-      @old_rails_env = ENV['RAILS_ENV']
-      @old_rack_env = ENV['RACK_ENV']
-    end
-
-    after do
-      described_class.env = nil
-      ENV['RAILS_ENV'] = @old_rails_env
-      ENV['RACK_ENV'] = @old_rack_env
-    end
-
-    it 'uses defined environment value' do
-      expect(described_class.env).to eq('foobarbaz')
-    end
-
-    it 'uses defined environment value even if RAILS_ENV is set' do
-      ENV['RAILS_ENV'] = 'foo'
-
-      expect(described_class.env).to eq('foobarbaz')
-    end
-
-
-    it 'uses defined environment value even if RACK_ENV is set' do
-      ENV['RAILS_ENV'] = nil
-      ENV['RACK_ENV'] = 'bar'
-
-      expect(described_class.env).to eq('foobarbaz')
-    end
-  end
-
-  describe '.method_missing' do
-    it 'works' do
-      expect(described_class.foo).to eq('foo')
-      expect(described_class.bar).to eq('bar')
-    end
-
-    it 'gets the correct root key' do
-      expect(described_class).to receive(:env).and_return('foobarbaz')
-      described_class.reload!
-
-      expect(described_class.foo).to eq('bar')
-      expect(described_class.bar).to eq(APIConfig::DeepStruct.new(baz: 'barbaz'))
-    end
-  end
-
-  describe '.reload!' do
-    it 'works' do
-      foo = described_class.foo
-
-      described_class.set_file :default, 'spec/config/foo.yml'
-
-      expect(foo).not_to eq(described_class.foo)
-    end
-  end
-
-  describe '.set_file' do
-    it 'works' do
-      file = described_class.get_file(:default)
-
-      described_class.set_file :default, 'spec/config/foo.yml'
-
-      expect(file).not_to eq(described_class.get_file(:default))
-    end
-  end
-end

data/spec/config/api.yml

@@ -1,12 +0,0 @@
-test:
-  foo: "<%= "#{102.chr}o" + 'o' %>"
-  bar: bar
-
-development:
-  foo: foo
-  bar: bar
-
-foobarbaz:
-  foo: bar
-  bar:
-    baz: barbaz

data/spec/config/foo.yml

@@ -1,5 +0,0 @@
-test: &test
-  foo: ☺
-  bar: ☹
-
-development: *test

data/spec/deep_strucure_spec.rb

@@ -1,36 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe APIConfig::DeepStruct do
-  let!(:hash) { { a: :a, b: { c: { d: :e }}} }
-
-  subject { APIConfig::DeepStruct.new(hash, 'src') }
-
-  describe '#to_h' do
-    it 'works' do
-      expect(subject.to_h).to eq(hash)
-    end
-  end
-
-  describe '#path_for' do
-    it 'works' do
-      expect(subject.path_for(:a)).to     eq("#{APIConfig.env}.a")
-      expect(subject.b.c.path_for(:d)).to eq("#{APIConfig.env}.b.c.d")
-    end
-  end
-
-  describe '#method_missing' do
-    it 'works' do
-      expect(subject.a).to     eq(:a)
-      expect(subject.b.c.d).to eq(:e)
-      expect(subject.b.c).to   eq(described_class.new(d: :e))
-      expect(subject.c).to     eq(nil)
-    end
-
-    it 'works with !' do
-      expect(subject.a!).to       eq(:a)
-      expect(subject.b!.c!.d!).to eq(:e)
-      expect(subject.b!.c!).to    eq(described_class.new(d: :e))
-      expect{subject.c!}.to       raise_error("API Setting `test.c' not found in src")
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,93 +0,0 @@
-ENV["RACK_ENV"] = 'test'
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# The generated `.rspec` file contains `--require spec_helper` which will cause this
-# file to always be loaded, without a need to explicitly require it in any files.
-#
-# Given that it is always loaded, you are encouraged to keep this file as
-# light-weight as possible. Requiring heavyweight dependencies from this file
-# will add to the boot time of your test suite on EVERY test run, even for an
-# individual file that may not need all of that loaded. Instead, consider making
-# a separate helper file that requires the additional dependencies and performs
-# the additional setup, and require it from the spec files that actually need it.
-#
-# The `.rspec` file also contains a few flags that are not defaults but that
-# users commonly want.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
-require 'bundler/setup'
-Bundler.setup
-
-require 'api-config'
-
-RSpec.configure do |config|
-  config.expose_dsl_globally = true
-
-  # rspec-expectations config goes here. You can use an alternate
-  # assertion/expectation library such as wrong or the stdlib/minitest
-  # assertions if you prefer.
-  config.expect_with :rspec do |expectations|
-    # This option will default to `true` in RSpec 4. It makes the `description`
-    # and `failure_message` of custom matchers include text for helper methods
-    # defined using `chain`, e.g.:
-    # be_bigger_than(2).and_smaller_than(4).description
-    #   # => "be bigger than 2 and smaller than 4"
-    # ...rather than:
-    #   # => "be bigger than 2"
-    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
-  end
-
-  # rspec-mocks config goes here. You can use an alternate test double
-  # library (such as bogus or mocha) by changing the `mock_with` option here.
-  config.mock_with :rspec do |mocks|
-    # Prevents you from mocking or stubbing a method that does not exist on
-    # a real object. This is generally recommended, and will default to
-    # `true` in RSpec 4.
-    mocks.verify_partial_doubles = true
-  end
-
-  # These two settings work together to allow you to limit a spec run
-  # to individual examples or groups you care about by tagging them with
-  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
-  # get run.
-  config.filter_run :focus
-  config.run_all_when_everything_filtered = true
-
-  # Limits the available syntax to the non-monkey patched syntax that is recommended.
-  # For more details, see:
-  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
-  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
-  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
-  config.disable_monkey_patching!
-
-  # This setting enables warnings. It's recommended, but in some cases may
-  # be too noisy due to issues in dependencies.
-  config.warnings = true
-
-  # Many RSpec users commonly either run the entire suite or an individual
-  # file, and it's useful to allow more verbose output when running an
-  # individual spec file.
-  if config.files_to_run.one?
-    # Use the documentation formatter for detailed output,
-    # unless a formatter has already been configured
-    # (e.g. via a command-line flag).
-    config.default_formatter = 'doc'
-  end
-
-  # Print the 10 slowest examples and example groups at the
-  # end of the spec run, to help surface which specs are running
-  # particularly slow.
-  config.profile_examples = 10
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = :random
-
-  # Seed global randomization in this process using the `--seed` CLI option.
-  # Setting this allows you to use `--seed` to deterministically reproduce
-  # test failures related to randomization by passing the same `--seed` value
-  # as the one that triggered the failure.
-  Kernel.srand config.seed
-end