lexicon-common 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb97bec1598709b8fefb46c28055ac8291edd138177995e08616de3b06dfbdb8
-  data.tar.gz: 20db194da73907714cb53ae861bd650ded613f71ef99ae1c93db370c8547c830
+  metadata.gz: 67f0a5454bbfd0be7a918086e92beb80d00adfbc5ad5e018619dc28198a9be39
+  data.tar.gz: 63da11d671ced447b6c9f78acabdcdf0dbab6c620fc7f88b6e8e28ecd7ffeb36
 SHA512:
-  metadata.gz: aa5b4f83c9647382dabdaa4dd09250fd4e165476ca3984740763bd4b2cd8f54ac41e73379a5988391a3336d31e9928ca9332598216b102829dff1efe28ab14dd
-  data.tar.gz: 296628e759a78533b06160d653ab6e1299d0d1378964ac20d5350c7b83892d0b385b4d78f1569c1844591c014db2a0130f9249e423946e7d3e38095f28029f5a
+  metadata.gz: b7e1f34a8a91a980156eaabe9456d0c08ddbac1cc4c231f73905dace76c40d095cccd158f8406f9f28e51b7ebb70c6d98b4c27a1dca2b4eacaa75f916b41145c
+  data.tar.gz: 627de86d02381a2ec9ab550b4c384d7d084860c7c18ab7f0f9863cf928c5f6867e5e418183a06540bf75fca21dbd667c42e6cf97a9b4921e7300041f06f285ea

data/lexicon-common.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'aws-sdk-s3', '~> 1.84'
   spec.add_dependency 'colored', '~> 1.2'
+  spec.add_dependency 'concurrent-ruby', '~> 1.1'
+  spec.add_dependency 'corindon', '~> 0.8.0'
   spec.add_dependency 'json_schemer', '~> 0.2.16'
   spec.add_dependency 'pg', '~> 1.2'
   spec.add_dependency 'semantic', '~> 1.6'

data/lib/lexicon-common.rb

@@ -3,10 +3,13 @@
 # require 'lexicon/common'
 require 'aws-sdk-s3'
 require 'colored'
+require 'concurrent-ruby'
+require 'corindon'
 require 'logger'
 require 'json_schemer'
 require 'pg'
 require 'semantic'
+require 'shellwords'
 require 'zeitwerk'
 
 # Require the common file as loading the version first through the gemspec prevents Zeitwerk to load it.

data/lib/lexicon/common.rb

@@ -3,5 +3,6 @@
 module Lexicon
   module Common
     LEXICON_SCHEMA_RELATIVE_PATH = 'resources/lexicon.schema.json'
+    LEXICON_SCHEMA_ABSOLUTE_PATH = Pathname.new(__dir__).join('..', '..', LEXICON_SCHEMA_RELATIVE_PATH).freeze
   end
 end

data/lib/lexicon/common/mixin/logger_aware.rb

@@ -16,8 +16,8 @@ module Lexicon
         def log_error(error)
           if error.nil?
             log('Error (nil)')
-          else
-            log([error.message, *error.backtrace].join("\n"))
+          elsif !logger.nil?
+            logger.error([error.message, *error.backtrace].join("\n"))
           end
         end
       end

data/lib/lexicon/common/mixin/nameable.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+using Corindon::Guards::Ext
+
+module Lexicon
+  module Common
+    module Mixin
+      module Nameable
+        # @return [String]
+        def name
+          unimplemented!
+        end
+      end
+    end
+  end
+end

data/lib/lexicon/common/package/directory_package_loader.rb

@@ -17,7 +17,7 @@ module Lexicon
         end
 
         # @param [String] name
-        # @return [Package, nil]
+        # @return [Package::Package, nil]
         def load_package(name)
           package_dir = root_dir.join(name.to_s)
 
@@ -40,18 +40,17 @@ module Lexicon
               json = JSON.parse(spec_file.read)
 
               if @schema_validator.valid?(json)
-                version = Semantic::Version.new(json.fetch('version'))
-                file_sets = json.fetch('content').map do |id, values|
-                  SourceFileSet.new(
-                    id: id,
-                    name: values.fetch('name'),
-                    structure: values.fetch('structure'),
-                    data: values.fetch('data', nil),
-                    tables: values.fetch('tables', [])
-                  )
-                end
+                package_version = json.fetch('schema_version', 1)
+                case package_version
+                when 1
+                  load_v1(dir: dir, spec_file: spec_file, checksum_file: checksum_file, json: json)
+                when 2
+                  load_v2(dir: dir, spec_file: spec_file, checksum_file: checksum_file, json: json)
+                else
+                  log("Package version #{package_version} is not supported")
 
