canfig 0.0.3 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 943269b9166513da09c866d6d4bae9e8bdb7f79c
-  data.tar.gz: d1988d15d10df3182c134075461db5640f0bd595
+SHA256:
+  metadata.gz: 28a747df13cf5c6c99fa96a201cb5f300b707a4642a63e5a65a943582a1fdde5
+  data.tar.gz: c917be14d97451e7615943952729ce00cc03b322c62536249a9a5859c88c63d0
 SHA512:
-  metadata.gz: 23d2195e6ae6b208e3a411b2de8904bef726a15c8dc5a4bf06f787fede78161485e3c24404655e63adf450d7fb0a8c7302453f87ee659d87ed171b2f7b39c2b0
-  data.tar.gz: d04944fa211c31db6f20df83f45824bf486c22de4568ce92b38860f875526edf197915d7619b6b07530948534c3449f747c423c6265c08e475eb90ff27de6444
+  metadata.gz: 4cf03ffeb05d41a42ef388d42013000cc62402befb390b1c188ac8a0acdda9c3e04fea5c63d47dd103258cedc5d36c9ce0d31ef14c079abbbd4842f4d5520589
+  data.tar.gz: 006e3e970b3aec9905abaa038bfca1f470f8b80ce6f8f2c743a729ebbf956d3a08425708d9aa0b486da58b6ea44178c69219c860edf40226bd999606d771aa1d

data/lib/canfig.rb

@@ -1,11 +1,20 @@
 require 'active_support/core_ext/array/extract_options'
 require 'active_support/core_ext/hash/keys'
+require 'active_support/inflector'
 require 'canfig/version'
+require 'canfig/yaml'
 require 'canfig/config'
 require 'canfig/open_config'
 require 'canfig/module'
 require 'canfig/class'
-require 'canfig/object'
+require 'canfig/instance'
 
 module Canfig
+  def self.new(*args, &block)
+    Canfig::Config.new *args, &block
+  end
+
+  def self.open(*args, &block)
+    Canfig::OpenConfig.new *args, &block
+  end
 end

data/lib/canfig/config.rb

@@ -1,18 +1,24 @@
 module Canfig
   class Config
 
-    def configure(argh={}, &block)
-      @options ||= {}
+    def configure(argh={}, file=nil, &block)
       save_state! do
+        configure_with_file file unless file.nil?
         configure_with_args argh
         configure_with_block &block
       end
       self
     end
 
+    def configure_with_file(file)
+      save_state! do
+        configure_with_args(Canfig::YAML.new(file).load)
+      end
+    end
+
     def configure_with_args(argh)
       save_state! do
-        argh.symbolize_keys.each { |key,val| configure_option(key, val) }
+        argh.symbolize_keys.each { |key,val| set(key, val) }
       end
     end
 
@@ -22,19 +28,44 @@ module Canfig
       end
     end
 
-    def configure_option(key, val)
-      raise ArgumentError, "#{key} is not an allowed configuration option" unless allowed?(key)
+    def set(key, val)
+      raise NoMethodError, "undefined method `#{key.to_s}=' for #{self.to_s}" unless allowed?(key)
+
+      save_state! do
+        @state[key] = val
+      end
+    end
+
+    def env(key, default=nil, &block)
+      val = ENV.fetch(key.to_s.underscore.upcase, default, &block)
+      val && ENV.key?(val) ? env(val, default, &block) : val
+    end
 
+    def clear(key)
       save_state! do
-        @changed[key] = [@options[key], val]
-        @options[key] = val
+        @state[key] = nil
       end
     end
 
+    def []=(key, val)
+      set key, val
+    end
+
+    def get(key, default=nil, &block)
+      raise NoMethodError, "undefined method `#{key.to_s}' for #{self.to_s}" unless allowed?(key)
+      @state[key] ||= env(key, default, &block)
+    end
+
+    def [](key)
+      get key
+    end
+
+    def to_h
+      Hash[@allowed.map { |key| [key, @state[key]] }]
+    end
+
     def changed
-      @changed = {}
-      @options.each { |key,val| @changed[key] = [@saved_state[key], val] if @saved_state[key] != val }
-      @changed
+      Hash[@allowed.map { |key| [key, [@saved_state[key], @state[key]]] if @saved_state[key] != @state[key] }.compact]
     end
 
     def changed?(key)
