figleaf 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ebc37827cd68fb9d931fa327581d19acd47a2c02
-  data.tar.gz: 7f5c2050291f1ead028c57e98febeba9329fbe97
+  metadata.gz: d23035213f0420e9f22c4cb80640be461b048781
+  data.tar.gz: 71e650d1680977aa5353e1a60d71a52e44003ca1
 SHA512:
-  metadata.gz: 73bc054a55de88db693d019a84d816e5a6e2adf40d76b8fcbba5484a49d79e0afc36fddada3e9d72bd1ff6e2797844c193f765cdd482d7166656f8d424f8d34e
-  data.tar.gz: 452291366fe8950e631cf4a0c77c8da558e68291b904481e9df10b3abf797656d0b31b86640a5b95c280b9ea7882a45b300065c8cf39d9449ced1493ad9262b9
+  metadata.gz: abad1d584376dc35bfbdf421fd7969e7ab9fa731748e825237da18a961e5507a8c3fb859d2784612a719ac0645f313fdacbcabd79871f8bd4fbffe0b715817e2
+  data.tar.gz: 89742c7aad92c275d11e5b5e4aacb393de330a8b11cf9e3baf602398302f93bd5cc46f253c73da9623e12f13b1a34aa469e9563893795548134e45d9107a9722

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Change Log
 
+## 0.2.6 (2017/09/28)
+Add ability to write config files in ruby
+
 ## 0.2.5 (2017/09/28)
 Add support for `default` options
 

data/lib/figleaf/config.rb

@@ -0,0 +1,55 @@
+module Figleaf
+  # Convert a ruby block to nested hash
+  class Config
+    def initialize
+      @property = LazyBlockHash.new
+    end
+
+    def call(&block)
+      instance_eval(&block)
+
+      property
+    end
+
+    def method_missing(method_name, *args, &block)
+      process_method(method_name, *args, &block)
+    end
+
+    def test(&block)
+      process_method(:test, [], &block)
+    end
+
+    def process_method(method_name, *args, &block)
+      @property[method_name.to_s] =
+        if block_given?
+          obj = self.class.new
+          Proc.new { obj.call(&block) }
+        else
+          if args.count == 1
+            args[0]
+          else
+            args
+          end
+        end
+    end
+
+    def respond_to_missing?(method_name, *args)
+      true
+    end
+
+    private
+
+      attr_reader :property
+  end
+
+  class LazyBlockHash < Hash
+    def [](attr)
+      val = super(attr)
+      if val.is_a?(Proc)
+        val.call
+      else
+        val
+      end
+    end
+  end
+end

data/lib/figleaf/settings.rb

@@ -1,6 +1,7 @@
 module Figleaf
   class Settings
     InvalidYAML = Class.new(RuntimeError)
+    InvalidRb = Class.new(RuntimeError)
 
     class_attribute :auto_define
     self.auto_define = false
@@ -41,12 +42,7 @@ module Figleaf
       def load_settings(file_pattern = default_file_pattern, env_to_load = env)
         configure_with_auto_define do
           Dir.glob(file_pattern).each do |file|
-            property_name = File.basename(file, '.yml')
-            yaml_hash     = load_file(file) or next
-            default       = yaml_hash["default"]
-            property      = yaml_hash[env_to_load]
-
-            property = default.merge(property) if !default.nil?
+            property_name, property = load_file(file, env_to_load)
 
             next if property.nil?
 
@@ -61,10 +57,34 @@ module Figleaf
         end
       end
 
-      def load_file(file_path, env = nil)
-        property = YAML.load(ERB.new(IO.read(file_path)).result)
-        property = property[env] if env
-        use_hashie_if_hash(property)
+      def load_file(file, env_to_load = env)
+        if file.end_with?('.rb')
+          property_name = File.basename(file, '.rb')
+          config = load_rb_file(file) or return nil
+        else
+          property_name = File.basename(file, '.yml')
+          config = load_yaml_file(file) or return nil
+        end
+
+        return if config.nil?
+
+        default = config["default"]
+        property = config[env_to_load]
+        property = default.merge(property) if !default.nil?
+
+        [property_name, use_hashie_if_hash(property)]
+      end
+
+      def load_rb_file(file_path, env = nil)
+        contents = File.read(file_path)
+        block = ->(*) { eval contents }
+        Config.new.call(&block)
+      rescue SyntaxError => e
+        raise InvalidRb, "#{file_path} has invalid Ruby\n" + e.message
+      end
+
+      def load_yaml_file(file_path)
+        YAML.load(ERB.new(IO.read(file_path)).result)
       rescue Psych::SyntaxError => e
         raise InvalidYAML, "#{file_path} has invalid YAML\n" + e.message
       end
