caramelize 0.3.0 → 0.4.0

data/spec/lib/caramelize/{wiki → input_wiki}/wiki_spec.rb

@@ -1,9 +1,34 @@
 require 'spec_helper'
 
-describe Caramelize::GollumOutput do
+describe Caramelize::InputWiki::Wiki do
+  subject(:wiki) { described_class.new }
 
-  describe :revisions_by_author do
-    let(:wiki) { Caramelize::Wiki.new }
+
+  describe '#latest_revisions' do
+    let(:page1) { double }
+    let(:page2) { double }
+    let(:page3) { double }
+
+    context 'no 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
+        wiki.titles = ['allosaurus', 'brachiosaurus']
+        allow(wiki).to receive(:revisions_by_title)
+          .with('allosaurus').and_return([page1, page2])
+        allow(wiki).to receive(:revisions_by_title)
+          .with('brachiosaurus').and_return([page3])
+
+        expect(wiki.latest_revisions).to eq([page2, page3])
+      end
+    end
+  end
+
+  describe '#revisions_by_author' do
     context 'revisions is empty' do
       context 'and titles is empty' do
         it 'returns empty array' do
@@ -12,6 +37,7 @@ describe Caramelize::GollumOutput do
         end
       end
     end
+
     context 'revisions are given' do
       context 'and title given' do
         it 'returns empty array' do
@@ -28,4 +54,4 @@ describe Caramelize::GollumOutput do
       end
     end
   end
-end
+end

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

@@ -0,0 +1,113 @@
+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
+    let(:title) { 'title' }
+    let(:input_page) do
+      double(author_name: 'Steven Universe',
+             author_email: 'steven@example.com',
+             body: 'body',
+             commit_message: 'done',
+             time: Time.now,
+             title: title)
+    end
+    let(:gollum_page) do
+      double(:gollum_page,
+             name: 'title',
+             format: :markdown)
+    end
+    let(:markup) { :markdown }
+    let(:gollum) { double(:gollum) }
+
+    before do
+      allow(Gollum::Wiki).to receive(:new).and_return(gollum)
+    end
+
+    context 'page exists' do
+      before do
+        allow(gollum).to receive(:page).with(title).and_return(gollum_page)
+      end
+
+      it 'updates page' do
+        expect(gollum).to receive(:update_page).once.and_return(true)
+        gollum_output.commit_revision(input_page, markup)
+      end
+    end
+
+    context 'page does not exist yet' do
+      before do
+        allow(gollum).to receive(:page).with(title).and_return(nil)
+      end
+
+      it 'creates page' do
+        expect(gollum).to receive(:write_page).once
+        gollum_output.commit_revision(input_page, markup)
+      end
+    end
+  end
+
+  describe '#commit_history' do
+    pending
+  end
+
+  describe '#commit_namespace_overview' do
+    let(:namespaces) do
+      [
+        OpenStruct.new(identifier: 'velociraptors', name: 'Velociraptor'),
+        OpenStruct.new(identifier: 'allosaurus', name: 'Allosaurus')
+      ]
+    end
+
+    context '2 pages in namespaces' do
+      it 'commits page' do
+        allow(gollum_output).to receive(:commit_revision)
+        gollum_output.commit_namespace_overview(namespaces)
+        expect(gollum_output).to have_received(:commit_revision)
+      end
+    end
+  end
+
+  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') )
+    end
+
+    let(:expected_hash) do
+      {
+        message: 'Dinosaurs really had feathers, do not forget!',
+        authored_date: Time.parse('2015-02-12'),
+        committed_date: Time.parse('2015-02-12'),
+        name: 'Jeff Goldblum',
+        email: 'jeff.g@example.com'
+      }
+    end
+
+    it 'builds commit hash' do
+      expect(gollum_output.build_commit(page)).to eq expected_hash
+    end
+
+    context '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
+        page.message = ''
+        expect(gollum_output.build_commit(page)[:message])
+          .to eq 'Edit in page Feathered Dinosaurs'
+      end
+    end
+  end
+end

data/spec/lib/caramelize/page_spec.rb

@@ -0,0 +1,49 @@
+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') }
+  subject(:page) do
+    Caramelize::Page.new( title: 'Feathered Dinosaurs',
+                message: message,
+                time: Time.parse('2015-02-12'),
+                body: 'Dinosaurs are awesome and have feathers!',
+                author: author )
+  end
+
+
+  describe '#author' do
+    context 'no author is set' 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')
+      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)
+      end
+    end
+  end
+
+  describe '#commit_message' do
+    context 'page has 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
+      let(:message) { '' }
+
+      it 'creates message "Edit in page Feathered Dinosaurs"' do
+        expect(page.commit_message).to eq 'Edit in page Feathered Dinosaurs'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Caramelize::Service::Pagebuilder do
+  describe '.build_namespace_overview' do
+    let(:body) do
+      "## Overview of namespaces\n\n* [[Velociraptor|velociraptors/Wiki]]  \n* [[Allosaurus|allosaurus/Wiki]]  \n"
+    end
+    let(:expected_page) do
+      Caramelize::Page.new(title: 'Home',
+                            body: body,
+                            message: 'Create Namespace Overview',
+                            latest: true)
+    end
+    let(:namespaces) do
+      [
+        OpenStruct.new(identifier: 'velociraptors', name: 'Velociraptor'),
+        OpenStruct.new(identifier: 'allosaurus', name: 'Allosaurus')
+      ]
+    end
+
+    it 'returns page with expected attributes' do
+      page = described_class.build_namespace_overview
+      expected(page.title).to eql(expected_page.title)
+      expected(page.body).to eql(expected_page.body)
+      expected(page.latest).to eql(expected_page.latest)
+      expected(page.message).to eql(expected_page.message)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -5,4 +5,4 @@ Dir[('./spec/support/**/*.rb')].each {|f| require f}
 
 RSpec.configure do |config|
   #config.include TestHelpers
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: caramelize
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Daniel Senff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-23 00:00:00.000000000 Z
+date: 2020-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mysql2
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: cmdparse
+  name: commander
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !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
@@ -181,33 +195,37 @@ files:
 - Rakefile
 - bin/caramelize
 - caramelize.gemspec
