defmastership 1.3.3 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 568d3b059a4327d2b486468b9867230d3547f9f499134c85e6c1d013761373a8
-  data.tar.gz: 8b9bf9d9abe528e104a3105a5ebd7c9fc83060282e56b81c7dfab8509eaa3b97
+  metadata.gz: 7005c6bf64a1de44a7ac2f511070d4233ec8abde7816df47ceb1219c77500732
+  data.tar.gz: 219352e005a6e87d02258caacc30ad537e3d644da8dc008b1d4b958e70f33fcc
 SHA512:
-  metadata.gz: 21e893b27a124ae1cdd50fa3312f06fa767d87cd44953f3f5b133e29c7bf6c21bd9f53c5683738c27bafa5050159be2f548068433995d15c45b442df9b136ceb
-  data.tar.gz: d04e16d41f24eee527638d475101080de60115cdaabd8ee48cc2b81084256cb1db6556ca8f5ecf9b123154b45b2b7be77b6af5a8ba56877eaa6ec9338b7d27fe
+  metadata.gz: 5a80ed40ddcf6300da7287b30e5e5c10bb4789aca80ef2c927a85056987c6831022e18e2459ac72633b408f05d3ab564292d96611c282f19e73d173534eadf91
+  data.tar.gz: 218bad889104732f8ba69f00b0313b7a8327ddffb7ea5bfd2e2fac66b4dd38ae37efacf7f0033be576b32924bececafa4582c02a7cf458bc9c81ed2474cbacbd

data/Gemfile

@@ -11,13 +11,13 @@ group :development do
   # cucumber steps for command line tests
   gem 'aruba',                 '~> 2.3'
   # bdd
-  gem 'cucumber',              '~> 10.0'
+  gem 'cucumber',              '~> 10.2'
   # code duplication
-  gem 'flay',                  '~> 2.13'
+  gem 'flay',                  '~> 2.14'
   # automatic test run
   gem 'guard',                 '~> 2.19'
   # automatic update invocation
-  gem 'guard-bundler',         '~> 3.0'
+  # gem 'guard-bundler',         '~> 3.0'
   # automatic style check
   gem 'guard-reek',            '~> 1.2'
   # automatic tdd
@@ -31,21 +31,21 @@ group :development do
   # detect selling code
   gem 'reek',                  '~> 6.5'
   # needed by yard to render documentation
-  gem 'rdoc',                  '~> 6.14'
+  gem 'rdoc',                  '~> 7.0'
   # tdd
   gem 'rspec',                 '~> 3.13'
   # code needs to be clean
-  gem 'rubocop',               '~> 1.77'
+  gem 'rubocop',               '~> 1.82'
   # code needs to be clean
-  gem 'rubocop-performance',   '~> 1.25'
+  gem 'rubocop-performance',   '~> 1.26'
   # test code needs to be clean
-  gem 'rubocop-rspec',         '~> 3.6'
+  gem 'rubocop-rspec',         '~> 3.8'
   # Rakefiles need to be clean
   gem 'rubocop-rake',          '~> 0.7'
   # Doc need to be clean
-  gem 'rubocop-yard',          '~> 0.10'
+  gem 'rubocop-yard',          '~> 1.0'
   # my code needs to be critiqued
-  gem 'rubycritic',            '~> 4.9'
+  gem 'rubycritic',            '~> 4.11'
   # What is tdd without code coverage ?
   gem 'simplecov',             '~> 0.22'
   # to document code

data/Rakefile

@@ -10,7 +10,7 @@ task :ci do
   [
     'test:spec',
     'test:features',
-    :rubocop
+    'quality:all'
   ].each do |name|
     puts "\n=== Running #{name}...\n"
     Rake::Task[name].invoke

data/defmastership.gemspec

@@ -23,10 +23,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency('aasm', '~> 5.5')
   spec.add_dependency('asciidoctor', '~> 2.0')
   spec.add_dependency('csv', '~> 3.3')
-  spec.add_dependency('defmastership-core', '~> 1.5.3')
+  spec.add_dependency('defmastership-core', '~> 1.5.5')
   spec.add_dependency('facets', '~> 3.1')
-  spec.add_dependency('git', '~> 3.1')
+  spec.add_dependency('git', '~> 4.0')
   spec.add_dependency('gli', '~> 2.22')
   spec.add_dependency('memoist', '~> 0.16')
   spec.add_dependency('ostruct', '~> 0.6')
+  spec.add_dependency('rubyXL', '~> 3.4')
 end

data/features/changeref.feature

