codnar 0.1.64

data/test/split_documentation_configurations.rb

@@ -0,0 +1,97 @@
+require "codnar"
+require "olag/test"
+require "test/spec"
+require "test_with_configurations"
+
+# Test the built-in split documentation configurations.
+class TestSplitDocumentationConfigurations < Test::Unit::TestCase
+
+  include Test::WithConfigurations
+  include Test::WithErrors
+  #!include Test::WithFakeFS - until FakeFS fixes the tempfile issue.
+  include Test::WithTempfile
+
+  HTML_FILE = <<-EOF.unindent #! ((( html
+    <p>This is an
+    HTML file.</p>
+  EOF
+  # ))) html
+
+  def test_split_html_documentation
+    check_split_file(HTML_FILE, Codnar::Configuration::SPLIT_HTML_DOCUMENTATION) do |path|
+      [ {
+        "name" => path,
+        "locations" => [ { "file" => path, "line" => 1 } ],
+        "containers" => [],
+        "contained" => [],
+        "html" => HTML_FILE.chomp
+      } ]
+    end
+  end
+
+  PRE_FILE = <<-EOF.unindent
+    This is a preformatted
+    raw text file.
+  EOF
+
+  def test_split_pre_documentation
+    check_split_file(PRE_FILE, Codnar::Configuration::SPLIT_PRE_DOCUMENTATION) do |path|
+      [ {
+        "name" => path,
+        "locations" => [ { "file" => path, "line" => 1 } ],
+        "containers" => [],
+        "contained" => [],
+        "html" => "<pre class='doc'>\n" + PRE_FILE + "</pre>"
+      } ]
+    end
+  end
+
+  MARKUP_FILE = <<-EOF.unindent
+    This is a
+    *marked-up* file.
+  EOF
+
+  RDOC_HTML = <<-EOF.unindent.chomp #! ((( html
+    <div class='rdoc doc markup'>
+    <p>
+    This is a <b>marked-up</b> file.
+    </p>
+    </div>
+  EOF
+  # ))) html
+
+  def test_split_rdoc_documentation
+    check_split_file(MARKUP_FILE, Codnar::Configuration::SPLIT_RDOC_DOCUMENTATION) do |path|
+      [ {
+        "name" => path,
+        "locations" => [ { "file" => path, "line" => 1 } ],
+        "containers" => [],
+        "contained" => [],
+        "html" => RDOC_HTML,
+      } ]
+    end
+  end
+
+  MARKDOWN_HTML = <<-EOF.unindent.chomp #! ((( html
+    <div class='markdown doc markup'>
+    <p>
+    This is a
+    <em>marked-up</em> file.
+    </p>
+    </div>
+  EOF
+  #! ))) html
+
+  def test_split_markdown_documentation
+    check_split_file(MARKUP_FILE, Codnar::Configuration::SPLIT_MARKDOWN_DOCUMENTATION) do |path|
+      [ {
+        "name" => path,
+        "locations" => [ { "file" => path, "line" => 1 } ],
+        "containers" => [],
+        "contained" => [],
+        "html" => MARKDOWN_HTML,
+      } ]
+    end
+  end
+
+end

data/test/split_simple_comment_configurations.rb

@@ -0,0 +1,50 @@
+require "codnar"
+require "olag/test"
+require "test/spec"
+require "test_with_configurations"
+
+# Test built-in split simple comment configurations.
+class TestSplitSimpleCommentsConfigurations < Test::Unit::TestCase
+
+  include Test::WithConfigurations
+  include Test::WithErrors
+  include Test::WithTempfile
+
+  def test_custom_comments
+    check_any_comment("!", Codnar::Configuration::CLASSIFY_SIMPLE_COMMENTS.call("!"))
+  end
+
+  def test_shell_comments
+    check_any_comment("#", Codnar::Configuration::CLASSIFY_SHELL_COMMENTS.call)
+  end
+
+  def test_cpp_comments
+    check_any_comment("//", Codnar::Configuration::CLASSIFY_CPP_COMMENTS.call)
+  end
+
+protected
+
+  # The "?" will be replaced by the simple comment prefix.
+  ANY_COMMENT_CODE = <<-EOF.unindent
+    ?
+    ? Comment
+    Code
+    ?! Not comment
+  EOF
+
+  def check_any_comment(prefix, configuration)
+    check_split_file(ANY_COMMENT_CODE.gsub("?", prefix),
+                     Codnar::Configuration::CLASSIFY_SOURCE_CODE.call("any"),
+                     Codnar::Configuration::FORMAT_PRE_COMMENTS,
+                     configuration) do |path|
+      [ {
+        "name" => path,
+        "locations" => [ { "file" => path, "line" => 1 } ],
+        "containers" => [],
+        "contained" => [],
+        "html" => "<pre class='comment'>\n\nComment\n</pre>\n<pre class='code'>\nCode\n#{prefix}! Not comment\n</pre>"
+      } ]
+    end
+  end
+
+end

