configature 0.1.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ced21d33cb1ae46cd3fe9d9235e51217e6dfd16042a19d1d69557c7a9025083
-  data.tar.gz: 8f2c729683b803eb64f961216e75faf73543d4f59c046d39b0e83efcaf097230
+  metadata.gz: 61bfe9a27a2905f469bfd446a01e8291a33a5e66ac87761d18f83f2959a8237e
+  data.tar.gz: 4812cfcdb1573f15a2e97ce4a23a204a28f2b76f6ef448b06f37dcadbf07c99d
 SHA512:
-  metadata.gz: 7d19f4c15b05f543e5400f51ce7251fb316f440523277636fdd78009fe21ef5006e8df1c55b93565b2fc8ec0fabab00dbc5255046aeb1aa094f0fae57d442abf
-  data.tar.gz: 28c077ec9222cea8e1fb8716b532581f477a936beaacd6ec5319726e9da7c2b7aeec8c4332642dbbd9565ee1091b05915f7c497b5316d6e1b90dc01471f3927f
+  metadata.gz: c5c230c614c28c9e423fa38bd2798e7730e450c19ee9c59702a8ca993103b10bb8f6559b6128d5fc233ea25aa13b857eed9e8954b078976ea16f2c3ff718d1a8
+  data.tar.gz: 2b9136bcbde3a3fc9b9c1724d072353b4f0c39587c33671dbad76c8b56673082f6ef90b34b64cf1e0654e53c2ab201dbdd97ad54c004c2a62398e23f2b4f6f3b

data/.gitignore

@@ -12,3 +12,5 @@
 
 .DS_Store
 .vscode
+
+*.gem

data/.travis.yml

@@ -3,5 +3,10 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.6.2
-before_install: gem install bundler -v 2.0.1
+  - 2.3.8
+  - 2.4.9
+  - 2.5.7
+  - 2.6.5
+  - 2.7.0
+  - jruby-9.2.9.0
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -2,3 +2,9 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in configature.gemspec
 gemspec
+
+group :development do
+  gem 'rake'
+  gem 'bundler'
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -1,26 +1,26 @@
 PATH
   remote: .
   specs:
-    configature (0.1.0)
+    configature (0.3.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.3)
-    rake (12.3.2)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.3)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
 
 PLATFORMS
   ruby
@@ -32,4 +32,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   2.0.1
+   2.1.4

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Scott Tadman, PostageApp Ltd.
+Copyright (c) 2019-2020 Scott Tadman, PostageApp Ltd.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -12,32 +12,110 @@ gem 'configature'
 
 And then execute:
 
-    bundle
-    bundle binstubs configature
+```shell
+bundle
+bundle binstubs configature
+```
 
 Or install it yourself as:
 
-    gem install configature
+```shell
+gem install configature
+```
 
 ## Usage
 
-Once installed, 
+Configuature expects a `config/` directory that contains one or more files
+with the file extension `.example`, as in `database.yml.example`. Any files
+of that form found will be copied to their corresponding name minus the
+`.example` extension *if* no such file exists.
+
+This is done with the command:
+
+```shell
+bin/config
+```
+
+Where files already exist these are not touched, but are noted in the output
+as being "present".
+
+The opposite step is to remove these files:
+
+```shell
+bin/config clean
+```
+
+<blockquote>
+Keep in mind this may remove important credentials so this should be done
+carefully if and only if necessary.
+</blockquote>
+
+### Definining Configuration
+
+Most applications should have a configuration definition like this where
+one or more *namespace* is defined where configuration information is stored:
+
+```ruby
+class MyConfig < Configature::Config
+  namespace :example do
+    argument default: 'value'
+  end
+end
+```
+
+In this case a single namespace is defined. When instantiated the configuration
+values can be read:
+
+```ruby
+config = MyConfig.new
+config.example.argument
+# => 'value'
+```
+
+This can also be accessed through a factory method that provides convenient
+defaults:
+
+```ruby
+Config.example.argument
+# => 'value'
+```
+
+In most cases this can be adequate. The `MyConfig.new` approach allows
+specifying which config file to load and which environment to read from,
+something that may be important in some situations.
+
+The default is to load from `ENV`, the main environment, and `config/`
+relative to `Rails.root` if `Rails` is defined.
 
