comfy_conf 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e0e373dda41050a755c862f826b3f0a681ffa8f
+  data.tar.gz: 52d592f2888035caae394a6cdc7b41b52de02096
+SHA512:
+  metadata.gz: f01dedb534b517c230942ca21d31ed683e5642f179c5858b1bc305bd6eba840a54f508ee8aceb7b0ce84964705819970851278121bb2ba14a1030205de3d19f6
+  data.tar.gz: 3e3821acda836b701e97a5a133248c7f9fe0c0a45c84ee4d38c364b17418f3042eb6903cfe7dbd79ada4dd299a9d72090e8f259c495c7dbefa3715fb43eb2e01

data/lib/comfy_conf/checker.rb

@@ -0,0 +1,59 @@
+module ComfyConf
+  class Checker
+    def initialize(definition, given_prefix, data)
+      @definition, @given_prefix, @data = definition, given_prefix, data
+    end
+    attr_reader :definition,  :data
+
+    def check
+      definition.props.each {|p| check_prop(p) }
+      definition.configs.each {|c| check_config(c) }
+    end
+
+    def prefix
+      given_prefix
+    end
+
+    private
+    attr_reader :given_prefix
+
+    def check_config(config)
+      if config.required and not valid_section(config)
+        raise MissingSection, "Expected configuration #{prefix} to contain "\
+          "section #{config.name} but it does not" \
+      end
+    end
+
+    def valid_section(config)
+      data[config.name] and data[config.name].kind_of?(Hash)
+    end
+
+    def check_prop(prop)
+      ensure_present(prop) if prop.required
+      ensure_type(prop) if data[prop]
+    end
+
+    def ensure_type(prop)
+      if not data[prop.name].kind_of?(prop.type)
+        raise InvalidOption, "Expect type #{prop.type} for "\
+          "configuration property #{prefixed_name(prop)}, "\
+          "got #{data[prop.name].class}"
+      end
+    end
+
+    def ensure_present(prop)
+      if not data[prop.name]
+        raise MissingOption,
+          "Configuration property #{prefixed_name(prop)} is required!"
+      end
+    end
+
+    def prefixed_name(prop)
+      if prefix
+        "#{prefix}[#{prop.name}]"
+      else
+        prop.name
+      end
+    end
+  end
+end

data/lib/comfy_conf/data.rb

@@ -0,0 +1,44 @@
+module ComfyConf
+  class Data
+    def initialize(prefix, definition, data)
+      @prefix, @definition, @data = prefix, definition, data
+      load
+    end
+    attr_reader :data, :definition, :prefix
+
+    def name
+      definition.name
+    end
+
+    private
+
+    def load
+      definition.check_data(full_name, data)
+      define_accessors
+    end
+
+    def full_name
+      if prefix
+        "#{prefix}[#{definition.name}]"
+      else
+        definition.name
+      end
+    end
+
+    def child_configs
+      @child_configs ||= definition.configs.map do |config|
+        Data.new full_name, config, @data[config.name]
+      end
+    end
+
+    def define_accessors
+      definition.props.each do |prop|
+        define_singleton_method(prop.name) { data[prop.name] }
+      end
+
+      child_configs.each do |config|
+        define_singleton_method(config.name) { config }
+      end
+    end
+  end
+end

data/lib/comfy_conf/definition.rb

@@ -0,0 +1,28 @@
+require 'comfy_conf/checker'
+
+module ComfyConf
+  class Definition
+    Prop = Struct.new(:name, :type, :required)
+
+    def initialize(name, required: false, &block)
+      @name = name.to_s
+      @required = required
+      @props = Array.new
+      @configs = Array.new
+      instance_eval(&block) if block
+    end
+    attr_reader :props, :configs, :name, :required
+
+    def prop(name, type:, required: false)
+      props.push Prop.new(name.to_s, type, required)
+    end
+
+    def config(name, required: false, &block)
+      configs.push Definition.new(name, required: required, &block)
+    end
+
+    def check_data(prefix, data)
+      Checker.new(self, prefix, data).check
+    end
+  end
+end

data/lib/comfy_conf/parser.rb

@@ -0,0 +1,34 @@
+require 'pathname'
+require 'yaml'
+require 'comfy_conf/definition'
+require 'comfy_conf/data'
+
+module ComfyConf
+  class Parser
+    def initialize(pathname, &block)
+      @pathname = Pathname.new(pathname)
+      @definition = Definition.new('root', &block)
+    end
+    attr_reader :pathname, :definition
+
+    def data
+      @data ||= Data.new(nil, definition, type_checked_config_data)
+    end
+
+    private
+
+    def type_checked_config_data
+      unless config_data.kind_of?(Hash)
+        raise ParseError, "YAML config data must be a hash.  File: #{pathname}"
+      end
+      config_data
+    end
+
+    def config_data
+      @config_data ||= YAML.load(pathname.read)
+    rescue Psych::SyntaxError => e
+      raise ParseError,
+        "YAML parse error in config file #{pathname}: #{e.message}"
+    end
+  end
+end

data/lib/comfy_conf.rb

@@ -0,0 +1,9 @@
+module ComfyConf
+  Error = Class.new(StandardError)
+  InvalidOption = Class.new(Error)
+  MissingOption = Class.new(Error)
+  MissingSection = Class.new(Error)
+  ParseError = Class.new(Error)
+end
+
+require 'comfy_conf/parser'

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: comfy_conf
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Jack Forrest
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 'ComfyConf provides a minimal DSL for parsing YAML config files into
+  a structured and type-checked configuration '
+email: jack@jrforrest.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- "./lib/comfy_conf.rb"
+- "./lib/comfy_conf/checker.rb"
+- "./lib/comfy_conf/data.rb"
+- "./lib/comfy_conf/definition.rb"
+- "./lib/comfy_conf/parser.rb"
+homepage: http://github.com/jrforrest/comfy_conf
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A YAML configuration parser
+test_files: []