zhuzh 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a8023b517bd18b09affd30ac54d42b5245021c0cee130f9de6490f758e64b378
+  data.tar.gz: 8551adc0c2205d4ff3640afe090239740158fea6c2f5876e38313b78e786d185
+SHA512:
+  metadata.gz: 9a7875c2e0855f3e00f6a8a607d9635c8e2342dabeeeb90334b8a91448f193ee3c5ab7d890488ce8339e9c680a3d3d9dad1745bc7601f1b259f1805eeadc96eb
+  data.tar.gz: 63ba8328c156ac24b395440e5b603eaf458da623aaca25900f70f86763221727b33dbf0722b62829a659bd054e084a37a3e07db2aa3267115693081b768fc1a1

data/README.md

@@ -0,0 +1,76 @@
+# Zhuzh
+
+A tool for easily creating and managing markdown notes.
+
+## Installation
+
+```bash
+gem install zhuzh
+```
+
+## Usage
+
+### Basic Usage
+
+Open your editor:
+```bash
+zz
+```
+
+When you save and close the editor, the note will be automatically saved.
+
+### Add a note directly:
+
+```bash
+zz "This is my super important note I need to write it quick before I forget"
+```
+
+### Pipe/redirect content to zz:
+
+```bash
+cat blog_post.txt | zz
+```
+
+or
+
+```bash
+zz < blog_post.txt
+```
+
+### Configuration
+
+By default, notes are stored in `$HOME/Zarchive`. You can change this by setting the `ZZ_DIR` environment variable:
+
+```bash
+export ZZ_DIR="$HOME/my_notes"
+```
+
+### Note Organization
+
+Notes are organized based on their content:
+- The first word becomes the subdirectory name
+- Words 2-5 are used in the filename, followed by a timestamp
+- For example, if you start a note with "Project ideas for tomorrow", it will be saved as `$ZZ_DIR/project/ideas_for_tomorrow_TIMESTAMP.md`
+
+## Neovim Integration
+
+Add this to your Neovim configuration:
+
+```vim
+" Save current buffer with Zhuzh
+function! SaveToZhuzh()
+  let output = system('zz', join(getline(1, '$'), "\n"))
+  echo "Saved to: " . trim(output)
+endfunction
+command! Zz call SaveToZhuzh()
+```
+
+Then you can use `:Zz` to save the current buffer as a Zhuzh note.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bin/tapioca

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'tapioca' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?('This file was generated by Bundler')
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('tapioca', 'tapioca')

data/bin/zz

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'zhuzh'
+
+# Handle command line arguments directly
+if ARGV.size.positive?
+  # Add explicit newline at the end of command line input
+  text = "#{ARGV.join(' ')}\n"
+  config = Zhuzh::Config.new
+  note = Zhuzh::Note.new(text, config)
+
+  if note.save
+    puts note.filepath
+    exit 0
+  else
+    exit 1
+  end
+else
+  # No arguments provided, use the CLI handler for stdin/editor
+  exit Zhuzh::CLI.start(ARGV) || 0
+end

data/lib/zhuzh/cli.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+# typed: strict
+
+require 'sorbet-runtime'
+
+module Zhuzh
+  # Command line interface for Zhuzh
+  class CLI
+    extend T::Sig
+
+    sig { params(args: T::Array[String]).returns(Integer) }
+    def self.start(args)
+      new.run(args)
+    end
+
+    sig { params(args: T::Array[String]).returns(Integer) }
+    def run(args)
+      content = if args.empty?
+                  if $stdin.tty?
+                    # No text, open editor
+                    open_editor
+                  else
+                    # Text piped from stdin
+                    $stdin.read
+                  end
+                else
+                  # Combine all arguments as note text
+                  args.join(' ')
+                end
+
+      process_content(content) ? 0 : 1
+    end
+
+    private
+
+    sig { params(content: T.nilable(String)).returns(T::Boolean) }
+    def process_content(content)
+      return false if content.nil? || content.strip.empty?
+
+      config = Config.new
+      note = Note.new(content, config)
+
+      if note.save
+        puts note.filepath
+        true
+      else
+        false
+      end
+    end
+
+    sig { returns(T.nilable(String)) }
+    def open_editor
+      editor = ENV['EDITOR'] || 'vim'
+      temp_file = "/tmp/zz_#{Time.now.to_i}.md"
+
+      # Open editor and wait for it to close
+      system("#{editor} #{temp_file}")
+
+      if File.exist?(temp_file)
+        content = File.read(temp_file)
+        File.unlink(temp_file)
+        return content
+      end
+
+      nil
+    end
+  end
+end

