konfa 0.3.1 → 0.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '019c8e91eccb651e1797bd4f14936e7e993d90cf41da39315c0756a6f9edc337'
+  data.tar.gz: b9cd987595b57b4747dc147f565f91fa435669ca0b84db275f2f69ff5c6b9f41
+SHA512:
+  metadata.gz: 28ec3dd4747fd0f64f2ea7cca123b014a31701d2667ada2240f2a5dbc319ba21321bf2e25d2dc92a85f2bc5246ca2fd5d9d9e1453daa26decc4e4a1d3099e713
+  data.tar.gz: 4d94c094df739eea1c0f90b82f0329f95cba20f2048500216a5eaafd6878c5841f575697c84f80196e15548b780f4861b92d43c5dc6a3398def760b0c5fae66a

data/lib/konfa.rb

@@ -1,29 +1,48 @@
-# -*- coding: utf-8 -*-
-require 'yaml'
+require_relative File.join(File.dirname(__FILE__), 'konfa', 'initializer')
+require_relative File.join(File.dirname(__FILE__), 'konfa', 'deprecation')
 
 module Konfa
   class Base
+    include Konfa::Initializer
+    include Konfa::Deprecation
+
     class << self
+
+      private
+
+      def default_values
+        self.allowed_variables.each do |key, value|
+          if !value.nil? && !value.kind_of?(String)
+            deprecated "[DEPRECATION] default value for #{key} will be automatically stringified in future versions"
+          end
+        end
+
+        self.allowed_variables
+      end
+
       protected
 
       #
-      # The following methods are not a part of the public API. You may sublcass
+      # The following methods are not a part of the public API. You may subclass
       # them, but remember that unless you scope them as protected or private,
       # they will then be public
       #
 
-      attr_writer :configuration, :deferred, :initialized_deferred
+      attr_writer :configuration, :initializer, :initialized
 
-      def initialized_deferred
-        @initialized_deferred ||= false
+      # [DEPRECATED] This method will be removed in favor of initialized? in Konfa 1.0
+      def initialized
+        @initialized ||= false
       end
 
       def configuration
-        @configuration ||= self.allowed_variables
+        self.init
+        @configuration ||= default_values
       end
 
-      def deferred
-        @deferred ||= nil
+      # [DEPRECATED] This attribute will be removed in Konfa 1.0
+      def initializer
+        @initializer ||= nil
       end
 
       def truthy?(value)
@@ -39,11 +58,6 @@ module Konfa
         end
       end
 
-      def do_deferred_initialization
-        self.send(self.deferred.first, *self.deferred[1..-1])
-        self.initialized_deferred = true
-      end
-
       public
 
       #
@@ -63,20 +77,20 @@ module Konfa
         raise UnsupportedVariableError.new(key)
       end
 
-      def do_deferred_initialization?
-        !self.initialized_deferred && !self.deferred.nil?
-      end
-
       #
       # The following methods provides the interface to this class
       #
 
       def get(variable)
-        self.do_deferred_initialization if self.do_deferred_initialization?
         raise UnsupportedVariableError.new(variable) unless self.configuration.has_key? variable
         self.configuration[variable]
       end
 
+      def get!(variable)
+        raise NilVariableError.new(variable) if self.get(variable).nil?
+        self.get(variable)
+      end
+
       def true?(variable)
         self.truthy?(self.get(variable))
       end
@@ -93,8 +107,51 @@ module Konfa
         self.configuration.dup
       end
 
