fuguta 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa160adc045cc3b478250bc25843f1be1142c9ec
-  data.tar.gz: f407c1da6ea79a0da7c4fe2782a6351c4b4ec548
+  metadata.gz: 2ce06a414af76fbb7237b3cc66001ed726b3e466
+  data.tar.gz: 102c6d2aad85b6d62ce59bc0decc43eda85a67be
 SHA512:
-  metadata.gz: 222aeb80be0857eaf55762bfe91e06ac613f5600c63b824ead1dae8594771682b9aec45c2409d396656fad7a261780e40de3abbc5a3eeafd23cf5d454bf96dd1
-  data.tar.gz: 84edc10c6abb6312627c796f3fa3d7c01953f3b4b6d88f0766c9ceaa84805e78ee6be19715cd936dc14718f5884be56804a4e7dd6519b2089cb5080725db1532
+  metadata.gz: 41d0b8df4582f1da011f2454d7b3378555780b8c67bd9cc6a94383e0ac78de049c01d33644ed9b142ea1b59fc5ada83ee35eb4b6e6ffabdf6cc6e12657e1aa7d
+  data.tar.gz: 807eb8d86ea21ce3118602bcf9d44a4e531a6f6d538b5e4091ae0c5b9ae8ca741806081a88cde928196072477bd8abca2ba52606d2971c26a9e790dfcd89515a

data/.travis.yml

@@ -2,6 +2,7 @@ script: bundle exec rspec
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.2
   - ruby-head
 
 matrix:

data/lib/fuguta.rb

@@ -1,16 +1,50 @@
 # -*- coding: utf-8 -*-
 
 module Fuguta
