nandoc 0.0.3 → 0.0.4

data/lib/nandoc/support/string-methods.rb

@@ -0,0 +1,56 @@
+module NanDoc
+  # @dependencies: none
+
+  module StringMethods
+    def basename_no_extension str
+      /([^\/\.]+)(?:\.[^\.\/]+)?\Z/ =~ str ? $1 : nil
+    end
+    def indent str, indent
+      str.gsub(/^/, indent)
+    end
+    def no_blank_lines str
+      str.gsub(/\n[[:space:]]*\n/, "\n")
+    end
+    def no_leading_ws str
+      str.sub(/\A[[:space:]]+/, '')
+    end
+    def no_trailing_ws str
+      str.sub(/[[:space:]]+\Z/, '')
+    end
+    def oxford_comma items, final = ' and ', &quoter
+      items = items.map(&quoter) if quoter
+      these = []
+      these.push final if items.size > 1
+      these.concat(Array.new(items.size-2,', ')) if items.size > 2
+      these.reverse!
+      items.zip(these).flatten.compact.join
+    end
+    module_function :oxford_comma
+    def quoted
+      proc{|x| "\"#{x}\"" }
+    end
+
+    #
+    # must respond to tab() and tabs()
+    # reindent a block by striping leading whitespace from lines evenly
+    # and then re-indenting each line according to our indent.
+    # this could be simpler, it has been more complicated
+    # we do it languidly because we can
+    #
+    def reindent h1, offset=0
+      indent_by = tab * (tabs+offset)
+      unindent_by = (/\A([[:space:]]+)/ =~ h1 && $1) or
+        fail('regex fail -- not sure if we need this to be so strict')
+      h2 = no_blank_lines(h1) # careful. will mess up with <pre> etc
+      return h2 if unindent_by == indent_by
+      h3 = unindent(h2, unindent_by)
+      h4 = indent(h3, indent_by)
+      h4
+    end
+
+    def unindent str, by=nil
+      by ||= (/\A([ \t]*)/ =~ str and $1 )
+      str.gsub(/^#{Regexp.escape(by)}/, '')
+    end
+  end
+end

data/lib/nandoc.rb

@@ -3,46 +3,23 @@
 
 unless Object.const_defined?('NanDoc')
 
-require 'nanoc3'
-require 'nanoc3/cli'
-
-module NanDoc
+  module NanDoc; end
   #
   # i make the D big so i can see it
   # i move my head away from the microphone when i breathe
   #
-  Root = File.expand_path('../..',__FILE__)
-end
-
-me = File.dirname(__FILE__)+'/nandoc'
-
-# order is important:
-require me + '/support-modules.rb'
-require 'treebis' # gem
-require me + '/config.rb'
-
-module NanDoc
-  Treebis::PersistentDotfile.extend_to(self,
-    './nandoc.persistent.json',
-    :file_utils => Config.file_utils
-  )
-end
-
-# order is not important: (alphabetical:)
-require me + '/commands/create-nandoc-site.rb'
-require me + '/commands/diff.rb'
-require me + '/cri-hacks.rb'
-require me + '/data-source.rb'
-require me + '/filters.rb'
-require me + '/helpers.rb'
-require me + '/item-class-hacks.rb'
 
-Nanoc3::DataSource.register ::NanDoc::DataSource, :nandoc
-Nanoc3::Filter.register ::NanDoc::Filters::General, :nandoc
 
-shared_base = Nanoc3::CLI::Base.shared_base
-shared_base.remove_command Nanoc3::CLI::Commands::CreateSite
-shared_base.add_command    NanDoc::CreateNanDocSite.new
-shared_base.add_command    NanDoc::Commands::Diff.new
+  require 'nanoc3'
+  require 'nanoc3/cli'
+  require 'treebis'
+  me = File.dirname(__FILE__)+'/nandoc'
+  require me + '/core/config.rb'
+  require me + '/hacks.rb'
+  require me + '/commands.rb'
+  # only above should be necessary for 'create site'
 
+  require me + '/helpers.rb'
+  require me + '/filters.rb'
+  require me + '/core/project.rb'
 end

data/proto/README.md

@@ -1,11 +1,13 @@
 ### Abstract
 
-This document presents three implementation alternatives of NanDoc site creation, and then explains why we are going with the one we are going with at the time of this writing.  (It was also a chance for me to experiment with markdown footnotes!)
+The target audience of this document is developers *of* nanDoc, not developers using nanDoc.
+
+This document introduces the use of [treebis](http://treebis.hipeland.org) tasks for use in representing site prototypes and generating prototype sites; and presents three implementation alternatives of NanDoc site creation, and then explains why we are going with the one we are going with at the time of this writing.  (It was also a chance for me to experiment with markdown footnotes!)
 
 
 ### Prototypes
 
-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.
+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. (maybe.)
 
 The folder called 'misc' holds one-off templates for ad-hoc stuff, maybe for helpers etc.
 

data/test/test.rb

@@ -7,6 +7,7 @@ describe 'Basic' do
   Treebis::PersistentDotfile.include_to(self, '.nandoc.persistent.json')
   include Treebis::DirAsHash
   include Treebis::Sopen2
+  include NanDoc::SpecDoc # really just loads nandoc/extlib/minitest
 
   def file_utils
     @fu ||= NanDoc::Config.file_utils

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Chip Malice
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-12 00:00:00 -04:00
+date: 2010-05-17 00:00:00 -04:00
 default_executable: nandoc
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,8 +41,8 @@ dependencies:
         segments: 
         - 0
         - 0
-        - 1
-        version: 0.0.1
+        - 2
+        version: 0.0.2
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -73,53 +73,86 @@ files:
 - doc/CREDITS.md
 - doc/FAQ.md
 - doc/FAQ/why-not-wiki.md
+- doc/PROVISO.md
 - doc/TODOs-and-BUGs.md
-- doc/bar/baz.md
-- doc/bar/bliff.md
-- doc/foo.md
-- doc/getting-started.rb
+- doc/commands/diff.md
 - doc/svg/less-fonts.svg
 - lib/nandoc.rb
+- lib/nandoc/cli.rb
+- lib/nandoc/cli/README.md
+- lib/nandoc/cli/command-methods.rb
+- lib/nandoc/cli/option-methods.rb
+- lib/nandoc/cli/option-methods/exclusive-options.rb
+- lib/nandoc/cli/option-methods/option-enum.rb
+- lib/nandoc/commands.rb
 - lib/nandoc/commands/create-nandoc-site.rb
 - lib/nandoc/commands/diff.rb
-- lib/nandoc/config.rb
-- lib/nandoc/cri-hacks.rb
-- lib/nandoc/data-source.rb
+- lib/nandoc/core/config.rb
+- lib/nandoc/core/project.rb
 - lib/nandoc/deployers/rsync.rb
+- lib/nandoc/doc/hack-free-zone-defined.md
 - lib/nandoc/erb/agent.rb
+- lib/nandoc/extlib/minitest.rb
 - lib/nandoc/filters.rb
+- lib/nandoc/filters/builtin-tags.rb
+- lib/nandoc/filters/builtin-tags/fence-dispatcher.rb
+- lib/nandoc/filters/builtin-tags/fence/terminal.rb
+- lib/nandoc/filters/builtin-tags/fences.rb
+- lib/nandoc/filters/builtin-tags/see-test.rb
+- lib/nandoc/filters/custom-tag.rb
+- lib/nandoc/filters/custom-tags.rb
+- lib/nandoc/filters/tag-parse-instance-methods.rb
+- lib/nandoc/filters/tag-parser.rb
+- lib/nandoc/hacks.rb
+- lib/nandoc/hacks/cri-hacks.rb
+- lib/nandoc/hacks/data-source.rb
+- lib/nandoc/hacks/item-class-hacks.rb
 - lib/nandoc/helpers.rb
 - lib/nandoc/helpers/menu-bouncy.rb
 - lib/nandoc/helpers/site-map.rb
 - lib/nandoc/helpers/top-nav.rb
-- lib/nandoc/item-class-hacks.rb
+- lib/nandoc/html.rb
+- lib/nandoc/html/tags.rb
 - lib/nandoc/nandoc.persistent.json
 - lib/nandoc/parse-readme.rb
 - lib/nandoc/spec-doc.rb
-- lib/nandoc/spec-doc/mini-test.rb
-- lib/nandoc/spec-doc/mini-test/spec-instance-methods.rb
+- lib/nandoc/spec-doc/agent-instance-methods.rb
+- lib/nandoc/spec-doc/code-snippet.rb
+- lib/nandoc/spec-doc/generic-agent.rb
 - lib/nandoc/spec-doc/mock-prompt.rb
-- lib/nandoc/spec-doc/support-modules.rb
+- lib/nandoc/spec-doc/parse-trace.rb
+- lib/nandoc/spec-doc/playback.rb
+- lib/nandoc/spec-doc/playback/html.rb
+- lib/nandoc/spec-doc/playback/html/foo-bar.rb
+- lib/nandoc/spec-doc/playback/players.rb
+- lib/nandoc/spec-doc/playback/players/method.rb
+- lib/nandoc/spec-doc/playback/players/ruby.rb
+- lib/nandoc/spec-doc/playback/players/terminal.rb
+- lib/nandoc/spec-doc/playback/support.rb
+- lib/nandoc/spec-doc/playback/support/playback-methods.rb
+- lib/nandoc/spec-doc/playback/support/sexp-scanner.rb
+- lib/nandoc/spec-doc/playback/terminal/color-to-html.rb
+- lib/nandoc/spec-doc/recordings.rb
+- lib/nandoc/spec-doc/ruby2ruby-standin.rb
 - lib/nandoc/spec-doc/test-case-agent.rb
-- lib/nandoc/spec-doc/test-framework-dispatcher.rb
-- lib/nandoc/spec-doc/test-framework-proxy.rb
-- lib/nandoc/support-modules.rb
+- lib/nandoc/spec-doc/test-framework/mini-test/proxy.rb
+- lib/nandoc/spec-doc/test-framework/proxy.rb
 - lib/nandoc/support/diff-proxy.rb
+- lib/nandoc/support/diff-to-string.rb
 - lib/nandoc/support/orphanage.rb
 - lib/nandoc/support/path-tardo.rb
 - lib/nandoc/support/regexp-enhance.rb
+- lib/nandoc/support/regexp.rb
+- lib/nandoc/support/secret-parent.rb
+- lib/nandoc/support/shared-attr-reader.rb
 - lib/nandoc/support/site-diff.rb
 - lib/nandoc/support/site-merge.rb
 - lib/nandoc/support/site-methods.rb
 - lib/nandoc/support/stream-colorizer.rb
+- lib/nandoc/support/string-methods.rb
 - lib/nandoc/support/treebis-extlib.rb
 - lib/nandoc/tasks.rb
 - lib/nandoc/tasks/nandoc/deploy.rake
-- lib/nandoc/test/diff-to-string.rb
-- lib/nandoc/test/minitest-extlib.rb
-- lib/nandoc/treebis/NOGIT-DOCS/NEWS.md
-- lib/nandoc/treebis/NOGIT-README.md
-- lib/nandoc/treebis/nandoc.persistent.json
 - proto/README.md
 - proto/default/Rakefile
 - proto/default/Rules
@@ -170,6 +203,6 @@ rubyforge_project: nandoc
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: hack of [nanoc3](http://nanoc.stoneship.org) to generate a static site of your ruby project from your README etc.
+summary: hack of [nanoc3](http://nanoc.stoneship.org) to generate a static site of your (command-line) ruby project from your README etc.
 test_files: 
 - test/test.rb

data/doc/bar/baz.md

@@ -1,4 +0,0 @@
-# what a crazy
-
-## way to
-write your docs

data/doc/bar/bliff.md

@@ -1,8 +0,0 @@
-# what if
-
-## you wrote
-
-all your documenation
-~~~
-like this
-~~~~

data/doc/foo.md

@@ -1,5 +0,0 @@
-i am some secret content
-### in this
-strange file
-
-see bar somehow

data/doc/getting-started.rb

@@ -1,13 +0,0 @@
-### requirements
-
-boobric foobric blaz
-~~~
-some code
-~~~
-
-
-blaff bliff bloof
-
-#### other stuff
-
-that's how you just got started

data/lib/nandoc/spec-doc/support-modules.rb

@@ -1,158 +0,0 @@
-module NanDoc
-  module SpecDoc
-    module AgentInstanceMethods
-      # share things between MockPrompt and TestCaseAgent
-
-      # we used to use first method, now we use first test_ method
-      def method_name_to_record caller
-        line = caller.detect{ |x| x =~ /in `test_/ } or fail('hack fail')
-        method = line =~ /in `(.+)'\Z/ && $1 or fail("hack fail")
-        method
-      end
-
-      def recordings
-        @recordings ||=  NanDoc::SpecDoc::Recordings.get(test_case)
-      end
-
-      def story story_name
-        method = method_name_to_record(caller)
-        rec = recordings
-        rec.add(:method, method)
-        rec.add(:story, story_name)
-        nil
-      end
-
-    end
-
-    class CodeSnippet
-      #
-      # internally this does deferred parsing of the thing
-      # a code snippet holds meta information (or maybe content)
-      # for record_ruby nandoc commands in tests.
-      #
-
-      def initialize matches_hash
-        @start_at = matches_hash
-        @stop_at = nil
-        @lines_proc = nil
-      end
-      attr_reader :start_at
-      %w(method line file).each do |meth|
-        sym = meth.to_sym
-        define_method(meth){ || @start_at[sym] }
-      end
-      def describe
-        last = method ? ":in `#{method}'" : ''
-        "#{file}:#{line}#{tail}"
-      end
-      # just hide all the lines from dumps to make irb debugging prettier
-      def file_lines
-        @lines_proc ||= begin
-          stop_at_assert    # not really appropriate here
-          same_file_assert  # not really appropriate here
-          all_lines = File.open(@start_at[:file],'r').lines.map # sure why not
-          proc{ all_lines }
-        end
-        @lines_proc.call
-      end
-      def line_start
-        @start_at[:line]
-      end
-      def line_stop
-        @stop_at[:line]
-      end
-      # @todo maybe get rid of this.  we interpolate inspects elsewhere
-      def ruby_string_raw
-        @ruby_string_raw ||= begin
-          these = all_lines[line_start..(line_stop-2)]
-          these.join('') # they have newlines already
-        end
-      end
-      def stop_at data=nil
-        data ? (@stop_at = data) : @stop_at
-      end
-    private
-      def same_file_assert
-        @stop_at[:file] == @start_at[:file] or fail("I want life to be"<<
-        " simple. start and stop files must be the same: "<<
-        ([@stop_at, @start_at].map{ |x| File.basename(x)}*' and '))
-      end
-      def stop_at_assert
-        stop_at or fail("no record_ruby_stop() found in method "<<
-        "after #{describe}")
-      end
-    end
-
-    module ParseTrace
-      #
-      # @return [Regexp] enhanced regex that parses a stack trace line
-      #
-      def parse_trace
-        @parse_trace_re ||= begin
-          re = /\A(.*):(\d+)(?::in `([^']+)')?\Z/
-          RegexpEnhance.names(re, :file, :line, :method)
-          re
-        end
-      end
-      def parse_trace_assert line
-        md = parse_trace.match(line) or
-          fail("couldn't parse trace line: #{line}")
-        h = md.to_hash
-        /\A\d+\Z/ =~ h[:line] or fail("not line: #{h[:line]}.inspect")
-        h[:line] = h[:line].to_i
-        h
-      end
-    end
-
-
-    class Recordings < Array
-      #
-      # everything that nandoc does during test runs gets written
-      # to one of these.  It's like a Sexp structure.
-      #
-
-
-      @for_test_case = {}
-
-      class << self
-        attr_accessor :for_test_case
-        def get test_case
-          @for_test_case[test_case.class] ||= new(test_case.class)
-        end
-        def report_test_case_not_found tc
-          msgs = ["no recordings found for #{tc}"]
-          msgs.join('  ')
-        end
-      end
-
-      def add name, *data
-        # this might change if we need to group by method name
-        push [name, *data]
-      end
-
-      def get_first_sexp_for_test_method meth
-        first = index([:method, meth]) or return nil
-        last = (first+1..length-1).detect do |i|
-          self[i].first == :method && self[i][1] != meth
-        end
-        last = last ? (last - 1) : (length - 1)
-        ret = self[first..last]
-        ret
-      end
-
-      def initialize test_case
-        @test_case = test_case
-      end
-
-      def note &block
-        push [:note, block]
-      end
-
-      def report_recording_not_found meth_name
-        "no recordings found for #{meth_name}"
-      end
-
-      attr_reader :test_case
-    end
-  end
-end

data/lib/nandoc/spec-doc/test-framework-dispatcher.rb

@@ -1,15 +0,0 @@
-require File.dirname(__FILE__)+'/test-framework-proxy.rb'
-
-module NanDoc
-  module SpecDoc
-    class TestFrameworkDispatcher
-      def initialize gem_root
-        require File.dirname(__FILE__)+'/mini-test.rb'
-        @the_only_proxy = SpecDoc::MiniTest::Proxy.new(gem_root)
-      end
-      def get_sexp *a
-        @the_only_proxy.get_sexp(*a)
-      end
-    end
-  end
-end