conifer 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 242c45c7c55f650e17a190ab1451c4c44600d737881d8a2e37c10291c46f9e48
-  data.tar.gz: 160ef67508c13a2e05e3efc9aa4dce2dd07bfd41c16979da8c77dc6b96bac2a4
+  metadata.gz: 0a170b07790bedd693faf1f86de8cea5bc2b6a8b1adcaa10360816a05a00de72
+  data.tar.gz: 6d3913dae889d4543fcda4c3686d88614c5bb95bfb8704fa41e55b4bb14731e6
 SHA512:
-  metadata.gz: 4ddc85687be772047571e4c7f56a60e4b2b44f867828de6abc5e38c308467faba238b51c4a6b2d1f880dbb53d9df8938ec1714b96044026b4843d356b0be61b9
-  data.tar.gz: 2567e3a020b165acdb8479ffe2b54163c69fe231814fa89a39eddb0df08751b2d305eccd663b44df07d0220d4caa22db78a122cb4c49ef2fef53b2beb780b346
+  metadata.gz: bfef2f2a00f2a7bbebd5c805876ee51276216c37169fc5e782f78ee218013de0f76afcc68abdea9b0844989dea9d9c7c7405e22ff75749c915068f734ef9880d
+  data.tar.gz: c13bc23806654f72898a68044485f294d4116fd127abd4cddbe0c45b11c6d46c59dd6c59eb9d1d5c89575b524b262325b3e5723a05c0c20fa7c6c175f1d78459

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

@@ -13,8 +13,14 @@ jobs:
         uses: actions/setup-ruby@v1
         with:
           ruby-version: 2.6.x
-      - name: Build and test with RSpec
+      - name: Configure Bundler
         run: |
           gem install bundler -v 1.17.3 --no-document
           bundle install --jobs 4 --retry 3
-          bundle exec rspec
+      - name: Run tests with RSpec
+        uses: paambaati/codeclimate-action@v2.5.3
+        env:
+          CC_TEST_REPORTER_ID: 0e4e712966b3d2fdf63128dc4d0c863fd4c61888b557ffb1673111b4c8b3bdc9
+        with:
+          coverageCommand: bundle exec rspec
+          debug: false

data/.rubocop.yml

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

data/Gemfile.lock

@@ -1,13 +1,23 @@
 PATH
   remote: .
   specs:
-    conifer (1.0.0)
+    conifer (1.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.0)
+    climate_control (0.2.0)
     diff-lcs (1.3)
+    docile (1.3.2)
+    jaro_winkler (1.5.4)
+    json (2.3.0)
+    parallel (1.19.1)
+    parser (2.7.0.3)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
     rake (10.5.0)
+    rexml (3.2.4)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -21,15 +31,36 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.2)
+    rubocop (0.80.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-rspec (1.38.1)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (1.6.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.17)
+  climate_control (~> 0.2)
   conifer!
   rake (~> 10.0)
   rspec (~> 3.0)
+  rubocop (~> 0.80)
+  rubocop-rspec (~> 1.38)
+  simplecov (= 0.16.1)
 
 BUNDLED WITH
    1.17.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,8 +10,8 @@ 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'
 
@@ -25,6 +25,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'climate_control', '~> 0.2'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.80'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.38'
+  spec.add_development_dependency 'simplecov', '0.16.1'
 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, method: ::File.basename(name.to_s, '.yml'), 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, 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

data/lib/conifer/file.rb

@@ -7,12 +7,13 @@ module Conifer
   class File
     NotFoundError = Class.new(StandardError)
 
-    attr_reader :name, :prefix, :dir
+    attr_reader :name, :prefix, :dir, :allowed_classes
 
-    def initialize(name, dir:, prefix: nil)
+    def initialize(name, dir:, prefix: nil, allowed_classes: [])
       @name = name
       @prefix = prefix
       @dir = dir
+      @allowed_classes = allowed_classes
     end
 
     def [](key)
@@ -21,7 +22,7 @@ module Conifer
     end
 
     def parsed
-      @parsed ||= YAML.safe_load(ERB.new(::File.read(path)).result)
+      @parsed ||= YAML.safe_load(ERB.new(::File.read(path)).result, allowed_classes)
     end
 
     def path

data/lib/conifer/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: conifer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Hamed Asghari
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-26 00:00:00.000000000 Z
+date: 2020-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,13 +66,57 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: This is a gem to manage multiple, optionally environment-based YAML configurations
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.38'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.38'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+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"
@@ -99,5 +157,6 @@ requirements: []
 rubygems_version: 3.0.6
 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: []