caramelize 1.1.1 → 1.2.1

data/spec/lib/caramelize/input_wiki/wiki_spec.rb

@@ -1,26 +1,27 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Caramelize::InputWiki::Wiki do
   subject(:wiki) { described_class.new }
 
-
   describe '#latest_revisions' do
-    let(:page1) { double }
-    let(:page2) { double }
-    let(:page3) { double }
+    let(:page1) { double } # rubocop:todo RSpec/IndexedLet
+    let(:page2) { double } # rubocop:todo RSpec/IndexedLet
+    let(:page3) { double } # rubocop:todo RSpec/IndexedLet
 
-    context 'no pages' do
+    context 'without pages' do
       it 'return empty array' do
         expect(wiki.latest_revisions).to eq []
       end
     end
 
-    context 'pages with revisions' do
-      it 'returns list of latest pages' do
+    context 'with pages with revisions' do
+      it 'returns list of latest pages' do # rubocop:todo RSpec/ExampleLength
         wiki.titles = %w[allosaurus brachiosaurus]
-        allow(wiki).to receive(:revisions_by_title)
+        allow(wiki).to receive(:revisions_by_title) # rubocop:todo RSpec/SubjectStub
           .with('allosaurus').and_return([page1, page2])
-        allow(wiki).to receive(:revisions_by_title)
+        allow(wiki).to receive(:revisions_by_title) # rubocop:todo RSpec/SubjectStub
           .with('brachiosaurus').and_return([page3])
 
         expect(wiki.latest_revisions).to eq([page2, page3])
@@ -29,27 +30,27 @@ describe Caramelize::InputWiki::Wiki do
   end
 
   describe '#revisions_by_author' do
-    context 'revisions is empty' do
-      context 'and titles is empty' do
+    context 'with revisions is empty' do
+      context 'with titles is empty' do
         it 'returns empty array' do
-          allow(wiki).to receive(:titles).and_return []
+          allow(wiki).to receive(:titles).and_return [] # rubocop:todo RSpec/SubjectStub
           expect(wiki.revisions_by_title('title')).to eq []
         end
       end
     end
 
-    context 'revisions are given' do
-      context 'and title given' do
-        it 'returns empty array' do
+    context 'with revisions are given' do
+      context 'with title given' do
+        it 'returns empty array' do # rubocop:todo RSpec/ExampleLength
           pages = []
-          home_1 = OpenStruct.new(title: 'Home', time: Time.parse('2015-01-23'))
-          pages << home_1
-          pages << OpenStruct.new(title: 'Example', time: Time.parse('2015-01-20'))
-          pages << OpenStruct.new(title: 'Authors', time: Time.parse('2015-01-30'))
-          home_2 = OpenStruct.new(title: 'Home', time: Time.parse('2014-01-23'))
-          pages << home_2
-          allow(wiki).to receive(:revisions).and_return pages
-          expect(wiki.revisions_by_title('Home')).to eq [home_2, home_1]
+          home1 = double(title: 'Home', time: Time.parse('2015-01-23')) # rubocop:todo RSpec/VerifiedDoubles
+          pages << home1
+          pages << double(title: 'Example', time: Time.parse('2015-01-20')) # rubocop:todo RSpec/VerifiedDoubles
+          pages << double(title: 'Authors', time: Time.parse('2015-01-30')) # rubocop:todo RSpec/VerifiedDoubles
+          home2 = double(title: 'Home', time: Time.parse('2014-01-23')) # rubocop:todo RSpec/VerifiedDoubles
+          pages << home2
+          allow(wiki).to receive(:revisions).and_return pages # rubocop:todo RSpec/SubjectStub
+          expect(wiki.revisions_by_title('Home')).to eq [home2, home1]
         end
       end
     end

data/spec/lib/caramelize/output_wiki/gollum_spec.rb

@@ -1,70 +1,72 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Caramelize::OutputWiki::Gollum do
   let(:gollum_output) { described_class.new('wiki.git') }
+
   before do
     allow(gollum_output).to receive(:initialize_repository).and_return true
   end
 
   describe '#commit_revision' do
+    subject(:gollum) { double(:gollum) } # rubocop:todo RSpec/VerifiedDoubles
+
     let(:title) { 'title' }
-    let(:author) { double(name: 'Steven Universe', email: 'steven@example.com') }
+    let(:author) { { name: 'Steven Universe', email: 'steven@example.com' } }
     let(:input_page) do