@@ -43,8 +74,7 @@ module Canfig
 
     def save_state!(&block)
       if save_state?
-        @saved_state = @options.dup
-        @changed = {}
+        @saved_state = to_h
 
         if block_given?
           disable_state_saves!
@@ -78,9 +108,9 @@ module Canfig
     def method_missing(meth, *args, &block)
       if meth.to_s.match(/=\Z/)
         opt = meth.to_s.gsub(/=/,'').to_sym
-        return configure_option(opt, args.first) if allowed?(meth)
+        return set(opt, args.first) if allowed?(opt)
       else
-        return @options[meth] if allowed?(meth)
+        return get(meth, *args, &block) if allowed?(meth)
       end
 
       super
@@ -90,7 +120,8 @@ module Canfig
 
     def initialize(*args, &block)
       options = args.extract_options!
-      @allowed = options.symbolize_keys.keys
+      @allowed = (args.map(&:to_sym) + options.symbolize_keys.keys).uniq
+      @state = {}
       enable_state_saves!
       configure options, &block
     end

data/lib/canfig/{object.rb → instance.rb}

@@ -1,11 +1,11 @@
 module Canfig
-  module Object
+  module Instance
     def configuration
       @configuration ||= Canfig::OpenConfig.new
     end
 
     def configure(&block)
-      @configuration.configure &block
+      configuration.configure &block
     end
   end
 end

data/lib/canfig/module.rb

@@ -3,7 +3,7 @@ require 'active_support/core_ext/module/attribute_accessors'
 module Canfig
   module Module
     def self.included(base)
-      base.send :cattr_reader, :configuration
+      base.send :mattr_reader, :configuration
       base.send :class_variable_set, :@@configuration, Canfig::OpenConfig.new
       base.send :extend, ClassMethods
     end

data/lib/canfig/open_config.rb

@@ -1,5 +1,10 @@
 module Canfig
   class OpenConfig < Config
+    def set(key, val)
+      super(key, val)
+      @allowed << key unless @allowed.include?(key)
+    end
+
     def allowed?(opt)
       true
     end

data/lib/canfig/version.rb

@@ -1,3 +1,3 @@
 module Canfig
-  VERSION = '0.0.3'
+  VERSION = '0.0.8'
 end

data/lib/canfig/yaml.rb

@@ -0,0 +1,25 @@
+module Canfig
+  class YAML
+    attr_reader :file
+
+    def initialize(file)
+      @file = file
+    end
+
+    def load
+      @data ||= ::YAML.load_file(file).symbolize_keys
+    end
+    alias_method :data, :load
+
+    def reload
+      @data = nil
+      self.load
+    end
+
+    def write
+      File.open(file, 'w') do |f|
+        f.write(::YAML.dump(data))
+      end
+    end
+  end
+end

data/spec/canfig/config_spec.rb

