wikitxt 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae4a4f273cffbd397b527c2059dff661b6086dbf98d12f5edbab7da4e95ef9d2
-  data.tar.gz: c7c4349c4984f0d106a539222fb3582de9ac4a7fae1cebefd48a2c2117888404
+  metadata.gz: d8fad6d59c01705bbe4b224a2e2b0c8aeec33f5dc565764fe9a30b0eee2f3429
+  data.tar.gz: 68e2f0f840d5d6b89d6ae308fb00205b8abaa3e95c6eb01e3905f4d02b6185d8
 SHA512:
-  metadata.gz: 94758439145d08a34e9342fd201b6acd0676b1efc9df8b3c72342dfd9f61b06d6afb492b720945874b8976f8b2234216c3c5f37b4a57c1a659855758207eff06
-  data.tar.gz: 6c1e4560a9b07566d68886aeca57aeb850ea6db5dfee8f22bc088b55d50d6831a92c55bdb2fd346a3be9595b54733a55f7b056fc3372259efe66787efee6acdd
+  metadata.gz: 63363c50d0698f4445f56f25b8f022a900a23f42ad1d237ec01d2f6057c68cca4f7e77a5d043a319f722886d1a5e5105bf6c48a62084d409824e9d37a9d51f7f
+  data.tar.gz: ad0569bc3741639ed7ce2eb4173b485c34e2ba790648b3d4b6d7f9afece0693041f4d248be12da97343145626125c4448a967959b472278bc156fcffeef23320

data/Gemfile.lock

@@ -1,13 +1,15 @@
 PATH
   remote: .
   specs:
-    wikitxt (0.1.3)
+    wikitxt (0.1.6)
+      rackup (~> 2.1)
+      sinatra (~> 4.0)
       thor (~> 1.3)
-      webrick (~> 1.8)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    base64 (0.2.0)
     coderay (1.1.3)
     diff-lcs (1.5.1)
     ffi (1.16.3)
@@ -30,6 +32,8 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.10)
     method_source (1.0.0)
+    mustermann (3.0.0)
+      ruby2_keywords (~> 0.0.1)
     nenv (0.3.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
@@ -37,6 +41,15 @@ GEM
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    rack (3.0.10)
+    rack-protection (4.0.0)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0, < 4)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
     rake (13.2.1)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
@@ -54,10 +67,18 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
+    ruby2_keywords (0.0.5)
     shellany (0.0.1)
+    sinatra (4.0.0)
+      mustermann (~> 3.0)
+      rack (>= 3.0.0, < 4)
+      rack-protection (= 4.0.0)
+      rack-session (>= 2.0.0, < 3)
+      tilt (~> 2.0)
     spoon (0.0.6)
       ffi
     thor (1.3.1)
+    tilt (2.3.0)
     webrick (1.8.1)
 
 PLATFORMS

data/README.md