-      double(author: author,
-             body: 'body',
-             commit_message: 'done',
-             time: Time.now,
-             title: title,
-             path: title)
-    end
-    let(:gollum_page) do
-      double(:gollum_page,
-             name: 'title',
-             format: :markdown)
+      Caramelize::Page.new(author:,
+                           body: 'body',
+                           commit_message: 'done',
+                           time: Time.now,
+                           title:,
+                           path: title)
     end
-    let(:markup) { :markdown }
-    let(:gollum) { double(:gollum) }
+    let(:gollum_page) { double(:gollum_page, name: 'title', format: :markdown) } # rubocop:todo RSpec/VerifiedDoubles
 
     before do
       allow(Gollum::Wiki).to receive(:new).and_return(gollum)
     end
 
-    context 'page exists' do
+    context 'when page exists' do
       before do
-        allow(gollum).to receive(:page).with(title).and_return(gollum_page)
+        allow(gollum).to receive(:page).with(title).and_return(gollum_page) # rubocop:todo RSpec/SubjectStub
       end
 
       it 'updates page' do
-        expect(gollum).to receive(:update_page).once.and_return(true)
-        gollum_output.commit_revision(input_page, markup)
+        # rubocop:todo RSpec/SubjectStub
+        expect(gollum).to receive(:update_page).once.and_return(true) # rubocop:todo RSpec/MessageSpies, RSpec/SubjectStub
+        # rubocop:enable RSpec/SubjectStub
+        gollum_output.commit_revision(input_page, :markdown)
       end
     end
 
-    context 'page does not exist yet' do
+    context 'when page does not exist yet' do
       before do
-        allow(gollum).to receive(:page).with(title).and_return(nil)
+        allow(gollum).to receive(:page).with(title).and_return(nil) # rubocop:todo RSpec/SubjectStub
       end
 
       it 'creates page' do
-        expect(gollum).to receive(:write_page).once
-        gollum_output.commit_revision(input_page, markup)
+        allow(gollum).to receive(:write_page) # rubocop:todo RSpec/SubjectStub
+        gollum_output.commit_revision(input_page, :markdown)
+        expect(gollum).to have_received(:write_page).once # rubocop:todo RSpec/SubjectStub
       end
     end
   end
 
   describe '#commit_history' do
-    pending
+    pending('test full history')
   end
 
   describe '#commit_namespace_overview' do
     let(:namespaces) do
       [
-        OpenStruct.new(identifier: 'velociraptors', name: 'Velociraptor'),
-        OpenStruct.new(identifier: 'allosaurus', name: 'Allosaurus')
+        { dentifier: 'velociraptors', name: 'Velociraptor' },
+        { identifier: 'allosaurus', name: 'Allosaurus' }
       ]
     end
 
-    context '2 pages in namespaces' do
+    context 'with 2 pages in namespaces' do
       it 'commits page' do
         allow(gollum_output).to receive(:commit_revision)
         gollum_output.commit_namespace_overview(namespaces)
@@ -75,11 +77,11 @@ describe Caramelize::OutputWiki::Gollum do
 
   describe '#build_commit' do
     let(:page) do
-      Caramelize::Page.new( title: 'Feathered Dinosaurs',
-                message: 'Dinosaurs really had feathers, do not forget!',
-                time: Time.parse('2015-02-12'),
-                body: 'Dinosaurs are awesome and have feathers!',
-                author: OpenStruct.new(name: 'Jeff Goldblum', email: 'jeff.g@example.com') )
+      Caramelize::Page.new(title: 'Feathered Dinosaurs',
+                           message: 'Dinosaurs really had feathers, do not forget!',
+                           time: Time.parse('2015-02-12'),
+                           body: 'Dinosaurs are awesome and have feathers!',
+                           author: { name: 'Jeff Goldblum', email: 'jeff.g@example.com' })
     end
 
     let(:expected_hash) do
@@ -95,15 +97,15 @@ describe Caramelize::OutputWiki::Gollum do
       expect(gollum_output.build_commit(page)).to eq expected_hash
     end
 
-    context 'page has message' do
+    context 'when page has message' do
       it 'uses page.title' do
         expect(gollum_output.build_commit(page)[:message])
           .to eq 'Dinosaurs really had feathers, do not forget!'
       end
     end
 