data/lib/zhuzh/config.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+# typed: strict
+
+require 'sorbet-runtime'
+require 'fileutils'
+
+module Zhuzh
+  # Manages configuration and directory settings
+  class Config
+    extend T::Sig
+
+    sig { returns(String) }
+    attr_reader :zz_dir
+
+    sig { void }
+    def initialize
+      @zz_dir = T.let(determine_zz_dir, String)
+      Zhuzh::Utils.ensure_directory_exists(@zz_dir)
+    end
+
+    private
+
+    sig { returns(String) }
+    def determine_zz_dir
+      ENV['ZZ_DIR'] || File.join(Dir.home, 'Zarchive')
+    end
+  end
+end

data/lib/zhuzh/note.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+# typed: strict
+
+require 'sorbet-runtime'
+require 'fileutils'
+require 'time'
+
+module Zhuzh
+  # Handles creation and storage of notes
+  class Note
+    extend T::Sig
+
+    sig { returns(String) }
+    attr_reader :content, :filepath
+
+    sig { params(content: String, config: Zhuzh::Config).void }
+    def initialize(content, config)
+      # Add trailing newline if not present for command line input
+      @content = T.let(content.end_with?("\n") ? content : "#{content}\n", String)
+      @config = T.let(config, Zhuzh::Config)
+      @filepath = T.let(generate_filepath, String)
+    end
+
+    sig { returns(T::Boolean) }
+    def save
+      Zhuzh::Utils.ensure_directory_exists(File.dirname(@filepath))
+      File.write(@filepath, @content)
+      true
+    rescue StandardError => e
+      warn "Error saving note: #{e.message}"
+      false
+    end
+
+    private
+
+    sig { returns(String) }
+    def generate_filepath
+      text = strip_frontmatter(@content)
+      words = text.strip.split(/\s+/)
+
+      dir_name = extract_directory_name(words)
+      file_base = extract_file_base(words)
+      timestamp = Time.now.strftime('%Y-%m-%d-%H-%M-%S')
+      base_path = File.join(@config.zz_dir, dir_name)
+
+      create_unique_filepath(base_path, file_base, timestamp)
+    end
+
+    sig { params(words: T::Array[String]).returns(String) }
+    def extract_directory_name(words)
+      words.empty? ? 'blank' : normalize_path_component(T.must(words[0]))
+    end
+
+    sig { params(words: T::Array[String]).returns(String) }
+    def extract_file_base(words)
+      file_words = words[1..4]&.compact || []
+      if file_words.empty?
+        'blank'
+      else
+        file_words.map { |w| normalize_path_component(w) }.join('_')
+      end
+    end
+
+    sig { params(base_path: String, file_base: String, timestamp: String).returns(String) }
+    def create_unique_filepath(base_path, file_base, timestamp)
+      file_path = File.join(base_path, "#{file_base}_#{timestamp}.md")
+
+      counter = 1
+      while File.exist?(file_path)
+        file_path = File.join(base_path, "#{file_base}_#{counter}_#{timestamp}.md")
+        counter += 1
+      end
+
+      file_path
+    end
+
+    sig { params(text: String).returns(String) }
+    def strip_frontmatter(text)
+      if text.start_with?("---\n")
+        # Ignore everything between the first and second "---"
+        parts = text.split("---\n", 3)
+        return parts[2] || '' if parts.size >= 3
+      end
+      text
+    end
+
+    sig { params(component: String).returns(String) }
+    def normalize_path_component(component)
+      # Convert to lowercase, remove non-alphanumeric chars, replace spaces with underscore
+      normalized = component.downcase.gsub(/[^a-z0-9\s]/, '').gsub(/\s+/, '_')
+      # Truncate to avoid filesystem issues
+      T.must(normalized[0..63])
+    end
+  end
+end

data/lib/zhuzh/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+# typed: strict
+
+require 'sorbet-runtime'
+
+module Zhuzh
+  extend T::Sig
+
+  VERSION = T.let('0.1.0', String)
+end

data/lib/zhuzh.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+# typed: strict
+
+require 'sorbet-runtime'
+require_relative 'zhuzh/version'
+require_relative 'zhuzh/config'
+require_relative 'zhuzh/note'
+require_relative 'zhuzh/cli'
+
+module Zhuzh
+  class Error < StandardError; end
+
+  # Common utility methods for Zhuhz
+  module Utils
+    extend T::Sig
+
+    # Creates a directory and its parent directories if they don't exist
+    sig { params(dir: String).void }
+    def self.ensure_directory_exists(dir)
+      FileUtils.mkdir_p(dir)
+    end
+  end
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: zhuzh
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fuzz Leonard
+bindir: bin
+cert_chain: []
+date: 2025-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.38'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.38'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: sorbet
+  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: tapioca
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: A tool for easily creating and managing markdown notes
+email:
+- ink@fuzz.ink
+executables:
+- zz
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/tapioca
+- bin/zz
+- lib/zhuzh.rb
+- lib/zhuzh/cli.rb
+- lib/zhuzh/config.rb
+- lib/zhuzh/note.rb
+- lib/zhuzh/version.rb
+homepage: https://github.com/fuzz/zhuhz
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.3
+specification_version: 4
+summary: Simple markdown note management
+test_files: []