noteman 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e598f1a385a1bd21e540785be4bc5475a822c1fb
-  data.tar.gz: 7cd126062f9066f2e331f012a661977add8d4d00
+  metadata.gz: 4740138c89902d9e1644021bce170a30b7a05bc3
+  data.tar.gz: 76bca57c449938f0f842b3f64692882da566811f
 SHA512:
-  metadata.gz: 74a734a10396b3a61e4ebd9920c16552ab48a9677ccae927d3da5bd5abc39c0fe1193f57180d20464df32aeaea61b4a1ae8493810f200171b5c741ea19f383fc
-  data.tar.gz: 26643fb89305db7cb9764d5271d57a725edb33ed47695516ea38ff43cb977fed1087a560e4f782b1fcacc7477b4bb8d9e6df638d5e8230193a61bbbb09859326
+  metadata.gz: 0fea16ee9eea6f44f26ad6a1ef8d9fa83e108ffabe280778bc26962f2eb7bb644e0da60d1794a2370b56120751e199fb990e1dc39af9dadb602794bc1be327af
+  data.tar.gz: 7955327d04b70d7ff0020607ab2b60bd9035ae3dc8a4f7018b13d6ec233fb9348a470de7e9fe06133af6bf214271b4a128e1d692134e7ee80623bd901645b528

data/README.md

@@ -3,10 +3,87 @@ Noteman
 
 You advanced note manager.
 