+  class ValidationError < StandardError
+    attr_reader :errors
+    def initialize(errors)
+      super("validation error")
+      @errors = errors
+    end
+  end
+
+  class SyntaxError < StandardError
+    # self.cause() is as of Ruby 2.1 so we
+    # handles root error .
+    attr_reader :root_cause, :source
+
+    def initialize(root_cause, source="")
+      super("Syntax Error")
+      raise ArgumentError, 'root_cause' unless root_cause.is_a?(::Exception)
+      @root_cause = root_cause
+      @source = source
+    end
+
+    def message
+      if @root_cause.backtrace.first =~ /:(\d+):in `/ ||
+          @root_cause.backtrace.first =~ /:(\d+)$/
+        line = $1.to_i
+      end
+      "%s from %s:%d" % [super(), @source, line]
+    end
+  end
+
   class Configuration
+    ValidationError = Fuguta::ValidationError
 
-    class ValidationError < StandardError
-      attr_reader :errors
-      def initialize(errors)
-        super("validation error")
-        @errors = errors
+    def self.usual_paths(paths = nil)
+      if paths
+        @usual_paths = paths
+      else
+        @usual_paths
       end
     end
 
+    def usual_paths
+      self.class.usual_paths
+    end
+
     def self.walk_tree(conf, &blk)
       raise ArgumentError, "conf must be a 'Configuration'. Got '#{conf.class}'." unless conf.is_a?(Configuration)
 
@@ -32,14 +66,20 @@ module Fuguta
         @conf = conf
       end
 
-      def load(path)
-        buf = String.new
-        case path
+      def load(path = nil)
+        buf = case path
+        when NilClass
+          raise "No path given and usual_paths not set" unless @conf.usual_paths
+
+          path = @conf.usual_paths.find { |path| File.exists?(path) } ||
+            raise("None of the usual paths existed: #{@conf.usual_paths.join(", ")}")
+
+          File.read(path)
         when String
           raise "does not exist: #{path}" unless File.exists?(path)
-          buf = File.read(path)
+          File.read(path)
         when IO
-          path.lines.each { |l| buf += l }
+          path.lines.join
         else
           raise "Unknown type: #{path.class}"
         end
@@ -92,7 +132,7 @@ module Fuguta
             l.load(File.expand_path(path, base_conf_dir))
           end
         }
-        
+
         self
       end
     end
@@ -224,7 +264,7 @@ module Fuguta
           end
         }
       end
-      
+
       def alias_param (alias_name, ref_name)
         # getter
         self.class_eval %Q{
@@ -295,9 +335,12 @@ module Fuguta
 
         l = Loader.new(c)
 
-        paths.each { |path|
-          l.load(path)
-        }
+        if paths.empty?
+          l.load
+        else
+          paths.each { |path| l.load(path) }
+        end
+
         l.validate
 
         c
@@ -380,6 +423,8 @@ module Fuguta
     def validate(errors)
     end
 
+    SYNTAX_ERROR_SOURCES=[ScriptError, NameError].freeze
+
     def parse_dsl(&blk)
       dsl = self.class.const_get(:DSL, false)
       raise "DSL module was not found" unless dsl && dsl.is_a?(Module)
@@ -388,7 +433,11 @@ module Fuguta
       cp_class.__send__(:include, dsl)
       cp = cp_class.new(self)
 
-      cp.instance_eval(&blk)
+      begin
+        cp.instance_eval(&blk)
+      rescue *SYNTAX_ERROR_SOURCES => e
+        raise Fuguta::SyntaxError.new(e, cp.instance_variable_get(:@loading_path))
+      end
 
       self
     end

data/lib/fuguta/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module Fuguta
-  VERSION='1.0.3'
+  VERSION='1.0.4'
 end

data/spec/conf_files/syntax-error.conf

@@ -0,0 +1,3 @@
+param1 1
+param2 1
+param3 1

data/spec/configuration_spec.rb

@@ -15,23 +15,64 @@ describe Fuguta::Configuration do
       end
     end
   end
-  
-  it "loads conf file" do
-    conf = Test1.load(File.expand_path('../test1.conf', __FILE__))
-    expect(conf.param1).to eq(1)
-    expect(conf.param2).to eq(2)
-  end
 
-  it "loads multiple conf files" do
-    conf = Test1.load(File.expand_path('../test1.conf', __FILE__), File.expand_path('../test2.conf', __FILE__))
-    expect(conf.param1).to eq(10)
-    expect(conf.param2).to eq(20)
+  class UsualPathTest < Test1
+    usual_paths([ "../test1.conf", "../conf_files/test1.conf" ].map do |path|
+      File.expand_path(path, __FILE__)
+    end)
   end
 
-  it "allows nested imports/loads" do
-    conf = NestTest1.load(File.expand_path('../nest-test1.conf', __FILE__))
-    expect(conf.param1).to eq(10)
-    expect(conf.param2).to eq(20)
-    expect(conf.param3).to eq(30)
+  describe "#load" do
+    let(:conf_path) { File.expand_path('../conf_files', __FILE__) }
+
+    it "allows nested imports/loads" do
+      conf = NestTest1.load("#{conf_path}/nest-test1.conf")
+      expect(conf.param1).to eq(10)
+      expect(conf.param2).to eq(20)
+      expect(conf.param3).to eq(30)
+    end
+
+    context "with a single path (string) parameter" do
+      it "loads conf file from that path" do
+        conf = Test1.load("#{conf_path}/test1.conf")
+        expect(conf.param1).to eq(1)
+        expect(conf.param2).to eq(2)
+      end
+    end
+
+    context "with multiple paths passed as parameters" do
+      it "the config files override each other" do
+        conf = Test1.load("#{conf_path}/test1.conf", "#{conf_path}/test2.conf")
+        expect(conf.param1).to eq(10)
+        expect(conf.param2).to eq(20)
+      end
+    end
+
+    context "with no arguments" do
+      context "when usual_paths is set" do
+        it "loads configurations from the first existing path set in usual_paths" do
+          conf = UsualPathTest.load
+          expect(conf.param1).to eq(1)
+          expect(conf.param2).to eq(2)
+        end
+      end
+
+      context "when usual_paths is not set" do
+        it "raises an error" do
+          expect { Test1.load }.to raise_error(
+            RuntimeError,
+            "No path given and usual_paths not set"
+          )
+        end
+      end
+    end
+
+    context 'when loading a config file with a faulty syntax' do
+      it "throws syntax error" do
+        expect {
+          Test1.load("#{conf_path}/syntax-error.conf")
+        }.to raise_error(Fuguta::SyntaxError)
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -8,4 +8,6 @@ require 'rspec'
 require 'fuguta'
 
 RSpec.configure do |config|
+  config.formatter = :documentation
+  config.color = true
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fuguta
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Axsh co. LTD
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-28 00:00:00.000000000 Z
+date: 2014-08-08 00:00:00.000000000 Z
 dependencies: []
 description: A configuration framework for Ruby programs
 email: 
@@ -24,11 +24,12 @@ files:
 - fuguta.gemspec
 - lib/fuguta.rb
 - lib/fuguta/version.rb
+- spec/conf_files/nest-test1.conf
+- spec/conf_files/syntax-error.conf
+- spec/conf_files/test1.conf
+- spec/conf_files/test2.conf
 - spec/configuration_spec.rb
-- spec/nest-test1.conf
 - spec/spec_helper.rb
-- spec/test1.conf
-- spec/test2.conf
 homepage: https://github.com/axsh/fuguta
 licenses:
 - LGPLv3