@@ -348,6 +348,36 @@ Feature: The changeref command
       | // tag::TOTO-TEMP-XXX1[]  Whatever | // tag::TOTO-0123[]  Whatever |
       | /* end::TOTO-TEMP-XXX1[] */        | /* end::TOTO-0123[] */        |
 
+  Scenario: Change definitions in subfolders, modify tags in included files
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :toto:
+      :type: change_ref
+      :config:
+        :from_regexp: TOTO-TEMP-[X\d]{4}
+        :to_template: TOTO-%<next_ref>04d
+        :next_ref: 123
+    """
+    And a directory named "any_path"
+    And a file named "any_path/thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1]
+    --
+    include::target[TOTO-TEMP-XXX1 ]
+    --
+    """
+    And a file named "any_path/target" with:
+    """
+    # tag::TOTO-TEMP-XXX1[]
+    """
+    When I successfully run `defmastership modify --modifications toto any_path/thedoc.adoc`
+    Then the stdout should not contain anything
+    And the file named "any_path/target" should contain:
+    """
+    # tag::TOTO-0123[]
+    """
+
   Scenario: Do not change definitions when in literal
     Given a file named "modifications.yml" with:
     """

data/features/export.feature

@@ -528,3 +528,58 @@ Feature: The export command
     ....",~7eb3c490
     """
     And the stdout should not contain anything
