caramelize 0.1.2 → 1.1.0

data/lib/caramelize/output_wiki/gollum.rb

@@ -0,0 +1,80 @@
+require 'gollum-lib'
+
+module Caramelize
+  module OutputWiki
+    class Gollum
+
+      attr_reader :wiki_path
+
+      SUPPORTED_TARGET_MARKUP =
+        %i[markdown textile rdoc creole media_wiki org pod re_structured_text ascii_doc].freeze
+
+      # Initialize a new gollum-wiki-repository at the given path.
+      def initialize(new_wiki_path)
+        # TODO use sanitized name as wiki-repository-title
+        @wiki_path = new_wiki_path
+        initialize_repository
+      end
+
+      # Commit the given page into the gollum-wiki-repository.
+      # Make sure the target markup is correct before calling this method.
+      def commit_revision(page, markup)
+        gollum_page = gollum.page(page.path)
+
+        if gollum_page
+          gollum.update_page(gollum_page, gollum_page.name, gollum_page.format, page.body, build_commit(page))
+        else
+          gollum.write_page(page.path, markup, page.body, build_commit(page))
+        end
+      end
+
+      def rename_page(page_title, rename)
+        gollum_page = gollum.page(page_title)
+        gollum.rename_page(gollum_page, rename, { message: 'Rename home page' })
+      end
+
+      # Commit all revisions of the given history into this gollum-wiki-repository.
+      def commit_history(revisions, options = {}, &block)
+        revisions.each_with_index do |page, index|
+          # call debug output from outside
+          block.call(page, index) if block_given?
+          commit_revision(page, options.fetch(:markup, :markdown))
+        end
+      end
+
+      def commit_namespace_overview(namespaces)
+        commit_revision(build_namespace_overview(namespaces), :markdown)
+      end
+
+      def supported_markup
+        SUPPORTED_TARGET_MARKUP
+      end
+
+      def build_commit(page)
+        {
+          message: page.commit_message,
+          name: page.author.name,
+          email: page.author.email,
+          time: page.time
+        }
+      end
+
+      private
+
+      def build_namespace_overview(namespaces)
+        ::Caramelize::Services::PageBuilder.build_namespace_overview(namespaces)
+      end
+
+      def gollum
+        @gollum ||= ::Gollum::Wiki.new(wiki_path, {repo_is_bare: true})
+      end
+
+      def initialize_repository
+        return if File.exists?(wiki_path)
+        Dir.mkdir(wiki_path)
+        #::Gollum::Git::Repo.new(wiki_path, { is_bare: true })
+        ::Gollum::Git::Repo.init(wiki_path)
+      end
+    end
+  end
+end

data/lib/caramelize/page.rb

@@ -1,30 +1,54 @@
 module Caramelize
   class Page
-  
-    attr_accessor :title, :body, :id, :markup, :latest, :time, :message, :author, :author_name
-  
-    def initialize page={}
+
+    attr_accessor :title, :body, :id, :markup, :latest, :time, :message,
+                  :author, :author_name
+
+    def initialize(page = {})
       @id =      page[:id]
-      @title =   page[:title]
-      @body =    page[:body]
+      @title =   page.fetch(:title, '')
+      @body =    page.fetch(:body, '')
       @syntax =  page[:markup]
-      @latest =  page[:latest]
-      @time =    page[:time]
-      @message = page[:message]
+      @latest =  page[:latest] || false
+      @time =    page.fetch(:time, Time.now)
+      @message = page.fetch(:message, '')
       @author =  page[:author]
-      @author_name =  page[:author_name]
+      @author_name = page[:author_name]
     end
-    
+
+    def author_email
+      author.email
+    end
+
+    def author_name
+      author.name
+    end
+
+    def author
+      @author ||= OpenStruct.new(name: @author_name || "Caramelize",
+                             email: "mail@example.com")
+    end
+
     def latest?
       @latest
     end
-    
+
+    def path
+      return @title unless @title.index('/')
+      @title.split('/').first + '/' + @title.split('/').last.downcase
+    end
+
     def set_latest
       @latest = true
     end
-    
+
     def to_s
       @title
     end
+
+    def commit_message
+      return "Edit in page #{title}" if message.empty?
+      message
+    end
   end
-end
+end

data/lib/caramelize/services/page_builder.rb

