defmastership 1.0.5 → 1.0.6

data/spec/unit/defmastership/rename_included_files_line_modifier_spec.rb

@@ -0,0 +1,203 @@
+# Copyright (c) 2021 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require('defmastership')
+
+RSpec.describe(DefMastership::RenameIncludedFilesLineModifier) do
+  subject(:includeschanger) { described_class.new }
+
+  describe '.new' do
+    it { is_expected.not_to(be(nil)) }
+    it { is_expected.to(have_attributes(from_regexp: '')) }
+    it { is_expected.to(have_attributes(to_template: '')) }
+    it { is_expected.to(have_attributes(changes:     [])) }
+    it { expect { includeschanger.user_defined_attribute }.to(raise_error(NoMethodError)) }
+  end
+
+  describe '.from_config' do
+    subject(:includeschanger) do
+      described_class.from_config(
+        from_regexp: 'Whatever.+',
+        to_template: 'Whatever'
+      )
+    end
+
+    it { is_expected.not_to(be(nil)) }
+    it { is_expected.to(have_attributes(from_regexp: 'Whatever.+')) }
+    it { is_expected.to(have_attributes(to_template: 'Whatever')) }
+  end
+
+  describe '#replace' do
+    context 'when NOT valid include' do
+      before do
+        includeschanger.from_config(
+          from_regexp: 'orig',
+          cancel_if_match: 'REF',
+          to_template: 'dest'
+        )
+        allow(File).to(receive(:rename))
+      end
+
+      context 'when the include statement do not match' do
+        before do
+          ['[define,requirement,REFERENCE]', '--'].each do |line|
+            includeschanger.replace(line)
+          end
+        end
+
+        it do
+          expect(includeschanger.replace('badinclude::orig[]'))
+            .to(eq('badinclude::orig[]'))
+        end
+
+        it do
+          includeschanger.replace('badinclude::orig[]')
+          expect(includeschanger).to(have_attributes(changes: []))
+        end
+      end
+
+      context 'when the include is not in a definition' do
+        before do
+          ['[define,requirement,REFERENCE]', '--', 'text', '--'].each do |line|
+            includeschanger.replace(line)
+          end
+        end
+
+        it do
+          expect(includeschanger.replace('include::orig[]'))
+            .to(eq('include::orig[]'))
+        end
+
+        it do
+          includeschanger.replace('include::orig[]')
+          expect(includeschanger).to(have_attributes(changes: []))
+        end
+      end
+
+      context 'when the cancel regexp is met' do
+        before do
+          ['[define,requirement,REFERENCE]', '--'].each do |line|
+            includeschanger.replace(line)
+          end
+        end
+
+        it do
+          expect(includeschanger.replace('include::REFERENCE_orig[]'))
+            .to(eq('include::REFERENCE_orig[]'))
+        end
+
+        it do
+          includeschanger.replace('include::REFERENCE_orig[]')
+          expect(includeschanger).to(have_attributes(changes: []))
+        end
+      end
+    end
+
+    context 'when valid include' do
+      before do
+        allow(File).to(receive(:rename))
+      end
+
+      context 'when really simple rule' do
+        before do
+          includeschanger.from_config(
+            from_regexp: 'orig',
+            cancel_if_match: 'REF',
+            to_template: 'dest'
+          )
+          includeschanger.replace('[define,requirement,REFERENCE]')
+          includeschanger.replace('--')
+        end
+
+        it do
+          expect(includeschanger.replace('include::orig[]'))
+            .to(eq('include::dest[]'))
+        end
+
+        it do
+          includeschanger.replace('include::orig[]')
+          expect(File).to(have_received(:rename).with('orig', 'dest'))
+        end
+
+        it do
+          includeschanger.replace('include::orig[]')
+          expect(includeschanger).to(have_attributes(changes: [%w[orig dest]]))
+        end
+
+        it do
+          expect(includeschanger.replace('include::toto/orig[]'))
+            .to(eq('include::toto/dest[]'))
+        end
+
+        it do
+          includeschanger.replace('include::toto/orig[]')
+          expect(File).to(have_received(:rename).with('toto/orig', 'toto/dest'))
+        end
+
+        it do
+          includeschanger.replace('include::toto/orig[]')
+          expect(includeschanger).to(have_attributes(changes: [%w[toto/orig toto/dest]]))
+        end
+      end
+
+      context 'when complex from_regexp' do
+        before do
+          includeschanger.from_config(
+            from_regexp: '(?<origin>.*\.extension)',
+            to_template: '%<reference>s_%<origin>s'
+          )
+          includeschanger.replace('[define,requirement,REF]')
+        end
+
+        it do
+          expect(includeschanger.replace('include::any_path/one_file.extension[]'))
+            .to(eq('include::any_path/REF_one_file.extension[]'))
+        end
+
+        it do
+          includeschanger.replace('include::any_path/one_file.extension[]')
+          expect(File).to(have_received(:rename).with('any_path/one_file.extension', 'any_path/REF_one_file.extension'))
+        end
+
+        it do
+          changes = [%w[any_path/one_file.extension any_path/REF_one_file.extension]]
+          includeschanger.replace('include::any_path/one_file.extension[]')
+          expect(includeschanger).to(have_attributes(changes: changes))
+        end
+      end
+
+      context 'when path with variable' do
+        before do
+          includeschanger.from_config(
+            from_regexp: 'orig',
+            to_template: 'dest'
+          )
+          includeschanger.replace(':any: one')
+          includeschanger.replace(':path: two')
+          includeschanger.replace('[define,requirement,REFERENCE]')
+          includeschanger.replace('--')
+        end
+
+        it do
+          expect(includeschanger.replace('include::{any}/orig[]'))
+            .to(eq('include::{any}/dest[]'))
+        end
+
+        it do
+          includeschanger.replace('include::{any}/orig[]')
+          expect(File).to(have_received(:rename).with('one/orig', 'one/dest'))
+        end
+
+        it do
+          includeschanger.replace('include::{any}_{path}/orig[]')
+          expect(File).to(have_received(:rename).with('one_two/orig', 'one_two/dest'))
+        end
+
+        it do
+          includeschanger.replace('include::{any}_{path}/orig[]')
+          expect(includeschanger).to(have_attributes(changes: [%w[one_two/orig one_two/dest]]))
+        end
+      end
+    end
+  end
+end

