nandoc 0.0.2 → 0.0.3

data/lib/nandoc/commands/create-nandoc-site.rb

@@ -13,11 +13,14 @@ module NanDoc
 
     def aliases; [ 'cnds', 'cns', 'cs' ] end # override create_site short!
 
-    def short_desc; 'create a nandoc site' end
+    def short_desc
+      "#{NanDoc::Config.option_prefix}create a nandoc site"
+    end
 
     def long_desc
+      prefix = NanDoc::Config.option_prefix
       <<-D.gsub(/\n +/,' ')
-      (nanDoc hack) Create a new site at the given path. This builds on the
+      #{prefix}Create a new site at the given path. This builds on the
       create_site nanoc3 command.  Please see that for more
       information.  Run this next to your README.md file.
       D
@@ -26,19 +29,26 @@ module NanDoc
     def usage; "nandoc create_nandoc_site [-m] <path>" end
 
     def option_definitions
-      [
-        { :long => 'patch-hack', :short => 'p', :argument => :none,
-          :desc => '(nanDoc hack) use files not patches when necessary' },
+      @opt_defs ||= begin
+        prefix = NanDoc::Config.option_prefix
+        [
+          { :long => 'patch-hack', :short => 'p', :argument => :none,
+            :desc => "#{prefix} use files not patches when necessary" },
 
-        { :long => 'merge-hack', :short => 'm', :argument => :none,
-          :desc =>
-            '(nanDoc hack) when site already exists do something clever'
-        },
-        { :long => 'merge-hack-reverse', :short => 'M', :argument => :none,
-          :desc =>
-            '(nanDoc hack) show the reverse diff of above.'
-        }
-      ]
+          { :long => 'merge-hack', :short => 'm', :argument => :none,
+            :desc =>
+              "#{prefix}when site already exists do something clever"
+          },
+          { :long => 'merge-hack-reverse', :short => 'M', :argument => :none,
+            :desc =>
+              "#{prefix}show the reverse diff of above."
+          },
+          { :long => 'prototype', :short=>'t', :argument => :required,
+            :default => 'default',
+            :desc => "#{prefix}the name of the site prototype to use"
+          }
+        ]
+      end
     end
 
     #
@@ -47,8 +57,13 @@ module NanDoc
     # stderr hack off.
     #
     def run(opts, args, method_opts={:_merge=>true})
+      args = store_extra_args(args)
       opts = normalize_opts opts
       run_opts_process opts
+
+      return prototype_run_without_nanoc(args) unless
+        @treebis_task.lay_over_nanoc_site?
+
       #
       # awful: see if nanoc triggers the error message about site
       # already existing, then take action
@@ -76,6 +91,10 @@ module NanDoc
     end
 
     def run_opts_process opts
+
+      # not sure where to put this
+      initiate_the_supreme_hack_of_the_standard_error_stream
+
       task_abort("you can't have both -M and -m") if
         opts[:merge_hack] && opts[:merge_hack_reverse]
       if opts[:datasource]
@@ -86,16 +105,26 @@ module NanDoc
       end
       opts[:datasource] = 'nandoc'
       @patch_hack = opts[:patch_hack]
+      prototype_determine opts
       nil
     end
     private :run_opts_process
 
   protected
 
+    def err *a
+      $stderr.puts(*a)
+    end
+
+    def my_exit
+      exit(1);
+    end
+
     #
     # see SupremeStderrHack
     #
     def initiate_the_supreme_hack_of_the_standard_error_stream
+      return if @extremely_hacked
       base = Nanoc3::CLI::Base
       return if base.instance_methods.include?("print_error_orig")
       base.send(:alias_method, :print_error_orig, :print_error)
@@ -103,8 +132,54 @@ module NanDoc
         $stderr = SupremeStderrHack.new($stderr)
         print_error_orig error
       end
+      @extremely_hacked = true
     end
 
