tiddlywiki_cp 0.4.1 → 0.5.1

data/History.txt

@@ -1,3 +1,9 @@
+== 0.5.1 2008-04-07
+
+* Apply Markup tiddlers.
+
+* Save / restore lang attribute.
+
 == 0.4.1 2008-03-30
 
 * 1 major bug fix:

data/Manifest.txt

@@ -30,6 +30,7 @@ test/content/ignored#
 test/content/test_fetch.html
 test/content/tiddly_version_2_1.txt
 test/content/tiddly_version_2_2.txt
+test/content/tiddly_version_2_3.txt
 test/content/universe.html
 test/r4tw/addtag.rb
 test/r4tw/all.rb
@@ -68,7 +69,7 @@ website/files/SiteTitle.tiddler
 website/files/SiteTitle.tiddler.div
 website/files/Usage.tiddler
 website/files/Usage.tiddler.div
-website/files/WebDAVSavingPlugin.js
-website/files/WebDAVSavingPlugin.js.div
+website/files/WebDavPlugin.js
+website/files/WebDavPlugin.js.div
 website/index.html
 website/index.xml

data/README.txt

@@ -1,3 +1,7 @@
 README for tiddlywiki_cp
 ========================
 
+a ruby gem (http://rubyforge.org/projects/tiddlywikicp/) providing a
+library and a command line interface to copy tiddlywiki tiddlers to
+files and vice versa.
+

data/Rakefile

@@ -83,6 +83,7 @@ desc 'Generate website files'
 task :website_generate do
     sh %{ ( echo '{{{' ; RUBYLIB=lib ruby bin/tiddlywiki_cp --help ; echo '}}}' ) > website/files/Usage.tiddler }
     sh %{ ( echo '{{{' ; hg log ; echo '}}}' ) > website/files/ChangeLog.tiddler }
+    sh %{ cd website ; RUBYLIB=../lib ruby ../bin/tiddlywiki_cp -a files index.html }
 end
 
 desc 'Upload website files to rubyforge'

data/lib/tiddlywiki_cp/r4tw.rb

@@ -1,6 +1,7 @@
 #
 # =r4tw
 # Author:: Simon Baird
+#          Copyright (C) 2008 Loic Dachary <loic@dachary.org>
 # URL:: http://simonbaird.com/r4tw
 # License:: http://en.wikipedia.org/wiki/MIT_license
 # r4tw is some ruby classes for manipuating TiddlyWikis and tiddlers.
@@ -129,7 +130,7 @@ class Tiddler
       '.js'      => %[systemConfig],
       '.html'    => %[html],
       '.css'     => %[css],
-      '.pub'     => %[contentPublisher],
+      '.pub'     => %[systemServer],
       '.palette' => %[palette],
   }
   
@@ -465,13 +466,23 @@ end
 
 class TiddlyWiki
 