@@ -75,7 +95,8 @@ module Figleaf
       end
 
       def default_file_pattern
-        root.join('config/settings/*.yml')
+        root.join('config/settings/*.yml') +
+          root.join('config/settings/*.rb')
       end
 
       def env

data/lib/figleaf/version.rb

@@ -1,3 +1,3 @@
 module Figleaf
-  VERSION = '0.2.5'
+  VERSION = '0.2.6'
 end

data/lib/figleaf.rb

@@ -8,9 +8,8 @@ require 'yaml'
 require 'erb'
 
 module Figleaf
+  autoload :Config, 'figleaf/config'
   autoload :Fighash, 'figleaf/fighash'
-  autoload :Configuration, 'figleaf/configuration'
-  autoload :LoadSettings, 'figleaf/load_settings'
   autoload :Settings, 'figleaf/settings'
   autoload :VERSION, 'figleaf/version'
 end

data/spec/figleaf/config_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+module Figleaf
+  RSpec.describe Config do
+    let(:code) do
+      proc do
+        setting_set_on_root "bar"
+
+        default do
+          foo "bar"
+          bar "baz"
+        end
+
+        production do
+          env "foo"
+        end
+
+        failer do
+          raise "Hello"
+        end
+
+        test do
+          foo "testbar"
+        end
+      end
+    end
+
+    subject(:config) { described_class.new }
+
+    describe "#call" do
+      subject(:called) { config.call(&code) }
+      it "stores first level keywords as keys" do
+        expect(called.keys).to contain_exactly(*%w(
+          default
+          failer
+          production
+          setting_set_on_root
+          test
+        ))
+      end
+
+      it "expands default" do
+        expect(called["default"]).to eq(
+          "foo" => "bar",
+          "bar" => "baz"
+        )
+      end
+
+      it "expands test" do
+        expect(called["test"]).to eq(
+          "foo" => "testbar"
+        )
+      end
+
+      it "only raises when evaluating 'failer'" do
+        expect { called["failer"] }.to raise_error(RuntimeError)
+      end
+    end
+  end
+end

data/spec/figleaf/settings_spec.rb

@@ -1,28 +1,6 @@
 require 'spec_helper'
 
 describe Figleaf::Settings do
-
-  describe "self.load_file" do
-    before do
-      @fixture_path = File.expand_path("../../fixtures/service.yml", __FILE__)
-    end
-
-    it "converts file settings from given env" do
-      settings = described_class.load_file(@fixture_path, "test")
-      expect(settings.foo).to eq("bar")
-    end
-
-    it "allows env to be optional" do
-      settings = described_class.load_file(@fixture_path)
-      expect(settings.test.foo).to eq("bar")
-    end
-
-    it "returns nil for missing env" do
-      settings = described_class.load_file(@fixture_path, "foo")
-      expect(settings).to eq(nil)
-    end
-  end
-
   describe "self.load_settings" do
     before do
       @fixtures_path = File.expand_path("../../fixtures/*.yml", __FILE__)
@@ -74,17 +52,28 @@ describe Figleaf::Settings do
     end
 
     it "raise exception when loading an undefined value" do
-      YAML.stub(:load_file).and_return({ "test" => {} })
+      YAML.stub(:load_yaml_file).and_return({ "test" => {} })
       described_class.load_settings
       expect { described_class.service.blah }.to raise_error NoMethodError
     end
 
     context "with bad files" do
-      let(:overload) { File.expand_path("../../fixtures/errors/*.yml", __FILE__) }
+      context "yaml" do
+        let(:overload) { File.expand_path("../../fixtures/errors/*.yml", __FILE__) }
 
-      it "reports the file that has errors" do
-        expect { described_class.load_settings(overload, "test") }.
-          to raise_error(described_class::InvalidYAML)
+        it "reports the file that has errors" do
+          expect { described_class.load_settings(overload, "test") }.
+            to raise_error(described_class::InvalidYAML)
+        end
+      end
+
+      context "rb" do
+        let(:overload) { File.expand_path("../../fixtures/errors/*.rb", __FILE__) }
+
+        it "reports the file that has errors" do
+          expect { described_class.load_settings(overload, "test") }.
+            to raise_error(described_class::InvalidRb)
+        end
       end
     end
 
@@ -127,17 +116,58 @@ describe Figleaf::Settings do
 
     context "using default as a YAML anchor is OK" do
       before do