data/spec/unit/defmastership/rename_included_files_modifier_spec.rb

@@ -0,0 +1,67 @@
+# Copyright (c) 2021 Jerome Arbez-Gindre
+# frozen_string_literal: true
+
+require('defmastership')
+
+RSpec.describe(DefMastership::RenameIncludedFilesModifier) do
+  subject(:modifier) do
+    described_class.new(
+      'fake config'
+    )
+  end
+
+  let(:adoc_texts) do
+    {
+      'file1.adoc' => "file1 line1\nfile1 line2",
+      'file2.adoc' => "file2 line1\nfile2 line2"
+    }
+  end
+
+  describe '.new' do
+    it { is_expected.not_to(be(nil)) }
+    it { is_expected.to(have_attributes(config: 'fake config')) }
+    it { is_expected.to(have_attributes(changes: [])) }
+  end
+
+  describe '#do_modifications' do
+    let(:line_modifier) { instance_double(DefMastership::RenameIncludedFilesLineModifier, 'lineModifier') }
+
+    before do
+      allow(DefMastership::RenameIncludedFilesLineModifier).to(
+        receive(:from_config).with('fake config').and_return(line_modifier)
+      )
+      allow(line_modifier).to(receive(:replace).with("file1 line1\n").and_return("new file1 line1\n"))
+      allow(line_modifier).to(receive(:replace).with('file1 line2').and_return('new file1 line2'))
+      allow(line_modifier).to(receive(:replace).with("file2 line1\n").and_return("new file2 line1\n"))
+      allow(line_modifier).to(receive(:replace).with('file2 line2').and_return('new file2 line2'))
+      allow(line_modifier).to(receive(:changes).and_return([%w[from1 to1], %w[from2 to2]]))
+      allow(line_modifier).to(receive(:config).and_return('fake config'))
+    end
+
+    context 'when detailed expectations' do
+      before { modifier.do_modifications(adoc_texts) }
+
+      it do
+        expect(DefMastership::RenameIncludedFilesLineModifier).to(
+          have_received(:from_config).with('fake config')
+        )
+      end
+
+      it { expect(line_modifier).to(have_received(:replace).with("file1 line1\n")) }
+      it { expect(line_modifier).to(have_received(:replace).with('file1 line2')) }
+      it { expect(line_modifier).to(have_received(:replace).with("file2 line1\n")) }
+      it { expect(line_modifier).to(have_received(:replace).with('file2 line2')) }
+      it { expect(line_modifier).to(have_received(:changes)) }
+      it { is_expected.to(have_attributes(config: 'fake config')) }
+      it { is_expected.to(have_attributes(changes: [%w[from1 to1], %w[from2 to2]])) }
+    end
+
+    it do
+      expected_adoc = {
+        'file1.adoc' => "new file1 line1\nnew file1 line2",
+        'file2.adoc' => "new file2 line1\nnew file2 line2"
+      }
+      expect(modifier.do_modifications(adoc_texts)).to(eq(expected_adoc))
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: defmastership
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Jérôme Arbez-Gindre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-12 00:00:00.000000000 Z
+date: 2021-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -181,30 +195,41 @@ files:
 - features/changeref.feature
 - features/defmastership.feature
 - features/export.feature
