wbconfigurator 0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3ffd332828a7b6fd0f0bbecc8687fa6c8106a23784edce28b8e8cf1795579f70
+  data.tar.gz: 8766eb08427c53b35f28208831b901987f15b3b42d548711cce537371d40684e
+SHA512:
+  metadata.gz: 5b79a2ea876cbe2349a093d0877a41c8cb3340ee20959e15476d21e9a649d7dab492236e1abf3a5314a479716d11d7aad4ffab76f6058358c8e0252ec3b0aaff
+  data.tar.gz: ac9656c2ef10c9fddd1b1e4f58999f5f1370d5be6b3ee447f1c97f05644b108c01048d3d895f0fdbd18493c7f925dc9946d5baea47cc22df7e9a119340cf57c7

data/.gitignore

@@ -0,0 +1,6 @@
+**/*.log
+**/*.rvm
+**/*.DS_Store
+**/*.idea
+*.gem
+

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# A sample Gemfile
+source 'https://rubygems.org'
+
+gem 'secure_yaml'

data/Gemfile.lock

@@ -0,0 +1,13 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    secure_yaml (2.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  secure_yaml
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,31 @@
+# Configurator Ruby Gem
+
+Configurator is a very simple configuration tool inspired by [rubyconfig gem](https://github.com/rubyconfig/config).
+It allows easy management of specific environment settings with YAML config files. 
+
+## Usage
+
+Please see the [wiki](https://github.com/wildbit/configurator/wiki) for detailed instructions about how to use the tool.
+
+## Installation
+
+You can use the library with a Bundler.
+
+With Bundler:
+
+``` ruby
+gem 'configurator', git: 'https://github.com/wildbit/configurator.git'
+```
+
+## Issues & Comments
+
+Feel free to contact us if you encounter any issues with the library. 
+Please leave all comments, bugs, requests and issues on the Issues page.  
+
+## License
+
+Configurator library is released under the [MIT](http://www.opensource.org/licenses/mit-license.php) license. 
+
+## Copyright
+
+Copyright © 2020 Wildbit LLC.

data/configurator.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'config/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'wbconfigurator'
+  s.version     = Configurator::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.license     = 'MIT'
+
+  s.authors     = ['Igor Balos']
+  s.email       = ['ibalosh@gmail.com', 'igor@wildbit.com']
+
+  s.summary     = 'Config tool.'
+  s.description = 'Configuration tool for simple management with yaml files.'
+
+  s.files       = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  s.test_files  = `git ls-files -- {spec}/*`.split("\n")
+  s.homepage    = 'https://github.com/wildbit/configurator'
+  s.require_paths = ['lib']
+  s.required_rubygems_version = '>= 1.9.3'
+  s.add_dependency 'secure_yaml', '~> 2.0'
+end

data/lib/config/app.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'secure_yaml'
+require 'singleton'
+require 'ostruct'
+
+# App::Configuration class helps loading configuration files.
+#
+# In order to load config files, you need to provide encryption password to the environment
+#
+# To encrypt content, use the following command:
+#
+# encrypt_property_for_yaml encrypt [SECRET_PASSWORD] [CONTENT_TO_ENCRYPT]
+module App
+  # Configuratior namespace
+  class Configurator
+    # OpenStruct class adaptation
+    class Struct < OpenStruct
+      alias each each_pair
+
+      # convert struct to hash, taken from:
+      # https://github.com/rubyconfig/config
+      def to_hash
+        result = {}
+        marshal_dump.each do |k, v|
+          if v.instance_of? Configurator::Struct
+            result[k] = v.to_hash
+          elsif v.instance_of? Array
+            result[k] = descend_array(v)
+          else
+            result[k] = v
+          end
+        end
+        result
+      end
+
+      private
+
+      def descend_array(array)
+        array.map do |value|
+          if value.instance_of? Configurator::Struct
+            value.to_hash
+          elsif value.instance_of? Array
+            descend_array(value)
+          else
+            value
+          end
+        end
+      end
+    end
+
+    FILES_EXTENSION = 'yaml'
+    DEFAULT_ENVIRONMENT = 'production'
+    attr_accessor :environment,
+                  :files_path
+
+    def initialize
+      @environment = DEFAULT_ENVIRONMENT
+    end
+
+    def load_all!
+      files = Dir.glob("#{files_path}/*.#{FILES_EXTENSION}")
+      names = files.map { |f| File.basename(f).split(".").first }.uniq
+
+      names.each { |name| load!(name) }
+    end
+
+    # options allowed:
+    #
+    # environment: 'production'
+    # filter: 'filter character'
+    def load!(name, filter: nil )
+      filename = config_filename(name)
+      generate_attr_reader(name, load_formatted_data(filename, filter))
+    end
+
+    def global_name=(name)
+      Object.send(:remove_const, name) if Object.const_defined?(name)
+      Object.const_set(name, App.config)
+    end
+
+    private
+
+    def load_formatted_data(filename, filter)
+      hash_data = load_from_yaml(filename)
+      formatted_data(hash_data, filter: filter, struct: true)
+    end
+
+    def config_filename(name)
+      filename = "#{name}.yaml"
+      filename_with_env = filename.gsub(FILES_EXTENSION, "#{environment}.#{FILES_EXTENSION}")
+
+      found_file = get_file_that_exists([filename, filename_with_env])
+      return found_file unless found_file.nil?
+
+      raise "Configuration file '#{filename}' or '#{filename_with_env}' doesn't exist on path '#{files_path}'"
+    end
+
+    def formatted_data(data, filter:, struct:)
+      data = filtered_data(data, filter)
+      struct ? convert_to_struct(data) : data
+    end
+
+    def filtered_data(data, filter)
+      filter.nil? ? data : data[filter]
+    end
+
+    def get_file_that_exists(filenames)
+      found_file = nil
+
+      filenames.each do |filename|
+        found_file = filename if file_exists?(file_full_path(filename))
+        break if found_file
+      end
+
+      found_file
+    end
+
+    def file_exists?(path)
+      File.exist? path
+    end
+
+    def file_full_path(filename)
+      "#{files_path}/#{filename}"
+    end
+
+    def load_from_yaml(filename)
+      SecureYaml.load(File.open(file_full_path(filename)))
+    end
+
+    # generate accessors for loaded data
+    # accessors will return objects which are deep copy of themselves
+    def generate_attr_reader(name, data)
+      define_singleton_method(name) do
+        Marshal.load(Marshal.dump(data))
+      end
+
+      send(name)
+    end
+
+    def convert_to_struct(object)
+      case object
+      when Hash
+        object.each { |key, value| object[key] = convert_to_struct(value) }
+        Configurator::Struct.new(object)
+      when Array
+        object.map!(&method(:convert_to_struct))
+      else
+        object
+      end
+    end
+  end
+
+  def self.config
+    @config ||= Configurator.new
+  end
+end

data/lib/config/version.rb

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

data/lib/configurator.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'config/app'

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: wbconfigurator
+version: !ruby/object:Gem::Version
+  version: '0.2'
+platform: ruby
+authors:
+- Igor Balos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: secure_yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Configuration tool for simple management with yaml files.
+email:
+- ibalosh@gmail.com
+- igor@wildbit.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- configurator.gemspec
+- lib/config/app.rb
+- lib/config/version.rb
+- lib/configurator.rb
+homepage: https://github.com/wildbit/configurator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: Config tool.
+test_files: []