+    def prototype_determine opts
+      proto_name = opts[:prototype] || 'default'
+      require 'nandoc/support/treebis-extlib' # experimental
+      proto_path = "#{NanDoc::Root}/proto/#{proto_name}"
+      @treebis_task = Treebis.dir_task(proto_path)
+    end
+
+    def prototype_run
+      task = @treebis_task
+      names = task.erb_variable_names
+      if names.any?
+        require 'nandoc/erb/agent'
+        Erb::Agent.process_erb_values_from_the_commandline(
+          self, task, names, @extra_args
+        )
+      end
+      task.file_utils = Config.file_utils
+      task.on(FileUtils.pwd).run(:patch_hack => @patch_hack)
+    end
+
+    def prototype_run_without_nanoc args
+      if args.empty?
+        err "missing <path> argument."
+        err usage
+        my_exit
+      end
+      if args.size > 1
+        err "Too many arguments"
+        err usage
+        my_exit
+      end
+      path = args.first
+      if File.exist?(path) && Dir[path+'/*'].any?
+        err "folder already exists (no merge yet): #{path}"
+        err usage
+        my_exit
+      end
+      if ! File.exist?(path)
+        fu = Config.file_utils
+        fu.mkdir_p(path)
+      end
+      FileUtils.cd(path) do
+        prototype_run
+      end
+    end
 
     def site_already_exists opts, args
       path = args.first
@@ -121,7 +196,14 @@ module NanDoc
       end
     end
 
-
+    def store_extra_args args
+      @extra_args = nil
+      if args.length > 1 && args[1] =~ /^-/
+        @extra_args = args[1..-1]
+        args = args[0..0]
+      end
+      args
+    end
 
     #
     # This is the crux of the whole thing: make the site as the parent
@@ -130,12 +212,9 @@ module NanDoc
     def site_populate
       initiate_the_supreme_hack_of_the_standard_error_stream
       super
-      task = Treebis.dir_task(NanDoc::Root+'/proto/default')
-      task.file_utils = Config.file_utils
-      task.on(FileUtils.pwd).run(:patch_hack => @patch_hack)
+      prototype_run
     end
 
-
     #
     # Somehow legitimize these awful hacks with an entire class
     #
@@ -194,13 +273,14 @@ module NanDoc
         when :looking_for_error_header
           if a.first && a.first.include?('/!\ ERROR /!\\')
             @state = :waiting_for_end_of_error_box
+            me = NanDoc::Config.option_prefix
             @ui.puts <<-HERE.gsub(/^ +/,'')
-           +--- /!\ ERROR /!\ --------------------------------------------+
-           | An exception occured while running nandoc. If you think this |
-           | is a bug in nandoc (likely), please report it at             |
-           | <http://github.com/hipe/nandoc/issues> -- thanks!            |
-           | (it is very likely a treebis patch failure)                  |
-           +--------------------------------------------------------------+
+        +--- /!\\ ERROR /!\\ ----------------------------------------------+
+        | An exception occured while running #{me}. If you think     |
+        | this is a bug in nanDoc (likely), please report it at          |
+        | <http://github.com/hipe/nandoc/issues> -- thanks!              |
+        | (it is very likely a treebis patch failure)                    |
+        +----------------------------------------------------------------+
            HERE
           else
             @ui.puts(*a) # probably just whitespace?

data/lib/nandoc/commands/diff.rb

@@ -12,7 +12,9 @@ module NanDoc::Commands
 
     def aliases; [ 'd' ] end
 
-    def short_desc; 'maybe push and pull some stuff (nanDoc hack)' end
+    def short_desc
+      "#{NanDoc::Config.option_prefix}maybe push and pull some stuff"
+    end
 
     def long_desc
       <<-LONG_DESC.gsub(/\n +/,' ')

data/lib/nandoc/config.rb

@@ -49,6 +49,29 @@ module NanDoc
         end
       end
     end