-    context 'page has no message' do
-      it 'should create message "Edit in page Feathered Dinosaurs"' do
+    context 'when page has no message' do
+      it 'creates message "Edit in page Feathered Dinosaurs"' do
         page.message = ''
         expect(gollum_output.build_commit(page)[:message])
           .to eq 'Edit in page Feathered Dinosaurs'

data/spec/lib/caramelize/page_spec.rb

@@ -1,62 +1,70 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Caramelize::Page do
-
-  let(:message) { 'Dinosaurs really had feathers, do not forget!' }
-  let(:author) { OpenStruct.new(name: 'Jeff Goldblum', email: 'jeff.g@example.com') }
-  let(:title){ 'Feathered Dinosaurs' }
   subject(:page) do
-    Caramelize::Page.new(title: title,
-                message: message,
-                time: Time.parse('2015-02-12'),
-                body: 'Dinosaurs are awesome and have feathers!',
-                author: author )
+    described_class.new(title:,
+                        message:,
+                        time: Time.parse('2015-02-12'),
+                        body: 'Dinosaurs are awesome and have feathers!',
+                        author:)
   end
 
+  let(:message) { 'Dinosaurs really had feathers, do not forget!' }
+  let(:author) { { name: 'Jeff Goldblum', email: 'jeff.g@example.com' } }
+  let(:title) { 'Feathered Dinosaurs' }
 
   describe '#author' do
-    context 'no author is set' do
+    context 'without author' do
       let(:author) { nil }
 
-      it 'fills with Caramelize user' do
-        expect(page.author.name).to eql('Caramelize')
-        expect(page.author.email).to eql('mail@example.com')
+      it 'fills with Caramelize user name' do
+        expect(page.author.fetch(:name)).to eql('Caramelize')
+      end
+
+      it 'fills with dummy email' do
+        expect(page.author.fetch(:email)).to eql('mail@example.com')
       end
     end
 
-    context 'author is set' do
-      it 'fills with Caramelize user' do
-        expect(page.author.name).to eql(author.name)
-        expect(page.author.email).to eql(author.email)
+    context 'with author' do
+      it 'fills with author name' do
+        expect(page.author.fetch(:name)).to eql(author[:name])
+      end
+
+      it 'fills with author email' do
+        expect(page.author.fetch(:email)).to eql(author[:email])
       end
     end
   end
 
   describe '#path' do
-    context "title is 'Home'" do
+    context "when title is 'Home'" do
       let(:title) { 'Home' }
-      it { expect(page.path).to eq 'Home'}
+
+      it { expect(page.path).to eq 'Home' }
     end
 
-    context "title is 'Feathered Dinosaurs'" do
-      it { expect(page.path).to eq 'Feathered Dinosaurs'}
+    context "when title is 'Feathered Dinosaurs'" do
+      it { expect(page.path).to eq 'Feathered Dinosaurs' }
     end
 
-    context "title is 'Space/Feathered Dinosaurs'" do
+    context "when title is 'Space/Feathered Dinosaurs'" do
       let(:title) { 'Space/Feathered Dinosaurs' }
-      it { expect(page.path).to eq 'Space/feathered dinosaurs'}
+
+      it { expect(page.path).to eq 'Space/feathered dinosaurs' }
     end
   end
 
-
   describe '#commit_message' do
-    context 'page has message' do
+    context 'with page having message' do
       it 'uses page.title' do
         expect(page.commit_message).to eq 'Dinosaurs really had feathers, do not forget!'
       end
     end
 
-    context 'page has no message' do
+    context 'with page having no message' do
       let(:message) { '' }
 
       it 'creates message "Edit in page Feathered Dinosaurs"' do

data/spec/lib/caramelize/services/page_builder_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Caramelize::Services::PageBuilder do
+  describe '.build_namespace_overview' do
+    subject(:page) { described_class.build_namespace_overview(namespaces) }
+
+    let(:body) do
+      "## Overview of namespaces\n  \n* [[Velociraptor|velociraptors/wiki]]  \n* [[Allosaurus|allosaurus/wiki]]"
+    end
+    let(:expected_page) do
+      Caramelize::Page.new(title: 'Home',
+                           body:,
+                           message: 'Create Namespace Overview',
+                           latest: true)
+    end
+    let(:namespaces) do
+      [
+        { identifier: 'velociraptors', name: 'Velociraptor' },
+        { identifier: 'allosaurus', name: 'Allosaurus' }
+      ]
+    end
+
+    it 'returns page with expected title' do
+      expect(page.title).to eql(expected_page.title)
+    end
+
+    it 'returns page with expected page body' do
+      expect(page.body).to eql(expected_page.body)
+    end
+
+    it 'returns page with expected page latest' do
+      expect(page.latest).to eql(expected_page.latest)
+    end
+
+    it 'returns page with expected message' do
+      expect(page.message).to eql(expected_page.message)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'pry'
 require 'caramelize'
 
