yaml-file-db 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcccc03ffdf919d10a071489113df40c30a6bdc7895648b333ce3fc892a95322
-  data.tar.gz: 9a5b1b311ed1cf15c73ecdc5fe2e33bd2e3471973d7909569d25881f579081b8
+  metadata.gz: e267ac60c172096d2484e3e86854886c4c4dbbeb7c895cae083eea0781d4fb00
+  data.tar.gz: 96258128806aea1f96017700203a485f204da736ab0ebcffce36fbfdc2654f57
 SHA512:
-  metadata.gz: c8569acad2ff389a8827dfb4203aa56525de1465849f01be2fa3f1f04742015d8fc615bf7c778f463ad8e752ceee1254928d268e3e3ee7568e704a5f4f2cd340
-  data.tar.gz: c4189b21b1b971969a0f2dfe3d2bb48ca181689f827b8e4bedefdd1033bb263f531c7248da2a364ef7d23d195ef802a58f2bb1c8f4ebd6ac4e668212e96684a8
+  metadata.gz: 34099bed1433f9fe540fb4a0f5f1a9a16c63b44f17b2809f6a535438da4968b6e1ae7874278b1628335f391b8fa280af442cd03235b6235764fe01b2501b4c73
+  data.tar.gz: ef76c1a1cafe075452fdaaf0d2f0250c0141a05cf81edf028c76bdf54cfb8e22653464df87e15e7430bebcc76367f650f838ff937f6ea3b3b5ac630fe4f950fa

data/lib/yaml-file-db.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'active_support/inflector'
 require 'json-schema'
 require 'yaml'
 
-require 'yaml-file-db/database.rb'
-require 'yaml-file-db/exception.rb'
-require 'yaml-file-db/row.rb'
+require 'yaml-file-db/database'
+require 'yaml-file-db/exception'
+require 'yaml-file-db/row'

data/lib/yaml-file-db/database.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module YDB
   class Database
-
-    INTERNAL_VARS = [:@errors, :@schemas, :@source].freeze
+    INTERNAL_VARS = %i[@errors @schemas @source].freeze
 
     attr_reader :errors, :schemas, :source
 
@@ -11,15 +12,16 @@ module YDB
       @source = source
     end
 
-    def build()
-      build_tables()
-      build_relationships()
+    def build
+      build_tables
+      build_relationships
+      check_relationships
       self
     end
 
     private
 
-    def build_tables()
+    def build_tables
       Dir["#{@source}/*"].each do |table_path|
         table = {}
 
@@ -29,37 +31,51 @@ module YDB
         schema_path = "#{@schemas}/#{table_name.singularize}.yml"
 
         Dir["#{table_path}/*.yml"].each do |source|
-          begin
-            row = Object.const_get(klass_name).new(source, schema_path)
-            table[row.id] = row
-          rescue ValidationError => error
-            @errors << "#{source}: #{error.to_s}"
-          end
+          row = Object.const_get(klass_name).new(source, schema_path)
+          table[row.id] = row
+        rescue ValidationError => e
+          @errors << "[#{source.split('/')[-3..].join('/')}] #{e}"
         end
 
         instance_variable_set("@#{table_name}", table)
-        self.class.send("attr_reader", table_name.to_sym)
+        self.class.send('attr_reader', table_name.to_sym)
       end
     end
 
-    def build_relationships()
+    def build_relationships
+      keywords = keywords()
+      iterate_over_rows do |row|
+        row.build_relationships(self, keywords)
+      end
+    end
+
+    def check_relationships
+      keywords = keywords()
+      iterate_over_rows do |row|
+        row.check_relationships(self, keywords)
+      end
+    end
+
+    def keywords
       keywords = []
-      (self.instance_variables - INTERNAL_VARS).each do |var|
-        keywords << var.to_s[1..-1]
-        keywords << var.to_s[1..-1].singularize
+      (instance_variables - INTERNAL_VARS).each do |var|
+        keywords << var.to_s[1..]
+        keywords << var.to_s[1..].singularize
       end
-      self.instance_variables.each do |var|
+      keywords
+    end
+
+    def iterate_over_rows(&block)
+      instance_variables.each do |var|
         next if INTERNAL_VARS.include? var
+
         table = instance_variable_get var
-        table.each do |id, row|
-          begin
-            row.build_relationships(self, keywords)
-          rescue ValidationError => error
-            @errors << "#{row.source}: #{error.to_s}"
+        table.each do |_id, row|
+          block.call(row).each do |error|
+            @errors << "[#{row.source.split('/')[-3..].join('/')}] #{error}"
           end
         end
       end
     end
-
   end
 end

data/lib/yaml-file-db/exception.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module YDB
   class ValidationError < StandardError
   end

data/lib/yaml-file-db/row.rb

