zenweb 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd4e60e046e26c4c52060e136115c18c9a67dd39
-  data.tar.gz: a07920ba086b1627aab87550053f6b2d7a0d9ade
+  metadata.gz: cc755e676f07eae47d4e65f3a785fbf5ccb7176b
+  data.tar.gz: e5e47a35122be41500fe61d135210f75556778f4
 SHA512:
-  metadata.gz: 40dfbb58356ae34e309c0a9d90fa8a23afdc7eb1b6e9e940b49e32ebc70ae8baae92943cd9859bdfdc77f4e7d8d1996883ce1e7ca3c41dead9746bb180579dce
-  data.tar.gz: 64a2699353dc48793df8ff6c354522a613cd5cfdb78ea205bc2bc59ca23da5ee95fda738ed5a2289d34846985268b8564efbfc916848eced9a7565d941f96091
+  metadata.gz: 46fa0dc8ba97b3dc62e5e427f78599df368c844a5b7ff0964b85c97ecaa7b7f7559e190351d915eb95aeb8ad621aded52a6372f4f5ed1d8dd73e23b67a0c99fd
+  data.tar.gz: f24ab230786bd0f2c86b8152487a242d860a22f1f87a2f04bd86b98797f5ee1dc116d5df2db59d224317a5616eb861e6d206cb86370801977291a7805161063e

data/History.txt

@@ -1,3 +1,26 @@
+=== 3.6.0 / 2014-12-09
+
+* 12 minor enhancements:
+
+  * Add debugging help when config blows on bad yaml.
+  * Added Enumerable#multi_group_by
+  * Added GeneratedIndex subclass of FakePage.
+  * Added Page#all_subpages_by_level that returns all subpages paired with their depth.
+  * Added Page#tag_list.
+  * Added TagIndex, TagDetail, MonthlyPage, YearlyPage, SeriesPage
+  * Extended Page#dated_path? to include yearly/monthly index pages.
+  * Page#all_subpages now partitioned by #dated_path?
+  * Page#all_subpages takes a reversed arg to reverse (only) dated pages.
+  * Page#dated_path? now returns true for yearly/monthly index.html pages.
+  * Page#sitemap now takes a demote arg in case your subpages are N levels deep.
+  * Page#sitemap reverse-sorts dated pages.
+
+* 3 bug fixes:
+
+  * Fixed Site#fix_subpages to index via url, not path, so virtual pages work.
+  * Page#all_subpages incorrectly filtered out no_index pages. All means all.
+  * Site#fix_subpages no longer reverse sorts... that's someone else's job.
+
 === 3.5.0 / 2014-06-17
 
 * 3 minor enhancements:

data/lib/zenweb.rb

@@ -6,7 +6,7 @@ require "time"
 
 module Zenweb
   # duh
-  VERSION = "3.5.0"
+  VERSION = "3.6.0"
 end
 
 require "zenweb/site"

data/lib/zenweb/config.rb

@@ -92,6 +92,9 @@ module Zenweb
                config, _ = self.class.split thing
                config && YAML.load(config) || {}
              end
+    rescue => e
+      warn "#{self.path}: #{e}"
+      raise
     end
 
     def inspect # :nodoc:

data/lib/zenweb/extensions.rb

@@ -27,6 +27,16 @@ module Enumerable
 
     result
   end unless [].respond_to? :chunk
+
+  def multi_group_by
+    r = Hash.new { |h,k| h[k] = [] }
+    each do |o|
+      Array(yield(o)).each do |k|
+        r[k] << o
+      end
+    end
+    r
+  end
 end
 
 class Array # :nodoc:

data/lib/zenweb/page.rb

@@ -65,10 +65,21 @@ module Zenweb
     end
 
     ##
-    # All pages below this page, recursively.
+    # All pages below this page, possibly +reversed+, recursively.
 
-    def all_subpages
-      subpages.reject(&:no_index?).map { |p| [p, p.all_subpages] }
+    def all_subpages reversed = false
+      dated, normal = subpages.partition(&:dated_path?)
+      dated = dated.reverse if reversed
+
+      (normal + dated).map { |p| [p, p.all_subpages(reversed)] }
+    end
+
+    ##
+    # All pages below this page, possibly +reversed+, recursively,
+    # with the depth of each subpage relative to the current page.
+
+    def all_subpages_by_level reversed = false
+      self.all_subpages(reversed).deep_each.map { |n, p| [(n-1)/2, p] }
     end
 
     ##
@@ -145,6 +156,7 @@ module Zenweb
     end
 
     def date_from_path # :nodoc:
+      # TODO: test
       date = path[/\d\d\d\d-\d\d-\d\d/]
       Time.local(*date.split(/-/).map(&:to_i)) if date
     end
@@ -165,7 +177,7 @@ module Zenweb
     # Is this a dated page? (ie, does it have YYYY-MM-DD in the path?)
 
     def dated_path?
-      path[/\d\d\d\d-\d\d-\d\d/]
+      path[/\d\d\d\d[-\/]\d\d[-\/]\d\d/] || path[/\d\d\d\d(?:[-\/]\d\d)?\/index/]
     end
 
     def change_frequency
@@ -361,7 +373,7 @@ module Zenweb
           (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(s);
         })();
       </script>
-    EOM
+      EOM
     end
 
     ##
@@ -391,6 +403,12 @@ module Zenweb
       @url_path ||= File.join(".site", self.url)
     end
 
+    def tag_list
+      self.tags.map { |tag|
+        "<a href=\"/blog/tags/#{tag.downcase.gsub(/\W/, '')}.html\">#{tag}</a>"
+      }.join ", "
+    end
+
     ##
     # Wire up this page to the rest of the rake dependencies. If you
     # have extra dependencies for this file (ie, an index page that
@@ -448,4 +466,161 @@ module Zenweb
     attr_accessor :content
     attr_accessor :date
   end
+
+  ##
+  # Generates a virtual page with an index of all tags on the given pages.
+  # You must subclass and provide a content method.
+
+  class GeneratedIndex < FakePage
+    attr_accessor :pages
+
+    def self.collate_by pages, key, default=nil
+      pages.multi_group_by { |page| page.config[key] || default }
+    end
+
+    def self.generate_all site, dir, pages
+      raise NotImplementedError, "Implement #{self}#generate_all"
+    end
+
+    def self.page_url page # TODO: hard to do helpers on class methods
+      "[#{page.title}](#{page.clean_url})"
+    end
+
+    def initialize site, path, pages
+      super site, path
+
+      self.pages = pages.select(&:html?)
+      self.date  = Time.now
+
+      site.pages[path] = self
+    end
+
+    def content
+      raise NotImplementedError, "Implement #{self.class}#content"
+    end
+
+    def wire
+      super
+      self.depends_on pages
+    end
+  end
+
+  class TagIndex < GeneratedIndex
+    def self.tags_for pages
+      collate_by pages, :tags, "None"
+    end
+
+    def self.generate_all site, dir, pages
+      self.new site, "#{dir}/index.html.md.erb", pages
+    end
+
+    def self.tag_list tag, pages
+      r = []
+      r << "### #{tag}"
+      r << "#{pages.size} pages"
+      r << ""
+      r << pages.map { |page| "*  #{page.date.date} #{page_url page}" }
+      r << ""
+      r.join "\n"
+    end
+
+    def index
+      self.class.tags_for(pages).sort_by { |t,_| t.to_s.downcase }.map { |t, p|
+        self.class.tag_list t, p
+      }.join "\n"
+    end
+  end
+
+  ##
+  # Generates a virtual page with an index for a given tag on the given pages.
+  # You must subclass and provide a content method.
+
+  class TagDetail < TagIndex
+    attr_accessor :tag
+
+    def self.generate_all site, dir, pages
+      tags_for(pages).sort.each do |tag, pgs|
+        path = tag.downcase.gsub(/\W+/, '')
+        generate site, "#{dir}/#{path}.html.md.erb", pgs, tag
+      end
+    end
+
+    def self.generate site, path, pages, tag
+      self.new site, path, pages, tag
+    end
+
+    def initialize site, path, pages, tag
+      super site, path, pages
+      self.tag = tag
+    end
+
+    def index
+      self.class.tag_list tag, pages
+    end
+  end
+
+  class SeriesPage < GeneratedIndex
+    attr_accessor :series
+
+    def self.series_for pages
+      collate_by pages, :series
+    end
+
+    def self.generate_all site, dir, pages
+      series_for(pages).sort.each do |series, pgs|
+        next unless series
+        path = series.downcase.gsub(/\W/, '-')
+        generate site, "#{dir}/#{path}.html.md.erb", pgs, series
+      end
+    end
+
+    def self.generate site, path, pages, series
+      self.new site, path, pages, series
+    end
+
+    def initialize sate, path, pages, series
+      super site, path, pages
+      self.series = series
+    end
+  end
+
+  ##
+  # Generates a virtual page with monthly index pages.
+  # You must subclass and provide a content method.
+
+  class MonthlyPage < GeneratedIndex
+    def self.generate_all site, dir, pages
+      pages.find_all(&:dated?).group_by { |page|
+        [page.date.year, page.date.month]
+      }.each do |(year, month), subpages|
+        path = "#{dir}/%4d/%02d/index.html.md.erb" % [year, month]
+        self.new site, path, subpages, year, month
+      end
+    end
+
+    def initialize site, path, pages, year, month
+      super site, path, pages
+      self.date = Time.local(year, month)
+    end
+  end
+
+  ##
+  # Generates a virtual page with yearly index pages.
+  # You must subclass and provide a content method.
+
+  class YearlyPage < GeneratedIndex
+    def self.generate_all site, dir, pages
+      pages.find_all(&:dated?).group_by { |page|
+        page.date.year
+      }.each do |year, subpages|
+        path = "#{dir}/%4d/index.html.md.erb" % [year]
+        self.new site, path, subpages, year
+      end
+    end
+
+    def initialize site, path, pages, year
+      super site, path, pages
+      self.date = Time.local(year)
+    end
+  end
 end