+- features/modify.feature
+- features/rename_included_files.feature
 - features/step_definitions/defmastership_steps.rb
 - features/support/env.rb
 - lib/defmastership.rb
-- lib/defmastership/batch_changer.rb
+- lib/defmastership/batch_modifier.rb
+- lib/defmastership/change_ref_line_modifier.rb
+- lib/defmastership/change_ref_modifier.rb
 - lib/defmastership/comment_filter.rb
 - lib/defmastership/constants.rb
 - lib/defmastership/csv_formatter.rb
 - lib/defmastership/csv_formatter_body.rb
 - lib/defmastership/csv_formatter_header.rb
 - lib/defmastership/definition.rb
+- lib/defmastership/definition_parser.rb
 - lib/defmastership/document.rb
-- lib/defmastership/project_ref_changer.rb
-- lib/defmastership/ref_changer.rb
+- lib/defmastership/filters.rb
+- lib/defmastership/line_modifier_base.rb
+- lib/defmastership/modifier_base.rb
+- lib/defmastership/rename_included_files_line_modifier.rb
+- lib/defmastership/rename_included_files_modifier.rb
 - lib/defmastership/version.rb
 - spec/spec_helper.rb
-- spec/unit/defmastership/batch_changer_spec.rb
+- spec/unit/defmastership/batch_modifier_spec.rb
+- spec/unit/defmastership/change_ref_line_modifier_spec.rb
+- spec/unit/defmastership/change_ref_modifier_spec.rb
 - spec/unit/defmastership/comment_filter_spec.rb
 - spec/unit/defmastership/csv_formatter_body_spec.rb
 - spec/unit/defmastership/csv_formatter_header_spec.rb
 - spec/unit/defmastership/csv_formatter_spec.rb
+- spec/unit/defmastership/definition_parser_spec.rb
 - spec/unit/defmastership/definition_spec.rb
 - spec/unit/defmastership/document_spec.rb
-- spec/unit/defmastership/project_ref_changer_spec.rb
-- spec/unit/defmastership/ref_changer_spec.rb
+- spec/unit/defmastership/rename_included_files_line_modifier_spec.rb
+- spec/unit/defmastership/rename_included_files_modifier_spec.rb
 - spec/unit/defmastership_spec.rb
 homepage: https://gitlab.com/jjag/defmastership/
 licenses:
@@ -229,7 +254,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0.rc.1
+rubygems_version: 3.2.5
 signing_key: 
 specification_version: 4
 summary: Handling of references and definitions with asciidoctor

data/lib/defmastership/batch_changer.rb

@@ -1,41 +0,0 @@
-# Copyright (c) 2020 Jerome Arbez-Gindre
-# frozen_string_literal: true
-
-module DefMastership
-  # Change references from temporary to definitive with multiple RefChangers
-  class BatchChanger
-    attr_reader :refchangers
-
-    def initialize
-      @refchangers = {}
-    end
-
-    def self.from_h(hash)
-      new.from_h(hash)
-    end
-
-    def from_h(hash)
-      @refchangers =
-        hash.transform_values do |value|
-          DefMastership::RefChanger.from_h(value)
-        end
-      self
-    end
-
-    def to_h
-      @refchangers.transform_values(&:to_h)
-    end
-
-    def replace(symb, line)
-      @refchangers.reduce(line) do |res_line, (_, refchanger)|
-        refchanger.public_send("replace_#{symb}".to_sym, res_line)
-      end
-    end
-
-    def changes
-      @refchangers.reduce([]) do |all_changes, (_, refchanger)|
-        all_changes + refchanger.changes
-      end
-    end
-  end
-end

data/lib/defmastership/project_ref_changer.rb

@@ -1,28 +0,0 @@
-# Copyright (c) 2020 Jerome Arbez-Gindre
-# frozen_string_literal: true
-
-module DefMastership
-  # Change all refs of a given project
-  class ProjectRefChanger
-    attr_reader :yaml_config, :adoc_texts, :changes
-
-    def initialize(yaml_config, adoc_texts)
-      @yaml_config = yaml_config
-      @adoc_texts = adoc_texts
-    end
-
-    def replace_all
-      batch = BatchChanger.from_h(@yaml_config)
-
-      @adoc_texts =
-        %i[refdef irefs].reduce(@adoc_texts) do |texts, method|
-          texts.transform_values do |text|
-            text.lines.map { |line| batch.replace(method, line) }.join
-          end
-        end
-
-      @yaml_config = batch.to_h.to_yaml
-      @changes = batch.changes
-    end
-  end
-end

data/spec/unit/defmastership/batch_changer_spec.rb

