sancho 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f82ecb02dbfd8049052cfd187eabe8be36d054494d4cfb5f5c0a057a44f0f85
-  data.tar.gz: a2952518cff02c6e2fb5ef44ac86a321a579cc682b0dce3f0743f7758ac94a48
+  metadata.gz: 66a1c14bbe20f6b69502ecb9bcbe5a611851ed7fe940f0ac6642c3ccb84631c5
+  data.tar.gz: f18a7dbc4fd6ccc7ff738fc6abb26b48736c6b62cf9395f33b1913d2c01181bb
 SHA512:
-  metadata.gz: eeb013e3f4b519c11eea6df4a596eb6f6e355e5bce51895a6b6e64c579f5f3caabee3cb3b50ced9634e31bbbd6101f080712c0cb854843e2c5417d404947250d
-  data.tar.gz: 16845d4840dd0abceab7fe1a27a123a051c3326afd3b56dd5632aaa6c08ec2ee9e6a9d0d2874d84fcbdf3609ff259df928df7344ff5f6e66934be3b9b1df940f
+  metadata.gz: 0bb1ae1f3e7f1da7dba28d20cd0302411944b119823cfd2fd02b8c7a125053dd7eae8a18a6a1ef856a3d01a5d09c9430f7f45245c8f54b939086e5e5acf6e76d
+  data.tar.gz: 03c0998e45418b6751547fa964b9e8c3effb7adb0f3e78a6237e18da4e9eef095cc012431bdb3de2ee91734fd0a408b1e890d567871c49fb39acbbe2751e95dc

data/.dockerignore

@@ -0,0 +1,12 @@
+# Ignore all
+*
+
+# Allow sources
+!/bin/
+!/app/
+!/lib/
+!Gemfile
+!Gemfile.lock
+
+# Ignore backups
+**/*~

data/.rubocop.yml

@@ -0,0 +1,73 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+AllCops:
+  TargetRubyVersion: 3.4.X
+  DisableByDefault: true
+  Exclude:
+    - 'test/**/*'
+
+Style:
+  Enabled: true
+
+# the codebase desing provides bunch of mappers and interactors
+#   that are actually "method"-like thing that have only one method
+#   and it "call"
+# TODO: inspect on Proc#[] and [] for only-one-method classes
+Style/LambdaCall:
+  Enabled: false
+
+# was spoted in Data constructors, where the constructor
+#   use the same arguments order as is was defined
+Style/KeywordParametersOrder:
+  Enabled: false
+
+# fail used intentionally to show that partilcular exeptions
+#   are not rescued/handled in the context of the fail call
+#   some obsolete consideration could be fund by link
+#   https://stackoverflow.com/questions/31937632/fail-vs-raise-in-ruby-should-we-really-believe-the-style-guide
+Style/SignalException:
+  Enabled: false
+
+# it's mainly ?\n that is one symbol shorter than "\n" with no necessity to wrap in ""
+Style/CharacterLiteral:
+  Enabled: false
+  
+# thats ridiculous cause many standard thing do not follow it
+#   have one simple string now do not mean it will simple string
+#   forever.. maybe for require/require_relative, but not everywhere 
+Style/StringLiterals:
+  Enabled: false
+
+# there are a few modules used like classes; I like it simplicity
+Style/ModuleFunction:
+  Enabled: false
+
+# # interfactor do not inlcude entities, not mixed-it-in but just
+# #   use shorter names withot the necessity Dog::Entitiies::Blob
+# #   just Blob
+# Style/MixinUsage:
+#   Enabled: false
+
+# not always fit my style mapping some string than adding ?\n
+# TODO: maybe change some style
+Style/StringConcatenation:
+  Enabled: false
+
+# some abstract classes require such arguments
+# TODO: explore RuboCop further, maybe mark abstract stuff
+Lint/UnusedMethodArgument:
+  Enbale: false
+
+Metrics:
+  Enabled: false
+  
+Layout:
+  Enabled: false

data/.sancho.yml

