runecms 0.0.12 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b21f4eb1bb1ba14621ce2e5e828135369171857133f3cd69f0f458e6d87dffcc
-  data.tar.gz: 6dc137a0c006d464a80ca68d5a6fcdadfcf69909d8a232ae37c62838c4f098fe
+  metadata.gz: bb703049421336644a4ed7f558e5b0e24ac1ac1afda11078abc2c487e6fcde62
+  data.tar.gz: 877c8eed4ad958999c8bb5af867286bda8c9a71cfd10faa6a91cf88f8824d172
 SHA512:
-  metadata.gz: d388385924aa49ec1b12147bb037788625549577953e8999971c0911ea3c8e2bd586dbc3d7c82c4255c56e0037c78550054fa72ba2efc961530fbc71a723f808
-  data.tar.gz: 242b2d20913ab59d25da21b29d9421bc176165dae0f4c985a4c39ea092a4dbf6f65a818fe616837380593711ec64772acf0f6c09d428279f0bc9948b0af78724
+  metadata.gz: b4d793a88a5f2d23ce5b9d74daa7094bd0827d4e1bc6bcbcad54c0d504510b12458c399b02c110dd2aa63e492c9aa28e3b3c8953280a609ee3643c6fdc2d184c
+  data.tar.gz: d3953ef17d5ba3e319ff30958b4685a4a65e7f5b1333b61294142c3b0923a60a922722509f538038733720b2dd242828e20f63134f096ef8c28750441988b485

data/README.lt3

@@ -1,23 +1,44 @@
+. Note: at present, paragraphs are broken in livetext. Hence the .br
+
 RuneCMS is intended to be a simple, lightweight tool for building
 and deploying static websites.
 
+.br 2
+
 It's based on Livetext, but could be generalized to be agnostic of
 that tool. It is abstracted from a portion of RuneBlog.
 
+.br 2
+
 In its present form, the `rcms command simply takes a parameter.
-Your choices are:
+Choices are:
+
+.br 2
+
 .xtable
-`[ rcms config]   :: Initialize `config.txt if necessary and edit with `vi
-`[ rcms generate] :: Find stale files under `source/ and generate them under `target/
-`[ rcms view]     :: View the current state of `target/ via browser (local files)
-`[ rcms publish]  :: Publish `target/ to the remote server
-`[ rcms browse]   :: Browse the current state of the remote server
+`[rcms version] :: Print the version number of RuneCMS
+
+`[rcms config] :: Initialize `config.txt if necessary and edit with `vi
+
+`[rcms check] ::  List stale files, but do nothing else
+
+`[rcms generate] :: Find stale files under `source/ and generate them under `target/
+
+`[rcms publish] :: Publish `target/ to the remote server
+
+`[rcms update]  :: Shortcut - Like a generate followed by a publish
+
+`[rcms view] :: View the current state of `target/ via browser (local files)
+
+`[rcms browse] :: Browse the current state of the remote server
 .end
 
 At present, there is no check for these to be done in order. For example, 
 you could publish without a generate (analogous to editing a C program
 and running the executable without recompiling it).
 