@@ -1,109 +0,0 @@
-# Copyright (c) 2020 Jerome Arbez-Gindre
-# frozen_string_literal: true
-
-require('defmastership')
-
-RSpec.describe(DefMastership::BatchChanger) do
-  subject(:batchchanger) { described_class.new }
-
-  describe '.new' do
-    it { is_expected.not_to(be(nil)) }
-    it { is_expected.to(have_attributes(refchangers: {})) }
-  end
-
-  describe '.from_h' do
-    before do
-      allow(DefMastership::RefChanger).to(receive(:from_h).once
-                                           .with(:whatever_a).and_return(:toto_a))
-    end
-
-    it { expect(described_class.from_h(a: :whatever_a)).not_to(be(nil)) }
-
-    it {
-      batchchanger = described_class.from_h(a: :whatever_a)
-      expect(batchchanger).to(have_attributes(refchangers: { a: :toto_a }))
-    }
-  end
-
-  describe '#from_h' do
-    before do
-      allow(DefMastership::RefChanger).to(receive(:from_h).with(:whatever_a).and_return(:one))
-      allow(DefMastership::RefChanger).to(receive(:from_h).with(:whatever_b).and_return(:two))
-      batchchanger.from_h(a: :whatever_a, b: :whatever_b)
-    end
-
-    it { expect(DefMastership::RefChanger).to(have_received(:from_h).with(:whatever_a)) }
-
-    it { expect(DefMastership::RefChanger).to(have_received(:from_h).with(:whatever_b)) }
-
-    it { expect(batchchanger).to(have_attributes(refchangers: { a: :one, b: :two })) }
-  end
-
-  describe '#to_h' do
-    subject(:batchchanger) { described_class.from_h(a: :a, b: :b) }
-
-    let(:refchanger_a) { instance_double(DefMastership::RefChanger, 'refchanger_a') }
-    let(:refchanger_b) { instance_double(DefMastership::RefChanger, 'refchanger_b') }
-
-    before do
-      allow(DefMastership::RefChanger).to(receive(:from_h).with(:a).and_return(refchanger_a))
-      allow(DefMastership::RefChanger).to(receive(:from_h).with(:b).and_return(refchanger_b))
-      allow(refchanger_a).to(receive(:to_h).and_return(a_a: :a_a))
-      allow(refchanger_b).to(receive(:to_h).and_return(b_b: :b_b))
-      batchchanger.to_h
-    end
-
-    it { expect(refchanger_a).to(have_received(:to_h)) }
-
-    it { expect(refchanger_b).to(have_received(:to_h)) }
-
-    it do
-      expect(batchchanger.to_h).to(eq(
-                                     a: { a_a: :a_a },
-                                     b: { b_b: :b_b }
-                                   ))
-    end
-  end
-
-  describe 'replace' do
-    subject(:batchchanger) { described_class.from_h(a: :a, b: :b) }
-
-    let(:refchanger_a) { instance_double(DefMastership::RefChanger, 'refchanger_a') }
-    let(:refchanger_b) { instance_double(DefMastership::RefChanger, 'refchanger_b') }
-
-    before do
-      allow(DefMastership::RefChanger).to(receive(:from_h).with(:a).and_return(refchanger_a))
-      allow(DefMastership::RefChanger).to(receive(:from_h).with(:b).and_return(refchanger_b))
-      allow(refchanger_a).to(receive(:public_send).with(:replace_toto, 'a line').and_return('b line'))
-      allow(refchanger_b).to(receive(:public_send).with(:replace_toto, 'b line').and_return('c line'))
-      batchchanger.replace(:toto, 'a line')
-    end
-
-    it { expect(refchanger_a).to(have_received(:public_send).with(:replace_toto, 'a line')) }
-
-    it { expect(refchanger_b).to(have_received(:public_send).with(:replace_toto, 'b line')) }
-
-    it { expect(batchchanger.replace(:toto, 'a line')).to(eq('c line')) }
-  end
-
-  describe 'changes' do
-    subject(:batchchanger) { described_class.from_h(a: :a, b: :b) }
-
-    let(:refchanger_a) { instance_double(DefMastership::RefChanger, 'refchanger_a') }
-    let(:refchanger_b) { instance_double(DefMastership::RefChanger, 'refchanger_b') }
-
-    before do
-      allow(DefMastership::RefChanger).to(receive(:from_h).with(:a).and_return(refchanger_a))
-      allow(DefMastership::RefChanger).to(receive(:from_h).with(:b).and_return(refchanger_b))
-      allow(refchanger_a).to(receive(:changes).and_return([%w[a1 a2]]))
-      allow(refchanger_b).to(receive(:changes).and_return([%w[b1 b2]]))
-    end
-
-    it do
-      expect(batchchanger.changes).to(eq([
-                                           %w[a1 a2],
-                                           %w[b1 b2]
-                                         ]))
-    end
-  end
-end