proto-convert 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5538e9d2c6050048c066b5694afe9bced0bdf8f3a8bf383aee963a1a0cc39034
-  data.tar.gz: 1e0bf071c4b5b6e493a7bf966cb8a795cfe04d3323d66982195cdb1cb0bd42e7
+  metadata.gz: f5838325797314e221a75028304dad6529875a0313bc0c718b8a85fd6a39c000
+  data.tar.gz: 59ca7099f09e630d907bd61557c3ede9149d2a183b55a8c819949d02be35e1f1
 SHA512:
-  metadata.gz: 462d652162fc52893b8b7799afceba2f595b0b9aba813d4c38abc0c4f37b48f10b13ba9b03c4ce644905ed1da179f5845506728b6f2b019f5dd976f260a32af7
-  data.tar.gz: c7e225689e68e81e9fceab2c8a861eab48c134a65204a7113856b19e1c95583ce24fcd1f4387099f26496ae2ae7458bf57499097200f0c4b5a960941bd416349
+  metadata.gz: f36c7eaac6931d92299889d86ce4fc9858cc2461e5f05a0f4e0a9ebfc3805ea46a2ec3b95368c2a21b3722e4a6ca90cc5c51deef1519a29882bc0a3b46099957
+  data.tar.gz: ab63c7fc6ee12cac7e7f6b837c4c672ba41551bc985780052c2a3d42ce3820ea594d4e9913621be55a3a61afb8f4b33697a0940055a690902c99556d39cdd501

data/bin/proto-convert

@@ -32,73 +32,62 @@
 require 'optparse'
 require 'English'
 
-VERSION = '0.3.0'
+VERSION = '0.4.1'
 AUTHOR_NAME = 'Azeem Sajid'
 AUTHOR_EMAIL = '<azeem.sajid@gmail.com>'
 AUTHOR_INFO = "Author: #{AUTHOR_NAME} #{AUTHOR_EMAIL}"
 AUTHOR_GITHUB = 'GitHub: https://github.com/iamAzeem/proto-convert'
 
-$debug = false
+$verbose = false
 
 def compile_proto(filename)
-  puts "\n>> Compiling [#{filename}]" if $debug
+  puts "\n>> Compile .proto file" if $verbose
 
   file_path = File.expand_path(filename)
   file_dir = File.dirname(file_path)
 
-  if $debug
-    puts "   File path: #{file_path}"
+  if $verbose
     protoc_version = `protoc --version`.chomp.split(' ')[1]
-    puts "   Running protoc #{protoc_version}:"
+    puts "   protoc version  : #{protoc_version}"
+    puts "   proto file path : #{file_path}"
   end
 
-  protoc_cmd =
-    "     protoc \\\n" \
-    "       --ruby_out=#{file_dir} \\\n" \
-    "       --proto_path=#{file_dir} \\\n" \
-    "       #{file_path}"
+  protoc_cmd = "protoc --ruby_out=\"#{file_dir}\" --proto_path=\"#{file_dir}\" \"#{file_path}\""
 
-  puts "\n#{protoc_cmd}" if $debug
+  puts "\n     #{protoc_cmd}" if $verbose
 
   `#{protoc_cmd}`
-  raise StandardError, "Invalid schema! [#{filename}] Resolve error(s)." unless $CHILD_STATUS.success?
-
-  puts "\n   Compiled [#{file_path}] " if $debug
+  abort "ERROR: Invalid schema! [#{filename}] Resolve error(s)." unless $CHILD_STATUS.success?
 
   compiled_proto = "#{file_dir}/#{File.basename(file_path, '.proto')}_pb.rb"
-  puts "   Validating [#{compiled_proto}]" if $debug
-  raise StandardError, "Compiled schema not found! [#{compiled_proto}]" unless File.file?(compiled_proto)
+  abort "ERROR: Compiled schema not found! [#{compiled_proto}]" unless File.file?(compiled_proto)
 
-  if $debug
-    puts "   Validatd [#{compiled_proto}]"
-    puts "<< Compilion and validation complete! [#{file_path} => #{compiled_proto}]"
-  end
+  puts "\n   generated file  : #{compiled_proto}" if $verbose
 
   compiled_proto
 end
 
 def valid_msgtype?(compiled_proto, msg_type)
-  puts "\n>> Validating msgtype [#{msg_type}] in [#{compiled_proto}]" if $debug
-
   msg_types = []
   File.foreach(compiled_proto) do |line|
-    if line.lstrip.start_with?('add_message')
-      extracted_msg_type = line[/"([^"]*)"/, 1].freeze # regex: <add_message> 'msg_type' <do>
+    if line.include?('::Google::Protobuf::DescriptorPool.generated_pool.lookup')
+      extracted_msg_type = line[/"([^"]*)"/, 1].freeze
       msg_types.push(extracted_msg_type) unless extracted_msg_type.nil?
     end
   end
 
