snippit 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9e6f255093428dc4ac4db2ce12c14e9d78e45f1cdfb07eeccb19ea7736bef6e
-  data.tar.gz: a764c0e2abaffd53c42bd1556cc9ce76bf9fd2ce7b596299eb61fe0fadbe297d
+  metadata.gz: 5775f3ab82f74a1c2c4e713c05019b3143806abcb03f19edcff00190febd6a80
+  data.tar.gz: 66506019f73d7a499a56da84ffee296be03b60c7e41eb9bce59cc9eafe48c888
 SHA512:
-  metadata.gz: 72f6978a479de66cbe424658b48fce6f0f85b8015c58b193b5d967b9eca4966b10d5ecf0287e67007485db551c202b7d15096a9311fe2c5ece7ebe67b25fc51e
-  data.tar.gz: 03b95c849abf6b52e9f09b8681531b47b3fc9d5a8dd8015ba40293835d4c8144afd09aff57959499efafd6cc55b3629898df60bcbb5675ccefebefd71eb293c9
+  metadata.gz: b7375cc306156e3fd6d9597227355750c9567a62f2b9e75eb61a4110ade50b6767a5f4d335fa8da62f1c9765a7288ee4e4fbd413ee576427ef4a69e59bcbc04d
+  data.tar.gz: 561467cabc034d3dde1a223b90f6f9af30dd041a139018a0b0b9149985426295f28d0ad1eaa2bbb289bdeae8e0f36e8e14bf10f6ab953ca8a8b2e3c1259d140e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snippit (0.0.1)
+    snippit (1.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -13,16 +13,16 @@ GEM
     docile (1.4.0)
     iniparse (1.5.0)
     json (2.6.3)
-    overcommit (0.59.1)
+    overcommit (0.60.0)
       childprocess (>= 0.6.3, < 5)
       iniparse (~> 1.4)
       rexml (~> 3.2)
     parallel (1.22.1)
-    parser (3.1.3.0)
+    parser (3.2.0.0)
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.1)
+    regexp_parser (2.6.2)
     rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -30,34 +30,37 @@ GEM
       rspec-mocks (~> 3.12.0)
     rspec-core (3.12.0)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.0)
+    rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.0)
+    rspec-mocks (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-snapshot (2.0.1)
       awesome_print (> 1.0.0)
       rspec (> 3.0.0)
     rspec-support (3.12.0)
-    rubocop (1.40.0)
+    rubocop (1.44.1)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      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.23.0, < 2.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.24.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
       parser (>= 3.1.1.0)
+    rubocop-capybara (2.17.0)
+      rubocop (~> 1.41)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.15.0)
+    rubocop-rspec (2.18.1)
       rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
     ruby-progressbar (1.11.0)
-    simplecov (0.21.2)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
@@ -66,13 +69,13 @@ GEM
       simplecov (~> 0.19)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    unicode-display_width (2.3.0)
+    unicode-display_width (2.4.2)
     webrick (1.7.0)
     yard (0.9.28)
       webrick (~> 1.7.0)
 
 PLATFORMS
-  ruby
+  x86_64-linux
 
 DEPENDENCIES
   bundler (~> 2.0)
@@ -89,4 +92,4 @@ DEPENDENCIES
   yard (~> 0.9.28)
 
 BUNDLED WITH
-   2.1.2
+   2.4.5

data/README.md

@@ -1,25 +1,33 @@
-# Snippit (WIP)
+# Snippit
 
