strong_yaml 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4d9fbf0e956d82b087df9a89ee34ed584b87bd15dd96fd69bb3fa7bc4c23568a
+  data.tar.gz: 9ac87edf2ff09038300c7b74f7171332f9e8f4379f9d0daa1a01693aaf70eea1
+SHA512:
+  metadata.gz: b524ca35ed3137d72309934f9287fef33d62da0fb77a1303850b7420013c319b1d06520441f614a50b32ffaf9a0e5ef454036a4accb1cdc4842cf831627d7c12
+  data.tar.gz: ac3613443faf96bfcaa0e960f36f66aafb35275fac07a3f1684b57287c6d757108d5a6cfe2b67835db421e38889b7e4adbc8a720f9570bfbd8ff4f03e3b521cb

data/lib/schema/config_group.rb

@@ -0,0 +1,32 @@
+require_relative "config_string"
+require_relative "config_integer"
+require_relative "config_list"
+
+module StrongYAML
+  class ConfigGroup
+    attr_reader :name, :elements
+
+    def initialize(name)
+      @name = name
+      @elements = []
+    end
+
+    def group(name, &block)
+      group = StrongYAML::ConfigGroup.new(name)
+      @elements << group
+      group.instance_eval(&block)
+    end
+
+    def string(name, **args)
+      @elements << StrongYAML::ConfigString.new(name, **args)
+    end
+
+    def integer(name, **args)
+      @elements << StrongYAML::ConfigInteger.new(name, **args)
+    end
+
+    def list(name, **args)
+      @elements << StrongYAML::ConfigList.new(name, **args)
+    end
+  end
+end

data/lib/schema/config_integer.rb

@@ -0,0 +1,10 @@
+module StrongYAML
+  class ConfigInteger
+    attr_reader :name, :default
+
+    def initialize(name, default: nil)
+      @name = name
+      @default = default
+    end
+  end
+end

data/lib/schema/config_list.rb

@@ -0,0 +1,10 @@
+module StrongYAML
+  class ConfigList
+    attr_reader :name, :default
+
+    def initialize(name, default: nil)
+      @name = name
+      @default = default
+    end
+  end
+end

data/lib/schema/config_string.rb

@@ -0,0 +1,10 @@
+module StrongYAML
+  class ConfigString
+    attr_reader :name, :default
+
+    def initialize(name, default: nil)
+      @name = name
+      @default = default
+    end
+  end
+end

data/lib/schema/schema.rb

@@ -0,0 +1,35 @@
+require_relative "config_group"
+require_relative "config_string"
+require_relative "config_integer"
+require_relative "config_list"
+
+module StrongYAML
+  class ConfigSchema
+    attr_reader :elements
+
+    class SchemaError < StandardError
+    end
+
+    def initialize
+      @elements = []
+    end
+
+    def group(name, &block)
+      group = StrongYAML::ConfigGroup.new(name)
+      @elements << group
+      group.instance_eval(&block)
+    end
+
+    def string(name, **args)
+      @elements << StrongYAML::ConfigString.new(name, **args)
+    end
+
+    def integer(name, **args)
+      @elements << StrongYAML::ConfigInteger.new(name, **args)
+    end
+
+    def list(name, **args)
+      @elements << StrongYAML::ConfigList.new(name, **args)
+    end
+  end
+end

data/lib/strong_yaml.rb

@@ -0,0 +1,116 @@
+require "yaml"
+require "json"
+require "ostruct"
+require "fileutils"
+require_relative "schema/schema"
+
+module StrongYAML
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def file(config_location)
+      @config_location = config_location
+    end
+
+    def schema(&block)
+      @schema = StrongYAML::ConfigSchema.new
+      @schema.instance_eval(&block)
+    end
+
+    def load
+      @config = YAML.load_file(@config_location)
+
+      if @schema
+        @schema.elements.each do |schema_entry|
+          obj = build_schema_entry schema_entry, @config, []
+
+          define_singleton_method(schema_entry.name) do
+            obj
+          end
+        end
+      else
+        @config.each do |key, value|
+          define_singleton_method(key) do
+            if value.is_a? Hash
+              JSON.parse value.to_json, object_class: OpenStruct
+            else
+              value
+            end
+          end
+        end
+      end
+    end
+
+    def create_or_load
+      if File.exist? @config_location
+        load
+      elsif @schema
+        File.write(@config_location, hash_from_schema.to_yaml)
+
+        load
+      else
+        FileUtils.touch(@config_location)
+      end
+    end
+
+    private
+
+    def build_schema_entry(schema_entry, config, path)
+      if schema_entry.is_a? StrongYAML::ConfigGroup
+        obj = OpenStruct.new
+        schema_entry.elements.each do |se|
+          obj[se.name] = build_schema_entry(se, config, path + [schema_entry.name])
+        end
+        obj
+      else
+        path << schema_entry.name
+        value = config.dig(*path.map(&:to_s))
+
+        case schema_entry
+        when StrongYAML::ConfigString
+          if value.nil? || value.is_a?(String)
+            value
+          else
+            raise StrongYAML::ConfigSchema::SchemaError, "#{path.map(&:to_s).join(".")} is of type #{value.class}, but should be String"
+          end
+        when StrongYAML::ConfigInteger
+          if value.nil? || value.is_a?(Integer)
+            value
+          else
+            raise StrongYAML::ConfigSchema::SchemaError, "#{path.map(&:to_s).join(".")} is of type #{value.class}, but should be Integer"
+          end
+        when StrongYAML::ConfigList
+          if value.nil? || value.is_a?(Array)
+            value
+          else
+            raise StrongYAML::ConfigSchema::SchemaError, "#{path.map(&:to_s).join(".")} is of type #{value.class}, but should be Array"
+          end
+        end
+      end
+    end
+
+    def hash_from_schema
+      hash = {}
+
+      @schema.elements.each do |schema_entry|
+        hash[schema_entry.name.to_s] = value_from_schema_entry(schema_entry)
+      end
+
+      hash
+    end
+
+    def value_from_schema_entry(schema_entry)
+      if schema_entry.is_a? StrongYAML::ConfigGroup
+        hash = {}
+        schema_entry.elements.each do |se|
+          hash[se.name.to_s] = value_from_schema_entry(se)
+        end
+        hash
+      else
+        schema_entry.default
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: strong_yaml
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Philipp Schlesinger
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-11-15 00:00:00.000000000 Z
+dependencies: []
+description: Allows for easy YAML parsing and type checking, as well as generators
+email:
+- info@philcomm.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/schema/config_group.rb
+- lib/schema/config_integer.rb
+- lib/schema/config_list.rb
+- lib/schema/config_string.rb
+- lib/schema/schema.rb
+- lib/strong_yaml.rb
+homepage: http://rubygems.org/gems/strong_yaml
+licenses:
+- MIT
+metadata:
+  documentation_uri: https://github.com/OfficialPhilcomm/strong_yaml
+  source_code_uri: https://github.com/OfficialPhilcomm/strong_yaml
+  changelog_uri: https://github.com/OfficialPhilcomm/strong_yaml/blob/master/changelog.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Easy YAML type checking
+test_files: []