whale 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10aefc6ce7f9102e028c417e9e8d7a5b2f1f1ce0
-  data.tar.gz: 7a3dcd424e6c33d208b18ae7e3a29b7d078b564d
+  metadata.gz: f6394ed84b098d65ca2be4a0dbd00904ea2d03c4
+  data.tar.gz: e402d341944f3c971d4db7b0da4ceed8ecd1f73d
 SHA512:
-  metadata.gz: 4e308539f6f2ac801178c4edb1fbabbec49ac1e31459c5d3662e96732deb7ca19a7edaa9fbabc2e1ed37b9a3449010277dd780aab335fb4699808471e8d6c5a6
-  data.tar.gz: 6653cc61f4da672de5e76f677c2845ba1b66a326333206115f57bb6b1f1658d0f5b4b256afd84bd67ad1cf942b5a41eec68087b84d524e0f980da7069321abbb
+  metadata.gz: 1d32425414eb367cb0bdd12220aaaa89bddc1cf3bd5b07f7a75867b39383875b461039feea6482e3eae34df739dbcdd5ee7b0ad8fe78a1d2708986c0942fcb5d
+  data.tar.gz: 4ba0d9abf19474b056ee134f65d650626a86fe194377a8e712a15b842797b838fbb1d82c044a0fe88e80f9f642a952a5a5aa6ca1ad7069d91729345519076351

data/bin/whale

@@ -2,20 +2,19 @@
 require 'whale'
 require 'logger'
 
-
 USAGE = <<ENDUSAGE
 Usage:
-  whale [files] [-h] [-p paths] [-r] [-f filter] [-e id] [-s tag]
+  whale [filter] [-h] [-p paths] [-r] [-f file] [-e id] [-s tag]
         [-w] [-n] [-t] [-v] [-d]
 ENDUSAGE
 
 HELP = <<ENDHELP
-  files                Space-separated list of files
+  filter               Filter to apply on the entries
   -h, --help           View this message
   -p, --paths          Colon-separated list of paths to search
   -r, --recursive      Search for files recursively
-  -f, --filter         Filter entries by tags
-  -e, --edit           Open the editor to given entry
+  -f, --file           The file to read
+  -e, --edit           Open the editor at the given entry
   -s, --sort           Sort entries by tag value
   -w, --write          Write the entries to stdout
   -n, --name           List the tag names
@@ -23,6 +22,25 @@ HELP = <<ENDHELP
   -v, --version        Show the version number
   -d, --debug          Set the logging level to debug
 
+  whale is a tool for keeping your ideas organized. Write ideas into some 
+  files and tag them with labels. whale can then filter and sort the entries
+  based on the tags. Each entry ends with one or more taglines, which consist 
+  of a semicolon followed by space-separated tags. Tags are assigned a
+  value by writing tag=value. Taglines at the beginning of the file are 
+  applied to every entry in the file.
+
+filter
+  Show entries with tags satisfying the filter. The filter is a string 
+  consisting of Ruby regexes and operators in reverse polish notation. 
+  A regex evaluates to true if at least one tag name in an entry matches it.
+  One can further match on the tag value by writing = followed by a regex.
+  Options for regexes are specified by writing in the form /(?option:regex)/.
+  The symbols for AND, OR, and NOT are &, |, and *, respectively.
+
+  Example:
+    whale "/action/ /done/ * &" gives entries with tags matching 'action' but 
+    not 'done'.
+
 -p, --paths
   Specify the paths to search. Each path is separated by a colon. Any files 
   with the .wl or .whale extension are read.
@@ -30,13 +48,8 @@ HELP = <<ENDHELP
 -r, --recursive
   Search for files recursively.
 
--f, --filter filter
-  Show entries with tags satisfying the filter. The filter is a string 
-  consisting of Ruby regexes and operators in reverse polish notation. 
-  A regex evaluates to true if at least one tag name in an entry matches it.
-  One can further match on the tag value by writing = followed by a regex.
-  Options for regexes are specified by writing /(?option:regex)/.
-  The symbols for AND, OR, and NOT are &, |, and *, respectively.
+-f, --file file
+  The file to read.
 
 -e, --edit id
   Edit the entry with id id using the text editor specified by the environment 
@@ -67,17 +80,20 @@ Environment
   WHALEPATH
     A colon separated list of default paths to search when paths is not
     provided.
+
+Installation
+  gem install whale
 ENDHELP
 
-args = { :files => [], :recursive => false }
-unflagged_args = [:files]
+args = {}
+unflagged_args = [:filter]
 next_arg = unflagged_args.first
 
 ARGV.each do |arg|
   case arg
   when '-h','--help'          then args[:help] = true
   when '-p','--paths'         then next_arg = :paths
