wikisys 0.2.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bffc9856824a5b8afe8648ea585e3fbe2400ff94e7d0c0fbb0f622b138b8f7e6
-  data.tar.gz: c2acad35e8fe2361cadabe919004a2f203bf687a1efdc43e061351a3fda11678
+  metadata.gz: 7df49481e6dd9b98d651456392c9dc2bdc74ccd65565a7a5a73818415c3ebb24
+  data.tar.gz: 615021b76e6869b19f2b0885970778da4885b459bdc9d90adca8b159c5a756a7
 SHA512:
-  metadata.gz: 0fc14b79eb6eca3034f904be493787d8058e8d85699f612d0c1749e2bc4536c20fa7c08b36e81b04f0ac7c8ae8955884f86565a3a027348c218acd181898bc3e
-  data.tar.gz: 9f499b325c14ed3dc204d21c928756a5b27cae725c824f718056cdece85c1729b44f62734d1723a1282585ad5b7bf5fc71c035647851b88bcdf09b0430b9b71b
+  metadata.gz: e6b9139472aa18dc3c7d76eed52a5d5f0ee5956f7ba061fde200989c605f7238d2c51779550f3f0f47da718694230e11c197853dd9a2949f38c4ed475249c536
+  data.tar.gz: 5a7532e004d33a95f6802fe912cc6d791dccf0c7fe9f815330e59b91488a33067897af8d41d2332633705c9e6f6b82b42dae8ba4c3bad0beab074114dc8b2c52

data/lib/wikisys.rb

@@ -3,12 +3,38 @@
 # file: wikisys.rb
 
 require 'dxlite'
+require 'dir-to-xml'
+require 'mindwords'
 require 'martile'
+require 'hashcache'
+
+module FileFetch
+
+  def fetch_filepath(filename)
+
+    lib = File.dirname(__FILE__)    
+    File.join(lib,'..','stylesheet',filename)
+
+  end  
+  
+  def fetch_file(filename)
+
+    filepath = fetch_filepath filename
+    read filepath
+  end  
+
+  def read(s)
+    RXFHelper.read(s).first
+  end
+end
 
 module Wikisys
 
-  class Wiki
+  class Wiki    
+    include FileFetch
+    using ColouredText
     
+    attr_accessor :title, :content, :tags
     attr_reader :to_xml
 
     def initialize(filepath='.', entries: 'entries.json', debug: false)
@@ -16,18 +42,36 @@ module Wikisys
       @filepath = filepath
       @page = ''
       @debug = debug
+      
+      @hc = HashCache.new(size:30)
 
-      @entries = if File.exists?(entries) then
+      @entries = if entries.is_a? DxLite then
+      
+        entries
+        
+      elsif File.exists?(entries) then
       
         DxLite.new(entries)
 
       else
 
-        DxLite.new('entries/entry(title, tags)', filepath: entries)
+        DxLite.new('entries/entry(title, tags)')
 
       end
     
     end
+    
+    def create_breadcrumb(filepath, links)
+  
+      doc = Rexle.new(read_file(filepath))
+      heading = doc.root.element('heading')
+      
+      menu = Rexle.new(HtmlCom::Menu.new(:breadcrumb, links).to_html)
+      
+      heading.insert_before menu.root
+      write_file filepath, doc.root.xml
+          
+    end    
 
     def page(title)
 
@@ -48,8 +92,8 @@ module Wikisys
       make_page(title, raw_content.lines.last.chomp[/(?<=\+ )/]) unless r
                    
       write_md title, raw_content
-      
-      @to_xml = build_xml raw_content      
+      title, content, tags = read_md()
+      @to_xml = build_xml title, content, tags
       write_xml title, @to_xml
 
       
@@ -58,13 +102,86 @@ module Wikisys
       
     end    
     