-      def initialize_deferred(method, *args)
-        self.deferred = [method, *args]
+      def init?
+        deprecated "[DEPRECATION] init? will be removed in Konfa 1.0, use initialized? instead"
+        !self.initialized && !self.initializer.nil?
+      end
+
+      def init
+        deprecated "[DEPRECATION] This style of initialization will no longer be supported in Konfa 1.0 and init "\
+                   "will be removed. Use initialize! or read_from/initialized! instead"
+        return unless self.init?
+        # Set to true before calling to prevent recursion if
+        # an initializer is accessing the configuration
+        self.initialized = true
+        self.send(self.initializer.first, *self.initializer[1..-1])
+        self.after_initialize
+      end
+
+      def init_with(suffix, *args)
+        deprecated "[DEPRECATION] init will be removed in Konfa 1.0. Use read_from instead"
+        self.initializer = [:"init_with_#{suffix}", *args]
+        self
+      end
+
+      def reinit
+        deprecated "[DEPRECATION] reinit will be removed in Konfa 1.0. Use read_from to load multiple config files"
+        self.initialized = false
+      end
+
+      def read_from(initializer, *args)
+        raise AlreadyInitializedError if self.initialized?
+        raise UnsupportedInitializerError unless self.respond_to?(:"init_with_#{initializer}")
+
+        self.send(:"init_with_#{initializer}", *args)
+        self
+      end
+
+      def initialize!
+        raise AlreadyInitializedError if self.initialized?
+
+        @initialized = true
+        self.after_initialize
+        self
+      end
+
+      def initialized?
+        @initialized == true
       end
 
       def after_initialize
@@ -113,46 +170,11 @@ module Konfa
         result
       end
 
-      # FIXME: Move out to external package
-      def initialize_from_yaml(path)
-        # FIXME: It would be a lot cleaner if the YAML library would raise an
-        # exception if it fails to read the file. We'll handle it like this for now
-        # load_file just returns "false" if it fails
-        yaml_data = YAML.load_file(path)
-
-        unless yaml_data.nil?
-          raise InitializationError.new("Bad YAML format, key/value pairs expected") unless yaml_data.kind_of?(Hash)
-
-          yaml_data.each do |variable, value|
-            self.store(variable, value)
-          end
-        end
-
-        after_initialize
-        dump
-      end
-
-      # FIXME: Move out to external package
-      def initialize_from_env
-        conf_prefix = self.env_variable_prefix.upcase
-
-        ENV.keys.reject { |key|
-          key !~ /^#{conf_prefix}/ # Ignore everything that doesn't match the prefix
-        }.each { |key|
-          variable = key[conf_prefix.size..-1].downcase
-
-          self.store(variable, ENV[key])
-        }
-
-        after_initialize
-        dump
-      end
     end
   end
 
-  class InitializationError < StandardError
-  end
-
-  class UnsupportedVariableError < StandardError
-  end
+  class UnsupportedInitializerError < StandardError; end
+  class AlreadyInitializedError < StandardError; end
+  class UnsupportedVariableError < StandardError; end
+  class NilVariableError < StandardError; end
 end

data/lib/konfa/autodoc.rb

@@ -0,0 +1,8 @@
+require 'konfa/autodoc/parser'
+require 'konfa/autodoc/formatter'
+require 'konfa/autodoc/markdown'
+
+module Konfa
+  module AutoDoc
+  end
+end

data/lib/konfa/autodoc/formatter.rb

@@ -0,0 +1,24 @@
+module Konfa
+  module AutoDoc
+    class Formatter
+      attr_reader :konfa_class
+      attr_accessor :version
+
+      def initialize(const, version=nil)
+        @konfa_class = const
+        @version = version
+      end
+
+      def generate
+        autodoc = Konfa::AutoDoc::Parser.new(@konfa_class)
+        format(autodoc.parse)
+      end
+
+      def format(variables)
+        raise ImplementationMissing.new
+      end
+
+      class ImplementationMissing < StandardError; end
+    end
+  end
+end

data/lib/konfa/autodoc/markdown.rb

@@ -0,0 +1,24 @@
+module Konfa
+  module AutoDoc
+    class Markdown < Formatter
+      def format(variables)
+        md_lines  = [header(konfa_class.name)]
+        md_lines << "*Version: #{version}*" unless version.nil?
+
+        variables.each do |variable|
+          md_lines << header(variable.name, 2)
+          md_lines << "Default: *#{variable.default}*"
+          md_lines << variable.comment unless variable.comment.nil?
+        end
+
+        md_lines.join("\n\n")
+      end
+
+      private
+
+      def header(text, level=1)
+        "#{'#' * level} #{text}"
+      end
+    end
+  end
+end

