conifer 1.0.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 242c45c7c55f650e17a190ab1451c4c44600d737881d8a2e37c10291c46f9e48
-  data.tar.gz: 160ef67508c13a2e05e3efc9aa4dce2dd07bfd41c16979da8c77dc6b96bac2a4
+  metadata.gz: '09ced739ff40c2e3f5b4bc60431dfd578a4a700aed77be41aeb84ea0e62677c1'
+  data.tar.gz: 0f8950a612acf6f0b3b2ee1a0bf9f9414c68cf541f4fcb89ee0b144721070f53
 SHA512:
-  metadata.gz: 4ddc85687be772047571e4c7f56a60e4b2b44f867828de6abc5e38c308467faba238b51c4a6b2d1f880dbb53d9df8938ec1714b96044026b4843d356b0be61b9
-  data.tar.gz: 2567e3a020b165acdb8479ffe2b54163c69fe231814fa89a39eddb0df08751b2d305eccd663b44df07d0220d4caa22db78a122cb4c49ef2fef53b2beb780b346
+  metadata.gz: a981b2691bffaabc70e2c79d3d58b00c811bafb06ec47f3d7b6560aa057ef883e6231d03555f677c3c17c5995e001194eeab4bb1549be5554d1d8835b0c8a7dc
+  data.tar.gz: 7de081b9c44c12a4cbfb8201c39ea77fc3b0d1477c75a4f1518632d569363eedf59c3f24a105f6c0512bbfe17ef3894cb3204581fd9d93c35d51dbd55cdb6c5f

data/.codeclimate.yml

@@ -0,0 +1,15 @@
+version: '2'
+
+plugins:
+  bundler-audit:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+        - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+    channel: rubocop-0-80

data/.github/workflows/ruby.yml

@@ -7,14 +7,27 @@ jobs:
 
     runs-on: ubuntu-latest
 
+    strategy:
+      matrix:
+        ruby:
+          - '2.6'
+          - '2.7'
+          - '3.0'
+          - '3.1'
+
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Ruby 2.6
-        uses: actions/setup-ruby@v1
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Run tests with RSpec
+        uses: paambaati/codeclimate-action@v2.7.5
+        env:
+          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
         with:
-          ruby-version: 2.6.x
-      - name: Build and test with RSpec
-        run: |
-          gem install bundler -v 1.17.3 --no-document
-          bundle install --jobs 4 --retry 3
-          bundle exec rspec
+          coverageCommand: bundle exec rspec
+          debug: false

data/.rubocop.yml

@@ -1,3 +1,10 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
 Layout/LineLength:
   Max: 120
 

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+3.0.0

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.1.0

data/Gemfile.lock

@@ -1,35 +1,71 @@
 PATH
   remote: .
   specs:
