ncn 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d459f6e9c00f76ef3d4f6ddbdb6cab64ff1d394480d189c930fc700de7f8d4ac
+  data.tar.gz: 16f4cc234e4a34f668c5a6ce838b5b0c349167bf2ef89a04f193d854a55cc47b
+SHA512:
+  metadata.gz: 2d3595eb1d430954e94701c7d63bf1eb0756beef70d6bc40e9bdb2198a2ad14b89264443af4c97e7bc4638aba60a5c2806df73388de1070fc5d1aa1cfe58c904
+  data.tar.gz: d7e4052e202af9e5fb1884c443518f07ca4f763e572a8c8a3bbdf5630f7c254b2234ebebc7db67d3c7ef59098efd2d7cdc376f77cd2fa99517ded8c3b1d492f5

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,4 @@
+require: standard
+
+inherit_gem:
+  standard: config/base.yml

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-04-06
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at alex.musayev@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    ncn (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    amazing_print (1.4.0)
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    method_source (1.0.0)
+    parallel (1.22.1)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.8.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.1)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.26.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.13.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.9.0)
+      rubocop (= 1.26.0)
+      rubocop-performance (= 1.13.3)
+    timecop (0.9.5)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  amazing_print (~> 1.4)
+  ncn!
+  pry
+  pry-byebug
+  rake (~> 13.0)
+  rspec (~> 3.11)
+  standard (~> 1.8)
+  timecop (~> 0.9.5)

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Alex Musayev
+
+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,5 @@
+# Taking notes, UNIX way
+
+CLI tool for personal notes management. Inspired by [other](https://getdnote.com) [similar](https://github.com/xwmx/nb) [projects](https://jrnl.sh), but subjectively more convenient out of the box.
+
+Written in Ruby with <3 and zero dependencies.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ncn"
+
+Bundler.require
+
+lib_path = File.expand_path(File.join("..", "lib"), __dir__)
+$LOAD_PATH << lib_path if File.exist?(lib_path)
+
+require "pry"
+
+Pry.start

data/bin/ncn

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ncn"
+
+DEBUG = ENV.key?("NOTES_DEBUG")
+
+require "pry" if DEBUG
+
+lib_path = File.expand_path(File.join("..", "lib"), __dir__)
+$LOAD_PATH << lib_path if File.exist?(lib_path)
+
+Ncn::Main.new.run

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/docs/commands/create.md

@@ -0,0 +1,20 @@
+# Create
+
+Generate a blank note and open it with the `$EDITOR`.
+
+Usage:
+
+```
+ncn create
+```
+
+Short form:
+
+```
+ncn
+```
+
+Options:
+
+- `--path` (optional) — local path to the notes repository. The directory will be created if not present. Default repository path is `$PWD`.
+- `--tags` (optional) — add any number of tags to the new note. Use comma to separate multiple values.

data/docs/commands/open.md

@@ -0,0 +1,19 @@
+# Open
+
+Open an existing note with the `$EDITOR`.
+
+Usage:
+
+```
+ncn open ID
+```
+
+When `ID` argument is omitted, it will open the most recent note, or do nothing if the repository is empty.
+
+```
+ncn open
+```
+
+Options:
+
+- `--path` (optional) — local path to the notes repository. Default repository path is `$PWD`.

data/docs/structure.md

@@ -0,0 +1,46 @@
+# Structure
+
+This document describes basic `ncn` concepts and data formats.
+
+## Notes repository
+
+Repository is an ordinary directory in a file system, containing note files and service data, like cache.
+
+Repository structure suppose to be managed automatically, though the logic is very generic, allowing multiple usage scenarios.
+
+## Directory structure
+
+Note file name and path suppose to be managed automatically, but the structure is quite straightforward:
+
+```
+ROOT/YYYY/MM/DD/ID.ext
+```
+
+- `ROOT` — root notes repository directory.
+- `YYYY/MM/DD` — note creation date.
+- `ID` — unique note ID (an integer serial number).
+- `ext` (optional) — note file extension, default is `md`.
+- File that does not match this structure are considered non-valid notes and will be ignored during lookups.
+
+## Note
+
+Each note is a plain text file with optional [YAML front matter](https://jekyllrb.com/docs/front-matter/):
+
+```
+---
+title: Arbitrary note title
+tags: comma, separated, tags, spaces are ok
+---
+
+Hello world, I'm a note!
+```
+
+## Note id
+
+Each note has a unique id, a serial number for a file within the repository.
+
+Id is the primary way to reference a note.
+
+Each new id is based on the current repository state.
+
+Ids are considered immutable.

data/lib/ncn/cache.rb

@@ -0,0 +1,53 @@
+module Ncn
+  class Cache
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    def fetch(key, value = nil)
+      return get(key) if exist?(key)
+      (value || (block_given? ? yield : nil))&.tap { set(key, _1) }
+    end
+
+    def exist?(key)
+      cache.key?(key.to_s)
+    end
+
+    # Add key with associated value to the cache
+    # @param [String] cache key
+    # @param [String] value to associate with the key
+    # @return [Object] original value
+    def set(key, value)
+      cache[key.to_s] = value
+      persist
+      value
+    end
+
+    def get(key)
+      cache[key.to_s]
+    end
+
+    def unset(key)
+      return unless exist?(key)
+      cache.delete(key.to_s)
+      persist
+    end
+
+    def keys
+      cache.keys
+    end
+
+    private
+
+    def persist
+      FileUtils.mkdir_p(File.dirname(path))
+      File.write(path, JSON.generate(cache))
+    end
+
+    def cache
+      @cache ||= File.exist?(path) ? JSON.parse(File.read(path)) : {}
+    end
+  end
+end

data/lib/ncn/cli_parser.rb

@@ -0,0 +1,29 @@
+module Ncn
+  class CliParser
+    attr_reader :options, :command, :arguments
+
+    COMMON_OPTIONS = [
+      ["--help", "-h", GetoptLong::NO_ARGUMENT],
+      ["--tags", "-t", GetoptLong::REQUIRED_ARGUMENT],
+      ["--path", GetoptLong::REQUIRED_ARGUMENT],
+      ["--number", "-n", GetoptLong::REQUIRED_ARGUMENT]
+    ].freeze
+
+    NORMALIZERS = {
+      "--tags" => ->(value) { value.to_s.split(",").map(&:strip).uniq(&:downcase) },
+      "--number" => ->(value) { value.match?(/^\d+$/) ? Integer(value) : nil }
+    }.freeze
+
+    def initialize
+      options_parser = GetoptLong.new(*COMMON_OPTIONS)
+
+      @options = {}.tap do |result|
+        options_parser.each do |option, argument|
+          result[option] = NORMALIZERS.key?(option) ? NORMALIZERS[option].call(argument) : argument
+        end
+      end
+
+      @command, *@arguments = ARGV
+    end
+  end
+end

data/lib/ncn/command/base.rb

@@ -0,0 +1,18 @@
+module Ncn
+  module Command
+    class Base
+      attr_reader :repository, :params
+
+      # @param repository [Repository]
+      # @param params [CommandParams]
+      def initialize(repository:, params: nil)
+        @repository = repository
+        @params = params
+      end
+
+      def perform
+        raise "not implemented"
+      end
+    end
+  end
+end

data/lib/ncn/command/create.rb

@@ -0,0 +1,10 @@
+module Ncn
+  module Command
+    class Create < Base
+      def perform
+        note = repository.create(tags: params.tags)
+        Draft.new(ids: [note.id], repository: repository).open_with(&Editor)
+      end
+    end
+  end
+end

data/lib/ncn/command/help.rb

@@ -0,0 +1,22 @@
+module Ncn
+  module Command
+    class Help < Base
+      HELP = <<~TEXT
+        Usage:
+
+        create - generate new note and open it with the $EDITOR
+        open - open one or multiple notes as a single draft
+        help - list all commands or display detailed help for a specific command
+
+        Common options:
+
+        --help - similar to the help command
+        --path - repository directory path (default is "notes" in the current directory)
+      TEXT
+
+      def perform
+        puts HELP
+      end
+    end
+  end
+end

data/lib/ncn/command/list.rb

@@ -0,0 +1,9 @@
+module Ncn
+  module Command
+    class List < Base
+      def perform
+        puts repository.list
+      end
+    end
+  end
+end

data/lib/ncn/command/open.rb

@@ -0,0 +1,15 @@
+module Ncn
+  module Command
+    class Open < Base
+      def perform
+        Draft.new(ids: ids, repository: repository).open_with(&Editor)
+      end
+
+      private
+
+      def ids
+        params.ids || [repository.last_id]
+      end
+    end
+  end
+end

data/lib/ncn/command.rb

@@ -0,0 +1,9 @@
+module Ncn
+  module Command
+    autoload :Base, "ncn/command/base"
+    autoload :Create, "ncn/command/create"
+    autoload :Help, "ncn/command/help"
+    autoload :List, "ncn/command/list"
+    autoload :Open, "ncn/command/open"
+  end
+end

data/lib/ncn/command_params/base.rb

@@ -0,0 +1,12 @@
+module Ncn
+  module CommandParams
+    class Base
+      attr_reader :arguments, :options
+
+      def initialize(arguments: [], options: {})
+        @arguments = arguments
+        @options = options
+      end
+    end
+  end
+end

data/lib/ncn/command_params/create.rb

@@ -0,0 +1,9 @@
+module Ncn
+  module CommandParams
+    class Create < Base
+      def tags
+        options["--tags"]
+      end
+    end
+  end
+end

data/lib/ncn/command_params/list.rb

@@ -0,0 +1,13 @@
+module Ncn
+  module CommandParams
+    class List < Base
+      def number
+        options["--number"]
+      end
+
+      def tags
+        options["--tags"]
+      end
+    end
+  end
+end

data/lib/ncn/command_params/open.rb

@@ -0,0 +1,19 @@
+module Ncn
+  module CommandParams
+    class Open < Base
+      # @return [Array{Integer}, nil] array of note ids or nil if there are none
+      def ids
+        return unless arguments&.any?
+        arguments.map { normalize_note_id(_1) }
+      end
+
+      private
+
+      def normalize_note_id(value)
+        Integer(value)
+      rescue TypeError, ArgumentError
+        raise Error::NonValidNoteId
+      end
+    end
+  end
+end

data/lib/ncn/command_params.rb

@@ -0,0 +1,8 @@
+module Ncn
+  module CommandParams
+    autoload :Base, "ncn/command_params/base"
+    autoload :Create, "ncn/command_params/create"
+    autoload :List, "ncn/command_params/list"
+    autoload :Open, "ncn/command_params/open"
+  end
+end

data/lib/ncn/command_resolver.rb

@@ -0,0 +1,36 @@
+module Ncn
+  class CommandResolver
+    COMMANDS = %w[
+      create
+      open
+      list
+      help
+    ].freeze
+
+    attr_reader :command
+
+    def initialize(command)
+      @command = command
+    end
+
+    def command_class
+      Kernel.const_get("Ncn::Command::#{classified_command}")
+    end
+
+    def params_class
+      Kernel.const_get("Ncn::CommandParams::#{classified_command}")
+    end
+
+    private
+
+    def classified_command
+      explicit_command.gsub(/(?:\b|_)([a-z])/) { $1.capitalize }
+    end
+
+    def explicit_command
+      return "help" unless command
+      raise "unknown command" unless COMMANDS.include?(command)
+      command
+    end
+  end
+end

data/lib/ncn/draft.rb

@@ -0,0 +1,62 @@
+module Ncn
+  class Draft
+    attr_reader :ids, :repository
+
+    def initialize(ids:, repository:)
+      @ids = ids
+      @repository = repository
+    end
+
+    def open_with
+      dump
+      yield file_name
+      load
+      FileUtils.rm_rf(file_name)
+    end
+
+    private
+
+    def dump
+      FileUtils.mkdir_p(File.dirname(file_name))
+      File.write(file_name, exported_notes)
+    end
+
+    def load
+      updated_note_ids = []
+
+      read_fragments.each do |fragment|
+        id, tags, body = parse_fragment(fragment)
+        updated_note_ids << id
+        repository.update(id, body: body, tags: tags)
+      end
+
+      (ids - updated_note_ids).each { repository.drop(_1) }
+    end
+
+    def read_fragments
+      File.read(file_name).split(/^--\s+(?=\d+),?/)[1..] || []
+    end
+
+    def parse_fragment(fragment)
+      fragment_tagline, body = fragment.split("\n", 2)
+      id, *tags = fragment_tagline.split(",").map(&:strip)
+      [Integer(id), tags, body]
+    end
+
+    def file_name
+      @file_name ||= File.join(repository.path, "edit", "#{ids.sort.join("_")}.md")
+    end
+
+    def exported_notes
+      notes.map { "#{tagline(_1)}\n#{_1.body}" }.join("\n\n") + "\n"
+    end
+
+    def tagline(note)
+      "-- #{[note.id].concat(note.uniq_tags).join(", ")}".strip
+    end
+
+    def notes
+      ids.map { repository.find(_1) }
+    end
+  end
+end

data/lib/ncn/editor.rb

@@ -0,0 +1,8 @@
+module Ncn
+  class Editor
+    def self.to_proc
+      editor = ENV["EDITOR"] || raise("$EDITOR not defined")
+      ->(file_name) { system("#{editor} \"#{file_name}\"") }
+    end
+  end
+end

data/lib/ncn/error.rb

@@ -0,0 +1,31 @@
+module Ncn
+  class Error < StandardError
+    RepoIsEmpty = Class.new(self)
+    NoteNotFound = Class.new(self)
+    NonValidNoteId = Class.new(self)
+
+    attr_reader :context
+
+    def initialize(context = {})
+      @context = context
+    end
+
+    def message
+      context[:message] || default_message
+    end
+
+    def to_s
+      message
+    end
+
+    def to_json
+      JSON.generate(context)
+    end
+
+    private
+
+    def default_message
+      self.class.name.split("::").last.gsub(/(?!\b)([A-Z])/, ' \1').downcase
+    end
+  end
+end

data/lib/ncn/main.rb

@@ -0,0 +1,51 @@
+module Ncn
+  class Main
+    DEFAULT_NOTES_PATH = "notes"
+
+    def run
+      code = 0
+      command.perform
+    rescue => e
+      puts e.message
+      puts e.backtrace.join("\n") if DEBUG
+    ensure
+      exit(code)
+    end
+
+    private
+
+    def command
+      resolver.command_class.new(repository: repository, params: command_params)
+    end
+
+    def command_params
+      resolver.params_class.new(options: options, arguments: arguments)
+    rescue NameError
+      nil
+    end
+
+    def repository
+      Repository.new(repository_path)
+    end
+
+    def repository_path
+      options.fetch(:path) { File.join(Dir.pwd, DEFAULT_NOTES_PATH) }
+    end
+
+    def options
+      cli_parser.options
+    end
+
+    def arguments
+      cli_parser.arguments
+    end
+
+    def resolver
+      @resolver ||= CommandResolver.new(cli_parser.command)
+    end
+
+    def cli_parser
+      @cli_parser ||= CliParser.new
+    end
+  end
+end

data/lib/ncn/note.rb

@@ -0,0 +1,58 @@
+module Ncn
+  class Note
+    MAX_TITLE_LENGTH = 80
+    OMISSION = "..."
+
+    attr_reader :id, :created
+    attr_accessor :tags, :body
+
+    def initialize(id:, created: nil, tags: nil, body: "")
+      @id = id
+      @created = created || Time.now
+      @tags = tags
+      @body = body
+    end
+
+    def title
+      first_line = body.to_s.strip.lines.first.to_s.strip.gsub(/^#+\s+/, "")
+      return first_line if first_line.length < MAX_TITLE_LENGTH
+      first_line[0..(MAX_TITLE_LENGTH - OMISSION.length.succ)] + OMISSION
+    end
+
+    def meta
+      {
+        "title" => title,
+        "tags" => csv(uniq_tags),
+        "created" => created.to_s
+      }
+    end
+
+    def uniq_tags
+      return [] unless tags
+      tags.uniq(&:downcase)
+    end
+
+    def path
+      NotePathBuilder.new(id: id, created: created).path
+    end
+
+    def to_h
+      {
+        id: id,
+        created: created,
+        tags: uniq_tags,
+        body: body
+      }
+    end
+
+    def to_s
+      "#{meta.to_yaml}---\n\n#{body.strip}"
+    end
+
+    private
+
+    def csv(values)
+      values.join(", ")
+    end
+  end
+end

data/lib/ncn/note_loader.rb

@@ -0,0 +1,53 @@
+module Ncn
+  class NoteLoader
+    attr_reader :file_name
+
+    def initialize(file_name)
+      @file_name = file_name
+    end
+
+    def load
+      Note.new(
+        id: id,
+        created: created,
+        tags: tags,
+        body: body
+      )
+    end
+
+    def id
+      @id ||= Integer(File.basename(file_name.split(".").first))
+    end
+
+    def created
+      value = meta["created"]
+      value.is_a?(Time) ? value : extract_approximate_timestamp
+    end
+
+    def extract_approximate_timestamp
+      year, month, day = file_name.split(File::SEPARATOR)[-4..-2]
+      Time.new(Integer(year), Integer(month), Integer(day), 0, 0, 0, 0)
+    end
+
+    def tags
+      meta["tags"].to_s.split(",").map(&:strip)
+    end
+
+    def meta
+      @meta ||= extract_meta
+    end
+
+    def extract_meta
+      result = YAML.safe_load(text, permitted_classes: [Time])
+      result.is_a?(Hash) ? result : {}
+    end
+
+    def body
+      text.gsub(/\A---(.|\n)*---\s*/, "").strip
+    end
+
+    def text
+      @text ||= File.read(file_name)
+    end
+  end
+end

data/lib/ncn/note_path_builder.rb

@@ -0,0 +1,36 @@
+module Ncn
+  class NotePathBuilder
+    attr_reader :id, :created
+
+    def initialize(created:, id:)
+      @id = id
+      @created = created
+    end
+
+    def path
+      File.join(*directory_names, "#{id}.md")
+    end
+
+    def directory_names
+      [year, month, day]
+    end
+
+    private
+
+    def year
+      created.year.to_s
+    end
+
+    def month
+      zero_indented(created.month)
+    end
+
+    def day
+      zero_indented(created.day)
+    end
+
+    def zero_indented(value)
+      format("%02d", value)
+    end
+  end
+end

data/lib/ncn/repository.rb

@@ -0,0 +1,86 @@
+module Ncn
+  class Repository
+    CACHE_PATH = "cache.json"
+
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    def create(tags: [], body: "")
+      register_new_note(tags: tags, body: body).tap do |note|
+        cache.set(note.id, note.meta)
+        cache.set("last_id", note.id)
+      end
+    end
+
+    def list
+      cache.keys.filter { _1.match?(/^\d+$/) }
+    end
+
+    def find(id)
+      meta = cache.fetch(id) { raise Error::NoteNotFound }
+      created = Time.parse(meta.fetch("created"))
+      relative = NotePathBuilder.new(id: id, created: created).path
+      NoteLoader.new(File.join(path, relative)).load
+    end
+
+    def update(id, body: nil, tags: nil)
+      note = find(id)
+      note.body = body if body
+      note.tags = tags if tags
+      persist(note)
+    end
+
+    def drop(id)
+      meta = cache.fetch(id) { raise Error::NoteNotFound }
+      created = Time.parse(meta.fetch("created"))
+      path_builder = NotePathBuilder.new(id: id, created: created)
+      FileUtils.rm_rf(File.join(path, path_builder.path))
+      drop_empty_directories(path_builder.directory_names)
+      cache.unset(id)
+    end
+
+    def note_path(note)
+      File.join(path, note.path)
+    end
+
+    # @return [Integer] last cached note id; 0 means the repository is empty
+    def last_id
+      cache.fetch("last_id", 0)
+    end
+
+    private
+
+    def drop_empty_directories(directory_names)
+      year, month, day = directory_names
+
+      directories = [
+        File.join(path, year, month, day),
+        File.join(path, year, month),
+        File.join(path, year)
+      ]
+
+      directories.each do |directory_path|
+        break unless Dir.empty?(directory_path)
+        Dir.rmdir(directory_path)
+      end
+    end
+
+    # TODO: Make this operation atomic
+    def register_new_note(tags:, body:)
+      Note.new(id: last_id.succ, tags: tags, body: body).tap { persist(_1) }
+    end
+
+    def persist(note)
+      full_path = File.join(path, note.path)
+      FileUtils.mkdir_p(File.dirname(full_path))
+      File.write(full_path, note)
+    end
+
+    def cache
+      @cache ||= Cache.new(File.join(path, CACHE_PATH))
+    end
+  end
+end

data/lib/ncn/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Ncn
+  VERSION = "0.1.0"
+end

data/lib/ncn.rb

@@ -0,0 +1,25 @@
+require "date"
+require "fileutils"
+require "getoptlong"
+require "json"
+require "time"
+require "yaml"
+
+require_relative "ncn/version"
+
+module Ncn
+  autoload :Cache, "ncn/cache"
+  autoload :CliParser, "ncn/cli_parser"
+  autoload :Command, "ncn/command"
+  autoload :CommandParams, "ncn/command_params"
+  autoload :CommandResolver, "ncn/command_resolver"
+  autoload :Draft, "ncn/draft"
+  autoload :Editor, "ncn/editor"
+  autoload :Error, "ncn/error"
+  autoload :Note, "ncn/note"
+  autoload :NoteLoader, "ncn/note_loader"
+  autoload :NotePathBuilder, "ncn/note_path_builder"
+  autoload :Repository, "ncn/repository"
+end
+
+require_relative "ncn/main"

data/ncn.gemspec

@@ -0,0 +1,35 @@
+require_relative "lib/ncn/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ncn"
+  spec.version = Ncn::VERSION
+  spec.authors = ["Alex Musayev"]
+  spec.email = ["alex.musayev@gmail.com"]
+
+  spec.summary = "Personal notes management tool"
+  spec.description = ""
+  spec.homepage = "https://github.com/dreikanter/ncn"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:spec|\.git)})
+    end
+  end
+
+  spec.bindir = "bin"
+  spec.executables = ["ncn"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "amazing_print", "~> 1.4"
+  spec.add_development_dependency "pry", "~> 0.14"
+  spec.add_development_dependency "pry-byebug", "~> 3.9"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.11"
+  spec.add_development_dependency "standard", "~> 1.8"
+  spec.add_development_dependency "timecop", "~> 0.9.5"
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: ncn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Musayev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: amazing_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+description: ''
+email:
+- alex.musayev@gmail.com
+executables:
+- ncn
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/ncn
+- bin/setup
+- docs/commands/create.md
+- docs/commands/open.md
+- docs/structure.md
+- lib/ncn.rb
+- lib/ncn/cache.rb
+- lib/ncn/cli_parser.rb
+- lib/ncn/command.rb
+- lib/ncn/command/base.rb
+- lib/ncn/command/create.rb
+- lib/ncn/command/help.rb
+- lib/ncn/command/list.rb
+- lib/ncn/command/open.rb
+- lib/ncn/command_params.rb
+- lib/ncn/command_params/base.rb
+- lib/ncn/command_params/create.rb
+- lib/ncn/command_params/list.rb
+- lib/ncn/command_params/open.rb
+- lib/ncn/command_resolver.rb
+- lib/ncn/draft.rb
+- lib/ncn/editor.rb
+- lib/ncn/error.rb
+- lib/ncn/main.rb
+- lib/ncn/note.rb
+- lib/ncn/note_loader.rb
+- lib/ncn/note_path_builder.rb
+- lib/ncn/repository.rb
+- lib/ncn/version.rb
+- ncn.gemspec
+homepage: https://github.com/dreikanter/ncn
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/dreikanter/ncn
+  source_code_uri: https://github.com/dreikanter/ncn
+  changelog_uri: https://github.com/dreikanter/ncn/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.4
+signing_key:
+specification_version: 4
+summary: Personal notes management tool
+test_files: []