csa-ccm 0.1.2 → 0.1.3

data/lib/csa/ccm/answer.rb

@@ -3,32 +3,19 @@ module Csa::Ccm
 class Answer
 
   ATTRIBS = %i(
-    id content
-    control-id question-id
-    notes
+    control_id
+    question_id
+    answer
+    comment
   )
 
   attr_accessor *ATTRIBS
 
   def initialize(options={})
-    @examples = []
-    @notes = []
-
-    # puts "options #{options.inspect}"
-
     options.each_pair do |k, v|
-      next unless v
-      case k
-      when /^example/
-        @examples << v
-      when /^note/
-        @notes << v
-      else
-        # puts"Key #{k}"
-        key = k.gsub("-", "_")
-        self.send("#{key}=", v)
-      end
+      self.send("#{k}=", v)
     end
+
     self
   end
 
@@ -42,16 +29,6 @@ class Answer
       end
     end
   end
-
-  # # entry-status
-  # ## Must be one of notValid valid superseded retired
-  # def entry_status=(value)
-  #   unless %w(notValid valid superseded retired).include?(value)
-  #     value = "notValid"
-  #   end
-  #   @entry_status = value
-  # end
-
 end
 
 end

data/lib/csa/ccm/cli/command.rb

@@ -11,101 +11,106 @@ module Csa
         desc 'ccm-yaml VERSION', 'Generating a machine-readable CCM/CAIQ'
         option :output_file, aliases: :o, type: :string, desc: 'Optional output YAML file. If missed, the input file’s name will be used'
 
-        def ccm_yaml(version)
-          input_files = Resource.lookup_version(version)
+        def ccm_yaml(caiq_version)
+          input_files = Resource.lookup_version(caiq_version)
 
-          unless input_files || !input_files.empty?
-            UI.say("No file found for #{version} version")
+          unless input_files && !input_files.empty?
+            UI.say("No file found for #{caiq_version} version")
             return
           end
 
           input_file = input_files.first
 
           unless File.exist? input_file
-            UI.say('No file found for version')
+            UI.say("#{input_file} doesn't exists for #{caiq_version} version")
             return
           end
 
-          matrix = Matrix.from_xlsx(version, input_file)
+          matrix = Matrix.from_xlsx(input_file)
 
-          output_file = options[:output_file] || "caiq-#{version}.yaml"
-          matrix.to_file(output_file)
+          output_file = options[:output_file] || "caiq-#{matrix.version}.yaml"
+          matrix.to_control_file(output_file)
         end
 
-        desc "xlsx2yaml XSLT_PATH", "Converting CCM XSLX to YAML"
+        desc "xlsx2yaml XLSX_PATH", "Converting CCM XSLX to YAML"
         option :output_file, aliases: :o, type: :string, desc: "Optional output YAML file. If missed, the input file’s name will be used"
 
-        def xlsx2yaml(xslt_path)
-          raise 'Not implemented yet'
+        def xlsx2yaml(input_xlsx_file)
+          unless input_xlsx_file
+            UI.say("#{input_xlsx_file} file doesn't exists")
+            return
+          end
+
+          matrix = Matrix.from_xlsx(input_xlsx_file)
+
+          output_file = options[:output_file] || input_xlsx_file.gsub('.xlsx', '.yaml')
+          matrix.to_control_file(output_file)
         end
 
-        desc "caiq2yaml XSLT_PATH", "Converting a filled CAIQ to YAML"
+        desc "caiq2yaml XLSX_PATH", "Converting a filled CAIQ to YAML"
         option :output_name, aliases: :n, type: :string, desc: "Optional output CAIQ YAML file. If missed, the input file’s name will be used"
         option :output_path, aliases: :p, type: :string, desc: "Optional output directory for result file. If missed pwd will be used"
 