-Dir[('./spec/support/**/*.rb')].each {|f| require f}
+Dir[('./spec/support/**/*.rb')].each { |f| require f }
 
 RSpec.configure do |config|
-  #config.include TestHelpers
+  # config.include TestHelpers
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: caramelize
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.1
 platform: ruby
 authors:
 - Daniel Senff
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-08 00:00:00.000000000 Z
+date: 2024-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -66,104 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-- !ruby/object:Gem::Dependency
-  name: rake
-  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: rspec
-  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: byebug
-  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
-  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: guard
-  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: guard-rspec
-  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'
 description: With Caramelize you can migrate any wiki to git-based Gollum wiki repositories.
 email:
 - mail@danielsenff.de
@@ -172,8 +74,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/main.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -187,10 +91,15 @@ files:
 - lib/caramelize/content_transferer.rb
 - lib/caramelize/database_connector.rb
 - lib/caramelize/filter_processor.rb
+- lib/caramelize/filters/add_newline_to_page_end.rb
+- lib/caramelize/filters/camel_case_to_wiki_links.rb
 - lib/caramelize/filters/remove_table_tab_line_endings.rb
 - lib/caramelize/filters/swap_wiki_links.rb
 - lib/caramelize/filters/wikka_to_markdown.rb
 - lib/caramelize/health_check.rb
+- lib/caramelize/health_checks/home_page_check.rb
+- lib/caramelize/health_checks/orphaned_pages_check.rb
+- lib/caramelize/health_checks/page.rb
 - lib/caramelize/input_wiki/redmine_wiki.rb
 - lib/caramelize/input_wiki/wiki.rb
 - lib/caramelize/input_wiki/wikkawiki.rb
@@ -204,18 +113,21 @@ files:
 - spec/fixtures/markup/table-tab-line-endings-output.textile
 - spec/lib/caramelize/content_transferer_spec.rb
 - spec/lib/caramelize/filter_processor_spec.rb
+- spec/lib/caramelize/filters/add_newline_to_page_end_spec.rb
+- spec/lib/caramelize/filters/camel_case_to_wiki_links_spec.rb
 - spec/lib/caramelize/filters/remove_table_tab_line_endings_spec.rb
 - spec/lib/caramelize/filters/swap_wiki_links_spec.rb
-- spec/lib/caramelize/filters/wikka_to_markdown_spec.rb
+- spec/lib/caramelize/filters/wikka2markdown_spec.rb
 - spec/lib/caramelize/input_wiki/wiki_spec.rb
 - spec/lib/caramelize/output_wiki/gollum_spec.rb
 - spec/lib/caramelize/page_spec.rb
-- spec/lib/caramelize/services/page_builder.rb
+- spec/lib/caramelize/services/page_builder_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/Dahie/caramelize
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -224,29 +136,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.5.5
 signing_key:
 specification_version: 4
 summary: Flexible and modular wiki conversion tool
-test_files:
-- spec/fixtures/markup/swap-links-input.textile
-- spec/fixtures/markup/swap-links-output.textile
-- spec/fixtures/markup/table-tab-line-endings-input.textile
-- spec/fixtures/markup/table-tab-line-endings-output.textile
-- spec/lib/caramelize/content_transferer_spec.rb
-- spec/lib/caramelize/filter_processor_spec.rb
-- spec/lib/caramelize/filters/remove_table_tab_line_endings_spec.rb
-- spec/lib/caramelize/filters/swap_wiki_links_spec.rb
-- spec/lib/caramelize/filters/wikka_to_markdown_spec.rb
-- spec/lib/caramelize/input_wiki/wiki_spec.rb
-- spec/lib/caramelize/output_wiki/gollum_spec.rb
-- spec/lib/caramelize/page_spec.rb
-- spec/lib/caramelize/services/page_builder.rb
-- spec/spec_helper.rb
+test_files: []

data/.travis.yml

@@ -1,5 +0,0 @@
-language: ruby
-rvm:
- - 2.6
-before_install:
-  - gem install bundler