@@ -0,0 +1,20 @@
+module Caramelize
+  module Services
+    class PageBuilder
+      def self.build_namespace_overview(namespaces)
+        body = "## Overview of namespaces\n\n"
+
+        namespaces.each do |namespace|
+          # TODO change wiki as configurable default home
+          # TODO support other markup syntaxes
+          body << "* [[#{namespace[:name]}|#{namespace[:identifier]}/wiki]]  \n"
+        end
+
+        Page.new(title: "Home",
+                 body: body,
+                 message: 'Create Namespace Overview',
+                 latest: true)
+      end
+    end
+  end
+end

data/lib/caramelize/version.rb

@@ -1,3 +1,3 @@
 module Caramelize
-  VERSION = "0.1.2"
+  VERSION = '1.1.0'
 end

data/spec/fixtures/markup/swap-links-input.textile

@@ -0,0 +1,57 @@
+h1. Wiki
+
+h2. The 1994 Formula One Season
+
+*[[statistics|Driver & Team Statistics]]*
+*[[race-by-race|Race by Race]]*
+*[[technical-regulations|Technical Regulations]]*
+*[[technical-rules|Technical Rule Changes]]*
+*[[HD-rear-wings|HD Rear Wing Configurations]]*
+*[[helmets|Helmet variants]]*
+
+h2. Development
+
+*[[Review Process F1 1994]]*
+*[[Credits]]*
+
+h2. Season data
+
+h3. Drivers
+
+Early season package
+Driver list from Brazil: "Discussion here":http://forum.ctdp.net/viewtopic.php?f=214&t=62989
+
+|_.Nr|_.Driver       |_.Team|
+|0|Damon Hill        |/2.[[Williams|Williams-Renault]]|
+|2|Ayrton Senna      |
+|3|Ukyo Katayama     |/2.[[Tyrrell|Tyrrell-Yamaha]]|
+|4|Mark Blundell     |
+|5|Michael Schumacher|/2.[[Benetton|Benetton-Ford]]|
+|6|Jos Verstappen    |
+|7|Mika Häkkinen     |/2.[[McLaren|McLaren-Peugeot]]|
+|8|Martin Brundle    |
+|9|Christian Fittipaldi|/2.[[Footwork|Footwork-Ford]]|
+|10|Gianni Morbidelli|
+|11|Pedro Lamy       |/2.[[Lotus|Lotus-Mugen-Honda]]|
+|12|Johnny Herbert   |
+|14|Rubens Barrichello|/2.[[Jordan|Jordan-Hart]]|
+|15|Eddie Irvine     |
+|19|Olivier Beretta  |/2.[[Larrousse|Larrousse-Ford]]|
+|20|Érik Comas       |
+|23|Pierluigi Martini|/2.[[Minardi|Minardi-Ford]]|
+|24|Michele Alboreto |
+|25|Éric Bernard     |/2.[[Ligier|Ligier-Renault]]|
+|26|Olivier Panis    |
+|27|Jean Alesi       |/2.[[Ferrari|Ferrari]]|
+|28|Gerhard Berger   |
+|29|Karl Wendlinger  |/2.[[Sauber|Sauber-Mercedes]]|
+|30|Heinz-Harald Frentzen|
+|31|David Brabham    |/2.[[Simtek|Simtek-Ford]]|
+|32|Roland Ratzenberger|
+|33|Paul Belmondo    |/2.[[Pacific|Pacific-Ilmor]]|
+|34|Bertrand Gachot  |
+
+
+[[Getting new people]]
+
+[[Contact form]]

data/spec/fixtures/markup/swap-links-output.textile