-  attr_accessor :orig_tiddlers, :tiddlers, :raw
+  TIDDLER2MARKUP = {
+    'MarkupPreHead'  => 'PRE-HEAD',
+    'MarkupPostHead' => 'POST-HEAD',
+    'MarkupPreBody'  => 'PRE-BODY',
+    'MarkupPostBody' => 'POST-BODY',
+  }
+
+  @@lang_re = /<html(.*?)\s+xml:lang=['"](\w\w)['"]\s+lang=['"](\w\w)['"]/ms
+
+  attr_accessor :orig_tiddlers, :tiddlers, :raw, :lang
 
   # doesn't do much. probably should allow an empty file param
   def initialize(use_pre=false)
     @use_pre = use_pre
     @tiddlers = []
     @core_hacks = []
+    @lang = 'en'
   end
 
   # this should replace all the add_tiddler_from_blah methods
@@ -490,6 +501,46 @@ class TiddlyWiki
     end
   end
 
+  def locale2lang(raw)
+    #
+    # Inspect systemConfig tiddlers, looking for locale settings
+    #
+    locale_set_re = /config.locale\s*=/s
+    locale_re = /config.locale\s*=\s*['"](\w\w)['"]/ms
+    lang = @lang
+    @tiddlers.each do |t|
+      if t.has_tag('systemConfig')
+        text = t.fields['text']
+        if text =~ locale_set_re
+          matches = text.match(locale_re)
+          if matches
+            lang = matches[1];
+          else
+            raise "#{locale_set_re} matches but #{locale_re} does not in #{text}"
+          end
+        end
+      end
+    end
+    if lang != @lang
+      raw.gsub!(@@lang_re, "<html\\1 xml:lang=\"#{lang}\" lang=\"#{lang}\"")
+      @lang = lang
+    end
+    return raw
+  end
+
+  def lang_from_raw()
+    matches = @raw.match(@@lang_re)
+    if matches
+      if matches[2] == matches[3]
+        @lang = matches[2]
+      else
+        raise "#{re} found '#{matches[2]}' and '#{matches[3]}' and expected them to be equal"
+      end
+    else
+      raise "#{re} found no match in ${@raw}"
+    end
+  end
+
   # initialise a TiddlyWiki from a source file
   # will treat empty_file as a url if it looks like one
   # note that it doesn't have to be literally empty
@@ -666,13 +717,27 @@ class TiddlyWiki
 
   # output the TiddlyWiki file
   def to_s
+    #
+    # Each Markup* tiddler must be copied to the corresponding <!-- .. -START -->
+    # section. It will be copied by the regular tiddlywiki save function, but
+    # it requires manual intervention.
+    #
+    @tiddlers.each do |t|
+      if TIDDLER2MARKUP[t.name]
+        markup = TIDDLER2MARKUP[t.name]
+        mstart = "<!--" + markup + "-START-->"
+        mend = "<!--" + markup + "-END-->"
+        add_core_hack(/#{mstart}.*#{mend}/m, "#{mstart}\n#{t.fields['text']}\n#{mend}")
+      end
+    end
     pre_store_hacked = pre_store
     post_store_hacked = post_store
     @core_hacks.each do |hack|
       pre_store_hacked.gsub!(hack[0],hack[1])
       post_store_hacked.gsub!(hack[0],hack[1])
     end
-    "#{pre_store_hacked}#{store_to_s}#{post_store_hacked}"
+    all = "#{pre_store_hacked}#{store_to_s}#{post_store_hacked}"
+    return locale2lang(all)
   end
 
   # output just the contents of the store

data/lib/tiddlywiki_cp/version.rb

@@ -16,7 +16,7 @@
 module TiddlywikiCp #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 4
+    MINOR = 5
     TINY  = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')

data/lib/tiddlywiki_cp.rb

@@ -158,6 +158,20 @@ module TiddlywikiCp
         opts.separator ""
         opts.separator "  #{cmd} -a A B C tiddlywiki.html"
         opts.separator "       copy all tiddlers found in the A B and C directories to tiddlywiki.html"
+        opts.separator ""
+        opts.separator "MarkupPreHead, MarkupPostHead, MarkupPreBody, MarkupPostBody tiddlers:"
+        opts.separator ""
+        opts.separator "  When copying to a tiddlywiki file, the content of these tiddlers "
+        opts.separator "  are copied to the corresponding HTML zones."
+        opts.separator ""
+        opts.separator "translations, i18n, l10n, linguo:"
+        opts.separator ""
+        opts.separator "  If a translation plugin such as the one found at "
+        opts.separator "  http://trac.tiddlywiki.org/wiki/Translations"
+        opts.separator "  is present, the tiddlywiki to which tiddlers are copied"
+        opts.separator "  will have its lang and xml:lang attributes updated."
+        opts.separator "  Saving the tiddlywiki manually does the same."
+        opts.separator ""
 
       end
       opts.parse!(argv)
@@ -347,6 +361,7 @@ module TiddlywikiCp
         tiddlywiki.raw = read_uri(uri)
         tiddlywiki.instance_eval do
           use_pre_from_raw
+          lang_from_raw
           @tiddlers = tiddlywiki.tiddler_divs.map do |tiddler_div|
             Tiddler.new.from_div(tiddler_div, @use_pre)
           end

data/test/content/tiddly_version_2_3.txt

@@ -0,0 +1 @@
+var version = {title: "TiddlyWiki", major: 2, minor: 3, revision: 0, date: new Date("Dec 4, 2007"), extensions: {}};

data/test/test_tiddlywiki_cp.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (C) 2007 Loic Dachary <loic@dachary.org>
+# Copyright (C) 2007, 2008 Loic Dachary <loic@dachary.org>
 #
 #    This program is free software: you can redistribute it and/or modify
 #    it under the terms of the GNU General Public License as published by
@@ -35,6 +35,60 @@ end
 class TestTiddlywikiCp < Test::Unit::TestCase
   include TiddlyBase
 
+  def test_lang_from_raw
+    r = TiddlyWiki.new
+    assert_equal('en', r.lang)
+    #
+    # The regexp does not match
+    #
+    r.raw = ''
+    exception = assert_raise RuntimeError do
+      r.lang_from_raw
+    end
+    assert_match(/no match/, exception.message)
+    #
+    # lang are inconsistent
+    #
+    r.raw = '<html xml:lang="en" lang="fr"'
+    exception = assert_raise RuntimeError do
+      r.lang_from_raw
+    end
+    assert_match(/'en' and 'fr'/, exception.message)
+    #
+    # success
+    #
+    r.raw = '<html xml:lang="fr" lang="fr"'
+    r.lang_from_raw
+    assert_equal('fr', r.lang)
+  end
+
+  def test_locale2lang
+    r = TiddlyWiki.new
+    r.add_tiddler_from({ 'tiddler' => 'fakefrench',
+                          'tags' => ['systemConfig'],
+                          'text' => 'config.locale = "fr"' })
+    raw = r.locale2lang('<html a="f" xml:lang="en" lang="en" ')
+    assert_match(/a="f" xml:lang="fr" lang="fr"/, raw)
+    #
+    # weird config.locale throw exceptions
+    #
+    r.get_tiddler('fakefrench').fields['text'] = 'config.locale = "f" + "r"';
+    exception = assert_raise RuntimeError do
+      r.locale2lang('')
+    end
+    assert_match(/matches but/, exception.message)
+  end
+
+  def test_locale
+    t = TiddlyWikiCp.new
+    uri = "#{this_dir(__FILE__)}/content/universe.html"
+    tw = t.uri2tiddlywiki("#{uri}")
+    tw.add_tiddler_from({ 'tiddler' => 'fakefrench',
+                          'tags' => ['systemConfig'],
+                          'text' => 'config.locale = "fr"' })
+    assert_match(/lang="fr"/s, tw.to_s)
+  end
+
   def test_main
     t = TiddlyWikiCp.new
     a = "#{this_dir(__FILE__)}/content/a" # existing file without .div
@@ -311,6 +365,7 @@ class TestTiddlywikiCp < Test::Unit::TestCase
 
   def test_tiddlywiki?
     t = TiddlyWikiCp.new
+    assert(t.tiddlywiki?("#{this_dir(__FILE__)}/content/tiddly_version_2_3.txt"))
     assert(t.tiddlywiki?("#{this_dir(__FILE__)}/content/tiddly_version_2_2.txt"))
     assert(t.tiddlywiki?("#{this_dir(__FILE__)}/content/tiddly_version_2_1.txt"))
     assert_equal(nil, t.tiddlywiki?("#{this_dir(__FILE__)}/content/html_entities.html"))
@@ -355,12 +410,23 @@ class TestTiddlywikiCp < Test::Unit::TestCase
     t.tiddler2file(j, "spit/c")
     t.uri2tiddler(j).fields['text'] = 'NONE'
     t.file2tiddler("spit/c", j)
-    assert_match(/lightBoxTitle {padding:0px/, original)
+    assert_match(/lightBoxTitle \{padding:0px/, original)
     transformed = t.uri2tiddler(j).text
     assert_match(/TiddlyLightBoxStyles=\"/, original)
     assert_equal(original, transformed)
   end
 
+  def test_file2markuptiddler
+    t = TiddlyWikiCp.new
+    uri = "#{this_dir(__FILE__)}/content/universe.html"
+    tw = t.uri2tiddlywiki("#{uri}")
+    TiddlyWiki::TIDDLER2MARKUP.each_pair do |tiddler, markup| 
+      mark = "XXX#{tiddler}XXX"
+      tw.add_tiddler_from({ 'tiddler' => tiddler, 'text' => mark})
+      assert_match(/#{markup}-START.*#{mark}.*#{markup}-END/sm, tw.to_s)
+    end
+  end
+
   def test_tiddler2directory
     t = TiddlyWikiCp.new
     t.tiddler2directory("#{this_dir(__FILE__)}/content/universe.html#Implementation", "spit")

data/website/files/ChangeLog.tiddler

@@ -1,7 +1,92 @@
 {{{
-changeset:   60:4177e4981005
+changeset:   77:5e92b7ebcd70
 tag:         tip
 user:        root@dachary.org
+date:        Fri Apr 04 14:17:09 2008 +0000
+summary:     update plugin name
+
+changeset:   76:b1a11d62dce4
+user:        root@dachary.org
+date:        Fri Apr 04 14:04:08 2008 +0000
+summary:     upgrade website to tw-2.3 and newer davplugin
+
+changeset:   75:fb74e9bc08d4
+user:        root@dachary.org
+date:        Fri Apr 04 13:42:01 2008 +0000
+summary:     update documentation
+
+changeset:   74:0dc051395239
+user:        root@dachary.org
+date:        Fri Apr 04 13:36:13 2008 +0000
+summary:     update documentation for 0.5.0
+
+changeset:   73:dddb2fc4bbca
+user:        root@dachary.org
+date:        Fri Apr 04 13:01:52 2008 +0000
+summary:     0.5.0 release ready
+
+changeset:   72:7290595266bb
+user:        root@dachary.org
+date:        Fri Apr 04 12:59:23 2008 +0000
+summary:     documentation for lang support
+
+changeset:   71:86e046e659af
+user:        root@dachary.org
+date:        Fri Apr 04 12:52:12 2008 +0000
+summary:     test file for tw 2.3
+
+changeset:   70:301346066b75
+user:        root@dachary.org
+date:        Fri Apr 04 10:36:24 2008 +0000
+summary:     update lang tags
+
+changeset:   69:7c7f3d279c28
+user:        root@dachary.org
+date:        Fri Apr 04 07:11:49 2008 +0000
+summary:     test tw-2.3 version detection
+
+changeset:   68:e635348a3352
+user:        root@dachary.org
+date:        Thu Apr 03 15:43:32 2008 +0000
+summary:     generate index.html with website_generate target
+
+changeset:   67:dd3534267e3c
+user:        root@dachary.org
+date:        Thu Apr 03 15:36:56 2008 +0000
+summary:     copy Markup* tiddlers to the corresponding zone in the tiddlywiki
+
+changeset:   66:740b082f235a
+user:        loic@dachary.org
+date:        Thu Apr 03 09:29:57 2008 +0000
+summary:     apt-get install ruby-elisp
+
+changeset:   65:47688556400d
+user:        root@dachary.org
+date:        Thu Apr 03 09:29:16 2008 +0000
+summary:     bump to version 0.5.0
+
+changeset:   64:3544bb17985c
+user:        root@dachary.org
+date:        Thu Apr 03 08:58:43 2008 +0000
+summary:     fix invalid regexp including {
+
+changeset:   63:13476d79f633
+user:        root@dachary.org
+date:        Thu Apr 03 08:44:20 2008 +0000
+summary:     update SimonBaird work local copy
+
+changeset:   62:dfdfb30ccb97
+user:        root@dachary.org
+date:        Mon Mar 31 21:08:17 2008 +0000
+summary:     sync with SimonBaird version : systemServer replaces contentPublisher
+
+changeset:   61:73d453e23b5d
+user:        root@dachary.org
+date:        Sun Mar 30 21:29:40 2008 +0000
+summary:     release information and web site
+
+changeset:   60:4177e4981005
+user:        root@dachary.org
 date:        Sun Mar 30 21:18:27 2008 +0000
 summary:     remove extra SimonBaird files
 

data/website/files/DefaultTiddlers.tiddler

@@ -1,2 +1,2 @@
-Introduction
-Usage
+[[Introduction]]
+[[Usage]]

data/website/files/Introduction.tiddler

@@ -1,12 +1,30 @@
 a ruby gem (http://rubyforge.org/projects/tiddlywikicp/) providing a library and a command line interface to copy [[tiddlywiki|http://tiddlywiki.com/]] tiddlers to files and vice versa.
 
+Installation : gem install tiddlywiki_cp
+
 Development is discussed at irc.freenode.net#tiddlywiki 
 
 This tiddlywiki was created using the following commands:
+* copy an empty tiddlywiki to a local file
+{{{
+tiddlywiki_cp http://tiddlywiki.com/empty.html  website/index.html
+}}}
+* copy and install a plugin 
+{{{
+tiddlywiki_cp 'http://garden.dachary.org/#WebDavPlugin' website/index.html
+}}}
+* copy all tiddlers to a directory
 {{{
-tiddlywiki_cp 'http://tiddlylab.bidix.info/#WebDAVSavingPlugin' website/index.html
+mkdir website/files
 tiddlywiki_cp -a website/index.html website/files
-( echo '{{''{' ; RUBYLIB=lib ruby bin/tiddlywiki_cp --help ; echo '}}''}' ) > website/files/Usage
-tiddlywiki_cp -a website/files website/index.html
+}}}
+* use regular shell commands to create or update files
+{{{
+( echo '{{''{' ; RUBYLIB=lib ruby bin/tiddlywiki_cp --help ; echo '}}''}' ) > website/files/Usage.tiddler
+( echo '{{''{' ; hg log ; echo '}}''}' ) > website/files/ChangeLog.tiddler
+}}}
+* copy all tiddlers in a directory into a tiddlywiki, updating existing ones and adding new ones
+{{{
+cd website ; RUBYLIB=../lib ruby ../bin/tiddlywiki_cp -a files index.html 
 }}}
 Loic Dachary <mailto:loic@dachary.org>

data/website/files/Usage.tiddler

@@ -52,4 +52,18 @@ Examples:
 
   tiddlywiki_cp -a A B C tiddlywiki.html
        copy all tiddlers found in the A B and C directories to tiddlywiki.html
+
+MarkupPreHead, MarkupPostHead, MarkupPreBody, MarkupPostBody tiddlers:
+
+  When copying to a tiddlywiki file, the content of these tiddlers 
+  are copied to the corresponding HTML zones.
+
+translations, i18n, l10n, linguo:
+
+  If a translation plugin such as the one found at 
+  http://trac.tiddlywiki.org/wiki/Translations
+  is present, the tiddlywiki to which tiddlers are copied
+  will have its lang and xml:lang attributes updated.
+  Saving the tiddlywiki manually does the same.
+
 }}}