open_config 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4b06d211bb7c9b53084433d03ea7a088c82613e130ef35bb9ea1f28310cd273a
+  data.tar.gz: ca95f738c6edd0cb589a42f58d6279d78b33de03368b2b15338973d366b04c52
+SHA512:
+  metadata.gz: 3f4beb18ba70d288d99e90191dfc51afab9292e3bd9730dc165dc6244a07eac2fd7b254ffd6535535bd647135e35f6b928b5a4e99abb2b91a3e5c96049cb8b8f
+  data.tar.gz: f6a6e7a9753a45dbc3e9074f39837b59f43a7dc30a95ba0f6f8a23ee609568a009bb0fe1a30dd449fe1df6e3add36b4909ee0332217b4aacbb02bbf3d2250532

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,23 @@
+PATH
+  remote: .
+  specs:
+    open_config (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    method_source (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  open_config!
+  pry (~> 0.13.1)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Egor Iskrenkov
+
+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,29 @@
+# OpenConfig
+It allows you to build OpenStruct trees from your configuration files
+
+## Installation
+Install OpenConfig on your machine as any other Ruby gem
+
+```sh
+$ gem install open_config
+```
+
+## Usage
+Imagine, you have file, called `configuration.yml` in your project's config folder:
+
+```yaml
+development:
+  key: value
+  another_key: 123
+production:
+  key: production_value
+  another_key: 321
+```
+You can create OpenConfig instance `open_config = OpenConfig::YAML.new(root: 'config', file: 'configuration.yml')`, and access configuration keys on any depth by simple method calls:
+
+```ruby
+pry(main)> open_config.production.another_key
+=> 321
+```
+
+Same thing will work with `configuration.json`, just use `OpenConfig::JSON` instead

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'open_config'
+require 'pry'
+
+Pry.start

data/lib/open_config.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative 'open_config/version'
+require_relative 'open_config/errors'
+require_relative 'open_config/files'
+
+module OpenConfig
+end

data/lib/open_config/errors.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module OpenConfig
+  module Errors
+    class FileNotFound < StandardError
+      def initialize(path)
+        super("#{path} doesn't exist!")
+      end
+    end
+  end
+end

data/lib/open_config/files.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative 'files/base'
+require_relative 'files/yaml'
+require_relative 'files/json'

data/lib/open_config/files/base.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module OpenConfig
+  class Base
+    attr_reader :file_path
+
+    def initialize(root:, file:)
+      @file_path = File.join(root, file)
+    end
+
+    def method_missing(method_name, *arguments, &block)
+      return super unless configuration_method?(method_name)
+
+      tree.public_send(method_name, *arguments, &block)
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      configuration_method?(method_name) || super
+    end
+
+    private
+
+    def configuration_method?(method_name)
+      tree.respond_to?(method_name)
+    end
+
+    def tree
+      @tree ||= parse_file(read_file)
+    end
+
+    def parse_file(_file_content)
+      raise NotImplementedError, 'Subclassed must implement #parse_file'
+    end
+
+    def read_file
+      raise OpenConfig::Errors::FileNotFound, file_path unless File.exists?(file_path)
+
+      File.new(file_path).read
+    end
+  end
+end

data/lib/open_config/files/json.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module OpenConfig
+  class JSON < OpenConfig::Base
+    private
+
+    def parse_file(file_content)
+      ::JSON.parse(file_content, object_class: OpenStruct)
+    end
+  end
+end

data/lib/open_config/files/yaml.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'json'
+require 'erb'
+
+module OpenConfig
+  class YAML < OpenConfig::Base
+    private
+
+    def parse_file(file_content)
+      ::JSON.parse(build_json(file_content), object_class: OpenStruct)
+    end
+
+    def build_json(file_content)
+      ::YAML.safe_load(load_erb(file_content)).to_json
+    end
+
+    def load_erb(file_content)
+      ::ERB.new(file_content).result
+    end
+  end
+end

data/lib/open_config/version.rb

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

data/open_config.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'lib/open_config/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'open_config'
+  spec.version       = OpenConfig::VERSION
+  spec.license       = 'MIT'
+
+  spec.authors       = ['Egor Iskrenkov']
+  spec.email         = ['e.iskrenkov@gmail.com']
+
+  spec.summary       = 'Building OpenStruct trees from configuration files'
+  spec.homepage      = 'https://github.com/eiskrenkov/open_config'
+
+  spec.files         = `git ls-files`.split($RS).reject { |f| f.match(%r{^spec/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = Gem::Requirement.new('~> 3.0.0')
+
+  # OpenConfig dependencies
+  spec.add_development_dependency 'pry', '~> 0.13.1'
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: open_config
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Egor Iskrenkov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+description:
+email:
+- e.iskrenkov@gmail.com
+executables:
+- console
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- bin/console
+- lib/open_config.rb
+- lib/open_config/errors.rb
+- lib/open_config/files.rb
+- lib/open_config/files/base.rb
+- lib/open_config/files/json.rb
+- lib/open_config/files/yaml.rb
+- lib/open_config/version.rb
+- open_config.gemspec
+homepage: https://github.com/eiskrenkov/open_config
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Building OpenStruct trees from configuration files
+test_files: []