+    def modify_build(filename)
+      
+      @title, @content, @tags = read_md(filename)
+      
+      # find the entry
+      # modify the tags if necessary
+      
+      r = @entries.find_by_title @title
+      puts 'r: ' + r.inspect if @debug
+      return unless r
+      
+      write_xml(@title, build_xml(@title, @content, @tags))
+      
+      r.tags = @tags.join(' ') if r.tags != @tags
+      
+    end        
+    
+    def new_build(filename)
+      
+      @title, @content, @tags = read_md(filename)      
+      @entries.create title: @title, tags: @tags.join(' ')
+
+      puts 'md contents: ' + [@title, @content, @tags].inspect if @debug
+      write_xml(@title, build_xml(@title, @content, @tags))      
+      
+    end
+    
+    def read_file(file='index.html')
+      @hc.read(file) { File.read(file) }
+    end
+    
+    def to_css()
+      fetch_file 'pg.css'
+    end
+    
+    def write_html(filename)
+
+      FileUtils.mkdir_p File.join(@filepath, 'html')
+      
+      xml = read_file File.join(@filepath, 'xml', filename)
+      puts 'about to fetch_file' if @debug
+      xsl = fetch_file 'pg.xsl'
+      puts 'xsl: ' + xsl.inspect if @debug
+      
+      html_file = File.join(@filepath, 'html', filename.sub(/\.xml$/,'.html'))
+      write_file(html_file, transform(xsl, xml))
+
+    end
+    
     private
     
-    def build_xml(content)
+    def read_md(filename)
+      
+      filepath = File.join(@filepath, 'md', filename)
+      return unless File.exists? filepath
+      
+      s = read_file(filepath).strip
+      
+      # read the title
+      title = s.lines.first.chomp.sub(/^# +/,'')
       
+      # read the hashtags if there is any
+      tagsline = s.lines.last[/^ *\+ +(.*)/,1]
+      
+      if tagsline then
+        
+        [title, s.lines[1..-2].join, tagsline.split]
+      
+      else
+        
+        [title, s.lines[1..--1].join, []]
+        
+      end
+      
+    end   
+    
+    def build_xml(title, content, tags)
+      
+      puts 'content: ' + content.inspect if @debug
       s = content.gsub(/\[\[[^\]]+\]\]/) do |raw_link|
-
-        title = raw_link[2..-3].strip
         
         r = @entries.find_by_title title            
         
@@ -88,12 +205,11 @@ module Wikisys
       end         
       
       
-      heading = "<heading>%s</heading>" % s.lines.first.chomp
-      tags = ''
+      heading = "<heading>%s</heading>" % title
       
-      if s.lines.last[0] = '+' then
+      if tags.any? then
       
-        list = s.lines.last[2..-1].split.map {|tag| "    <tag>%s</tag>" % tag}
+        list = tags.map {|tag| "    <tag>%s</tag>" % tag}
         tags = "<tags>\n%s\n  </tags>" % list.join("\n")
         
         body = "<body>\n    %s  </body>" % \
@@ -105,11 +221,39 @@ module Wikisys
 
       end
             
-      "<article>\n  %s\n  %s\n  %s\n</article>" % [heading, body, tags]
+      "<article id='%s'>\n  %s\n  %s\n  %s\n</article>" % \
+          [title.downcase.gsub(/ +/,'-'), heading, body, tags]
       
       
     end
     
