code_snippet 0.2.7 → 0.3.0

data/spec/code_snippet/commands/list_snippets_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+RSpec.describe CodeSnippet::Commands::ListSnippets do
+  let(:options) { Hashie::Mash.new }
+
+  let(:snippet_list_table) do
+    <<~TABLE
+      NAME         LANG
+      some-snippet .go
+    TABLE
+  end
+
+  let(:manager) { double(CodeSnippet::Manager) }
+  let(:snippets) { [snippet] }
+
+  let(:snip_name) { 'some-snippet' }
+  let(:snip_ext) { '.go' }
+
+  let(:snippet) do
+    double(
+      CodeSnippet::Snip,
+      name: snip_name,
+      ext: snip_ext,
+      content: 'stuff'
+    )
+  end
+
+  subject { described_class.new(manager, options) }
+
+  before do
+    allow(manager)
+      .to receive(:snippets)
+      .and_return(snippets)
+
+    allow(snippet)
+      .to receive(:name)
+      .and_return(snip_name)
+
+    allow(snippet)
+      .to receive(:ext)
+      .and_return(snip_ext)
+
+    allow(TTY::Table).to receive(:new).and_call_original
+    allow(subject).to receive(:puts)
+  end
+
+  describe '#run' do
+    before { subject.run }
+
+    it 'retrieves snippets from manager' do
+      expect(manager).to have_received(:snippets)
+    end
+
+    it 'renders table' do
+      expect(TTY::Table).to have_received(:new).with(
+        header: CodeSnippet::Commands::ListSnippets::RESULT_HEADER,
+        rows: [['some-snippet', '.go']]
+      )
+    end
+
+    it 'prints table to STDOUT' do
+      expect(subject)
+        .to have_received(:puts)
+        .with(snippet_list_table.strip)
+    end
+  end
+end

data/spec/code_snippet/commands/print_path_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+RSpec.describe CodeSnippet::Commands::PrintPath do
+  let(:options) { Hashie::Mash.new }
+  let(:snippet_dir) { '/path/to/snippets' }
+
+  subject { described_class.new(snippet_dir, options) }
+
+  before do
+    allow(subject).to receive(:puts)
+  end
+
+  describe '#run' do
+    before { subject.run }
+
+    it 'prints given template path to STDOUT' do
+      expect(subject)
+        .to have_received(:puts)
+        .with(snippet_dir)
+    end
+  end
+end

data/spec/code_snippet/commands/print_version_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+RSpec.describe CodeSnippet::Commands::PrintVersion do
+  let(:options) { Hashie::Mash.new }
+
+  subject { described_class.new(options) }
+
+  before do
+    allow(subject).to receive(:puts)
+  end
+
+  describe '#run' do
+    before { subject.run }
+
+    it 'prints current version to STDOUT' do
+      expect(subject)
+        .to have_received(:puts)
+        .with(CodeSnippet::VERSION)
+    end
+  end
+end

data/spec/code_snippet/commands/show_snippet_spec.rb

