makit 0.0.1 → 0.0.2

data/lib/makit/protoc.rb

@@ -1,61 +1,61 @@
-# frozen_string_literal: true
-
-# This module provides classes for the Makit gem.
-module Makit
-  # This class provide methods for working with the system Environment.
-  #
-  class Protoc
-    def self.grpc_tools_path
-      File.join(Makit::Directories::NUGET_PACKAGE_CACHE, "grpc.tools", Makit::Protoc::get_latest_grpc_tools_version)
-    end
-
-    def self.grpc_csharp_plugin_path
-      Makit::Protoc::find_plugin_path("grpc_csharp_plugin")
-    end
-    def self.setup
-      if (!Dir.exist?(Makit::Directories::NUGET_PACKAGE_CACHE))
-        puts "  warning: Nuget package cache directory #{Makit::Directories::NUGET_PACKAGE_CACHE} not found".colorize(:red)
-        puts "  warning: Unable to proceed with protoc setup".colorize(:red)
-      else
-        Makit::NuGet::cache("Grpc.Tools", "2.66.0")
-        raise "Nuget package path #{Makit::Directories::NUGET_PACKAGE_CACHE} not found" if !Dir.exist?(Makit::Directories::NUGET_PACKAGE_CACHE)
-
-        # test if protoc is installed by running >protoc --version
-        which_protoc = Makit::Environment.which("protoc")
-        if (Makit::Environment.which("protoc").nil?)
-          puts "  protoc not found, installing...".colorize(:red)
-          "go version".run
-          "go install google.golang.org/protobuf/cmd/protoc-gen-go@latest".run
-          "go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway@latest".run
-          "go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2@latest".run
-        else
-          puts "  protoc found at #{which_protoc}".colorize(:green)
-        end
-        raise "protoc not found" if !Makit::Environment.which("protoc")
-
-        #"git clone https://github.com/googleapis/googleapis.git third_party".run unless File.directory?("third_party/google")
-        puts "  grpc_tools_path " + "#{Makit::Protoc::grpc_tools_path}".colorize(:green)
-        puts "  grpc_csharp_plugin_path " + "#{Makit::Protoc::grpc_csharp_plugin_path}".colorize(:green)
-      end
-    end
-
-    # get the latest version of the grpc.tools package
-    def self.get_latest_grpc_tools_version
-      Makit::NuGet::get_latest_version("Grpc.Tools")
-    end
-
-    #GRPC_CSHARP_PLUGIN_PATH = Makit::Protoc::find_plugin_path("grpc_csharp_plugin")
-    def self.find_plugin_path(plugin_name)
-      # search for a file matching the pattern *grpc_csharp_plugin* in the grpc.tools directory
-      # should match on Windows and Linux
-      if (Makit::Environment.is_windows?)
-        plugin_name = plugin_name + ".exe"
-      end
-
-      plugin_path = Dir.glob("#{Makit::Directories::GRPC_TOOLS_PATH}/**/#{plugin_name}").first
-
-      raise "Plugin path #{plugin_path} not found" if !File.exist?(plugin_path)
-      plugin_path
-    end
-  end
-end
+# frozen_string_literal: true
+
+# This module provides classes for the Makit gem.
+module Makit
+  # This class provide methods for working with the system Environment.
+  #
+  class Protoc
+    def self.grpc_tools_path
+      File.join(Makit::Directories::NUGET_PACKAGE_CACHE, "grpc.tools", Makit::Protoc::get_latest_grpc_tools_version)
+    end
+
+    def self.grpc_csharp_plugin_path
+      Makit::Protoc::find_plugin_path("grpc_csharp_plugin")
+    end
+    def self.setup
+      if (!Dir.exist?(Makit::Directories::NUGET_PACKAGE_CACHE))
+        puts "  warning: Nuget package cache directory #{Makit::Directories::NUGET_PACKAGE_CACHE} not found".colorize(:red)
+        puts "  warning: Unable to proceed with protoc setup".colorize(:red)
+      else
+        Makit::NuGet::cache("Grpc.Tools", "2.66.0")
+        raise "Nuget package path #{Makit::Directories::NUGET_PACKAGE_CACHE} not found" if !Dir.exist?(Makit::Directories::NUGET_PACKAGE_CACHE)
+
+        # test if protoc is installed by running >protoc --version
+        which_protoc = Makit::Environment.which("protoc")
+        if (Makit::Environment.which("protoc").nil?)
+          puts "  protoc not found, installing...".colorize(:red)
+          "go version".run
+          "go install google.golang.org/protobuf/cmd/protoc-gen-go@latest".run
+          "go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway@latest".run
+          "go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2@latest".run
+        else
+          puts "  protoc found at #{which_protoc}".colorize(:green)
+        end
+        raise "protoc not found" if !Makit::Environment.which("protoc")
+
+        #"git clone https://github.com/googleapis/googleapis.git third_party".run unless File.directory?("third_party/google")
+        puts "  grpc_tools_path " + "#{Makit::Protoc::grpc_tools_path}".colorize(:green)
+        puts "  grpc_csharp_plugin_path " + "#{Makit::Protoc::grpc_csharp_plugin_path}".colorize(:green)
+      end
+    end
+
+    # get the latest version of the grpc.tools package
+    def self.get_latest_grpc_tools_version
+      Makit::NuGet::get_latest_version("Grpc.Tools")
+    end
+
+    #GRPC_CSHARP_PLUGIN_PATH = Makit::Protoc::find_plugin_path("grpc_csharp_plugin")
+    def self.find_plugin_path(plugin_name)
+      # search for a file matching the pattern *grpc_csharp_plugin* in the grpc.tools directory
+      # should match on Windows and Linux
+      if (Makit::Environment.is_windows?)
+        plugin_name = plugin_name + ".exe"
+      end
+
+      plugin_path = Dir.glob("#{Makit::Directories::GRPC_TOOLS_PATH}/**/#{plugin_name}").first
+
+      raise "Plugin path #{plugin_path} not found" if !File.exist?(plugin_path)
+      plugin_path
+    end
+  end
+end