@@ -0,0 +1,57 @@
+h1. Wiki
+
+h2. The 1994 Formula One Season
+
+*[[Driver & Team Statistics|statistics]]*
+*[[Race by Race|race-by-race]]*
+*[[Technical Regulations|technical-regulations]]*
+*[[Technical Rule Changes|technical-rules]]*
+*[[HD Rear Wing Configurations|hd-rear-wings]]*
+*[[Helmet variants|helmets]]*
+
+h2. Development
+
+*[[Review Process F1 1994|review_process_f1_1994]]*
+*[[Credits|credits]]*
+
+h2. Season data
+
+h3. Drivers
+
+Early season package
+Driver list from Brazil: "Discussion here":http://forum.ctdp.net/viewtopic.php?f=214&t=62989
+
+|_.Nr|_.Driver       |_.Team|
+|0|Damon Hill        |/2.[[Williams-Renault|williams]]|
+|2|Ayrton Senna      |
+|3|Ukyo Katayama     |/2.[[Tyrrell-Yamaha|tyrrell]]|
+|4|Mark Blundell     |
+|5|Michael Schumacher|/2.[[Benetton-Ford|benetton]]|
+|6|Jos Verstappen    |
+|7|Mika Häkkinen     |/2.[[McLaren-Peugeot|mclaren]]|
+|8|Martin Brundle    |
+|9|Christian Fittipaldi|/2.[[Footwork-Ford|footwork]]|
+|10|Gianni Morbidelli|
+|11|Pedro Lamy       |/2.[[Lotus-Mugen-Honda|lotus]]|
+|12|Johnny Herbert   |
+|14|Rubens Barrichello|/2.[[Jordan-Hart|jordan]]|
+|15|Eddie Irvine     |
+|19|Olivier Beretta  |/2.[[Larrousse-Ford|larrousse]]|
+|20|Érik Comas       |
+|23|Pierluigi Martini|/2.[[Minardi-Ford|minardi]]|
+|24|Michele Alboreto |
+|25|Éric Bernard     |/2.[[Ligier-Renault|ligier]]|
+|26|Olivier Panis    |
+|27|Jean Alesi       |/2.[[Ferrari|ferrari]]|
+|28|Gerhard Berger   |
+|29|Karl Wendlinger  |/2.[[Sauber-Mercedes|sauber]]|
+|30|Heinz-Harald Frentzen|
+|31|David Brabham    |/2.[[Simtek-Ford|simtek]]|
+|32|Roland Ratzenberger|
+|33|Paul Belmondo    |/2.[[Pacific-Ilmor|pacific]]|
+|34|Bertrand Gachot  |
+
+
+[[Getting new people|getting_new_people]]
+
+[[Contact form|contact_form]]

data/spec/fixtures/markup/table-tab-line-endings-input.textile