@@ -8,6 +8,23 @@ Most lightweight markup language and personal knowledge manager or wiki platform
 
 ![screenshot](https://github.com/kawakamimoeki/wikitxt/blob/main/docs/screenshot.png)
 
+Wikitxt is a lightweight markup language and a tool for composing Wiki . The syntax of #Wikitxt can be converted to HTML and viewed in a browser. When converted to HTML, files can be interlinked.
+
+Wikitxt is based on the format of lists and paragraphs. Most information can be expressed in list format, and the choice between lists and paragraphs is always changing as you write.
+
+Text decoration is limited to mutual links using hashtags. By utilizing the decoration of mutual links, you can intentionally increase the number of pages in the wiki.
+
+In summary, it's like this:
+
+- Lists
+  - Based on the idea that most information can be expressed in lists
+- Paragraphs
+  - Paragraphs always have the potential to be listed. They can easily be converted to lists.
+  - Paragraphs can also serve as headings.
+- Mutual Links
+  - Text decoration is limited to links.
+  - Words you want to emphasize should be expressed as wiki pages.
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -73,12 +90,6 @@ Wikitxt.to_html(text)
 
 ### Server
 
-`wiki/index.txt`:
-
-```
-Link to #sample .
-```
-
 `wiki/sample.txt`:
 
 ```
@@ -101,10 +112,16 @@ Cras at tortor urna. Maecenas nec iaculis nulla.
 ```
 
 ```
-$ wikitxt s
+$ wikitxt s wiki
 ```
 
-Access to http://localhost:8000 .
+Access to http://localhost:4567 .
+
+### Build
+
+```
+$ wikitxt build wiki
+```
 
 ## Development
 

data/lib/wikitxt/cli.rb

@@ -1,5 +1,4 @@
 require "thor"
-require 'webrick'
 require 'erb'
 require 'fileutils'
 
@@ -7,9 +6,15 @@ module Wikitxt
   class CLI < Thor
     package_name "wikitxt"
     map "s" => :server
+    map "b" => :build
 
-    desc "server [PATH]", "start wiki site"
+    desc "server PATH", "start wiki site"
     def server(path)
+      system("DIR=\"#{path}\" ruby #{File.join(__dir__, "server.rb")}")
+    end
+
+    desc "build PATH", "build wiki site"
+    def build(path)
       files = Dir.glob(File.join(path, "*.txt"))
       pages = []
       files.each do |file|
@@ -17,18 +22,15 @@ module Wikitxt
         body = Wikitxt.to_html(text)
         title = File.basename(file, ".txt")
         pages << title
-        html = ERB.new(File.read(File.join(__dir__, "../", "html", "layout.html.erb"))).result_with_hash({ body: body, title: title })
+        html = ERB.new(File.read(File.join(__dir__, "views", "layout.erb"))).result_with_hash({ body: body, title: title })
         Dir.mkdir("dist") unless Dir.exist?("dist")
         File.write(File.join("dist", "#{title}.html"), html)
       end
-      index = ERB.new(File.read(File.join(__dir__, "../", "html", "index.html.erb"))).result_with_hash({ pages: pages })
-      html = ERB.new(File.read(File.join(__dir__, "../", "html", "layout.html.erb"))).result_with_hash({ body: index, title: "Index" })
+      index = ERB.new(File.read(File.join(__dir__, "views", "index.erb"))).result_with_hash({ pages: pages })
+      html = ERB.new(File.read(File.join(__dir__, "views", "layout.erb"))).result_with_hash({ body: index, title: "Index" })
       File.write(File.join("dist", "index.html"), html)
       images = Dir.glob(File.join(path, "*.{png,jpg,jpeg}"))
       FileUtils.cp(images, "dist")
-      server = WEBrick::HTTPServer.new :Port => 8000, :DocumentRoot => "dist"
-      trap 'INT' do server.shutdown end
-      server.start
     end
   end
 end

data/lib/wikitxt/node.rb

@@ -39,13 +39,13 @@ module Wikitxt
 
   class TextNode < BaseNode
     def to_html
-      "<span>#{attrs[:text]}</span>"
+      "<span>#{CGI.escapeHTML(attrs[:text])}</span>"
     end
   end
 
   class LinkNode < BaseNode
     def to_html
-      " <a href=\"#{attrs[:url]}\">#{attrs[:title]}</a> "
+      " <a href=\"#{attrs[:url]}\">#{CGI.escapeHTML(attrs[:title])}</a> "
     end
   end
 

data/lib/wikitxt/server.rb

@@ -0,0 +1,30 @@
+require 'sinatra'
+require 'wikitxt'
+
+get "/" do
+  pages = Dir.glob(File.join(ENV["DIR"], "*.txt")).map { File.basename(_1, ".txt") }
+  title = "Index"
+  body = ERB.new(File.read(File.join(__dir__, "views", "index.erb"))).result_with_hash({ pages: pages })
+  ERB.new(File.read(File.join(__dir__, "views", "layout.erb"))).result_with_hash({ body: body, title: title })
+end
+
+get "/:page" do
+  page = params[:page]
+
+  if page.match?(/\.(png|jpeg|jpg)/)
+    pass unless File.exist?(File.join(ENV["DIR"], page))
+    send_file File.join(ENV["DIR"], page)
+  end
+
+  page = File.basename(page, ".html")
+  file = File.join(ENV["DIR"], "#{page}.txt")
+  pass unless File.exist?(file)
+  text = File.read(file)
+  title = File.basename(file, ".txt")
+  body = Wikitxt.to_html(text)
+  ERB.new(File.read(File.join(__dir__, "views", "layout.erb"))).result_with_hash({ body: body, title: title })
+end
+
+not_found do
+  ERB.new(File.read(File.join(__dir__, "views", "layout.erb"))).result_with_hash({ body: "Not found", title: "Not found" })
+end

data/lib/wikitxt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Wikitxt
-  VERSION = "0.1.4"
+  VERSION = "0.1.6"
 end

data/lib/wikitxt/views/index.erb

@@ -0,0 +1,3 @@
+<% pages.each do |page| %>
+<div class="line"><a href="/<%= page %>.html"><%= page.capitalize %></a></div>
+<% end %>

data/lib/{html/layout.html.erb → wikitxt/views/layout.erb}

@@ -1,11 +1,13 @@
 <head>
   <meta charset="UTF-8" />
+  <title><%= title.capitalize %></title>
 </head>
 
 <style>
   body {
     background: #ddd;
     padding: 1rem;
+    word-break: break-all;
   }
 
   .content {
@@ -36,6 +38,19 @@
     border-radius: 100%;
   }
 
+  pre, code {
+    background: #eee;
+  }
+
+  pre .dot, code .dot {
+    background: none;
+  }
+
+  blockquote {
+    background: #eee;
+    font-style: italic;
+  }
+
   img {
     max-width: 100%;
   }

data/samples/Wikitxt.txt

@@ -18,3 +18,36 @@ In summary, it's like this:
 Absolute url is parsed as external link: #<https://example.com Example Domain>
 
 #woman.jpg
+
+  やってること
+    パラグラフ
+    リスト
+    リンク
+    画像
+  やってないこと
+    #装飾文字
+      これはいらない気もする
+    #コードブロック
+    #引用
+    #自動リンク
+      コードスパンがないのでURLを生で書きたい時に困る
+  コードブロックというかpreはは必要なのか
+    というか #コードブロック の記法を作るくらいならpreタグを使うのとさほど変わらないのでは
+
+<code>
+  class Hoge
+    def initialize(fuga)
+      @fuga = fuga
+   end
+  end
+</code>
+
+↑preタグの中にもリストができてしまったので修正必要そう。
+
+インラインは良さそう: <pre>これはpreタグの中身です</pre>
+
+と思ったがpreタグは改行されるのか
+
+<blockquote>
+ホゲホゲ
+</blockquote>

data/wikitxt.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "thor", "~> 1.3"
-  spec.add_dependency "webrick", "~> 1.8"
+  spec.add_dependency "sinatra", "~> 4.0"
+  spec.add_dependency "rackup", "~> 2.1"
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wikitxt
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Moeki Kawakami
@@ -25,19 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: webrick
+  name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rackup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 description: Most lightweight markup language and personal knowledge manager or wiki
   platform.
 email:
@@ -52,20 +66,20 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
-- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - docs/screenshot.png
 - exe/wikitxt
-- lib/html/index.html.erb
-- lib/html/layout.html.erb
 - lib/wikitxt.rb
 - lib/wikitxt/cli.rb
 - lib/wikitxt/node.rb
 - lib/wikitxt/parser.rb
 - lib/wikitxt/renderer.rb
+- lib/wikitxt/server.rb
 - lib/wikitxt/version.rb
+- lib/wikitxt/views/index.erb
+- lib/wikitxt/views/layout.erb
 - samples/Wikitxt.txt
 - samples/woman.jpg
 - wikitxt.gemspec

data/Guardfile

@@ -1,4 +0,0 @@
-guard :process, name: 's', command: "exe/wikitxt s samples" do
-  watch(%r{lib/.+$})
-  watch(%r{samples/.+$})
-end

data/lib/html/index.html.erb

@@ -1,3 +0,0 @@
-<% pages.each do |page| %>
-<div class="line"><a href="/<%= page %>.html"><%= page %></a></div>
-<% end %>