til_cli 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab6057c27228ad501f8bdce4e3203f796441afc0
-  data.tar.gz: d488d377bd955ff853f2ba4183020cd5c1741d67
+  metadata.gz: d407f12beba107ba569ca26aa41c4dbe553e873e
+  data.tar.gz: 9869122a9a035906d72ebbd57d36d66354fad19e
 SHA512:
-  metadata.gz: ab48021b8c5900226a2ff9bdbb65a9df219ef695a6834087f329ed494fe96eb9d6cf72a4bc42662f7a6206bc2bb1b63d9993a5afb923a7f1a0f21fd5a8cc72ca
-  data.tar.gz: 93cf5670bfc773cffc93e7176b613e113794bb4196873c978a1b274fdfe13e19394beb52a5fbe31673dd7644c79770ccf869ff0ff711cc2232b147fccf4e28f9
+  metadata.gz: 90e17b8c04f47edbd94523d29f67aadd4d025fbed09c234fd67685f85d765aa0eebb0b35291fb2d6fcceb11bf464ef139de5b8c232ab5b46c14694a7f4de396a
+  data.tar.gz: 2ead72d1c5d2429f7386aa759857f15ac9201b79b99f5be5c1e6d3f1d614b7aa6be48e3e46014169e22d90b41b1e49f44971fadf2048ac99f65d191d4372f3cb

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2015 Kevin
+Copyright (c) 2015 Kevin Litchfield
 
 MIT License
 

data/README.md

@@ -1,31 +1,16 @@
-# Til
+# `til_cli`
 
-TODO: Write a gem description
+Command-line notetaking application: a CRUD interface to a repo of "Today I Learned" notes. Inspired by the format of https://github.com/thoughtbot/til. Uses `$EDITOR` to create and edit notes, wraps Git for convenience, more features to come.
 
 ## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'til'
+```
+gem install til_cli
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install til
+## Setup
+```
+til init
+```
 
 ## Usage
-
-TODO: Write usage instructions here
-
-## Contributing
-
-1. Fork it ( https://github.com/[my-github-username]/til/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+Run `til help` for usage information.

data/lib/til.rb

@@ -7,12 +7,12 @@ require 'til/note_writer'
 require 'til/note_list'
 require 'til/note_editor'
 require 'til/note_deleter'
-
+require 'til/initializer'
 
 module Til
-
-  DIRECTORY = Settings.load.directory
-
+  DIRECTORY = -> () { Settings.load.directory }
+  GITHUB_REPO = -> () { Settings.load.github_repo }
+  EDITOR = ENV["VISUAL"] || ENV["EDITOR"] || "vim"
   HIGHLIGHT_COLORS = {
       0 => :yellow,
       1 => :light_blue,
@@ -23,15 +23,16 @@ module Til
       6 => :light_magenta,
     }
 
+  def self.init_settings_file_and_notes_repo
+    Initializer.new.create_settings_file unless Settings.settings_file_configured?
+    Initializer.new.create_notes_directory
+    puts "Your settings file is at `#{Settings.settings_file_path}`. Your notes are at `#{DIRECTORY}`."
+  end
 
   def self.print_working_directory
     puts DIRECTORY
   end
 
-  def self.open_working_directory
-    system("open", DIRECTORY)
-  end
-
   def self.new_note(subject, title)
     if_unmodified = Proc.new do
       puts "You didn't write anything, so a note wasn't created.".red
@@ -69,14 +70,14 @@ module Til
 
   def self.edit_file(search_term, options)
     if options[:last] 
-      system(ENV["EDITOR"] || "vim", Directory.root.notes.most_recent.path)
+      system(EDITOR, Directory.root.notes.most_recent.path)
       return
     end
     matches = Til.search_results_for(search_term)
     if matches.length < 1
       puts "no matches"
     else
-      system(ENV["EDITOR"] || "vim", matches.filter.path)
+      system(EDITOR, matches.filter.path)
     end
   end
 
@@ -89,6 +90,17 @@ module Til
     end
   end
 
+  def self.open_github_page_for_repo
+    if GITHUB_REPO
+    else
+      begin
+        repo = %x|git --git-dir=#{DIRECTORY}/.git --work-tree=#{DIRECTORY} remote -v|.scan(/:(.*).git/).flatten.first
+        system("open https://www.github.com/#{repo}")
+      rescue
+        puts "You don't appear to have a GitHub remote repository for your notes."
+      end
+    end
+  end
 
   def self.run_git_command(*args)
     system("git --git-dir=#{DIRECTORY}/.git --work-tree=#{DIRECTORY} #{args.join(" ")}")

data/lib/til/cli.rb

@@ -5,28 +5,42 @@ require 'date'
 require 'json'
 
 module Til
+  class Cli < Thor
+    
+    desc "init", "Generate a settings file if one doesn't already exist."
+    def init
+      Til.init_settings_file_and_notes_repo
+    end
 
+    desc "github", "If your notes have a remote repository on Github, open it."
+    def github
+      Til.open_github_page_for_repo
+    end
+
+    desc "edit [SEARCH TERM]", "Edit file that matches search for [SEARCH TERM]."
+    long_desc "`--last` flag"
+    option :last, type: :boolean
+    def edit(keyword="")
+      Til.edit_file(keyword, options)
+    end
 
-  class Cli < Thor
     desc "new SUBJECT \"TITLE\"", "Generate a new note with TITLE about SUBJECT. TITLE should be quoted and shell metacharacters escaped."
     def new(subject, title)
       Til.new_note(subject, title)
     end
 
     desc "ls [SUBJECT]", "List all notes [on SUBJECT]"
+    option :subjects, type: :boolean
     def ls(subject = nil)
-      if subject
+      if options[:subjects]
+        Til.list_subjects
+      elsif subject
         Til.list_notes_in(subject)
       else
         Til.list_all_notes
       end
     end
 
-    desc "subjects", "List all subjects"
-    def subjects
-      Til.list_subjects :bullet_points
-    end
-
     desc "pwd", "Print the path of your TIL working directory"
     def pwd
       Til.print_working_directory
@@ -37,11 +51,6 @@ module Til
       Til.print_most_recent_note quantity.to_i
     end
 
-    desc "open", "Open TIL working directory"
-    def open
-      Til.open_working_directory
-    end
-
     desc "cat [SUBJECT]", "Print all notes [on SUBJECT]"
     def cat(subject=nil)
       if subject
@@ -51,25 +60,16 @@ module Til
       end
     end
 
-    desc "edit [SEARCH TERM]", "Edit file that matches search for [SEARCH TERM]."
-    long_desc "`--last` flag"
-    option :last, type: :boolean
-    def edit(keyword="")
-      Til.edit_file(keyword, options)
-    end
-
     desc "git COMMAND", "Run Git COMMAND in TIL directory"
     def git(*args)
       Til.run_git_command(*args)
     end
 
-
     desc "grep COMMAND", "Run grep COMMAND in TIL directory"
     def grep(*args)
       Til.run_grep_command(*args)
     end
 
-
     desc "ag COMMAND", "Run Silver Searcher COMMAND in TIL directory"
     def ag(*args)
       Til.run_ag_command(*args)

data/lib/til/initializer.rb

@@ -0,0 +1,24 @@
+require 'fileutils'
+
+module Til
+  class Initializer
+    include Thor::Base
+    include Thor::Actions
+
+    def create_settings_file
+      notes_directory = ask("What directory do you want your notes to live in? (If you have no preference, `~/til` is a good option.)\n>")
+      settings_hash = {
+        "directory" => notes_directory
+      }
+      puts "Creating a settings file at `#{Settings.settings_file_path}`."
+      File.open(Settings.settings_file_path, "w") do |f|
+        f.write(settings_hash.to_json)
+      end
+    end
+
+    def create_notes_directory
+      d = Settings.load.notes_directory
+      FileUtils.mkdir_p(File.expand_path(d))
+    end
+  end
+end

data/lib/til/note_editor.rb

@@ -1,5 +1,3 @@
-# require 'github-markdown-preview' #!! seems to be slowing things down a lot if placed in til.rb
-
 module Til
   class NoteEditor
     attr_reader :path
@@ -13,12 +11,7 @@ module Til
     end
     
     def edit
-      # preview = GithubMarkdownPreview::HtmlPreview.new(path)
-      # preview.watch
-      # system("open", preview.preview_file)
-      system(ENV["EDITOR"] || "vim", path)
-      # preview.end_watch
-      # preview.delete
+      system(EDITOR, path)
     end
   end
 end

data/lib/til/settings.rb

@@ -4,16 +4,30 @@ module Til
   class Settings
     attr_reader :settings
 
+    SETTINGS_FILE_PATH = File.expand_path("~/.til/config.json")
+
     def initialize(config_file)
       @settings = JSON.parse(File.read(config_file))
     end
 
+    def self.settings_file_path
+      SETTINGS_FILE_PATH
+    end
+
+    def self.settings_file_configured?
+      File.exist?(SETTINGS_FILE_PATH)
+    end
+
     def self.load
-      self.new(File.expand_path("~/.til/config.json"))
+      self.new(SETTINGS_FILE_PATH)
     end
 
-    def directory
+    def notes_directory
       File.expand_path(settings["directory"])
     end
+
+    def github_repo
+      settings["github_repo"]
+    end
   end
 end

data/lib/til/version.rb

@@ -1,3 +1,3 @@
 module Til
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: til_cli
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Kevin Litchfield
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-27 00:00:00.000000000 Z
+date: 2015-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -97,6 +97,7 @@ files:
 - lib/til.rb
 - lib/til/cli.rb
 - lib/til/directory.rb
+- lib/til/initializer.rb
 - lib/til/note.rb
 - lib/til/note_deleter.rb
 - lib/til/note_editor.rb