-                Package.new(file_sets: file_sets, version: version, dir: dir, checksum_file: checksum_file, spec_file: spec_file)
+                  nil
+                end
               else
                 log("Package at path #{dir} has invalid manifest")
 
@@ -61,6 +60,51 @@ module Lexicon
               nil
             end
           end
+
+          # @param [Pathname] checksum_file
+          # @param [Pathname] dir
+          # @param [Hash] json
+          # @param [Pathname] spec_file
+          # @return [V1::Package]
+          def load_v1(dir:, spec_file:, checksum_file:, json:)
+            version = Semantic::Version.new(json.fetch('version'))
+            file_sets = json.fetch('content').map do |id, values|
+              V1::SourceFileSet.new(
+                id: id,
+                name: values.fetch('name'),
+                structure: values.fetch('structure'),
+                data: values.fetch('data', nil),
+                tables: values.fetch('tables', [])
+              )
+            end
+
+            V1::Package.new(file_sets: file_sets, version: version, dir: dir, checksum_file: checksum_file, spec_file: spec_file)
+          end
+
+          # @param [Pathname] checksum_file
+          # @param [Pathname] dir
+          # @param [Hash] json
+          # @param [Pathname] spec_file
+          # @return [V2::Package]
+          def load_v2(dir:, spec_file:, checksum_file:, json:)
+            version = Semantic::Version.new(json.fetch('version'))
+            file_sets = json.fetch('content').map do |id, values|
+              V2::SourceFileSet.new(
+                id: id,
+                name: values.fetch('name'),
+                structure: values.fetch('structure'),
+                tables: values.fetch('tables', {})
+              )
+            end
+
+            V2::Package.new(
+              file_sets: file_sets,
+              version: version,
+              dir: dir,
+              checksum_file: checksum_file,
+              spec_file: spec_file
+            )
+          end
       end
     end
   end

data/lib/lexicon/common/package/package.rb

@@ -11,65 +11,33 @@ module Lexicon
         attr_reader :checksum_file, :spec_file
         # @return [Pathname]
         attr_reader :dir
-        # @return [Array<SourceFileSet>]
-        attr_reader :file_sets
         # @return [Semantic::Version]
         attr_reader :version
+        # @return [Integer]
+        attr_reader :schema_version
 
-        # @param [Array<SourceFileSet>] file_sets
-        # @param [Pathname] dir
         # @param [Pathname] checksum_file
+        # @param [Pathname] dir
+        # @param [Integer] schema_version
+        # @param [Pathname] spec_file
         # @param [Semantic::Version] version
-        def initialize(file_sets:, version:, dir:, checksum_file:, spec_file:)
+        def initialize(checksum_file:, dir:, schema_version:, spec_file:, version:)
           @checksum_file = checksum_file
           @dir = dir
-          @file_sets = file_sets
+          @schema_version = schema_version
           @spec_file = spec_file
           @version = version
         end
 
         # @return [Boolean]
         def valid?
-          checksum_file.exist? && dir.directory? && data_dir.directory? && all_sets_valid?
-        end
-
-        # @return [Array<Pathname>]
-        def structure_files
-          file_sets.map { |fs| dir.join(relative_structure_path(fs)) }
+          checksum_file.exist? && dir.directory? && files.all? { |f| f.path.exist? rescue false }
         end
 
-        # @param [SourceFileSet] file_set
-        # @return [Pathname]
-        def data_path(file_set)
-          dir.join(relative_data_path(file_set))
-        end
-
-        # @return [Pathname]
-        def data_dir
-          dir.join('data')
+        # @return [Array<PackageFile>] Array of File of the package
+        def files
+          []
         end
-
-        # @return [Pathname, nil]
-        def relative_data_path(file_set)
-          if file_set.data_path.nil?
-            nil
-          else
-            data_dir.basename.join(file_set.data_path)
-          end
-        end
-
-        # @return [Pathname]
-        def relative_structure_path(file_set)
-          data_dir.basename.join(file_set.structure_path)
-        end
-
-        private
-
-          def all_sets_valid?
-            file_sets.all? do |set|
-              data_dir.join(set.structure_path).exist? && !set.data_path.nil? && data_dir.join(set.data_path).exist?
-            end
-          end
       end
     end
   end

