code_snippet 0.2.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59c5c839aadfe64707cd9263e404a696ae8309679428b36e9b774146a6a4f582
-  data.tar.gz: 053cf881c099b8b860d87c6fa8a2e89542601c1fbb8007985e6ee5a3d05ed68b
+  metadata.gz: 8150df6bfc6ffaa3432d2bc2e867406e2600bf4c7a66c2a4f944ead7dbfa78b3
+  data.tar.gz: 6377217cee2607224d5716a353b8d27ffe4311858464650c24b1bef66561cb2c
 SHA512:
-  metadata.gz: 38e4c0336de7caae9d98e89049eca65a8e5bf3c5e5c8ffdf24e9de5a29628bcc5bf55168a0989e83a7c7717c5320b73e1c5c809f3a9af61a976680ba091dbe04
-  data.tar.gz: be6b4f54ea41148b9dc7e90a1b7df556e402bbed6e1d93e191cf7ac86be44f22cdff5c94eebb635cfba548aaa1f9e8acb00389e2a8849ee6c6e6c520214bb3b9
+  metadata.gz: 948f14c6989daf999bed5b262cb6c77eb5f8d7c2e5eeb2910fcf1ae80b31b6303ec1b0e821967c74680c90ab244cd0e9b1d4ed3cc016bd188143747a7fc18e86
+  data.tar.gz: 1ba523a6bf7278e7183fcca35150a01ddb5dac22186426344c5f2b995bd121b9ddf4d1f92d594f247f1db6f8e24552d386cab84bcc6b48d42c8361d100614c2c

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    code_snippet (0.2.7)
+    code_snippet (0.3.0)
       clipboard
       ffi
       hashie
       highline (~> 2.0)
       logger (~> 1.4)
+      thor
       tty-prompt
       tty-table
 
@@ -22,7 +23,7 @@ GEM
       thread_safe (~> 0.3, >= 0.3.1)
     bump (0.6.1)
     byebug (11.0.1)
-    clipboard (1.3.5)
+    clipboard (1.3.6)
     codeclimate-engine-rb (0.4.1)
       virtus (~> 1.0)
     coderay (1.1.2)
@@ -34,7 +35,7 @@ GEM
     docile (1.3.2)
     equalizer (0.0.11)
     erubis (2.7.0)
-    ffi (1.15.3)
+    ffi (1.15.4)
     flay (2.12.1)
       erubis (~> 2.7.0)
       path_expander (~> 1.0)
@@ -51,7 +52,7 @@ GEM
     json (2.2.0)
     launchy (2.4.3)
       addressable (~> 2.3)
-    logger (1.4.3)
+    logger (1.4.4)
     method_source (0.9.2)
     parallel (1.19.1)
     parser (2.5.3.0)
@@ -113,6 +114,7 @@ GEM
       unicode-display_width (>= 1.5, < 3.0)
       unicode_utils (~> 1.4)
     strings-ansi (0.2.0)
+    thor (1.1.0)
     thread_safe (0.3.6)
     tty-color (0.6.0)
     tty-cursor (0.7.1)
@@ -155,4 +157,4 @@ DEPENDENCIES
   yard (~> 0.9)
 
 BUNDLED WITH
-   2.2.16
+   2.2.27

data/README.md

@@ -35,12 +35,9 @@ Once you have a set of snippets, run `snippet list` to show a list of all your s
 ```bash
 $ snippet list
 
-+---------------------+----+-----------------------------------------------------------------+
-|NAME                 |LANG|PATH                                                             |
-+---------------------+----+-----------------------------------------------------------------+
-|for_i                |.go |/Users/me/Code/templates/snippets/golang/for_i.go                |
-|table_test           |.go |/Users/me/Code/templates/snippets/golang/table_test.go           |
-+---------------------+----+-----------------------------------------------------------------+
+NAME                          LANG
+for_i                         .go 
+table_test                    .go
 ```
 
 You can then show a snippet by executing `snippet show <name>`:
@@ -53,7 +50,7 @@ for 1 := 1; i < 10; i++ {
 }
 ```
 
-You can copy the snippet straight to the clipboard by adding the `-c=true` to the end of the command.
+You can copy the snippet straight to the clipboard by adding the `--copy` to the end of the command.
 
 ## Tests and Quality
 

data/bin/code_snippet

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+lib_path = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+
+require 'pry'
+require 'code_snippet/cli'
+
+Signal.trap('INT') do
+  warn("\n#{caller.join("\n")}: interrupted")
+  exit(1)
+end
+
+begin
+  CodeSnippet::CLI.start
+rescue StandardError => e
+  puts "ERROR: #{e.message}"
+  puts e.backtrace.join("\n")
+  exit 1
+end

data/bin/snippet

@@ -1,62 +1,20 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH.unshift(__dir__ + '/../lib')
+lib_path = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
 
-require 'rubygems'
-require 'optparse'
-require 'highline'
-
-require 'code_snippet'
+require 'pry'
 require 'code_snippet/cli'
 
-USAGE = "Snippet is a CLI tool for quick access to code snippets
-
-Usage:\tsnippet <command> <variables> <opts>
-Options:
-  \s\s\s\s--trace\t\t trace mode on
-  -l, --language\t snippet language filter
-  -c, --copy\t\t copy snippet to clipboard
-
-  -h, --help\t\t print usage
-
-Commands:
-  show\t\t\t finds and shows snippet
-  list\t\t\t displays a list of snippets
-
-  path\t\t\t prints configured SNIPPET_DIR
-  version\t\t prints gem version
-".freeze
-
-@trace = false
-@overwrite = false
-
-OptionParser.new do |opts|
-  opts.banner = USAGE
-  opts.on('--trace') { @trace = true }
-
-  opts.on('-l', '--language STRING')  { |l| @lang = l }
-  opts.on('-c', '--copy BOOL')        { @copy = true }
-
-  opts.on_tail('-h', '--help') do
-    CodeSnippet::CLI.print_message_and_exit(USAGE)
-  end
-end.parse!
+Signal.trap('INT') do
+  warn("\n#{caller.join("\n")}: interrupted")
+  exit(1)
+end
 
 begin
-  raise 'ERROR: no command provided' unless ARGV[0]
-
-  cmd = ARGV.shift
-  CodeSnippet::CLI::Commands.public_send(
-    cmd.to_sym,
-    @lang,
-    !@copy.nil?,
-    ARGV
-  )
+  CodeSnippet::CLI.start
 rescue StandardError => e
-  CodeSnippet::CLI.print_message(e)
-  CodeSnippet::CLI.print_message(e.backtrace) if @trace
-  CodeSnippet::CLI.print_message("\n")
-  CodeSnippet::CLI.print_message_and_exit(USAGE)
+  puts "ERROR: #{e.message}"
+  puts e.backtrace.join("\n")
+  exit 1
 end
-
-exit(0)

data/code_snippet.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'hashie'
   spec.add_dependency 'highline', '~> 2.0'
   spec.add_dependency 'logger', '~> 1.4'
+  spec.add_dependency 'thor'
   spec.add_dependency 'tty-prompt'
   spec.add_dependency 'tty-table'
 

data/lib/code_snippet/cli.rb

@@ -1,19 +1,78 @@
-require 'code_snippet/cli/commands'
-require 'code_snippet/cli/presenters'
-
+require 'thor'
 require 'logger'
 
+require 'code_snippet'
+require 'code_snippet/commands'
+
 module CodeSnippet
   # Command line interface helpers and actions
-  module CLI
-    # CLI Helpers
-    class <<self
+  class CLI < ::Thor
+    package_name 'CodeSnippet'
+
+    desc 'version', 'Print code snippet version to STDOUT'
+
+    ##
+    # Runs version command
+    #
+    def version
+      cmd = CodeSnippet::Commands::PrintVersion.new(options)
+      cmd.run
+    end
+
+    map %w[--version -v] => :version
+
+    desc 'path', 'Print snippet directory path to STDOUT'
+
+    ##
+    # Runs version command
+    #
+    def path
+      cmd = CodeSnippet::Commands::PrintPath.new(snip_dir, options)
+      cmd.run
+    end
+
+    desc 'show', 'Find and show snippet'
+
+    method_option(
+      :name,
+      type: :string,
+      desc: 'Name of snippet'
+    )
+
+    method_option(
+      :copy,
+      type: :boolean,
+      desc: 'Should copy snippet to clipboard',
+      default: false
+    )
+
+    ##
+    # Show snippet command
+    #
+    def show
+      cmd = CodeSnippet::Commands::ShowSnippet.new(manager, options)
+      cmd.run
+    end
+
+    desc 'list', 'List all known snippets'
+
+    ##
+    # Show snippet command
+    #
+    def list
+      cmd = CodeSnippet::Commands::ListSnippets.new(manager, options)
+      cmd.run
+    end
+
+    no_commands do
       ##
       # Retrieves snippet dir from environment
       #
       def snip_dir
         @snippet_dir = ENV['SNIPPET_DIR']
+
         raise 'SNIPPET_DIR environment variable not set' unless @snippet_dir
+
         unless File.exist?(@snippet_dir)
           raise "SNIPPET_DIR #{@snippet_dir} does not exist"
         end
@@ -22,30 +81,15 @@ module CodeSnippet
       end
 
       ##
-      # Creates logger for printing messages
+      # Loads and creates snippet manager
       #
-      def logger
-        @logger ||= Logger.new(STDOUT)
-        @logger.formatter = proc do |_sev, _time, _prog, msg|
-          "#{msg}\n"
-        end
-
-        @logger
-      end
-
-      ##
-      # Prints command line message to CLI
+      # @return [CodeSnippet::Manager]
       #
-      def print_message(message)
-        logger.info(message)
-      end
+      def manager
+        @manager ||= CodeSnippet::Manager.new(snip_dir)
+        @manager.load
 
-      ##
-      # Prints a message and then exits with given status code
-      #
-      def print_message_and_exit(message, exit_code = 1)
-        print_message(message)
-        exit(exit_code)
+        @manager
       end
     end
   end

data/lib/code_snippet/commands/list_snippets.rb

@@ -0,0 +1,41 @@
+require 'tty-prompt'
+require 'tty-table'
+
+module CodeSnippet
+  module Commands
+    # Lists snippets in STDOUT
+    class ListSnippets
+      ##
+      # Output table header
+      #
+      RESULT_HEADER = %w[NAME LANG].freeze
+
+      def initialize(manager, options = Hashie::Mash.new)
+        @manager = manager
+        @options = options
+        @prompt = TTY::Prompt.new
+      end
+
+      ##
+      # Prints a list of snippets to STDOUT
+      #
+      def run
+        puts(snippet_list_table.render.strip)
+      end
+
+      private
+
+      def snippet_list_table
+        TTY::Table.new(
+          header: RESULT_HEADER,
+          rows: @manager.snippets.map do |snip|
+            [
+              snip.name.downcase,
+              snip.ext
+            ]
+          end
+        )
+      end
+    end
+  end
+end

data/lib/code_snippet/commands/print_path.rb

@@ -0,0 +1,20 @@
+require 'tty-prompt'
+
+module CodeSnippet
+  module Commands
+    # Prints gem version to STDOUT
+    class PrintPath
+      def initialize(snip_dir, options = Hashie::Mash.new)
+        @snip_dir = snip_dir
+        @options = options
+      end
+
+      ##
+      # Prints gem version
+      #
+      def run
+        puts(@snip_dir)
+      end
+    end
+  end
+end

data/lib/code_snippet/commands/print_version.rb

@@ -0,0 +1,19 @@
+require 'tty-prompt'
+
+module CodeSnippet
+  module Commands
+    # Prints snippet path to STDOUT
+    class PrintVersion
+      def initialize(options = Hashie::Mash.new)
+        @options = options
+      end
+
+      ##
+      # Prints snippet path
+      #
+      def run
+        puts(CodeSnippet::VERSION)
+      end
+    end
+  end
+end

data/lib/code_snippet/commands/show_snippet.rb

@@ -0,0 +1,57 @@
+require 'clipboard'
+require 'tty-prompt'
+
+module CodeSnippet
+  module Commands
+    # Shows snippet in STDOUT
+    class ShowSnippet
+      def initialize(manager, options = Hashie::Mash.new)
+        @manager = manager
+        @options = options
+        @prompt = TTY::Prompt.new
+      end
+
+      ##
+      # Prints snippet path
+      #
+      def run
+        name = @options.name
+        name ||= @prompt.select(
+          'Please choose snippet',
+          @manager.snippet_names
+        )
+
+        snips = find_snippets(name)
+        snip = pick_snippet(snips)
+
+        if @options.copy
+          Clipboard.copy(snip.content)
+          puts "COPIED: #{snip.path}"
+        end
+
+        puts(snip.content)
+      end
+
+      def find_snippets(name)
+        snips = @manager.find(name)
+        raise "unable to find #{name}" if snips.empty?
+
+        snips
+      end
+
+      def pick_snippet(snips)
+        snip = snips.first
+        if snips.length > 1
+          snip_name = @prompt.select(
+            'Multiple snippets found, which one would you like to view?',
+            snips.map(&:name)
+          )
+
+          snip = @manager.find(snip_name).first
+        end
+
+        snip
+      end
+    end
+  end
+end

data/lib/code_snippet/commands.rb

@@ -0,0 +1,13 @@
+require 'hashie'
+
+COMMANDS = File.join(__dir__, 'commands', '*.rb')
+
+Dir[COMMANDS].sort.each do |file|
+  require file
+end
+
+module CodeSnippet
+  # Module for CLI command classes
+  module Commands
+  end
+end

data/lib/code_snippet/manager.rb

@@ -10,7 +10,7 @@ module CodeSnippet
       @snippets = []
     end
 
-    def load_snippets
+    def load
       Dir.glob(File.join(@snippet_dir, '**', '*')).each do |file|
         next if File.directory?(file)
 
@@ -46,5 +46,9 @@ module CodeSnippet
       ext_query = ->(snip) { snip.ext == ext }
       filter(ext_query)
     end
+
+    def snippet_names
+      @snippets.map(&:name)
+    end
   end
 end

data/lib/code_snippet/version.rb

@@ -1,3 +1,3 @@
 module CodeSnippet
-  VERSION = '0.2.7'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/spec/code_snippet/cli_spec.rb

@@ -0,0 +1,203 @@
+require 'spec_helper'
+
+RSpec.describe CodeSnippet::CLI do
+  let(:options) { Hashie::Mash.new }
+  let(:snip_dir) { 'path/to/snippets' }
+  let(:snip_exist) { true }
+
+  subject { described_class.new }
+
+  before do
+    allow(subject).to receive(:options)
+      .and_return(options)
+  end
+
+  describe '#version' do
+    let(:command) { double }
+
+    before do
+      allow(command).to receive(:run)
+      allow(CodeSnippet::Commands::PrintVersion)
+        .to receive(:new)
+        .and_return(command)
+
+      subject.version
+    end
+
+    it 'passes options to command' do
+      expect(CodeSnippet::Commands::PrintVersion)
+        .to have_received(:new).with(options)
+    end
+
+    it 'runs command' do
+      expect(command).to have_received(:run)
+    end
+  end
+
+  describe '#path' do
+    let(:command) { double }
+
+    before do
+      allow(ENV)
+        .to receive(:[])
+        .with('SNIPPET_DIR')
+        .and_return(snip_dir)
+
+      allow(File)
+        .to receive(:exist?)
+        .with(snip_dir)
+        .and_return(snip_exist)
+
+      allow(command).to receive(:run)
+      allow(CodeSnippet::Commands::PrintPath)
+        .to receive(:new)
+        .and_return(command)
+
+      subject.path
+    end
+
+    it 'passes snip_dir and options to command' do
+      expect(CodeSnippet::Commands::PrintPath)
+        .to have_received(:new).with(snip_dir, options)
+    end
+
+    it 'runs command' do
+      expect(command).to have_received(:run)
+    end
+  end
+
+  describe '#show' do
+    let(:command) { double }
+    let(:manager) { CodeSnippet::Manager }
+
+    before do
+      allow(command).to receive(:run)
+      allow(subject)
+        .to receive(:manager)
+        .and_return(manager)
+
+      allow(CodeSnippet::Commands::ShowSnippet)
+        .to receive(:new)
+        .and_return(command)
+
+      subject.show
+    end
+
+    it 'passes manager and options to command' do
+      expect(CodeSnippet::Commands::ShowSnippet)
+        .to have_received(:new).with(manager, options)
+    end
+
+    it 'runs command' do
+      expect(command).to have_received(:run)
+    end
+  end
+
+  describe '#list' do
+    let(:command) { double }
+    let(:manager) { CodeSnippet::Manager }
+
+    before do
+      allow(command).to receive(:run)
+      allow(subject)
+        .to receive(:manager)
+        .and_return(manager)
+
+      allow(CodeSnippet::Commands::ListSnippets)
+        .to receive(:new)
+        .and_return(command)
+
+      subject.list
+    end
+
+    it 'passes manager and options to command' do
+      expect(CodeSnippet::Commands::ListSnippets)
+        .to have_received(:new).with(manager, options)
+    end
+
+    it 'runs command' do
+      expect(command).to have_received(:run)
+    end
+  end
+
+  describe '#snip_dir' do
+    let(:snip_dir) { 'path/to/snippet/dir' }
+    let(:snip_dir_exist) { false }
+
+    before do
+      allow(ENV)
+        .to receive(:[])
+        .with('SNIPPET_DIR')
+        .and_return(snip_dir)
+
+      allow(File)
+        .to receive(:exist?)
+        .and_return(snip_dir_exist)
+    end
+
+    context 'when environment variable not set' do
+      let(:snip_dir) { nil }
+
+      it 'raises env var not set runtime error' do
+        expect do
+          subject.snip_dir
+        end.to raise_error(
+          RuntimeError,
+          'SNIPPET_DIR environment variable not set'
+        )
+      end
+    end
+
+    context 'when snippet directory does not exist' do
+      it 'raises env var not exist runtime error' do
+        expect do
+          subject.snip_dir
+        end.to raise_error(
+          RuntimeError,
+          "SNIPPET_DIR #{snip_dir} does not exist"
+        )
+      end
+    end
+
+    context 'when environment variable set and directory exists' do
+      let(:snip_dir_exist) { true }
+
+      it 'returns snippet dir' do
+        expect(subject.snip_dir).to eq snip_dir
+      end
+    end
+  end
+
+  describe '#manager' do
+    let(:snip_dir) { 'path/to/snip/dir' }
+    let(:manager) { double(CodeSnippet::Manager) }
+
+    before do
+      allow(subject)
+        .to receive(:snip_dir)
+        .and_return(snip_dir)
+
+      allow(CodeSnippet::Manager)
+        .to receive(:new)
+        .and_return(manager)
+
+      allow(manager).to receive(:load)
+
+      @manager = subject.manager
+    end
+
+    it 'creates a new snip with snip dir' do
+      expect(CodeSnippet::Manager)
+        .to have_received(:new)
+        .with(snip_dir)
+    end
+
+    it 'loads manager' do
+      expect(manager).to have_received(:load)
+    end
+
+    it 'returns manager' do
+      expect(@manager).to eq manager
+    end
+  end
+end