-  is_valid = msg_types.include?(msg_type)
-
-  if $debug
-    puts "   msgtype [#{msg_type}] available? #{is_valid ? 'yes' : 'no'}"
-    puts '   Available types:'
-    msg_types.each do |t|
-      puts "   - #{t}"
-    end
+  if $verbose
+    puts "\n>> Validate msgtype"
+    puts "   msgtype : #{msg_type}"
+    puts "   pb file : #{compiled_proto}"
+    puts "   pb types: #{msg_types}"
   end
 
-  puts "<< Validation of msgtype [#{msg_type}] complete!" if $debug
+  is_valid = msg_types.include?(msg_type)
+  unless is_valid
+    puts "ERROR: Invalid msgtype! [#{msg_type}]"
+    puts "       Available types: #{msg_types}"
+  end
 
   is_valid
 end
@@ -109,11 +98,20 @@ def msg_class(compiled_proto, msg_type)
   msg.msgclass
 end
 
-def convert(compiled_proto, msg_type, conversion_mode, input_file, output_file)
-  puts "\n>> Converting [#{input_file}], mode: #{conversion_mode}" if $debug
+def convert(compiled_proto, args)
+  msg_type = args[:msgtype]
+  conversion_mode = args[:mode]
+  input_file = args[:input]
+  output_file = args[:output]
+
+  if $verbose
+    puts "\n>> Convert"
+    puts "   file : #{input_file}"
+    puts "   mode : #{conversion_mode}"
+  end
 
   pb_msg_class = msg_class(compiled_proto, msg_type)
-  raise StandardError, "Message type ['#{msg_type}'] not registered!'" if pb_msg_class.nil?
+  abort "ERROR: Message type ['#{msg_type}'] not registered!'" if pb_msg_class.nil?
 
   begin
     case conversion_mode
@@ -137,27 +135,30 @@ def convert(compiled_proto, msg_type, conversion_mode, input_file, output_file)
       puts "<< [B] #{output_file} (#{output_msg.length} bytes)"
     end
   rescue Google::Protobuf::ParseError
-    raise StandardError, "Incompatible input message! [msgtype: #{msg_type}] #{$ERROR_INFO}"
+    abort "ERROR: Incompatible input message! [msgtype: #{msg_type}] #{$ERROR_INFO}"
   rescue StandardError
-    raise StandardError, "Conversion failed! #{$ERROR_INFO}"
+    abort "ERROR: Conversion failed! #{$ERROR_INFO}"
   end
 
-  puts ">> Converion complete! [#{input_file}] => [#{output_file}]" if $debug
+  puts ">> Converted! [#{input_file}] => [#{output_file}]" if $verbose
 end
 
 def start
   mandatory_args = %i[mode proto msgtype input output].freeze
 
-  options = {}
-  mandatory_args.each { |arg| options[arg] = nil }
+  args = {}
+  mandatory_args.each { |arg| args[arg] = nil }
 
   parser = OptionParser.new do |opts|
     opts.banner = "Usage: #{$PROGRAM_NAME} -m [mode] -p [proto] -t [msgtype] -i [input] -o [output]"
-    opts.separator ''
+    opts.separator "\nOPTIONS:\n\n"
 
     modes = %i[binary2json b2j json2binary j2b].freeze
-    opts.on('-m', '--mode [MODE]', modes, "conversion mode #{modes.map(&:to_s)}") do |mode|
-      raise OptionParser::InvalidArgument unless modes.include?(mode)
+    opts.on('-m', '--mode [MODE]', String, "conversion mode #{modes.map(&:to_s)}") do |mode|
+      abort 'ERROR: Missing mode!' if mode.nil?
+
+      mode = mode.to_sym
+      abort "ERROR: Invalid mode! [#{mode}]" unless modes.include?(mode)
 
       case mode
       when :b2j
@@ -166,35 +167,40 @@ def start
         mode = :json2binary
       end
 
-      options[:mode] = mode
+      args[:mode] = mode
     end
 
-    opts.on('-p', '--proto [FILENAME]', 'protobuf schema (.proto)') do |filename|
-      raise StandardError, "Protobuf schema not found! [#{filename}]" unless File.file?(filename)
+    opts.on('-p', '--proto [FILENAME]', String, 'protobuf schema (.proto file)') do |filename|
+      abort 'ERROR: Missing schema filename!' if filename.nil?
+      abort "ERROR: Protobuf schema not found! [#{filename}]" unless File.file?(filename)
 
-      options[:proto] = filename
+      args[:proto] = filename
     end
 
-    opts.on('-t', '--msgtype [TYPE]', 'fully-qualified message type') do |msgtype|
-      options[:msgtype] = msgtype
+    opts.on('-t', '--msgtype [TYPE]', String, 'fully-qualified message type') do |msgtype|
+      abort 'ERROR: Missing msgtype!' if msgtype.nil?
+
+      args[:msgtype] = msgtype
     end
 