data/test/sunlight_highlight_syntax.rb

@@ -0,0 +1,25 @@
+require "codnar"
+require "test/spec"
+
+# Test highlighting syntax using Sunlight.
+class TestSunlightHighlightSyntax < Test::Unit::TestCase
+
+  def test_sunlight_lines
+    Codnar::Sunlight.lines_to_html([
+      { "kind" => "ruby_code", "number" => 1, "indentation" => "",   "payload" => "def foo"  },
+      { "kind" => "ruby_code", "number" => 2, "indentation" => "  ", "payload" => "return 1" },
+      { "kind" => "ruby_code", "number" => 3, "indentation" => "",   "payload" => "end"      },
+    ], "ruby").should == [
+      { "kind" => "html", "number" => 1,
+        "payload" => <<-EOF.unindent.chomp
+          <pre class='sunlight-highlight-ruby'>
+          def foo
+            return 1
+          end
+          </pre>
+        EOF
+      },
+    ]
+  end
+
+end

data/test/weave_configurations.rb

@@ -0,0 +1,144 @@
+require "codnar"
+require "olag/test"
+require "test/spec"
+
+# Test the built-in weave configurations.
+class TestWeaveConfigurations < Test::Unit::TestCase
+
+  include Test::WithErrors
+  include Test::WithFakeFS
+
+  def test_weave_file
+    Codnar::Writer.write("chunks", {
+      "locations" => [ "file" => "chunk" ], "containers" => [], "contained" => [],
+      "name" => "Top", "html" => <<-EOF.unindent,
+        <h1>Top</h1>
+        <embed src="path" type="x-codnar/file"/>
+      EOF
+    })
+    File.open("path", "w") { |file| file.puts("<h2>File</h2>") }
+    html = Codnar::Weaver.new(@errors, [ "chunks" ], Codnar::Configuration::WEAVE_INCLUDE).weave("include", "top")
+    @errors.should == []
+    html.should == <<-EOF.unindent
+      <h1>Top</h1>
+      <h2>File</h2>
+    EOF
+  end
+
+  def test_weave_include
+    Codnar::Writer.write("chunks", chunks("include"))
+    html = Codnar::Weaver.new(@errors, [ "chunks" ], Codnar::Configuration::WEAVE_INCLUDE).weave("include", "top")
+    @errors.should == []
+    html.should == <<-EOF.unindent #! ((( html
+      <h1>Top</h1>
+      <h2>Intermediate</h2>
+      <h3>Bottom</h3>
+    EOF
+    #! ))) html
+  end
+
+  WOVEN_PLAIN_CHUNK = <<-EOF.unindent #! ((( html
+    <div class="plain chunk">
+    <a name="top"/>
+    <h1>Top</h1>
+    <div class="plain chunk">
+    <a name="intermediate"/>
+    <h2>Intermediate</h2>
+    <div class="plain chunk">
+    <a name="bottom"/>
+    <h3>Bottom</h3>
+    </div>
+    </div>
+    </div>
+  EOF
+  #! ))) html
+
+  def test_weave_plain_chunk
+    Codnar::Writer.write("chunks", chunks("plain_chunk"))
+    html = Codnar::Weaver.new(@errors, [ "chunks" ], Codnar::Configuration::WEAVE_PLAIN_CHUNK).weave("plain_chunk", "top")
+    @errors.should == []
+    html.should == WOVEN_PLAIN_CHUNK
+  end
+
+  # Normally, one does not nest named_chunk_with_containers chunks this
+  # way, but it serves as a test.
+  WOVEN_NAMED_CHUNK = <<-EOF.unindent #! ((( html
+    <div class="named_with_containers chunk">
+    <div class="chunk name">
+    <a name="top">
+    <span>Top</span>
+    </a>
+    </div>
+    <div class="chunk html">
+    <h1>Top</h1>
+    <div class="named_with_containers chunk">
+    <div class="chunk name">
+    <a name="intermediate">
+    <span>Intermediate</span>
+    </a>
+    </div>
+    <div class="chunk html">
+    <h2>Intermediate</h2>
+    <div class="named_with_containers chunk">
+    <div class="chunk name">
+    <a name="bottom">
+    <span>BOTTOM</span>
+    </a>
+    </div>
+    <div class="chunk html">
+    <h3>Bottom</h3>
+    </div>
+    <div class="chunk containers">
+    <span class="chunk containers header">Contained in:</span>
+    <ul class="chunk containers">
+    <li class="chunk container">
+    <a class="chunk container" href="#intermediate">Intermediate</a>
+    </li>
+    </ul>
+    </div>
+    </div>
+    </div>
+    <div class="chunk containers">
+    <span class="chunk containers header">Contained in:</span>
+    <ul class="chunk containers">
+    <li class="chunk container">
+    <a class="chunk container" href="#top">Top</a>
+    </li>
+    </ul>
+    </div>
+    </div>
+    </div>
+    </div>
+  EOF
+  #! ))) html
+
+  def test_weave_named_chunk_with_containers
+    Codnar::Writer.write("chunks", chunks("named_chunk_with_containers"))
+    weaver = Codnar::Weaver.new(@errors, [ "chunks" ], Codnar::Configuration::WEAVE_NAMED_CHUNK_WITH_CONTAINERS)
+    html = weaver.weave("named_chunk_with_containers", "top")
+    @errors.should == []
+    html.should == WOVEN_NAMED_CHUNK
+  end
+
+protected
+
+  def chunks(template)
+    return [
+      { "locations" => [ "file" => "chunk" ], "containers" => [ "Intermediate" ], "contained" => [],
+        "name" => "BOTTOM", "html" => "<h3>Bottom</h3>\n", },
+      { "locations" => [ "file" => "chunk" ], "containers" => [ "Top" ], "contained" => [ "BOTTOM" ],
+        "name" => "Intermediate", "html" => <<-EOF.unindent, #! ((( html
+          <h2>Intermediate</h2>
+          <embed type='x-codnar/#{template}' src='bottom'>
+          </embed>
+        EOF
+      }, { #! ))) html
+        "locations" => [ "file" => "chunk" ], "containers" => [], "contained" => [ "Intermediate" ],
+        "name" => "Top", "html" => <<-EOF.unindent, #! ((( html
+          <h1>Top</h1>
+          <embed src="##INTERMEDIATE" type="x-codnar/#{template}"/>
+        EOF
+    } ] #! ))) html
+  end
+
+end

