snibbets 2.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b4b5be01b0a7d1768bef21a63ffd7c1f1f176a77d6d3fa1be5ff84db7b0b27eb
+  data.tar.gz: 7c65f52ecb3dacbeea62c8225f9dc70db7d90d358a4c284050b7149a9b19fe75
+SHA512:
+  metadata.gz: e4adffb0b196b8f891ac9363fdcb91a67dccfc579530568e336dd1ced2d7d8f6c7f4496fa1c4cbe992e24655a37a7808bd49c48e44d75623a2c1fa0fb1615bb9
+  data.tar.gz: 796ec5249c2c7332132ac2138d5281c05aab7259b75726319f247499543a15c4b839d6929e764850a8bbc907747a42a179d3b61625e4b4fff7ca90f698c24509

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+### 2.0.7
+
+2023-04-15 12:02
+
+### 2.0.6
+
+2023-04-15 11:55
+
+#### IMPROVED
+
+- Refactor script as modules and classes
+
+## 2.0.2
+
+Initial release as a gem

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in snibbets.gemspec.
+gemspec

data/Gemfile.lock

@@ -0,0 +1,96 @@
+PATH
+  remote: .
+  specs:
+    snibbets (2.0.3)
+      tty-which (~> 0.5, >= 0.5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    gem-release (2.2.2)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    multi_json (1.15.0)
+    parallel (1.22.1)
+    parse_gemspec (1.0.0)
+    parse_gemspec-cli (1.0.0)
+      multi_json
+      parse_gemspec
+      thor
+    parser (3.2.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rdoc (4.3.0)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.48.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-console (0.9.1)
+      ansi
+      simplecov
+      terminal-table
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    standard (1.26.0)
+      language_server-protocol (~> 3.17.0.2)
+      rubocop (~> 1.48.1)
+      rubocop-performance (~> 1.16.0)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    thor (1.2.1)
+    tty-which (0.5.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-20
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  gem-release (~> 2.2)
+  parse_gemspec-cli (~> 1.0)
+  rake (~> 13.0)
+  rdoc (~> 4.3)
+  rspec (~> 3.0)
+  simplecov (~> 0.21)
+  simplecov-console (~> 0.9)
+  snibbets!
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.2.29

data/LICENSE.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Brett Terpstra
+
+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,173 @@
+# Snibbets
+
+[![RubyGems.org](https://img.shields.io/gem/v/snibbets)](https://rubygems.org/gems/snibbets)
+[![GitHub Actions](https://github.com/ttscoff/snibbets/actions/workflows/check.yml/badge.svg)](https://github.com/ttscoff/snibbets/actions/workflows/check.yml)
+
+<!--README-->
+A tool for accessing code snippets contained in a folder of plain text Markdown files.
+
+Snibbets allows me to keep code snippets in raw files, not relying on a dedicated code snippet app. I can collect and edit my snippets using a text editor, nvALT (nvUltra), or simply by saving snippets from my clipboard to a text file using *NIX redirection on the command line. I can add descriptive names and extended descriptions/notes to code snippets using standard Markdown.
+
+What Snibbets does is simply allow a quick search for a specific snippet that I can either output to the terminal, pipe to my clipboard, or access via LaunchBar (via the included LaunchBar Action). It's basically a wrapper for `find` and `grep` with the ability to separate code blocks from other text in my Markdown files.
+
+<!--GITHUB-->
+![Snibbets in action](https://cdn3.brettterpstra.com/uploads/2023/04/snibbets2.gif)
+<!--END GITHUB-->
+<!--JEKYLL{% gif /uploads/2023/04/snibbets2.gif %}-->
+
+## Collecting Snippets
+
+Snibbets is designed to work with a folder containing Markdown files. Each Markdown file can have somewhat flexible formatting, as long as there's at least one code block (either indented by 4 spaces/1 tab or fenced with backticks).
+
+I recommend using filenames with multiple extensions (ending with your markdown extension), primarily to define the syntax for a snippet. For example, a css snippet would be `*.css.md`, a ruby snippet would be `*.rb.md`. This can aid in searching and makes it easy to script things like adding language tags automatically.
+
+The name of the file should be the description of the snippet, at least in the case where there's only one snippet in the document. Call it 'javascript url parser.js.md' or similar. If I got the snippet from StackOverflow, I give it a name based on the question I searched to find it. Be descriptive.
+
+You can combine multiple snippets in a file, though. For example, I have a file called 'Ruby hash snippets.rb.md'. That file contains an array of useful snippets, and each one has a descriptive title in an h3 header above it. Those (ATX) headers are used to split the file, and when you search from the command line, you'll get a menu of all of the snippets in the selected file. (And if you have [fzf](https://github.com/junegunn/fzf) or [gum](https://github.com/charmbracelet/gum) installed, you can quickly filter through with fuzzy searching and find exactly what you need.)
+
+If a file contains multiple snippets, they should be separated by ATX-style headers (one or more `#`) describing the snippets. Additional  descriptions can be included outside of the code block. For example:
+
+A file titled `unix find.bash.md`:
+
+    title: Unix find commands
+    tags: bash, shell, unix
+
+    ### Find by name and execute command
+
+        find . -name "rc.conf" -exec chmod o r '{}' \;
+
+    ### Find by name and grep contents
+
+        find . -name "*.php" -exec grep -H googleapis '{}' \;
+
+    ### Find by age range to CSV
+
+    Finds files older than 18months and newer than 24 months, cats the output to a CSV in the format `/some/path/somewhere, size in bytes, Access Time, Modified Time`
+
+        find /dir/dir -type f -mtime +540 -mtime -720 -printf \"%p\",\"%s\",\"%AD\",|"%TD\"\\n > /dir/dir/output.csv
+
+You can include MultiMarkdown metadata in your snippets, either in a YAML block or just at the top of the file with raw key/value pairs. I mostly use this for adding tags, which are then synced to macOS tags when I save. It makes it easy to search for snippets in [nvUltra](https://nvultra.com/), and also allows you to do searches like `snibbets tag:javascript url parser` in Snibbets.
+
+## CLI
+
+### Dependencies
+
+Snibbets requires Ruby 3.0+. On recent versions of macOS, this is not included by default. You can install it via the Command Line Tools from Apple. On macOS and most other systems, you can use something like [Homebrew], [rbenv], [rvm], or [asdf] to install Ruby 3.
+
+If available, menus are generated by [fzf] or [gum]. If neither are available, a basic Readline menu system will be displayed, so neither are required, just nice to have as they provide fuzzy filtering, scrolling, and type-ahead completion.
+
+[homebrew]: https://brew.sh/ "Homebrew—The Missing Package Manager for macOS (or Linux)"
+[rbenv]: https://github.com/rbenv/rbenv "rbenv/rbenv:Manage your app's Ruby environment"
+[rvm]: https://rvm.io/ "Ruby Version Manager"
+[asdf]: https://asdf-vm.com/ "ASDF environment manager"
+[fzf]: https://github.com/junegunn/fzf "junegunn/fzf:A command-line fuzzy finder"
+[gum]: https://github.com/charmbracelet/gum "charmbracelet/gum:A tool for glamorous shell scripts 🎀"
+
+### Installation
+
+To install Snibbets:
+
+    gem install snibbets
+
+If you're using the system Ruby, you may need to use `sudo gem install snibbets`.
+
+### Configuration
+
+When you run it the first time, Snibbets will write a configuration file to `~/.config/snibbets/snibbets.yml`. You can edit that file to set things like your snippets directory, your preferred file extension, and a few other options. Options specified in the config file can always be overriden on the command line with flags.
+
+Once an editor is defined, you can use `snibbets --configure` to open it automatically. Running that commmand before configuring an editor will use whatever app/utility your system defaults to for YAML files.
+
+Default config:
+
+```yaml
+---
+all: false
+copy: false
+editor: 
+extension: md
+highlight: false
+interactive: true
+launchbar: false
+name_only: false
+output: raw
+source: "~/Dropbox/Snippets"
+```
+
+#### Snippet Location
+
+Set the `source` key to the folder where you keep your Markdown snippets. Optionally adjust the `extension` setting if you use an extension other than `md` (e.g. `markdown` or `txt`).
+
+#### Other Options
+
+The `all` setting determines how Snibbets handles files containing multiple snippets. If `all` is true, then it will always display every snippet in the selected file. If false, it will offer a menu and let you choose which snippet to display. You can use `--all` on the command line to just enable this once.
+
+The `copy` setting determines whether the output is copied to the clipboard in addition to being displayed on STDOUT. This is the equivalent of running `snibbets QUERY | pbcopy` (macOS) or `snibbets QUERY | xclip` (Linux). This can be enabled for just one run with `--copy` on the command line. Setting it to true in the config will copy to the clipboard every time a snippet is displayed. On Mac this will work automatically, on Windows/Linux you may need to [install `xclip` or `xsel`][xclip].
+
+[xclip]: https://ostechnix.com/access-clipboard-contents-using-xclip-and-xsel-in-linux/
+
+The `editor` setting is used to open the config file, and to open snippets for editing when using the `--edit` flag. This setting can be any command line utility (`code`, `subl`, `vim`, `nano`, etc.), or on macOS it can be an application name (`BBEdit`, `VS Code`, etc.) or a bundle identifier (`com.sublimetext.4`, `com.microsoft.VSCode`, etc.). If no editor is set, then the file will be opened by whatever the system default is (using `open` on macOS, `start` on Windows, or `xdg-open`on Linux).
+
+The `highlight` key turns on syntax highlighting. This requires that either `pygmentize` or `skyligting` is available on your system (both available via package managers like Homebrew). This feature is still in development and results may be mixed.
+
+The `interactive` setting determines whether menus will be displayed. This should generally be true, but if you want silent operation that just displays the best match automatically, set it to false. 
+
+The `name_only` key will permanently set Snibbets to only search for snippets by their filename rather than examining their contents. You can enable this at runtime using `--name-only` in the command.
+
+### Usage
+
+    Usage: snibbets [options] query
+        -a, --all                        If a file contains multiple snippets, output all of them (no menu)
+        -c, --[no-]copy                  Copy the output to the clibpoard (also displays on STDOUT)
+        -e, --edit                       Open the selected snippet in your configured editor
+        -n, --[no-]name-only             Only search file names, not content
+        -o, --output FORMAT              Output format (json|launchbar|*raw)
+        -p, --paste                      Interactively create a new snippet from clipboard contents (Mac only)
+        -q, --quiet                      Skip menus and display first match
+        -s, --source FOLDER              Snippets folder to search
+            --configure                  Open the configuration file in your default editor
+            --highlight                  Use pygments or skylighting to syntax highlight (if installed)
+            --save                       Save the current command line options to the YAML configuration
+        -h, --help                       Display this screen
+        -v, --version                    Display version information
+
+If your Snippets folder is set in the config, simply running `snibbets [search query]` will perform the search and output the code blocks, presenting a menu if more than one match is found or the target file contains more than one snippet. Selected contents are output raw to STDOUT.
+
+> If you have fzf or gum installed, snibbets will use those for menus, providing fuzzy filtering of options.
+
+#### JSON output
+
+An undocumented output option is `-o json`, which will output all of the matches and their code blocks as a JSON string that can be incorporated into other scripts. It's similar to the `-o launchbar` option, but doesn't contain the extra keys required for the LaunchBar action.
+
+#### Open snippets in your editor
+
+Use the `--edit` flag on any search to open the found snippet file in your editor. Configure your default editor in the config file. `snibbets configure` will open that, but if you don't have an editor set, it might have strange results. To edit manually, open `~/.config/snibbets/snibbets.yml` in your text editor of choice.
+
+#### Creating new snippets
+
+I do most of my snippet editing in [nvUltra], but sometimes I have a function in my clipboard that just needs quick saving and there are so few moving parts to creating a snippet that it just feels like they could be automated/simplified. That's why I added the `--paste` flag. If you have a code snippet in your clipboard, you can just run `snibbets --paste` (or just `-p`) and you'll get a prompt asking you to describe the snippet (used for filename) and one asking what language(s) are represented.
+
+You can input the languages as names, e.g. `rust`, `typescript`, or `scala`, or you can just add file extensions that represent the language. If I say `ts` to that prompt, it will generate an extension of `.ts.md` and then add a metadata tag of `typescript` to the file. The code from the clipboard goes into a fenced code block in the document. You can always go add notes to it later, but it's a great way to save snippets as you come across them (or solutions you figure out after a week of banging your head).
+
+This command requires that a clipboard utility be available. On macOS, you have `pbpaste` by default and don't need to do anything. On Windows and Linux, you'll need to [install either `xclip` or `xsel`][xclip].
+
+[nvUltra]: https://nvultra.com "nvUltra for Mac"
+
+
+#### Saving Settings When Running
+
+Any time you specify things like a source folder with the `--source` flag, or turn on highlighting or name-only search, you can add the flag `--save` to write those to your config and make them the default options.
+
+## LaunchBar Action
+
+_I'm currently reworking the LaunchBar action, and it doesn't function very well at this time. I'll update when I have a chance._
+
+### Installation
+
+The LaunchBar action can be installed simply by double clicking the `.lbaction` file in Finder. The CLI is not required for the LaunchBar action to function. 
+
+Once installed, run the action (type `snib` and hit return on the result) to select your Snippets folder.
+
+### Usage
+
+Type `snib` to bring the Action up, then hit Space to enter your query text. Matching files will be presented. If the selected file contains more than one snippet, a list of snippets (based on ATX headers in the file) will be presented as a child menu. Selecting a snippet and hitting return will copy the associated code block to the clipboard.
+<!--END README-->

data/README.rdoc

@@ -0,0 +1,6 @@
+= Snibbets
+
+A command line tool for managing a code snippet collection in plain text (Markdown).
+
+
+

data/Rakefile

@@ -0,0 +1,87 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rdoc/task'
+require 'standard/rake'
+require 'yard'
+
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc", "lib/**/*.rb", "bin/**/*")
+  rd.title = 'Snibbets'
+end
+
+YARD::Rake::YardocTask.new do |t|
+ t.files = ['lib/na/*.rb']
+ t.options = ['--markup-provider=redcarpet', '--markup=markdown', '--no-private', '-p', 'yard_templates']
+ # t.stats_options = ['--list-undoc']
+end
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "--pattern {spec,lib}/**/*_spec.rb"
+end
+
+task default: %i[test]
+
+desc 'Alias for build (so it shows up in rake -T)'
+task :package do
+  Rake::Task['build'].invoke
+end
+
+task test: "spec"
+task lint: "standard"
+task format: "standard:fix"
+
+desc "Open an interactive ruby console"
+task :console do
+  require "irb"
+  require "bundler/setup"
+  require "snibbets"
+  ARGV.clear
+  IRB.start
+end
+
+desc 'Development version check'
+task :ver do
+  gver = `git ver`
+  cver = IO.read(File.join(File.dirname(__FILE__), 'CHANGELOG.md')).match(/^#+ (\d+\.\d+\.\d+(\w+)?)/)[1]
+  res = `grep VERSION lib/snibbets/version.rb`
+  version = res.match(/VERSION *= *['"](\d+\.\d+\.\d+(\w+)?)/)[1]
+  puts "git tag: #{gver}"
+  puts "version.rb: #{version}"
+  puts "changelog: #{cver}"
+end
+
+desc 'Changelog version check'
+task :cver do
+  puts IO.read(File.join(File.dirname(__FILE__), 'CHANGELOG.md')).match(/^#+ (\d+\.\d+\.\d+(\w+)?)/)[1]
+end
+
+desc 'Bump incremental version number'
+task :bump, :type do |_, args|
+  args.with_defaults(type: 'inc')
+  version_file = 'lib/snibbets/version.rb'
+  content = IO.read(version_file)
+  content.sub!(/VERSION = '(?<major>\d+)\.(?<minor>\d+)\.(?<inc>\d+)(?<pre>\S+)?'/) do
+    m = Regexp.last_match
+    major = m['major'].to_i
+    minor = m['minor'].to_i
+    inc = m['inc'].to_i
+    pre = m['pre']
+
+    case args[:type]
+    when /^maj/
+      major += 1
+      minor = 0
+      inc = 0
+    when /^min/
+      minor += 1
+      inc = 0
+    else
+      inc += 1
+    end
+
+    $stdout.puts "At version #{major}.#{minor}.#{inc}#{pre}"
+    "VERSION = '#{major}.#{minor}.#{inc}#{pre}'"
+  end
+  File.open(version_file, 'w+') { |f| f.puts content }
+end