@@ -0,0 +1,202 @@
+require 'spec_helper'
+
+RSpec.describe CodeSnippet::Commands::ShowSnippet do
+  let(:snip_name) { 'some-snippet' }
+  let(:manager) { double(CodeSnippet::Manager) }
+  let(:options) do
+    Hashie::Mash.new(
+      name: snip_name
+    )
+  end
+
+  let(:prompt) { double(TTY::Prompt) }
+
+  subject { described_class.new(manager, options) }
+
+  before do
+    subject.instance_variable_set(:@prompt, prompt)
+  end
+
+  describe '#run' do
+    let(:snip_path) { 'path/to/snippet' }
+    let(:snip) do
+      double(
+        CodeSnippet::Snip,
+        name: snip_name,
+        path: snip_path
+      )
+    end
+
+    let(:found_snips) { [snip, snip] }
+    let(:snip_content) { 'snippet content' }
+    let(:snip_names) { [snip_name, snip_name] }
+
+    before do
+      allow(prompt).to receive(:select)
+        .and_return(snip_name)
+
+      allow(manager)
+        .to receive(:snippet_names)
+        .and_return(snip_names)
+
+      allow(subject)
+        .to receive(:find_snippets)
+        .and_return(found_snips)
+
+      allow(subject)
+        .to receive(:pick_snippet)
+        .and_return(snip)
+
+      allow(snip)
+        .to receive(:content)
+        .and_return(snip_content)
+
+      allow(Clipboard).to receive(:copy)
+      allow(subject).to receive(:puts)
+
+      subject.run
+    end
+
+    context 'when name option is provided' do
+      it 'finds snippets' do
+        expect(subject)
+          .to have_received(:find_snippets)
+          .with(snip_name)
+      end
+
+      it 'prompts user to choose snippet' do
+        expect(subject)
+          .to have_received(:pick_snippet)
+          .with(found_snips)
+      end
+
+      it 'prints snippet content' do
+        expect(subject)
+          .to have_received(:puts)
+          .with(snip_content)
+      end
+    end
+
+    context 'when name option is not provided' do
+      let(:options) { Hashie::Mash.new }
+
+      it 'asks user to choose snippet' do
+        expect(prompt)
+          .to have_received(:select)
+          .with(
+            'Please choose snippet',
+            snip_names
+          )
+      end
+
+      it 'finds snippets' do
+        expect(subject)
+          .to have_received(:find_snippets)
+          .with(snip_name)
+      end
+
+      it 'prompts user to choose snippet' do
+        expect(subject)
+          .to have_received(:pick_snippet)
+          .with(found_snips)
+      end
+
+      it 'prints snippet content' do
+        expect(subject)
+          .to have_received(:puts)
+          .with(snip_content)
+      end
+    end
+
+    context 'when copy flag is provided' do
+      let(:options) do
+        Hashie::Mash.new(
+          copy: true
+        )
+      end
+
+      it 'copies snippet content to clipboard' do
+        expect(Clipboard)
+          .to have_received(:copy)
+          .with(snip_content)
+      end
+
+      it 'prints copied message' do
+        expect(subject)
+          .to have_received(:puts)
+          .with("COPIED: #{snip_path}")
+      end
+    end
+  end
+
+  describe '#find_snippets' do
+    let(:snip) { double(CodeSnippet::Snip, name: snip_name) }
+    let(:found_snips) { [snip, snip] }
+
+    before do
+      allow(manager).to receive(:find).and_return(found_snips)
+    end
+
+    context 'when snippet exists' do
+      before { @result = subject.find_snippets(snip_name) }
+
+      it 'returns snippets that match the search term' do
+        expect(@result).to eq found_snips
+      end
+    end
+
+    context 'when snippet does not exist' do
+      let(:found_snips) { [] }
+
+      it 'raises unable to find snippet runtime error' do
+        expect do
+          subject.find_snippets(snip_name)
+        end.to raise_error(
+          RuntimeError,
+          "unable to find #{snip_name}"
+        )
+      end
+    end
+  end
+
+  describe '#pick_snippet' do
+    let(:snip) { double(CodeSnippet::Snip, name: snip_name) }
+    let(:found_snips) { [snip, snip] }
+
+    before do
+      allow(prompt).to receive(:select).and_return(snip_name)
+      allow(manager).to receive(:find).and_return(found_snips)
+
+      @result = subject.pick_snippet(found_snips)
+    end
+
+    context 'when there are multiple snippets' do
+      it 'prompts user to select a snippet from list' do
+        expect(prompt)
+          .to have_received(:select)
+          .with(
+            'Multiple snippets found, which one would you like to view?',
+            [snip_name, snip_name]
+          )
+      end
+
+      it 'finds snippet' do
+        expect(manager).to have_received(:find).with(snip_name)
+      end
+
+      it 'returns snippet' do
+        expect(@result).to eq snip
+      end
+    end
+
+    context 'when there is one snippet' do
+      it 'finds snippet' do
+        expect(manager).to have_received(:find).with(snip_name)
+      end
+
+      it 'returns snippet' do
+        expect(@result).to eq snip
+      end
+    end
+  end
+end

data/spec/{snippet → code_snippet}/manager_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe CodeSnippet::Manager do
     described_class.new(snippet_dir)
   end
 
-  describe '#load_snippets' do
+  describe '#load' do
     let(:directory) { File.join(snippet_dir, 'path/to/dir') }
     let(:file)      { File.join(snippet_dir, 'path/to/dir/file') }
 
@@ -32,7 +32,7 @@ RSpec.describe CodeSnippet::Manager do
       allow(CodeSnippet::Snip).to receive(:new_from_file)
         .and_return(file_snip)
 
-      subject.load_snippets
+      subject.load
     end
 
     it 'creates snips from files' do
@@ -163,4 +163,27 @@ RSpec.describe CodeSnippet::Manager do
       expect(@result[1]).to be another_target_snip
     end
   end