data/lib/makit/serializer.rb

@@ -1,70 +1,115 @@
-# frozen_string_literal: true
-require "google/protobuf"
-# This module provides classes for the Makit gem.
-module Makit
-  module Proto3Formats
-    JSON = 0,
-           PRETTY_JSON = 1,
-    BINARY = 3
-  end
-
-  # This class provide methods for serializing and deserializing objects.
-  #
-  class Serializer
-    attr_accessor :format_map
-
-    def initialize(proto3_format = Proto3Formats::PRETTY_JSON)
-      @format_maps = {
-        ::Google::Protobuf::MessageExts => proto3_format,
-      }
-    end
-
-    # Serialize an object to a byte[] or a string
-    def serialize(object)
-      raise "Object is nil" if object.nil?
-      raise "object is not of type ::Google::Protobuf::MessageExts" if !object.is_a? ::Google::Protobuf::MessageExts
-
-      case @format_maps[::Google::Protobuf::MessageExts]
-      when Proto3Formats::JSON
-        puts "Serializing to protobuf json format"
-        object.to_json
-      when Proto3Formats::PRETTY_JSON
-        puts "Serializing to protobuf pretty json format"
-        json = object.to_json
-        pretty_json = JSON.pretty_generate(JSON.parse(json))
-        pretty_json
-      when Proto3Formats::BINARY
-        puts "Serializing to protobuf binary format"
-        serialized_object = object.to_proto
-      else
-        raise "Unknown serialization format"
-      end
-    end
-
-    # Deserialize a byte[] or a string to an object
-    def deserialize(type, data)
-      raise "data is nil" if data.nil?
-      case @format_maps[::Google::Protobuf::MessageExts]
-      when Proto3Formats::JSON
-        raise "data is not of type string" if !data.is_a? String
-        json = data
-        puts "Deserializing from protobuf json format into type #{type}"
-        # use the from_json method to deserialize the object
-        type.decode_json(json)
-      when Proto3Formats::PRETTY_JSON
-        raise "data is not of type string" if !data.is_a? String
-        json = data
-        puts "Deserializing from protobuf pretty json format into type #{type}"
-        # use the from_json method to deserialize the object
-        type.decode_json(json)
-      when Proto3Formats::BINARY
-        #raise "data is not of type byte[]" if !data.is_a? Array
-        bytes = data
-        puts "Deserializing from protobuf binary format into type #{type}"
-        type.decode(bytes)
-      else
-        raise "Unknown serialization format"
-      end
-    end
-  end # class Storage
-end # module Makit
+# frozen_string_literal: true
+require "google/protobuf"
+# This module provides classes for the Makit gem.
+module Makit
+  module Proto3Formats
+    JSON = 0,
+           PRETTY_JSON = 1,
+           YAML = 2,
+    BINARY = 3
+  end
+
+  # This class provide methods for serializing and deserializing objects.
+  #
+  class Serializer
+    attr_accessor :format_map
+
+    def self.save_as(filename, object)
+      extension = File.extname(filename)
+      case extension
+      when ".json"
+        File.write(filename, Makit::Serializer.new(Makit::Proto3Formats::PRETTY_JSON).serialize(object))
+      when ".yml"
+        File.write(filename, Makit::Serializer.new(Makit::Proto3Formats::YAML).serialize(object))
+      when ".pb"
+        File.open(filename, "wb") do |file|
+          file.write(Makit::Serializer.new(Makit::Proto3Formats::BINARY).serialize(object))
+        end
+
+        #File.write(filename, Makit::Serializer.new(Makit::Proto3Formats::BINARY).serialize(object))
+      else
+        raise "unsupported file extension: #{extension}"
+      end
+    end
+
+    def self.open(filename, type)
+      extension = File.extname(filename)
+      case extension
+      when ".json"
+        Makit::Serializer.new(Makit::Proto3Formats::PRETTY_JSON).deserialize(type, File.read(filename))
+      when ".yml"
+        Makit::Serializer.new(Makit::Proto3Formats::YAML).deserialize(type, File.read(filename))
+      when ".pb"
+        data = File.open(filename, "rb") { |file| file.read }
+        Makit::Serializer.new(Makit::Proto3Formats::BINARY).deserialize(type, data)
+      else
+        raise "unsupported file extension: #{extension}"
+      end
+    end
+
+    def initialize(proto3_format = Proto3Formats::PRETTY_JSON)
+      @format_maps = {
+        ::Google::Protobuf::MessageExts => proto3_format,
+      }
+    end
+
+    # Serialize an object to a byte[] or a string
+    def serialize(object)
+      raise "Object is nil" if object.nil?
+      raise "object is not of type ::Google::Protobuf::MessageExts" if !object.is_a? ::Google::Protobuf::MessageExts
+
+      case @format_maps[::Google::Protobuf::MessageExts]
+      when Proto3Formats::JSON
+        #puts "Serializing to protobuf json format"
+        object.to_json
+      when Proto3Formats::PRETTY_JSON
+        #puts "Serializing to protobuf pretty json format"
+        json = object.to_json
+        pretty_json = JSON.pretty_generate(JSON.parse(json))
+        pretty_json
+      when Proto3Formats::YAML
+        #puts "Serializing to protobuf yaml format"
+        data = JSON.parse(object.to_json)
+        data.to_yaml.sub(/^---\n/, "")
+      when Proto3Formats::BINARY
+        #puts "Serializing to protobuf binary format"
+        serialized_object = object.to_proto
+      else
+        raise "Unknown serialization format"
+      end
+    end
+
+    # Deserialize a byte[] or a string to an object
+    def deserialize(type, data)
+      raise "data is nil" if data.nil?
+      case @format_maps[::Google::Protobuf::MessageExts]
+      when Proto3Formats::JSON
+        raise "data is not of type string" if !data.is_a? String
+        json = data
+        #puts "Deserializing from protobuf json format into type #{type}"
+        # use the from_json method to deserialize the object
+        type.decode_json(json)
+      when Proto3Formats::PRETTY_JSON
+        raise "data is not of type string" if !data.is_a? String
+        json = data
+        #puts "Deserializing from protobuf pretty json format into type #{type}"
+        # use the from_json method to deserialize the object
+        type.decode_json(json)
+      when Proto3Formats::YAML
+        raise "data is not of type string" if !data.is_a? String
+        yaml = data
+        # convert yaml to json
+        json = JSON.pretty_generate(YAML.safe_load(yaml))
+        #puts "Deserializing from protobuf yaml format into type #{type}"
+        type.decode_json(json)
+      when Proto3Formats::BINARY
+        #raise "data is not of type byte[]" if !data.is_a? Array
+        bytes = data
+        #puts "Deserializing from protobuf binary format into type #{type}"
+        type.decode(bytes)
+      else
+        raise "Unknown serialization format"
+      end
+    end
+  end # class Storage
+end # module Makit