data/test/write_chunks.rb

@@ -0,0 +1,28 @@
+require "codnar"
+require "olag/test"
+require "test/spec"
+
+# Test writing chunks to files.
+class TestWriteChunks < Test::Unit::TestCase
+
+  include Test::WithFakeFS
+
+  def test_write_chunks
+    check_writing_data([])
+    check_writing_data("name" => "foo")
+    check_writing_data([ { "name" => "foo" }, { "name" => "bar" } ])
+  end
+
+  def test_write_invalid_data
+    lambda { check_writing_data("not a chunk") }.should.raise
+  end
+
+protected
+
+  def check_writing_data(data)
+    Codnar::Writer.write("path", data)
+    data = [ data ] unless Array === data
+    YAML.load_file("path").should == data
+  end
+
+end

metadata

@@ -0,0 +1,363 @@
+--- !ruby/object:Gem::Specification 
+name: codnar
+version: !ruby/object:Gem::Version 
+  hash: 155
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 64
+  version: 0.1.64
+platform: ruby
+authors: 
+- Oren Ben-Kiki
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-22 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: andand
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rdiscount
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: olag
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: Saikuro
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: codnar
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: fakefs
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: flay
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: reek
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id011
+- !ruby/object:Gem::Dependency 
+  name: roodi
+  prerelease: false
+  requirement: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id012
+- !ruby/object:Gem::Dependency 
+  name: test-spec
+  prerelease: false
+  requirement: &id013 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id013
+description: Code Narrator (Codnar) is an inverse literate programming tool. It splits the source files into "chunks" (including structured comments) and weaves them back into a narrative that describes the overall system.
+email: rubygems-oren@ben-kiki.org
+executables: 
+- codnar-split
+- codnar-weave
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+- ChangeLog
+files: 
+- lib/codnar/application.rb
+- lib/codnar/cache.rb
+- lib/codnar/data/contents.js
+- lib/codnar/data/control_chunks.js
+- lib/codnar/data/style.css
+- lib/codnar/data/sunlight/css-min.js
+- lib/codnar/data/sunlight/default.css
+- lib/codnar/data/sunlight/javascript-min.js
+- lib/codnar/data/sunlight/min.js
+- lib/codnar/data/sunlight/README.txt
+- lib/codnar/data/sunlight/ruby-min.js
+- lib/codnar/data/yui/base.css
+- lib/codnar/data/yui/README.txt
+- lib/codnar/data/yui/reset.css
+- lib/codnar/formatter.rb
+- lib/codnar/grouper.rb
+- lib/codnar/gvim.rb
+- lib/codnar/hash_extensions.rb
+- lib/codnar/markdown.rb
+- lib/codnar/merger.rb
+- lib/codnar/rake/split_task.rb
+- lib/codnar/rake/weave_task.rb
+- lib/codnar/rake.rb
+- lib/codnar/rdoc.rb
+- lib/codnar/reader.rb
+- lib/codnar/scanner.rb
+- lib/codnar/split.rb
+- lib/codnar/splitter.rb
+- lib/codnar/split_configurations.rb
+- lib/codnar/string_extensions.rb
+- lib/codnar/sunlight.rb
+- lib/codnar/version.rb
+- lib/codnar/weave.rb
+- lib/codnar/weaver.rb
+- lib/codnar/weave_configurations.rb
+- lib/codnar/writer.rb
+- lib/codnar.rb
+- doc/logo.png
+- doc/root.html
+- doc/story.markdown
+- doc/system.markdown
+- Rakefile
+- codnar.html
+- test/cache_computations.rb
+- test/deep_merge.rb
+- test/embed_images.rb
+- test/expand_markdown.rb
+- test/expand_rdoc.rb
+- test/format_code_gvim_configurations.rb
+- test/format_code_sunlight_configurations.rb
+- test/format_comment_configurations.rb
+- test/format_lines.rb
+- test/group_lines.rb
+- test/gvim_highlight_syntax.rb
+- test/identify_chunks.rb
+- test/lib/test_with_configurations.rb
+- test/merge_lines.rb
+- test/rake_tasks.rb
+- test/read_chunks.rb
+- test/run_application.rb
+- test/run_split.rb
+- test/run_weave.rb
+- test/scan_lines.rb
+- test/split_chunk_configurations.rb
+- test/split_code.rb
+- test/split_code_configurations.rb
+- test/split_combined_configurations.rb
+- test/split_complex_comment_configurations.rb
+- test/split_documentation.rb
+- test/split_documentation_configurations.rb
+- test/split_simple_comment_configurations.rb
+- test/sunlight_highlight_syntax.rb
+- test/weave_configurations.rb
+- test/write_chunks.rb
+- bin/codnar-split
+- bin/codnar-weave
+- README.rdoc
+- LICENSE
+- ChangeLog
+homepage: https://rubygems.org/gems/codnar
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --title
+- Code Narrator 0.1.64
+- --main
+- README.rdoc
+- --line-numbers
+- --all
+- --quiet
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Code narrator - an inverse literate programming tool.
+test_files: 
+- test/cache_computations.rb
+- test/deep_merge.rb
+- test/embed_images.rb
+- test/expand_markdown.rb
+- test/expand_rdoc.rb
+- test/format_code_gvim_configurations.rb
+- test/format_code_sunlight_configurations.rb
+- test/format_comment_configurations.rb
+- test/format_lines.rb
+- test/group_lines.rb
+- test/gvim_highlight_syntax.rb
+- test/identify_chunks.rb
+- test/lib/test_with_configurations.rb
+- test/merge_lines.rb
+- test/rake_tasks.rb
+- test/read_chunks.rb
+- test/run_application.rb
+- test/run_split.rb
+- test/run_weave.rb
+- test/scan_lines.rb
+- test/split_chunk_configurations.rb
+- test/split_code.rb
+- test/split_code_configurations.rb
+- test/split_combined_configurations.rb
+- test/split_complex_comment_configurations.rb
+- test/split_documentation.rb
+- test/split_documentation_configurations.rb
+- test/split_simple_comment_configurations.rb
+- test/sunlight_highlight_syntax.rb
+- test/weave_configurations.rb
+- test/write_chunks.rb