+
+  describe '#snippet_names' do
+    let(:snip) do
+      CodeSnippet::Snip.new('path/to/snip.rb', 'snip.go', '.go')
+    end
+
+    let(:snips) do
+      [
+        snip,
+        snip,
+        snip
+      ]
+    end
+
+    before do
+      subject.instance_variable_set(:@snippets, snips)
+      @result = subject.snippet_names
+    end
+
+    it 'returns array of snippet names' do
+      expect(@result).to eq %w[snip snip snip]
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code_snippet
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Bigger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-11 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: tty-prompt
   requirement: !ruby/object:Gem::Requirement
@@ -250,6 +264,7 @@ description:
 email:
 - andrew.bigger@gmail.com
 executables:
+- code_snippet
 - snippet
 extensions: []
 extra_rdoc_files: []
@@ -264,21 +279,26 @@ files:
 - LICENCE
 - README.md
 - Rakefile
+- bin/code_snippet
 - bin/snippet
-- bitbucket-pipelines.yml
 - code_snippet.gemspec
 - lib/code_snippet.rb
 - lib/code_snippet/cli.rb
-- lib/code_snippet/cli/commands.rb
-- lib/code_snippet/cli/presenters.rb
+- lib/code_snippet/commands.rb
+- lib/code_snippet/commands/list_snippets.rb
+- lib/code_snippet/commands/print_path.rb
+- lib/code_snippet/commands/print_version.rb
+- lib/code_snippet/commands/show_snippet.rb
 - lib/code_snippet/manager.rb
 - lib/code_snippet/snip.rb
 - lib/code_snippet/version.rb
-- spec/snippet/cli/commands_spec.rb
-- spec/snippet/cli/presenters_spec.rb
-- spec/snippet/cli_spec.rb
-- spec/snippet/manager_spec.rb
-- spec/snippet/snip_spec.rb
+- spec/code_snippet/cli_spec.rb
+- spec/code_snippet/commands/list_snippets_spec.rb
+- spec/code_snippet/commands/print_path_spec.rb
+- spec/code_snippet/commands/print_version_spec.rb
+- spec/code_snippet/commands/show_snippet_spec.rb
+- spec/code_snippet/manager_spec.rb
+- spec/code_snippet/snip_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/andrewbigger/code_snippet
 licenses:
@@ -304,9 +324,11 @@ signing_key:
 specification_version: 4
 summary: A code snippet handling tool
 test_files:
-- spec/snippet/cli/commands_spec.rb
-- spec/snippet/cli/presenters_spec.rb
-- spec/snippet/cli_spec.rb
-- spec/snippet/manager_spec.rb
-- spec/snippet/snip_spec.rb
+- spec/code_snippet/cli_spec.rb
+- spec/code_snippet/commands/list_snippets_spec.rb
+- spec/code_snippet/commands/print_path_spec.rb
+- spec/code_snippet/commands/print_version_spec.rb
+- spec/code_snippet/commands/show_snippet_spec.rb
+- spec/code_snippet/manager_spec.rb
+- spec/code_snippet/snip_spec.rb
 - spec/spec_helper.rb

data/bitbucket-pipelines.yml

@@ -1,18 +0,0 @@
-image: ruby:2.6.4
-
-pipelines:
-  branches:
-    master:
-      - step:
-          name: Build and Test
-          caches:
-            - bundler
-          script:
-            - gem install bundler
-            - bundle install --path .bundle
-            - bundle exec rake
-          deployment: production
-
-definitions:
-  caches:
-    bundler: .bundle

data/lib/code_snippet/cli/commands.rb

@@ -1,82 +0,0 @@
-require 'clipboard'
-
-module CodeSnippet
-  # Command line interface helpers and actions
-  module CLI
-    # CLI Actions
-    module Commands
-      ##
-      # Show displays a snippet
-      #
-      def self.show(
-        lang,
-        copy,
-        args = []
-      )
-        name = args.first
-        snippet_dir = CodeSnippet::CLI.snip_dir
-
-        manager = CodeSnippet::Manager.new(snippet_dir)
-        manager.load_snippets
-
-        snips = manager.find(name, lang)
-        raise "unable to find #{name}" if snips.empty?
-
-        snip = snips.first
-        if snips.length > 1
-          snip = CLI::Presenters.pick_from(
-            'Multiple snippets found, which one would you like to view?',
-            snips
-          )
-        end
-
-        if copy
-          Clipboard.copy(snip.content)
-          CLI.print_message("COPIED: #{snip.path}")
-        end
-
-        CLI::Presenters.show(snip)
-      end
-
-      ##
-      # List lists snippets
-      #
-      def self.list(
-        lang,
-        _copy,
-        _args = []
-      )
-        snippet_dir = CodeSnippet::CLI.snip_dir
-
-        manager = CodeSnippet::Manager.new(snippet_dir)
-        manager.load_snippets
-
-        snippets = lang ? manager.filter_by_extension(lang) : manager.snippets
-
-        CLI::Presenters.list_snippets(snippets)
-      end
-
-      ##
-      # Show snippet directory path
-      #
-      def self.path(
-        _lang,
-        _copy,
-        _args = []
-      )
-        CLI.print_message(CLI.snip_dir)
-      end
-
-      ##
-      # Show snippet gem version
-      #
-      def self.version(
-        _lang,
-        _copy,
-        _args = []
-      )
-        CLI.print_message(CodeSnippet::VERSION)
-      end
-    end
-  end
-end

