ficus 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.sw*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ficus.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 afradette
+
+MIT License
+
+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,76 @@
+# Ficus
+
+A simple YAML configuration DSL that does runtime validation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ficus'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ficus
+
+## Usage
+
+Here is an example YAML config file:
+
+```yaml
+# config.yml
+---
+section_1:
+  key1: value1
+  key2: value2
+
+section_2:
+  key4: value4
+
+optional_section:
+  key5: value5
+```
+
+And now we can use Ficus to load the config and validate it at the same time.
+
+```ruby
+require 'ficus'
+
+config = Ficus.load 'config.yml' do
+  section 'section_1' do
+    required 'key1'
+    required 'key2'
+
+    optional 'key3', 'value3'
+  end
+
+  section 'section_2'  do
+    required 'key4'
+  end
+
+  section 'optional_section', :optional => true do
+    required 'key5'
+  end
+
+  section 'not_defined', :optional => true do
+    require 'key6'
+  end
+end
+
+config.section_1.key1         # value1
+config.section_1.key2         # value2
+config.section_1.key3         # value3
+config.section_2.key4         # value4
+config.not_defined            # nil
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/ficus.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "ficus"
+  spec.version       = '0.0.1'
+  spec.authors       = ["Drew Fradette"]
+  spec.email         = ["drew.fradette@gmail.com"]
+  spec.description   = 'A runtime validation configuration DSL'
+  spec.summary       = ''
+  spec.homepage      = "https://github.com/drewfradette/ficus"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov' if RUBY_VERSION >= '1.9'
+
+  #spec.add_dependency 'recursive-open-struct'
+end

data/lib/ficus.rb

@@ -0,0 +1,47 @@
+require 'yaml'
+require 'recursive-open-struct'
+
+class Ficus < RecursiveOpenStruct
+  class ConfigError < StandardError; end
+  class << self
+    attr_accessor :log, :verbose
+
+    def load(file, &block)
+      @log = []
+      yaml = YAML.load File.read(file)
+      config = Ficus.new(yaml, :recurse_over_arrays => true)
+      config.instance_eval(&block) if block_given?
+
+      errors = log.select{|v| v =~ /^\[ERR\]/}
+      if errors.size > 0
+        log.each{|v| puts v} if ENV['DEBUG']
+        raise ConfigError.new("Unable to start due to invalid settings")
+      end
+      config
+    end
+
+    def log(log = {})
+      @log << log
+    end
+  end
+
+  def section(name, args = {}, &block)
+    section = self.send(name)
+    if section.nil?
+      level = args[:optional] ? 'WARN' : 'ERR'
+      Ficus.log "[#{level}] Section #{name} is not defined"
+    else
+      section.parent = self.parent ? "#{self.parent}.#{name}" : name
+      section.instance_eval &block if block_given?
+    end
+  end
+
+  def optional(name, default)
+    self.send("#{name}=", default) if self.send(name).nil?
+  end
+
+  def required(name)
+    prefix = self.parent ? "#{self.parent}." : nil
+    Ficus.log "[ERR] Option #{prefix}#{name} is not defined" if self.send(name).nil?
+  end
+end

data/lib/recursive-open-struct.rb

@@ -0,0 +1,93 @@
+require 'ostruct'
+
+class RecursiveOpenStruct < OpenStruct
+  VERSION = "0.4.3"
+
+  def initialize(h=nil, args={})
+    @recurse_over_arrays = args.fetch(:recurse_over_arrays,false)
+    super(h)
+    @sub_elements = {}
+  end
+
+  def to_h
+    @table.dup.update(@sub_elements) do |k, oldval, newval|
+      if newval.kind_of?(self.class)
+        newval.to_h
+      elsif newval.kind_of?(Array)
+        newval.map { |a| a.kind_of?(self.class) ? a.to_h : a }
+      else
+        raise "Cached value of unsupported type: #{newval.inspect}"
+      end
+    end
+  end
+
+  def new_ostruct_member(name)
+    name = name.to_sym
+    unless self.respond_to?(name)
+      class << self; self; end.class_eval do
+        define_method(name) do
+          v = @table[name]
+          if v.is_a?(Hash)
+            @sub_elements[name] ||= self.class.new(v, :recurse_over_arrays => @recurse_over_arrays)
+          elsif v.is_a?(Array) and @recurse_over_arrays
+            @sub_elements[name] ||= recurse_over_array v
+          else
+            v
+          end
+        end
+        define_method("#{name}=") { |x| modifiable[name] = x }
+        define_method("#{name}_as_a_hash") { @table[name] }
+      end
+    end
+    name
+  end
+
+  def recurse_over_array array
+    array.map do |a|
+      if a.is_a? Hash
+        self.class.new(a, :recurse_over_arrays => true)
+      elsif a.is_a? Array
+        recurse_over_array a
+      else
+        a
+      end
+    end
+  end
+
+  def debug_inspect(io = STDOUT, indent_level = 0, recursion_limit = 12)
+    display_recursive_open_struct(io, @table, indent_level, recursion_limit)
+  end
+
+  def display_recursive_open_struct(io, ostrct_or_hash, indent_level, recursion_limit)
+
+    if recursion_limit <= 0 then
+      # protection against recursive structure (like in the tests)
+      io.puts '  '*indent_level + '(recursion limit reached)'
+    else
+      #puts ostrct_or_hash.inspect
+      if ostrct_or_hash.is_a?(self.class) then
+        ostrct_or_hash = ostrct_or_hash.marshal_dump
+      end
+
+      # We'll display the key values like this :    key =  value
+      # to align display, we look for the maximum key length of the data that will be displayed
+      # (everything except hashes)
+      data_indent = ostrct_or_hash \
+        .reject { |k, v| v.is_a?(self.class) || v.is_a?(Hash) } \
+        .max {|a,b| a[0].to_s.length <=> b[0].to_s.length}[0].to_s.length
+      # puts "max length = #{data_indent}"
+
+      ostrct_or_hash.each do |key, value|
+        if (value.is_a?(self.class) || value.is_a?(Hash)) then
+          io.puts '  '*indent_level + key.to_s + '.'
+          display_recursive_open_struct(io, value, indent_level + 1, recursion_limit - 1)
+        else
+          io.puts '  '*indent_level + key.to_s + ' '*(data_indent - key.to_s.length) + ' = ' + value.inspect
+        end
+      end
+    end
+
+    true
+  end
+
+end

data/spec/ficus_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+require 'tempfile'
+require 'yaml'
+
+require 'ficus'
+
+describe Ficus do
+  before :each do
+    @config = {
+      :general => {:key1=>'value1',:key2=>'value2',:key3=>'value3'},
+      :misc    => {
+        :key4 => 'value4',
+        :list => {:item1 => 'value1', :item2 => 'value2'}
+      }
+    }
+  end
+
+  it 'should load the config without any validation' do
+    config_file do |config|
+      config = Ficus.load(config)
+
+      config.to_h.should eq @config
+    end
+  end
+
+  it 'should load the config with a warning about a missing section' do
+    config_file do |config|
+      config = Ficus.load(config) do
+        section 'not_real', :optional => true
+      end
+      Ficus.log.count{|v| v =~ /^\[WARN\]/}.should eq 1
+    end
+  end
+
+  it 'should load the config with a error about a missing section' do
+    config_file do |config|
+      expect {
+        config = Ficus.load(config) do
+          section 'not_real'
+        end
+      }.to raise_error Ficus::ConfigError
+
+      Ficus.log.count{|v| v =~ /^\[ERR\]/}.should eq 1
+    end
+  end
+
+  it 'should load the config but fail to validate' do
+    config_file do |config|
+      expect {
+        config = Ficus.load(config) do
+          section 'general', :optional => true do
+            required 'fake_param'
+          end
+        end
+      }.to raise_error Ficus::ConfigError
+      Ficus.log.count{|v| v =~ /^\[ERR\]/}.should eq 1
+    end
+  end
+
+  it 'should load the config but fill in the optional value' do
+    config_file do |config|
+      config = Ficus.load(config) do
+        section 'general' do
+          optional 'newparam', 'value2'
+        end
+      end
+      @config.fetch(:general).fetch('newparam', nil).should eq nil
+      config.general.newparam.should eq 'value2'
+    end
+  end
+
+  def config_file
+    Tempfile.open('config.yml') do |config|
+      config.write @config.to_yaml
+      config.close
+
+      yield config.path
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+$:.unshift File.join(File.dirname(__FILE__), '..')
+
+require 'rspec'
+
+if RUBY_VERSION.to_f >= 1.9
+  puts 'Enabling coverage'
+  require 'simplecov'
+  SimpleCov.add_filter 'vendor'
+  SimpleCov.add_filter 'spec'
+  SimpleCov.start
+end
+
+RSpec.configure do |config|
+  require 'lib/ficus'
+end
+
+

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: ficus
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Drew Fradette
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A runtime validation configuration DSL
+email:
+- drew.fradette@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ficus.gemspec
+- lib/ficus.rb
+- lib/recursive-open-struct.rb
+- spec/ficus_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/drewfradette/ficus
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 996828060778593471
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 996828060778593471
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- spec/ficus_spec.rb
+- spec/spec_helper.rb