simple-configurator 0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 12c6da130c9b8f8d3675e08fbc53ea1af2eb190e7e6d1012b69a7cb822a7af68
+  data.tar.gz: 697c77cb03524ea5bb760813d25b792298d6985a89e5c34c7dc8913fb048d6eb
+SHA512:
+  metadata.gz: 86f195b7e0148f07aa7011bbf6ea778db92818330afc88d30c2c028646bbf474fffc0f31d9fcc4b6ce25fc4b9022d98ea28c06e920bdb5023fa20961b5ab00d4
+  data.tar.gz: 84a5022d547b2cfb1ea5c1c9a447e79307846b4f3c51816dd36acfa88fc1007a285b65b7b9125aeadb5b5960762d9f998ce657b630c6664262139744b767e3e7

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+Gemfile.lock
+*.gem
+test/tmp

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 jslabovitz
+
+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,3 @@
+# Simple::Config
+
+FIXME

data/Rakefile

@@ -0,0 +1 @@
+require 'simple-rake-tasks'

data/TODO.md

@@ -0,0 +1,2 @@
+# TODO
+

data/lib/simple-configurator.rb

@@ -0,0 +1,131 @@
+require 'json'
+require 'yaml'
+require 'path'
+require 'uri'
+
+module Simple
+
+  class Configurator
+
+    class Error < StandardError; end
+
+    attr_accessor :parent
+    attr_accessor :fields
+    attr_accessor :data
+
+    def self.define(definitions)
+      fields = {}
+      data = definitions.map do |key, field|
+        field = Field.make(field)
+        fields[key] = field
+        [key, field.convert(field.default)]
+      end.to_h
+      new(fields: fields, data: data)
+    end
+
+    def initialize(parent: nil, fields:, data:)
+      @parent = parent
+      @fields = fields
+      @data = data.map do |key, value|
+        key = key.to_sym
+        field = @fields[key] or raise Error, "Unknown config key: #{key.inspect}"
+        [key, field.convert(value)]
+      end.to_h
+    end
+
+    def load(file)
+      data = File.read(file)
+      json = JSON.parse(data, symbolize_names: true)
+      make(**json)
+    end
+
+    def load_yaml(file)
+      yaml = YAML.load_file(file, permitted_classes: [Date, Symbol])
+      make(**yaml)
+    end
+
+    def make(**data)
+      self.class.new(parent: self, fields: @fields, data: data)
+    end
+
+    def as_json(*opts)
+      @data.compact
+    end
+
+    def to_json(*opts)
+      as_json.to_json(*opts)
+    end
+
+    def to_h
+      (@parent&.to_h || {}).merge(@data)
+    end
+
+    def save(file)
+      File.write(file, JSON.pretty_generate(self))
+    end
+
+    def method_missing(id, *args)
+      key = id.to_s.sub(/=$/, '').to_sym
+      field = @fields[key] or return super
+      if $&
+        @data[key] = args.first
+      elsif @data.has_key?(key)
+        @data[key]
+      elsif @parent
+        @parent.send(key)
+      else
+        super
+      end
+    end
+
+    class Field
+
+      attr_accessor :default
+      attr_accessor :converter
+
+      def self.make(obj)
+        case obj
+        when nil
+          new
+        when Proc
+          new(converter: obj)
+        when Hash
+          new(**obj)
+        when Field
+          obj
+        else
+          new(default: obj)
+        end
+      end
+
+      def initialize(default: nil, converter: nil)
+        @default = default
+        @converter = converter
+      end
+
+      def convert(value)
+        if value.nil?
+          nil
+        else
+          case @converter
+          when :path
+            Path.new(value)
+          when :date
+            value.kind_of?(Date) ? value : Date.parse(value)
+          when :uri
+            value.kind_of?(URI) ? value : URI.parse(value)
+          when :symbol
+            value.to_sym
+          when Proc
+            @converter.call(value)
+          else
+            value
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/simple-configurator.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name          = 'simple-configurator'
+  s.version       = '0.2'
+  s.summary       = 'simple hierarchical configuration object'
+  s.author        = 'John Labovitz'
+  s.email         = 'johnl@johnlabovitz.com'
+  s.description   = %q{
+    A simple hierarchical configuration object.
+  }
+  s.homepage      = 'http://github.com/jslabovitz/simple-configurator'
+  s.license       = 'MIT'
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_path  = 'lib'
+
+  s.add_dependency 'path', '~> 2.1'
+
+  s.add_development_dependency 'minitest', '~> 5.26'
+  s.add_development_dependency 'minitest-power_assert', '~> 0.3'
+  s.add_development_dependency 'rake', '~> 13.3'
+  s.add_development_dependency 'simple-rake-tasks', '~> 0.1'
+end