@@ -0,0 +1,222 @@
+require 'spec_helper'
+
+RSpec.describe Canfig::Config do
+  describe '#initialize' do
+    context 'when passed a list of keys' do
+      subject { Canfig::Config.new(:foo, :bar, :baz) }
+
+      it 'adds those keys to the allowed keys' do
+        expect(subject.allowed?(:foo)).to be_true
+        expect(subject.allowed?(:bar)).to be_true
+        expect(subject.allowed?(:baz)).to be_true
+      end
+    end
+
+    context 'when passed a hash of keys and values' do
+      subject { Canfig::Config.new(foo: 'foo', bar: 'bar', baz: 'baz') }
+
+      it 'adds those keys to the allowed keys' do
+        expect(subject.allowed?(:foo)).to be_true
+        expect(subject.allowed?(:bar)).to be_true
+        expect(subject.allowed?(:baz)).to be_true
+      end
+    end
+
+    context 'when passed a list of keys and a hash of keys and values' do
+      subject { Canfig::Config.new(:foo, :bar, baz: 'baz') }
+
+      it 'adds those keys to the allowed keys' do
+        expect(subject.allowed?(:foo)).to be_true
+        expect(subject.allowed?(:bar)).to be_true
+        expect(subject.allowed?(:baz)).to be_true
+      end
+    end
+  end
+
+  describe '#set' do
+    context 'when the key is allowed' do
+      subject { Canfig::Config.new(:foo) }
+
+      it 'sets the key/value pair' do
+        subject.set(:foo, 'bar')
+        expect(subject.get(:foo)).to eql('bar')
+      end
+    end
+
+    context 'when the key is not allowed' do
+      subject { Canfig::Config.new(:baz) }
+
+      it 'raises a NoMethodError' do
+        expect { subject.set(:foo, 'bar') }.to raise_exception(NoMethodError)
+      end
+    end
+  end
+
+  describe '#get' do
+    context 'when the key is allowed' do
+      subject { Canfig::Config.new(:baz, foo: 'bar') }
+
+      it 'returns the corresponding value' do
+        expect(subject.get(:foo)).to eql('bar')
+      end
+
+      context 'when the key is not set' do
+        it 'returns nil' do
+          expect(subject.get(:baz)).to be_nil
+        end
+      end
+    end
+
+    context 'when the key is not allowed' do
+      subject { Canfig::Config.new(:baz) }
+
+      it 'raises a NoMethodError' do
+        expect { subject.get(:foo) }.to raise_exception(NoMethodError)
+      end
+    end
+  end
+
+  describe '#to_h' do
+    subject { Canfig::Config.new(:foo, bar: 'bar', baz: 'baz') }
+
+    it 'returns a hash' do
+      expect(subject.to_h).to be_an_instance_of(Hash)
+    end
+
+    it 'contain all allowed keys' do
+      [:foo, :bar, :baz].each do |key|
+        expect(subject.to_h.keys).to include(key)
+      end
+    end
+  end
+
+  describe '#configure_with_args' do
+    subject { Canfig::Config.new(:foo, bar: 'bar', baz: 'baz') }
+
+    context 'when the passed keys are allowed' do
+      it 'sets the key/value pairs passed the hash' do
+        subject.configure_with_args({foo: 1, bar: 2})
+        expect(subject.get(:foo)).to eql(1)
+        expect(subject.get(:bar)).to eql(2)
+      end
+    end
+
+    context 'when the passed keys are not allowed' do
+      it 'raises a NoMethodError' do
+        expect { subject.configure_with_args({abc: '123'}) }.to raise_exception(NoMethodError)
+      end
+    end
+  end
+
+  describe '#configure_with_block' do
+    subject { Canfig::Config.new(:foo, bar: 'bar', baz: 'baz') }
+
+    it 'accepts a block' do
+      expect { subject.configure_with_block { |config| } }.to_not raise_exception
+    end
+
+    it 'executes the block with instance_eval' do
+      conf = nil
+      subject.configure_with_block { |config| conf = config }
+      expect(conf).to eql(subject)
+    end
+  end
+
+  describe '#configure' do
+    subject { Canfig::Config.new(:foo, bar: 'bar', baz: 'baz') }
+
+    it 'returns self' do
+      expect(subject.configure).to eql(subject)
+    end
+
+    it 'accepts a hash and a block' do
+      subject.configure foo: 'foo' do |config|
+        config.bar = 'baz'
+        config.baz = 'bar'
+      end
+
+      expect(subject.get(:foo)).to eql('foo')
+      expect(subject.get(:bar)).to eql('baz')
+      expect(subject.get(:baz)).to eql('bar')
+    end
+  end
+
+  context 'when referencing option keys' do
+    subject { Canfig::Config.new(:foo, bar: 'bar', baz: 'baz') }
+
+    context 'that are allowed' do
+      context 'using getter methods' do
+        it 'returns the value' do
+          expect(subject.bar).to eql('bar')
+        end
+      end
+
+      context 'using setter methods' do
+        it 'sets the passed value to the key' do
+          subject.bar = 'foo'
+          expect(subject.bar).to eql('foo')
+        end
+      end
+    end
+
+    context 'that are not allowed' do
+      context 'using getter methods' do
+        it 'returns the value' do
+          expect { subject.abc }.to raise_exception(NoMethodError)
+        end
+      end
+
+      context 'using setter methods' do
+        it 'sets the passed value to the key' do
+          expect { subject.abc = 123 }.to raise_exception(NoMethodError)
+        end
+      end
+    end
+  end
+
+  context 'when saving state' do
+    subject { Canfig::Config.new(:foo, bar: 'bar', baz: 'baz') }
+
+    describe '#changed' do
+      it 'returns a hash' do
+        subject.configure do |config|
+          config.foo = 'test'
+          config.bar = 1
+        end
+
+        expect(subject.changed).to be_an_instance_of(Hash)
+      end
+
+      it 'contains the changed keys' do
+        subject.configure do |config|
+          config.foo = 'test'
+          config.bar = 1
+        end
+
+        [:foo, :bar].each do |key|
+          expect(subject.changed.keys).to include(key)
+        end
+      end
+
+      it 'contains only the changed keys' do
+        subject.configure do |config|
+          config.foo = 'test'
+          config.bar = 1
+        end
+
+        expect(subject.changed.keys).to_not include(:baz)
+      end
+
+      it 'contains the old and new values' do
+        subject.configure do |config|
+          config.foo = 'test'
+          config.bar = 1
+        end
+
+        expect(subject.changed[:foo]).to eql([nil,'test'])
+        expect(subject.changed[:bar]).to eql(['bar',1])
+      end
+    end
+  end
+
+end