+
+    #
+    # Give some visual distinction of what options for a given command
+    # are a nanDoc hack
+    #
+    def option_prefix_colorized
+      "(\e[35mnanDoc\e[0m) "
+    end
+
+    def option_prefix_no_color
+      '(nanDoc hack) '
+    end
+
+    def option_prefix
+      colorize? ?
+        option_prefix_colorized :
+        option_prefix_no_color
+    end
+
+    #
+    # other parts of the app include this module to get convenience methods
+    # to some of the config nodes.
+    #
     module Accessors
       def file_utils
         NanDoc::Config.file_utils

data/lib/nandoc/erb/agent.rb

@@ -0,0 +1,95 @@
+module NanDoc::Erb
+  class Agent
+
+    #
+    # whatever weird random and fanciful things we want to do with an ERB tree
+    #
+
+    class << self
+      include NanDoc::OptsNormalizer # unnormalize_opt_keys
+
+      # put parameter values from the command line into the erb files
+      # in the task
+      #
+      # @param [?]
+      # @param [Treebis::Task] task - takes erb values
+      # @param [Array] names - the list of names it takes
+      # @param [Array] argv - ARGV or the like
+      #
+      def process_erb_values_from_the_commandline cmd, task, names, argv
+        @cmd, @task, @names, @argv = cmd, task, names, argv
+        @args = nil
+        args_none unless argv
+        args_parse
+        erb_values = args_validate
+        task.erb_values(erb_values)
+        nil
+      end
+    private
+
+      def args_none
+        err "Please provide args for the erb templates."
+        show_usage
+        my_exit
+      end
+
+      def args_parse
+        hash = {}
+        @argv.each do |str|
+          unless /\A--([-_a-z0-9]*)=(.+)\Z/ =~ str
+            err "couldn't parse #{str.inspect} -- expecting \"--foo='bar'\""
+            show_usage
+            my_exit
+          end
+          hash[normalize_opt_key($1)] = $2
+        end
+        @args = hash
+      end
+
+      def args_validate
+        args = @args.dup
+        have = {}
+        need = Hash[ @names.map{ |n| [normalize_opt_key(n), true] } ]
+        suck = []
+        args.each do |k, v|
+          if need[k]
+            have[k.to_s] = v
+            need.delete(k)
+          else
+            suck.push unnormalize_opt_key(k)
+          end
+        end
+        miss = need.keys.map{ |k| unnormalize_opt_key(k) }
+        err "unrecognized erb parameter(s): #{suck.join(' ')}" if suck.any?
+        err "missing erb parameter(s): #{miss.join(' ')}" if miss.any?
+        if miss.any? or suck.any?
+          show_usage;
+          my_exit
+        end
+        have
+      end
+
+      def err *a
+        $stderr.puts(*a)
+      end
+
+      def my_exit
+        exit(1)
+      end
+
+      def show_usage
+        err "usage: nandoc #{@cmd.name} <mysite> -- #{these_things}"
+      end
+
+      def these_things
+        names = unnormalize_opt_keys(@names)
+        vals = ['foo', 'bar', 'bizz bazz']
+        vals2 = Array.new(names.size).map{ |x| vals[ rand(vals.size) ] }
+        vals3 = names.zip(vals2)
+        vals4 = vals3.map{|(name,val)| "#{name}=\"#{val}\"" }
+        str = vals4.join(' ')
+        str
+      end
+    end
+  end
+end

data/lib/nandoc/support/treebis-extlib.rb