data/test/config.json

@@ -0,0 +1,4 @@
+{
+  "a": 11,
+  "b": 22
+}

data/test/config_test.rb

@@ -0,0 +1,73 @@
+$VERBOSE = false
+
+require 'minitest/autorun'
+require 'minitest/power_assert'
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'simple-configurator'
+
+class SimpleConfiguratorTest < Minitest::Test
+
+  def setup
+    @base_config = Simple::Configurator.define(
+      a: { default: 1 },
+      b: { default: 2, converter: proc { |o| Integer(o) } },
+      c: nil,
+      d: nil,
+    )
+    @config1 = @base_config.make
+    @config2 = @config1.make(b: '22', c: 3)
+    @config3 = @config2.make(d: 4)
+  end
+
+  def test_config
+    assert { @config1.a == 1 }
+    assert { @config1.b == 2 }
+    assert { @config1.c == nil }
+    assert { @config1.d == nil }
+
+    assert { @config2.a == 1 }
+    assert { @config2.b == 22 }
+    assert { @config2.c == 3 }
+    assert { @config2.d == nil }
+
+    assert { @config3.a == 1 }
+    assert { @config3.b == 22 }
+    assert { @config3.c == 3 }
+    assert { @config3.d == 4 }
+  end
+
+  def test_load
+    file = 'test/config.json'
+    config = @base_config.load(file)
+    assert { config.a == 11 }
+    assert { config.b == 22 }
+  end
+
+  def test_save
+    file = 'test/tmp/config.json'
+    FileUtils.mkpath(File.dirname(file))
+    File.unlink(file) if File.exist?(file)
+    @base_config.save(file)
+    config = @base_config.load(file)
+    assert { config.a == 1 }
+    assert { config.b == 2 }
+  end
+
+  def test_set
+    @base_config.d = 4
+    assert { @base_config.d == 4 }
+  end
+
+  def test_types
+    config = Simple::Configurator.define(
+      uri: { default: 'http://localhost', converter: :uri },
+      sym: { default: 'a', converter: :symbol },
+      path: { default: 'a/b/c', converter: :path },
+    )
+    assert { config.uri.kind_of?(URI) }
+    assert { config.sym == :a }
+    assert { config.path == Path.new('a/b/c') }
+  end
+
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: simple-configurator
+version: !ruby/object:Gem::Version
+  version: '0.2'
+platform: ruby
+authors:
+- John Labovitz
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: path
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.26'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.26'
+- !ruby/object:Gem::Dependency
+  name: minitest-power_assert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.3'
+- !ruby/object:Gem::Dependency
+  name: simple-rake-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: "\n    A simple hierarchical configuration object.\n  "
+email: johnl@johnlabovitz.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- Rakefile
+- TODO.md
+- lib/simple-configurator.rb
+- simple-configurator.gemspec
+- test/config.json
+- test/config_test.rb
+homepage: http://github.com/jslabovitz/simple-configurator
+licenses:
+- MIT
+metadata: {}
+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: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: simple hierarchical configuration object
+test_files:
+- test/config.json
+- test/config_test.rb