-        def caiq2yaml(xslt_path)
-          # if xslt_path.nil?
-          #   puts 'Error: no filepath given as first argument.'
-          #   exit 1
-          # end
-
-          # if Pathname.new(xslt_path).extname != ".xlsx"
-          #   puts 'Error: filepath given must have extension .xlsx.'
-          #   exit 1
-          # end
-
-          # workbook = Csa::Ccm::MatrixWorkbook.new(xslt_path)
-          # workbook.glossary_info.metadata_section.structure
-          # workbook.glossary_info.metadata_section.attributes
-
-          # languages = {}
-
-          # workbook.languages_supported.map do |lang|
-          #   puts "************** WORKING ON LANGUAGE (#{lang})"
-          #   sheet = workbook.language_sheet(lang)
-          #   termsec = sheet.terms_section
-          #   languages[sheet.language_code] = termsec.terms
-          # end
+        def caiq2yaml(input_xlsx_file)
+          unless input_xlsx_file
+            UI.say("#{input_xlsx_file} file doesn't exists")
+            return
+          end
 
-          # collection = Csa::Ccm::ControlDomain.new
+          matrix = Matrix.from_xlsx(input_xlsx_file)
 
-          # languages.each_pair do |lang, terms|
-          #   terms.each do |term|
-          #     collection.add_term(term)
-          #   end
-          # end
+          base_output_file = options[:output_name] || File.basename(input_xlsx_file.gsub('.xlsx', ''))
+          if options[:output_path]
+            base_output_file = File.join(options[:output_path], base_output_file)
+          end
 
-          # # collection[1206].inspect
+          control_output_file = "#{base_output_file}.control.yaml"
+          answers_output_file = "#{base_output_file}.answers.yaml"
 
-          # # FIXME use  instea output dir
-          # output_dir = options[:output_path] || Dir.pwd
-          # output_file = options[:output_name] || File.join(output_dir, Pathname.new(filepath).basename.sub_ext(".yaml"))
+          matrix.to_control_file(control_output_file)
+          matrix.to_answers_file(answers_output_file)
+        end
 
-          # collection.to_file(output_file)
+        desc "generate-with-answers ANSWERS_YAML", "Writing to the CAIQ XSLX template using YAML"
+        option :template_path, aliases: :t, type: :string, desc: "Optional input template CAIQ XSLT file. If missed -r will be checked"
+        option :caiq_version, aliases: :r, type: :string, default: "3.0.1", desc: "Optional input template CAIQ XSLT version. If missed -t will be checked"
+        option :output_file, aliases: :o, type: :string, desc: 'Optional output XSLT file. If missed, the input file’s name will be used'
 
-          # collection_output_dir = File.join(output_dir, "concepts")
+        def generate_with_answers(answers_yaml_path)
+          unless File.exist? answers_yaml_path
+            UI.say("#{answers_yaml_path} file doesn't exists")
+            return
+          end
 
-          # FileUtils.mkdir_p(collection_output_dir)
+          unless options[:template_path] || options[:caiq_version]
+            UI.say("No input template specified by -r or -t")
+            return
+          end
 
-          # collection.keys.each do |id|
-          #   collection[id].to_file(File.join(collection_output_dir, "concept-#{id}.yaml"))
-          # end
+          template_xslt_path = options[:template_path]
+          unless template_xslt_path
+            caiq_version = options[:caiq_version]
+            input_files = Resource.lookup_version(caiq_version)
 
-          # french = workbook.language_sheet("French")
-          # french.sections[3].structure
-          # french.sections[3].terms
+            unless input_files && !input_files.empty?
+              UI.say("No file found for #{caiq_version} version")
+              return
+            end
 
-          # english = workbook.language_sheet("English")
-          # english.terms_section
-          # english.terms_section.terms
+            template_xslt_path = input_files.first
+          end
 
-          #pry.binding
-        end
+          unless File.exist? template_xslt_path
+            UI.say("#{template_xslt_path} file doesn't exists")
+            return
+          end
 
