fuzzy_notes 0.0.1 → 0.0.2

data/bin/fnote

@@ -1,5 +1,8 @@
 #!/usr/bin/env ruby
 
+# test without installing gem
+#$LOAD_PATH.unshift "#{File.dirname(File.expand_path(__FILE__))}/../lib/"
+
 require 'optparse'
 require 'yaml'
 require 'rubygems'
@@ -8,7 +11,6 @@ require 'fuzzy_notes'
 CONFIG_PATH = "#{ENV['HOME']}/.fuzzy_notes"
 
 options = {}
-need_extra_args = [:print, :edit, :encrypt, :decrypt]
 optparse = OptionParser.new do |opts|
   opts.banner = "Usage: fnote [options] [keyword1, keyword2...]"
 
@@ -26,10 +28,14 @@ optparse = OptionParser.new do |opts|
   }
 end
 
+need_extra_args = [:print, :edit, :encrypt, :decrypt]
+
 begin
   optparse.parse!(ARGV)                                                                                                                                                                                                 
+  # edit is the default action
   options[:edit] = true if options.values.compact.empty?
-  # check for extra args if necessary
+
+  # check for required args
   if need_extra_args.any? {|opt| options[opt]} && ARGV.empty?
     puts optparse
     exit
@@ -38,6 +44,8 @@ rescue OptionParser::ParseError => e
   puts optparse
 end
 
+# fetch config 
+#
 config_path = \
   options[:config] && File.exists?(options[:config]) && options[:config] ||
   File.exists?(CONFIG_PATH) && CONFIG_PATH
@@ -45,11 +53,15 @@ config_path = \
 config = config_path ? YAML::load_file(config_path) : {}
 puts "Warning: config file not found, using defaults" if config.empty?
 
+# find matching notes
+# 
 notes = FuzzyNotes::Notes.new(:log_level => (options[:verbose] || config[:verbose]) ? 0 : 1,
                               :note_paths => config[:note_paths], 
                               :full_text_search => options[:search] || config[:full_text_search],
                               :keywords => ARGV)
                              
+# perform action on matching notes 
+# 
 if options[:list] || options[:info]
   notes.info
 elsif options[:print]

data/lib/fuzzy_notes.rb

@@ -3,5 +3,6 @@ require 'rubygems'
 module FuzzyNotes; end
 
 require 'fuzzy_notes/logger'
+require 'fuzzy_notes/cipher'
 require 'fuzzy_notes/notes'
 require 'fuzzy_notes/fuzzy_finder'

data/lib/fuzzy_notes/cipher.rb

@@ -0,0 +1,37 @@
+require 'gibberish'
+
+class FuzzyNotes::Cipher
+  extend FuzzyNotes::Logger
+  private_class_method :new
+
+  def self.apply_cipher(file_paths, decrypt = false)
+    extension, action = decrypt ? ['.txt', 'dec'] : ['.enc', 'enc']
+    password = get_password
+    cipher = Gibberish::AES.new(password)
+
+    file_paths.each do |path|
+      log.info "#{action} '#{path}'"
+      pathname = File.dirname(path)
+      filename = File.basename(path, '.*')
+
+      begin
+        ciphertext = cipher.send(action, File.read(path))
+        log.debug "[debug] writing encrypted content to: #{pathname}/#{filename}#{extension}"
+        File.open("#{pathname}/#{filename}#{extension}", 'w') { |f| f << ciphertext }
+        log.debug "[debug] deleting unencrypted file: #{path}"
+        File.delete(path)
+      rescue OpenSSL::Cipher::CipherError => e
+        log.error "ERROR: #{e}"
+      end
+    end
+  end
+
+
+  def self.get_password
+    printf 'Enter password (will not be shown):'
+    `stty -echo`; password = STDIN.gets.strip;`stty echo`; puts
+    log.debug "[debug] entered password: #{password.inspect}"
+    password
+  end
+
+end

data/lib/fuzzy_notes/fuzzy_finder.rb

@@ -4,6 +4,7 @@ class FuzzyNotes::FuzzyFinder
   extend FuzzyNotes::Logger
   private_class_method :new
 
+
   def self.find(path, params = {})
     keywords, extensions, search = params.values_at(:keywords, :extensions, :full_text_search)
     match_proc = method(search ? :full_text_match? : :file_name_match?)
@@ -20,17 +21,21 @@ class FuzzyNotes::FuzzyFinder
     [all_files.sort, matching_files.sort]
   end
 
+
 private
 
