defmastership 1.0.1

data/spec/unit/defmastership/project_ref_changer_spec.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require('defmastership')
+require('yaml')
+
+RSpec.describe(DefMastership::ProjectRefChanger) do
+  subject(:projectrefchanger) do
+    described_class.new(
+      'fake yaml config',
+      {
+        '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(yaml_config: 'fake yaml config')) }
+
+    it do
+      expect(projectrefchanger).to(have_attributes(adoc_texts:
+                                           {
+                                             'file1.adoc' => "file1 line1\nfile1 line2",
+                                             'file2.adoc' => "file2 line1\nfile2 line2"
+                                           }))
+    end
+
+    it { is_expected.to(have_attributes(changes: nil)) }
+  end
+
+  describe '#replace_all' do
+    let(:batch_changer) { instance_double(DefMastership::BatchChanger, 'batch_changer') }
+    let(:config_hash)   { instance_double(Hash, 'config_hash')                          }
+
+    before do
+      allow(DefMastership::BatchChanger).to(receive(:from_h).with('fake yaml config').and_return(batch_changer))
+      allow(batch_changer).to(receive(:replace).with(:refdef, "file1 line1\n").and_return("new file1 line1\n"))
+      allow(batch_changer).to(receive(:replace).with(:refdef, 'file1 line2').and_return('new file1 line2'))
+      allow(batch_changer).to(receive(:replace).with(:refdef, "file2 line1\n").and_return("new file2 line1\n"))
+      allow(batch_changer).to(receive(:replace).with(:refdef, 'file2 line2').and_return('new file2 line2'))
+      allow(batch_changer).to(receive(:replace).with(:irefs, "new file1 line1\n").and_return("new2 file1 line1\n"))
+      allow(batch_changer).to(receive(:replace).with(:irefs, 'new file1 line2').and_return('new2 file1 line2'))
+      allow(batch_changer).to(receive(:replace).with(:irefs, "new file2 line1\n").and_return("new2 file2 line1\n"))
+      allow(batch_changer).to(receive(:replace).with(:irefs, 'new file2 line2').and_return('new2 file2 line2'))
+      allow(batch_changer).to(receive(:to_h).and_return(config_hash))
+      allow(batch_changer).to(receive(:changes).and_return('pouet'))
+      allow(config_hash).to(receive(:to_yaml).with(no_args).and_return('new fake yaml config'))
+      projectrefchanger.replace_all
+    end
+
+    it { expect(DefMastership::BatchChanger).to(have_received(:from_h).with('fake yaml config')) }
+
+    it { expect(batch_changer).to(have_received(:replace).with(:refdef, "file1 line1\n")) }
+    it { expect(batch_changer).to(have_received(:replace).with(:refdef, 'file1 line2')) }
+    it { expect(batch_changer).to(have_received(:replace).with(:refdef, "file2 line1\n")) }
+    it { expect(batch_changer).to(have_received(:replace).with(:refdef, 'file2 line2')) }
+    it { expect(batch_changer).to(have_received(:replace).with(:irefs, "new file1 line1\n")) }
+    it { expect(batch_changer).to(have_received(:replace).with(:irefs, 'new file1 line2')) }
+    it { expect(batch_changer).to(have_received(:replace).with(:irefs, "new file2 line1\n")) }
+    it { expect(batch_changer).to(have_received(:replace).with(:irefs, 'new file2 line2')) }
+
+    it { expect(batch_changer).to(have_received(:to_h)) }
+
+    it { expect(config_hash).to(have_received(:to_yaml).with(no_args)) }
+
+    it { expect(projectrefchanger).to(have_attributes(yaml_config: 'new fake yaml config')) }
+
+    it do
+      expect(projectrefchanger).to(have_attributes(adoc_texts: {
+                                                     'file1.adoc' => "new2 file1 line1\nnew2 file1 line2",
+                                                     'file2.adoc' => "new2 file2 line1\nnew2 file2 line2"
+                                                   }))
+    end
+
+    it { expect(batch_changer).to(have_received(:changes)) }
+    it { expect(projectrefchanger).to(have_attributes(changes: 'pouet')) }
+  end
+end

data/spec/unit/defmastership/ref_changer_spec.rb

@@ -0,0 +1,205 @@
+# frozen_string_literal: true
+
+require('defmastership')
+
+RSpec.describe(DefMastership::RefChanger) do
+  subject(:refchanger) { 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(next_ref:    0)) }
+    it { is_expected.to(have_attributes(changes:     [])) }
+    it { expect { refchanger.user_defined_attribute }.to(raise_error(NoMethodError)) }
+  end
+
+  describe '.from_h' do
+    subject(:refchanger) do
+      described_class.from_h(
+        from_regexp: 'Whatever.+',
+        to_template: 'Whatever',
+        next_ref: 17
+      )
+    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')) }
+    it { is_expected.to(have_attributes(next_ref:    17)) }
+  end
+
+  describe '#from_h' do
+    before do
+      refchanger.from_h(
+        from_regexp: 'Whatever.+',
+        to_template: 'Whatever',
+        next_ref: 17,
+        user_defined_attribute: 'Tadaam'
+      )
+    end
+
+    it { is_expected.to(have_attributes(from_regexp: 'Whatever.+')) }
+    it { is_expected.to(have_attributes(to_template: 'Whatever')) }
+    it { is_expected.to(have_attributes(next_ref:    17)) }
+    it { is_expected.to(have_attributes(user_defined_attribute: 'Tadaam')) }
+  end
+
+  describe '#to_h' do
+    context 'when not initalized' do
+      it do
+        expect(refchanger.to_h).to(include(
+                                     from_regexp: '',
+                                     to_template: '',
+                                     next_ref: 0
+                                   ))
+      end
+    end
+
+    context 'when initalized with additionnal keys' do
+      before do
+        refchanger.from_h(
+          next_ref: 1256,
+          user_defined_attribute: 'Tadaam'
+        )
+      end
+
+      it { expect(refchanger.to_h).to(include(from_regexp: '')) }
+      it { expect(refchanger.to_h).to(include(to_template: '')) }
+      it { expect(refchanger.to_h).to(include(next_ref: 1256)) }
+      it { expect(refchanger.to_h).to(include(user_defined_attribute: 'Tadaam')) }
+    end
+  end
+
+  describe '#replace_definitions' do
+    context 'when really simple rule' do
+      before do
+        refchanger.from_h(
+          from_regexp: 'TEMP',
+          to_template: 'TUTU'
+        )
+      end
+
+      context 'when valid definition' do
+        it do
+          expect(refchanger.replace_refdef('[define, whatever, TEMP]'))
+            .to(eq('[define, whatever, TUTU]'))
+        end
+      end
+
+      context 'when no valid definition' do
+        it do
+          expect(refchanger.replace_refdef('[pouet, whatever, TEMP]'))
+            .to(eq('[pouet, whatever, TEMP]'))
+        end
+      end
+    end
+
+    context 'when template is variable' do
+      before do
+        refchanger.from_h(
+          from_regexp: 'TEMP',
+          to_template: 'TOTO-%<next_ref>04d',
+          next_ref: 124
+        )
+      end
+
+      it do
+        expect(refchanger.replace_refdef('[define, whatever, TEMP]'))
+          .to(eq('[define, whatever, TOTO-0124]'))
+      end
+
+      it do
+        refchanger.replace_refdef('[define, whatever, TEMP]')
+        expect(refchanger).to(have_attributes(next_ref: 125))
+      end
+    end
+
+    context 'when capture group in regexp' do
+      before do
+        refchanger.from_h(
+          from_regexp: '(?<cg>TOTO|TITI)-TEMP[\d]*',
+          to_template: '%<cg>s-%<next_ref>04d',
+          next_ref: 132
+        )
+      end
+
+      it do
+        expect(refchanger.replace_refdef('[define, whatever, TOTO-TEMP]'))
+          .to(eq('[define, whatever, TOTO-0132]'))
+      end
+
+      it do
+        refchanger.replace_refdef('[define, whatever, TOTO-TEMP]')
+        expect(refchanger.replace_refdef('[define, whatever, TITI-TEMP]'))
+          .to(eq('[define, whatever, TITI-0133]'))
+      end
+
+      it do
+        refchanger.replace_refdef('[define, whatever, TOTO-TEMP1]')
+        refchanger.replace_refdef('[define, whatever, TITI-TEMP2]')
+        expect(refchanger).to(have_attributes(changes: [%w[TOTO-TEMP1 TOTO-0132], %w[TITI-TEMP2 TITI-0133]]))
+      end
+    end
+
+    context 'when definition is in literal block' do
+      before do
+        refchanger.from_h(
+          from_regexp: 'TEMP',
+          to_template: 'TUTU'
+        )
+        refchanger.replace_refdef('....')
+      end
+
+      it do
+        expect(refchanger.replace_refdef('[define, whatever, TEMP]'))
+          .to(eq('[define, whatever, TEMP]'))
+      end
+    end
+
+    context 'when defintion is after literal block' do
+      before do
+        refchanger.from_h(
+          from_regexp: 'TEMP',
+          to_template: 'TUTU'
+        )
+        refchanger.replace_refdef("....\n")
+        refchanger.replace_refdef('[define, whatever, TEMP]')
+        refchanger.replace_refdef("....\n")
+      end
+
+      it do
+        expect(refchanger.replace_refdef('[define, whatever, TEMP]'))
+          .to(eq('[define, whatever, TUTU]'))
+      end
+    end
+  end
+
+  describe '#replace_irefs' do
+    before do
+      refchanger.from_h(
+        from_regexp: '(?<cg>TOTO|TITI)-TEMP[\d]*',
+        to_template: '%<cg>s-%<next_ref>04d',
+        next_ref: 132
+      )
+      refchanger.replace_refdef('[define, whatever, TOTO-TEMP123]')
+      refchanger.replace_refdef('[define, whatever, TITI-TEMP421]')
+    end
+
+    it do
+      expect(refchanger.replace_irefs('defs:iref[TOTO-TEMP1234]'))
+        .to(eq('defs:iref[TOTO-TEMP1234]'))
+    end
+
+    it do
+      expect(refchanger.replace_irefs('defs:iref[TOTO-TEMP123]'))
+        .to(eq('defs:iref[TOTO-0132]'))
+    end
+
+    it do
+      expect(refchanger.replace_irefs('defs:iref[TOTO-TEMP123] ' \
+                                      'defs:iref[TITI-TEMP421] bla'))
+        .to(eq('defs:iref[TOTO-0132] defs:iref[TITI-0133] bla'))
+    end
+  end
+end

data/spec/unit/defmastership_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.describe(DefMastership) do
+  it 'has a version number' do
+    expect(DefMastership::VERSION).not_to(be(nil))
+  end
+end

metadata

@@ -0,0 +1,234 @@
+--- !ruby/object:Gem::Specification
+name: defmastership
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Jérôme Arbez-Gindre
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aasm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: 
+email: jeromearbezgindre@gmail.com
+executables:
+- defmastership
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- defmastership.rdoc
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- bin/defmastership
+- config/devtools.yml
+- config/flay.yml
+- config/flog.yml
+- config/mutant.yml
+- config/reek.yml
+- config/rubocop.yml
+- config/yardstick.yml
+- defmastership.gemspec
+- defmastership.rdoc
+- features/changeref.feature
+- features/defmastership.feature
+- features/export.feature
+- features/step_definitions/defmastership_steps.rb
+- features/support/env.rb
+- lib/defmastership.rb
+- lib/defmastership/batch_changer.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/document.rb
+- lib/defmastership/project_ref_changer.rb
+- lib/defmastership/ref_changer.rb
+- lib/defmastership/version.rb
+- spec/spec_helper.rb
+- spec/unit/defmastership/batch_changer_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_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_spec.rb
+homepage: http://your.website.com
+licenses:
+- Nonstandard
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--title defmastership"
+- "--main README.rdoc"
+- "-ri"
+require_paths:
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Handling of references and definitions with asciidoctor
+test_files: []