ntxt 1.0.4 → 1.0.5

data/README.rdoc

@@ -7,7 +7,7 @@ to search their text in a slightly more structured way than +grep+ 'ing.
 
 Any tags found in a block are extracted and the block is _tagged_ with them.
 All parent blocks also receive the tags of their child blocks. Thus, the 
-root block is tagged with all tags occuring in the document.
+root block is tagged with all tags occurring in the document.
 
 == Format Rules
 === Headers
@@ -40,13 +40,15 @@ is bundled into a subblock to the 2-space indented block of text.
 
 The only ways to break out of this 2-indent text is to:
 
-1. Put in an empty line.
-2. Put in a header.
-3. Indent more shallowly, such as a 1-space line.
+1. Put in an empty line. That is, a line with no indenting. A line with only
+   two spaces on it will be seen as a continuation of the 2-indent block.
+2. Indent more shallowly, such as a 1-space line.
+3. Put in a header.
 
 === Tags
 
-Lines beginning with [tag1] [tag2] are considered to have tags
+Lines beginning with [tag1] [tag2] (ignoring whitespace) are considered to 
+have tags
 +tag1+ and +tag2+. For example:
 
   Block1
@@ -61,3 +63,4 @@ And finally, <code>not a tag</code> is, well, not a tag. It does not start a lin
 Also note that you can't tag header blocks directly because the header line
 must start with = and tag lines must begin with [. Blocks inherit all their 
 child blocks' tags, though, so finding header blocks by tags is still possible.
+

data/bin/ntxt

@@ -6,12 +6,19 @@ require 'ntxt'
 require 'yaml'
 
 $configs = {
-  :cmd => 'tag',
+  :cmd => 'last',
+  :last => 1,
   :tag_string => '',
-  :filename => "#{ENV['HOME']}/notes.txt"
+
+  # Replace with command of editor. Otherwise NTXT_EDITOR and EDITOR are used.
+  :editor => nil,
+
+  # Tag printing mode describes how tags are printed.
+  :tag_print_mode => 'path',
+  :filename => File.join(ENV['HOME'], "notes.txt")
 }
 
-DEFAULT_CONFIG_FILE="#{ENV['HOME']}/.ntxtrc"
+DEFAULT_CONFIG_FILE=File.join(ENV['HOME'], ".ntxtrc")
 
 # Create or load a configuration file.
 if File.exists?(DEFAULT_CONFIG_FILE)
@@ -25,7 +32,7 @@ else
 end
 
 OptionParser.new do |opt|
-  opt.version="1.0.4"
+  opt.version="1.0.5"
 
   opt.on('--trace', 'Trace through the file printing summaries.' ) do |v|
     $configs[:cmd] = 'trace'
@@ -43,13 +50,23 @@ OptionParser.new do |opt|
     $configs[:cmd] = 'print_tags'
   end
     
-  opt.on('-t', '--tag=String', 'Search and print the give so-tagged blocks.') do |v|
+  opt.on('-t', '--tag=String', 'Print blocks with tags contaning this.') do |v|
     $configs[:cmd] = 'tag'
     $configs[:tag_string] = v
   end
   
+  opt.on('--path', 'Print the path down the tree.') do |v|
+    $configs[:tag_print_mode] = 'path'
+  end
+  opt.on('--parent', 'Print the whole parent block.') do |v|
+    $configs[:tag_print_mode] = 'parent'
+  end
+  opt.on('--leaf', 'Print only the tagged block.') do |v|
+    $configs[:tag_print_mode] = 'leaf'
+  end
+
   opt.on('-l', '--last=[Integer]', 
-    'Show the last n top-level blocks. Default is 1') do |v|
+    'Show the last n top-level blocks.') do |v|
     $configs[:cmd] = 'last'
     $configs[:last] = (v.nil?)? 1 : v.to_i
   end
@@ -72,6 +89,71 @@ def printNonEmpty(txt)
   end
 end
 
+module TagPrintModes
+
+  def self.each_matched_tag(block, tag_string)
+    block.
+      tags.
+      keys.
+      # Filter the tags we want.
+      select { |x| x.index(tag_string) }.
+
+      # Process the tags we've selected.
+      each { |tag| yield tag }
+  end
+
+  # Only print the block if the tag count == 0.
+  def self.leaf(ntxt, tag_string)
+    ntxt.walkText(
+      # Processing a block
+      lambda { |txt, depth, block| },
+      lambda do |depth, block|
+        each_matched_tag(block, tag_string) do |tag|
+          printNonEmpty(block.text) if block.tags[tag] == 0
+        end
+      end,
+      lambda { |depth, block| } )
+  end
+
+  # Print the entire parent block if the tag count == 0
+  # and the parent tag count == 1. Otherwise, print txt.
+  def self.parent(ntxt, tag_string)
+    ntxt.walkText(
+      # Processing a block
+      lambda { |txt, depth, block| },
+      lambda do |depth, block|
+        each_matched_tag(block, tag_string) do |tag|
+          if block.tags[tag] == 0 and
+             block.parent and 
+             block.parent.tags[tag] == 1
+            printNonEmpty(block.parent.text)
+          end
+        end
+      end,
+      lambda { |depth, block| } )
+  end
+
+  # Print txt always. Effectively this presents a pruned 
+  # text path of text that is tagged.
+  #
+  # This is essentially the Ntxt::Ntxt.walkText algorithm.
+  def self.path(ntxt, tag_string)
+    ntxt.walkText(
+      # Processing a block
+      lambda do |txt, depth, block|
+        each_matched_tag(block, tag_string) do |tag|
+          printNonEmpty(txt) if block.tags[tag] > 0
+        end
+      end,
+      lambda do |depth, block|
+        each_matched_tag(block, tag_string) do |tag|
+          printNonEmpty(block.text) if block.tags[tag] == 0
+        end
+      end,
+      lambda { |depth, block| } )
+  end
+end
+
 $configs[:tag_string] = ARGV.shift if ARGV.length > 0
 
 begin