-  when '-f','--filter'        then next_arg = :filter
+  when '-f','--file'          then next_arg = :file
   when '-e','--edit'          then next_arg = :edit
   when '-n','--name'          then args[:name] = true
   when '-t','--tags'          then next_arg = :tags
@@ -87,13 +103,9 @@ ARGV.each do |arg|
   when '-v','--version'       then args[:version] = true
   when '-d','--debug'         then args[:debug] = true
   else
-    if next_arg == :files
-      args[:files] << arg
-    else
-      args[next_arg] = arg
-      unflagged_args.delete next_arg
-      next_arg = unflagged_args.first
-    end
+    args[next_arg] = arg
+    unflagged_args.delete next_arg
+    next_arg = unflagged_args.first
   end
 end
 
@@ -107,25 +119,26 @@ if args[:version]
   exit
 end
 
+files = []
+files << args[:file] if args[:file]
 paths = []
 paths += ENV['WHALEPATH'].split(':') if ENV['WHALEPATH']
 paths += args[:paths].split(':') if args[:paths]
 
 logger.debug(paths)
 
-paths.each { |p| args[:files] += \
-  list_files_in_path(p, args[:recursive], logger) }
+paths.each { |p| files += list_files_in_path(p, args[:recursive], logger) }
 
-logger.debug(args[:files])
+logger.debug(files)
 
-if args[:help] or args[:files].empty?
+if args[:help] or files.empty?
   puts USAGE
   puts HELP if args[:help]
   exit
 end
 
 entries = []
-args[:files].each do |file| 
+files.each do |file| 
   begin
     entries += parse_file(file, logger)
   rescue Errno::ENOENT
@@ -135,12 +148,12 @@ args[:files].each do |file|
   end
 end
 
-logger.info("Parsed #{args[:files].length} files " +
+logger.info("Parsed #{files.length} files " +
             "and #{entries.length} entries")
 
 if args[:filter]
   filter = Filter.new
-  filter.pgrse_filter(args[:filter], logger)
+  filter.parse_filter(args[:filter], logger)
   filter_entries(entries, filter, logger)
 end 
 

data/lib/whale.rb

@@ -4,7 +4,7 @@ require 'set'
 require 'logger'
 
 MAJOR_VERSION = 0
-MINOR_VERSION = 1
+MINOR_VERSION = 3
 REVISION      = 0
 
 $DEFAULT_TAGS = [:title, :body, :line, :file, :tags]
@@ -130,14 +130,14 @@ end
 
 def write_entries(entries)
   entries.each do |e|
-    printf("#{e.tags[:title]}\n")
-    printf("#{e.tags[:body]}")
+    puts(e.tags[:title])
+    print("#{e.tags[:body]}")
     # extension: implement wrapping
     e.tags.each do |t, v|
       next if $DEFAULT_TAGS.find_index(t) 
-      printf(";#{t}")
-      printf("=#{v}") if v != true
-      printf("\n")
+      print(";#{t}")
+      print("=#{v}") if v != true
+      print("\n")
     end
   end
 end
@@ -198,9 +198,9 @@ end
 def list_tags(tags)
   s = ""
   tags.each do |tag|
-    s << "#{tag}, "
+    s << "#{tag} "
   end
-  puts s.slice(0, s.length - 2)
+  puts s
 end
 
 # List files in the path with the given extension
@@ -215,7 +215,7 @@ def list_files_in_path(path, recursive, logger)
 end
 
 EMPTY_LINE = /\A\s*\Z/
-LABEL_LINE = /\A;(.*)\Z/
+TAGLINE = /\A;(.*)\Z/
 
 # Extract entries from file.
 # param @file a file name to read
@@ -229,9 +229,7 @@ def parse_file(file, logger)
   File.open(file, 'r') do |f|
     f.each_line do |line|
       lineno += 1
-      # skip if the line is whitespace
-      next if EMPTY_LINE.match line
-      if (m = LABEL_LINE.match line)
+      if (m = TAGLINE.match line)
         logger.debug("#{f.path}, #{lineno}, reading tag")
         is_reading_tag = true
         matched_line = m[1]
@@ -242,6 +240,7 @@ def parse_file(file, logger)
           parse_tags entry, matched_line
         end
       elsif is_reading_tag
+        next if EMPTY_LINE.match line
         logger.debug("#{f.path}, #{lineno}, new entry")
         is_reading_tag = false
         entries << entry if !entry.nil?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: whale
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ryutaro Ikeda