@@ -0,0 +1,83 @@
+module Treebis
+  #
+  # experimental additions to treebis
+  #
+
+  class BlockProbe
+    # if needed, etc
+    def initialize(&block)
+      @sexp = []
+      instance_eval(&block)
+    end
+    attr_reader :sexp
+    def method_missing name, *args
+      record = [name, *args]
+      @sexp.push record
+      nil
+    end
+  end
+
+  module PathUtils
+    def undot path
+      $1 if /^(?:\.\/)?(.+)$/ =~ path
+    end
+    def path_from_full path
+      File.join(@from, undot(path))
+    end
+    def path_from_full_assert path
+      fullpath = path_from_full(path)
+      unless File.exist?(fullpath)
+        name = respond_to?(:name) ? " #{self.name.inspect}" : ''
+        fail <<-HERE.gsub(/^ +/, '')
+          Treebis task#{name} referred to file #{path}
+          that did not exist at #{fullpath}
+        HERE
+      end
+      fullpath
+    end
+  end
+
+  class Task
+    include PathUtils
+    alias_method :initialize_orig, :initialize
+    def initialize(*a,&b)
+      initialize_orig(*a,&b)
+      sexp = reflection_sexp
+      props = sexp.select{|x| x.first == :prop }
+      set_props(props) if props.any?
+    end
+    def erb_variable_names
+      sexp = reflection_sexp
+      filenames = sexp.select{ |x| x.first == :erb }
+      names = []
+      filenames.each do |node|
+        path = path_from_full_assert(node[1])
+        names |= erb_variable_names_in_file(path)
+      end
+      names
+    end
+    def erb_variable_names_in_file path
+      content = File.read(path)
+      names = content.scan(/<%= *([_a-z0-9]+) *%>/).map{ |x| x[0] }
+      names = names.uniq
+      names
+    end
+    def prop *a
+    end
+    def reflection_sexp
+      BlockProbe.new(&@block).sexp
+    end
+  private
+    def set_props props
+      sing = class << self; self end
+      props.each do |prop|
+        val = prop[2]
+        sing.send(:define_method, prop[1]){ val }
+      end
+      nil
+    end
+    class RunContext
+      def prop(*a); end
+    end
+  end
+end

data/lib/nandoc/support-modules.rb

@@ -16,10 +16,13 @@ module NanDoc
     def normalize_opts opts
       opts = opts.dup
       opts.keys.select{|x| x.to_s.index('-') }.each do |k|
-        opts[k.to_s.gsub('-','_').to_sym] = opts.delete(k)
+        opts[normalize_opt_key(k)] = opts.delete(k)
       end
       opts
     end
+    def normalize_opt_key k
+      k.to_s.gsub('-','_').to_sym
+    end
     def unnormalize_opt_keys keys
       keys.map{|x| unnormalize_opt_key(x)}
     end

data/lib/nandoc/tasks/nandoc/deploy.rake

@@ -4,7 +4,7 @@ namespace :nandoc do
     desc "#{prefix} Upload the compiled site using rsync, shows command"
     task :rsync do
       require 'nandoc/deployers/rsync'
-      
+
       dry_run     = !!ENV['dry_run']
       config_name = ENV['config'] || :default
 

data/proto/README.md

@@ -5,7 +5,9 @@ This document presents three implementation alternatives of NanDoc site creation
 
 ### Prototypes
 
-Each folder in this folder is a 'prototype' nanoc installation. (Probably only one folder, called 'default'.)  (The folder called 'misc' holds one-off templates for ad-hoc stuff, maybe for helpers etc.)
+Almost each folder in this folder is a 'prototype' nanDoc installation.  Most users will only ever use the `default` prototype and not worry about other prototypes.
+
+The folder called 'misc' holds one-off templates for ad-hoc stuff, maybe for helpers etc.
 
 The result of each such prototype is comparable to the filetree you get from a default nanoc 'create_site' command, but altered accordingly to be a NanDoc site, whatever that will come to mean.
 
@@ -14,7 +16,7 @@ The result of each such prototype is comparable to the filetree you get from a d
 
 The prototype site(s) in this folder is probably expressed as a cangeset to an existing default filetree created by `nanoc create_site <my-site>`.  Given that the default NanDoc site is rougly 90% the same as a default Nanoc3 site ATTOTW, the author felt that it would be best to represent the default NanDoc site as a diff of the default Nanoc site.[^1]
 