data/lib/code_snippet/cli/presenters.rb

@@ -1,42 +0,0 @@
-require 'tty-table'
-require 'tty-prompt'
-
-module CodeSnippet
-  # Command line interface helpers and actions
-  module CLI
-    # CLI Presentation functions
-    module Presenters
-      def self.pick_from(question, snips)
-        prompt = TTY::Prompt.new
-
-        choice = prompt.select(
-          question,
-          snips.map(&:path)
-        )
-
-        snips.find { |snip| snip.path == choice }
-      end
-
-      def self.show(snip)
-        CLI.print_message(snip.content)
-      end
-
-      def self.list_snippets(snippets)
-        result_header = %w[NAME LANG PATH]
-
-        results = TTY::Table.new(
-          result_header,
-          snippets.map do |snippet|
-            [
-              snippet.name,
-              snippet.ext,
-              snippet.path
-            ]
-          end
-        )
-
-        CLI.print_message(results.render(:ascii))
-      end
-    end
-  end
-end

data/spec/snippet/cli/commands_spec.rb

@@ -1,104 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe CodeSnippet::CLI::Commands do
-  let(:snippet_dir) { 'path/to/snippets' }
-  let(:lang) { '.rb' }
-  let(:copy) { false }
-  let(:vars) { [] }
-
-  before do
-    allow(ENV)
-      .to receive(:[]).with('SNIPPET_DIR')
-                      .and_return(snippet_dir)
-
-    allow(File)
-      .to receive(:exist?)
-      .with(snippet_dir)
-      .and_return(true)
-  end
-
-  describe '.show' do
-  end
-
-  describe '.list' do
-    let(:manager) { double(CodeSnippet::Manager) }
-    let(:lang) { nil }
-
-    let(:snip) { double(CodeSnippet::Snip) }
-    let(:filtered_snips) { [snip, snip] }
-    let(:all_snips) { [snip, snip, snip, snip] }
-
-    before do
-      allow(CodeSnippet::CLI).to receive(:snip_dir)
-        .and_return('path/to/snips')
-
-      allow(CodeSnippet::Manager)
-        .to receive(:new)
-        .and_return(manager)
-
-      allow(manager).to receive(:load_snippets)
-      allow(manager)
-        .to receive(:filter_by_extension)
-        .and_return(filtered_snips)
-
-      allow(manager)
-        .to receive(:snippets)
-        .and_return(all_snips)
-
-      allow(CodeSnippet::CLI::Presenters)
-        .to receive(:list_snippets)
-
-      described_class.list(lang, copy, vars)
-    end
-
-    it 'loads snippets' do
-      expect(manager).to have_received(:load_snippets)
-    end
-
-    it 'presents a list of snippets' do
-      expect(CodeSnippet::CLI::Presenters)
-        .to have_received(:list_snippets)
-        .with(all_snips)
-    end
-
-    context 'when language filter is applied' do
-      let(:lang) { '.rb' }
-
-      it 'presents a list of filtered snippets' do
-        expect(CodeSnippet::CLI::Presenters)
-          .to have_received(:list_snippets)
-          .with(filtered_snips)
-      end
-    end
-  end
-
-  describe '.path' do
-    before do
-      allow(CodeSnippet::CLI)
-        .to receive(:print_message)
-        .and_return(nil)
-
-      described_class.path(lang, copy, vars)
-    end
-
-    it 'prints snippet dir' do
-      expect(CodeSnippet::CLI).to have_received(:print_message)
-        .with(snippet_dir)
-    end
-  end
-
-  describe '.version' do
-    before do
-      allow(CodeSnippet::CLI)
-        .to receive(:print_message)
-        .and_return(nil)
-
-      described_class.version(lang, copy, vars)
-    end
-
-    it 'prints snippet version' do
-      expect(CodeSnippet::CLI).to have_received(:print_message)
-        .with(CodeSnippet::VERSION)
-    end
-  end
-end