-    opts.on('-i', '--input [FILENAME]', 'source file (JSON/binary)') do |filename|
-      raise StandardError, "Source/input file not found! [#{filename}]" unless File.file?(filename)
+    opts.on('-i', '--input [FILENAME]', String, 'source file (JSON/binary)') do |filename|
+      abort 'ERROR: Missing input filename!' if filename.nil?
+      abort "ERROR: Input file not found! [#{filename}]" unless File.file?(filename)
 
-      options[:input] = filename
+      args[:input] = filename
     end
 
-    opts.on('-o', '--output [FILENAME]', 'destination file (binary/JSON)') do |filename|
-      options[:output] = filename
+    opts.on('-o', '--output [FILENAME]', String, 'destination file (binary/JSON)') do |filename|
+      abort 'ERROR: Missing output filename!' if filename.nil?
+
+      args[:output] = filename
     end
 
-    opts.on('-d', '--debug', 'prints debugging information') do
-      options[:debug] = true
-      $debug = true
+    opts.on('-v', '--verbose', 'print verbose information') do
+      $verbose = true
     end
 
-    opts.on('-h', '--help', 'prints help') do
+    opts.on('-h', '--help', 'print help') do
       puts "#{$PROGRAM_NAME} #{VERSION}\n\n#{opts}\n#{AUTHOR_INFO}\n#{AUTHOR_GITHUB}"
       exit
     end
@@ -203,40 +209,31 @@ def start
   begin
     parser.parse!
 
-    puts ">> #{$PROGRAM_NAME} #{VERSION} [debug mode]" if $debug
+    puts ">> #{$PROGRAM_NAME} #{VERSION} [verbose mode]" if $verbose
 
     # Validate missing mandatory arguments
-    missing_args = mandatory_args.select { |arg| options[arg].nil? }
-    raise OptionParser::MissingArgument, 'No arguments provided!' if missing_args.length == mandatory_args.length
-    raise OptionParser::MissingArgument, "--#{missing_args.join(', --')}" unless missing_args.empty?
+    missing_args = mandatory_args.select { |arg| args[arg].nil? }
+    abort "ERROR: Missing required arguments! --#{missing_args.join(', --')}" unless missing_args.empty?
 
-    if $debug
-      puts "\n>> Arguments:"
-      options.each do |arg, val|
+    if $verbose
+      puts "\n>> Arguments"
+      args.each do |arg, val|
         puts format('   %<arg>8s : %<val>s', arg: arg, val: val)
       end
     end
 
     # Compile and validate proto and msgtype
-    compiled_proto = compile_proto(options[:proto])
-    msg_type = options[:msgtype]
-    raise OptionParser::InvalidArgument, "--msgtype #{msg_type}" unless valid_msgtype?(compiled_proto, msg_type)
-
-    # Convert and write to output file
-    conversion_mode = options[:mode]
-    input_file = options[:input]
-    output_file = options[:output]
-    convert(compiled_proto, msg_type, conversion_mode, input_file, output_file)
+    compiled_proto = compile_proto(args[:proto])
+    abort unless valid_msgtype?(compiled_proto, args[:msgtype])
+
+    convert(compiled_proto, args)
   rescue OptionParser::InvalidOption, OptionParser::InvalidArgument, OptionParser::MissingArgument
     puts $ERROR_INFO
-    puts "\n#{$PROGRAM_NAME} #{VERSION}\n\n#{parser}\n#{AUTHOR_INFO}"
-    exit 1
+    abort "\n#{$PROGRAM_NAME} #{VERSION}\n\n#{parser}\n#{AUTHOR_INFO}\n#{AUTHOR_GITHUB}"
   rescue LoadError
-    puts "ERROR: Possible 'import' issue! #{$ERROR_INFO}"
-    exit 1
+    abort "ERROR: Possible 'import' issue! #{$ERROR_INFO}"
   rescue StandardError
-    puts "ERROR: #{$ERROR_INFO}"
-    exit 1
+    abort "ERROR: #{$ERROR_INFO}"
   ensure
     File.delete(compiled_proto) if !compiled_proto.nil? && File.file?(compiled_proto)
   end

metadata

@@ -1,35 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: proto-convert
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Azeem Sajid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-14 00:00:00.000000000 Z
+date: 2023-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
@@ -37,9 +37,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.12'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.12.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -47,11 +44,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.12'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.12.2
-description: A command-line tool to convert protobuf messages from binary to JSON
-  and vice versa
+description: a CLI tool to convert protobuf messages from binary to JSON and vice
+  versa
 email:
 - azeem.sajid@gmail.com
 executables:
@@ -64,7 +58,7 @@ homepage: https://github.com/iamAzeem/proto-convert
 licenses:
 - MIT
 metadata: {}
-post_install_message: Thanks for installing! :)
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -79,8 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.9
 signing_key: 
 specification_version: 4
 summary: Protobuf Message Converter [Binary <-> JSON]