flight_config 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8c36bdbe520695cb9d379d6038699c3529fb1fb8938af728fa50452ec0414ae
-  data.tar.gz: 58bf550037f38ede9db72516a5a70afd1b2fa1a47f1be8e7a3d7b95144d9d768
+  metadata.gz: 8526bfd920f7e1e74a43402bd85998d5bfd997ad8e65fcff50db35b2d1e82616
+  data.tar.gz: fcd21613b191a9cd3df1e84780f62677b47b18ee84f86d0d75a883d42c5e385b
 SHA512:
-  metadata.gz: bf01421b86b937cfd4df7180398a81578723391cd26ac0f54e8c98d7ad741cc1315ff23f257460cb6e7474c652285e67cc5ffabf739fb1d3fda6e826847d6d21
-  data.tar.gz: 17768019155bd3e1621f0d597c89010b1403fe11f280ccec08f9e27c5685bb0435b0dbfdbc888b59bfcc84772146ebb153c2f624330505979d7c3b61b1bdbdc0
+  metadata.gz: 11b70976a739890020e3d266da4e3acf39d04fab07d0447efa56a6db1d3cd712e162276a6fd29a35bf3572e534fb249dc4dae1ec12f905fd4bb1905a1eb5e288
+  data.tar.gz: b8e468998c06fea296e29bb1bb70d3f94d1e9cc94906748bc0612b928946e8ce3e96ecb852cf00e1982e550588dcc1517b5abd8a5c742a46a9f3c97c45842adb

data/lib/flight_config/exceptions.rb

@@ -30,4 +30,5 @@ module FlightConfig
   class ResourceBusy < FlightConfigError; end
   class MissingFile < FlightConfigError; end
   class CreateError < FlightConfigError; end
+  class InvalidIndex < FlightConfigError; end
 end

data/lib/flight_config/has_indices.rb

@@ -0,0 +1,53 @@
+#==============================================================================
+# 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 FightConfig
+  module HasIndices
+    def included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def has_indices(klass, &b)
+        @indices ||= []
+        @indices << [klass, b]
+      end
+
+      def indices
+        @indices ||= []
+        base = (defined?(super) ? super : [])
+        [*base, *@indices]
+      end
+    end
+
+    def generate_indices
+      self.class.indices.each do |klass, block|
+        instance_exec(klass.method(:create_or_update), &block)
+      end
+    end
+  end
+end

data/lib/flight_config/indexable.rb

@@ -0,0 +1,75 @@
+#==============================================================================
+# 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
+#==============================================================================
+
+require 'flight_config/reader'
+require 'flight_config/globber'
+
+module FlightConfig
+  module Indexable
+    include FlightConfig::Reader
+    include FlightConfig::Globber
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      include FlightConfig::Reader::ClassMethods
+
+      def glob_read(*a)
+        super.reject do |index|
+          next if index.valid?
+          FileUtils.rm_f path
+          true
+        end
+      end
+
+      def create_or_update(*a)
+        new!(*a, read_mode: true) do |index|
+          Core.log(index, "Generating index")
+          FileUtils.mkdir_p File.dirname(index.path)
+          FileUtils.touch index.path
+        end
+      end
+    end
+
+    def valid?
+      raise NotImplementedError
+    end
+
+    def __data__
+      @__data__ ||= begin
+        if __read_mode__ && !valid?
+          FlightConfig::Core.log(self, 'Removing index')
+          FileUtils.rm_f path
+          raise InvalidIndex, 'Failed to load index as it is invalid'
+        end
+        {}
+      end
+    end
+  end
+end

data/lib/flight_config/updater.rb

@@ -74,7 +74,7 @@ module FlightConfig
         mode = File.exists?(_path(*a))
         new!(*a, read_mode: mode) do |config|
           Updater.create_or_update(config, action: 'create_or_update', &b)
-        end
+        end.tap { |c| c.generate_indices if c.respond_to?(:generate_indices) }
       end
 
       def create(*a, &b)

data/lib/flight_config/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flight_config
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Alces Flight Ltd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-22 00:00:00.000000000 Z
+date: 2019-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-config
@@ -117,6 +117,8 @@ files:
 - lib/flight_config/deleter.rb
 - lib/flight_config/exceptions.rb
 - lib/flight_config/globber.rb
+- lib/flight_config/has_indices.rb
+- lib/flight_config/indexable.rb
 - lib/flight_config/links.rb
 - lib/flight_config/log.rb
 - lib/flight_config/patches/tty_config.rb