kube_schema 1.0.0 → 1.1.0

data/lib/kube_schema/resource.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "black_hole_struct"
-
-module KubeSchema
-  class Resource
-
-    # Subclasses generated by Instance#[] have a class-level .schema.
-    # When called directly via KubeSchema.parse(hash), the hash is passed in.
-    def initialize(hash = nil, &block)
-      @data = BlackHoleStruct.new(hash)
-      @data.instance_exec(&block) if block
-    end
-
-    # Gets overridden by the factory in KubeSchema::Instance
-    def self.schema
-      nil
-    end
-
-    def to_h
-      @data.to_h
-    end
-
-    def ==(other)
-      other.is_a?(Resource) && to_h == other.to_h
-    end
-  end
-end

data/lib/kube_schema/schema_cache.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-require 'fileutils'
-require 'net/http'
-require 'uri'
-
-module KubeSchema
-  # Lazily downloads individual schema JSON files from the schemas branch
-  # on GitHub and caches them locally under Gem.cache_home (XDG_CACHE_HOME).
-  #
-  # Usage:
-  #   KubeSchema::SchemaCache.fetch("cert-manager.io/certificate_v1")
-  #   # => "/home/user/.cache/kube_schema/schemas/cert-manager.io/certificate_v1.json"
-  #
-  #   KubeSchema::SchemaCache.read("v1.33.6/deployment")
-  #   # => "{...json contents...}"
-  #
-  module SchemaCache
-    BASE_URL = 'https://raw.githubusercontent.com/general-intelligence-systems/kube_schema/refs/heads/schemas'
-
-    class DownloadError < StandardError; end
-
-    class << self
-      # Root directory for cached schemas.
-      # Defaults to ~/.cache/kube_schema/schemas (or $XDG_CACHE_HOME/kube_schema/schemas).
-      def cache_dir
-        @cache_dir ||= File.join(Gem.cache_home, 'kube_schema', 'schemas')
-      end
-
-      # Override the cache directory (useful for testing).
-      attr_writer :cache_dir
-
-      # Returns the local file path for a schema, downloading it if not cached.
-      # The file_path should NOT include the .json extension.
-      #
-      #   SchemaCache.fetch("cert-manager.io/certificate_v1")
-      #   # => "/home/user/.cache/kube_schema/schemas/cert-manager.io/certificate_v1.json"
-      #
-      def fetch(file_path)
-        local = local_path(file_path)
-        return local if File.exist?(local)
-
-        download!(file_path, local)
-        local
-      end
-
-      # Returns the JSON content as a String, downloading if necessary.
-      def read(file_path)
-        File.read(fetch(file_path))
-      end
-
-      # Returns the local path where a schema would be cached (without downloading).
-      def local_path(file_path)
-        File.join(cache_dir, "#{file_path}.json")
-      end
-
-      # Returns true if the schema is already cached locally.
-      def cached?(file_path)
-        File.exist?(local_path(file_path))
-      end
-
-      # Removes a single cached schema file.
-      def evict(file_path)
-        path = local_path(file_path)
-        File.delete(path) if File.exist?(path)
-      end
-
-      # Removes the entire cache directory.
-      def clear!
-        FileUtils.rm_rf(cache_dir)
-      end
-
-      private
-
-      def download!(file_path, local)
-        url = "#{BASE_URL}/#{file_path}.json"
-        uri = URI.parse(url)
-
-        response = Net::HTTP.get_response(uri)
-
-        unless response.is_a?(Net::HTTPSuccess)
-          raise DownloadError,
-                "Failed to download schema: #{url} (HTTP #{response.code})"
-        end
-
-        FileUtils.mkdir_p(File.dirname(local))
-        File.write(local, response.body)
-      end
-    end
-  end
-end

data/lib/kube_schema/schema_index.rb

@@ -1,27 +0,0 @@
-module KubeSchema
-  class SchemaIndex
-    def initialize(version)
-      @version = version
-    end
-
-    def find(query)
-      all_paths.select { _1.include?(query.downcase) }.first
-    end
-
-    def all_paths
-      custom_resource_paths + kubernetes_paths
-    end
-
-    def custom_resource_paths
-      File.read(SCHEMA_INDEX + "/crds.txt").lines.map do |line|
-        line.chomp.gsub(".json", "")
-      end
-    end
-
-    def kubernetes_paths
-      File.read(SCHEMA_INDEX + "/v#{@version}.txt").lines.map do |line|
-        line.chomp.gsub(".json", "").split("/")[1..-1].join("/")
-      end
-    end
-  end
-end

data/lib/kube_schema/version.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-module KubeSchema
-  VERSION = "1.0.0"
-end

data/lib/kube_schema/version.rb.erb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-module KubeSchema
-  VERSION = "<%= version %>"
-end

data/lib/kube_schema.rb

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'kube_schema/version'
-require_relative 'kube_schema/resource'
-require_relative 'kube_schema/instance'
-require_relative 'kube_schema/schema_cache'
-require_relative 'kube_schema/schema_index'
-
-module KubeSchema
-  class UnknownVersionError < StandardError; end
-
-  @schema_version = nil
-  @instances = {}
-
-  GEM_ROOT = File.expand_path("..", __dir__).freeze
-  SCHEMA_INDEX = File.join(GEM_ROOT, "data").freeze
-  DEFAULT_VERSION = "1.34.4" # 2025-04-16
-
-  class << self
-    # Set a default Kubernetes version for bare lookups like KubeSchema["Deployment"].
-    # When nil, the latest version found in the schemas directory is used.
-    attr_accessor :schema_version
-
-    # KubeSchema["1.33.6"]       => cached Instance (supports ["Deployment"] chaining)
-    # KubeSchema["Deployment"]   => Resource via the default version
-    # KubeSchema["apps/v1/Deployment"] => Resource via the default version
-    def [](key)
-      is_a_version = -> (key) { Gem::Version.correct?(key) }
-
-      if is_a_version.(key)
-        if has_version?(key)
-          @instances[key] ||= Instance.new(key)
-        else
-          raise UnknownVersionError.new(
-            "\n#{key} is an unknown version..." +
-            "\nUse `KubeSchema.schema_versions` to get a list."
-          )
-        end
-      else
-        Instance.new(schema_version || DEFAULT_VERSION)[key]
-      end
-    end
-
-    # Build a Resource from a hash.
-    #   KubeSchema.parse(KubeSchema["Deployment"].to_h) == KubeSchema["Deployment"]
-    def parse(hash)
-      raise NotImplementedError
-    end
-
-    def schema_versions
-      @schema_versions ||=
-        Dir.glob(SCHEMA_INDEX + "/v*.txt").map do |file_path|
-          file_path.split("/").last.gsub(".txt", "")[1..-1]
-        end.sort_by { Gem::Version.new(_1) }
-    end
-
-    # The latest Kubernetes version available in the schemas directory,
-    # determined by sorting the filenames with Gem::Version.
-    def latest_version
-      schema_versions.last
-    end
-
-    def has_version?(version)
-      schema_versions.include?(version)
-    end
-  end
-end