+- lib/caramelize.rb
 - lib/caramelize/caramel.rb
-- lib/caramelize/cli.rb
-- lib/caramelize/cli/create_command.rb
-- lib/caramelize/cli/run_command.rb
 - lib/caramelize/content_transferer.rb
 - lib/caramelize/database_connector.rb
 - lib/caramelize/ext.rb
+- lib/caramelize/filter_processor.rb
 - lib/caramelize/filters/remove_table_tab_line_endings.rb
 - lib/caramelize/filters/swap_wiki_links.rb
 - lib/caramelize/filters/trac_to_markdown.rb
 - lib/caramelize/filters/wikka_to_markdown.rb
-- lib/caramelize/gollum_output.rb
+- lib/caramelize/input_wiki/redmine_wiki.rb
+- lib/caramelize/input_wiki/trac_converter.rb
+- lib/caramelize/input_wiki/wiki.rb
+- lib/caramelize/input_wiki/wikkawiki.rb
+- lib/caramelize/output_wiki/gollum.rb
 - lib/caramelize/page.rb
+- lib/caramelize/services/page_builder.rb
 - lib/caramelize/version.rb
-- lib/caramelize/wiki/redmine_wiki.rb
-- lib/caramelize/wiki/trac_converter.rb
-- lib/caramelize/wiki/wiki.rb
-- lib/caramelize/wiki/wikkawiki.rb
 - 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/gollum_output_spec.rb
-- spec/lib/caramelize/wiki/wiki_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
 homepage: http://github.com/Dahie/caramelize
 licenses:
@@ -228,8 +246,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Flexible and modular wiki conversion tool
@@ -238,9 +255,13 @@ test_files:
 - 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/gollum_output_spec.rb
-- spec/lib/caramelize/wiki/wiki_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

data/lib/caramelize/cli.rb

@@ -1,89 +0,0 @@
-require 'cmdparse'
-require 'caramelize/version'
-
-module Caramelize
-  require 'caramelize/content_transferer'
-  module CLI
-    require 'caramelize/cli/run_command'
-    require 'caramelize/cli/create_command'
-
-    # This is the command parser class used for handling the webgen command line interface. After
-    # creating an instance, the inherited #parse method can be used for parsing the command line
-    # arguments and executing the requested command.
-    class CommandParser < CmdParse::CommandParser
-
-      # The verbosity level. Default: <tt>:normal</tt>
-      attr_reader :verbosity
-
-      # Create a new CommandParser class. T
-      def initialize
-        super(true)
-        @verbosity = :normal
-
-        self.program_name = "caramelize"
-        self.program_version = Caramelize::VERSION
-        self.options = CmdParse::OptionParserWrapper.new do |opts|
-          opts.separator "Global options:"
-          opts.on("--verbose", "-v", "Print more output") { @verbosity = :verbose }
-          opts.on("--quiet", "-q", "No output") { @verbosity = :quiet }
-        end
-        self.add_command(CmdParse::HelpCommand.new)
-        self.add_command(CmdParse::VersionCommand.new)
-      end
-
-      KNOWN_CONFIG_LOCATIONS = ['config/caramel.rb', "config/caramel.config", "caramel.rb", "src/caramel.rb"]
-
-      # Finds the configuration file, if it exists in a known location.
-      def detect_configuration_file(config_path = nil)
-        possible_files = []
-        possible_files << config_path if config_path
-        possible_files |= KNOWN_CONFIG_LOCATIONS
-        possible_files.detect{|f| File.exists?(f)}
-      end
-
-      # Utility method for sub-commands to transfer wiki contents
-      def transfer_content(config_file = "")
-        time_start = Time.now
-
-        file = detect_configuration_file config_file
-        puts "Read config file: #{file}" if verbose?
-
-        unless file && File.exists?(file)
-          puts "No config file found."
-          return false
-        end
-
-        commence_transfer file
-
-        puts "Time required: #{Time.now - time_start} s" if verbose?
-      end
-
-      def commence_transfer(file)
-        #load file
-        #original_wiki = Configuration.instance.input_wiki
-        instance_eval(File.read(file))
-        original_wiki = input_wiki
-
-        options = original_wiki.options
-        options[:verbosity] = @verbosity
-        ContentTransferer.execute(original_wiki, options)
-      end
-
-      def verbose?
-        @verbosity == :verbose
-      end
-
-      # :nodoc:
-      def parse(argv = ARGV)
-        Caramelize::CLI.constants.select {|c| c =~ /.+Command$/ }.each do |c|
-          # set runcommand as default
-          self.add_command(Caramelize::CLI.const_get(c).new, (c.to_s == 'RunCommand' ? false : false))
-        end
-        super
-      end
-
-    end
-
-  end
-
-end