-Still in development.
+Still in development. More features are coming.
+
+## Contents
+
+- [What and why](#what-and-why)
+- [Installation](#installation)
+- [Configuration](#configuration)
+- [Usage](#usage)
+
+## What and why
+
+`noteman` is a convenient CLI for managing your plain text notes. It can search by content, tags, keywords and whatever wired stuff you can think of by extending it. There are plenty of great GUI tools to do this. E.g. [nvAlt](http://brettterpstra.com/projects/nvalt/), [Ulysses](http://www.ulyssesapp.com). The motivation behind this project is to simplify the note management process into a couple of simple command lines, and at the same time, make it possible to be crafted into a power tool if you wanted by the extensiblility it provides.
+
+## Installation
+
+Installing `noteman` is straightforward.
+
+```bash
+gem install noteman
+```
+
+## Configuration
+
+The first time you run `noteman` by invoking the command `note` will generate the config file with default values. Which looks like this.
+
+``` yaml
+---
+notes_in: "~/notes"
+view_with: marked 2
+capture_to: capture.md
+ends_with: md
+home: "~/.noteman"
+```
+
+The config file is stored in "~/.notemanrc".
+
+## Usage
+
+You can always invoke `note help` to see a list commands. But here I will describe the basic functions that current version provides.
+
+### Capture notes
+
+Capturing notes is as simple as:
+
+```bash
+note new
+```
+
+This command will open your default text editor (set in environment variable). Jot down your note, save and quit. The note will be appended onto file defined in the config `capture_to`.
+
+You also can quickly jot down a one line note without opening a text editor. E.g.
+
+```bash
+note new buy milk
+```
+
+If you want to save an URL link with the text. Use `-l` or `--link` option.
+```bash
+note new watch this video -l http://www.youtube.com
+```
+This will create a markdown style link.
+
+To view what you have captured, use this command to open the inbox.
+
+```bash
+note inbox
+```
+This command will open your `capture.md` file with the app configured in the config file. By default it is [Marked 2](http://marked2app.com/).
+
+### Find your notes
+
+Searching for notes is quick and fun.
+
+```bash
+note find
+```
+This command will bring up a search bar, and a result window (don't worry, it's still CLI). Just put down your keywords, there will be a list of results displayed instantly. Navigate through them with arrow keys(up and down). Select one with `Enter` will open the file. Or press `Esc` to quit.
 
 ## Get started with the code
 
 ```bash
 bundle install
 ```
+	

data/bin/note

@@ -29,18 +29,20 @@ command :find do |c|
       tags = []
       keywords = []
       args.each do |arg|
-        if arg.start_with? '@'
-          tags << arg.tr('@', '')
-        else
-          keywords << arg
-        end
+	if arg.start_with? '@'
+	  tags << arg.tr('@', '')
+	else
+	  keywords << arg
+	end
       end
       nm.by_tags tags
       nm.by_keywords keywords
       nm.result.each { |n| puts n.file }
     else
       note = Noteman::Finder.new.find_note
-      note.view
+      if note
+	note.view
+      end
     end
   end
 end
@@ -77,4 +79,11 @@ command :new do |c|
   end
 end
 
+desc 'Show the inbox.'
+command :inbox do |c|
+  c.action do |global_options,options,args|
+    Noteman::NoteManager.search.inbox.view
+  end
+end
+
 exit run(ARGV)

data/lib/noteman.rb

@@ -1,7 +1,12 @@
 require 'tempfile'
-require 'noteman/md_processor'
-require 'noteman/config'
-require 'noteman/display'
-require 'noteman/finder'
-require 'noteman/note'
-require 'noteman/note_manager'
+
+Gem.find_files("noteman/**/*.rb").each do |f| 
+  require f
+end
+
+Dir["#{Dir.home}/.noteman/plugins/*.rb"].each do |f|
+  require f
+end
+
+module Noteman
+end

data/lib/noteman/config.rb

@@ -2,51 +2,38 @@ require 'deep_merge'
 
 module Noteman
   module Config
-
-    CONFIG_NAME = ".notemanrc"
-
+    NOTEMAN_CONFIG = File.join(Dir.home, '.notemanrc')
     attr_reader :config
 
     def config
       if not defined? @config
         @config = read_from_file
-        @config['notes_in'] ||= "~/io"
+        @config['notes_in'] ||= "~/notes"
         @config['view_with'] ||= "Marked 2"
         @config['capture_to'] ||= "capture.md"
         @config['ends_with'] ||= "md"
-				@config['fomula'] ||= {}
-				@config['fomula']['cheatsheets'] ||= {
-					'tags' => 'cheatsheet'
-				}
-				@config['fomula']['drafts'] ||= {
-					'tags' => 'draft post',
-					'tags_bool' => 'AND'
-				}
+        @config['home'] ||= "~/.noteman"
+        # @config['state_file'] ||= "state.json"
+        # @config['dropbox_path'] ||= "/notes"
+        # @config['fomula'] ||= {}
+        # @config['fomula']['cheatsheets'] ||= {
+        #   'tags' => 'cheatsheet'
+        # }
+        # @config['fomula']['drafts'] ||= {
+        #   'tags' => 'draft post',
+        #   'tags_bool' => 'AND'
+        # }
 
-        File.open(home_config, 'w') { |yf| YAML::dump(config, yf) }
+        File.open(NOTEMAN_CONFIG, 'w') { |yf| YAML::dump(config, yf) }
+        FileUtils.mkdir_p @config['home']
       end
       @config
     end
 
-    def home_config
-      if Dir.respond_to?('home')
-        File.join(Dir.home, CONFIG_NAME)
-      else
-        File.join(File.expand_path("~"), CONFIG_NAME)
-      end
-    end
-
     def read_from_file
       c = {}
-      dir = Dir.pwd
-      while(dir != '/')
-        if File.exists? File.join(dir, CONFIG_NAME)
-          c = YAML.load_file(File.join(dir, CONFIG_NAME)).deep_merge!(c)
-        end
-        dir = File.dirname(dir)
-      end
-      if c.empty? && File.exists?(home_config)
-        c = YAML.load_file(home_config)
+      if c.empty? && File.exists?(NOTEMAN_CONFIG)
+        c = YAML.load_file(NOTEMAN_CONFIG)
       end
       c
     end

data/lib/noteman/dropbox.rb

@@ -0,0 +1,39 @@
+require 'dropbox_sdk'
+require 'fileutils'
+require 'pp'
+
+module Noteman
+  module Dropbox
+    include Config
+    APP_KEY = ''
+    APP_SECRET = ''
+
+    def sync
+      state = load_state
+      # auth
+      if not state['access_token']
+        web_auth = DropboxOAuth2FlowNoRedirect.new(APP_KEY, APP_SECRET)
+        authorize_url = web_auth.start()
+        puts "1. Go to: #{authorize_url}"
+        puts "2. Click \"Allow\" (you might have to log in first)."
+        puts "3. Copy the authorization code."
+
+        print "Enter the authorization code here: "
+        STDOUT.flush
+        auth_code = STDIN.gets.strip
+
+        access_token, user_id = web_auth.finish(auth_code)
+        puts "Link successful."
+        state['access_token'] = access_token
+      end
+
+      cursor = state['cursor']
+      access_token = state['access_token']
+      c = DropboxClient.new(access_token)
+      result = c.delta cursor, config['dropbox_path']
+      pp result
+      #save_state state
+    end
+
+  end
+end

data/lib/noteman/finder.rb

@@ -1,109 +1,113 @@
 require 'curses'
 
 module Noteman
-	class Finder
-		include Curses
+  class Finder
+    include Curses
 
-		def initialize
-			@opend = false
-		end
+    def initialize
+      @opend = false
+    end
 
-		def open
-			if @opened
-				return self
-			end
-			init_screen
-			cbreak
-			noecho
-			raw
-			@search_box = Window.new(3, cols, 0 ,0)
-			@search_box.keypad = true
-			draw_search_box
+    def open
+      if @opened
+        return self
+      end
+      init_screen
+      cbreak
+      noecho
+      raw
+      @search_box = Window.new(3, cols, 0 ,0)
+      @search_box.keypad = true
+      draw_search_box
 
-			@result_box = Window.new(30, cols, 3 ,0)
-			draw_result_box
+      @result_box = Window.new(30, cols, 3 ,0)
+      draw_result_box
 
-			@message_box = Window.new(3, cols, 40 ,0)
-			draw_message_box
+      @message_box = Window.new(3, cols, 40 ,0)
+      draw_message_box
 
-			@opened = true
-			self
-		end
+      @opened = true
+      self
+    end
 
-		def close
-			@opened = false
-			close_screen
-		end
+    def close
+      @opened = false
+      close_screen
+    end
 
-		def find_note
-			begin
-				open
-				text = ''
-				selected = 0
-				notes = []
-				while true
-					ch = @search_box.getch
-					case ch
-					when KEY_RESIZE
-						next
-					when 10 # enter
-						break
-					when 127 # backspace
-						if text.length > 0
-							text = text.slice(0, text.length - 1)
-						end
-					when KEY_UP #arrow up
-						#selected -= 1
-						selected == 0 ? selected = notes.length - 1 : selected -= 1
-					when KEY_DOWN #arrow down
-						selected == notes.length - 1 ? selected = 0 : selected += 1
-					else
-						if ch.is_a? String
-							text += ch
-						end
-					end
-					draw_search_box text
-					tags = []
-					keywords = []
-					text.split.each do |t|
-						if t.start_with? '@' and t.length > 1
-							tags << t.tr('@', '')
-						else
-							keywords << t
-						end
-					end
-					notes = NoteManager.search.by_tags(tags).by_keywords(keywords).result
-					draw_result_box notes, selected
-				end
-				notes[selected]
-			ensure
-				close
-			end
-		end
+    def find_note
+      begin
+        open
+        text = ''
+        selected = 0
+        notes = []
+        while true
+          ch = @search_box.getch
+          #draw_message_box "#{ch}"
+          case ch
+          when KEY_RESIZE
+            next
+          when 10 # enter
+            break
+          when 27 # esc
+            return
+          when 127 # backspace
+            if text.length > 0
+              text = text.slice(0, text.length - 1)
+            end
+          when KEY_UP #arrow up
+            #selected -= 1
+            selected == 0 ? selected = notes.length - 1 : selected -= 1
+          when KEY_DOWN #arrow down
+            selected == notes.length - 1 ? selected = 0 : selected += 1
+          else
+            if ch.is_a? String
+              text += ch
+            end
+          end
+          draw_search_box text
+          tags = []
+          keywords = []
+          text.split.each do |t|
+            if t.start_with? '@' and t.length > 1
+              tags << t.tr('@', '')
+            else
+              keywords << t
+            end
+          end
+          notes = NoteManager.search.by_tags(tags).by_keywords(keywords).result
+          draw_result_box notes, selected
+        end
+        notes[selected]
+      ensure
+        close
+      end
+    end
 
-		def draw_search_box(text='')
-			@search_box.clear
-			@search_box.box('|', '-')
-			@search_box.setpos(1, 1)
-			@search_box.addstr text
-			@search_box.refresh
-		end
+    def draw_search_box(text='')
+      @search_box.clear
+      @search_box.box(' ', ' ')
+      @search_box.setpos(1, 1)
+      @search_box.attrset(A_BOLD)
+      @search_box.addstr text
+      @search_box.refresh
+    end
 
-		def draw_result_box(results=[], selected_index=0)
-			@result_box.clear
-			results.each_with_index do |n, i|
-				@result_box.setpos(i+1, 1)
-				@result_box.attrset(i == selected_index ? A_STANDOUT : A_NORMAL)
-				@result_box.addstr "#{n.file}"
-			end
-			@result_box.refresh
-		end
+    def draw_result_box(results=[], selected_index=0)
+      @result_box.clear
+      results.each_with_index do |n, i|
+        @result_box.setpos(i+1, 1)
+        @result_box.attrset(i == selected_index ? A_STANDOUT : A_NORMAL)
+        @result_box.addstr "#{n.file}"
+      end
+      @result_box.refresh
+    end
 
-		def draw_message_box(text='')
-			@message_box.clear
-			@message_box.setpos(1, 1)
-			@message_box.addstr "#{text}"
-			@message_box.refresh
-		end
-	end
+    def draw_message_box(text='')
+      @message_box.clear
+      @message_box.setpos(1, 1)
+      @message_box.addstr "#{text}"
+      @message_box.refresh
+    end
+  end
 end

data/lib/noteman/note.rb

@@ -1,39 +1,39 @@
 module Noteman
-	class Note
-		include MDProcessor, Config
-		attr_accessor :content, :metadata, :tags, :body, :file
+  class Note
+    include MDProcessor, Config
+    attr_accessor :content, :metadata, :tags, :body, :file
 
-		def initialize(file)
-			@file = file
-			@content = File.read file
-			@metadata = get_metadata @content
-			@body = remove_metadata @content
-		end
+    def initialize(file)
+      @file = file
+      @content = File.read file
+      @metadata = get_metadata @content
+      @body = remove_metadata @content
+    end
     
     def tags
       @tags = []
-			if metadata and metadata['tags']
+      if metadata and metadata['tags']
         @tags = metadata['tags']
       end
       @tags
     end
 
-		def with_tags?(tags)
-			if metadata and metadata['tags']
-				if (tags - metadata['tags']).empty?
-					return true
-				end
-			end
-			false
-		end
+    def with_tags?(tags)
+      if metadata and metadata['tags']
+        if (tags - metadata['tags']).empty?
+          return true
+        end
+      end
+      false
+    end
 
-		def contains?(keywords)
-			keywords.all? { |word| body.downcase.include? word.downcase }
-		end
+    def contains?(keywords)
+      keywords.all? { |word| body.downcase.include? word.downcase }
+    end
 
     def view
-			system("open -a \"#{config['view_with']}\" #{file}")
+      system("open -a \"#{config['view_with']}\" #{file}")
     end
 
-	end
+  end
 end

data/lib/noteman/note_manager.rb

@@ -65,6 +65,10 @@ module Noteman
       end
     end
 
+    def inbox
+      notes.select { |n| n.file == config['capture_to'] }.first
+    end
+
     def choose(notes)
       if notes.length > 1
         notes.each_with_index do |note, i|

data/lib/noteman/state.rb

@@ -0,0 +1,74 @@
+module Noteman
+  module Dropbox
+    include Config
+
+    def state_file
+      File.join File.expand_path(config['home']), config['state_file']
+    end
+
+    def load_state
+      if File.exist? state_file
+        state = JSON.parse(File.read(state_file), :max_nesting => false)
+        state['tree'] = Node.from_json_content(state['tree'])
+      else
+        state = {
+          'tree' => {}
+        }
+
+        save_state state
+      end
+      state
+    end
+
+    def save_state(state)
+      state['tree'] = Node.to_json_content(state['tree'])
+      File.open(state_file,"w") do |f|
+        f.write(JSON.pretty_generate(state, :max_nesting => false))
+      end
+    end
+
+    # We track folder state as a tree of Node objects.
+    class Node
+      attr_accessor :path, :content
+      def initialize(path, content)
+        # The "original" page (i.e. not the lower-case path)
+        @path = path
+        # For files, content is a pair (size, modified)
+        # For folders, content is a hash of children Nodes, keyed by lower-case file names.
+        @content = content
+      end
+      def folder?()
+        @content.is_a? Hash
+      end
+      def to_json()
+        [@path, Node.to_json_content(@content)]
+      end
+      def self.from_json(jnode)
+        path, jcontent = jnode
+        Node.new(path, Node.from_json_content(jcontent))
+      end
+      def self.to_json_content(content)
+        if content.is_a? Hash
+          map_hash_values(content) { |child| child.to_json }
+        else
+          content
+        end
+      end
+      def self.from_json_content(jcontent)
+        if jcontent.is_a? Hash
+          map_hash_values(jcontent) { |jchild| Node.from_json jchild }
+        else
+          jcontent
+        end
+      end
+    end
+
+    # Run a mapping function over every value in a Hash, returning a new Hash.
+    def map_hash_values(h)
+      new = {}
+      h.each { |k,v| new[k] = yield v }
+      new
+    end
+
+  end
+end

data/lib/noteman/version.rb

@@ -1,3 +1,3 @@
 module Noting
-	VERSION = '0.1.0'
+	VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: noteman
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Xiaoxing Hu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-12 00:00:00.000000000 Z
+date: 2014-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,6 +38,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: gli
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +150,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: dropbox-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 description: A tool for managing your markdown notes.
 email: dawnstar.hu@gmail.com
 executables:
@@ -120,10 +176,12 @@ files:
 - lib/noteman.rb
 - lib/noteman/config.rb
 - lib/noteman/display.rb
+- lib/noteman/dropbox.rb
 - lib/noteman/finder.rb
 - lib/noteman/md_processor.rb
 - lib/noteman/note.rb
 - lib/noteman/note_manager.rb
+- lib/noteman/state.rb
 - lib/noteman/version.rb
 homepage: https://github.com/xiaoxinghu/noteman
 licenses: