add support for format option and json bom output

Signed-off-by: Jeffrey Zhang <[email protected]>

Author: jeffreysfllo24

README.md

@@ -29,9 +29,10 @@ cyclonedx-ruby [options]
 
     `-v, --[no-]verbose` Run verbosely
     `-p, --path path` Path to Ruby project directory
+    `-f, --format` Bom output format
     `-h, --help` Show help message
 
-**Output:** bom.xml file in project directory
+**Output:** bom.xml or bom.json file in project directory
 
 #### Example
 ```bash

lib/bom_builder.rb

@@ -31,13 +31,14 @@
 require 'rest_client'
 require 'securerandom'
 require_relative 'bom_helpers'
+require 'active_support/core_ext/hash'
 
 class Bombuilder
   def self.build(path)
     original_working_directory = Dir.pwd
     setup(path)
     specs_list
-    bom = build_bom(@gems)
+    bom = build_bom(@gems, @bom_output_format)
 
     begin
       @logger.info("Changing directory to the original working directory located at #{original_working_directory}")
@@ -84,6 +85,9 @@ def self.setup(path)
       opts.on('-o', '--output bom_file_path', '(Optional) Path to output the bom.xml file to') do |bom_file_path|
         @options[:bom_file_path] = bom_file_path
       end
+      opts.on('-f', '--format bom_output_format', '(Optional) Output format for bom. Currently support xml (default) and json.') do |bom_output_format|
+        @options[:bom_output_format] = bom_output_format
+      end
       opts.on_tail('-h', '--help', 'Show help message') do
         puts opts
         exit
@@ -119,8 +123,17 @@ def self.setup(path)
       abort
     end
 
+    if @options[:bom_output_format].nil? || @options[:bom_output_format] == "xml"
+      @bom_output_format = 'xml'
+    elsif @options[:bom_output_format] == "json"
+      @bom_output_format = 'json'
+    else
+      @logger.error("Unrecognized cyclonedx bom output format provided: #{@options[:bom_output_format]}")
+      abort
+    end
+
     @bom_file_path = if @options[:bom_file_path].nil?
-                       './bom.xml'
+                       "./bom.#{@bom_output_format}"
                      else
                        @options[:bom_file_path]
                      end

lib/bom_helpers.rb

@@ -29,7 +29,7 @@ def random_urn_uuid
   "urn:uuid:#{SecureRandom.uuid}"
 end
 
-def build_bom(gems)
+def build_bom(gems, format)
   builder = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
     attributes = { 'xmlns' => 'http://cyclonedx.org/schema/bom/1.1', 'version' => '1', 'serialNumber' => random_urn_uuid }
     xml.bom(attributes) do
@@ -61,7 +61,16 @@ def build_bom(gems)
       end
     end
   end
-  builder.to_xml
+
+  xml = builder.to_xml
+
+  # Format verified to be either xml (default) or json in setup
+  if format == 'json'
+    JSON.pretty_generate(Hash.from_xml(xml))
+  else
+    xml
+  end
+
 end
 
 def get_gem(name, version)