data/lib/lexicon/common/package/package_file.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Lexicon
+  module Common
+    module Package
+      class PackageFile
+        class << self
+          def new_structure(path)
+            new(path, type: STRUCTURE)
+          end
+
+          def new_data(path)
+            new(path, type: DATA)
+          end
+        end
+
+        # @return [Pathname]
+        attr_reader :path
+
+        # @return [String]
+        def to_s
+          path.to_s
+        end
+
+        # @return [Boolean]
+        def data?
+          type == DATA
+        end
+
+        # @return [Boolean]
+        def structure?
+          type == STRUCTURE
+        end
+
+        private
+
+          attr_reader :type
+
+          DATA = 'data'
+          STRUCTURE = 'structure'
+
+          def initialize(path, type:)
+            @path = path
+            @type = type
+          end
+
+      end
+    end
+  end
+end

data/lib/lexicon/common/package/v1/package.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Lexicon
+  module Common
+    module Package
+      module V1
+        class Package < Common::Package::Package
+          # @return [Array<SourceFileSet>]
+          attr_reader :file_sets
+
+          # @param [Array<SourceFileSet>] file_sets
+          # @param [Pathname] dir
+          # @param [Pathname] checksum_file
+          # @param [Semantic::Version] version
+          def initialize(version:, spec_file:, checksum_file:, dir:, file_sets:)
+            super(
+              checksum_file: checksum_file,
+              dir: dir,
+              spec_file: spec_file,
+              schema_version: 1,
+              version: version,
+            )
+
+            @file_sets = file_sets
+          end
+
+          # @return [Boolean]
+          def valid?
+            super && data_dir.directory? && all_sets_valid?
+          end
+
+          def files
+            structures = file_sets.map { |fs| PackageFile.new_structure(relative_structure_path(fs)) }
+            data = file_sets.flat_map do |fs|
+              data_path = relative_data_path(fs)
+
+              if data_path.nil?
+                []
+              else
+                [PackageFile.new_data(data_path)]
+              end
+            end
+
+            [*structures, *data]
+          end
+
+          # @param [SourceFileSet] file_set
+          # @return [Pathname]
+          def data_path(file_set)
+            dir.join(relative_data_path(file_set))
+          end
+
+          # @return [Pathname]
+          def data_dir
+            dir.join('data')
+          end
+
+          # @return [Pathname, nil]
+          def relative_data_path(file_set)
+            if file_set.data_path.nil?
+              nil
+            else
+              data_dir.basename.join(file_set.data_path)
+            end
+          end
+
+          # @return [Pathname]
+          def relative_structure_path(file_set)
+            data_dir.basename.join(file_set.structure_path)
+          end
+
+          private
+
+            def all_sets_valid?
+              file_sets.all? do |set|
+                data_dir.join(set.structure_path).exist? && !set.data_path.nil? && data_dir.join(set.data_path).exist?
+              end
+            end
+        end
+      end
+    end
+  end
+end

data/lib/lexicon/common/package/v1/package_builder.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Lexicon
+  module Common
+    module Package
+      module V1
+        class PackageBuilder < Package
+          def initialize(version:, dir:)
+            super(
+              file_sets: [],
+              version: version,
+              dir: dir,
+              checksum_file: dir.join(CHECKSUM_FILE_NAME),
+              spec_file: dir.join(SPEC_FILE_NAME)
+            )
+
+            FileUtils.mkdir_p(data_dir)
+          end
+
+          # @param [String] id
+          # @param [String] name
+          # @param [Pathname] structure
+          #   Takes ownership of the file (moves it to the correct folder)
+          # @param [Array<String>] tables
+          # @param [Pathname] data
+          #   Takes ownership of the file (moves it to the correct folder)
+          # @param [String] data_ext
+          def add_file_set(id, name:, structure:, tables:, data: nil, data_ext: '.sql')
+            # @type [Pathname] structure_file_path
+            structure_file_path = data_dir.join(structure_file_name(id))
+            FileUtils.mv(structure.to_s, structure_file_path.to_s)
+
+            # @type [Pathname] data_file_path
+            data_name = if data.nil?
+                          nil
+                        else
+                          dname = data_file_name(id, data_ext)
+                          path = data_dir.join(dname)
+                          FileUtils.mv(data, path)
+
+                          dname
+                        end
+
+            file_sets << SourceFileSet.new(
+              id: id,
+              name: name,
+              structure: structure_file_name(id),
+              data: data.nil? ? nil : data_name,
+              tables: tables
+            )
+          end
+
+          def as_package
+            Package.new(version: version, dir: dir, file_sets: file_sets, checksum_file: checksum_file, spec_file: spec_file)
+          end
+
+          private
+
+            def data_file_name(id, ext)
+              "#{id}#{ext}"
+            end
+
+            def structure_file_name(id)
+              "#{id}__structure.sql"
+            end
+        end
+      end
+    end
+  end
+end