wikisys 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58d2c1e764d883278d6cc59cc30701bec9e60e54f40f5d74a2c2ca9de24aaaa3
-  data.tar.gz: 3ce2675464a445aaaa1ae9e5061b34fab9d36556c8d7a37ae06d8cd5a03c9d4d
+  metadata.gz: 968d63c44160b867a30d0102d61998755fe7e6ac1f1d77b517aa5c057dc6fd61
+  data.tar.gz: 2ede5cdd04ca85944cdcd228081283e91c546ac450246fce7f11923fe55eeba2
 SHA512:
-  metadata.gz: e67d2e605bfb300d986730021834943b5467b3de637cbcc0257602bb9c1939227add73b3d57de71d13cb6b1e2153bc59e2046c6623fc4f3b421583b71e0292ed
-  data.tar.gz: c0d03e1ae012d972ae452a0b8252b444df51c7f3d1d7c55375db126673c4821a96f244090ec4e2c0990c64f063fd9a68546b4c5dedacaba8c7f490ca08c45680
+  metadata.gz: 234190cfca855775c8e1218ae5f64d94e6b673dabdf6a98609f8db35cfa5207483c82ead6688509fb76effc8969ee073b93dc0f55373b3abca47da411b7461e1
+  data.tar.gz: 3bd627fab82a7cc57b90d4085dc77aa357fe782c68c6d1b060d7e9830be2491825d754f853b27360ab9befd06e3363fedbefa8320d4459ceedfd4513e3ade997

data/lib/wikisys.rb

@@ -0,0 +1,436 @@
+#!/usr/bin/env ruby
+
+# file: wikisys.rb
+
+require 'dxlite'
+require 'dir-to-xml'
+require 'mindwords'
+require 'martile'
+
+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    
+    include FileFetch
+    using ColouredText
+    
+    attr_accessor :title, :content, :tags
+    attr_reader :to_xml
+
+    def initialize(filepath='.', entries: 'entries.json', debug: false)
+
+      @filepath = filepath
+      @page = ''
+      @debug = debug
+      
+      @hc = HashCache.new(size:30)
+
+      @entries = if entries.is_a? DxLite then
+      
+        entries
+        
+      elsif File.exists?(entries) then
+      
+        DxLite.new(entries)
+
+      else
+
+        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)
+
+      r = @entries.find_by_title title   
+      @page = r ? read_md(title) : make_page(title)
+      @to_xml = build_xml @page
+      @entries.save
+      
+      return @page
+
+    end
+    
+    def page=(raw_content)
+      
+      title = raw_content.lines.first.chomp
+      
+      r = @entries.find_by_title title
+      make_page(title, raw_content.lines.last.chomp[/(?<=\+ )/]) unless r
+                   
+      write_md title, raw_content
+      title, content, tags = read_md()
+      @to_xml = build_xml title, content, tags
+      write_xml title, @to_xml
+
+      
+      @entries.save
+      @page = raw_content
+      
+    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 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|
+        
+        r = @entries.find_by_title title            
+        
+        e = Rexle::Element.new('a').add_text title
+        e.attributes[:href] = title.gsub(/ +/, '_')
+        
+        if r then
+          
+          e.attributes[:title] = title.capitalize
+          
+        else
+          
+          make_page(title.capitalize)
+          e.attributes[:class] = 'new'
+          e.attributes[:title] = title.capitalize + ' (page does not exist)'
+          
+        end
+                
+        e.xml
+
+      end         
+      
+      
+      heading = "<heading>%s</heading>" % title
+      
+      if tags.any? then
+      
+        list = tags.map {|tag| "    <tag>%s</tag>" % tag}
+        tags = "<tags>\n%s\n  </tags>" % list.join("\n")
+        
+        body = "<body>\n    %s  </body>" % \
+            Martile.new(s.lines[1..-2].join.strip).to_html
+        
+      else
+        
+        body = "<body>%s</body>" % Martile.new(s.lines[1..-1].join.strip).to_html
+
+      end
+            
+      "<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(' ')
+      s = "#{title}\n\n\n+ " + tags
+      write_md title, s
+      write_xml title, build_xml(s)
+      
+      @entries.create title: title, tags: tags      
+      
+      return s
+      
+    end          
+    
+    def read_md_file(filename)
+      
+      filepath = File.join(@filepath, 'md', filename)
+      File.read(filepath)
+      
+    end
+    
+    def write_md(title, content)
+      
+      filepath = File.join(File.absolute_path(@filepath), 'md', 
+                           title.gsub(/ +/,'_') + '.md')
+      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
+    
+    private        
+
+    
+    # Check if any of the md files have been modified or newly created
+    #
+    def scan_md_files()
+      
+      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
+      
+      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       
+    
+    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.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>

data.tar.gz.sig

@@ -1 +1 @@
-F�y��@�HK�b�T�}���u�Р)dekZV��2@{����,։�$�E2�#G�ua^��K��Nj�A,�b?k�F��<���w@D��o��<�y�g�ݿS23��e�U7#O�Io)�w"���E�|�#���4�?*�N��Y<g|�iH�5�	�AE�����$^N'�5vq�=
+WM.������%�%H���:�f�LxF �CA��F��;g��V��F�h����(h���1�$��)�b�2�`�G+����=�%|�
L!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wikisys
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - James Robertson
@@ -123,7 +123,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/wikisys.rb
 - stylesheet/pg.css
+- stylesheet/pg.xsl
 homepage: https://github.com/jrobertson/wikisys
 licenses:
 - MIT