@@ -0,0 +1,7 @@
+---
+directory: docs
+domain: domain
+title: Sancho
+pages:
+- README.md
+- CHANGELOG.md

data/CHANGELOG.md

@@ -6,21 +6,25 @@ keywords:
   - ruby
 ...
 
-## [TODO]
+## [Unreleased]
 
-- [ ] having template, is there any sense in header, footer?
-- [ ] page collections with own collection layout and index.html
+__TODO__
 
-## [Unreleased]
+- [ ] add progress copying assets and generated HTML files
+
+## [0.7.0] - 2025-08-24
+
+- designed CLI interface of init, build, serve commands
+- removed Rake interface (that was dependency disaster)
+- Ruby 3.4
 
-## [0.6.2] - 2024-03-09
+## [0.6.0] - 2024-03-07
 
 - designed new model based on Data.define
 - designed tests for tasks.rake
-- designed new `sancho:serve` tasks
+- designed new `sancho:serve` and `sancho:release` tasks
 - improved `sancho:init` output
 - improved `sancho:docs` using Dir.mktempdir
-- removed `docs branch` stuff
 
 ## [0.3.0] - 2023-02-11
 

data/Gemfile

@@ -6,6 +6,6 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 13.1"
+gem "minitest", "~> 5.22"
 gem "rack", "~> 3.0"
 gem "rackup"
-gem "minitest", "~> 5.22"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sancho (0.6.1)
+    sancho (0.7.0)
 
 GEM
   remote: https://rubygems.org/
@@ -16,7 +16,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-23
-  x64-mingw-ucrt
+  arm64-darwin-24
   x64-mingw32
   x86_64-linux
 

data/README.md

@@ -5,43 +5,43 @@ keywords:
   - github-pages-generator
 ...
 