+This value can be overridden with the environment variable `EXAMPLE_ARGUMENT`
+or in a config file `config/example.yml` under the `argument:` key.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake spec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and
+then run `bundle exec rake release`, which will create a git tag for the
+version, push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/tadman/configature. 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](https://github.com/postageapp/configature).
+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
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the Configature project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/tadman/configature/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Configature project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/tadman/configature/blob/master/CODE_OF_CONDUCT.md).

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.3.3

data/configature.gemspec

@@ -35,8 +35,4 @@ Gem::Specification.new do |spec|
   spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = %w[ lib ]
-
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
 end

data/exe/config

@@ -12,7 +12,7 @@ require_relative '../lib/configature'
 options = {
   verbose: false,
   quiet: false,
-  config_dir: Configature.config_dir
+  config_dir: Configature::Directory.find('config')
 }
 
 program = OptionParser.new do |opts|
@@ -42,30 +42,22 @@ end
 
 case (arg = args.first)
 when 'clean'
-  Configature.configable_examples(options[:config_dir]) do |source, target|
-    if (File.exist?(target))
-      print "* %s: " % File.basename(target)
-      File.unlink(target)
-      puts "removed"
-    end
+  Configature::Stamper.new(options[:config_dir]).clean! do |target|
+    puts "* %s: removed" % File.basename(target)
   end
 when nil
-  Configature.configable_examples(options[:config_dir]) do |source, target|
-    if (File.exist?(target))
-      if (File.read(target).match(/__[A-Z\_]+__/))
-        puts "* %s: present (requires configuration)" % File.basename(target)
-      else
-        puts "* %s: present" % File.basename(target)
-      end
+  Configature::Stamper.new(options[:config_dir]).apply! do |source, target, created:, existing:, config_required:|
+    if (created)
+      print "* %s: created" % File.basename(target)
     else
-      FileUtils.copy(source, target)
-  
-      if (File.read(target).match(/__[A-Z\_]+__/))
-        puts "* %s: created (requires configuration)" % File.basename(target)
-      else
-        puts "* %s: created" % File.basename(target)
-      end
+      print "* %s: present" % File.basename(target)
+    end
+
+    if (config_required)
+      print ' (requires configuration)'
     end
+
+    puts
   end
 else
   $stderr.puts("Unknown command #{arg.inspect}")

data/lib/configature.rb

@@ -1,46 +1,21 @@
+require 'yaml'
+
 module Configature
-  VERSION = File.readlines(File.expand_path('../VERSION', __dir__)).first.chomp.freeze
+  VERSION = File.readlines(
+    File.expand_path('../VERSION', __dir__)
+  ).first.chomp.freeze
 
   class Error < StandardError; end
-  # Your code goes here...
 
   def self.version
     VERSION
   end
+end
 
-  def self.dir_plus_parents(dir)
-    Enumerator.new do |y|
-      y << dir
-
-      loop do
-        last, dir = dir, File.expand_path('../', dir)
-
-        break if (last == dir)
-
-        y << dir
-      end
-    end
-  end
-
-  def self.config_dir
-    dir_plus_parents(Dir.pwd).lazy.map do |dir|
-      File.expand_path('config', dir)
-    end.find do |dir|
-      File.directory?(dir)
-    end
-  end
-
-  def self.configable_examples(dir)
-    map = Dir.glob(File.expand_path('*.example', dir)).map do |source|
-      [ source, source.delete_suffix('.example') ]
-    end.to_h
-
-    if (block_given?)
-      map.each do |k,v|
-        yield(k, v)
-      end
-    end
+require_relative './configature/support'
 