+[![Gem Version](https://badge.fury.io/rb/snippit.svg)](https://badge.fury.io/rb/snippit)
 [![CI](https://github.com/spenserblack/snippit/actions/workflows/ci.yml/badge.svg)](https://github.com/spenserblack/snippit/actions/workflows/ci.yml)
-[![CodeQL](https://github.com/spenserblack/snippit/actions/workflows/codeql.yml/badge.svg)](https://github.com/spenserblack/snippit/actions/workflows/codeql.yml)
+[![CodeQL](https://github.com/spenserblack/snippit/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/spenserblack/snippit/actions/workflows/github-code-scanning/codeql)
 [![codecov](https://codecov.io/gh/spenserblack/snippit/branch/main/graph/badge.svg?token=5yr1302Knn)](https://codecov.io/gh/spenserblack/snippit)
 
 Define, store, and output your code snippets.
 
-## (Proposed) Usage
+## Usage
 
 All uses of `snippit` can be replaced with the shortcut `snip`.
 
 ```console
 # Define a snippet called "hello-world.js"
-$ snippit save hello-world.js
+$ snippit --save hello-world.js
 
-# Make a code snippet called "Hello World (JS)" from STDIN
-$ echo "console.log('Hello, World!');" | snippit save --name "Hello World (JS)"
+# Set the slug and descriptive name of the snippet
+$ snippit --save hello-world.js --slug hw-js --name "JavaScript Starter"
 
-# Output the "Hello World (JS)" snippet to a file called "index.js"
-$ snippit out "Hello World (JS)" > index.js
+# Output the "JavaScript Starter" snippet to a file called "index.js"
+$ snippit --get hw-js > index.js
 
 # List all of your code snippets
-$ snippit list
+$ snippit --list
 ```
+
+## How it works
+
+Code snippets get stored in a directory called `.snippit` in your home
+directory. The actual code snippet filenames are slugified versions of the
+snippet name. `.__definitions__.yml` is a reserved filename, as it is used to
+map snippet slugs (filenames) to their human-readable names.

data/RELEASE_NOTES

@@ -0,0 +1,13 @@
+Initial Version
+
+## Added
+
+- `snippit --save` to save snippets
+  - `--add` alias
+  - `--force` to force overwriting
+  - `--name` to set a different name
+  - `--slug` to use a different slug (ID)
+- `snippit --get` to get snippets
+- `snippit --delete` to delete snippets
+- `snippit --list` to list available snippets
+- `snip` as an alias of `snippit`

data/exe/snip

@@ -3,4 +3,4 @@
 
 require 'snippit/cli'
 
-Snippit::CLI.start(ARGV)
+exit Snippit::CLI.new(ARGV).start

data/exe/snippit

@@ -3,4 +3,4 @@
 
 require 'snippit/cli'
 
-Snippit::CLI.start(ARGV)
+exit Snippit::CLI.new(ARGV).start

data/lib/snippit/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/snippit/cli/delete.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'snippit/io'
+
+module Snippit
+  class CLI
+    # Snippit::CLI::Delete deletes a snippet.
+    class Delete
+      include Snippit::IO
+
+      def initialize(slug)
+        @slug = slug
+      end
+
+      # Starts the delete subcommand.
+      #
+      # @return [Integer] the exit code
+      def start
+        return 1 unless definitions.key?(@slug)
+
+        delete_snippet(@slug)
+        0
+      end
+    end
+  end
+end

data/lib/snippit/cli/get.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'snippit/io'
+
+module Snippit
+  class CLI
+    # Snippit::CLI::Get gets a snippet's contents.
+    class Get
+      include Snippit::IO
+
+      def initialize(slug)
+        @slug = slug
+      end
+
+      # Starts the get subcommand.
+      #
+      # @return [Integer] the exit code
+      def start
+        unless definitions.key?(@slug)
+          warn "Snippet '#{@slug}' does not exist."
+          return 1
+        end
+
+        print read_snippet(@slug)
+        0
+      end
+    end
+  end
+end

data/lib/snippit/cli/list.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'snippit/io'
+
+module Snippit
+  class CLI
+    # Snippit::CLI::List lists all snippets.
+    class List
+      include Snippit::IO
+
+      # Starts the list subcommand.
+      #
+      # @return [Integer] the exit code
+      def start
+        out = definitions.map { |slug, name| "#{slug}: #{name}" }
+
+        puts 'No snippets found.' if out.empty?
+
+        puts out
+        0
+      end
+    end
+  end
+end

data/lib/snippit/cli/save.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'snippit/exceptions'
+require 'snippit/io'
+require 'snippit/slugify'
+
+module Snippit
+  class CLI
+    # Snippit::CLI::Save saves a new snippet, or overwrites an existing one.
+    class Save
+      include Snippit::IO
+      include Snippit::Slugify
+
+      # Initializes a new Save subcommand.
+      #
+      # @param [String] path The path to the snippet to save
+      # @param [TrueClass|FalseClass] force
+      def initialize(path, force: false, name: nil, slug: nil)
+        @force = force
+        @path = path
+        @name = name
+        @slug = slug
+      end
+
+      # Starts the save subcommand.
+      #
+      # @return [Integer] the exit code
+      def start
+        base_name = File.basename(@path)
+        slug = @slug || slugify(base_name)
+
+        handle(slug) { write_snippet(@name || base_name, slug, File.read(@path), @force) }
+      end
+
+      private
+
+      # Executes a provided block, handling errors.
+      def handle(slug)
+        begin
+          yield
+        rescue Snippit::SnippetExistsError
+          warn "Snippet #{slug} already exists. Use --force to overwrite."
+          return 1
+        rescue Snippit::ReservedFilenameError
+          warn "#{slug} is a reserved filename. Please choose another."
+          return 1
+        end
+
+        0
+      end
+    end
+  end
+end

data/lib/snippit/cli/version.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'snippit/version'
+
+module Snippit
+  class CLI
+    # Snippit::CLI::Version is the version subcommand for Snippit::CLI.
+    class Version
+      # Starts the version subcommand.
+      #
+      # @return [Integer] the exit code
+      def start
+        puts "snippit #{Snippit::VERSION}"
+        0
+      end
+    end
+  end
+end

data/lib/snippit/cli.rb

@@ -1,20 +1,106 @@
 # frozen_string_literal: true
 
-require 'snippit'
+require 'optparse'
+require 'snippit/cli/delete'
+require 'snippit/cli/get'
+require 'snippit/cli/list'
+require 'snippit/cli/save'
+require 'snippit/cli/version'
 
 module Snippit
   # Snippit::CLI is the command line interface for Snippit.
   class CLI
-    def self.start(args)
-      new(args).run
-    end
-
     def initialize(args)
       @args = args
+      @opts = {}
+    end
+
+    # Starts the CLI.
+    #
+    # @return [Integer] the exit code
+    def start
+      parser.parse!(@args)
+
+      return Version.new.start if @opts[:version]
+
+      result = start_io
+      return result unless result.nil?
+
+      bad_usage
+    end
+
+    private
+
+    def parser
+      OptionParser.new do |opts|
+        opts.banner = 'Usage: snippit|snip [options]'
+        opts.separator ''
+        opts.separator 'Options:'
+        add_list_option(opts)
+        add_save_option(opts)
+        add_get_option(opts)
+        add_delete_option(opts)
+        add_version_option(opts)
+      end
+    end
+
+    def add_save_option(opts)
+      opts.on('-s', '-a', '--save PATH', '--add PATH', 'Save a new snippet') do |path|
+        @opts[:save] = path
+      end
+      add_save_helper_options(opts)
+    end
+
+    def add_save_helper_options(opts)
+      opts.on('-f', '--force', 'Used with --save to overwrite existing snippets') do
+        @opts[:force] = true
+      end
+      opts.on('-n', '--name NAME', 'Used with --save to set the snippet name') do |name|
+        @opts[:name] = name
+      end
+      opts.on('-S', '--slug SLUG', 'Used with --save to set the snippet slug') do |slug|
+        @opts[:slug] = slug
+      end
     end
 
-    def run
-      puts 'Hello, world!'
+    def add_get_option(opts)
+      opts.on('-g', '--get SLUG', 'Get a snippet') do |slug|
+        @opts[:get] = slug
+      end
+    end
+
+    def add_delete_option(opts)
+      opts.on('-d', '--delete SLUG', 'Delete a snippet') do |slug|
+        @opts[:delete] = slug
+      end
+    end
+
+    def add_list_option(opts)
+      opts.on('-l', '--list', 'List all snippet slugs and their names') do
+        @opts[:list] = true
+      end
+    end
+
+    def add_version_option(opts)
+      opts.on('-v', '--version', 'Print version') do
+        @opts[:version] = true
+      end
+    end
+
+    def bad_usage
+      puts parser
+      1
+    end
+
+    # Handles options that require IO.
+    def start_io
+      return List.new.start if @opts[:list]
+
+      return Save.new(@opts[:save], **@opts.slice(:force, :name, :slug)).start if @opts.key?(:save)
+
+      return Get.new(@opts[:get]).start if @opts.key?(:get)
+
+      return Delete.new(@opts[:delete]).start if @opts.key?(:delete)
     end
   end
 end

data/lib/snippit/exceptions.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Snippit
+  class Error < RuntimeError
+  end
+
+  class SnippetExistsError < Error
+  end
+
+  class SnippetNotFoundError < Error
+  end
+
+  class ReservedFilenameError < Error
+  end
+end

data/lib/snippit/io.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'snippit/exceptions'
+require 'yaml'
+
+module Snippit
+  # Provides IO functions for Snippit.
+  module IO
+    # Reads teh contents of a code snippet.
+    #
+    # @param [String] slug The name of the snippet.
+    # @return [String] The contents of the snippet.
+    def read_snippet(slug)
+      raise SnippetNotFoundError, slug unless File.exist?(filepath!(slug))
+
+      File.read(filepath!(slug))
+    end
+
+    # Writes the contents of a code snippet to a file.
+    #
+    # @param [String] name The name of the snippet
+    # @param [String] slug The name of the file. Relative to the ~/.snippit directory
+    # @param [String] contents The contents of the file.
+    # @param [TrueClass|FalseClass] force Whether or not to overwrite an existing file.
+    def write_snippet(name, slug, contents, force)
+      raise ReservedFilenameError, slug if slug == '.__definitions__.yml'
+
+      raise SnippetExistsError, slug if File.exist?(filepath!(slug)) && !force
+
+      File.write(filepath!(slug), contents)
+      write_definition(definitions.merge(slug => name))
+    end
+
+    # Removes a code snippet.
+    #
+    # @param [String] slug The name of the file. Relative to the ~/.snippit directory
+    def delete_snippet(slug)
+      raise ReservedFilenameError, slug if slug == '.__definitions__.yml'
+
+      File.delete(filepath!(slug))
+      write_definition(definitions.reject { |k, _v| k == slug })
+    end
+
+    # Gets the filepath to the snippet.
+    #
+    # Also creates the ~/.snippit directory if it does not exist.
+    #
+    # @param [String] slug The name of the snippet.
+    def filepath!(slug)
+      File.expand_path(slug, snippit_dir!)
+    end
+
+    # Creates the ~/.snippit directory if it does not exist, and returns the path to it.
+    def snippit_dir!
+      FileUtils.mkdir_p(snippit_dir)
+      snippit_dir
+    end
+
+    # Returns the path to the ~/.snippit directory.
+    def snippit_dir
+      File.expand_path('.snippit', Dir.home)
+    end
+
+    # Loads the ~/.snippit/.__definitions__.yml file if it exists, or returns an empty hash.
+    def definitions
+      return {} unless File.exist?(definitions_file)
+
+      @definitions ||= YAML.load_file(definitions_file)
+    end
+
+    # Writes the definitions to the ~/.snippit/.__definitions__.yml file.
+    def write_definition(definitions)
+      File.write(definitions_file, definitions.to_yaml)
+    end
+
+    # Returns the path to the ~/.snippit/.__definitions__.yml file.
+    def definitions_file
+      File.expand_path('.__definitions__.yml', snippit_dir)
+    end
+  end
+end

data/lib/snippit/slugify.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Snippit
+  # Provides the slugify function
+  module Slugify
+    # Slugify a string
+    #
+    # @param [String] str The string to slugify
+    # @return [String] The slugified string
+    def slugify(str)
+      str.strip.downcase.gsub(/ /, '-').gsub(/[^a-z0-9\-_.]/, '')
+    end
+  end
+end

data/lib/snippit/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Snippit
+  VERSION = File.read(File.expand_path('VERSION', __dir__)).strip
+end

data/lib/snippit.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+require 'snippit/version'
+
 # Snippit manages code snippets.
-module Snippit
+class Snippit
   # Snippit::DEFINITIONS is a reserved filename for the snippet definitions.
   DEFINITIONS = '__definitions__.yml'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snippit
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Spenser Black
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-13 00:00:00.000000000 Z
+date: 2023-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -175,11 +175,22 @@ files:
 - Gemfile
 - Gemfile.lock
 - README.md
+- RELEASE_NOTES
 - Rakefile
 - exe/snip
 - exe/snippit
 - lib/snippit.rb
+- lib/snippit/VERSION
 - lib/snippit/cli.rb
+- lib/snippit/cli/delete.rb
+- lib/snippit/cli/get.rb
+- lib/snippit/cli/list.rb
+- lib/snippit/cli/save.rb
+- lib/snippit/cli/version.rb
+- lib/snippit/exceptions.rb
+- lib/snippit/io.rb
+- lib/snippit/slugify.rb
+- lib/snippit/version.rb
 homepage: https://github.com/spenserblack/snippit
 licenses:
 - MIT
@@ -205,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Manage your personal code snippets