canfig 0.0.4 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ac2beb0c3075dc310f01561ffded475028a3bbb8
-  data.tar.gz: 235d02c3dd6a3cb91f65b34780d359f13c602d78
+SHA256:
+  metadata.gz: cb0af652bc6aced0a5a7be703c93267bbef555c28f821c565c9c5b14f93b6d20
+  data.tar.gz: cb3541d3ca774f5f7a331f75238ecef6231b62be3776b50ae52cac3b12182c6b
 SHA512:
-  metadata.gz: 373862b787b95c189ecee41b186a3e8ad64cab9cb64d0985f645e029c1a0ed1cf5b7fac8228bccd060d03e7306d330820432bd1fbe140d0922b24f0a8f4a9575
-  data.tar.gz: 4a65de2f0f811ac061e26079faaa4144a8dd735532d3f7192db926edf2063489619ecf0b8d903b1666bca818dded1774aa84ffa4a11c2612542e7d80ec0ef13b
+  metadata.gz: aab3a3c345efea85b20c75e8aec11ccd62baab19e8dcfa5b5870406a2731e6894311a21273b10cfea3476f037185b300e862e027a19bf8314fbb9300054d2b78
+  data.tar.gz: ebc54005799b649dbecc527bd30f6bbad0149ad4fc022b2998323b0fe6b7888df12ffc1050a9884caee2ee14e30093f315408ed08e657b4e3a8dc657e3449459

data/lib/canfig.rb

@@ -1,11 +1,21 @@
 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/env_config'
 require 'canfig/module'
 require 'canfig/class'
 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,14 +1,21 @@
 module Canfig
   class Config
 
-    def configure(argh={}, &block)
+    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| set(key, val) }
@@ -29,13 +36,24 @@ module Canfig
       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(*keys)
+      save_state! do
+        keys.each { |key| @state[key] = nil }
+      end
+    end
+
     def []=(key, val)
       set key, val
     end
 
-    def get(key)
+    def get(key, default=nil, &block)
       raise NoMethodError, "undefined method `#{key.to_s}' for #{self.to_s}" unless allowed?(key)
-      @state[key]
+      @state[key] ||= env(key, default, &block)
     end
 
     def [](key)
@@ -47,7 +65,7 @@ module Canfig
     end
 
     def changed
-      Hash[@state.map { |key,val| [key, [@saved_state[key], val]] if @saved_state[key] != val }.compact]
+      Hash[@allowed.map { |key| [key, [@saved_state[key], @state[key]]] if @saved_state[key] != @state[key] }.compact]
     end
 
     def changed?(key)
@@ -92,7 +110,7 @@ module Canfig
         opt = meth.to_s.gsub(/=/,'').to_sym
         return set(opt, args.first) if allowed?(opt)
       else
-        return @state[meth] if allowed?(meth)
+        return get(meth, *args, &block) if allowed?(meth)
       end
 
       super
@@ -100,9 +118,8 @@ module Canfig
 
     protected
 
-    def initialize(*args, &block)
-      options = args.extract_options!
-      @allowed = (args + options.symbolize_keys.keys).uniq.map(&:to_sym)
+    def initialize(*args, **options, &block)
+      @allowed = (args.map(&:to_sym) + options.symbolize_keys.keys).uniq
       @state = {}
       enable_state_saves!
       configure options, &block

data/lib/canfig/env_config.rb

@@ -0,0 +1,20 @@
+module Canfig
+  class EnvConfig < OpenConfig
+    attr_reader :namespace
+
+    def initialize(namespace=nil, **options, &block)
+      @namespace = namespace ? "#{namespace.to_s.underscore.upcase.gsub(/_$/, '')}_" : namespace
+      super(**options, &block)
+    end
+
+    def set(key, val)
+      raise NotImplementedError, "You cannot set values on a Canfig::EnvConfig"
+    end
+
+    def env(key, default=nil, &block)
+      key = key.to_s.underscore.upcase
+      key = key.gsub(/^#{namespace}/, '') if namespace
+      super("#{namespace}#{key}", default, &block)
+    end
+  end
+end

data/lib/canfig/instance.rb

@@ -5,7 +5,7 @@ module Canfig
     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,11 +1,12 @@
 module Canfig
   class OpenConfig < Config
-    def allowed?(opt)
-      true
+    def set(key, val)
+      @allowed << key unless @allowed.include?(key)
+      super(key, val)
     end
 
-    def to_h
-      @state.to_h
+    def allowed?(opt)
+      true
     end
   end
 end

data/lib/canfig/version.rb

@@ -1,3 +1,3 @@
 module Canfig
-  VERSION = '0.0.4'
+  VERSION = '0.0.9'
 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/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

@@ -1,4 +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.4
+  version: 0.0.9
 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,18 +62,22 @@ files:
 - lib/canfig.rb
 - lib/canfig/class.rb
 - lib/canfig/config.rb
+- lib/canfig/env_config.rb
 - lib/canfig/instance.rb
 - lib/canfig/module.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
@@ -88,13 +92,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
-- spec/spec_helper.rb