-    map
-  end
-end
+require_relative './configature/config'
+require_relative './configature/data'
+require_relative './configature/directory'
+require_relative './configature/namespace'
+require_relative './configature/stamper'

data/lib/configature/config.rb

@@ -0,0 +1,93 @@
+require 'date'
+
+require_relative './data'
+require_relative './support'
+
+require_relative './namespace'
+
+class Configature::Config < Configature::Data
+  # == Constants ============================================================
+  
+  # == Properties ===========================================================
+  
+  # == Class Methods ========================================================
+
+  def self.config_dir
+    @config_dir ||= defined?(Rails) && Rails.root.join('config/')
+  end
+
+  def self.config_dir=(dir)
+    @config_dir = dir
+  end
+
+  def self.namespace(name, file: nil, env_suffix: '', extends: nil, &block)
+    namespace = self.namespaces[name] = Configature::Namespace.new(name, env_suffix: env_suffix, extends: extends && self.namespaces[extends]).tap do |n|
+      case (block&.arity)
+      when nil
+        nil
+      when 1
+        block[n]
+      else
+        n.instance_eval(&block)
+      end
+    end
+
+    file = file&.to_s || name.to_s
+
+    if (file and !file.include?('.'))
+      file += '.yml'
+    end
+
+    unless (self.respond_to?(name))
+      iv = :"@#{name}"
+
+      singleton_class.send(:define_method, name) do
+        config_path = File.expand_path(file, self.config_dir)
+
+        config = Configature::Support.yaml_if_exist(config_path)
+
+        instance_variable_get(iv) or instance_variable_set(iv, namespace.__instantiate(source: config))
+      end
+    end
+  end
+
+  def self.namespaces
+    @namespaces ||= { }
+  end
+  
+  # == Instance Methods =====================================================
+
+  def initialize(config_dir: nil, env: ENV)
+    super(
+      self.class.namespaces.map do |name, namespace|
+        config_path = File.expand_path('%s.yml' % name, config_dir || self.class.config_dir)
+
+        config = Configature::Support.yaml_if_exist(config_path)
+
+        [
+          name,
+          Configature::Support.convert_hashes(
+            Configature::Data,
+            namespace.__instantiate(source: config, env: env)
+          )
+        ]
+      end.to_h
+    )
+  end
+
+  def to_h
+    super.map do |k, v|
+      [
+        k,
+        case (v)
+        when Array
+          v.map do |e|
+            e.respond_to?(:to_h) ? e.to_h : e
+          end
+        else
+          v.respond_to?(:to_h) ? v.to_h : v
+        end
+      ]
+    end.to_h
+  end
+end

data/lib/configature/data.rb

@@ -0,0 +1,26 @@
+require 'ostruct'
+
+class Configature::Data < OpenStruct
+  # == Class Methods ========================================================
+
+  def self.hashify(data)
+    case (data)
+    when Configature::Data
+      data.to_h
+    when Array
+      data.map do |v|
+        hashify(v)
+      end
+    else
+      data
+    end
+  end
+
+  # == Instance Methods =====================================================
+
+  def to_h
+    super.transform_values do |v|
+      self.class.hashify(v)
+    end
+  end
+end

data/lib/configature/directory.rb

@@ -0,0 +1,23 @@
+module Configature::Directory
+  def self.parents(dir)
+    Enumerator.new do |y|
+      y << dir
+
+      loop do
+        last, dir = dir, File.expand_path('../', dir)
+
+        break if (last == dir)
+
+        y << dir
+      end
+    end
+  end
+
+  def self.find(name)
+    parents(Dir.pwd).lazy.map do |dir|
+      File.expand_path(name, dir)
+    end.find do |dir|
+      File.directory?(dir)
+    end
+  end
+end

data/lib/configature/namespace.rb

