code: replace `is cached` by `is lazy`
[nit.git] / contrib / nitiwiki / src / wiki_base.nit
index d5db709..1527d4c 100644 (file)
@@ -54,6 +54,7 @@ class Nitiwiki
                sys.system "rsync -vr --delete {root}/ {config.rsync_dir}"
        end
 
+       # Pull data from git repository.
        fun fetch do
                sys.system "git pull {config.git_origin} {config.git_branch}"
        end
@@ -112,7 +113,7 @@ class Nitiwiki
        # List markdown source files from a directory.
        fun list_md_files(dir: String): Array[String] do
                var files = new Array[String]
-               var pipe = new IProcess("find", dir, "-name", "*.md")
+               var pipe = new ProcessReader("find", dir, "-name", "*.md")
                while not pipe.eof do
                        var file = pipe.read_line
                        if file == "" then break # last line
@@ -211,6 +212,9 @@ class Nitiwiki
                return path.simplify_path
        end
 
+       # Transform an id style name into a pretty printed name.
+       #
+       # Used to translate ids in beautiful page names.
        fun pretty_name(name: String): String do
                name = name.replace("_", " ")
                name = name.capitalized
@@ -304,7 +308,7 @@ abstract class WikiEntry
        # Result is returned as an array containg ordered entries:
        # `breadcrumbs.first` is the root entry and
        # `breadcrumbs.last == self`
-       fun breadcrumbs: Array[WikiEntry] is cached do
+       var breadcrumbs: Array[WikiEntry] is lazy do
                var path = new Array[WikiEntry]
                var entry: nullable WikiEntry = self
                while entry != null and not entry.is_root do
@@ -508,7 +512,7 @@ class WikiArticle
        # Page content.
        #
        # What you want to be displayed in the page.
-       var content: nullable Streamable = null
+       var content: nullable Writable = null
 
        # Headlines ids and titles.
        var headlines = new ArrayMap[String, HeadLine]
@@ -534,9 +538,9 @@ class WikiArticle
        # Extract the markdown text from `source_file`.
        #
        # REQUIRE: `has_source`.
-       fun md: String is cached do
+       var md: String is lazy do
                assert has_source
-               var file = new IFStream.open(src_full_path.to_s)
+               var file = new FileReader.open(src_full_path.to_s)
                var md = file.read_all
                file.close
                return md
@@ -573,7 +577,7 @@ class WikiConfig
        #
        # * key: `wiki.name`
        # * default: `MyWiki`
-       fun wiki_name: String is cached do return value_or_default("wiki.name", "MyWiki")
+       var wiki_name: String is lazy do return value_or_default("wiki.name", "MyWiki")
 
        # Site description.
        #
@@ -581,7 +585,7 @@ class WikiConfig
        #
        # * key: `wiki.desc`
        # * default: ``
-       fun wiki_desc: String is cached do return value_or_default("wiki.desc", "")
+       var wiki_desc: String is lazy do return value_or_default("wiki.desc", "")
 
        # Site logo url.
        #
@@ -589,13 +593,13 @@ class WikiConfig
        #
        # * key: `wiki.logo`
        # * default: ``
-       fun wiki_logo: String is cached do return value_or_default("wiki.logo", "")
+       var wiki_logo: String is lazy do return value_or_default("wiki.logo", "")
 
        # Root url of the wiki.
        #
        # * key: `wiki.root_url`
        # * default: `http://localhost/`
-       fun root_url: String is cached do return value_or_default("wiki.root_url", "http://localhost/")
+       var root_url: String is lazy do return value_or_default("wiki.root_url", "http://localhost/")
 
 
        # Root directory of the wiki.
@@ -604,7 +608,7 @@ class WikiConfig
        #
        # * key: `wiki.root_dir`
        # * default: `./`
-       fun root_dir: String is cached do return value_or_default("wiki.root_dir", "./").simplify_path
+       var root_dir: String is lazy do return value_or_default("wiki.root_dir", "./").simplify_path
 
        # Pages directory.
        #
@@ -612,7 +616,7 @@ class WikiConfig
        #
        # * key: `wiki.source_dir
        # * default: `pages/`
-       fun source_dir: String is cached do
+       var source_dir: String is lazy do
                return value_or_default("wiki.source_dir", "pages/").simplify_path
        end
 
@@ -623,7 +627,7 @@ class WikiConfig
        #
        # * key: `wiki.out_dir`
        # * default: `out/`
-       fun out_dir: String is cached do return value_or_default("wiki.out_dir", "out/").simplify_path
+       var out_dir: String is lazy do return value_or_default("wiki.out_dir", "out/").simplify_path
 
        # Asset files directory.
        #
@@ -632,7 +636,7 @@ class WikiConfig
        #
        # * key: `wiki.assets_dir`
        # * default: `assets/`
-       fun assets_dir: String is cached do
+       var assets_dir: String is lazy do
                return value_or_default("wiki.assets_dir", "assets/").simplify_path
        end
 
@@ -643,7 +647,7 @@ class WikiConfig
        #
        # * key: `wiki.templates_dir`
        # * default: `templates/`
-       fun templates_dir: String is cached do
+       var templates_dir: String is lazy do
                return value_or_default("wiki.templates_dir", "templates/").simplify_path
        end
 
@@ -653,7 +657,7 @@ class WikiConfig
        #
        # * key: `wiki.template`
        # * default: `template.html`
-       fun template_file: String is cached do
+       var template_file: String is lazy do
                return value_or_default("wiki.template", "template.html")
        end
 
@@ -664,7 +668,7 @@ class WikiConfig
        #
        # * key: `wiki.header`
        # * default: `header.html`
-       fun header_file: String is cached do
+       var header_file: String is lazy do
                return value_or_default("wiki.header", "header.html")
        end
 
@@ -674,7 +678,7 @@ class WikiConfig
        #
        # * key: `wiki.menu`
        # * default: `menu.html`
-       fun menu_file: String is cached do
+       var menu_file: String is lazy do
                return value_or_default("wiki.menu", "menu.html")
        end
 
@@ -685,7 +689,7 @@ class WikiConfig
        #
        # * key: `wiki.footer`
        # * default: `footer.html`
-       fun footer_file: String is cached do
+       var footer_file: String is lazy do
                return value_or_default("wiki.footer", "footer.html")
        end
 
@@ -695,19 +699,19 @@ class WikiConfig
        #
        # * key: `wiki.rsync_dir`
        # * default: ``
-       fun rsync_dir: String is cached do return value_or_default("wiki.rsync_dir", "")
+       var rsync_dir: String is lazy do return value_or_default("wiki.rsync_dir", "")
 
        # Remote repository used to pull modifications on sources.
        #
        # * key: `wiki.git_origin`
        # * default: `origin`
-       fun git_origin: String is cached do return value_or_default("wiki.git_origin", "origin")
+       var git_origin: String is lazy do return value_or_default("wiki.git_origin", "origin")
 
        # Remote branch used to pull modifications on sources.
        #
        # * key: `wiki.git_branch`
        # * default: `master`
-       fun git_branch: String is cached do return value_or_default("wiki.git_branch", "master")
+       var git_branch: String is lazy do return value_or_default("wiki.git_branch", "master")
 end
 
 # WikiSection custom configuration.