flight_config 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '081d7e1e6de4db075516f7c0c6e56014960a1a67a40d10038ca934039c2ef7ad'
-  data.tar.gz: ed51d2999f19411b130f1f5acc41b58f056efc2bbad05783d1eec00b95c38d62
+  metadata.gz: f8c36bdbe520695cb9d379d6038699c3529fb1fb8938af728fa50452ec0414ae
+  data.tar.gz: 58bf550037f38ede9db72516a5a70afd1b2fa1a47f1be8e7a3d7b95144d9d768
 SHA512:
-  metadata.gz: cd304a5753c64707df7e0fd4c107489bac75378db3c731db249deeba0262053fc0a05c7aee9e3bd1df8704897b46183c3a8be33661e41e731b29881679a4ecbe
-  data.tar.gz: 4635f2ee905c961830fa2c393db15c8978afbd24d2131d20734c8df967abb842a7dd04781e551a75d97f1f42e56ab0ea5949c7cc47d93591c102a0142ff88c24
+  metadata.gz: bf01421b86b937cfd4df7180398a81578723391cd26ac0f54e8c98d7ad741cc1315ff23f257460cb6e7474c652285e67cc5ffabf739fb1d3fda6e826847d6d21
+  data.tar.gz: 17768019155bd3e1621f0d597c89010b1403fe11f280ccec08f9e27c5685bb0435b0dbfdbc888b59bfcc84772146ebb153c2f624330505979d7c3b61b1bdbdc0

data/lib/flight_config/accessor.rb

@@ -0,0 +1,89 @@
+#==============================================================================
+# Copyright (C) 2019-present Alces Flight Ltd.
+#
+# This file is part of FlightConfig.
+#
+# This program and the accompanying materials are made available under
+# the terms of the Eclipse Public License 2.0 which is available at
+# <https://www.eclipse.org/legal/epl-2.0>, or alternative license
+# terms made available by Alces Flight Ltd - please direct inquiries
+# about licensing to licensing@alces-flight.com.
+#
+# FlightConfig is distributed in the hope that it will be useful, but
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
+# IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS
+# OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A
+# PARTICULAR PURPOSE. See the Eclipse Public License 2.0 for more
+# details.
+#
+# You should have received a copy of the Eclipse Public License 2.0
+# along with FlightConfig. If not, see:
+#
+#  https://opensource.org/licenses/EPL-2.0
+#
+# For more information on FlightConfig, please visit:
+# https://github.com/openflighthpc/flight_config
+#==============================================================================
+
+# NOTE: This is compatibility layer between the accessor and TTY::Config.
+# TTY::Config isn't a good match with FlightConfig as they both try and preform
+# the file handling. Instead a Hashie type object should be used.
+#
+# To facilitate the transition, the accessors use the standard [] and []= methods
+# as these will be defined on most hashie objects. TTY::Config does not implement
+# them however. Hence the need for the compatibility layer
+
+module FlightConfig
+  module TTYConfigAccessor
+    def [](key)
+      fetch(key)
+    end
+
+    def []=(key, value)
+      if value.nil?
+        delete(key)
+      else
+        set(key, value: value)
+      end
+    end
+  end
+
+  TTY::Config.include(TTYConfigAccessor)
+end
+
+module FlightConfig
+  module Accessor
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def data_accessor(key)
+        data_reader(key)
+        data_writer(key)
+      end
+
+      def data_reader(key, &b)
+        self.define_method(key) do
+          raw = __data__[key]
+          b ? instance_exec(raw, &b) : raw
+        end
+      end
+
+      def data_writer(key, &b)
+        self.define_method("#{key}=") do |raw|
+          __data__[key] = b ? instance_exec(raw, &b) : raw
+        end
+      end
+
+      def define_input_methods_from_path_parameters
+        self.method(:path)
+            .parameters
+            .select { |type, _| type == :req }
+            .each_with_index do |(_, arg), idx|
+          define_method(arg) { __inputs__[idx] }
+        end
+      end
+    end
+  end
+end

data/lib/flight_config/core.rb

@@ -24,6 +24,7 @@
 # For more information on FlightConfig, please visit:
 # https://github.com/openflighthpc/flight_config
 #==============================================================================
+
 require 'flight_config/exceptions'
 require 'flight_config/log'
 require 'flight_config/patches/tty_config'
@@ -43,7 +44,8 @@ module FlightConfig
 
     # Deprecated: The mode can be switched directly on the object
     def self.read(obj)
-      obj.__data__set_read_mode
+      obj.instance_variable_set(:@__read_mode__, true)
+      obj.instance_variable_set(:@__data__, nil)
       obj.__data__
     end
 
@@ -76,12 +78,32 @@ module FlightConfig
       end
     end
 