+.br 2
+
 The assumption is made that keys for the user and server are already 
 set up. The `config.txt file looks like:
 
@@ -27,6 +48,49 @@ path: /var/www/foo
 user: hal9000
 </pre>
 
+<hr>
+
+*[Original notes:]
+
+<pre>
+General idea: Website is stored in a directory tree. Use Livetext (etc.?) to create target files
+and rsync to upload.
+
+.br 2
+
+Config will comprise:
+  - server
+  - user
+  - root/path
+
+.br 2
+
+Dir structure:
+
+.br 2
+
+  site
+   |
+   +---- config.lt3
+   +---- source/...
+   +---- target/...
+
+.br 2
+
+Logic flow:
+  1. Edit file(s) under source/ tree
+  2. Generate 
+      - reads config
+      - finds modified files under source/
+      - runs livetext on each
+      - results go under target/
+  3. View target/ locally to verify
+  4. Publish via rsync
+      # cmd = "rsync -r -z #{target}/ #@user@#@server:#{path}/"
+
+</pre>
+
+.br 2
 
 More details later...
 

data/README.md

@@ -1,53 +1,100 @@
 RuneCMS is intended to be a simple, lightweight tool for building
 and deploying static websites.
-<p>
-
+<br><br>
 It's based on Livetext, but could be generalized to be agnostic of
 that tool. It is abstracted from a portion of RuneBlog.
-<p>
-
-In its present form, the <font size=+1><tt>rcms</tt></font> command simply takes a parameter.
-Your choices are:
+<br><br>
+In its present form, the <t>rcms</t> command simply takes a parameter.
+Choices are:
+<br><br>
 <br><center><table width=90% cellpadding=5>
 <tr>
-  <td valign=top><font size=+1><tt>rcms config</tt></font>  </td>
-  <td valign=top>Initialize <font size=+1><tt>config.txt</tt></font> if necessary and edit with <font size=+1><tt>vi</tt></font></td>
+  <td valign=top><t>rcms version</t></td>
+  <td valign=top>Print the version number of RuneCMS</td>
 </tr>
 <tr>
-  <td valign=top><font size=+1><tt>rcms generate</tt></font></td>
-  <td valign=top>Find stale files under <font size=+1><tt>source/</tt></font> and generate them under <font size=+1><tt>target/</tt></font></td>
 </tr>
 <tr>
-  <td valign=top><font size=+1><tt>rcms view</tt></font>    </td>
-  <td valign=top>View the current state of <font size=+1><tt>target/</tt></font> via browser (local files)</td>
+  <td valign=top><t>rcms config</t></td>
+  <td valign=top>Initialize <t>config.txt</t> if necessary and edit with <t>vi</t></td>
 </tr>
 <tr>
-  <td valign=top><font size=+1><tt>rcms publish</tt></font> </td>
-  <td valign=top>Publish <font size=+1><tt>target/</tt></font> to the remote server</td>
 </tr>
 <tr>
-  <td valign=top><font size=+1><tt>rcms browse</tt></font>  </td>
+  <td valign=top><t>rcms check</t></td>
+  <td valign=top> List stale files, but do nothing else</td>
+</tr>
+<tr>
+</tr>
+<tr>
+  <td valign=top><t>rcms generate</t></td>
+  <td valign=top>Find stale files under <t>source/</t> and generate them under <t>target/</t></td>
+</tr>
+<tr>
+</tr>
+<tr>
+  <td valign=top><t>rcms publish</t></td>
+  <td valign=top>Publish <t>target/</t> to the remote server</td>
+</tr>
+<tr>
+</tr>
+<tr>
+  <td valign=top><t>rcms update</t> </td>
+  <td valign=top>Shortcut - Like a generate followed by a publish</td>
+</tr>
+<tr>
+</tr>
+<tr>
+  <td valign=top><t>rcms view</t></td>
+  <td valign=top>View the current state of <t>target/</t> via browser (local files)</td>
+</tr>
+<tr>
+</tr>
+<tr>
+  <td valign=top><t>rcms browse</t></td>
   <td valign=top>Browse the current state of the remote server</td>
 </tr>
 </table></center>
 At present, there is no check for these to be done in order. For example, 
 you could publish without a generate (analogous to editing a C program
 and running the executable without recompiling it).
-<p>
-
+<br><br>
 The assumption is made that keys for the user and server are already 
-set up. The <font size=+1><tt>config.txt</tt></font> file looks like:
-<p>
-
+set up. The <t>config.txt</t> file looks like:
 <pre>
 server: foo.com
 path: /var/www/foo
 user: hal9000
 </pre>
-<p>
-
-<p>
-
+<hr>
+<b>Original notes:</b>
+<pre>
+General idea: Website is stored in a directory tree. Use Livetext (etc.?) to create target files
+and rsync to upload.
+<br><br>
+Config will comprise:
+  - server
+  - user
+  - root/path
+<br><br>
+Dir structure:
+<br><br>
+  site
+   |
+   +---- config.lt3
+   +---- source/...
+   +---- target/...
+<br><br>
+Logic flow:
+  1. Edit file(s) under source/ tree
+  2. Generate 
+      - reads config
+      - finds modified files under source/
+      - runs livetext on each
+      - results go under target/
+  3. View target/ locally to verify
+  4. Publish via rsync
+      # cmd = "rsync -r -z #{target}/ #@user@#@server:#{path}/"
+</pre>
+<br><br>
 More details later...
-<p>
-

data/bin/rcms

@@ -1,9 +1,6 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH << "lib" 
-$LOAD_PATH << "../../lib"  # for examples/ex1/ etc.
-
-require 'rubygems'
+$LOAD_PATH << "lib"
 
 require 'runecms'
 
@@ -15,7 +12,5 @@ cmd = ARGV.first
 
 abort "Don't know #{cmd}" unless command?(cmd)
 
-read_config
-
 execute(cmd)
 

data/examples/ex1/config.txt

@@ -1,3 +1,3 @@
 server: foo.com
-path:   /var/www/foo
-user:   hal9000
+path: /var/www/foo
+user: hal9000

data/lib/runecms/commands.rb

@@ -3,29 +3,52 @@ require 'find'
 
 CONFIG = "config.txt"
 
+def run_version
+  puts RuneCMS::VERSION
+end
+
+def run_check
+  stale = stale_files("source")
+  if stale.empty? 
+    puts "No stale files"
+  else
+    puts "Stale files:"
+    stale.each {|x| puts "  " + x }
+    puts
+  end
+end
+
 def run_config
-  unless File.exist?(CONFIG)
-    File.open(CONFIG, "w") do |f|
+  unless read_config
+    File.open("config.txt", "w") do |f|
       f.puts "server: "
-      f.puts "path:   "
-      f.puts "user:   "
+      f.puts "path: "
+      f.puts "user: "
     end
   end
-  system("vi #{CONFIG}")
+  system("vi config.txt")
 end
 
 def run_generate
   verify_dirs    # handle missing subdirectories
-  list = find_files("source") 
-  list.each do |file|
-    next if File.directory?("source/#{file}")
-    if stale?(file)
-      puts "  #{file} is stale"
+  stale = stale_files("source") 
+  if stale.empty? 
+    puts "Nothing to do"
+  else
+    puts "Stale files:"
+    stale.each do |file| 
+      puts "  " + x
       update_target(file)
     end
+    puts
   end
 end
 
+def run_update
+  run_generate
+  run_publish
+end
+
 def run_view
   # FIXME index is hardcoded...
   system("open target/index.html")
@@ -34,19 +57,10 @@ end
 def run_publish
   cmd = "rsync -r -z target/ #@user@#@server:#@path/"
   system(cmd)
-# puts "Would run: '#{cmd}'"
-# puts
-end
-
-def run_update
-  run_generate
-  run_publish
 end
 
 def run_browse
   system("open #@server")
-# puts "Would run: 'open #@server'"
-# puts
 end
 
 def command?(cmd)

data/lib/runecms/support.rb

@@ -3,19 +3,32 @@ def usage_message
   puts
   puts <<-TEXT
     rcms config    Initialize config.txt if necessary and edit with vi
+    rcms check     List stale files, but do nothing else
     rcms generate  Find stale files under source/ and generate them under target/
     rcms view      View the current state of target/ via browser (local files)
     rcms publish   Publish target/ to the remote server
     rcms update    Shortcut - Like a generate followed by a push
     rcms browse    Browse the current state of the remote server
+
+    Run from a directory with a config.txt, a source/ dir, and a target/ dir.
+
+    Config file looks like:
+      server: example.com
+      path: /some/arbitrary/path
+      user: myuser
+
   TEXT
   puts
   exit
 end
 
-def find_files(dir)
-  list = Find.find(dir).to_a - [dir]
-  list.map {|x| x.sub("#{dir}/","") }
+def stale_files(dir)
+  list = nil
+  path = "#{Dir.pwd}/#{dir}/"
+  list = Find.find(path).to_a
+  list = list.select {|x| ! File.directory?(x) }
+  list.map! {|x| x.sub(path, "") }
+  list.select {|x| stale?(x) }
 end
 
 def stale?(file)  # without source/ or target/
@@ -44,7 +57,6 @@ def update_target(file)
       cmd = "cp source/#{file} target/#{file2}"
     end
   end
-  # puts cmd
   system(cmd)
 end
 
@@ -74,13 +86,23 @@ def fix_extension(file)
 end
 
 def read_config
+  config = "config.txt"
+  here = Dir.pwd
+  loop do
+    raise if Dir.pwd == "/"  # shouldn't get this far
+    break if File.exist?(config)
+    Dir.chdir("..")
+  end
   lines = File.readlines("config.txt")
   # Example: "user: hal9000"
   lines.each do |line|
     var, val = line.split(": ")
-    instance_variable_set("@"+var, val.chomp.strip)
+    instance_variable_set("@" + var, val.chomp.strip)
   end
-rescue => err
-  abort "Can't open config file: #{err}"
+  return true
+rescue => e
+  puts "Can't read config file: here = #{here}  pwd = #{Dir.pwd}"
+  puts e
+  return false
 end
 

data/lib/runecms/version.rb

@@ -1,3 +1,3 @@
 class RuneCMS
-  VERSION = "0.0.12"
+  VERSION = "0.0.14"
 end

data/runecms.gemspec

@@ -1,14 +1,15 @@
 require 'date'
 require 'find'
 
-$LOAD_PATH << "lib"
-
-require "runecms"
+require_relative "lib/runecms"
 
 Gem::Specification.new do |s|
   def s.file_trees(*dirs)
     list = []
-    dirs.each {|dir| list += Find.find(dir).to_a }
+    dirs.each do |dir| 
+      stuff = Find.find(dir).to_a 
+      list += stuff
+    end
     list
   end
 
@@ -34,4 +35,5 @@ Gem::Specification.new do |s|
   s.files       =  main + misc
   s.homepage    = 'https://github.com/Hal9000/runecms'
   s.license     = "Ruby"
+  s.post_install_message = "\n  Success! For help, run 'rcms' with no parameters.\n "
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runecms
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.14
 platform: ruby
 authors:
 - Hal Fulton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-04 00:00:00.000000000 Z
+date: 2022-07-02 00:00:00.000000000 Z
 dependencies: []
 description: A simple static website manager based on Livetext (and Ruby)
 email: rubyhacker@gmail.com
@@ -24,9 +24,6 @@ files:
 - examples/ex1/source/file2.html
 - examples/ex1/source/file3.lt3
 - examples/ex1/source/index.lt3
-- examples/ex1/target/file2.html
-- examples/ex1/target/file3.html
-- examples/ex1/target/index.html
 - lib/runecms.rb
 - lib/runecms/commands.rb
 - lib/runecms/support.rb
@@ -36,7 +33,7 @@ homepage: https://github.com/Hal9000/runecms
 licenses:
 - Ruby
 metadata: {}
-post_install_message:
+post_install_message: "\n  Success! For help, run 'rcms' with no parameters.\n "
 rdoc_options: []
 require_paths:
 - lib

data/examples/ex1/target/file2.html

@@ -1,3 +0,0 @@
-<h3>This file is in HTML</h3>
-
-It would get copied over with no processing.

data/examples/ex1/target/file3.html

@@ -1,10 +0,0 @@
-<h3>This file...</h3>
-<p>
-
-is a <font size=+1><tt>.lt3</tt></font> file, which means livetext would process it
-before it is copied from source/ to target/
-<p>
-
-That's all for now.
-<p>
-

data/examples/ex1/target/index.html

@@ -1,7 +0,0 @@
-<h1>Well, here we are</h1>
-<p>
-
-<b>Not much to see here, really</b>
-<p>
-
-But maybe later there will be.