@@ -0,0 +1,163 @@
+require 'date'
+
+require_relative './support'
+
+class Configature::Namespace
+  # == Constants ============================================================
+
+  BOOLEAN_EQUIVALENT = begin
+    h = {
+      true => %w[ on yes 1 ],
+      false => %w[ off no 0 ]
+    }.flat_map do |k, a|
+      a.map do |v|
+        [ v, k ]
+      end
+    end.to_h
+
+    -> (v) do
+      b = h[v]
+
+      b.nil? ? !!v : b
+    end
+  end
+
+  RECAST_AS = {
+    [ :string, String ] => :to_s.to_proc,
+    [ :integer, Integer ] => :to_i.to_proc,
+    [ :float, Float ] => :to_f.to_proc,
+    [ :boolean ] => -> (v) { BOOLEAN_EQUIVALENT[v] },
+    [ :date, Date ] => -> (v) { Date.parse(v) },
+    [ :datetime, DateTime ] => -> (v) { DateTime.parse(v) },
+    [ :time, Time ] => -> (v) { v.match?(/\A\d+\z/) ? Time.at(v.to_i) : Time.parse(v) }
+  }.flat_map do |a, v|
+    a.map do |k|
+      [ k, v ]
+    end
+  end.to_h.freeze
+  
+  # == Properties ===========================================================
+
+  attr_reader :name
+  attr_reader :env_name_prefix
+  attr_reader :namespaces
+  attr_reader :parameters
+  
+  # == Class Methods ========================================================
+  
+  # == Instance Methods =====================================================
+
+  def initialize(name = nil, env_name_prefix: '', env_suffix: '', extends: nil)
+    @name = name&.to_sym
+    @extends = extends
+    @env = extends&.instance_variable_get(:@env)
+    @env_default = extends&.instance_variable_get(:@env_default)
+    @namespaces = extends ? extends.namespaces.dup : { }
+    @parameters = extends ? extends.parameters.dup : { }
+    @env_suffix = env_suffix
+    @env_name_prefix = name ? Configature::Support.extend_env_prefix(env_name_prefix, name) : ''
+
+    yield(self) if (block_given?)
+  end
+
+  def namespace(name, env_suffix: '', extends: nil, &block)
+    name = name.to_sym
+
+    @namespaces[name] = self.class.new(name, env_suffix: env_suffix, extends: extends && self.namespaces[extends], env_name_prefix: @env_name_prefix).tap do |n|
+      case (block&.arity)
+      when nil
+        nil
+      when 1
+        block[n]
+      else
+        n.instance_eval(&block)
+      end
+    end
+  end
+
+  def env(*names, default: 'development')
+    @env = names.map(&:to_s).freeze
+    @env_default = default
+  end
+
+  def parameter(parameter_name, default: nil, as: :string, name: nil, env: nil, remap: nil)
+    name ||= parameter_name
+
+    case (as)
+    when Class, Symbol
+      as = RECAST_AS[as]
+    end
+
+    @parameters[name] = {
+      name: name,
+      default: default.is_a?(Proc) ? default : -> { default },
+      as: as,
+      remap: remap,
+      env:
+        case (env)
+        when false
+          false
+        when nil
+          Configature::Support.extend_env_prefix(@env_name_prefix, name)
+        else
+          env
+        end
+    }
+  end
+
+  def [](name)
+    @parameters[name] or @namespaces[name]
+  end
+
+  def method_missing(name, **options)
+    parameter(name, **options)
+  end
+
+  def __instantiate(source: nil, env: ENV)
+    if (@env and source)
+      env_key = @env.map { |e| env[e] }.first || @env_default
+
+      if (@env_suffix)
+        env_key += @env_suffix
+      end
+
+      source = source[env_key] || source[env_key.to_sym]
+    end
+
+    self.__instantiate_branch(source: source, env: env)
+  end
+
+  def __instantiate_branch(source: nil, env: nil)
+    Configature::Data.new(
+      @parameters.values.map do |param|
+        name = param[:name]
+        name_s = name.to_s
+        name_sym = name_s.to_sym
+
+        value = (param[:env] && env && env[param[:env]]) ||
+          source && (source[name_s] || source[name_sym])
+
+        case (remap = param[:remap])
+        when Hash, Proc
+          value = remap[value] || value
+        end
+
+        if (!value.nil? and as = param[:as])
+          value = as[value]
+        end
+
+        [ param[:name], value.nil? ? param[:default].call : value ]
+      end.to_h.merge(
+        @namespaces.map do |name, namespace|
+          [
+            name,
+            namespace.__instantiate_branch(
+              source: source && (source[name] || source[name.to_s]),
+              env: env
+            )
+          ]
+        end.to_h
+      )
+    )
+  end
+end