@@ -1,66 +1,100 @@
+# frozen_string_literal: true
+
 module YDB
   class Row
-    INTERNAL_VARS = [:@id, :@source].freeze
+    INTERNAL_VARS = %i[@id @source].freeze
 
     attr_reader :id, :source
 
     def initialize(source, schema_path)
-      @id = File.basename(source, ".yml")
+      @id = File.basename(source, '.yml')
       @source = source
 
-      validate_filename()
+      validate_filename
       build(source, schema_path)
     end
 
     def build_relationships(db, keywords)
-      self.instance_variables.each do |var|
-        next if INTERNAL_VARS.include? var
-        keyword = var.to_s[1..-1]
-
-        if keywords.include? keyword
-          if keyword.pluralize == keyword
-            array = instance_variable_get var
-            entities = db.public_send(keyword.to_sym)
-            value = []
-            array.each do |primary_key|
-              entity = entities[primary_key]
-              raise ValidationError.new("invalid primary_key #{primary_key}") if entity.nil?
-              value << entity
+      errors = []
+      iterate_over_columns do |key, value|
+        if keywords.include?(key)
+          if key.pluralize == key
+            rows = []
+            table = db.public_send(key.to_sym)
+            value.each do |primary_key|
+              row = table[primary_key]
+              errors << "Invalid primary_key: #{primary_key} isn't part of table #{key}" if row.nil?
+              rows << row
             end
-            instance_variable_set("@#{keyword}", value)
+            instance_variable_set("@#{key}", rows)
           else
-            primary_key = instance_variable_get var
-            entity = db.public_send(keyword.pluralize.to_sym)[primary_key]
-            raise ValidationError.new("invalid primary_key #{primary_key}") if entity.nil?
-            instance_variable_set("@#{keyword}", entity)
+            row = db.public_send(key.pluralize.to_sym)[value]
+            errors << "Invalid primary_key: #{value} isn't part of table #{key.pluralize}" if row.nil?
+            instance_variable_set("@#{key}", row)
           end
         end
       end
+      errors
+    end
+
+    def check_relationships(_db, keywords)
+      errors = []
+      iterate_over_columns do |key, value|
+        if keywords.include?(key)
+          next if value.nil?
+
+          value = [value] if value.is_a?(YDB::Row)
+          value.each do |row|
+            if row.respond_to?(self.class.to_s.downcase.to_sym)
+              unless row.public_send(self.class.to_s.downcase.to_sym) == self
+                errors << "Inconsistent relationship: #{row.id} doesn't link back to #{id}"
+              end
+            elsif row.respond_to?(self.class.to_s.downcase.pluralize.to_sym)
+              unless row.public_send(self.class.to_s.downcase.pluralize.to_sym).include?(self)
+                errors << "Inconsistent relationship: #{row.id} doesn't link back to #{id}"
+              end
+            end
+          end
+        end
+      end
+      errors
     end
 
     private
 
     def build(source, schema_path)
-      doc = YAML.load(File.read(source))
-      raise ValidationError.new("invalid YAML") if doc == false
+      doc = YAML.safe_load(File.read(source))
+      raise ValidationError, 'Invalid YAML document' if doc.nil?
 
-      schema = YAML.load(File.read(schema_path))
+      schema = YAML.safe_load(File.read(schema_path))
       begin
-        JSON::Validator.validate!(schema, doc, :parse_data => false)
-      rescue JSON::Schema::ValidationError => error
-        raise ValidationError.new("invalid data (#{error.message})")
+        JSON::Validator.validate!(schema, doc, parse_data: false)
+      rescue JSON::Schema::ValidationError => e
+        raise ValidationError, "Invalid data: #{e.message}"
       end
 
       doc.each do |name, value|
         instance_variable_set("@#{name}", value)
-        next if self.respond_to? name.to_sym
-        self.class.send("attr_reader", name.to_sym)
+        next if respond_to?(name.to_sym)
+
+        self.class.send('attr_reader', name.to_sym)
       end
     end
 
-    def validate_filename()
-      raise ValidationError.new("invalid filename") unless self.id =~ /^[\w-]+$/
+    def iterate_over_columns(&block)
+      instance_variables.each do |var|
+        next if INTERNAL_VARS.include?(var)
+
+        key = var.to_s[1..]
+        value = instance_variable_get(var)
+        block.call(key, value)
+      end
     end
 
+    def validate_filename
+      return if id =~ /\A[a-z\d][a-z\d-]*[a-z\d]\z/i
+
+      raise ValidationError, "Invalid filename: #{id} doesn't follow dash-case convention"
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaml-file-db
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.6
 platform: ruby
 authors:
 - Louis-Philippe Gauthier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-15 00:00:00.000000000 Z
+date: 2021-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -72,7 +72,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="