notes_cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 73fe7f6770836515148031d07002166d3db2635f94508eb90f33757cceb8ecd6
+  data.tar.gz: 7eb9ee91974caa8b8f103da40c38b289f02b10d37a1a1244013790e0ce67294c
+SHA512:
+  metadata.gz: 55c0ead38e7df4e746efe2cab82041ae226d4f444bd8ace2ec89d10ca861a1077a9057e245ffdb0146ec78277c7fef4b220de73c3a59a9f29f6a0b98b3ffe803
+  data.tar.gz: 531023291b416aa26e2c50e00c4fe37beba81cc99738ab33b5bf5b997ced661ab079777d0855b5952935e0474667472705b343dc46eb88d49c1d98a98ad0dac9

data/.gitignore

@@ -0,0 +1,3 @@
+config.yml
+coverage
+lib/config.yml

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    notes_cli (0.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    byebug (11.1.3)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    fakefs (1.2.2)
+    method_source (1.0.0)
+    parallel (1.19.1)
+    parser (2.7.1.2)
+      ast (~> 2.4.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rainbow (3.0.0)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.84.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fakefs
+  notes_cli!
+  pry
+  pry-byebug
+  rspec
+  rubocop
+  simplecov
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Joeffrey Lamy
+
+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,103 @@
+# Getting started
+
+Tell notes_cli where your notes will be stored.
+```bash
+notes --notes_folder path/to/where/you/will/store/notes
+```
+
+Define your first workspace.
+```bash
+notes -w workspace_name
+```
+
+# DSL
+## Notes folder
+Where you will store all notes, including your workspaces and notebooks as the top layers.
+
+## Workspace
+Where you will store notebooks.
+
+## Notebook
+Where you will store notes.
+
+## Example
+Basic case scenario, where:  
+- `notes_folder` is where we decided to store notes  
+- `personal_projects` and `work` are workspaces  
+- `social_media_apps` and `features` are notebooks   
+- `twitter_clone.md` and `requirements.md` are notes  
+
+```bash
+notes_folder/
+├── personal_projects
+│   └── social_media_apps
+│       └── twitter_clone.md
+└── work
+    └── features
+        └── voice_chat
+            └── requirements.md
+```
+
+# Usage
+## Check
+Checking which workspace you are currently in
+```bash
+notes
+'Current workspace is ...'
+```
+
+## Create
+### Create a note in the current workspace
+```bash
+notes -n notebook note_title
+```
+
+### Creating a note in a nested notebook
+```bash
+notes -n path/to/notebook note_title
+```
+```bash
+# e.g
+notes -n saving_the_world/doing_charity_work list_of_charities
+
+# will produce
+notes_folder/
+├── personal_projects
+│   ├── saving_the_world
+│   │   └── doing_charity_work
+│   │       └── list_of_charities.md
+│   └── social_media_apps
+│       └── twitter_clone.md
+└── work
+    └── features
+        └── voice_chat
+            └── requirements.md
+```
+
+## Delete
+Delete a note
+```bash
+notes -d notebook note_title
+```
+
+## List
+Listing all notebooks in your workspace
+```bash
+notes -l .
+```
+
+Listing all notes in a given notebook
+```bash
+notes -l notebook
+```
+
+## Switch
+Switching workspace
+```bash
+notes -w workspace_name
+```
+
+Switching workspace and creating a note there
+```bash
+notes -w workspace_name -n notebook note_title
+```

data/bin/notes

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'notes_cli'

data/lib/notes_cli.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module NotesCli
+  ROOTH_PATH = __dir__
+  LIBRARY = File.join(ROOTH_PATH, 'notes_cli')
+  CONFIG_PATH = File.join(LIBRARY, 'config.yml')
+end
+
+require 'pry'
+require 'pry-byebug'
+require 'yaml'
+require 'fileutils'
+require 'optparse'
+require File.join(NotesCli::LIBRARY, 'modules', 'modules')
+require File.join(NotesCli::LIBRARY, 'models', 'workspace')
+require File.join(NotesCli::LIBRARY, 'services', 'services')
+require File.join(NotesCli::LIBRARY, 'controllers', 'option_parser')
+require File.join(NotesCli::LIBRARY, 'version')

data/lib/notes_cli/controllers/option_parser.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+workspace = Workspace.new
+
+if ARGV.empty?
+  ARGV << '--which_workspace'
+  ARGV << 'any_character'
+end
+
+OptionParser.new do |opt|
+  opt.on('-n --new_note TITLE PATH/TO/FILE') { |option| workspace.create_note(option, ARGV) }
+
+  opt.on('-d --delete_note TITLE PATH/TO/FILE ') { |option| workspace.delete_note(option, ARGV) }
+
+  opt.on('-l --list_notes TITLE PATH/TO/NOTEBOOK') do |option|
+    workspace.list_notes(option)
+  end
+
+  opt.on('-w --workspace WORKSPACE') do |option|
+    puts "Switched to #{option} wokspace" if workspace.switch(option)
+  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
+end.parse!

data/lib/notes_cli/models/workspace.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+class Workspace
+  include Modules::ResourceUtils
+
+  def initialize
+    FileUtils.touch(NotesCli::CONFIG_PATH) unless File.file?(NotesCli::CONFIG_PATH)
+  end
+
+  def create_note(notebook, title)
+    NoteCreator.new(notebook, title, notebook_path(notebook), workspace_path).call
+  end
+
+  def delete_note(notebook, title)
+    NoteDeleter.new(notebook, title, notebook_path(notebook), workspace_path).call
+  end
+
+  def list_notes(notebook)
+    NoteLister.new(notebook).call
+  end
+
+  def switch(workspace)
+    return unless workspace_exists?(workspace) || create?('workspace')
+
+    update_entry('workspace', workspace)
+  end
+
+  def update_entry(key, value)
+    current_config = config
+    current_config ? current_config[key] = value.strip.chomp : current_config = { key => value }
+    File.open(NotesCli::CONFIG_PATH, 'w') { |file| file.truncate(0) }
+    File.open(NotesCli::CONFIG_PATH, 'r+') do |f|
+      YAML.dump(current_config, f)
+    end
+  end
+end

data/lib/notes_cli/modules/modules.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require File.join(NotesCli::LIBRARY, 'modules', 'resource_utils')
+

data/lib/notes_cli/modules/resource_utils.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Modules
+  module ResourceUtils
+    def config
+      YAML.safe_load(File.read(NotesCli::CONFIG_PATH))
+    end
+
+    def notebook_exists?(notebook)
+      Dir.exist?(File.join(notes_folder, current_workspace, notebook))
+    end
+
+    def workspace_exists?(workspace)
+      Dir.exist?(File.join(notes_folder, workspace))
+    end
+
+    def create?(resource)
+      puts "This #{resource} does not currently exist and will be created, "\
+           'do you wish to continue? [y/N]'
+      STDIN.gets.chomp == 'y'
+    end
+
+    def current_workspace
+      return config['workspace'] if config && config['workspace']
+
+      raise StandardError, 'Please set your workspace'
+    end
+
+    def notes_folder
+      return config['notes_folder'] if config && config['notes_folder']
+
+      raise StandardError, 'Please set your notes_folder'
+    end
+
+    def notebook_path(notebook)
+      @notebook_path ||= File.join(notes_folder, current_workspace, notebook)
+    end
+
+    def workspace_path
+      File.join(notes_folder, current_workspace)
+    end
+  end
+end

data/lib/notes_cli/services/note_creator.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+class NoteCreator
+  include Modules::ResourceUtils
+
+  def initialize(notebook, title, notebook_path, workspace_path)
+    @notebook = notebook
+    @title = title.join('_')
+    @notebook_path = notebook_path
+    @workspace_path = workspace_path
+  end
+
+  def call
+    return unless notebook_exists?(@notebook) || create?('notebook')
+
+    handle_errors
+    create_note
+    notify
+  end
+
+  private
+
+  def handle_errors
+    raise ArgumentError, 'no notebook specified' if !@notebook || @notebook.empty?
+    raise ArgumentError, 'no note title specified' if !@title || @title.empty?
+  end
+
+  def create_note
+    FileUtils.mkdir_p(@notebook_path)
+    FileUtils.cd(@notebook_path)
+    FileUtils.touch("#{@title}.md")
+    FileUtils.cd(@workspace_path)
+  end
+
+  def notify
+    puts File.basename(@workspace_path)
+    puts '----------------'
+    puts "Added '#{@title}' to your #{@notebook} notebook"
+    puts File.join(@notebook_path, "#{@title}.md")
+  end
+end

data/lib/notes_cli/services/note_deleter.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+class NoteDeleter
+  include Modules::ResourceUtils
+
+  def initialize(notebook, title, notebook_path, workspace_path)
+    @notebook = notebook
+    @title = title.join('_')
+    @notebook_path = notebook_path
+    @workspace_path = workspace_path
+  end
+
+  def call
+    handle_errors
+    delete_note
+    notify
+  end
+
+  private
+
+  def handle_errors
+    raise ArgumentError, 'no notebook specified' if !@notebook || @notebook.empty?
+    raise ArgumentError, 'no note title specified' if !@title || @title.empty?
+    raise ArgumentError, 'notebook does not exist' unless notebook_exists?(@notebook)
+  end
+
+  def delete_note
+    FileUtils.cd(@notebook_path)
+    FileUtils.rm("#{@title}.md")
+    FileUtils.cd(@workspace_path)
+  end
+
+  def notify
+    puts current_workspace.to_s
+    puts '----------------'
+    puts "Deleted '#{@title}' from your #{@notebook} notebook"
+  end
+end

data/lib/notes_cli/services/note_lister.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+class NoteLister
+  include Modules::ResourceUtils
+  
+  def initialize(notebook)
+    @notebook = notebook
+  end
+
+  def call
+    handle_errors
+    return list if entries.any?
+
+    empty_notebook_notification
+  end
+
+  def handle_errors
+    raise StandardError, 'no such notebook' unless notebook_exists?(@notebook)
+  end
+
+  def list
+    max_spacing = entries.keys.max_by(&:length).size
+    entries.each do |k, v|
+      spacing = ' ' * (max_spacing - k.length)
+      puts "#{k} #{spacing} #{v}"
+    end
+  end
+
+  def entries
+    @entries ||= {}.tap do |entries|
+      Dir.glob(File.join(notes_folder, current_workspace, @notebook, '/*')).sort.each do |path|
+        entries[File.basename(path)] = path
+      end
+    end
+  end
+
+  def empty_notebook_notification
+    puts File.basename(current_workspace)
+    puts '----------------'
+    puts "#{@notebook} is empty"
+  end
+end

data/lib/notes_cli/services/services.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require File.join(NotesCli::LIBRARY, 'services', 'note_creator')
+require File.join(NotesCli::LIBRARY, 'services', 'note_deleter')
+require File.join(NotesCli::LIBRARY, 'services', 'note_lister')

data/lib/notes_cli/version.rb

@@ -0,0 +1,3 @@
+module NotesCli
+  VERSION = '0.1.0'
+end

data/notes_cli.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'notes_cli/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'notes_cli'
+  s.version     = NotesCli::VERSION
+  s.date        = '2020-07-04'
+  s.summary     = 'Easy note management from the command line'
+  s.description = %q{
+    Easily create, delete and list all your notes.
+    NotesCli lets you create workspaces and notebooks in which you can store notes.
+    Notes are created as md files for ease of storing code snippets.
+  }.strip.gsub(/\s+/, ' ')
+  s.authors     = ['Joeffrey Lamy']
+  s.email       = 'joeffreylamy41@gmail.com'
+  s.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  s.executables << 'notes'
+  s.require_paths = ['lib']
+  s.homepage    =
+    'https://rubygems.org/gems/notes_cli'
+  s.license       = 'MIT'
+  s.add_development_dependency 'fakefs', '~> 0.5'
+  s.add_development_dependency 'pry', '~> 0.12'
+  s.add_development_dependency 'pry-byebug', '~> 3.9'
+  s.add_development_dependency 'rspec', '~> 3.9'
+  s.add_development_dependency 'rubocop', '~> 0.86'
+  s.add_development_dependency 'simplecov', '~> 0.18'
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: notes_cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joeffrey Lamy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.86'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.86'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+description: Easily create, delete and list all your notes. NotesCli lets you create
+  workspaces and notebooks in which you can store notes. Notes are created as md files
+  for ease of storing code snippets.
+email: joeffreylamy41@gmail.com
+executables:
+- notes
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- bin/notes
+- config.db
+- config.yml.db
+- lib/notes_cli.rb
+- lib/notes_cli/controllers/option_parser.rb
+- lib/notes_cli/models/workspace.rb
+- lib/notes_cli/modules/modules.rb
+- lib/notes_cli/modules/resource_utils.rb
+- lib/notes_cli/services/note_creator.rb
+- lib/notes_cli/services/note_deleter.rb
+- lib/notes_cli/services/note_lister.rb
+- lib/notes_cli/services/services.rb
+- lib/notes_cli/version.rb
+- notes_cli.gemspec
+homepage: https://rubygems.org/gems/notes_cli
+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: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Easy note management from the command line
+test_files: []