journaltxt 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c32f384a50536df5f9c7997e721912cfd90f60e6
-  data.tar.gz: 0bf922b19677baf36a160a2e147a0c6e67895d89
+  metadata.gz: 0322499b7aa32d50778470dfeb81fd0318e1795a
+  data.tar.gz: cf684977e3e28615aef65bc4dbc886012472cd84
 SHA512:
-  metadata.gz: 70ffa8e8fc8cafeabff2d18658812712bfe1bab4aadd57a033b53b414a905cb4f594d798e0becad0885baaa8027a6e06ceb3522bc3926edb354743383969adb8
-  data.tar.gz: 9f558373699db8c8a55ae2412bb1912fb1ed73b36e854730c54159d80b22fcf991ea23fec665745598cf371236cb4588acb2f28c245cc7b8f599d181688e9d5f
+  metadata.gz: fef0ccacf2d852ef6ef78657178663d0e2ef4a46df52aea5cd49bb1520376ab5ce3cad0bd0285a013c0b1893ac86e02a6b5fae2c73d73710265cf703ed572a1d
+  data.tar.gz: 4e789f63161222b3ff526bd70a92339e07903011c8d5782aa4168329c3a8c1ea95f4c0c635467bf7e52f72d30f93b658292b5a7a22a0518d46da1422550cb6fe

data/Manifest.txt

@@ -2,7 +2,14 @@ HISTORY.md
 Manifest.txt
 README.md
 Rakefile
+bin/jo
+bin/journaltxt
 lib/journaltxt.rb
+lib/journaltxt/parser.rb
 lib/journaltxt/version.rb
+test/data/journal.txt
+test/data/vienna.txt
 test/helper.rb
+test/test_build.rb
+test/test_parser.rb
 test/test_version.rb

data/README.md