data/lib/configature/stamper.rb

@@ -0,0 +1,53 @@
+class Configature::Stamper
+  def initialize(dir)
+    @dir = dir
+  end
+
+  def examples
+    map = Dir.glob(File.expand_path('*.example', @dir)).map do |source|
+      [ source, source.delete_suffix('.example') ]
+    end.to_h
+
+    if (block_given?)
+      map.each do |k,v|
+        yield(k, v)
+      end
+    end
+
+    map
+  end
+
+  def clean!
+    self.examples.each do |_source, target|
+      if (File.exist?(target))
+        File.unlink(target)
+
+        yield(target) if (block_given?)
+      end
+    end
+  end
+
+  def apply!(force: false)
+    self.examples.each do |source, target|
+      if (!force and File.exist?(target))
+        yield(
+          source,
+          target,
+          created: false,
+          existing: true,
+          config_required: !!File.read(target).match(/__[A-Z\-\_]+__/)
+        ) if (block_given?)
+      else
+        FileUtils.copy(source, target)
+    
+        yield(
+          source,
+          target,
+          created: true,
+          existing: false,
+          config_required: !!File.read(target).match(/__[A-Z\-\_]+__/)
+        ) if (block_given?)
+      end
+    end
+  end
+end

data/lib/configature/support.rb

@@ -0,0 +1,45 @@
+require 'yaml'
+
+module Configature::Support
+  # == Module and Mixin Methods =============================================
+
+  def yaml_if_exist(path)
+    return unless (File.exist?(path))
+    
+    # FIX: Use safe_load if safe_load supports aliases
+    File.open(path) do |f|
+      YAML.load(f)
+    end
+  end
+
+  def extend_env_prefix(base, with)
+    return base unless (base)
+    return with unless (with)
+
+    case (base)
+    when ''
+      with.to_s.upcase
+    else
+      base.upcase + '_' + with.to_s.upcase
+    end
+  end
+
+  def convert_hashes(to_class, obj)
+    case (obj)
+    when Hash, OpenStruct, Configature::Data
+      to_class.new(
+        obj.to_h.map do |k, v|
+          [ k, convert_hashes(to_class, v) ]
+        end.to_h
+      )
+    when Array
+      obj.map do |v|
+        convert_hashes(to_class, v)
+      end
+    else
+      obj
+    end
+  end
+
+  extend self
+end

metadata

@@ -1,57 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: configature
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.3
 platform: ruby
 authors:
 - Scott Tadman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-03 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  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: rake
-  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: 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'
+date: 2020-04-21 00:00:00.000000000 Z
+dependencies: []
 description: Assists in the creation of config files from example templates and can
   identify when some customization is necessary.
 email:
@@ -76,6 +34,12 @@ files:
 - configature.gemspec
 - exe/config
 - lib/configature.rb
+- lib/configature/config.rb
+- lib/configature/data.rb
+- lib/configature/directory.rb
+- lib/configature/namespace.rb
+- lib/configature/stamper.rb
+- lib/configature/support.rb
 homepage: https://postageapp.com/
 licenses:
 - MIT
@@ -99,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Configuration file auto-generator