+
+  Scenario: Export one definition to xslx
+    Given a file named "toto.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    Exemple of multiline requirement.
+    Second line.
+    --
+    """
+    When I successfully run `defmastership export --format xlsx toto.adoc`
+    Then the file "toto.xlsx" should exist
+
+  Scenario: Export one definition to json
+    Given a file named "toto.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    Exemple of multiline requirement.
+    Second line.
+    --
+    """
+    When I successfully run `defmastership export --format json toto.adoc`
+    Then the file "toto.json" should contain:
+    """
+    [
+      {
+        "Type": "requirement",
+        "Reference": "TOTO-0001",
+        "Value": "Exemple of multiline requirement.\nSecond line.",
+        "Checksum": "~b86dcbde"
+      }
+    ]
+    """
+
+  Scenario: Export one definition to yaml
+    Given a file named "toto.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    Exemple of multiline requirement.
+    Second line.
+    --
+    """
+    When I successfully run `defmastership export --format yaml toto.adoc`
+    Then the file "toto.yaml" should contain:
+    """
+    ---
+    - :Type: requirement
+      :Reference: TOTO-0001
+      :Value: |-
+        Exemple of multiline requirement.
+        Second line.
+      :Checksum: "~b86dcbde"
+    """

data/features/rename_included_files.feature

@@ -56,6 +56,33 @@ Feature: The rename_included_files command
     And the file "any_path/one_file.png" should not exist
     And the file "any_path/TOTO-WHATEVER-123_one_file.png" should exist
 
+  Scenario: change the filename of a file included in a definition (sub directory)
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :rename_included_png:
+      :type: rename_included_files
+      :config:
+        :from_regexp: (?<origin>.*\.png)
+        :to_template: "%<reference>s_%<origin>s"
+    """
+    And a directory named "any_path"
+    And a file named "any_path/thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-WHATEVER-123]
+    include::one_file.png[]
+    """
+    And an empty file named "any_path/one_file.png"
+    When I successfully run `defmastership modify --modifications rename_included_png any_path/thedoc.adoc`
+    Then the stdout should not contain anything
+    And the file "any_path/thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-WHATEVER-123]
+    include::TOTO-WHATEVER-123_one_file.png[]
+    """
+    And the file "any_path/one_file.png" should not exist
+    And the file "any_path/TOTO-WHATEVER-123_one_file.png" should exist
+
   Scenario: change the filename with options in include macro
     Given a file named "modifications.yml" with:
     """

data/features/step_definitions/git_steps.rb

@@ -9,6 +9,9 @@ end
 
 Given('I add and commit the {string} file') do |filename|
   git = Git.open(Aruba.config.home_directory)
+
+  git.config('user.name', 'Bob Léponge')
+  git.config('user.email', 'bob.léponge@example.com')
   git.add(filename)
   git.commit('whatever')
 end

data/lib/defmastership/app.rb

@@ -6,6 +6,9 @@ require('defmastership/batch_modifier')
 require('defmastership/config_preserver')
 require('defmastership/document')
 require('defmastership/export/csv/formatter')
+require('defmastership/export/json/formatter')
+require('defmastership/export/xlsx/formatter')
+require('defmastership/export/yaml/formatter')
 require('defmastership/version')
 require('gli')
 
@@ -24,9 +27,36 @@ module Defmastership
     def self.configure_export_flags(command)
       command.flag(%i[separator sep s], default_value: ',', desc: 'CSV separator')
       command.flag(%i[output-file o], desc: 'CSV output filename')
+      command.flag(%i[format f], desc: 'Output format', default_value: 'csv')
       command.switch(%i[no-fail], desc: 'Exit success even in case of wrong explicit checksum')
     end
 
+    # Helper method
+    def self.do_the_export(my_doc, options, first_adoc_file)
+      format = options.fetch('format')
+      formatter = create_formatter(my_doc, format, options)
+      output_file = determine_output_file(options, first_adoc_file, format)
+
+      formatter.export_to(output_file)
+    end
+
+    class << self
+      private
+
+      # Responsibility: Create the correct formatter instance with its specific options.
+      def create_formatter(doc, format, options)
+        formatter_class = Object.const_get("Defmastership::Export::#{format.upcase}::Formatter")
+        formatter_options = format == 'xlsx' ? {} : { separator: options.fetch(:separator) }
+
+        formatter_class.new(doc, **formatter_options)
+      end
+
+      # Responsibility: Determine the final output filename.
+      def determine_output_file(options, first_adoc_file, format)
+        options.fetch(:'output-file') || first_adoc_file.sub(/(?<=\.)adoc$/, format)
+      end
+    end
+
     desc 'Export the definition database in CSV'
     arg 'asciidoctor_file'
     arg 'asciidoctor_file', %i[optional multiple]
@@ -38,9 +68,7 @@ module Defmastership
         my_doc = Defmastership::Document.new
         args.each { |adoc_file| my_doc.parse_file_with_preprocessor(adoc_file) }
 
-        output_file = options[:'output-file'] || args.first.sub(/\.adoc$/, '.csv')
-
-        Defmastership::Export::CSV::Formatter.new(my_doc, options['separator']).export_to(output_file)
+        App.do_the_export(my_doc, options, args.first)
 
         if my_doc.wrong_explicit_checksum?
           my_doc.definitions.each do |definition|

data/lib/defmastership/export/csv/formatter.rb

@@ -1,9 +1,7 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-require('csv')
-require('defmastership/export/body_formatter')
-require('defmastership/export/header_formatter')
+require('defmastership/export/formatter')
 
 module Defmastership
   # Module to host export classes
@@ -11,17 +9,17 @@ module Defmastership
     # Module to host CSV export classes
     module CSV
       # to export a CSV file
-      class Formatter
+      class Formatter < Defmastership::Export::Formatter
         # @param doc [Document] the document to export
-        # @param sep [String] the CSV separator
-        def initialize(doc, sep)
-          @doc = doc
-          @sep = sep
+        # @param separator [String] the CSV separator
+        def initialize(doc, separator: ',')
+          @sep = separator
+          super(doc)
         end
 
         # Export the document to a CSV file
         #
-        # @param output_file [Strinf] filename for the export
+        # @param output_file [String] filename for the export
         def export_to(output_file)
           column_list = build_column_list
           ::CSV.open(output_file, 'w:ISO-8859-1', col_sep: @sep) do |csv|
@@ -32,58 +30,8 @@ module Defmastership
 
         private
 
-        # Helper functions
-        module Helper
-          # @return [Array<Symbol>] the array of methods for columns inclusion
-          #
-          # @param column_spec [MethodSpec] the method to include or not with its guard
-          # @param doc [Document] the Document to export
-          def self.column_method(column_spec, doc)
-            column_spec.guard.call(doc) ? [column_spec.column_method] : []
-          end
-
-          # 2-uplet with  one method to include or not depending of a lambda guard
-          MethodSpec = Struct.new(:column_method, :guard)
-          public_constant :MethodSpec
-        end
-        private_constant :Helper
-
-        COLUMNS_METHODS_SPECIFICATIONS =
-          [
-            Helper::MethodSpec.new(:type,                    ->(_) { true }),
-            Helper::MethodSpec.new(:reference,               ->(_) { true }),
-            Helper::MethodSpec.new(:summary,                 lambda(&:summaries?)),
-            Helper::MethodSpec.new(:value,                   ->(_) { true }),
-            Helper::MethodSpec.new(:checksum,                ->(_) { true }),
-            Helper::MethodSpec.new(:wrong_explicit_checksum, lambda(&:wrong_explicit_checksum?)),
-            Helper::MethodSpec.new(:explicit_version,        lambda(&:explicit_version?)),
-            Helper::MethodSpec.new(:labels,                  ->(doc) { !doc.labels.empty? }),
-            Helper::MethodSpec.new(:eref,                    ->(doc) { !doc.eref.empty? }),
-            Helper::MethodSpec.new(:iref,                    lambda(&:iref)),
-            Helper::MethodSpec.new(:attributes,              ->(doc) { !doc.attributes.empty? })
-          ].freeze
-        private_constant :COLUMNS_METHODS_SPECIFICATIONS
-
         def export_definitions_in(csv, column_list)
-          @doc.definitions.each { |definition| csv << body(definition, column_list) }
-        end
-
-        def header(column_list)
-          header_formatter = HeaderFormatter.new(@doc)
-          header_line = column_list.map { |part| header_formatter.public_send(part) }
-          header_line.flatten
-        end
-
-        def body(definition, column_list)
-          body_formatter = BodyFormatter.new(@doc, definition)
-          body_line = column_list.map { |part| body_formatter.public_send(part) }
-          body_line.flatten
-        end
-
-        def build_column_list
-          COLUMNS_METHODS_SPECIFICATIONS.reduce([]) do |acc, column|
-            acc + Helper.column_method(column, @doc)
-          end
+          doc.definitions.each { |definition| csv << body(definition, column_list) }
         end
       end
     end

data/lib/defmastership/export/formatter.rb

@@ -0,0 +1,88 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require('defmastership/export/body_formatter')
+require('defmastership/export/header_formatter')
+
+module Defmastership
+  # Module to host export classes
+  module Export
+    # to export a CSV file
+    class Formatter
+      attr_reader :doc
+
+      # @param doc [Document] the document to export
+      def initialize(doc)
+        @doc = doc
+      end
+
+      # Export the document to a CSV file
+      #
+      # @param _output_file [String] filename for the export
+      def export_to(_output_file)
+        raise(NotImplementedError, "#{self.class} has not implemented the 'export_to' method")
+      end
+
+      # Build content of the header from the list of columns
+      #
+      # @param column_list [Array<Symbol>] List of columns to include
+      # @return [Array<String>] List of colums values
+      def header(column_list)
+        header_formatter = HeaderFormatter.new(doc)
+        header_line = column_list.map { |part| header_formatter.public_send(part) }
+        header_line.flatten
+      end
+
+      # Build content of a row from the list of columns
+      #
+      # @param definition [Definition] sourec of data
+      # @param column_list [Array<Symbol>] List of columns to include
+      # @return [Array<String>] List of colums values
+      def body(definition, column_list)
+        body_formatter = BodyFormatter.new(doc, definition)
+        body_line = column_list.map { |part| body_formatter.public_send(part) }
+        body_line.flatten
+      end
+
+      private
+
+      # Helper functions
+      module Helper
+        # @return [Array<Symbol>] the array of methods for columns inclusion
+        #
+        # @param column_spec [MethodSpec] the method to include or not with its guard
+        # @param doc [Document] the Document to export
+        def self.column_method(column_spec, doc)
+          column_spec.guard.call(doc) ? [column_spec.column_method] : []
+        end
+
+        # 2-uplet with  one method to include or not depending of a lambda guard
+        MethodSpec = Struct.new(:column_method, :guard)
+        public_constant :MethodSpec
+      end
+      public_constant :Helper
+
+      COLUMNS_METHODS_SPECIFICATIONS =
+        [
+          Helper::MethodSpec.new(:type,                    ->(_) { true }),
+          Helper::MethodSpec.new(:reference,               ->(_) { true }),
+          Helper::MethodSpec.new(:summary,                 lambda(&:summaries?)),
+          Helper::MethodSpec.new(:value,                   ->(_) { true }),
+          Helper::MethodSpec.new(:checksum,                ->(_) { true }),
+          Helper::MethodSpec.new(:wrong_explicit_checksum, lambda(&:wrong_explicit_checksum?)),
+          Helper::MethodSpec.new(:explicit_version,        lambda(&:explicit_version?)),
+          Helper::MethodSpec.new(:labels,                  ->(doc) { !doc.labels.empty? }),
+          Helper::MethodSpec.new(:eref,                    ->(doc) { !doc.eref.empty? }),
+          Helper::MethodSpec.new(:iref,                    lambda(&:iref)),
+          Helper::MethodSpec.new(:attributes,              ->(doc) { !doc.attributes.empty? })
+        ].freeze
+      private_constant :COLUMNS_METHODS_SPECIFICATIONS
+
+      def build_column_list
+        COLUMNS_METHODS_SPECIFICATIONS.reduce([]) do |acc, column|
+          acc + Helper.column_method(column, doc)
+        end
+      end
+    end
+  end
+end

data/lib/defmastership/export/json/formatter.rb

@@ -0,0 +1,34 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require('defmastership/export/formatter')
+require('json')
+
+module Defmastership
+  # Module to host export classes
+  module Export
+    # Module to host JSON export classes
+    module JSON
+      # to export a JSON file
+      class Formatter < Defmastership::Export::Formatter
+        # @param doc [Document] the document to export
+        # @param _options [Hash{Symbol => Object}] unused options
+        def initialize(doc, _options = {})
+          super(doc)
+        end
+
+        # Export the document to a JSON file
+        # @param output_file [String] filename for the export
+        def export_to(output_file)
+          column_list = build_column_list
+          header_column_list = header(column_list).map(&:to_sym)
+          definitions =
+            doc.definitions.map do |definition|
+              header_column_list.zip(body(definition, column_list)).to_h
+            end
+          File.write(output_file, ::JSON.pretty_generate(definitions))
+        end
+      end
+    end
+  end
+end

data/lib/defmastership/export/xlsx/formatter.rb

@@ -0,0 +1,87 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require('defmastership/export/body_formatter')
+require('defmastership/export/header_formatter')
+require('memoist')
+require('rubyXL')
+
+module Defmastership
+  # Module to host export classes
+  module Export
+    # Module to host XLSX export classes
+    module XLSX
+      # to export a XSLX file
+      class Formatter < Defmastership::Export::Formatter
+        # @param doc [Document] the document to export
+        # @param [Hash{Symbol => Object}] _options
+        def initialize(doc, _options = {})
+          super(doc)
+        end
+
+        # Export the document to a XSLX file
+        #
+        # @param output_file [String] filename for the export
+        def export_to(output_file)
+          workbook = RubyXL::Workbook.new
+          column_list = build_column_list
+          xlsx_data = XLSXData.new(self, workbook, doc, column_list)
+
+          # Delegate the entire process to the XLSXData object
+          xlsx_data.export_to(output_file, doc.definitions)
+        end
+      end
+
+      # Encapsulate the data clump
+      class XLSXData
+        extend Memoist
+
+        attr_reader :column_list
+
+        # @param formatter [XLSX::Formatter] the concerned formatter
+        # @param workbook [XLSXData] the workbook to save
+        # @param doc [Document] the document to export
+        # @param column_list [Array<Symbol>] the list of columns to export
+        def initialize(formatter, workbook, doc, column_list)
+          @formatter = formatter
+          @workbook = workbook
+          @doc = doc
+          @column_list = column_list
+        end
+
+        # Build an write the exported Excel Spreasheet
+        #
+        # @param output_file [String] filename for the export
+        # @param definitions [Array<Definition>] the list of definitions
+        def export_to(output_file, definitions)
+          add_header(@formatter.header(@column_list))
+
+          definitions.each_with_index do |definition, def_index|
+            add_row(@formatter.body(definition, @column_list), def_index + 1)
+          end
+
+          @workbook.write(output_file)
+        end
+
+        private
+
+        def add_header(header_data)
+          header_data.each_with_index do |val, index|
+            worksheet.add_cell(0, index, val)
+          end
+        end
+
+        def add_row(row_data, row_index)
+          row_data.each_with_index do |val, index|
+            worksheet.add_cell(row_index, index, val)
+          end
+        end
+
+        def worksheet
+          @workbook.worksheets.first
+        end
+        memoize :worksheet
+      end
+    end
+  end
+end

data/lib/defmastership/export/yaml/formatter.rb

@@ -0,0 +1,34 @@
+# Copyright (c) 2020 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require('defmastership/export/formatter')
+require('yaml')
+
+module Defmastership
+  # Module to host export classes
+  module Export
+    # Module to host YAML export classes
+    module YAML
+      # to export a YAML file
+      class Formatter < Defmastership::Export::Formatter
+        # @param doc [Document] the document to export
+        # @param  _options [Hash{Symbol => Object}] unused options
+        def initialize(doc, _options = {})
+          super(doc)
+        end
+
+        # Export the document to a YAML file
+        # @param output_file [String] filename for the export
+        def export_to(output_file)
+          column_list = build_column_list
+          header_column_list = header(column_list).map(&:to_sym)
+          definitions =
+            doc.definitions.map do |definition|
+              header_column_list.zip(body(definition, column_list)).to_h
+            end
+          File.write(output_file, ::YAML.dump(definitions))
+        end
+      end
+    end
+  end
+end