@@ -0,0 +1,145 @@
+h1. Williams-Renault 1994
+
+"Williams FW16 Launch Press Conference on YouTube":http://www.youtube.com/watch?v=qJF5TYS9uX0
+"Williams FW16 Testing (Senna, Estoril) on YouTube":http://www.youtube.com/watch?v=smRQ2YnAfv0
+
+h2. Livery Changes
+
+|	|_.Mainsponsor	    |_.Mirrors|
+|*Brazil*	|/5.Rothmans|/2.white/elf|
+|Pacific|
+|San Marino	|/14.blue/elf|			
+|Monaco		|
+|Spain		|			
+|*Canada*		|Rothmans Ltd|
+|*France*	|Barcode|
+|*Great Britain*|/2.Racing|
+|Germany	|
+|Hungary	|/7.Rothmans|			
+|Belgium	|			
+|Italy		|		
+|Portugal	|			
+|Europe 	|			
+|Japan		|		
+|Australia |
+
+h2. Selected Technical Upgrades
+
+The upgrades we are going to do on the mod:
+* **A-Spec**
+** Frontwing
+*** High V1
+** Rearwing
+*** High V1
+*** Regular V1
+* **B-Spec**
+** Frontwing
+*** High V3
+*** High V2
+** Rearwing
+*** High V3
+*** Regular V3
+*** Low V3
+
+h2. Technical Upgrades
+
+_This is for keeping track of all upgrades. We will not implement everything in the actual mod!_
+
+|	        |_.Front wing	|_.Rear wing|_.Nose    |_.Barge boards|_.Airbox|
+|*Brazil*	|/2.High V1     |Regular V1|/2.with flipups |/4.none|/5. |
+|Pacific	|              High V1|
+|San Marino	|Low V1|Regular V1|/14. without flipups|
+|Monaco	        |/2.High V2    |High V1|      
+|Spain	        |??|/12.bargeboard|
+|Canada	        |/3.High V3|/2.High V1|/11.Airbox cutout|
+|France	        |
+|Great Britain  |Regular V1|
+|Germany	|Low V2 |Low|
+|Hungary	|High V3|High V3|
+|Belgium	|/2.Low V2|Regular V2|
+|Italy		|Low |
+|Portugal	|/4.High V3|??|
+|Europe 	|/3.Regular V3|
+|Japan		|
+|Australia      |
+
+h3. Front wing
+
+All frontwings from Spain onwards have new triangular endplates.
+
+*Low V2*: flat angle and large gurney flaps 
+*High V2*: added large gurney flaps 
+*High V3*: like v2, but with triangular sideplates 
+
+h3. Front wing
+
+*High V3*: adds one additional plane on the top and the wing additions inside the tires
+*Regular V2*: has different striped-down endplates
+*Regular V3*: has different endplates featuring the wing additions from the high-downforce variant
+
+
+
+h2. Technical Data (Autocourse 1994/95)
+
+!F1-1994_01_Williams.jpg!
+For comparison (from Histomobile):
+"FW16":http://www.histomobile.com/dvd_histomobile/usa/286/1994-Williams-FW16-.asp 515 kg, 2990 mm (wheelbase), 1669 mm (track front), 1598 mm (track rear)
+"FW16B":http://www.histomobile.com/dvd_histomobile/usa/286/1994-Williams-FW16B-.asp 595 kg, 2890 mm (wheelbase), 1669 mm (track front), 1598 mm (track rear)
+
+According to Autocourse 94/95, the FW16 started the season with the 67° V10 engine RS6 and got the RS6B for the Hockenheim GP as well as the RS6C for Monza. Both upgrades featured higher revs and improved top-end power. The RS6 delivered about 790 bhp / 589 KW @ 14300 rpm according to *"ultimatecarpage.com":http://www.ultimatecarpage.com/car/1054/Williams-FW16-Renault.html*.
+
+h2. Technical Data (Grand Prix 1994)
+
+!F1-1994_01_Williams_GP94.jpg!
+
+h2. Technical Upgrades
+
+The Ferrari car upgrades are listed below as reported in Autosport Magazine.
+
+h2. Pre-Season (Autosport 134(4), January 27)
+
+* Passive front suspension
+* New and simplified cockpit
+
+!Williams_000_AS-134_4_-1994-January-27.jpg!
+
+!Williams_010_AS-134_4_-1994-January-27.jpg!
+
+h3. Photos of the new cockpit and display (late season!)
+
+!Williams_010_cockpit1.jpg!
+!Williams_010_cockpit2.jpg!
+!Williams_010_cockpit3.jpg!
+
+h2. Pre-Season (Autosport 134(9), March 3)
+
+* General car design
+* Suspension
+* Rear wing
+
+!Williams_015_AS-134_9_-1994-March-3.jpg!
+!Williams_016_AS-134_9_-1994-March-3.jpg!
+!Williams_018_AS-134_9_-1994-March-3.jpg!
+
+h2. Brazilian GP, Interlagos (Autosport 134(11), March 17)
+
+* Re-designed ear end
+* Chassis (cockpit, fuel tank, ...)
+
+!Williams_020_AS-134_11_-1994-March-17.jpg!
+
+h2. Testing between Brazilian and Pacific GP (Autosport 134(14), April 7)
+
+!Williams_030_AS-134_14_-1994-April-7.jpg!
+
+h2. German GP, Hockenheim (Autosport 136(5), August 4)
+
+* Shortened sidepods
+* Revised (elongated) bargeboards
+* Revised cockpit edge (now rounded at the front)
+* New airbox vent in agreement with the new regulations
+* Rear suspension
+* Diffuser
+
+!Williams_040_AS-136_5_-1994-August-4.jpg!
+

data/spec/fixtures/markup/table-tab-line-endings-output.textile