-        desc "generate-with-answers ANSWERS_YAML", "Writing to the CAIQ XSLX template using YAML"
+          output_file = options[:output_file]
+          unless options[:output_file]
+            output_file = "#{answers_yaml_path.gsub('answers.yaml', '')}.xlsx"
+          end
 
-        def generate_with_answers(answers)
-          raise 'Not implemented yet'
+          Matrix.fill_answers(answers_yaml_path, template_xslt_path, output_file)
         end
       end
     end

data/lib/csa/ccm/cli/resource.rb

@@ -1,4 +1,3 @@
-require 'rubyXL'
 require 'yaml'
 
 require_relative '../../../ext/string'
@@ -15,14 +14,6 @@ module Csa
           Dir["#{root_gem}/resources/**/*v#{version}*.xlsx"]
         end
 
-        def self.from_xlsx(xslt_path)
-          raise 'Not implemented yet'
-        end
-
-        def from_caiq(xslt_path, output_name, output_path)
-          raise 'Not implemented yet'
-        end
-
         def self.to_file(hash, output_file)
           File.open(output_file, 'w') { |f| f.write hash.to_yaml(line_width: 9999) }
         rescue Errno::ENOENT => e

data/lib/csa/ccm/cli/version.rb

@@ -1,7 +1,7 @@
 module Csa
   module Ccm
   	module Cli
-      VERSION = "0.1.2"
+      VERSION = "0.1.3"
     end
   end
 end

data/lib/csa/ccm/control.rb

@@ -2,7 +2,7 @@ module Csa::Ccm
 
 class Control
   ATTRIBS = %i(
-    id name specification questions
+    id title specification questions
   )
 
   attr_accessor *ATTRIBS
@@ -22,11 +22,9 @@ class Control
       value = self.send(attrib)
 
       unless value.nil?
+
         if attrib == :questions
-          value = value.inject([]) do |acc, (k, v)|
-            acc << v.to_hash
-            acc
-          end
+          value = value.values.map(&:to_hash)
         end
 
         acc.merge(attrib.to_s => value)

data/lib/csa/ccm/control_domain.rb

@@ -4,7 +4,7 @@ module Csa::Ccm
 
 class ControlDomain
   ATTRIBS = %i(
-    id name controls
+    id title controls
   )
 
   attr_accessor *ATTRIBS
@@ -25,10 +25,7 @@ class ControlDomain
 
       unless value.nil?
         if attrib == :controls
-          value = value.inject([]) do |acc, (k, v)|
-            acc << v.to_hash
-            acc
-          end
+          value = value.values.map(&:to_hash)
         end
 
         acc.merge(attrib.to_s => value)

data/lib/csa/ccm/matrix.rb

@@ -1,26 +1,36 @@
-require_relative "control_domain"
-require_relative "control"
-require_relative "question"
+require_relative 'control_domain'
+require_relative 'control'
+require_relative 'question'
+require_relative 'answer'
+
+require 'rubyXL'
+require 'rubyXL/convenience_methods/cell'
+require 'rubyXL/convenience_methods/workbook'
+require 'rubyXL/convenience_methods/worksheet'
 
 module Csa::Ccm
 
 class Matrix
-  ATTRIBS = %i(
-    version title source_file workbook source_path control_domains
-  )
+
+  ATTRIBS = %i[
+    version title source_file workbook source_path control_domains answers
+  ].freeze
 
   attr_accessor *ATTRIBS
 
-  def initialize(options={})
-    options.each_pair do |k,v|
-      self.send("#{k}=", v)
+  def initialize(options = {})
+    options.each_pair do |k, v|
+      send("#{k}=", v)
     end
 
     if source_path
       @workbook = RubyXL::Parser.parse(source_path)
+
+      parse_version if version.nil?
     end
 
     @control_domains ||= {}
+    @answers ||= []
 
     self
   end
@@ -29,10 +39,25 @@ class Matrix
     @source_file || File.basename(source_path)
   end
 
