fuzzy_notes 0.1.3 → 0.1.4

data/README.md

@@ -0,0 +1,54 @@
+## About
+
+*fuzzy_notes* is a command line document viewer with some cool features:
+
+1. Supports Emacs/Vim/MacVim and other CLI text editors
+2. Supports viewing image files using a user specified CLI viewer (eg. open, display)
+3. Fuzzy path search and full text search across one or more note directories
+4. OpenSSL encryption for text notes
+5. Evernote synchronization
+
+
+## Configuration
+
+*fuzzy_notes* looks for a ~/.fuzzy_notes config file or the -c option and a
+config file path. A config file is not required if you're ok with the default
+settings:
+
+    :editor: vim
+    :viewer: open
+    :valid_extensions: ["txt", "enc", "txt", "html", "tif", "tiff", "gif", "jpeg", "jpg", "png", "pdf"]
+    :verbose: false
+    :full_text_search: false
+    :note_paths:
+      - ~/notes
+
+An Evernote section is required in the config file in order to use the evernote sync tool
+
+    :evernote:
+      :note_path:       [local directory used to sync evernotes]
+      :username:        [evernote username]
+      :consumer_key:    [consumer key acquired through Evernote dev channel]
+      :consumer_secret: [consumer secret acquired through Evernote dev channel]
+
+You need to get a "client application" API key from [Evernote](http://www.evernote.com/about/developer/api/#key), 
+note that a "web application" API key uses OAuth to authenticate and will not work.
+
+
+## Usage
+
+    Usage: fnote [options] [keyword1, keyword2...]
+        -c, --config [CONFIG]            Specify config file
+        -t, --editor [EDITOR]            Editor of choice
+        -a, --add-path [PATH]            Add a note path to the config file
+        -r, --rm-path [PATH]             Remove a note path from the config file
+        -s, --search                     Perform a full text search when matching notes
+        -p, --preview                    Dump matching notes to stdout or preview images
+        -l, --list                       List all or matching notes
+        -i, --info                       Show stats for matching notes
+        -e, --encrypt                    Encrypt matching notes
+        -d, --decrypt                    Decrypt matching notes
+        -v, --verbose                    Enable debug output
+        -u, --update-evernotes           Synchronize evernote directory
+            --no-color                   Turn off ANSI color
+        -h, --help                       Show usage

data/TODO

@@ -1,8 +1,6 @@
 TODO
-- README
+- ability to create notes
 - ask for missing params during evernote AUTH
 - debugging output
 - figure out good output spacing
-- test suite
-- 1.9 testing
 - add a per-note password option for enc/dec

data/bin/fnote

@@ -1,6 +1,5 @@
 #!/usr/bin/env ruby
 
-# test without installing gem
 $LOAD_PATH.unshift "#{File.dirname(File.expand_path(__FILE__))}/../lib/"
 
 require 'optparse'
@@ -9,25 +8,26 @@ require 'rubygems'
 require 'fuzzy_notes'
 
 CONFIG_PATH = "#{ENV['HOME']}/.fuzzy_notes"
-OPT_ACTIONS = [:print, :list, :info, :encrypt, :decrypt, :update_evernotes].freeze
-OPT_KEYWORDS_REQUIRED = [:print, :edit, :encrypt, :decrypt].freeze
+OPT_ACTIONS = [:add_path, :rm_path, :preview, :list, :info, :encrypt, :decrypt, :update_evernotes].freeze
+OPT_KEYWORDS_REQUIRED = [:preview, :edit, :encrypt, :decrypt].freeze
 
 options = {}
 optparse = OptionParser.new do |opts|
   opts.banner = "Usage: fnote [options] [keyword1, keyword2...]"
 
-  opts.on("-c", "--config [CONFIG]", "Specify config file") { |opt| options[:config] = opt}
-  opts.on("-n", "--note-path [PATH]", "Specify config file") { |opt| options[:note_path] = opt}
-  opts.on("--editor [EDITOR]", "Editor of choice") { |opt| options[:editor] = opt}
-  opts.on("-s", "--search", "Perform a full text search when matching notes") { |opt| options[:search] = true}
-  opts.on("-p", "--print", "Dump matching notes to stdout") { |opt| options[:print] = true }
+  opts.on("-c", "--config [CONFIG]", "Specify config file") { |opt| options[:config] = opt }
+  opts.on("-t", "--editor [EDITOR]", "Editor of choice") { |opt| options[:editor] = opt }
+  opts.on("-a", "--add-path [PATH]", "Add a note path to the config file") { |opt| options[:add_path] = opt }
+  opts.on("-r", "--rm-path [PATH]", "Remove a note path from the config file") { |opt| options[:rm_path] = opt }
+  opts.on("-s", "--search", "Perform a full text search when matching notes") { |opt| options[:search] = true }
+  opts.on("-p", "--preview", "Dump matching notes to stdout or preview images") { |opt| options[:preview] = true }
   opts.on("-l", "--list", "List all or matching notes") { |opt| options[:list] = true }
-  opts.on("-i", "--info", "Show statistics for matching notes") { |opt| options[:info] = true }
+  opts.on("-i", "--info", "Show stats for matching notes") { |opt| options[:info] = true }
   opts.on("-e", "--encrypt", "Encrypt matching notes") { |opt| options[:encrypt] = true }
   opts.on("-d", "--decrypt", "Decrypt matching notes") { |opt| options[:decrypt] = true }
   opts.on("-v", "--verbose", "Enable debug output") { |opt| options[:verbose] = true }
-  opts.on("--no-color", "Turn off ANSI color") { |opt| options[:no_color] = true}
   opts.on("-u", "--update-evernotes", "Synchronize evernote directory") { |opt| options[:update_evernotes] = true }
+  opts.on("--no-color", "Turn off ANSI color") { |opt| options[:no_color] = true }
   opts.on("-h", "--help", "Show usage") { 
     puts opts 
     exit
@@ -56,11 +56,29 @@ config_path = \
 config = config_path ? YAML::load_file(config_path) : {}
 log.info("config file not found, using defaults") if config.empty?
 
-# grab notes
+# add/remove note path from config
+#
+if options[:add_path] || options[:rm_path]
+  if options[:add_path]
+    full_path = File.expand_path(options[:add_path]) 
+    config[:note_paths] = (Array(config[:note_paths]) + Array(full_path)).uniq
+    puts "added '#{full_path}' to note paths"
+  else
+    full_path = File.expand_path(options[:rm_path]) 
+    config[:note_paths].reject! { |p| p == full_path }
+    puts "removed '#{full_path}' from note paths"
+  end
+ 
+  File.open(config_path, 'w') { |f| f << config.to_yaml }
+  exit
+end
+
+# process notes
 # 
 notes = FuzzyNotes::Notes.new(:editor => options[:editor] || config[:editor],
-                              :valid_extensions => config[:valid_extensions],
-                              :note_paths => [options[:note_path] || config[:note_paths]].flatten, 
+                              :viewer => config[:viewer],
+                              :custom_extensions => config[:custom_extensions],
+                              :note_paths => config[:note_paths].flatten, 
                               :evernote_params => config[:evernote],
                               :full_text_search => options[:search] || config[:full_text_search],
                               :log_level => (options[:verbose] || config[:verbose]) ? :debug : :info,
@@ -75,12 +93,12 @@ elsif options[:update_evernotes]
   notes.evernote_sync
 elsif options[:info]
   notes.info
-elsif options[:print]
+elsif options[:preview]
   notes.cat
 elsif options[:encrypt]
   notes.encrypt
 elsif options[:decrypt]
   notes.decrypt
-else 
+else
   notes.edit
 end

data/lib/fuzzy_notes.rb

@@ -1,6 +1,3 @@
-require 'pp'
-require 'rubygems'
-
 module FuzzyNotes; end
 
 require 'fuzzy_notes/logger'
@@ -8,4 +5,6 @@ require 'fuzzy_notes/authentication'
 require 'fuzzy_notes/cipher'
 require 'fuzzy_notes/evernote_sync'
 require 'fuzzy_notes/fuzzy_finder'
+require 'fuzzy_notes/text_viewer'
+require 'fuzzy_notes/image_viewer'
 require 'fuzzy_notes/notes'

data/lib/fuzzy_notes/image_viewer.rb

@@ -0,0 +1,12 @@
+class FuzzyNotes::ImageViewer
+  IMG_EXTS = ['tif', 'tiff', 'gif', 'jpeg', 'jpg', 'png', 'pdf']
+
+  def self.display(viewer, path)
+    `#{viewer} #{path}`
+  end
+
+  def self.image?(path)
+    IMG_EXTS.include?(File.extname(path)[1..-1])
+  end
+
+end

data/lib/fuzzy_notes/notes.rb

@@ -1,37 +1,40 @@
 require 'tempfile'
 
-class FuzzyNotes::Notes
-  include FuzzyNotes::Logger
-
-module Defaults
+module FuzzyNotes::Defaults
   LOG_LEVEL   = :info
   EDITOR      = 'vim'
+  VIEWER      = 'open'
   KEYWORDS    = []
   NOTE_PATHS  = [ "#{ENV['HOME']}/notes" ]
-  VALID_EXTENSIONS = [ 'txt', 
+  FULL_TEXT_SEARCH = false
+  VALID_EXTENSIONS = [ FuzzyNotes::TextViewer::TXT_EXT, 
                        FuzzyNotes::Cipher::CIPHERTEXT_EXT, 
                        FuzzyNotes::Cipher::PLAINTEXT_EXT, 
-                       FuzzyNotes::EvernoteSync::NOTE_EXT ]
+                       FuzzyNotes::EvernoteSync::NOTE_EXT] + 
+                       FuzzyNotes::ImageViewer::IMG_EXTS
 
   def self.const_missing(*args); end
 end
 
-  VALID_PARAMS = [:log_level, :color, :editor, :note_paths, :valid_extensions, :keywords, :evernote_params].freeze
+class FuzzyNotes::Notes
+  include FuzzyNotes::Logger
+
+  VALID_PARAMS = [:log_level, :color, :editor, :viewer, :note_paths,
+                  :valid_extensions, :custom_extensions, :full_text_search,
+                  :keywords, :evernote_params].freeze
 
   attr_reader :matching_notes, :all_notes
 
   def initialize(params = {})
-    parse_init_params(params)
-    FuzzyNotes::Log.init_log(@log_level, @color)
-    log.debug "init params: \n#{inspect_instance_vars}"
-    @note_paths = prune_invalid_note_paths!
-
-    finder = FuzzyNotes::FuzzyFinder.new(@note_paths, 
-                                        { :keywords => @keywords, 
-                                          :extensions => @valid_extensions, 
-                                          :full_text_search => params[:full_text_search] })
-    @all_notes, @matching_notes = finder.files_matching_extension, finder.files_matching_all
-    @cipher = FuzzyNotes::Cipher.new
+    @params = params
+    parse_init_params
+    
+    init_logger
+    init_cipher
+    init_finder
+    
+    @all_notes = @finder.files_matching_extension 
+    @matching_notes = @finder.files_matching_all
   end
 
   # dump all matching notes to stdout
@@ -48,8 +51,10 @@ end
           decrypted_notes.shift
         elsif FuzzyNotes::EvernoteSync.evernote?(note_path)
           FuzzyNotes::EvernoteSync.sanitize_evernote(note_path)
+        elsif FuzzyNotes::ImageViewer.image?(note_path)
+          FuzzyNotes::ImageViewer.display(@viewer, note_path)
         else
-          File.read(note_path)
+          FuzzyNotes::TextViewer.read(note_path)
         end
 
       if contents
@@ -73,7 +78,7 @@ end
 
     # edit decrypted files
     unless notes_to_edit.empty?
-      system("#{editor} #{bashify_note_paths(notes_to_edit)}")
+      system("#{@editor} #{bashify_note_paths(notes_to_edit)}")
     end
 
     # reencrypt decrypted notes
@@ -127,6 +132,36 @@ end
 
 private
 
+  # initialize to params or use defaults
+  #
+  def parse_init_params
+    VALID_PARAMS.each do |param|
+      default_const = param.to_s.upcase
+
+     val = @params[param] || FuzzyNotes::Defaults.const_get(default_const)
+     instance_variable_set("@#{param}", val) 
+    end
+  end
+
+  def init_logger
+    FuzzyNotes::Log.init_log(@log_level, @color)
+  end
+
+  def init_cipher
+    @cipher = FuzzyNotes::Cipher.new
+  end
+
+  def init_finder
+    @finder = FuzzyNotes::FuzzyFinder.new(valid_note_paths, 
+                                        { :keywords => @keywords, 
+                                          :extensions => valid_extensions,
+                                          :full_text_search => @full_text_search })
+  end
+
+  def valid_extensions
+    (@valid_extensions + @custom_extensions).uniq
+  end
+
   def encrypted_notes
     @encrypted_notes ||= matching_notes.select { |note_path| FuzzyNotes::Cipher.encrypted?(note_path) }
   end
@@ -137,10 +172,11 @@ private
 
   def plaintext_notes
     @plaintext_notes ||= matching_notes.select { |note_path| !FuzzyNotes::Cipher.encrypted?(note_path) && 
-                                                             !FuzzyNotes::EvernoteSync.evernote?(note_path) }
+                                                             !FuzzyNotes::EvernoteSync.evernote?(note_path) &&
+                                                             !FuzzyNotes::ImageViewer.image?(note_path) }
   end
 
-  def prune_invalid_note_paths!
+  def valid_note_paths
     valid_paths = []
     @note_paths.each do |path| 
       if File.directory?(path) 
@@ -149,10 +185,12 @@ private
         log.warn("note path #{PATH_COLOR} #{path} #{DEFAULT_COLOR} does not exist")
       end
     end
+
     if valid_paths.empty?
       log.error "no valid note paths found, exiting"
       exit
     end
+
     valid_paths
   end
 
@@ -177,6 +215,7 @@ private
     notes << encrypted_notes if params[:encrypted]
     notes << evernote_notes if params[:evernote]
     notes << plaintext_notes if params[:plaintext]
+
     if notes.empty?
       notes << matching_notes(:all_if_empty => true)
     end
@@ -191,26 +230,4 @@ private
     (@matching_notes.empty? && params[:all_if_empty]) ? @all_notes : @matching_notes
   end
 
-  # initialize to params or use defaults
-  #
-  def parse_init_params(params)
-    VALID_PARAMS.each do |param|
-      klass = self.class
-      klass.send(:attr_reader, param)
-      default_const = param.to_s.upcase
-
-      value = \
-        if params.include?(param) 
-          params[param] 
-        else Defaults.const_get(default_const)
-        end
-     instance_variable_set("@#{param}", value) 
-    end
-  end
-
-  def inspect_instance_vars
-    instance_variables.inject("") { |s, ivar| s << "  #{ivar} => #{eval(ivar.to_s).inspect}\n" }
-  end
-
-
 end

data/lib/fuzzy_notes/text_viewer.rb

@@ -0,0 +1,8 @@
+class FuzzyNotes::TextViewer
+  FuzzyNotes::TextViewer::TXT_EXT = 'txt'
+
+  def self.read(path)
+    File.read(path)
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fuzzy_notes
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-16 00:00:00.000000000 Z
+date: 2012-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: buffered_logger
-  requirement: &70250716786780 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: 0.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *70250716786780
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: gibberish
-  requirement: &70250716786180 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70250716786180
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: evernote
-  requirement: &70250716801860 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70250716801860
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sanitize
-  requirement: &70250716801020 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +69,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70250716801020
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A note manager with fuzzy path search, full text search, evernote sync,
   and encryption capabilities
 email: rut216@gmail.com
@@ -67,11 +87,13 @@ files:
 - lib/fuzzy_notes/cipher.rb
 - lib/fuzzy_notes/evernote_sync.rb
 - lib/fuzzy_notes/fuzzy_finder.rb
+- lib/fuzzy_notes/image_viewer.rb
 - lib/fuzzy_notes/logger.rb
 - lib/fuzzy_notes/notes.rb
+- lib/fuzzy_notes/text_viewer.rb
 - lib/fuzzy_notes.rb
 - bin/fnote
-- README
+- README.md
 - TODO
 homepage: http://github.com/skryl
 licenses: []
@@ -93,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A cli note manager

data/README

@@ -1,53 +0,0 @@
-ABOUT
--------------------------------------------------------------------------
-fuzzy_notes is a command line note manager with some cool features:
-
-1. Supports Emacs/Vim/MacVim and other CLI text editors
-2. Fuzzy path search and full text search across one or more note directories
-3. OpenSSL encryption
-4. Evernote synchronization
-
-
-CONFIG
--------------------------------------------------------------------------
-
-fuzzy_notes looks for a ~/.fuzzy_notes config file or the -c option and
-overwrites the defaults with the contents of the YAML file specified. 
-
-A config file is not required if you're ok with fuzzy_note's defaults settings
-outlined below:
-
-:editor: vim
-:verbose: false
-:full_text_search: false
-:note_paths:
-  - [HOMEDIR]/notes
-
-An Evernote config section is required to use the sync tool
-
-:evernote:
-  :note_path:       [local directory used to sync evernotes]
-  :username:        [evernote username]
-  :consumer_key:    [consumer key acquired through Evernote dev channel]
-  :consumer_secret: [consumer secret acquired through Evernote dev channel]
-
-Get yourself a "client application" API key from Evernote
-(http://www.evernote.com/about/developer/api/#key), note that a "web
-application" API key uses OAuth to authenticate and will not work.
-
-
-USAGE
--------------------------------------------------------------------------
-
-fnote [options] [keyword1, keyword2...]
-  -c, --config [CONFIG]            Specify config file
-  -p, --print                      Dump matching notes to stdout
-  -l, --list                       List matching notes
-  -i, --info                       Show statistics for matching notes
-  -s, --search                     Perform a full text search when matching notes
-  -v, --verbose                    Enable debug output
-  -e, --encrypt                    Encrypt matching notes
-  -d, --decrypt                    Decrypt matching notes
-  -n, --no-color                   Turn off ANSI color
-  -u, --evernote-update            Synchronize evernote directory
-  -h, --help                       Show this message