@@ -0,0 +1,145 @@
+h1. Williams-Renault 1994
+
+"Williams FW16 Launch Press Conference on YouTube":http://www.youtube.com/watch?v=qJF5TYS9uX0
+"Williams FW16 Testing (Senna, Estoril) on YouTube":http://www.youtube.com/watch?v=smRQ2YnAfv0
+
+h2. Livery Changes
+
+|	|_.Mainsponsor	    |_.Mirrors|
+|*Brazil*	|/5.Rothmans|/2.white/elf|
+|Pacific|
+|San Marino	|/14.blue/elf|
+|Monaco		|
+|Spain		|
+|*Canada*		|Rothmans Ltd|
+|*France*	|Barcode|
+|*Great Britain*|/2.Racing|
+|Germany	|
+|Hungary	|/7.Rothmans|
+|Belgium	|
+|Italy		|
+|Portugal	|
+|Europe 	|
+|Japan		|
+|Australia |
+
+h2. Selected Technical Upgrades
+
+The upgrades we are going to do on the mod:
+* **A-Spec**
+** Frontwing
+*** High V1
+** Rearwing
+*** High V1
+*** Regular V1
+* **B-Spec**
+** Frontwing
+*** High V3
+*** High V2
+** Rearwing
+*** High V3
+*** Regular V3
+*** Low V3
+
+h2. Technical Upgrades
+
+_This is for keeping track of all upgrades. We will not implement everything in the actual mod!_
+
+|	        |_.Front wing	|_.Rear wing|_.Nose    |_.Barge boards|_.Airbox|
+|*Brazil*	|/2.High V1     |Regular V1|/2.with flipups |/4.none|/5. |
+|Pacific	|              High V1|
+|San Marino	|Low V1|Regular V1|/14. without flipups|
+|Monaco	        |/2.High V2    |High V1|
+|Spain	        |??|/12.bargeboard|
+|Canada	        |/3.High V3|/2.High V1|/11.Airbox cutout|
+|France	        |
+|Great Britain  |Regular V1|
+|Germany	|Low V2 |Low|
+|Hungary	|High V3|High V3|
+|Belgium	|/2.Low V2|Regular V2|
+|Italy		|Low |
+|Portugal	|/4.High V3|??|
+|Europe 	|/3.Regular V3|
+|Japan		|
+|Australia      |
+
+h3. Front wing
+
+All frontwings from Spain onwards have new triangular endplates.
+
+*Low V2*: flat angle and large gurney flaps 
+*High V2*: added large gurney flaps 
+*High V3*: like v2, but with triangular sideplates 
+
+h3. Front wing
+
+*High V3*: adds one additional plane on the top and the wing additions inside the tires
+*Regular V2*: has different striped-down endplates
+*Regular V3*: has different endplates featuring the wing additions from the high-downforce variant
+
+
+
+h2. Technical Data (Autocourse 1994/95)
+
+!F1-1994_01_Williams.jpg!
+For comparison (from Histomobile):
+"FW16":http://www.histomobile.com/dvd_histomobile/usa/286/1994-Williams-FW16-.asp 515 kg, 2990 mm (wheelbase), 1669 mm (track front), 1598 mm (track rear)
+"FW16B":http://www.histomobile.com/dvd_histomobile/usa/286/1994-Williams-FW16B-.asp 595 kg, 2890 mm (wheelbase), 1669 mm (track front), 1598 mm (track rear)
+
+According to Autocourse 94/95, the FW16 started the season with the 67° V10 engine RS6 and got the RS6B for the Hockenheim GP as well as the RS6C for Monza. Both upgrades featured higher revs and improved top-end power. The RS6 delivered about 790 bhp / 589 KW @ 14300 rpm according to *"ultimatecarpage.com":http://www.ultimatecarpage.com/car/1054/Williams-FW16-Renault.html*.
+
+h2. Technical Data (Grand Prix 1994)
+
+!F1-1994_01_Williams_GP94.jpg!
+
+h2. Technical Upgrades
+
+The Ferrari car upgrades are listed below as reported in Autosport Magazine.
+
+h2. Pre-Season (Autosport 134(4), January 27)
+
+* Passive front suspension
+* New and simplified cockpit
+
+!Williams_000_AS-134_4_-1994-January-27.jpg!
+
+!Williams_010_AS-134_4_-1994-January-27.jpg!
+
+h3. Photos of the new cockpit and display (late season!)
+
+!Williams_010_cockpit1.jpg!
+!Williams_010_cockpit2.jpg!
+!Williams_010_cockpit3.jpg!
+
+h2. Pre-Season (Autosport 134(9), March 3)
+
+* General car design
+* Suspension
+* Rear wing
+
+!Williams_015_AS-134_9_-1994-March-3.jpg!
+!Williams_016_AS-134_9_-1994-March-3.jpg!
+!Williams_018_AS-134_9_-1994-March-3.jpg!
+
+h2. Brazilian GP, Interlagos (Autosport 134(11), March 17)
+
+* Re-designed ear end
+* Chassis (cockpit, fuel tank, ...)
+
+!Williams_020_AS-134_11_-1994-March-17.jpg!
+
+h2. Testing between Brazilian and Pacific GP (Autosport 134(14), April 7)
+
+!Williams_030_AS-134_14_-1994-April-7.jpg!
+
+h2. German GP, Hockenheim (Autosport 136(5), August 4)
+
+* Shortened sidepods
+* Revised (elongated) bargeboards
+* Revised cockpit edge (now rounded at the front)
+* New airbox vent in agreement with the new regulations
+* Rear suspension
+* Diffuser
+
+!Williams_040_AS-136_5_-1994-August-4.jpg!
+