+
   def self.extension_match?(file_path, extensions)
     file_name = File.basename(file_path)
     !extensions || extensions.any? {|ext| /\.#{ext}$/ === file_name }
   end
 
+
   def self.file_name_match?(file_path, keywords)
     keywords ? keywords.any? { |name| /#{name}/ === file_path } : false
   end
 
+
   def self.full_text_match?(file_path, keywords)
     if keywords && !keywords.empty?
       file_contents = File.read(file_path)
@@ -39,4 +44,5 @@ private
     end
   end
 
+
 end

data/lib/fuzzy_notes/logger.rb

@@ -1,9 +1,8 @@
 require 'buffered_logger'
 
 class FuzzyNotes::Log
-  LOG_LEVEL = 1
-
   private_class_method :new
+  LOG_LEVEL = 1
 
   def self.init_log(log_level)
     @log = BufferedLogger.new(STDOUT, log_level)
@@ -14,6 +13,7 @@ class FuzzyNotes::Log
   end
 end
 
+
 module FuzzyNotes::Logger
   def log
     FuzzyNotes::Log.log

data/lib/fuzzy_notes/notes.rb

@@ -1,5 +1,3 @@
-require 'gibberish'
-
 class FuzzyNotes::Notes
   include FuzzyNotes::Logger
 
@@ -13,40 +11,28 @@ NOTE_PATHS=[ "#{ENV['HOME']}/notes" ]
 VALID_EXTENSIONS=%w( txt enc )
 KEYWORDS = []
 
-attr_reader :notes, :all_notes
+attr_reader :matching_notes, :all_notes
 
 def initialize(params = {})
   parse_init_params(params)
+  FuzzyNotes::Log.init_log(@log_level)
+  log.debug "[debug] init attributes: \n#{attributes}"
 
-  unless @note_paths.any? { |p| File.exists?(p) }
-    log.error "ERROR: no valid note paths found"
+  unless note_paths_valid?
+    log.error "ERROR: no valid note paths found, exiting"
     exit
   end
 
-  @all_notes, @notes = \
+  @all_notes, @matching_notes = \
     FuzzyNotes::FuzzyFinder.find(@note_paths, { :keywords => @keywords, 
                                                 :extensions => @extensions,
                                                 :full_text_search => params[:full_text_search] })
 end
 
-def parse_init_params(params)
-  INIT_PARAMS.each do |param|
-    klass = self.class
-    klass.send(:attr_reader, param)
-    const_name = param.to_s.upcase
-    instance_variable_set("@#{param}", params[param] || 
-                                       (klass.const_defined?(const_name) ? klass.const_get(const_name) : nil) )
-  end
-  FuzzyNotes::Log.init_log(@log_level)
-
-  ivar_values = instance_variables.inject("") { |s, ivar| s << "  #{ivar} => #{eval(ivar).inspect}\n" }
-  log.debug "[debug] init attributes: \n#{ivar_values}"
-end
-
-
-# cat all matching notes to stdout
+# dump all matching notes to stdout
+#
 def cat
-  notes.each do |n|
+  matching_notes.each do |n|
     puts "=== #{n} ===\n\n"
     puts "#{File.read(n)}\n"
   end
@@ -54,24 +40,29 @@ end
 
 
 # edit all matching notes in EDITOR
+#
 def edit
-  exec("#{editor} #{bashify_paths(notes)}") if !notes.empty?
+  exec("#{editor} #{bashify_paths(matching_notes)}") if !matching_notes.empty?
 end
 
 
+# encrypt matching notes 
+#
 def encrypt
-  apply_cipher
+  FuzzyNotes::Cipher.apply_cipher(matching_notes)
 end
 
 
+# decrypt matching notes
+#
 def decrypt
-  apply_cipher(true)
+  FuzzyNotes::Cipher.apply_cipher(matching_notes, true)
 end
 
 
 # view WC info for all/matching notes
 def info
-  paths = bashify_paths(notes.empty? ? all_notes : notes)
+  paths = bashify_paths(matching_notes.empty? ? all_notes : matching_notes)
   puts `wc $(find #{paths} -type f)` 
 end
 
@@ -79,32 +70,23 @@ end
 private
 
 
-def apply_cipher(decrypt = false)
-  extension, action = decrypt ? ['.txt', 'dec'] : ['.enc', 'enc']
-  password = get_password
-  cipher = Gibberish::AES.new(password)
-  notes.each do |note|
-    log.info "#{action} '#{note}'"
-    pathname = File.dirname(note)
-    filename = File.basename(note, '.*')
-    begin
-      ciphertext = cipher.send(action, File.read(note))
-      log.debug "[debug] writing encrypted content to: #{pathname}/#{filename}#{extension}"
-      File.open("#{pathname}/#{filename}#{extension}", 'w') { |f| f << ciphertext }
-      log.debug "[debug] deleting unencrypted file: #{note}"
-      File.delete(note)
-    rescue OpenSSL::Cipher::CipherError => e
-      log.error "ERROR: #{e}"
-    end
+# initialize params or use defaults
+#
+def parse_init_params(params)
+  INIT_PARAMS.each do |param|
+    klass = self.class
+    klass.send(:attr_reader, param)
+    const_name = param.to_s.upcase
+    instance_variable_set("@#{param}", params[param] || 
+                                       (klass.const_defined?(const_name) ? klass.const_get(const_name) : nil) )
   end
 end
 
 
-def get_password
-  printf 'Enter password (will not be shown):'
-  `stty -echo`; password = STDIN.gets.strip;`stty echo`; puts
-  log.debug "[debug] entered password: #{password.inspect}"
-  password
+def note_paths_valid?
+  @note_paths.any? do |p| 
+    File.exists?(p) || log.info("Warning: note path '#{p}' not found")
+  end
 end
 
 
@@ -113,4 +95,10 @@ def bashify_paths(paths)
   paths.map {|n| "\"#{n}\""}.join(' ')
 end
 
+
+def attributes
+  instance_variables.inject("") { |s, ivar| s << "  #{ivar} => #{eval(ivar).inspect}\n" }
+end
+
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: fuzzy_notes
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Alex Skryl
@@ -55,10 +55,11 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/fuzzy_notes/fuzzy_finder.rb
+- lib/fuzzy_notes.rb
 - lib/fuzzy_notes/logger.rb
+- lib/fuzzy_notes/cipher.rb
 - lib/fuzzy_notes/notes.rb
-- lib/fuzzy_notes.rb
+- lib/fuzzy_notes/fuzzy_finder.rb
 - bin/fnote
 - README
 - TODO