data/lib/konfa/autodoc/parser.rb

@@ -0,0 +1,66 @@
+require "method_source"
+
+module Konfa
+  module AutoDoc
+
+    Variable = Struct.new(:name, :default, :comment)
+
+    class Parser
+      attr_reader :variables, :konfa_class
+
+      def initialize(const)
+        @variables = []
+        @konfa_class = const
+      end
+
+      RE_VAR = /
+        (?:
+          :(\w+)\s*=>           # 0: Old style hash key declaration - :key => 'value'
+          |                     #   - or -
+          (\w+):                # 1: New style hash key declaration - key: 'value'
+        )
+        \s*
+        (?:
+          (?:'|")(.+?)(?:'|")   # 2: A string constant (FIXME: unless Backrefs to match leading and tailing quote)
+          |                     #   - or -
+          ([\w\@\:\.]+)         # 3: Bareword
+        )
+        \s*
+        ,?                      #   - an optional comma -
+        \s*
+        (?:
+          \#\s*(.+?)            # 4: An optional comment
+          (?=\n\s*(?:           #  Match all lines to next entry,
+             :\w+\s*=>          #  or end of hash declaraion. The lookahead
+            |\}                 #  ensures we do not gobble up string for next match
+            |\w+:
+          ))
+        )?
+      /xm
+
+      def parse
+        @variables = []
+        code = @konfa_class.method(:allowed_variables).source
+        code.scan(RE_VAR).each do |tokens|
+          @variables << Variable.new(
+            tokens[0] || tokens[1],
+            tokens[2] || tokens[3],
+            trim_comment(tokens[4])
+          )
+        end
+
+        variables
+      end
+
+      private
+
+      def trim_comment(comment)
+        unless comment.nil?
+          comment.gsub!(/^\s*|\s*$/x, "")     # The ^ and $ rather than \A and \Z anchors are intentional
+          comment.gsub!(/\n\#\s*/x, " ")      # Not sure if we should perserve line breaks. We currenty do not. Can be fixed by using a zero width look-behind
+        end
+        comment
+      end
+    end
+  end
+end

data/lib/konfa/autodoc/rspec.rb

@@ -0,0 +1,45 @@
+module Konfa
+  module AutoDoc
+    module RSpec
+      shared_examples 'an Konfa::AutoDoc::Formatter subclass' do
+        let(:konfa_class) { double("KonfaClass") }
+
+        subject { described_class.new(konfa_class) }
+
+        it { is_expected.to be_kind_of Konfa::AutoDoc::Formatter }
+        it { is_expected.to respond_to :konfa_class }
+        it { is_expected.to respond_to :version }
+
+        it 'sets class as r/o accessor' do
+          expect(subject.konfa_class).to be konfa_class
+        end
+
+        it 'sets version as r/w accessor' do
+          expect(subject).to respond_to :version=
+        end
+
+        context '#generate' do
+          let(:autodoc_instance) { double }
+
+          before(:each) do
+            allow(Konfa::AutoDoc::Parser).to receive(:new).with(subject.konfa_class).and_return autodoc_instance
+            allow(subject).to receive(:format).and_return "something formatted"
+            allow(autodoc_instance).to receive(:parse).and_return "something parsed"
+          end
+
+          after(:each) do
+            subject.generate
+          end
+
+          it 'constructs a parser with konfa_class' do
+            expect(Konfa::AutoDoc::Parser).to receive(:new).with(subject.konfa_class).and_return autodoc_instance
+          end
+
+          it 'passes the parsed value to #format' do
+            expect(subject).to receive(:format).with("something parsed")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/konfa/deprecation.rb

@@ -0,0 +1,23 @@
+module Konfa
+  module Deprecation
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      @@deprecation_warnings = true
+
+      def deprecation_warnings=(val)
+        @@deprecation_warnings = val
+      end
+
+      def deprecation_warnings
+        @@deprecation_warnings
+      end
+
+      def deprecated(*args)
+        warn(*args) if @@deprecation_warnings
+      end
+    end
+  end
+end

data/lib/konfa/initializer.rb

@@ -0,0 +1,48 @@
+require 'yaml'
+
+module Konfa
+  module Initializer
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def init_with_yaml(*paths)
+        paths.each do |path|
+          # FIXME: It would be a lot cleaner if the YAML library would raise an
+          # exception if it fails to read the file. We'll handle it like this for now
+          # load_file just returns "false" if it fails
+          yaml_data = YAML.load_file(path)
+
+          unless yaml_data.nil?
+            raise Konfa::InitializationError.new("Bad YAML format, key/value pairs expected") unless yaml_data.kind_of?(Hash)
+
+            yaml_data.each do |variable, value|
+              self.store(variable, value)
+            end
+          end
+        end
+
+        dump
+      end
+
+      def init_with_env
+        conf_prefix = self.env_variable_prefix.upcase
+
+        ENV.keys.reject { |key|
+          key !~ /^#{conf_prefix}/ # Ignore everything that doesn't match the prefix
+        }.each { |key|
+          variable = key[conf_prefix.size..-1].downcase
+
+          self.store(variable, ENV[key])
+        }
+
+        dump
+      end
+    end
+
+  end
+
+  class InitializationError < StandardError
+  end
+end

data/lib/konfa/rspec.rb

@@ -0,0 +1,38 @@
+module Konfa
+  module RSpec
+    shared_context 'with konfa' do |klass|
+      before {
+        @konfa_klass = klass
+        @konfa_stubbed_klasses = []
+      }
+
+      def let_config(variable, value, use_klass=@konfa_klass)
+        raise Konfa::UnsupportedVariableError.new(variable) unless use_klass.allowed_variables.has_key?(variable)
+        raise Konfa::RSpec::BadValueError.new(value) unless value.kind_of?(String) || value.kind_of?(NilClass)
+
+        unless @konfa_stubbed_klasses.include?(use_klass)
+          allow(use_klass).to receive(:get).and_call_original
+          @konfa_stubbed_klasses << use_klass
+        end
+
+        allow(use_klass).to receive(:get).with(variable).and_return(value)
+      end
+
+      def with_config(variables, use_klass=@konfa_klass)
+        variables.each_pair do |var, val|
+          let_config(var, val, use_klass)
+        end
+      end
+    end
+
+    class BadValueError < StandardError
+      def initialize(msg)
+        @type = msg.class.name
+      end
+
+      def to_s
+        "Konfa requires values to be of type String (or NilClass), you passed #{@type}"
+      end
+    end
+  end
+end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: konfa
 version: !ruby/object:Gem::Version
-  version: 0.3.1
-  prerelease: 
+  version: 0.5.1
 platform: ruby
 authors:
 - Gunnar Hansson
@@ -10,8 +9,64 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-06 00:00:00.000000000 Z
-dependencies: []
+date: 2017-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: ruby_dep
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
 description: Helps you avoid common pitfalls when dealing with app config
 email: code@avidiy.se
 executables: []
@@ -19,29 +74,35 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/konfa.rb
-homepage: http://github.com/avidity/konfa
+- lib/konfa/autodoc.rb
+- lib/konfa/autodoc/formatter.rb
+- lib/konfa/autodoc/markdown.rb
+- lib/konfa/autodoc/parser.rb
+- lib/konfa/autodoc/rspec.rb
+- lib/konfa/deprecation.rb
+- lib/konfa/initializer.rb
+- lib/konfa/rspec.rb
+homepage: http://github.com/promoteinternational/konfa
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 3.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Application configuration
 test_files: []