-    attr_reader :__data__mode
+    module ClassMethods
+      # NOTE: The _path method acts as adaptation layer to the two ways the path
+      # could be defined: on the class or instance. Moving forward, the path method
+      # should be defined on the class
+      # NOTE: DO NOT USE THIS METHOD PUBLICLY. Define a `path` method instead
+      def _path(*args)
+        if self.respond_to?(:path)
+          self.path(*args)
+        else
+          msg = <<~WARN.gsub("\n", ' ').chomp
+            FlightConfig Deprecation: #{self}.path is not defined. Falling back to
+            the instance method
+          WARN
+          Log.warn msg
+          $stderr.puts msg
+          self.new(*args).path
+        end
+      end
 
-    def __data__initialize(_tty_config)
-    end
+      # *READ ME*: Hack Alart
+      # NOTE: Override this method in your class, and it should just work
+      # TODO: Eventually replace the _path method with this
+      # def path(*_args)
+      #   raise NotImplementedError
+      # end
 
-    module ClassMethods
       def allow_missing_read(fetch: false)
         if fetch
           @allow_missing_read ||= false
@@ -90,48 +112,62 @@ module FlightConfig
         end
       end
 
-      def new__data__
-        TTY::Config.new
+      def data_core(klass = nil, &b)
+        @data_core ||= -> do
+          obj = (klass || TTY::Config).new
+          b ? b.call(obj) : obj
+        end
+        @data_core.call
       end
     end
 
-    def __data__read(tty_config)
-      if File.exists?(path)
-        Core.log(self, 'read')
-        str = File.read(path)
-        yaml_h = (str == Core::PLACEHOLDER ? nil : YAML.load(File.read(path)))
-        return unless yaml_h
-        tty_config.merge(yaml_h)
-      elsif self.class.allow_missing_read(fetch: true)
-        Core.log(self, 'missing (skip read)')
-      else
-        raise MissingFile, "The file does not exist: #{path}"
-      end
+    attr_reader :__inputs__, :__read_mode__
+
+    def initialize(*input_args, registry: nil, read_mode: nil)
+      @__inputs__ = input_args
+      # TODO: Make this @path = self.class.path(*__inputs__)
+      self.path # Ensure the path can be established with the __inputs__
+      @__registry__ = registry
+      @__read_mode__ = read_mode
     end
 
-    def __data__set_read_mode
-      # Do not call '__data__' directly as this skips the initialize block
-      if @__data__
-        raise BadModeError, <<~ERROR.chomp
-          The read mode can not be changed after __data__ has been set
-        ERROR
-      else
-        @__data__mode = :read
-      end
+    def __registry__
+      @__registry__ ||= FlightConfig::Registry.new
+    end
+
+    def __data__initialize(_tty_config)
     end
 
     def __data__
-      @__data__ ||= self.class.new__data__.tap do |core|
-        if __data__mode == :read
-          __data__read(core)
+      @__data__ ||= self.class.data_core.tap do |core|
+        if __read_mode__ && File.exists?(path)
+          Core.log(self, 'read')
+          str = File.read(path)
+          yaml_h = (str == Core::PLACEHOLDER ? nil : YAML.load(str))
+          core.merge(yaml_h) if yaml_h
+        elsif __read_mode__ && self.class.allow_missing_read(fetch: true)
+          Core.log(self, 'missing (skip read)')
+        elsif __read_mode__
+          raise MissingFile, "The file does not exist: #{path}"
         else
           __data__initialize(core)
         end
       end
     end
 
+    # TODO: Eventually remove the error section as all the configs will have a
+    # class path method
+    # TODO: Set the path in initialize
     def path
-      raise NotImplementedError
+      @path ||= begin
+        if self.class.respond_to?(:path)
+          self.class.path(*__inputs__)
+        else
+          raise FlightConfigError, <<~ERROR.chomp
+            #{self.class}.path has not been defined!
+          ERROR
+        end
+      end
     end
   end
 end

data/lib/flight_config/deleter.rb

@@ -42,11 +42,10 @@ module FlightConfig
 
     module ClassMethods
       def delete(*a)
-        new!(*a) do |config|
+        new!(*a, read_mode: true) do |config|
           Deleter.delete_error_if_missing(config)
           Core.log(config, 'delete')
           Core.lock(config) do
-            config.__data__set_read_mode
             config.__data__
             if block_given? && !(yield config)
               Core.log(config, 'delete (failed)')

data/lib/flight_config/globber.rb

@@ -29,11 +29,12 @@ require 'flight_config/reader'
 module FlightConfig
   module Globber
     class Matcher
-      attr_reader :klass, :arity
+      attr_reader :klass, :arity, :registry
 
-      def initialize(klass, arity)
+      def initialize(klass, arity, registry)
         @klass = klass
         @arity = arity
+        @registry = (registry || FlightConfig::Registry.new)
       end
 
       def keys
@@ -50,7 +51,7 @@ module FlightConfig
       def read(path)
         data = regex.match(path)
         init_args = keys.map { |key| data[key] }
-        klass.read(*init_args)
+        klass.read(*init_args, registry: registry)
       end
     end
 
@@ -59,8 +60,8 @@ module FlightConfig
     end
 
     module ClassMethods
-      def glob_read(*a)
-        matcher = Globber::Matcher.new(self, a.length)
+      def glob_read(*a, registry: nil)
+        matcher = Globber::Matcher.new(self, a.length, registry)
         glob_regex = self.new(*a).path
         Dir.glob(glob_regex)
            .map { |path| matcher.read(path) }

