elexis-wiki-interface 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5baba0fd1711b2a15b723334288063147ba422d4
-  data.tar.gz: 168ff2b578edd9fbeb81b0d7d233ebcbd94462a0
+  metadata.gz: 1af9634489e62b4b68be7683c5711ea4f29cf403
+  data.tar.gz: f8d6689239f46763698749f8b4dd0e2a575dcaf6
 SHA512:
-  metadata.gz: d3265153c61faa03c0f5aaeee4d49c36c3cc1819fd558256d3c05bf204fbfce6dd98bd43472b5c3bbea782727e44b3c71796e8ebec34d0177f177081092c452e
-  data.tar.gz: 469f8477d558afc9ab1064c5b98e5bf4caf8af1c482de768f34a056dbcedb3a0b31f1c87f06cecca5f025f51ea2d5c52108ee0cd3d9da4bd1e8bf336af06c14f
+  metadata.gz: 791b7f0da48c69730dabde66490ec12fdca8a509cdb5f1987c41e9216045615156e077f20aa9334cec519da207bbbb0054b12546dc031453105d43fadedf1551
+  data.tar.gz: 6c1ac1fdb2cd40507b3cfcd811d9d4df77311afcd70bb3c2c3b9e98d5731b7c7e4028f8919e5daf9d074023c4877736d5304b0f6cd35b4e5a8ef170e349dae0f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    elexis-wiki-interface (0.4.5)
+    elexis-wiki-interface (0.4.6)
       eclipse-plugin (>= 0.1)
       mediawiki-gateway
       rubyzip (< 1.0.0)

data/History.txt