+    
+    def transform(xsl, xml)
+
+      doc   = Nokogiri::XML(xml)
+      xslt  = Nokogiri::XSLT(xsl)
+
+      xslt.transform(doc)      
+      
+    end    
+    
+    def write_xml(title, content)
+      
+      filepath = File.join(File.absolute_path(@filepath), 'xml', 
+                           title.downcase.gsub(/ +/,'_') + '.xml')
+      FileUtils.mkdir_p File.dirname(filepath)      
+      #File.write filepath, content
+      write_file filepath, content
+      
+    end          
+    
+    def write_file(filepath, content)
+      
+      puts 'writing file: ' + filepath.inspect if @debug
+      File.write filepath, content
+      @hc.write(filepath) { content }      
+    end
+    
     def make_page(title, raw_tags=title.downcase.gsub(/['\.\(\)]/,''))
       
       tags = raw_tags.split.join(' ')
@@ -121,13 +265,12 @@ module Wikisys
       
       return s
       
-    end
+    end          
     
-    def read_md(title)
-            
-      filepath = File.join(File.absolute_path(@filepath), 'md', 
-                           title.gsub(/ +/,'_') + '.md')      
-      File.read(title.gsub(/ +/,'_') + '.md')
+    def read_md_file(filename)
+      
+      filepath = File.join(@filepath, 'md', filename)
+      File.read(filepath)
       
     end
     
@@ -138,17 +281,159 @@ module Wikisys
       FileUtils.mkdir_p File.dirname(filepath)      
       File.write filepath, content
       
+    end      
+    
+  end
+  
+  class Pages
+    
+    attr_accessor :mw, :entries
+
+    def initialize(filepath='.', debug: false)
+      
+      @filepath, @debug = filepath, debug
+      
+      entries_file = File.join(@filepath, 'entries.txt')
+      
+      if File.exists?(entries_file) then
+        @entries = DxLite.new(entries_file)
+      else
+        @entries = DxLite.new('entries/entry(title, tags)')
+        @entries.save entries_file
+      end
+
+      # check for the mindwords raw document file
+      mindwords_file = File.join(@filepath, 'mindwords.txt')
+      
+      if File.exists?(mindwords_file) then 
+        @mw = MindWords.new(mindwords_file)
+      else
+        @mw = MindWords.new
+        @mw.filepath = mindwords_file
+      end
+      
+      scan_md_files()
+      
     end
     
-    def write_xml(title, content)
+    private        
+
+    
+    # Check if any of the md files have been modified or newly created
+    #
+    def scan_md_files()
       
-      filepath = File.join(File.absolute_path(@filepath), 'xml', 
-                           title.gsub(/ +/,'_') + '.xml')
-      FileUtils.mkdir_p File.dirname(filepath)      
-      File.write filepath, content
+      filepath = File.join(@filepath, 'md')
+      puts 'about to scan ' + filepath.inspect if @debug
+      dir = DirToXML.new(filepath, index: 'dir.json', debug: @debug)
+      h = dir.activity
+      puts 'h: ' + h.inspect if @debug
       
-    end    
+      return if (h[:new] + h[:modified]).empty?
+      
+      pg = Wiki.new @filepath, entries: @entries, debug: @debug
+                    
+      
+      h[:new].each do |filename|
+
+        pg.new_build(filename)
+        update_mw(pg.title, pg.tags)
+        
+      end
+      
+      h[:modified].each do |filename|
+        
+        pg.modify_build(filename)
+        update_mw(pg.title, pg.tags)
+                
+      end
+
+      @mw.save if @mw.lines.any?      
+      outline_filepath = File.join(@filepath, 'myoutline.txt')
+      
+      File.write outline_filepath, @mw.to_outline
+      
+      (h[:new] + h[:modified]).each do |filename|
+        
+        xml_file = filename.sub(/\.md$/,'.xml')
+        filepath = File.join(@filepath, 'xml', xml_file)
+        s = pg.read_file filepath
+        title = Rexle.new(s).root.text('heading')
+        puts 'about to search title: ' + title.inspect if @debug
+        found = @mw.search(title)
+        
+        if found then
+        
+          links = found.breadcrumb.map do |x| 
+            [x, x.downcase.gsub(/ +/,'-') + '.html']
+          end
+                    
+          pg.create_breadcrumb(filepath, links)
+          
+        end
+        
+        pg.write_html xml_file
+        
+      end
+      
+      @entries.save
+
+      
+    end # /scan_md_files       
     
-  end
+    def update_mw(title, line_tags)
+      
+      # read the file
+
+      tags = line_tags.reject {|x| x =~ /#{title.strip}/i}
+      puts 'tags: '  + tags.inspect if @debug
+      puts 'title: ' + title.inspect if @debug
+      
+      return if tags.empty?
+      
+      line = title + ' ' + tags.map {|x| "#" + x }.join(' ') + "\n"
+      puts 'line: ' + line.inspect if @debug
+      
+      # does the tagsline contain the topic hashtag?
+      
+      #if tagsline =~ /#/ # not yet implemented
+        
+
+                            
+      # check if the title already exists
+      found = @mw.lines.grep(/^#{title} +(?=#)/i)
+      
+      if found.any? then
+        
+        found_tags = found.first.scan(/(?<=#)\w+/)
+        
+        if @debug then
+          
+          puts 'tags: ' + tags.inspect
+          puts 'found_tags: ' + found_tags.inspect
+        
+        end
+
+        new_tags = tags - found_tags   
+        
+        # add the new tags to the mindwords line
+        
+        hashtags = (found_tags + new_tags).map {|x| '#' + x }.join(' ')
+
+        i = @mw.lines.index(found.first)
+        @mw.lines[i] = line
+        
+      else
+        
+        @mw.lines <<  line
+        
+      end                            
+      
+    end
+    
+    def view_file(file='index.html')
+      @hc.read(file) { File.read(file) }
+    end
 
+  end
 end

data/stylesheet/pg.css

@@ -0,0 +1,75 @@
+
+
+/* begin breadcrumb.css */
+
+body {font-family: Arial;}
+
+/* Style the list */
+ul.breadcrumb {
+  padding: 10px 16px;
+  list-style: none;
+  background-color: #eee;
+}
+
+/* Display list items side by side */
+ul.breadcrumb li {
+  display: inline;
+  font-size: 18px;
+}
+
+/* Add a slash symbol (/) before/behind each list item */
+ul.breadcrumb li+li:before {
+  padding: 8px;
+  color: black;
+  content: "/\00a0";
+}
+
+/* Add a color to all links inside the list */
+ul.breadcrumb li a {
+  color: #0275d8;
+  text-decoration: none;
+}
+
+/* Add a color on mouse-over */
+ul.breadcrumb li a:hover {
+  color: #01447e;
+  text-decoration: underline;
+}
+
+/* end breadcrumb */
+
+article {
+  background-color: rgba(255,255,255,0.5);
+  padding: 1.1em;
+  margin: 0.4em;
+}
+
+header div {text-align: right}
+#tags {
+  background-color: transparent;
+  padding: 2.5em 1.0em;
+  margin: 1.0em 0em;
+  list-style-type: none
+}
+#tags li {
+  background-color: transparent;
+  display: inline;
+  padding: 0.1em;
+  margin: 1.3em 0.1em;
+  color: #fff;
+}
+
+#tags li a {
+  background-color: #eee;
+  color: #a95; 
+  text-decoration: none;
+  font-family: "Courier";
+  font-weight: 600;
+  font-size: 0.9em;
+  padding: 0.4em 0.6em;
+  margin: 0.3em;
+
+}
+
+#tags li:hover {background-color: transparent; }
+#tags li a:hover { background-color: #ededed;  color: #66e; }

data/stylesheet/pg.xsl

@@ -0,0 +1,52 @@
+<xsl:stylesheet xmlns:xsl='http://www.w3.org/1999/XSL/Transform' version='1.0'>
+
+  <xsl:template match='article'>
+      
+    <html>
+      <head>
+        <link rel="stylesheet" type="text/css" href=pg.css"/>
+      </head>
+      <body>
+        <xsl:variable name='id' select='@id'/>
+        <header><div><a href='../edit?id={$id}'>edit</a></div></header>
+        <div>
+        <xsl:copy-of select='ul[@class="breadcrumb"]' />
+        </div>
+        <article>
+          <xsl:apply-templates select='heading' />
+          <xsl:copy-of select='body/*' />
+        </article>
+          <xsl:apply-templates select='tags' />
+      </body>
+    </html>
+
+  </xsl:template>
+
+  <xsl:template match='heading'>
+
+    <h1><xsl:value-of select='.' /></h1>
+
+  </xsl:template>
+
+  <xsl:template match='tags'>
+
+    <ul id='tags'>
+      <xsl:apply-templates select='tag' />
+    </ul>
+
+  </xsl:template>
+
+  <xsl:template match='tag'>
+
+    <li>
+      <xsl:element name='a'>
+        <xsl:attribute name='href'>
+          ../hashtags.html#<xsl:value-of select='.' />
+        </xsl:attribute>
+        <xsl:value-of select='.' />
+      </xsl:element>
+    </li>
+
+  </xsl:template>
+
+</xsl:stylesheet>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wikisys
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.2
 platform: ruby
 authors:
 - James Robertson
@@ -35,28 +35,48 @@ cert_chain:
   O3SRDzvvWXrwDFGyRDmGqdEw51FKHPw/6pk4ci0QPIvQEgOyPKfdSesPWmNmtxpf
   KX/89ohIpftt89vtcCI21R5u
   -----END CERTIFICATE-----
-date: 2020-06-22 00:00:00.000000000 Z
+date: 2021-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: dxlite
+  name: dir-to-xml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 1.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+- !ruby/object:Gem::Dependency
+  name: mindwords
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.5.4
 - !ruby/object:Gem::Dependency
   name: martile
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +86,7 @@ dependencies:
         version: '1.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.3
+        version: 1.4.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -76,7 +96,27 @@ dependencies:
         version: '1.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.3
+        version: 1.4.6
+- !ruby/object:Gem::Dependency
+  name: hashcache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.10
 description: 
 email: james@jamesrobertson.eu
 executables: []
@@ -84,6 +124,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/wikisys.rb
+- stylesheet/pg.css
+- stylesheet/pg.xsl
 homepage: https://github.com/jrobertson/wikisys
 licenses:
 - MIT
@@ -103,7 +145,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.10
 signing_key: 
 specification_version: 4
 summary: A poor man's wiki.