yaml-file-db 0.1.2 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdec368220bb1f0c3075bc77ce04deee5d71b589dedfe4768c12a91c963b5373
-  data.tar.gz: 64a96c084ff0d6a622c787c84632fb9163f8218151e1575a71b0ca02bc10413d
+  metadata.gz: ae6799ef62195b4c458d3f3cd47be139da5f7aef5b8e6dbd69fe6df64d9f52e4
+  data.tar.gz: 71b3d6392ebc40c100202f8660c5939a2584a2ac93773e61a808826b62e3e08a
 SHA512:
-  metadata.gz: 83182ca75c22109d1e0a8c117cfae4d75551b9d6f363b4a244d596864fb9b6e657e49b29312ea1b235a0e607ca656a69238acbfa88a4359d7303994d16e7da69
-  data.tar.gz: 2d7e1a93edefba627b2da0bb473398e35dd84343070268256eb3b198d60cfd3bb1b24ad0aa0f16fc621efb1fb8c117ee39f2c9b8b7e9dff2d6d4ac69611df987
+  metadata.gz: 25ef22935b21a47f905646f8ce633db3f657e77f4cfdbaf2fff1abf547c1c7b92edf5297bb91f34ed864d27beab61e1302742b497026378b850d35884ae8d823
+  data.tar.gz: 11642c1d417335cf217867b8e32d60e30c6ee26d86dd1adbd50be740115af846ef0ad57482a4afa839e94e50366d1d7ad47cf3f93dd8f98ffb495a573ce707cf

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,16 +12,16 @@ module YDB
       @source = source
     end
 
-    def build()
-      build_tables()
-      build_relationships()
-      check_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 = {}
 
@@ -30,57 +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()
+    def check_relationships
       keywords = keywords()
       iterate_over_rows do |row|
         row.check_relationships(self, keywords)
       end
     end
 
-    private
-
-    def keywords()
+    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
       keywords
     end
 
     def iterate_over_rows(&block)
-      self.instance_variables.each do |var|
+      instance_variables.each do |var|
         next if INTERNAL_VARS.include? var
+
         table = instance_variable_get var
-        table.each do |id, row|
-          begin
-            block.call(row)
-          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,18 +1,21 @@
+# 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)
+      errors = []
       iterate_over_columns do |key, value|
         if keywords.include?(key)
           if key.pluralize == key
@@ -20,71 +23,82 @@ module YDB
             table = db.public_send(key.to_sym)
             value.each do |primary_key|
               row = table[primary_key]
-              raise ValidationError.new("invalid primary_key: #{primary_key} is not part of #{key}") if row.nil?
+              errors << "Invalid primary_key: #{primary_key} isn't part of table #{key}" if row.nil?
               rows << row
             end
             instance_variable_set("@#{key}", rows)
           else
             row = db.public_send(key.pluralize.to_sym)[value]
-            raise ValidationError.new("invalid primary_key: #{primary_key} is not part of #{key}") if row.nil?
+            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)
+    def check_relationships(_db, keywords)
+      errors = []
       iterate_over_columns do |key, value|
         if keywords.include?(key)
-          # move row into array to make it iterable
+          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
-                raise ValidationError.new("inconsistent relationship: #{row.id} doesn't link back to #{self.id}")
+                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)
-                raise ValidationError.new("inconsistent relationship: #{row.id} doesn't link back to #{self.id}")
+                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
+      begin
+        doc = YAML.safe_load(File.read(source))
+      rescue Psych::SyntaxError => e
+        raise ValidationError, "Invalid YAML document: #{e.message}"
+      end
+      raise ValidationError, 'Blank 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 iterate_over_columns(&block)
-      self.instance_variables.each do |var|
+      instance_variables.each do |var|
         next if INTERNAL_VARS.include?(var)
-        key = var.to_s[1..-1]
+
+        key = var.to_s[1..]
         value = instance_variable_get(var)
         block.call(key, value)
       end
     end
 
-    def validate_filename()
-      raise ValidationError.new("invalid filename") unless self.id =~ /^[\w-]+$/
-    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.2
+  version: 0.1.7
 platform: ruby
 authors:
 - Louis-Philippe Gauthier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-23 00:00:00.000000000 Z
+date: 2021-03-04 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:
   - - ">="