cnote 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9df0e76707bb7a63ff3b121e9e0b4fa6143b66c7
+  data.tar.gz: 9950e8a6fff2d2c7de76fc9883a211b65312696e
+SHA512:
+  metadata.gz: ee7ab59688e6773eb02255983795aca1c3957f6bd49ffc8fada57862017121d833cff46d974eef1b937bb92c806878d1b755bef8e4a7365bb7ac876c813b1d84
+  data.tar.gz: 26d390e8ac70d6179dd256f6fa0e37a262fc1ff4dc26ee956c88c98b87a48b75066b04f37c37792d5edf3d13bb8e585a1f886410a4f1277c1902f8a6b691f877

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Added at 2017-09-09 01:27:23 -0700 by tony:
+gem "awesome_print", "~> 1.8"
+
+# Added at 2017-09-09 03:13:22 -0700 by tony:
+gem "colorize", "~> 0.8.1"
+
+# Specify your gem's dependencies in cnote.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Tony McCoy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,192 @@
+# CNote
+> CLI notes app for Linux (and probably macOS) ((and maybe Windows Subsystem for Linux)) written in Ruby
+
+CNote is my personal system for managing notes. I wanted something snappy and lightweight that would let me search, tag and edit a folder full of markdown files using just my keyboard and some `vim`mish single-letter commands.
+
+## Installation
+
+First of all, make sure you have a recent version of Ruby installed (including RubyGems). I'm using 2.4.0. Then run:
+
+    $ gem install cnote
+
+## Usage
+
+CNote will be installed as a command on your machine. To get started, run `cnote`. The first time you run `cnote`, you'll be walked through the basic setup process which will produce a `.cnote.yaml` file within your `$HOME` directory. To skip this, just create the file yourself. Valid options for this file are covered [here](#).
+
+```
+$ cnote
+
+Hello, new user!
+Enter the path to the folder where you would like to store your notes: _
+```
+
+Running `cnote` again will drop you into a REPL interface where you can type in commands to interact with your notes. `help` will show the complete list while the program is running.
+
+```
+$ cnote
+
+Welcome to CNote! Type 'help' or 'h' to see a list of available commands.
+> _
+```
+
+Here are the available commands:
+
+### Commands
+
+Keywords surrounded by `<these>` are placeholders. You would enter the real value yourself.
+
+#### `list`
+> Aliases: `l`, `ls`
+
+Lists *every single* note in your notes directory (recursively). This might be a lot of notes. To search for something specific, you would use the `find` command.
+
+```bash
+> list
+
+    All Notes
+    ---------
+
+1.  Note Title
+    /subfolder/some-note.md
+    tags: [pickle] [fish]
+
+2.  Note Title
+    /whatever.md
+    <no tags>
+
+3.  ...
+
+    Listed 27 Notes
+```
+
+#### `new <file_name>`
+> Aliases: `create`, `n`, `c`
+
+Creates a new note with the given filename. If you pass in a nested directory, the directory will be created relative to your `note_path` value from the configuration file.
+
+```bash
+> new general/whatever.md
+#=> creates file at '$note_path/general/whatever.md'
+
+> create note.jpg
+#=> creates file at '$note_path/note.md'
+#=> (File extension is ignored. All notes are markdown.)
+
+> c note.md
+> n note.md
+#=> All aliases do the same thing.
+```
+
+#### `edit <note_number>`
+> Aliases: `open`, `o`, `e`
+
+Opens the note file in your editor of choice, first looking for the `editor` property in your `.cnote.yaml` config file, and if that fails, uses the `EDITOR` environment variable.
+
+#### `delete <note_number(s)>`
+> Aliases: `d`, `rm`
+
+Deletes the note(s) specified by their numbers. The numbers will be whatever number appeared next to that note the last time the notes were listed.
+
+```bash
+> delete 12
+
+Are you sure you want to delete note number 12 with title 'Some Title Here'? [y/n] y
+Deleted!
+
+> _
+```
+
+#### `find <search_term>`
+> Aliases: `search`, `s`, `f`
+
+Searches and returns a list of all notes whose title or contents contain the search term. 
+
+```bash
+> find cnote
+#=> Returns a list of notes whose titles or content match the given term.
+#=> Sample output:
+
+    Found 2 Notes
+    -------------
+
+1.  CNote Commands
+    /cnote/commands.md
+    tags: [cnote] [programming]
+
+2.  CNote Sync Backends
+    /cnote/cnote-sync.md
+    <no tags>
+
+    Listed 2 Notes
+
+> find +t cnote
+#=> Returns a list of notes that include the tag 'cnote'
+#=> Sample output:
+
+    Found 1 Note
+    ------------
+
+1.  CNote Commands
+    /cnote/commands.md
+    tags: [cnote] [programming]
+
+    Listed 1 Note
+
+> find -t cnote
+#=> Returns a list of notes that DO NOT contain the tag 'cnote'
+
+> f project +t cnote
+#=> Returns a list of notes that both match the text 'project' AND contain the tag 'cnote'
+```
+
+#### `peek <note_number`
+
+Shows a short preview of the note, just to make sure it's the one you're looking for before you commit to editing, tagging, etc.
+
+```bash
+> peek 10
+> p 10
+#=> Shows the first 15 lines of note number 10
+```
+
+#### `tag <note_number(s)> <tag> <tag> <tag> ...`
+> Aliases: `t`
+
+Adds a space separated list of tags to the note specified by its list number.
+
+```bash
+> tag 15 pizza charcoal fishness
+#=> Adds ['pizza', 'charcoal', 'fishness'] to the tag list of note number 15
+
+> tag 4,17 double_tag
+#=> Adds 'double_tag' to the tag lists of BOTH notes 4 and 17.
+```
+
+#### `untag <note_number(s)> <tag> <tag> ...`
+> Aliases: `ut`
+
+Removes the space separated list of tags from the note specified by its list number. Works exactly the same as `tag`, but in reverse.
+
+## Configuration
+
+CNote uses a YAML file called `.cnote.yaml` to store your preferences. The file is stored in your home directory and is editable in any text editor. Here are the options:
+
+```yaml
+# note_path is the only required property.
+# This is the root directory for your notes folder.
+note_path: ~/Documents/Notes
+
+# Optionally, you can provide an editor that CNote will 
+# open your notes in. This can be any editor that handles
+# markdown files: vscode, gedit, emacs, etc...
+editor: vim
+
+# prompt can be any string. This will show up just
+# before your cursor whenever CNote is waiting for you to
+# type something.
+prompt: "=> uLtR4Hax <=(🌭)>>"
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cnote"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cnote.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cnote/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cnote"
+  spec.version       = Cnote::VERSION
+  spec.authors       = ["Tony McCoy"]
+  spec.email         = ["tony@ratwizard.io"]
+
+  spec.summary       = %q{Console notes!}
+  spec.description   = %q{Take notes with a fast and efficient CLI}
+  spec.homepage      = "https://www.tonymccoy.me/cnote"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "awesome_print", "~> 1.8"
+  spec.add_runtime_dependency "colorize", "~> 0.8.1"
+end

data/exe/cnote

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "cnote"

data/lib/cnote.rb

@@ -0,0 +1,14 @@
+require "colorize"
+require_relative "cnote/config"
+require_relative "cnote/notes"
+require_relative "cnote/version"
+
+# module Cnote
+  # Your code goes here...
+# end
+
+config = Config.new("~/.cnote.yaml")
+
+# Start REPL
+notes = Notes.new(config)
+notes.await_command("\nWelcome to CNote! Type #{'help'.white} or #{'h'.white} to see a list of available commands.")

data/lib/cnote/version.rb

@@ -0,0 +1,3 @@
+module Cnote
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: cnote
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tony McCoy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+description: Take notes with a fast and efficient CLI
+email:
+- tony@ratwizard.io
+executables:
+- cnote
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cnote.gemspec
+- exe/cnote
+- lib/cnote.rb
+- lib/cnote/version.rb
+homepage: https://www.tonymccoy.me/cnote
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Console notes!
+test_files: []