notes_cli 0.1.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 333db1b8b6dbbcd790a58549547ba44ddc8928fb63a4f1d1af1f565987da1865
-  data.tar.gz: be86e4e00485b7a7ebe8001565b40bde1002c057ce0ab7239e9d4d8a66ed95d1
+  metadata.gz: 6624e27858770f04d3c3b2eb740c55c3c688bf23a76b996b27aad967ec5a4734
+  data.tar.gz: f1d493a601faa6ee2f1925cb1e4a7362e755471d47005fa43327c69f599399f2
 SHA512:
-  metadata.gz: 62e99f63a3bd462f3852227d54eabaee0e3982909d2317650bc84522f31921b47d34e26b5403953f961e89b18ce221a2f88c8d849d55664558b4fa1e686bb8ed
-  data.tar.gz: 89e4aa5bd7648cace82ed0febae82344cfcc4ed9ad8fc9c101d9ec0b88ad13b5419a42ed6d0b4ffa6c3226f451e2b64c43c985a59d1e6a1d6bd70a73e63b7b65
+  metadata.gz: e5e8f1bd09caec7c073c9c3d7a416a7825290ecaf623cbbe13f0ca91db19be563dba61eb5356d56966e4687ddec5401e11b9bd08e3090ab8c586cb5f1c1b709d
+  data.tar.gz: 8440c749b88e8d4f8ae7108cf133aeb7f75e27b1684bc0e8be03a9fa7391546b54702ad5e8357686caef774a3d27402ed83573e2e15f9653cc6713cb24b52233

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+
+## 0.0.0
+Core functionalities implemented.
+
+## 0.1.0
+Specify gem versions in Gemspec.
+
+## 0.1.1
+Add install instruction to documentation.
+
+## 0.1.2
+Minor refactor of `NoteLister`, adding a previously missing private section.
+
+## 0.1.3
+Amend available commands and README to provide accurate documentation.
+
+## 0.1.4
+Fix punctuation inconsistencies in documentation.
+
+## 0.1.5
+Removes require statements for debuggers out of the main app.
+Adds about section.
+
+## 0.2.0
+Introduce `notes -e --editor` to allow users to set their favourite editor to open notebooks with.
+Add `notes -o --open_notebook` to allow users to open a notebook in the context of their favourite editors.
+
+## 1.0.0
+Specify a ruby version of 2.6.5.

data/Gemfile.lock

@@ -1,21 +1,21 @@
 PATH
   remote: .
   specs:
-    notes_cli (0.0.0)
+    notes_cli (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
+    ast (2.4.1)
     byebug (11.1.3)
     coderay (1.1.2)
     diff-lcs (1.3)
     docile (1.3.2)
-    fakefs (1.2.2)
+    fakefs (0.20.1)
     method_source (1.0.0)
-    parallel (1.19.1)
-    parser (2.7.1.2)
-      ast (~> 2.4.0)
+    parallel (1.19.2)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -23,6 +23,7 @@ GEM
       byebug (~> 11.0)
       pry (~> 0.13.0)
     rainbow (3.0.0)
+    regexp_parser (1.8.2)
     rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -37,16 +38,17 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (0.84.0)
+    rubocop (0.93.1)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
       rexml
-      rubocop-ast (>= 0.0.3)
+      rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.0.3)
-      parser (>= 2.7.0.1)
+    rubocop-ast (0.8.0)
+      parser (>= 2.7.1.5)
     ruby-progressbar (1.10.1)
     simplecov (0.18.5)
       docile (~> 1.1)
@@ -58,13 +60,13 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  fakefs
+  fakefs (~> 0.5)
   notes_cli!
-  pry
-  pry-byebug
-  rspec
-  rubocop
-  simplecov
+  pry (~> 0.12)
+  pry-byebug (~> 3.9)
+  rspec (~> 3.9)
+  rubocop (~> 0.86)
+  simplecov (~> 0.18)
 
 BUNDLED WITH
    1.17.2

data/README.md

@@ -20,6 +20,11 @@ Define your first workspace
 notes -w workspace_name
 ```
 
+Set your default editor
+```bash
+notes -e subl
+```
+
 # DSL
 ## Notes folder
 Where you will store all notes, including your workspaces and notebooks as the top layers
@@ -57,12 +62,12 @@ notes
 ```
 
 ## Create
-### Create a note in the current workspace
+Create a note in the current workspace
 ```bash
 notes -n notebook note_title
 ```
 
-### Creating a note in a nested notebook
+Creating a note in a nested notebook
 ```bash
 notes -n path/to/notebook note_title
 ```
@@ -101,6 +106,12 @@ Listing all notes in a given notebook
 notes -l notebook
 ```
 
+## Open
+Open a notebook in the context of your favourite editor
+```bash
+notes -o notebook
+```
+
 ## Switch
 Switching workspace
 ```bash

data/lib/notes_cli/controllers/option_parser.rb

@@ -16,14 +16,18 @@ OptionParser.new do |opt|
     workspace.list_notes(option)
   end
 
+  opt.on('-o --open_notebook NOTEBOOK') { |option| workspace.open_notebook(option) }
+
+  opt.on('-e --editor EDITOR') { |option| workspace.update_entry('editor', option) }
+
   opt.on('-w --workspace WORKSPACE') do |option|
     puts "Switched to #{option} wokspace" if workspace.switch(option)
-  end 
+  end
 
   opt.on('--notes_folder PATH/TO/FOLDER') do |option|
     workspace.update_entry('notes_folder', option)
   end
- 
+
   opt.on('--which_workspace ANY_CHARACTER') do |_option|
     puts "Current workspace is #{workspace.current_workspace}"
   end

data/lib/notes_cli/models/workspace.rb

@@ -19,12 +19,22 @@ class Workspace
     NoteLister.new(notebook).call
   end
 
+  def open_notebook(notebook)
+    system("#{editor} #{notebook_path(notebook)}")
+  end
+
   def switch(workspace)
     return unless workspace_exists?(workspace) || create?('workspace')
 
     update_entry('workspace', workspace)
   end
 
+  def editor
+    return config['editor'] if config && config['editor']
+
+    raise StandardError, 'Please set your editor'
+  end
+
   def update_entry(key, value)
     current_config = config
     current_config ? current_config[key] = value.strip.chomp : current_config = { key => value }

data/lib/notes_cli/version.rb

@@ -1,3 +1,3 @@
 module NotesCli
-  VERSION = '0.1.5'
+  VERSION = '1.0.0'
 end

data/notes_cli.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
   s.homepage    =
     'https://github.com/joe-at-github/notes_cli'
   s.license       = 'MIT'
+  s.required_ruby_version = Gem::Requirement.new('>= 2.6.5')
   s.add_development_dependency 'fakefs', '~> 0.5'
   s.add_development_dependency 'pry', '~> 0.12'
   s.add_development_dependency 'pry-byebug', '~> 3.9'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: notes_cli
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Joeffrey Lamy
@@ -105,6 +105,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -133,7 +134,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="