-`Sancho` is static site generator for [Github Pages](https://pages.github.com/). Site content should to be written in Markdown or [Pandoc Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown). And it will be rendered with [Pandoc](https://pandoc.org/)
+## Overview
 
-## Installation
-
-Run
+Sancho plays [Github Pages](https://pages.github.com/) generator designed for simplest site generation from a few markdown files.
 
-    $ bundle add sancho --git https://github.com/nvoynov/sancho.git
+In my scenario, I always have README.md and CHANGELOG.md, sometimes STORY.md for every project and present those on the project page.
 
-Require it in the Rakefile
+It utilizes [Pandoc](https://pandoc.org) for Markdown to HTML translation; source markdonw could be [Pandoc Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown).
 
-```ruby
-require "sancho"
-source, folders = Sancho.tasks
-Rake.application.rake_require source, folders
-```
-
-Install [pandoc](https://pandoc.org/installing.html)
+## Installation
 
-## Usage
+Install the gem
 
-To initialize site content, run the initialization task
+    gem install sancho
 
-    $ rake sancho:init
+Or add it by
 
-Configure the site content by customizing `sancho.yml`
+    bundle add sancho --git https://github.com/nvoynov/sancho.git
 
-Render HTML content from markdown sources
+Install [pandoc](https://pandoc.org/installing.html)
 
-    $ rake sancho:docs
+## Usage
 
-Serve it locally by
+[Basic flow]{.underline}
 
-    $ rake sancho:serve
+    # go to tareget directory
+    cd my_thing
+    # create .sancho.yml configuration file and copy basis site assets
+    sancho init
+    # do some configuration and template changes
+    # then build the site
+    sancho build
+    # test the site
+    sancho serve
 
 [Template]{.underline}
 
-You can provide your own HTML template by placing `_layouts/template.html` file. Read [Pandoc Templates](https://pandoc.org/MANUAL.html#templates) section for details.
+To change template just place your `_layouts/template.html` file. Read [Pandoc Templates](https://pandoc.org/MANUAL.html#templates) section for details.
 
 ## Links
 

data/Rakefile

@@ -1,8 +1,3 @@
-require "rake"
-require_relative "lib/sancho"
-source, folders = Sancho.tasks
-Rake.application.rake_require source, folders
-
 require "bundler/gem_tasks"
 require "rake/testtask"
 

data/docs/changelog.html

@@ -1,96 +1,90 @@
-<!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
-<head>
-  <meta charset="utf-8" />
-  <meta name="generator" content="pandoc" />
-  <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
-  <meta name="keywords" content="static-site-generator, github-pages-generator, ruby" />
-  <title>Sancho Changelog</title>
-  <style>
-    code{white-space: pre-wrap;}
-    span.smallcaps{font-variant: small-caps;}
-    div.columns{display: flex; gap: min(4vw, 1.5em);}
-    div.column{flex: auto; overflow-x: auto;}
-    div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
-    ul.task-list{list-style: none;}
-    ul.task-list li input[type="checkbox"] {
-      width: 0.8em;
-      margin: 0 0.8em 0.2em -1.6em;
-      vertical-align: middle;
-    }
-    .display.math{display: block; text-align: center; margin: 0.5rem auto;}
-  </style>
-  <link rel="stylesheet" href="css/styles.css" />
-  <!--[if lt IE 9]>
-    <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
-  <![endif]-->
-</head>
-<body>
-<p class="navbar">
-<span class="smallcaps">= <strong>“Sancho” Pages Puncher</strong> = <a
-href="readme.html">Readme</a> ~ <a href="changelog.html">Changelog</a> ~
-<a href="story.html">Story</a> ~ <a
-href="https://github.com/nvoynov/sancho">Github</a></span>
-</p>
-<header id="title-block-header">
-<h1 class="title">Sancho Changelog</h1>
-</header>
-<nav id="TOC" role="doc-toc">
-<ul>
-<li><a href="#todo" id="toc-todo">[TODO]</a></li>
-<li><a href="#unreleased" id="toc-unreleased">[Unreleased]</a></li>
-<li><a href="#section" id="toc-section">[0.6.0] - 2024-03-08</a></li>
-<li><a href="#section-1" id="toc-section-1">[0.6.0] -
-2024-03-07</a></li>
-<li><a href="#section-2" id="toc-section-2">[0.3.0] -
-2023-02-11</a></li>
-<li><a href="#section-3" id="toc-section-3">[0.2.0] -
-2023-01-30</a></li>
-<li><a href="#section-4" id="toc-section-4">[0.1.0] -
-2023-01-28</a></li>
-</ul>
-</nav>
-<h2 id="todo">[TODO]</h2>
-<ul class="task-list">
-<li><input type="checkbox" />fix config.ru for serving locally; provide
-it for clients</li>
-<li><input type="checkbox" />having template, is there any sense in
-header, footer?</li>
-<li><input type="checkbox" />page collections with own collection layout
-and index.html</li>
-</ul>
-<h2 id="unreleased">[Unreleased]</h2>
-<h2 id="section">[0.6.0] - 2024-03-08</h2>
-<ul>
-<li>fixed config.ru</li>
-<li><code>serve</code> task depends on <code>docs</code></li>
-</ul>
-<h2 id="section-1">[0.6.0] - 2024-03-07</h2>
-<ul>
-<li>designed new model based on Data.define</li>
-<li>designed tests for tasks.rake</li>
-<li>designed new <code>sancho:serve</code> and
-<code>sancho:release</code> tasks</li>
-<li>improved <code>sancho:init</code> output</li>
-<li>improved <code>sancho:docs</code> using Dir.mktempdir</li>
-</ul>
-<h2 id="section-2">[0.3.0] - 2023-02-11</h2>
-<ul>
-<li>packed as a gem</li>
-<li>added <code>sancho:init</code> rake task</li>
-</ul>
-<h2 id="section-3">[0.2.0] - 2023-01-30</h2>
-<ul>
-<li>added styles (pandoc.css with sticky navbar and changed code)</li>
-<li>added rackup</li>
-</ul>
-<h2 id="section-4">[0.1.0] - 2023-01-28</h2>
-<ul>
-<li>Project released</li>
-</ul>
-<div id="footer">
-<hr />
-<p>© 2022-2023 <a href="http://nvoynov.github.io/">nvoynov</a></p>
-</div>
-</body>
-</html>
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
+<head>
+  <meta charset="utf-8" />
+  <meta name="generator" content="pandoc" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
+  <meta name="keywords" content="static-site-generator, github-pages-generator, ruby" />
+  <title>Sancho Changelog</title>
+  <style>
+    code{white-space: pre-wrap;}
+    span.smallcaps{font-variant: small-caps;}
+    div.columns{display: flex; gap: min(4vw, 1.5em);}
+    div.column{flex: auto; overflow-x: auto;}
+    div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
+    /* The extra [class] is a hack that increases specificity enough to
+       override a similar rule in reveal.js */
+    ul.task-list[class]{list-style: none;}
+    ul.task-list li input[type="checkbox"] {
+      font-size: inherit;
+      width: 0.8em;
+      margin: 0 0.8em 0.2em -1.6em;
+      vertical-align: middle;
+    }
+    .display.math{display: block; text-align: center; margin: 0.5rem auto;}
+  </style>
+  <link rel="stylesheet" href="css/styles.css" />
+  <!--[if lt IE 9]>
+    <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
+  <![endif]-->
+</head>
+<body>
+<p class="navbar">
+<span class="smallcaps">= <strong>“Sancho” Pages Puncher</strong> = <a
+href="readme.html">Readme</a> ~ <a href="changelog.html">Changelog</a> ~
+<a href="story.html">Story</a> ~ <a
+href="https://github.com/nvoynov/sancho">Github</a></span>
+</p>
+<header id="title-block-header">
+<h1 class="title">Sancho Changelog</h1>
+</header>
+<nav id="TOC" role="doc-toc">
+<ul>
+<li><a href="#todo" id="toc-todo">[TODO]</a></li>
+<li><a href="#unreleased" id="toc-unreleased">[Unreleased]</a></li>
+<li><a href="#section" id="toc-section">[0.4.0] - 2024-03-07</a></li>
+<li><a href="#section-1" id="toc-section-1">[0.3.0] -
+2023-02-11</a></li>
+<li><a href="#section-2" id="toc-section-2">[0.2.0] -
+2023-01-30</a></li>
+<li><a href="#section-3" id="toc-section-3">[0.1.0] -
+2023-01-28</a></li>
+</ul>
+</nav>
+<h2 id="todo">[TODO]</h2>
+<ul class="task-list">
+<li><label><input type="checkbox" />fix config.ru for serving
+locally</label></li>
+<li><label><input type="checkbox" />having template, is there any sense
+in header, footer?</label></li>
+<li><label><input type="checkbox" />page collections with own collection
+layout and index.html</label></li>
+</ul>
+<h2 id="unreleased">[Unreleased]</h2>
+<h2 id="section">[0.4.0] - 2024-03-07</h2>
+<ul>
+<li>designed new model based on Data.define</li>
+<li>designed tests for Rake tasks</li>
+<li>improved <code>sancho:init</code> output</li>
+<li>improved <code>sancho:docs</code> using Dir.mktempdir</li>
+</ul>
+<h2 id="section-1">[0.3.0] - 2023-02-11</h2>
+<ul>
+<li>packed as a gem</li>
+<li>added <code>sancho:init</code> rake task</li>
+</ul>
+<h2 id="section-2">[0.2.0] - 2023-01-30</h2>
+<ul>
+<li>added styles (pandoc.css with sticky navbar and changed code)</li>
+<li>added rackup</li>
+</ul>
+<h2 id="section-3">[0.1.0] - 2023-01-28</h2>
+<ul>
+<li>Project released</li>
+</ul>
+<div id="footer">
+<hr />
+<p>© 2022-2023 <a href="http://nvoynov.github.io/">nvoynov</a></p>
+</div>
+</body>
+</html>