@@ -1,7 +1,7 @@
-# journaltxt - reads Journal.TXT and writes out a blog (w/ Jekyll posts etc.)
+# journaltxt - reads Journal.TXT and writes out (auto-builds) a blog (w/ Jekyll posts etc.)
 
 * home  :: [github.com/journaltxt/journaltxt](https://github.com/journaltxt/journaltxt)
-* bugs  :: [github.com/feedtxt/journaltxt/issues](https://github.com/journaltxt/journaltxt/issues)
+* bugs  :: [github.com/journaltxt/journaltxt/issues](https://github.com/journaltxt/journaltxt/issues)
 * gem   :: [rubygems.org/gems/journaltxt](https://rubygems.org/gems/journaltxt)
 * rdoc  :: [rubydoc.info/gems/journaltxt](http://rubydoc.info/gems/journaltxt)
 * forum :: [groups.google.com/group/wwwmake](http://groups.google.com/group/wwwmake)
@@ -9,7 +9,99 @@
 
 ## Usage
 
-To be done
+Use the single-file [Journal.TXT format](https://journaltxt.github.io)
+to write your blog posts / journal entries.
+Example:
+
+```
+---
+year:  2017
+month: July
+day:   Mon 17
+---
+
+Jumping on tram #1 in front of the Staatsoper (state opera house).
+Circling the Ringstrasse (grand boulevard vienna ring road)
+for a great tour with a public transport ticket.
+Passing the Hofburg (imperial palace), Parlament,
+Burggarten (imperial court's garden),
+Rathaus (city council), Burgtheater (imperial court's theatre),
+Vienna University, and more. [...]
+
+---
+day:   Tue 18
+---
+
+Visiting the imperial palace Schönbrunn - the former summer residence
+of the Habsburg family.
+Taking an inside tour of the 1 441-room baroque palace.
+Enjoying the Neptune Fountain and sculptures in the public garden. [...]
+
+---
+day:   Wed 19
+---
+
+Visiting the Sigmund Freud Museum in Bergstrasse 9. Too much culture -
+need a beer therapy soon.
+Passing through the Palais Lichtenstein to the
+Beaver Brewing Co. (Liechtensteinstraße 69). [...]
+```
+
+(Source: [samples/Vienna.txt](https://github.com/journaltxt/journaltxt.github.io/blob/master/samples/Vienna.txt))
+
+
+Try the `journaltxt` or `jo` (shortened alternate) command line tool e.g.:
+
+```
+$ journaltxt --help
+
+Usage: journaltxt [OPTS] [JOURNAL.TXT FILES...]
+    -v, --[no-]verbose               Show debug messages
+    -o, --output=PATH                Output path (default: .)
+    -n, --name=NAME                  Journal name (default: Journal)
+        --[no-]date                  Add date to page title (default: true)
+    -h, --help                       Prints this help
+```
+
+For example, to auto-build all posts for a static Jekyll website / blog
+in the `YYYY-MM-DD-title.md` format from a single-file in the Journal.TXT format
+e.g. [Vienna.txt](https://github.com/journaltxt/journaltxt.github.io/blob/master/samples/Vienna.txt) use:
+
+```
+$ journaltxt --output=_posts Vienna.txt
+     -or-
+$ journaltxt -o _posts Vienna.txt
+     -or-
+$ jo -o _posts Vienna.txt
+```
+
+resulting in:
+
+```
+Writing entry 1/3 >Vienna - Day 1< to ./_posts/2017-07-17-vienna.md...
+Writing entry 2/3 >Vienna - Day 2< to ./_posts/2017-07-18-vienna.md...
+Writing entry 3/3 >Vienna - Day 3< to ./_posts/2017-07-19-vienna.md...
+```
+
+That's it.
+**See the live auto-built [Vienna.TXT Blog »](https://journaltxt.github.io/blog)**
+
+
+## Bonus: Add Your Perfect Day!
+
+Berlin.TXT, Munich.TXT, Salzburg.TXT, Paris.TXT, London.TXT, Rome.TXT, New York.TXT, Austin.TXT, Tornoto.TXT, Calgary.TXT,
+Melbourne.TXT, Sydney.TXT, ...   - Anyone?
+Write your perfect day(s) in a single-text file with Journal.TXT.
+
+
+
+## Install
+
+Just install the gem:
+
+```
+$ gem install journaltxt
+```
 
 
 ## License

data/Rakefile

@@ -5,7 +5,7 @@ Hoe.spec 'journaltxt' do
 
   self.version = Journaltxt::VERSION
 
-  self.summary = "journaltxt - reads Journal.TXT and writes out a blog (w/ Jekyll posts etc.)"
+  self.summary = "journaltxt - reads Journal.TXT and writes out (auto-builds) a blog (w/ Jekyll posts etc.)"
   self.description = summary
 
   self.urls    = ['https://github.com/journaltxt/journaltxt']

data/bin/jo

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'journaltxt'
+
+Journaltxt.main

data/bin/journaltxt

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'journaltxt'
+
+Journaltxt.main

data/lib/journaltxt/parser.rb

@@ -0,0 +1,121 @@
+# encoding: utf-8
+
+module Journaltxt
+
+class Parser
+
+  def self.parse( text )   ## convenience helper
+    self.new( text ).parse
+  end
+
+  def initialize( text )
+    @text = text
+  end
+
+  def parse
+
+    puts ":: Text :::::::::::::::::::::"
+    puts @text
+
+    ## allow trailing spaces for now
+    ##  - allow leadin spaces too - why? why not?
+
+    ## remove leading 1st separator --- first
+    text = @text.sub( /^---[ ]*$\n?/, '' )
+    b = text.split( /^---[ ]*$\n?/ )
+
+    items = b.each_slice(2).to_a
+
+
+    ## process meta data blocks convert to hash via yaml
+
+    ##
+    ## todo: check for required entries
+    ##
+    ##   first entry needs/requires:
+    ##      year/month/day
+    ##   all others requireÖ
+    ##      day
+
+    last_page_date = nil
+
+    items = items.each_with_index.map do |item,i|
+      page_meta   = YAML.load( item[0] )  ## convert to hash (from yaml text)
+      pp page_meta
+      page_content = item[1]
+
+      ## remove all (short-cut) date entries
+      year  = page_meta.delete( 'year' )
+      month = page_meta.delete( 'month' )
+      day   = page_meta.delete( 'day' )
+
+      puts "  year: >#{year}< : #{year.class.name}, month: >#{month}< : #{month.class.name}, day: >#{day}< : #{day.class.name}"
+
+      ## convert all date entries to ints
+      ##   lets us handle day => Sun 23 etc.
+
+      ##  note: assume year is always a number
+      if year.nil?
+         if last_page_date
+           year = last_page_date.year
+         else
+           ### fix/todo: throw format/parse exception!!
+           puts "** year entry required / expected for first entry / meta data block"
+           exit 1
+         end
+      end
+
+
+      if day && day.is_a?(String)
+         puts "  trying to convert day to int..."
+         nums_day = day.scan( /[0-9]+/ )   ## returns array e.g. ['12']
+         day = nums_day[0].to_i
+         puts "  day:   >#{day}< : #{day.class.name}"
+      end
+
+      if day.nil?   ### fix/add - check if day >0 and< 31 why? why not??
+        ### fix/todo: throw format/parse exception!!
+        puts "** day entry required in meta data block"
+        exit 1
+      end
+
+
+      if month && month.is_a?(String)
+        puts "  trying to convert month to int..."
+        ## for now let stdlib handle conversion
+        ##   supports abbreviated names (e.g. Jan) and full names (e.g. January)
+
+        ## todo/fix: check what happens if montn is invalid/unknow
+        ##    returns nil? throws exception?
+        date_month = Date.parse( "#{year}/#{month}/#{day}" )
+        month = date_month.month
+        puts "  month: >#{month}< : #{month.class.name}"
+      end
+
+      if month.nil?
+        if last_page_date
+          month = last_page_date.month
+        else
+          ### fix/todo: throw format/parse exception!!
+          puts "** month entry required for first entry / meta data block"
+          exit 1
+        end
+      end
+
+
+      page_date = Date.new( year, month, day )
+      last_page_date = page_date
+
+      ## todo:check if date exists? possible?
+      ##     issue warning or something - will get replaced - why? why not?
+      page_meta['date']  = page_date
+
+      ## pp YAML.dump( h )
+
+      [page_meta, page_content]
+    end
+    items
+  end  # method parse
+
+end # class Parser
+end # module Journaltxt

data/lib/journaltxt/version.rb

@@ -2,9 +2,9 @@
 
 module Journaltxt
 
-  MAJOR = 0
+  MAJOR = 1
   MINOR = 0
-  PATCH = 1
+  PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

data/lib/journaltxt.rb

@@ -3,23 +3,167 @@
 
 # core and stdlibs
 
-require 'strscan'    ## StringScanner
-require 'json'
 require 'yaml'
 require 'date'
 require 'time'
 require 'pp'
+require 'optparse'
 
 
+# our own code
+require 'journaltxt/version'  # let it always go first
+require 'journaltxt/parser'
 
-# 3rd party gems/libs
-require 'logutils'
-require 'props'     ## used for IniFile.parse
 
+module Journaltxt
 
-# our own code
-require 'journaltxt/version'  # let it always go first
+  def self.main
+    process( ARGV )
+  end
+
+
+  DEFAULTS = { outpath: '.',
+             date:    true,      # include date in (auto-)title
+             verbose: false,
+             name:    'Journal'
+           }
+
+  def self.process( args )
+
+    config = {}   ## note: keep use supplied and defaults separated!!! entry nil - if not set!!
+
+    parser = OptionParser.new do |opts|
+      opts.banner = "Usage: journaltxt [OPTS]"
+
+      opts.on("-v", "--[no-]verbose", "Show debug messages") do |verbose|
+        config[:verbose] = verbose
+      end
+
+      ## use --outdir or outputdir or something or output
+      opts.on("-o", "--output=PATH", "Output path (default: #{DEFAULTS[:outpath]})") do |outpath|
+        config[:outpath] = outpath
+      end
+
+      opts.on("-n", "--name=NAME", "Journal name (default: #{DEFAULTS[:name]})") do |name|
+        config[:name] = name
+      end
+
+      opts.on("--[no-]date", "Add date to page title (default: #{DEFAULTS[:date]})") do |date|
+        config[:date] = date
+      end
+
+      opts.on("-h", "--help", "Prints this help") do
+        puts opts
+        exit
+      end
+    end
+
+    parser.parse!(args)
+
+    puts ":: Config :::"
+    pp config
+    puts ":: Args :::"
+    pp args
+
+    if args.size == 0   ## default to journal.txt  if no filename passed along
+      args << 'journal.txt'
+    end
+
+    args.each do |arg|
+      build_file( arg, config )
+    end
+  end
+
+
+  def self.build_file( path, opts={} )
+    text = File.open( path, 'r:bom|utf-8' ).read
+
+    ## note: remove .txt extension if present for basename
+    basename = File.basename( path, '.txt' )
+    puts "basename:"
+    pp basename
+
+    ## note: only overwrite if NOT user-supplied
+    opts[:name] ||= basename
+
+    build( text, opts )
+  end
+
+
+  def self.build( text, opts={} )
+    puts ":: Opts :::"
+    pp opts
+
+    outpath   = opts[:outpath]  || DEFAULTS[:outpath]
+    name      = opts[:name]     || DEFAULTS[:name]
+    add_date  = opts.fetch( :date, DEFAULTS[:date] )  ## special case boolean flag migth be false
+
+
+    items = Parser.parse( text  )
+
+    items.each_with_index do |item,i|
+      ## add page_title
+      ##   todo/fix:  check if title exists? do NOT overwrite - why? why not?
+
+      page_meta = item[0]
+      page_date = page_meta['date']
+
+      page_title = ''
+      if name.downcase == 'journal'  ## note: special case (do NOT auto-add journal to title)
+        ## dont't add "default/generic" journal to title
+      else
+        page_title << "#{name} - "
+      end
+      page_title << "Day #{i+1}"
+      page_title << " - #{page_date.strftime('%a, %-d %b')}"   if add_date
+
+      page_meta['title'] = page_title
+    end
+
+
+    items.each_with_index do |item,i|
+       page_meta    = item[0]
+       page_content = item[1]
+
+       page_date    = page_meta['date']
+       page_title   = page_meta['title']
+
+       path = ''
+       path << "#{outpath}/#{page_date}"
+       path << "-#{name.downcase}.md"      ## note: journal gets auto-added to the name too
+
+       ##
+       ##  check if path exits?
+       page_root = File.dirname( File.expand_path( path ) )
+       unless File.directory?( page_root )
+         puts "   make (missing) output dirs >#{page_root}...<"
+         FileUtils.makedirs( page_root )
+       end
+
+
+       puts "Writing entry #{i+1}/#{items.size} >#{page_title}< to #{path}..."
+
+       ### todo:
+       ##   add a comment in the yaml meta data block e.g.
+       ##   #  Journal.TXT entry 1/4 - auto-built on xxxx by journaltxt v1.2.3
+       ##   or something
+
+       comment = "Journal.TXT entry #{i+1}/#{items.size} - auto-built on #{Time.now} by journaltxt/#{Journaltxt.version}"
+
+       yaml_text = YAML.dump( page_meta )
+       ## todo: check better way to add an upfront comment?
+       ##   for now just replace leading --- with leading --- with comment
+       yaml_text = yaml_text.sub( /^---[ ]*$\n?/, "---\n# #{comment}\n" )
+
+       File.open( path, 'w:utf-8' ) do |f|
+         f.write yaml_text
+         f.write "---\n\n"
+         f.write page_content
+       end
+    end
+  end
 
+end # module Journaltxt
 
 
 # say hello

data/test/data/journal.txt

@@ -0,0 +1,24 @@
+---
+year:  2017
+month: July
+day:   Wed 19
+---
+Let's reinvent push-button publishing on the internets!
+Use a single-file for your journal / diary / blog. That's it.
+---
+day:   Thu 20
+---
+Crazy idea? Let's put up a website and a example blog auto-generated from journal.txt.
+---
+day:   Fri 21
+---
+Did you know? The single-file format works great for advent calendars
+or beer-of-the-day calendars.
+---
+day:    Sat 22
+---
+Let's add another example. A diary about the Oktoberfest 2016. Prost. Cheers.
+---
+day:    Sun 23
+---
+Let's rest.

data/test/data/vienna.txt

@@ -0,0 +1,83 @@
+---
+year:  2017
+month: July
+day:   Mon 17
+---
+
+Jumping on tram #1 in front of the Staatsoper (state opera house).
+Circling the Ringstrasse (grand boulevard vienna ring road)
+for a great tour with a public transport ticket.
+Passing the Hofburg (imperial palace), Parlament,
+Burggarten (imperial court's garden),
+Rathaus (city council), Burgtheater (imperial court's theatre),
+Vienna University, and more.
+
+Getting off at the Vienna University stop.
+Wandering to the heart of the city to the glourious
+gothic Stepansdom (Stephan's cathedral).
+
+Making my way to the Hofburg passing the Pestsäule (plague column) in the Graben
+and the Michaeler Tor (St. Michael's gate). Passing the National Library and
+the Imperial Sisi Apartments and Crown Jewels.
+
+Crossing the Ringstrasse to the Kunsthistorisches Museum (national art gallery) - home
+to a breath-taking art collection. Must see!
+The (Great) Babel Tower by Pieter Bruegel the Elder (c.1525-1530 - 1569)
+and the Geographer by Johannes Vermeer (1668 – 1669).
+
+Recharging at 7 Stern Bräu in Neubau with a Gulash[^1] and beers brewed-on-location
+with Vienna's fine tap water (from the Austrian Mountains).
+Trying 7 Stern Märzen (5.1%, 13.5°),
+7 Stern Weizen Classic (5.2%, 12.7°),
+7 Stern Prager Dunkles (4.5%, 12.1°) and
+today's special 7 Stern Smoked Porter (5.3%, 13.8°). Cheers. Prost.
+
+[^1]: Goulash (Hungarian: gulyás [ˈɡujaːʃ]) is a soup or stew of meat and vegetables, seasoned with paprika and other spices.
+
+---
+day:   Tue 18
+---
+
+Visiting the imperial palace Schönbrunn - the former summer residence
+of the Habsburg family.
+Taking an inside tour of the 1 441-room baroque palace.
+Enjoying the Neptune Fountain and sculptures in the public garden.
+
+Heading back to the city to explore Schloss Belvedere - another
+unequalled baroque palace. Entering the art collection.
+Must see! The Kiss by Gustav Klimt (1862-1918) -
+a symbol of Vienna Jugendstil (Viennese Art Nouveau).
+
+Recharging at Salm Bräu (Rennweg 8)
+with Schinkenfleckerl (Austrian noodles with ham)
+and beers brewed-on-location.
+Trying Salm 1842 Pils (5.0%, 12.5°),
+Salm Wiener Märzen (5.0%, 12.5°),
+Salm Böhmisch Dunkles (5.0%, 12.5°)
+and today's special Salm Burning Hell (4.9%, 12.2°). Cheers. Prost.
+
+
+---
+day:   Wed 19
+---
+
+Visiting the Sigmund Freud Museum in Bergstrasse 9. Too much culture -
+need a beer therapy soon.
+Passing through the Palais Lichtenstein to the
+Beaver Brewing Co. (Liechtensteinstraße 69).
+Trying a 6-sample beer flight:
+Beaver Blue Ribbon, Wry Pale Ale,
+Late Summer IPA,
+Witty Bastard Witbier,
+Charlie Brown Ale,
+Brave Lion Golden Strong Ale.
+
+Heading to the Highlander (Sobieskiplatz 4) -
+brewing Vienna's first and oldest porter - the
+Highlander Stout. Let's try an unfiltered lager too - the Highlander Märzen Zwickl.
+
+Last therapy stop - recharging in the Biergarten at Lichtenthaler Bräu
+(Lichtensteinstraße 108). Sampling a Lichtenthaler Helles,
+Lichtenthaler West Coast P.A.,
+Lichtenthaler Dark U.S. Lager and
+Lichtenthaler Dinkel Leicht.

data/test/helper.rb

@@ -10,7 +10,7 @@ require 'textutils'
 
 
 ## our own code
-require 'feedtxt'
+require 'journaltxt'
 
 
 
@@ -18,6 +18,6 @@ LogUtils::Logger.root.level = :debug
 
 
 def read_text( name )
-  text = File.read( "#{Feedtxt.root}/test/feeds/#{name}.txt" )
+  text = File.open( "#{Journaltxt.root}/test/data/#{name}.txt", 'r:bom|utf-8' ).read
   text
 end

data/test/test_build.rb

@@ -0,0 +1,35 @@
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_build.rb
+#  or better
+#     rake test
+
+require 'helper'
+
+
+class TestParser < MiniTest::Test
+
+  def xxx_test_journal
+    text = read_text( 'journal' )
+
+    Journaltxt.build( text, name: 'journal', outpath: './tmp' )
+
+    assert true
+  end
+
+  def test_journal_ii
+    Journaltxt.build_file( "#{Journaltxt.root}/test/data/journal.txt", outpath: './tmp' )
+
+    assert true
+  end
+
+  def test_vienna
+    text = read_text( 'vienna' )
+
+    Journaltxt.build( text, name: 'Vienna', outpath: './tmp', date: false )
+
+    assert true
+  end
+
+
+end # class TestParser

data/test/test_parser.rb

@@ -0,0 +1,35 @@
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_parser.rb
+#  or better
+#     rake test
+
+require 'helper'
+
+
+class TestParser < MiniTest::Test
+
+  def test_journal
+    text = read_text( 'journal' )
+
+    items = Journaltxt::Parser.parse( text )
+
+    puts ":: Blocks ::::::::::::::::::::::"
+    pp items
+
+    assert true
+  end
+
+  def test_vienna
+    text = read_text( 'vienna' )
+
+    items = Journaltxt::Parser.parse( text )
+
+    puts ":: Blocks ::::::::::::::::::::::"
+    pp items
+
+    assert true
+  end
+
+
+end # class TestParser

data/test/test_version.rb

@@ -10,8 +10,12 @@ require 'helper'
 class TestVersion < MiniTest::Test
 
   def test_version
-    puts Journaltxt::Version
+    puts Journaltxt.version
+    puts Journaltxt::VERSION
+
     assert true
+
+    ## Journaltxt.process( ['--help'] )
   end
 
 end # class TestVersion

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: journaltxt
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-20 00:00:00.000000000 Z
+date: 2017-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -30,18 +30,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.15'
+        version: '3.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.15'
-description: journaltxt - reads Journal.TXT and writes out a blog (w/ Jekyll posts
-  etc.)
+        version: '3.16'
+description: journaltxt - reads Journal.TXT and writes out (auto-builds) a blog (w/
+  Jekyll posts etc.)
 email: wwwmake@googlegroups.com
-executables: []
+executables:
+- jo
+- journaltxt
 extensions: []
 extra_rdoc_files:
 - HISTORY.md
@@ -52,9 +54,16 @@ files:
 - Manifest.txt
 - README.md
 - Rakefile
+- bin/jo
+- bin/journaltxt
 - lib/journaltxt.rb
+- lib/journaltxt/parser.rb
 - lib/journaltxt/version.rb
+- test/data/journal.txt
+- test/data/vienna.txt
 - test/helper.rb
+- test/test_build.rb
+- test/test_parser.rb
 - test/test_version.rb
 homepage: https://github.com/journaltxt/journaltxt
 licenses:
@@ -81,5 +90,6 @@ rubyforge_project:
 rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
-summary: journaltxt - reads Journal.TXT and writes out a blog (w/ Jekyll posts etc.)
+summary: journaltxt - reads Journal.TXT and writes out (auto-builds) a blog (w/ Jekyll
+  posts etc.)
 test_files: []