data/lib/flight_config/links.rb

@@ -0,0 +1,54 @@
+#==============================================================================
+# Copyright (C) 2019-present Alces Flight Ltd.
+#
+# This file is part of FlightConfig.
+#
+# This program and the accompanying materials are made available under
+# the terms of the Eclipse Public License 2.0 which is available at
+# <https://www.eclipse.org/legal/epl-2.0>, or alternative license
+# terms made available by Alces Flight Ltd - please direct inquiries
+# about licensing to licensing@alces-flight.com.
+#
+# FlightConfig is distributed in the hope that it will be useful, but
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
+# IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS
+# OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A
+# PARTICULAR PURPOSE. See the Eclipse Public License 2.0 for more
+# details.
+#
+# You should have received a copy of the Eclipse Public License 2.0
+# along with FlightConfig. If not, see:
+#
+#  https://opensource.org/licenses/EPL-2.0
+#
+# For more information on FlightConfig, please visit:
+# https://github.com/openflighthpc/flight_config
+#==============================================================================
+
+module FlightConfig
+  module Links
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      include Globber::ClassMethods
+
+      def define_link(key, klass, glob: false, &b)
+        links_class.define_method(key) do
+          args = config.instance_exec(&b)
+          method = (glob ? :glob_read : :read)
+          klass.public_send(method, *args, registry: config.__registry__)
+        end
+      end
+
+      def links_class
+        @links_class ||= Struct.new(:config)
+      end
+    end
+
+    def links
+      @links ||= self.class.links_class.new(self)
+    end
+  end
+end

data/lib/flight_config/reader.rb

@@ -24,9 +24,26 @@
 # For more information on FlightConfig, please visit:
 # https://github.com/openflighthpc/flight_config
 #==============================================================================
+
 require 'flight_config/core'
 
 module FlightConfig
+  class Registry
+    def read(klass, *args)
+      class_hash = (cache[klass] ||= {})
+      arity_hash = (class_hash[args.length] ||= {})
+      last_arg = args.pop
+      last_hash = args.reduce(arity_hash) { |hash, arg| hash[arg] ||= {} }
+      last_hash[last_arg] ||= klass.new(*args, last_arg, registry: self, read_mode: true)
+    end
+
+    private
+
+    def cache
+      @cache ||= {}
+    end
+  end
+
   module Reader
     include Core
 
@@ -37,27 +54,19 @@ module FlightConfig
     module ClassMethods
       include Core::ClassMethods
 
-      def new!(*a)
-        new(*a).tap do |config|
+      def new!(*a, **h)
+        new(*a, **h).tap do |config|
           yield config if block_given?
         end
       end
 
-      def read(*a)
-        new!(*a) do |config|
-          config.__data__set_read_mode
-          config.__data__
-        end
+      def read(*a, registry: nil)
+        (registry || Registry.new).read(self, *a)
       end
       alias_method :load, :read
 
       def read_or_new(*a)
-        new!(*a) do |config|
-          if File.exists?(config.path)
-            config.__data__set_read_mode
-            config.__data__
-          end
-        end
+        File.exists?(_path(*a)) ? read(*a) : new(*a)
       end
     end
   end

data/lib/flight_config/updater.rb

@@ -64,16 +64,15 @@ module FlightConfig
       include Reader::ClassMethods
 
       def update(*a, &b)
-        new!(*a) do |config|
+        new!(*a, read_mode: true) do |config|
           Updater.update_error_if_missing(config)
-          config.__data__set_read_mode
           Updater.create_or_update(config, action: 'update', &b)
         end
       end
 
       def create_or_update(*a, &b)
-        new!(*a) do |config|
-          config.__data__set_read_mode if File.exists?(config.path)
+        mode = File.exists?(_path(*a))
+        new!(*a, read_mode: mode) do |config|
           Updater.create_or_update(config, action: 'create_or_update', &b)
         end
       end

data/lib/flight_config/version.rb

@@ -25,5 +25,5 @@
 # https://github.com/openflighthpc/flight_config
 #==============================================================================
 module FlightConfig
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/flight_config.rb

@@ -30,3 +30,5 @@ require 'flight_config/globber'
 require 'flight_config/log'
 require 'flight_config/reader'
 require 'flight_config/updater'
+require 'flight_config/accessor'
+require 'flight_config/links'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flight_config
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Alces Flight Ltd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-19 00:00:00.000000000 Z
+date: 2019-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-config
@@ -112,10 +112,12 @@ files:
 - Rakefile
 - flight_config.gemspec
 - lib/flight_config.rb
+- lib/flight_config/accessor.rb
 - lib/flight_config/core.rb
 - lib/flight_config/deleter.rb
 - lib/flight_config/exceptions.rb
 - lib/flight_config/globber.rb
+- lib/flight_config/links.rb
 - lib/flight_config/log.rb
 - lib/flight_config/patches/tty_config.rb
 - lib/flight_config/reader.rb