-    conifer (1.0.0)
+    conifer (1.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.3)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    ast (2.4.2)
+    climate_control (1.0.0)
+    diff-lcs (1.4.4)
+    docile (1.3.5)
+    parallel (1.21.0)
+    parser (3.0.3.2)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.2.0)
+    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.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.24.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.15.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.0)
+      parser (>= 3.0.1.1)
+    rubocop-rspec (2.3.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
-  ruby
+  x86_64-darwin-19
+  x86_64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  climate_control
   conifer!
-  rake (~> 10.0)
-  rspec (~> 3.0)
+  rake
+  rspec
+  rubocop
+  rubocop-rspec
+  simplecov
 
 BUNDLED WITH
-   1.17.3
+   2.3.3

data/README.md

@@ -1,8 +1,10 @@
-# Conifer
+![](https://github.com/hasghari/conifer/workflows/Ruby/badge.svg)
+[![Maintainability](https://api.codeclimate.com/v1/badges/f02c1de9e9d7dbfa5800/maintainability)](https://codeclimate.com/github/hasghari/conifer/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/f02c1de9e9d7dbfa5800/test_coverage)](https://codeclimate.com/github/hasghari/conifer/test_coverage)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/conifer`. To experiment with that code, run `bin/console` for an interactive prompt.
+# Conifer
 
-TODO: Delete this and the text above, and describe your gem
+Conifer allows you to easily manage YAML configuration files and import them into your Ruby objects.
 
 ## Installation
 
@@ -22,7 +24,91 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+You can include the `Conifer` module in any class or module and specify the YAML file you want to import by calling the
+`conifer` method:
+
+```ruby
+class Config
+  include Conifer
+
+  conifer :config
+end
+```
+
+By default, this will look for a file called `config.yml` in the same directory where the `Config` class is defined.
+If no such file is found, it will look for that file in the parent directory. It will continue to traverse the ancestry
+tree until it finds that file. If the file is not found, it will raise a `Conifer::File::NotFoundError` error.
+
+With the following `config.yml` file defined in the same directory as the source file for `Config`:
+
+```yaml
+aws:
+  access_key_id: <%= ENV.fetch('AWS_ACCESS_KEY_ID', 'my-access-key-id') %>
+  bucket: atlantis
+```
+
+You may access the values using a method that defaults to the same name as your YAML file:
+
+```ruby
+object = Config.new
+object.config['aws.access_key_id'] #=> my-access-key-id
+object.config['aws.bucket'] #=> atlantis
+```
+
+The `conifer` method accepts several optional keyword arguments:
+
+- `dir`: This option overrides the default location where the YAML file is expected to reside.
+- `method`: This option overrides the default method name that is defined on the class or module. The method name defaults to the name of the YAML file.
+    ```ruby
+    class Config
+      include Conifer
+
+      conifer :config, method: :foobar
+    end
+    ```
+
+    ```ruby
+    Config.new.foobar['aws.bucket'] #=> atlantis
+    ```
+- `prefix`: This is a string that will be prepended to the lookup key. This is especially useful in Rails where you would like to have different values per environment.
+    ```ruby
+    class Config
+      include Conifer
+
+      conifer :config, prefix: Rails.env
+    end
+    ```
+
+    With the following `config.yml` file:
+
+    ```yaml
+    development:
+      aws:
+        bucket: atlantis-development
+
+    production:
+      aws:
+        bucket: atlantis-production
+    ```
+
+    You can lookup the values the same as before:
+
+    ```ruby
+    Rails.env #=> development
+    Config.new.config['aws.bucket'] #=> atlantis-development
+    ```
+- `singleton`: This is `false` by default. When set to `true`, the method will be defined at the class scope instead of the instance scope.
+    ```ruby
+    class Config
+      include Conifer
+
+      conifer :config, singleton: true
+    end
+    ```
+
+    ```ruby
+    Config.config['aws.bucket'] #=> atlantis
+    ```
 
 ## Development
 
@@ -32,7 +118,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/conifer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/hasghari/conifer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/conifer.gemspec

@@ -10,11 +10,13 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Hamed Asghari']
   spec.email         = ['hasghari@gmail.com']
 
-  spec.summary       = 'This is a gem to manage multiple, optionally environment-based YAML configurations'
-  spec.description   = 'This is a gem to manage multiple, optionally environment-based YAML configurations'
+  spec.summary       = 'Conifer allows you to easily manage YAML configuration files and import them into your objects.'
+  spec.description   = 'Conifer allows you to easily manage YAML configuration files and import them into your objects.'
   spec.homepage      = 'https://github.com/hasghari/conifer'
   spec.license       = 'MIT'
 
+  spec.required_ruby_version = '>= 2.6'
+
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
@@ -24,7 +26,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.17'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'climate_control'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'simplecov'
 end

data/lib/conifer/file.rb

@@ -6,13 +6,16 @@ require 'erb'
 module Conifer
   class File
     NotFoundError = Class.new(StandardError)
+    UnsupportedFormatError = Class.new(StandardError)
 
-    attr_reader :name, :prefix, :dir
+    attr_reader :name, :dir, :prefix, :format, :allowed_classes
 
-    def initialize(name, dir:, prefix: nil)
+    def initialize(name, dir:, prefix: nil, format: :yml, allowed_classes: [])
       @name = name
-      @prefix = prefix
       @dir = dir
+      @prefix = prefix
+      @format = format
+      @allowed_classes = allowed_classes
     end
 
     def [](key)
@@ -21,7 +24,14 @@ module Conifer
     end
 
     def parsed
-      @parsed ||= YAML.safe_load(ERB.new(::File.read(path)).result)
+      @parsed ||= case format
+                  when :yml, :yaml
+                    YAML.safe_load(ERB.new(::File.read(path)).result, permitted_classes: allowed_classes)
+                  when :json
+                    JSON.parse(ERB.new(::File.read(path)).result)
+                  else
+                    raise UnsupportedFormatError, "Format '#{format}' is not supported"
+                  end
     end
 
     def path
@@ -35,7 +45,7 @@ module Conifer
     end
 
     def filename
-      "#{::File.basename(name.to_s, '.yml')}.yml"
+      "#{::File.basename(name.to_s, ".#{format}")}.#{format}"
     end
 
     def validate!

data/lib/conifer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Conifer
-  VERSION = '1.0.0'
+  VERSION = '1.3.0'
 end

data/lib/conifer.rb

@@ -8,21 +8,22 @@ module Conifer
     base.extend ClassMethods
   end
 
+  # rubocop:disable Metrics/ParameterLists
   module ClassMethods
-    def conifer(name, prefix: nil, dir: nil, method: ::File.basename(name.to_s, '.yml'), singleton: false)
+    def conifer(name, prefix: nil, dir: nil, format: :yml, method: ::File.basename(name.to_s, ".#{format}"),
+                singleton: false, allowed_classes: [])
       dir ||= ::File.expand_path(::File.dirname(caller_locations.first.path))
 
       body = proc do
         return instance_variable_get("@conifer_#{method}") if instance_variable_defined?("@conifer_#{method}")
 
-        instance_variable_set "@conifer_#{method}", Conifer::File.new(name, prefix: prefix, dir: dir).tap(&:validate!)
+        instance_variable_set "@conifer_#{method}",
+                              Conifer::File.new(name, prefix: prefix, format: format,
+                                                      dir: dir, allowed_classes: allowed_classes).tap(&:validate!)
       end
 
-      if singleton
-        define_singleton_method method, &body
-      else
-        define_method method, &body
-      end
+      singleton ? define_singleton_method(method, &body) : define_method(method, &body)
     end
+    # rubocop:enable Metrics/ParameterLists
   end
 end

metadata

@@ -1,70 +1,115 @@
 --- !ruby/object:Gem::Specification
 name: conifer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Hamed Asghari
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-02-26 00:00:00.000000000 Z
+date: 2021-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: climate_control
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-description: This is a gem to manage multiple, optionally environment-based YAML configurations
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: rubocop-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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Conifer allows you to easily manage YAML configuration files and import
+  them into your objects.
 email:
 - hasghari@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
+- ".tool-versions"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -81,7 +126,7 @@ homepage: https://github.com/hasghari/conifer
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -89,15 +134,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
-summary: This is a gem to manage multiple, optionally environment-based YAML configurations
+summary: Conifer allows you to easily manage YAML configuration files and import them
+  into your objects.
 test_files: []