data/lib/zenweb/plugins/markdown.rb

@@ -49,9 +49,10 @@ class Zenweb::Page
     # whether the pages are ordered (dated) or not or a combination of
     # the two.
 
-    def sitemap title_dated = true
-      self.all_subpages.deep_each.chunk { |n, p| n }.map { |depth, a|
-        level = (depth-1)/2
+    def sitemap title_dated = true, demote = 0
+      self.all_subpages_by_level(true).chunk { |n, p| n }.map { |level, a|
+        level -= demote
+
         level = 0 if level < 0
 
         dated, normal = a.map(&:last).reject(&:no_index?).partition(&:dated?)
@@ -60,7 +61,7 @@ class Zenweb::Page
 
         dated = dated_map(dated) { |month, ps2|
           x = date_sorted_map(ps2) { |p|
-            page_sitemap_url p, level + 1
+            page_sitemap_url p, level + (title_dated ? 1 : 0)
           }
           x.unshift "#{"  " * level}* #{month}:" if title_dated
           x
@@ -70,8 +71,14 @@ class Zenweb::Page
       }.join "\n"
     end
 
+    def page_url page
+      "[#{page.title}](#{page.clean_url})"
+    end
+
+    module_function :page_url
+
     def page_sitemap_url page, depth # :nodoc:
-      "#{"  " * (depth)}* [#{page.title}](#{page.clean_url})"
+      "#{"  " * (depth)}* #{page_url page}"
     end
 
     def date_sorted_map a, &b # :nodoc:

data/lib/zenweb/site.rb

@@ -207,17 +207,25 @@ module Zenweb
     end
 
     def fix_subpages # :nodoc:
+      # TODO: push most of this down to page
       parents = {}
+
       @pages.values.select(&:index?).each do |p|
-        parents[File.dirname p.path] = p
+        parents[p.url] = p
       end
 
       @pages.values.each do |p|
-        path = File.dirname p.path
-        path = File.dirname path if p.index?
+        path = p.parent_url
+
+        parent = nil
+        begin
+          path = File.join File.dirname(path), "index.html"
+          parent = parents[path]
+          path = File.dirname path
+        end until parent or path == "/"
 
-        parent = parents[path]
         next unless parent and parent != p and p.url =~ /html$/
+
         p.parent = parent
         parent.subpages << p
       end
@@ -225,7 +233,6 @@ module Zenweb
       @pages.values.each do |p|
         unless p.subpages.empty? then
           sorted = p.subpages.sort_by(&:clean_url)
-          sorted = sorted.reverse if sorted.first.dated_path?
           p.subpages.replace sorted
         end
       end

data/test/test_zenweb_page.rb

@@ -30,6 +30,139 @@ class TestZenwebPage < Minitest::Test
     return p1, p2
   end
 
+  def setup_complex_website
+    self.site = Zenweb::Site.new
+
+    pages = %w[
+      index.html.md
+      blog/index.html.md
+      blog/2014-01-01-first.html.md
+      blog/2014-02-02-second.html.md
+      blog/2014-03-03-third.html.md
+    ]
+
+    build_fake_site(*pages)
+
+    site.pages["index.html.md"]
+  end
+
+  def setup_complex_website2 skip_monthly = false
+    self.site = Zenweb::Site.new
+
+    pages = %w[
+      index.html.md
+      ruby/index.html.md
+      ruby/notes.html.md
+      ruby/quickref.html.md
+      blog/2014/index.html.md
+      blog/2014/01/index.html.md
+      blog/2014-01-01-first.html.md
+      blog/2014/02/index.html.md
+      blog/2014-02-02-second.html.md
+      blog/2014/03/index.html.md
+      blog/2014-03-03-third.html.md
+      blog/index.html.md
+    ]
+
+    pages.reject! { |s| s =~ /blog.2.*index/ } if skip_monthly
+
+    build_fake_site(*pages)
+
+    site.pages["index.html.md"]
+  end
+
+  def test_all_subpages
+    top = setup_complex_website2
+    sp  = site.pages
+    exp = [[sp["blog/index.html.md"],
+            [[sp["blog/2014/index.html.md"],
+              [[sp["blog/2014/01/index.html.md"],
+                [[sp["blog/2014-01-01-first.html.md"], []]]],
+               [sp["blog/2014/02/index.html.md"],
+                [[sp["blog/2014-02-02-second.html.md"], []]]],
+               [sp["blog/2014/03/index.html.md"],
+                [[sp["blog/2014-03-03-third.html.md"], []]]]]]]],
+           [sp["ruby/index.html.md"],
+            [[sp["ruby/notes.html.md"], []],
+             [sp["ruby/quickref.html.md"], []]]]]
+
+    assert_equal exp, top.all_subpages
+  end
+
+  make_my_diffs_pretty!
+
+  def test_all_subpages_reversed
+    top = setup_complex_website2
+    sp  = site.pages
+
+    exp = [[sp["blog/index.html.md"],
+            [[sp["blog/2014/index.html.md"],
+              [[sp["blog/2014/03/index.html.md"],
+                [[sp["blog/2014-03-03-third.html.md"], []]]],
+               [sp["blog/2014/02/index.html.md"],
+                [[sp["blog/2014-02-02-second.html.md"], []]]],
+               [sp["blog/2014/01/index.html.md"],
+                [[sp["blog/2014-01-01-first.html.md"], []]]]]]]],
+           [sp["ruby/index.html.md"],
+            [[sp["ruby/notes.html.md"], []],
+             [sp["ruby/quickref.html.md"], []]]]]
+
+    assert_equal exp, top.all_subpages(true)
+  end
+
+  def test_all_subpages_complex_reversed
+    top = setup_complex_website2
+    sp = site.pages
+
+    exp = [[sp["blog/index.html.md"],
+            [[sp["blog/2014/index.html.md"],
+              [[sp["blog/2014/03/index.html.md"],
+                [[sp["blog/2014-03-03-third.html.md"], []]]],
+               [sp["blog/2014/02/index.html.md"],
+                [[sp["blog/2014-02-02-second.html.md"], []]]],
+               [sp["blog/2014/01/index.html.md"],
+                [[sp["blog/2014-01-01-first.html.md"], []]]]]]]],
+           [sp["ruby/index.html.md"],
+            [[sp["ruby/notes.html.md"], []],
+             [sp["ruby/quickref.html.md"], []]]]]
+    assert_equal exp, top.all_subpages(true)
+  end
+
+  def test_sitemap_complex_no_dates # TODO: move to markdown tests
+    top = setup_complex_website2
+
+    exp = "* [Title for blog/index.html.md](/blog/)
+  * [Title for blog/2014/index.html.md](/blog/2014/)
+    * [Title for blog/2014/03/index.html.md](/blog/2014/03/)
+      * [Title for blog/2014-03-03-third.html.md](/blog/2014/03/03/third.html)
+    * [Title for blog/2014/02/index.html.md](/blog/2014/02/)
+      * [Title for blog/2014-02-02-second.html.md](/blog/2014/02/02/second.html)
+    * [Title for blog/2014/01/index.html.md](/blog/2014/01/)
+      * [Title for blog/2014-01-01-first.html.md](/blog/2014/01/01/first.html)
+* [Title for ruby/index.html.md](/ruby/)
+  * [Title for ruby/notes.html.md](/ruby/notes.html)
+  * [Title for ruby/quickref.html.md](/ruby/quickref.html)"
+
+    assert_equal exp, top.sitemap(false)
+  end
+
+  def test_sitemap_title_dated_no_monthlies # TODO: move to markdown tests
+    top = setup_complex_website2 :skip_monthly
+
+    exp = "* [Title for blog/index.html.md](/blog/)
+  * 2014-03:
+    * [Title for blog/2014-03-03-third.html.md](/blog/2014/03/03/third.html)
+  * 2014-02:
+    * [Title for blog/2014-02-02-second.html.md](/blog/2014/02/02/second.html)
+  * 2014-01:
+    * [Title for blog/2014-01-01-first.html.md](/blog/2014/01/01/first.html)
+* [Title for ruby/index.html.md](/ruby/)
+  * [Title for ruby/notes.html.md](/ruby/notes.html)
+  * [Title for ruby/quickref.html.md](/ruby/quickref.html)"
+
+    assert_equal exp, top.sitemap(:title_dated)
+  end
+
   def test_body
     assert_equal "Not really much here to see.", page.body
   end
@@ -279,9 +412,9 @@ class TestZenwebPage < Minitest::Test
 
     page = site.pages["blog/index.html.erb"]
     act = page.subpages
-    exp = [site.pages["blog/2012-01-04-page3.html.md"],
+    exp = [site.pages["blog/2012-01-02-page1.html.md"],
            site.pages["blog/2012-01-03-page2.html.md"],
-           site.pages["blog/2012-01-02-page1.html.md"]]
+           site.pages["blog/2012-01-04-page3.html.md"]]
 
     assert_equal exp, act
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zenweb
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Ryan Davis
@@ -10,9 +10,9 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDPjCCAiagAwIBAgIBATANBgkqhkiG9w0BAQUFADBFMRMwEQYDVQQDDApyeWFu
+  MIIDPjCCAiagAwIBAgIBAjANBgkqhkiG9w0BAQUFADBFMRMwEQYDVQQDDApyeWFu
   ZC1ydWJ5MRkwFwYKCZImiZPyLGQBGRYJemVuc3BpZGVyMRMwEQYKCZImiZPyLGQB
-  GRYDY29tMB4XDTEzMDkxNjIzMDQxMloXDTE0MDkxNjIzMDQxMlowRTETMBEGA1UE
+  GRYDY29tMB4XDTE0MDkxNzIzMDcwN1oXDTE1MDkxNzIzMDcwN1owRTETMBEGA1UE
   AwwKcnlhbmQtcnVieTEZMBcGCgmSJomT8ixkARkWCXplbnNwaWRlcjETMBEGCgmS
   JomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALda
   b9DCgK+627gPJkB6XfjZ1itoOQvpqH1EXScSaba9/S2VF22VYQbXU1xQXL/WzCkx
@@ -22,14 +22,14 @@ cert_chain:
   qhtV7HJxNKuPj/JFH0D2cswvzznE/a5FOYO68g+YCuFi5L8wZuuM8zzdwjrWHqSV
   gBEfoTEGr7Zii72cx+sCAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
   HQYDVR0OBBYEFEfFe9md/r/tj/Wmwpy+MI8d9k/hMA0GCSqGSIb3DQEBBQUAA4IB
-  AQCFZ7JTzoy1gcG4d8A6dmOJy7ygtO5MFpRIz8HuKCF5566nOvpy7aHhDDzFmQuu
-  FX3zDU6ghx5cQIueDhf2SGOncyBmmJRRYawm3wI0o1MeN6LZJ/3cRaOTjSFy6+S6
-  zqDmHBp8fVA2TGJtO0BLNkbGVrBJjh0UPmSoGzWlRhEVnYC33TpDAbNA+u39UrQI
-  ynwhNN7YbnmSR7+JU2cUjBFv2iPBO+TGuWC+9L2zn3NHjuc6tnmSYipA9y8Hv+As
-  Y4evBVezr3SjXz08vPqRO5YRdO3zfeMT8gBjRqZjWJGMZ2lD4XNfrs7eky74CyZw
-  xx3n58i0lQkBE1EpKE0lFu/y
+  AQAFoDJRokCQdxFfOrmsKX41KOFlU/zjrbDVM9hgB/Ur999M6OXGSi8FitXNtMwY
+  FVjsiAPeU7HaWVVcZkj6IhINelTkXsxgGz/qCzjHy3iUMuZWw36cS0fiWJ5rvH+e
+  hD7uXxJSFuyf1riDGI1aeWbQ74WMwvNstOxLUMiV5a1fzBhlxPqb537ubDjq/M/h
+  zPUFPVYeL5KjDHLCqI2FwIk2sEMOQgjpXHzl+3NlD2LUgUhHDMevmgVua0e2GT1B
+  xJcC6UN6NHMOVMyAXsr2HR0gRRx4ofN1LoP2KhXzSr8UMvQYlwPmE0N5GQv1b5AO
+  VpzF30vNaJK6ZT7xlIsIlwmH
   -----END CERTIFICATE-----
-date: 2014-06-17 00:00:00.000000000 Z
+date: 2014-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -113,14 +113,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '5.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '5.4'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -141,14 +141,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
 description: |-
   Zenweb is a set of classes/tools for organizing and formating a
   website. It is website oriented rather than webpage oriented, unlike
@@ -259,7 +259,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Zenweb is a set of classes/tools for organizing and formating a website