-[^1]: At such time as this percentage drops significantly we will reconsider this decision.
+[^1]: At such time as this percentage drops significantly we will reconsider this decision. -- @todo this is no longer the case.
 
 Thus the changesets here are the minimal readable expression of changes we want to make to a default nanoc site tree, to alter it to be a default NanDoc
 site tree.  These changesets are expressed using a Treebis 'patch' which is some files along with a Treebis task.  (See documentation there for gory details.)

data/proto/default/config.yaml

@@ -21,12 +21,15 @@ enable_output_diff: false
 
 
 # nanDoc: here is an example deployment config node.
-# uncomment this, get it right, and try `rake deploy:rsync` from your mysite
-# directory
+# uncomment this, get it right, and try
+# `rake config={default|rubyforge} deploy:rsync` from your mysite
+# directory (or rake `nandoc:deploy:rsync` whatever that does.)
+#
 # deploy:
 #   default:
 #     dst: "hipeland.org:/var/sites/nandoc.hipeland.org"
-#
+#   rubyforge:
+#     dst: hipe@rubyforge.org:/var/www/gforge-projects/nandoc
 
 # The data sources where nanoc loads its data from. This is an array of
 # hashes; each array element represents a single data source. By default,

data/proto/default/treebis-task.rb

@@ -4,6 +4,7 @@
 # to the folder containing this file.
 
 Treebis.tasks.task(:default) do
+  prop   :lay_over_nanoc_site?, true
   # opts[:patch_hack] = true
   remove  './content/index.html' # assume we will use README.md for now.
                                  # we don't want multiple '/' @items.

data/proto/rubyforge-redirect/Rakefile

@@ -0,0 +1,2 @@
+require 'nanoc3/tasks'
+require 'nandoc/tasks'

data/proto/rubyforge-redirect/config.yaml

@@ -0,0 +1,4 @@
+# added by nanDoc (not really):
+deploy:
+  default:
+    dst: <%= rubyforge_username %>@rubyforge.org:/var/www/gforge-projects/<%= rubyforge_project_name %>

data/proto/rubyforge-redirect/output/index.html

@@ -0,0 +1,5 @@
+<html>
+<head>
+<meta HTTP-EQUIV="REFRESH" content="0; url=<%= url %>">
+</head>
+</html>

data/proto/rubyforge-redirect/treebis-task.rb

@@ -0,0 +1,10 @@
+# This is a treebis patch file for this folder and its contents.
+# See the README sibling to the folder containing this file.
+
+Treebis.tasks.task(:"rubyforge-redirect") do
+  prop    :lay_over_nanoc_site?, false
+  copy    './Rakefile'
+  erb     './config.yaml'
+  mkdir_p './output/'
+  erb     './output/index.html'
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Chip Malice
@@ -86,6 +86,7 @@ files:
 - lib/nandoc/cri-hacks.rb
 - lib/nandoc/data-source.rb
 - lib/nandoc/deployers/rsync.rb
+- lib/nandoc/erb/agent.rb
 - lib/nandoc/filters.rb
 - lib/nandoc/helpers.rb
 - lib/nandoc/helpers/menu-bouncy.rb
@@ -111,6 +112,7 @@ files:
 - lib/nandoc/support/site-merge.rb
 - lib/nandoc/support/site-methods.rb
 - lib/nandoc/support/stream-colorizer.rb
+- lib/nandoc/support/treebis-extlib.rb
 - lib/nandoc/tasks.rb
 - lib/nandoc/tasks/nandoc/deploy.rake
 - lib/nandoc/test/diff-to-string.rb
@@ -133,6 +135,10 @@ files:
 - proto/default/lib/default.rb
 - proto/default/treebis-task.rb
 - proto/misc/orphan-surrogate.md
+- proto/rubyforge-redirect/Rakefile
+- proto/rubyforge-redirect/config.yaml
+- proto/rubyforge-redirect/output/index.html
+- proto/rubyforge-redirect/treebis-task.rb
 - test/test.rb
 - README
 has_rdoc: true