+  def parse_version
+    title_prefix = 'consensus assessments initiative questionnaire v'
+    first_row = workbook[0][0]
+
+    if first_row[2].value.downcase.start_with? title_prefix # version v3.0.1
+      self.version = first_row[2].value.downcase[title_prefix.length..-1]
+    elsif first_row[0].value.downcase.start_with? title_prefix # version v1.1
+      self.version = first_row[0].value.downcase[title_prefix.length..-1]
+    else # version 1.0
+      self.version = workbook[1][0][0].value[/(?<=Version )(\d+\.?)+(?= \()/]
+    end
+  end
+
   def worksheet
     workbook.worksheets.first
   end
 
+  attr_reader :workbook
+
   def title
     worksheet = workbook.worksheets.first
     worksheet[0][2].value
@@ -47,11 +72,11 @@ class Matrix
   end
 
   class Row
-    ATTRIBS = %i(
+    ATTRIBS = %i[
       control_domain_id control_id question_id control_spec
-      question_content answer_yes answer_no answer_na notes
+      question_content answer_yes answer_no answer_na comment
       control_domain_description
-    )
+    ].freeze
 
     attr_accessor *ATTRIBS
 
@@ -64,10 +89,21 @@ class Matrix
       @answer_yes = ruby_xl_row[5].value
       @answer_no = ruby_xl_row[6].value
       @answer_na = ruby_xl_row[7].value
+      @comment = ruby_xl_row[8].value
+
+      # In 3.0.1 2017-09-01, question_id for "AIS-02.2" is listed as "AIS- 02.2"
+      %w[control_id question_id].each do |field|
+        if val = send(field)
+          send("#{field}=", val.gsub(/\s/, ''))
+        end
+      end
 
       # In 3.0.1 2017-09-01, Rows 276 and 277's control ID says "LG-02" but it should be "STA-05" instead.
-      @control_id = question_id.split(".").first if question_id
-      @control_domain_id = control_id.split("-").first if control_id
+      if @control_id.nil? && @question_id
+        @control_id = @question_id.split('.').first
+      end
+
+      @control_domain_id = control_id.split('-').first if @control_id
 
       # puts "HERE IN ROW! #{ruby_xl_row.cells.map(&:value)}"
 
@@ -78,16 +114,18 @@ class Matrix
       self
     end
 
-    def control_domain_name
+    def control_domain_title
       return nil if control_domain_description.nil?
-      name, _, control_name = control_domain_description.split(/(\n)/)
+
+      name, = control_domain_description.split(/(\n)/)
       name
     end
 
-    def control_name
+    def control_title
       return nil if control_domain_description.nil?
-      name, _, control_name = control_domain_description.split(/(\n)/)
-      control_name
+
+      _, _, control_title = control_domain_description.split(/(\n)/)
+      control_title
     end
   end
 
@@ -95,27 +133,34 @@ class Matrix
     Row.new(worksheet[i])
   end
 
-  def self.from_xlsx(version, input_file)
+  def self.get_start_row(version)
+    case version
+    when '1.0'
+      2
+    when '1.1'
+      3
+    else
+      # '3.0.1' and assume beyond
+      4
+    end
+  end
+
+  def self.version_from_filepath(input_file)
+    input_file[/(?<=v)[0-9\.]*(?=-)/] || 'unknown'
+  end
+
+  def self.from_xlsx(input_file)
     matrix = Matrix.new(
-      version: version,
       source_path: input_file
     )
 
     all_rows = matrix.worksheet.sheet_data.rows
-    start_row = 4 # FIXME add some basic logic to calculate it
-
-    last_control_domain = nil
-    last_control_id = nil
-    last_control_specification = nil
 
-    worksheet = matrix.worksheet
-
-    row_number = start_row
+    start_row = get_start_row(matrix.version)
     max_row_number = all_rows.length - 1
 
     # We loop over all Questions
     (start_row..max_row_number).each do |row_number|
-
       # puts "looping row #{row_number}"
       row = matrix.row(row_number)
       # Skip row if there is no question-id
@@ -130,10 +175,10 @@ class Matrix
       unless domain_id.nil?
 
         control_domain = matrix.control_domains[domain_id] ||
-          ControlDomain.new(
-            id: row.control_domain_id,
-            name: row.control_domain_name
-          )
+                         ControlDomain.new(
+                           id: row.control_domain_id,
+                           title: row.control_domain_title
+                         )
 
         # puts"control_domain #{control_domain.to_hash}"
 
@@ -147,7 +192,7 @@ class Matrix
         control_domain = matrix.control_domains[domain_id]
         control = control_domain.controls[control_id] || Control.new(
           id: row.control_id,
-          name: row.control_name,
+          title: row.control_title,
           specification: row.control_spec
         )
 
@@ -160,28 +205,104 @@ class Matrix
       # Store the Question
       # putsquestion.to_hash
       control.questions[row.question_id] = Question.new(id: row.question_id, content: row.question_content)
+
+      answer = if row.answer_na
+                 'NA'
+               elsif row.answer_no
+                 'no'
+               elsif row.answer_yes
+                 'yes'
+      end
+
+      matrix.answers << Answer.new(
+        question_id: row.question_id,
+        control_id: control_id,
+        answer: answer,
+        comment: row.comment
+      )
     end
 
     matrix
   end
 
-  def to_hash
+  def self.fill_answers(answers_yaml_path, template_xslt_path, output_xslt_path)
+    ccm = YAML.safe_load(File.read(answers_yaml_path, encoding: 'UTF-8'))['ccm']
+    answers = ccm['answers']
+    answers_hash = Hash[*answers.collect { |a| [a['question-id'], a] }.flatten]
+    answers_version = ccm['metadata']['version']
+    template_version = version_from_filepath(template_xslt_path)
+
+    unless template_version == answers_version
+      raise "Template XLSX & answers YAML version missmatch #{template_version} vs. #{answers_version}"
+    end
+
+    matrix = Matrix.new(
+      version: template_version,
+      source_path: template_xslt_path
+    )
+
+    worksheet = matrix.worksheet
+    all_rows = worksheet.sheet_data.rows
+
+    start_row = get_start_row(matrix.version)
+    max_row_number = all_rows.length - 1
+
+    (start_row..max_row_number).each do |row_number|
+      question_id = worksheet[row_number][2].value
+
+      next unless answers_hash.key?(question_id)
+
+      answer = answers_hash[question_id]
+      answer_value = answer['answer']
+
+      answer_col = case answer_value
+                   when 'yes', true
+                     5
+                   when 'no', false
+                     6
+                   when 'NA'
+                     7
+                   end
+
+      worksheet[row_number][answer_col].change_contents(answer['notes'])
+    end
+
+    matrix.workbook.write(output_xslt_path)
+    worksheet
+  end
+
+  def to_control_hash
     {
-      "ccm" => {
-        "metadata" => metadata.to_hash,
-        "control_domains" => control_domains.inject([]) do |acc, (k, v)|
-            acc << v.to_hash
-            acc
-          end
+      'ccm' => {
+        'metadata' => metadata.to_hash,
+        'control_domains' => control_domains.each_with_object([]) do |(_k, v), acc|
+                               acc << v.to_hash
+                             end
       }
     }
   end
 
-  def to_file(filename)
-    File.open(filename,"w") do |file|
-      file.write(to_hash.to_yaml)
+  def to_answers_hash
+    {
+      'ccm' => {
+        'metadata' => metadata.to_hash,
+        'answers' => answers.each_with_object([]) do |v, acc|
+                       acc << v.to_hash
+                     end
+      }
+    }
+  end
+
+  def to_control_file(filename)
+    File.open(filename, 'w') do |file|
+      file.write(to_control_hash.to_yaml)
     end
   end
 
+  def to_answers_file(filename)
+    File.open(filename, 'w') do |file|
+      file.write(to_answers_hash.to_yaml)
+    end
+  end
+end
 end
-end