data/lib/makit/storage.rb

@@ -1,131 +1,131 @@
-# frozen_string_literal: true
-
-# This module provides classes for the Makit gem.
-module Makit
-  # This class provide methods for serializing and deserializing objects.
-  #
-  class Storage
-    # declare a private class variable, connection_string
-    attr_accessor :directory #= nil
-    attr_accessor :protoc_json_serializer # = Makit::Serializer::new()
-    attr_accessor :protoc_binary_serializer # = Makit::Serializer::new()
-
-    def initialize(directory)
-      @directory = directory
-      @protoc_json_serializer = Makit::Serializer::new(Makit::Proto3Formats::JSON)
-      @protoc_binary_serializer = Makit::Serializer::new(Makit::Proto3Formats::BINARY)
-    end
-
-    def save(object, key)
-      puts "=" * 80
-      puts "Saving object to storage"
-      puts "=" * 80
-      raise "directory is nil" if @directory.nil?
-      raise "Object is nil" if object.nil?
-      raise "Key is nil" if key.nil?
-
-      # get the fully qualfied type name of the object
-      type_name = object.class.to_s
-      puts "Type name: #{type_name}"
-
-      type_rel_dir = type_name.downcase.gsub("::", "/")
-      puts "Type relative directory: #{type_rel_dir}"
-
-      # extract the file extension from the key
-      file_extension = File.extname(key)
-      puts "File extension: #{file_extension}"
-
-      serializer = nil
-      if file_extension == ".json"
-        serializer = @protoc_json_serializer
-      elsif file_extension == ".pb"
-        serializer = @protoc_binary_serializer
-      else
-        raise "Unknown file extension: #{file_extension}"
-      end
-      bytes = serializer.serialize(object)
-      puts "Serialized object size: #{bytes.size} bytes"
-
-      rel_filename = File.join(type_rel_dir, "#{key}")
-      puts "Relative filename: #{rel_filename}"
-
-      filename = File.join(@directory, rel_filename)
-      puts "Saving object to file: #{filename}"
-
-      # make sure the file directory has been created
-      FileUtils.mkdir_p(File.dirname(filename)) unless File.directory?(File.dirname(filename))
-      # write the bytes to the file
-      File.open(filename, "wb") do |file|
-        file.write(bytes)
-      end
-
-      puts "=" * 80
-    end
-
-    def load(type, key)
-      raise "directory is nil" if @directory.nil?
-      raise "Key is nil" if key.nil?
-
-      # get the fully qualfied type name of the object
-      type_name = type.to_s # object.class.to_s
-      puts "Type name: #{type_name}"
-
-      type_rel_dir = type_name.downcase.gsub("::", "/")
-      puts "Type relative directory: #{type_rel_dir}"
-
-      # extract the file extension from the key
-      file_extension = File.extname(key)
-      puts "File extension: #{file_extension}"
-
-      rel_filename = File.join(type_rel_dir, "#{key}")
-      puts "Relative filename: #{rel_filename}"
-
-      filename = File.join(@directory, rel_filename)
-      puts "Loading object from file: #{filename}"
-
-      # make sure the file exists
-      raise "File does not exist: #{filename}" unless File.exist?(filename)
-
-      # read the bytes from the file
-      bytes = File.read(filename, mode: "rb")
-      puts "Read object from file: #{filename}"
-
-      # extract the file extension from the key
-      file_extension = File.extname(key)
-      puts "File extension: #{file_extension}"
-
-      serializer = nil
-      if file_extension == ".json"
-        serializer = @protoc_json_serializer
-      elsif file_extension == ".pb"
-        serializer = @protoc_binary_serializer
-      else
-        raise "Unknown file extension: #{file_extension}"
-      end
-
-      # deserialize the object
-      object = serializer.deserialize(type, bytes)
-      puts "Deserialized object size: #{bytes.size} bytes"
-
-      # if the object type inherits from Google::Protobuf::AbstractMessage,
-      # then serialize to protobuf json format
-      #if object.is_a? Google::Protobuf::MessageExts
-      #  puts "Serializing to protobuf json format"
-      #  serialized_object = object.to_json
-      #  pretty_json = JSON.pretty_generate(JSON.parse(serialized_object))
-      #  puts pretty_json
-      #else
-      #  puts "Serializing to Marshal format"
-      #  serialized_object = Marshal.dump(object)
-      #end
-      # serialize the object
-      #serialized_object = Marshal.dump(object)
-
-      # save the object to the storage
-      # ...
-      puts "=" * 80
-
-      object
-    end
-  end # class Storage
-end # module Makit
+# frozen_string_literal: true
+
+# This module provides classes for the Makit gem.
+module Makit
+  # This class provide methods for serializing and deserializing objects.
+  #
+  class Storage
+    # declare a private class variable, connection_string
+    attr_accessor :directory #= nil
+    attr_accessor :protoc_json_serializer # = Makit::Serializer::new()
+    attr_accessor :protoc_binary_serializer # = Makit::Serializer::new()
+
+    def initialize(directory)
+      @directory = directory
+      @protoc_json_serializer = Makit::Serializer::new(Makit::Proto3Formats::JSON)
+      @protoc_binary_serializer = Makit::Serializer::new(Makit::Proto3Formats::BINARY)
+    end
+
+    def save(object, key)
+      #puts "=" * 80
+      #puts "Saving object to storage"
+      # puts "=" * 80
+      raise "directory is nil" if @directory.nil?
+      raise "Object is nil" if object.nil?
+      raise "Key is nil" if key.nil?
+
+      # get the fully qualfied type name of the object
+      type_name = object.class.to_s
+      #puts "Type name: #{type_name}"
+
+      type_rel_dir = type_name.downcase.gsub("::", "/")
+      #puts "Type relative directory: #{type_rel_dir}"
+
+      # extract the file extension from the key
+      file_extension = File.extname(key)
+      #puts "File extension: #{file_extension}"
+
+      serializer = nil
+      if file_extension == ".json"
+        serializer = @protoc_json_serializer
+      elsif file_extension == ".pb"
+        serializer = @protoc_binary_serializer
+      else
+        raise "Unknown file extension: #{file_extension}"
+      end
+      bytes = serializer.serialize(object)
+      #puts "Serialized object size: #{bytes.size} bytes"
+
+      rel_filename = File.join(type_rel_dir, "#{key}")
+      #puts "Relative filename: #{rel_filename}"
+
+      filename = File.join(@directory, rel_filename)
+      #puts "Saving object to file: #{filename}"
+
+      # make sure the file directory has been created
+      FileUtils.mkdir_p(File.dirname(filename)) unless File.directory?(File.dirname(filename))
+      # write the bytes to the file
+      File.open(filename, "wb") do |file|
+        file.write(bytes)
+      end
+
+      #puts "=" * 80
+    end
+
+    def load(type, key)
+      raise "directory is nil" if @directory.nil?
+      raise "Key is nil" if key.nil?
+
+      # get the fully qualfied type name of the object
+      type_name = type.to_s # object.class.to_s
+      #puts "Type name: #{type_name}"
+
+      type_rel_dir = type_name.downcase.gsub("::", "/")
+      #puts "Type relative directory: #{type_rel_dir}"
+
+      # extract the file extension from the key
+      file_extension = File.extname(key)
+      #puts "File extension: #{file_extension}"
+
+      rel_filename = File.join(type_rel_dir, "#{key}")
+      #puts "Relative filename: #{rel_filename}"
+
+      filename = File.join(@directory, rel_filename)
+      #puts "Loading object from file: #{filename}"
+
+      # make sure the file exists
+      raise "File does not exist: #{filename}" unless File.exist?(filename)
+
+      # read the bytes from the file
+      bytes = File.read(filename, mode: "rb")
+      #puts "Read object from file: #{filename}"
+
+      # extract the file extension from the key
+      file_extension = File.extname(key)
+      #puts "File extension: #{file_extension}"
+
+      serializer = nil
+      if file_extension == ".json"
+        serializer = @protoc_json_serializer
+      elsif file_extension == ".pb"
+        serializer = @protoc_binary_serializer
+      else
+        raise "Unknown file extension: #{file_extension}"
+      end
+
+      # deserialize the object
+      object = serializer.deserialize(type, bytes)
+      #puts "Deserialized object size: #{bytes.size} bytes"
+
+      # if the object type inherits from Google::Protobuf::AbstractMessage,
+      # then serialize to protobuf json format
+      #if object.is_a? Google::Protobuf::MessageExts
+      #  puts "Serializing to protobuf json format"
+      #  serialized_object = object.to_json
+      #  pretty_json = JSON.pretty_generate(JSON.parse(serialized_object))
+      #  puts pretty_json
+      #else
+      #  puts "Serializing to Marshal format"
+      #  serialized_object = Marshal.dump(object)
+      #end
+      # serialize the object
+      #serialized_object = Marshal.dump(object)
+
+      # save the object to the storage
+      # ...
+      #puts "=" * 80
+
+      object
+    end
+  end # class Storage
+end # module Makit