-        default = File.expand_path("../../fixtures/extra/default_anchor.yml", __FILE__)
-        described_class.load_settings(default, "test")
+        default_anchor = File.expand_path("../../fixtures/extra/default_anchor.yml", __FILE__)
+        described_class.load_settings(default_anchor, "test")
       end
 
       it "overrides values" do
-        expect(described_class.default.foo).to eq("overriden")
+        expect(described_class.default_anchor.foo).to eq("overriden")
       end
 
-      it "respects values set in default" do
-        expect(described_class.default.bar).to eq("baz")
+      it "respects values set in default_anchor" do
+        expect(described_class.default_anchor.bar).to eq("baz")
       end
     end
   end
+
+  context "load ruby files" do
+    before do
+      fixtures_path = File.expand_path("../../fixtures/extra/*.rb", __FILE__)
+      described_class.load_settings(fixtures_path, "test")
+    end
+
+    it "load indifferently the key names" do
+      expect(described_class.code["foo"]).to eq("bar")
+      expect(described_class.code[:foo]).to eq("bar")
+    end
+
+    it "create foo as a method" do
+      expect(described_class.code.foo).to eq("bar")
+    end
+
+    it "create bool_true? and return true" do
+      expect(described_class.code.bool_true?).to eq(true)
+    end
+
+    it "create bool_false? and return false" do
+      expect(described_class.code.bool_false?).to eq(false)
+    end
+
+    it "work for array as well", :aggregate_failures do
+      expect(described_class.code.array).to eq([1, 2, 3, 4])
+      expect(described_class.code.array_alt).to eq([1, 2, 3, 4])
+    end
+
+    it "and for boolean (true)" do
+      expect(described_class.code.bool_true).to eq(true)
+    end
+
+    it "and for boolean (false)" do
+      expect(described_class.code.bool_false).to eq(false)
+    end
+
+    it "and for ENV values" do
+      expect(described_class.code.from_env).to eq('foo')
+    end
+  end
 end

data/spec/fixtures/errors/bad_file.rb

@@ -0,0 +1 @@
+begin

data/spec/fixtures/extra/code.rb

@@ -0,0 +1,21 @@
+default do
+  foo "bar"
+  bar "baz"
+end
+
+production do
+  env "foo"
+end
+
+dev_int do
+  bar "baz"
+end
+
+test do
+  foo "bar"
+  bool_true true
+  bool_false false
+  array 1, 2, 3, 4
+  array_alt [1, 2, 3, 4]
+  from_env ENV['FIGLEAF_TEST_FOO']
+end

data/spec/spec_helper.rb

@@ -9,7 +9,6 @@ require "figleaf"
 
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: figleaf
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Juan C. Müller
@@ -57,18 +57,22 @@ files:
 - Rakefile
 - figleaf.gemspec
 - lib/figleaf.rb
+- lib/figleaf/config.rb
 - lib/figleaf/fighash.rb
 - lib/figleaf/settings.rb
 - lib/figleaf/version.rb
+- spec/figleaf/config_spec.rb
 - spec/figleaf/configuration_spec.rb
 - spec/figleaf/fighash_spec.rb
 - spec/figleaf/settings_spec.rb
 - spec/fixtures/array.yml
 - spec/fixtures/boolean.yml
 - spec/fixtures/erb.yml
+- spec/fixtures/errors/bad_file.rb
 - spec/fixtures/errors/bad_file.yml
 - spec/fixtures/extra/array.yml
 - spec/fixtures/extra/boolean.yml
+- spec/fixtures/extra/code.rb
 - spec/fixtures/extra/default.yml
 - spec/fixtures/extra/default_anchor.yml
 - spec/fixtures/extra/service.yml
@@ -99,15 +103,18 @@ signing_key:
 specification_version: 4
 summary: YAML based DRY settings manager.
 test_files:
+- spec/figleaf/config_spec.rb
 - spec/figleaf/configuration_spec.rb
 - spec/figleaf/fighash_spec.rb
 - spec/figleaf/settings_spec.rb
 - spec/fixtures/array.yml
 - spec/fixtures/boolean.yml
 - spec/fixtures/erb.yml
+- spec/fixtures/errors/bad_file.rb
 - spec/fixtures/errors/bad_file.yml
 - spec/fixtures/extra/array.yml
 - spec/fixtures/extra/boolean.yml
+- spec/fixtures/extra/code.rb
 - spec/fixtures/extra/default.yml
 - spec/fixtures/extra/default_anchor.yml
 - spec/fixtures/extra/service.yml