@@ -86,15 +168,11 @@ when 'print_tags'
   # Notice that we are re-wrapping the tags back into square brackets.
   puts "[#{ntxt.rootBlock.tags.keys.sort.join('] [')}]"
 when 'tag'
-  ntxt.walkText(
-    lambda { |txt, depth, block|
-      printNonEmpty txt if block.tags.keys.sort.join(', ').index( $configs[:tag_string])},
-    lambda { |depth, block| },
-    lambda { |depth, block| } )
+  TagPrintModes.send($configs[:tag_print_mode], ntxt, $configs[:tag_string])
 when 'search'
   ntxt.walkText(
     lambda { |txt, depth, block|
-      printNonEmpty txt if txt && txt.index( $configs[:search_string])},
+      printNonEmpty txt if txt && txt.index($configs[:search_string])},
     lambda { |depth, block| },
     lambda { |depth, block| } )
 when 'print'
@@ -103,14 +181,16 @@ when 'print'
     lambda { |depth, block| },
     lambda { |depth, block| } )
 when 'last'
-  ntxt.rootBlock.children[-$configs[:last].. -1].each do |blk|
+  ntxt.rootBlock.children[-$configs[:last] .. -1].each do |blk|
     puts blk.text
   end
 when 'edit'
-  editor = ENV['NTXT_EDITOR'] || ENV['EDITOR']
+  editor = $configs[:editor] || ENV['NTXT_EDITOR'] || ENV['EDITOR']
 
   if editor.nil?
-    puts "Environment variable NTXT_EDITOR and EDITOR are not defined."
+    puts "No editor defined."
+    puts "No editor entry in .ntxtrc."
+    puts "No editor entry in NTXT_EDITOR or EDITOR environment variables."
   else
     system("#{editor} \"#{$configs[:filename]}\"")
   end

data/lib/ntxt/block.rb

@@ -60,9 +60,21 @@ module Ntxt
     end
     
     # Add a tag to this block and all ancestor blocks.
-    def addTag(tag)
-      @tags[tag] += 1
-      @parent.addTag(tag) if @parent
+    #
+    # A tag added to a block does not increment that block's tag count
+    # for the added tag. A tag added to the parent of a tagged block has
+    # it's tag count incremented by 1.
+    #
+    # Thus, if a tag count = 0, then this block owns the tag.
+    # 
+    # If a tag count = 1. there is 1 child block with the given tag.
+    #
+    # [tag] The tag to add.
+    # [inc] The increment value. This should always be 0
+    #       for client code.
+    def addTag(tag, inc=0)
+      @tags[tag] += inc
+      @parent.addTag(tag, 1) if @parent
     end
 
     # Return the text slice that this block refers to.

data/lib/ntxt/parser.rb

@@ -206,9 +206,7 @@ module Ntxt
         # Check if we have discovered another block in the form of an hlevel.
         hl = Parser::hlevel(line)
         
-        if hl && hl[0].to_i <= level
-          break
-        end
+        break if hl && hl[0] <= level
         
         line = state.nextLine
       end

metadata

@@ -1,74 +1,58 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ntxt
-version: !ruby/object:Gem::Version 
-  hash: 31
+version: !ruby/object:Gem::Version
+  version: 1.0.5
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 4
-  version: 1.0.4
 platform: ruby
-authors: 
+authors:
 - Sam Baskinger
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-12-09 00:00:00 Z
+date: 2013-02-25 00:00:00.000000000 Z
 dependencies: []
+description: ! 'A library and command line tool for parsing plain text into blocks
+  by
 
-description: |
-  A library and command line tool for parsing plain text into blocks by
   indentation and a simple wiki-esque == header == notation. Tagging of blocks
+
   and searching them is also supported.
 
+'
 email: basking2@yahoo.com
-executables: 
+executables:
 - ntxt
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - README.rdoc
+- lib/ntxt.rb
 - lib/ntxt/block.rb
-- lib/ntxt/parser.rb
 - lib/ntxt/ntxt.rb
-- lib/ntxt.rb
+- lib/ntxt/parser.rb
 - bin/ntxt
 homepage: http://coffeesgone.wordpress.com
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: A parser and some tools for the ntxt text block format.
 test_files: []
-