data/spec/canfig/open_config_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+RSpec.describe Canfig::OpenConfig do
+  describe '#to_h' do
+    subject { Canfig::OpenConfig.new() }
+
+    it 'returns a hash' do
+      expect(subject.to_h).to be_an_instance_of(Hash)
+    end
+
+    it 'contain all set keys' do
+      subject.set :foo, 'foo'
+      subject.set :bar, 'bar'
+      subject.set :baz, 'baz'
+      [:foo, :bar, :baz].each do |key|
+        expect(subject.to_h.keys).to include(key)
+      end
+    end
+  end
+end

data/spec/canfig/yaml_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+RSpec.describe Canfig::YAML do
+  subject { described_class.new('spec/fixtures/config.yml') }
+
+  describe '#load' do
+    it 'loads the file into a hash' do
+      expect(subject.load).to be_a(Hash)
+    end
+  end
+
+  describe '#write' do
+    subject { described_class.new('spec/fixtures/test.yml') }
+
+    before do
+      FileUtils.cp 'spec/fixtures/config.yml', 'spec/fixtures/test.yml'
+    end
+
+    it 'writes the hash back to the file in YAML' do
+      subject.data[:foo] = 'bar'
+      subject.write
+      subject.reload
+      expect(subject.data[:foo]).to eq('bar')
+    end
+
+    after do
+      FileUtils.rm 'spec/fixtures/test.yml'
+    end
+  end
+
+  describe '#reload' do
+    it 'reloads the data from the file' do
+      subject.data[:foo] = 'bar'
+      subject.reload
+      expect(subject.data[:foo]).to eq('foo')
+    end
+  end
+end

data/spec/canfig_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+RSpec.describe Canfig do
+  describe '.new' do
+    it 'returns a configuration object' do
+      expect(subject.new).to be_an_instance_of(Canfig::Config)
+    end
+  end
+
+  describe '.open' do
+    it 'returns an open configuration object' do
+      expect(subject.open).to be_an_instance_of(Canfig::OpenConfig)
+    end
+  end
+end

data/spec/fixtures/config.yml

@@ -0,0 +1,3 @@
+foo: 'foo'
+bar: 'bar'
+baz: 'baz'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canfig
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.8
 platform: ruby
 authors:
 - Mark Rebec
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-05-21 00:00:00.000000000 Z
+date: 2020-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -62,15 +62,21 @@ files:
 - lib/canfig.rb
 - lib/canfig/class.rb
 - lib/canfig/config.rb
+- lib/canfig/instance.rb
 - lib/canfig/module.rb
-- lib/canfig/object.rb
 - lib/canfig/open_config.rb
 - lib/canfig/version.rb
+- lib/canfig/yaml.rb
+- spec/canfig/config_spec.rb
+- spec/canfig/open_config_spec.rb
+- spec/canfig/yaml_spec.rb
+- spec/canfig_spec.rb
+- spec/fixtures/config.yml
 - spec/spec_helper.rb
 homepage: http://github.com/markrebec/canfig
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -85,10 +91,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Dead simple canned configuration for gems or whatever
 test_files:
 - spec/spec_helper.rb
+- spec/fixtures/config.yml
+- spec/canfig/config_spec.rb
+- spec/canfig/open_config_spec.rb
+- spec/canfig/yaml_spec.rb
+- spec/canfig_spec.rb