@@ -1,3 +1,9 @@
+=== 0.4.6 / 15.08.2015
+
+* Replace [[Datei:|[[Image: by [[File:
+* Cleanup readme.textile
+* Avoid adding an EOL at the end of the file
+
 === 0.4.5 / 14.08.2015
 
 * Don't report plugin without documenteation, as only features are required to have one

data/README.textile

@@ -45,7 +45,6 @@ workspace.pull # get actual mediawiki content and place it under doc inside the
 workspace.info.show
 pp workspace.views_missing_documentation            # returns an array of plugin-ids
 pp workspace.perspectives_missing_documentation     # returns an array of plugin-ids
-pp workspace.plugins_missing_documentation          # returns an array of plugis
 workspace.push # push doc/*.mediwiki files to the wiki
 
 Or you can inspire you from the spec/*_spec.rb files to see tested examples.
@@ -69,13 +68,20 @@ h3. Conventions
 
 * You must create a directory config with a file hosts.yml containing the mediawiki-gateway configuration (host, username, password)
 
+* Use tag File
+We decided to use only the tag file as https://www.mediawiki.org/wiki/Help:Images/de recommends, even when the legacy tag Image is still supported.
+Also we don't use the tag Datei, as this one is not supported by the Mylin Wikitext extension of Eclipse.
+
 * The push/pull methods use the convention
 ** in page names all '.' are removed
 ** a plugin plugin.name has a page plugin.name
 ** a view view.name with a localized name localized_name has a page <plugin.name>Views<localized_name>
 ** a perspective perspective.name with a localized name localized_name has a page  P_<localized_name>
+** an image file must be lowercase (files which differ only by the case will be deleted)
+** use syntax @[[File:@, not [[Datei: or @[[Image:@
 ** png files should start with their plugin/feature-name followed by '/' by a name or a globally unique name
 ** png files resides inside the 'doc' sub-directory of each plugin/feature
+** inside the doc directoy we create a logical link of the plugin|feature name to the directory. This allows us to edit and preview the mediawiki files using the Mylin Wikitext extension of Eclipse.
 
 h3. Limitations/TODO
 
@@ -89,9 +95,6 @@ h3. Limitations/TODO
 *** ch.elexis.core.application/plugin.xml:            name="%elexis.articleSelectorView">
 ** Missing line [[Datei:Ch.elexis:Artikelauswahl.png]] in http://wiki.elexis.info/ChElexisViewsArtikelArtikelselektor
 * Perspektives: were not uploaded to doc_de
-* No images are pulled/pushed at the moment.
-* Check whether a link to the view exists on the wiki.elexis.info/Hauptseite
-* No support for features at the moment
 * No multilingual support at the moment
 
 

data/lib/elexis/wiki/interface/version.rb

@@ -1,7 +1,7 @@
 module Elexis
   module Wiki
     module Interface
-      VERSION = "0.4.5"
+      VERSION = "0.4.6"
     end
   end
 end

data/lib/elexis/wiki/interface/workspace.rb

@@ -15,14 +15,6 @@ module Elexis
       TestPattern = /[\._]test[s]*$/i
       $ws_errors = []
 
-      # All images under wiki.elexis.info must have images corresponding to the following scheme
-      # directory (optional): id of the plugin/feature (with feature.feature.group removed)
-      # imagename:
-      # Therefore you find und http://wiki.elexis.info/index.php?title=Ch.elexis.connect.mythic&action=edit the line
-      #   [[Image:ch.elexis.connect.mythic_kabel.png|image]] [fig:kabel]
-      # and under http://wiki.elexis.info/index.php?title=Com.hilotec.elexis.opendocument.feature.feature.group&action=edit
-      #   [[Image:com.hilotec.elexis.opendocument/anleitung_opendocument_1.png|frame|none]]
-
       def Interface.return_canonical_image_name(pagename, filename)
         pagename = pagename.sub('.feature.feature.group', '')
         short = File.basename(filename.downcase.sub(ImagePrefix, ''))
@@ -30,12 +22,23 @@ module Elexis
         /[:\/]/.match(filename) ? pagename + '/' + short : short
       end
 
+      def Interface.remove_image_ignoring_case(filename)
+        files = Dir.glob(filename, File::FNM_CASEFOLD)
+        return if files.size == 1
+        files.each{
+          |file|
+            next if File.basename(file).eql?(File.basename(filename))
+            cmd = "git rm -f #{file}"
+            res = system(cmd)
+        }
+      end
+
       def Interface.fix_image_locations(filename, pagename)
         return unless File.exists?(filename)
         pagename = pagename.sub('.feature.feature.group', '')
         lines = IO.readlines(filename)
         dirName = File.dirname(filename)
-        newLines = []
+        newLines = ''
         showDetails =  $VERBOSE
         if /icpc.mediawiki/i.match(filename)
           showDetails = true
@@ -43,26 +46,27 @@ module Elexis
         lines.each{
           |line|
           unless m =ImagePattern.match(line)
-            newLines << line
+            newLines += line
           else
             new_name = Interface.return_canonical_image_name(pagename, m[2])
             unless new_name.eql?(File.basename(new_name))
               FileUtils.ln_s('.', File.dirname(new_name), :verbose => true) unless File.exists?(File.dirname(new_name))
             end
             simpleName = File.join(dirName, File.basename(new_name))
-            if files = Dir.glob(simpleName, File::FNM_CASEFOLD) and files.size == 1
+            if files = Dir.glob(simpleName, File::FNM_CASEFOLD) and files.size >= 1
               new_line = line.sub(m[2], new_name)
-              newLines << new_line
+              newLines += new_line
+              Interface.remove_image_ignoring_case(simpleName)
             else
               next if defined?(RSpec)
-              msg =  "Could not find image for #{m[0]} searched for #{simpleName} in #{Dir.pwd}"
+              msg =  "Could not find image for #{m[0]} searched for #{simpleName} in #{Dir.pwd}. files are #{files}"
               puts msg
               $ws_errors << msg
-              newLines << line.sub(ImagePattern, "#{m[1]}#{m[2].sub(':', '_')}")
+              newLines += line.sub(ImagePattern, "#{m[1]}#{m[2].sub(':', '_')}")
             end
           end
         }
-        File.open(filename, "w+") {|f| f.puts newLines}
+        File.open(filename, "w") {|f| f.write newLines.gsub(/\[\[Datei:|\[\[Image:/i, '[[File:')}
       end
 
       class Workspace
@@ -195,8 +199,9 @@ module Elexis
 
         def remove_image_files_with_id(id, info, docDir = nil)
           docDir ||= File.join(@info.workspace_dir, id, 'doc')
-          files = Dir.glob(File.join(docDir, "#{id}_*png")) +
-                  Dir.glob(File.join(docDir, "#{id.capitalize}_*png"))
+          files = Dir.glob(File.join(docDir, "#{id}_*jpg"), File::FNM_CASEFOLD) +
+              Dir.glob(File.join(docDir, "#{id}_*gif"), File::FNM_CASEFOLD) +
+              Dir.glob(File.join(docDir, "#{id}_*png"), File::FNM_CASEFOLD)
           system("git rm #{files.join(' ')}") if files.size > 0
         end
 
@@ -316,11 +321,7 @@ module Elexis
                   file.write(open(image_url).read)
                 end
                 files = Dir.glob(downloaded_image, File::FNM_CASEFOLD)
-                files.each{
-                  |file|
-                  next if file.eql?(downloaded_image)
-                  FileUtils.rm_f(file, :verbose => true)
-                  }
+                Interface.remove_image_ignoring_case(downloaded_image)
               else
                 puts "skipping image #{image} for page #{pageName}"
               end

data/spec/data/push/ch.elexis.core.application/doc/ChElexisViewsBestellblatt.mediawiki

@@ -0,0 +1,19 @@
+[[Kategorie:Basis-System]]
+== View: Bestellblatt==
+{{PluginInfo
+|plugin=ch.elexis
+| category=ch.elexis.datenKategorie
+| wikiName=ChElexisViewsBestellblatt
+| Iatrix-Hilfe=nicht vorhanden
+| view_name=View
+| name=elexis
+| description=Elexis Basismodul
+| category=invisible
+| license=EPL
+| first_commit_date=2007-06-24
+| first_commit_author=rgw_ch
+| responsible=weirich@elexis.ch
+| type=Basis-System
+
+
+}}

data/spec/pull_spec.rb

@@ -80,10 +80,10 @@ describe 'Plugin' do
       name = File.join(@dataDir, "ch.elexis.icpc", "doc", "Ch.elexis.icpc.mediawiki")
       expect(Dir.glob(name).size).to eq 1
       content = IO.read(name)
-      m = /(Image:[\w\.]+)[:_](\w+.png)/.match(content)
+      m = /(File:[\w\.]+)[:_](\w+.png)/.match(content)
       expect(m).to eq nil
-      m = /(Image:[\w\.]+)\/(icpc0.png)/i.match(content)
-      expect(m[0]).to eq 'Image:Ch.elexis.icpc/icpc0.png'
+      m = /(File:[\w\.]+)\/(icpc0.png)/i.match(content)
+      expect(m[0]).to eq 'File:Ch.elexis.icpc/icpc0.png'
   end
 
   it "should show all users" do

data/spec/update_images_spec.rb

@@ -11,7 +11,7 @@ describe 'ImageHandling' do
     @dataDir = File.expand_path(File.join(File.dirname(__FILE__), 'run', 'push'))
     FileUtils.rm_rf(@dataDir)
     FileUtils.makedirs(@dataDir)
-    FileUtils.cp_r(@originDir, @dataDir, :verbose => true, :preserve => true)
+    FileUtils.cp_r(@originDir, @dataDir, :preserve => true)
   end
 
   it "should return corret canonical_names for a plugin" do
@@ -53,18 +53,13 @@ describe 'ImageHandling' do
                 ]
     original = IO.read(wiki_file)
     before.each{|string| expect(original).to include string }
-  end
-
-  it "should adapt correctly the image name being in #{@dataDir}" do
-    wiki_file = File.join(@dataDir, 'ch.elexis.icpc', 'doc', 'test.mediawiki')
-    Dir.chdir(@dataDir)
 
     Elexis::Wiki::Interface.fix_image_locations(wiki_file, 'ch.elexis.icpc')
-    after =['tag_one [[Image:ch.elexis.icpc/icpc1.png|image]]',
-      'tag_two [[Image:ch.elexis.icpc/icpc2.png|image]]',
-      'tag_three [[Image:icpc3.png|image]]',
-      'tag_four [[Datei:ch.elexis.icpc/icpc4.png|image]]',
-      'tag_five [[Datei:ch.elexis.icpc/icpc5.png|image]]',
+    after =['tag_one [[File:ch.elexis.icpc/icpc1.png|image]]',
+      'tag_two [[File:ch.elexis.icpc/icpc2.png|image]]',
+      'tag_three [[File:icpc3.png|image]]',
+      'tag_four [[File:ch.elexis.icpc/icpc4.png|image]]',
+      'tag_five [[File:ch.elexis.icpc/icpc5.png|image]]',
                 ]
     changed = IO.read(wiki_file)
     after.each{|string| expect(changed).to include string }
@@ -75,11 +70,26 @@ describe 'ImageHandling' do
     Dir.chdir(@dataDir)
 
     Elexis::Wiki::Interface.fix_image_locations(wiki_file, 'ch.elexis.icpc')
-    after =['tag_three [[Image:icpc3.png|image]]',
+    after =['tag_three [[File:icpc3.png|image]]',
             ]
     changed = IO.read(wiki_file)
     after.each{|string| expect(changed).to include string }
   end
 
+  it "should not add an EOL if nothing changed" do
+    id = 'ch.elexis.core.application'
+    @originDir = File.expand_path(File.join(File.dirname(__FILE__), 'data', 'push', id))
+    @dataDir = File.expand_path(File.join(File.dirname(__FILE__), 'run', 'push'))
+    FileUtils.rm_rf(@dataDir)
+    FileUtils.makedirs(@dataDir)
+    FileUtils.cp_r(@originDir, @dataDir, :preserve => true)
+    wiki_file = File.join(@dataDir, id, 'doc', 'ChElexisViewsBestellblatt.mediawiki')
+    orig_content = IO.read(wiki_file)
+    Dir.chdir(@dataDir)
+    Elexis::Wiki::Interface.fix_image_locations(wiki_file, id)
+    changed = IO.read(wiki_file)
+    expect(changed).to eql orig_content
+  end
+
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elexis-wiki-interface
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - Niklaus Giger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-14 00:00:00.000000000 Z
+date: 2015-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -171,6 +171,7 @@ files:
 - spec/data/pull/ch.elexis.notes/plugin_en.properties
 - spec/data/pull/ch.elexis.notes/plugin_fr.properties
 - spec/data/pull/doc_de/.project
+- spec/data/push/ch.elexis.core.application/doc/ChElexisViewsBestellblatt.mediawiki
 - spec/data/push/ch.elexis.icpc/.project
 - spec/data/push/ch.elexis.icpc/META-INF/MANIFEST.MF
 - spec/data/push/ch.elexis.icpc/doc/ch.elexis.icpc_icpc1.png
@@ -185,9 +186,6 @@ files:
 - spec/data/push/ch.elexis.icpc/plugin.xml
 - spec/pull_spec.rb
 - spec/push_spec.rb
-- spec/run/push/ch.elexis.icpc/doc/icpc3.png
-- spec/run/push/ch.elexis.icpc/doc/icpc4.png
-- spec/run/push/ch.elexis.icpc/doc/icpc5.png
 - spec/spec_helper.rb
 - spec/update_images_spec.rb
 - spec/user_spec.rb
@@ -240,6 +238,7 @@ test_files:
 - spec/data/pull/ch.elexis.notes/plugin_en.properties
 - spec/data/pull/ch.elexis.notes/plugin_fr.properties
 - spec/data/pull/doc_de/.project
+- spec/data/push/ch.elexis.core.application/doc/ChElexisViewsBestellblatt.mediawiki
 - spec/data/push/ch.elexis.icpc/.project
 - spec/data/push/ch.elexis.icpc/META-INF/MANIFEST.MF
 - spec/data/push/ch.elexis.icpc/doc/ch.elexis.icpc_icpc1.png
@@ -254,9 +253,6 @@ test_files:
 - spec/data/push/ch.elexis.icpc/plugin.xml
 - spec/pull_spec.rb
 - spec/push_spec.rb
-- spec/run/push/ch.elexis.icpc/doc/icpc3.png
-- spec/run/push/ch.elexis.icpc/doc/icpc4.png
-- spec/run/push/ch.elexis.icpc/doc/icpc5.png
 - spec/spec_helper.rb
 - spec/update_images_spec.rb
 - spec/user_spec.rb