code_snippet 0.2.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b3be1025b2ca9038e8efa67c202272d75d9106847af59912d94402f4fdefb02a
+  data.tar.gz: f74a1eeb89ef415b879029e093dbcb50dec4263d86200185dcb5f2a5de23eca6
+SHA512:
+  metadata.gz: a02f2a04c6a5e97f75c3de4a2c1c0aeb6a0477a7ef6fd4089e88962bfe538dafd77d9ff12c09c9ec90d28f1cf932a2515d9f11666c0ecbc278be209f7fc74843
+  data.tar.gz: d4ad4736c97d2be4fe77dfea10e2c3ad01da85b46dbf03634b7c3a590570b367860ce16ab5bb86948fd93d1e9ce88cc8f21df6205ae370a22e8efb1899d91681

data/.github/workflows/build.yml

@@ -0,0 +1,23 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7']
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,20 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# byebug history
+.byebug_history
+
+*.gem
+target/reports
+
+.DS_Store
+
+/doc/

data/.rubocop.yml

@@ -0,0 +1,20 @@
+---
+  AllCops:
+    TargetRubyVersion: 2.4
+  
+  Style/FrozenStringLiteralComment:
+    Enabled: false
+  
+  Metrics/MethodLength:
+    Max: 20
+  
+  Metrics/AbcSize:
+    Max: 20
+  
+  Lint/AssignmentInCondition:
+    Enabled: false
+  
+  Metrics/BlockLength:
+    Exclude:
+      - 'code_snippet.gemspec'
+      - 'spec/**/*'

data/.ruby-version

@@ -0,0 +1 @@
+2.6.6

data/CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contributing
+
+When contributing to CodeSnippet, please take note of the following requests.
+
+## Pull Request Process
+
+1. Before raising a pull request, please first discuss the change by raising an issue.
+2. Ensure any changes that change the behaviour or would be useful to implementers of this gem are documented within the README.md
+3. Increase the version number in any PR raised. The versioning scheme we use is [SemVer](https://semver.org/)
+
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing or otherwise unacceptable behaviour may be reported by contacting the project team. The project team will decide how to respond to any compliants.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org/version/1/4), version 1.4, available at http://contributor-covenant.org/version/1/4

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,158 @@
+PATH
+  remote: .
+  specs:
+    code_snippet (0.2.6)
+      clipboard
+      ffi
+      hashie
+      highline (~> 2.0)
+      logger (~> 1.4)
+      tty-prompt
+      tty-table
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    bump (0.6.1)
+    byebug (11.0.1)
+    clipboard (1.3.5)
+    codeclimate-engine-rb (0.4.1)
+      virtus (~> 1.0)
+    coderay (1.1.2)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    equalizer (0.0.11)
+    erubis (2.7.0)
+    ffi (1.15.3)
+    flay (2.12.1)
+      erubis (~> 2.7.0)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.0)
+      sexp_processor (~> 4.0)
+    flog (4.6.3)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.1, > 3.1.0)
+      sexp_processor (~> 4.8)
+    hashie (4.1.0)
+    highline (2.0.3)
+    ice_nine (0.11.2)
+    jaro_winkler (1.5.4)
+    json (2.2.0)
+    launchy (2.4.3)
+      addressable (~> 2.3)
+    logger (1.4.3)
+    method_source (0.9.2)
+    parallel (1.19.1)
+    parser (2.5.3.0)
+      ast (~> 2.4.0)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    path_expander (1.1.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (4.0.1)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    reek (4.8.2)
+      codeclimate-engine-rb (~> 0.4.0)
+      parser (>= 2.5.0.0, < 2.6)
+      rainbow (>= 2.0, < 4.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.68.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.10.1)
+    ruby_parser (3.14.1)
+      sexp_processor (~> 4.9)
+    rubycritic (3.5.2)
+      flay (~> 2.8)
+      flog (~> 4.4)
+      launchy (= 2.4.3)
+      parser (~> 2.5.0)
+      rainbow (~> 3.0)
+      reek (~> 4.4)
+      ruby_parser (~> 3.8)
+      tty-which (~> 0.3.0)
+      virtus (~> 1.0)
+    sexp_processor (4.13.0)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    strings (0.2.1)
+      strings-ansi (~> 0.2)
+      unicode-display_width (>= 1.5, < 3.0)
+      unicode_utils (~> 1.4)
+    strings-ansi (0.2.0)
+    thread_safe (0.3.6)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    tty-table (0.12.0)
+      pastel (~> 0.8)
+      strings (~> 0.2.0)
+      tty-screen (~> 0.8)
+    tty-which (0.3.0)
+    unicode-display_width (1.5.0)
+    unicode_utils (1.4.0)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+    wisper (2.0.1)
+    yard (0.9.20)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bump (~> 0.6)
+  byebug (~> 11.0)
+  code_snippet!
+  pry (~> 0.11)
+  rake (~> 13.0)
+  rspec (~> 3.7, >= 3.7.0)
+  rubocop (~> 0.58)
+  rubycritic (~> 3.4, >= 3.4.0)
+  simplecov (~> 0.16)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.2.16

data/LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Andrew Bigger
+
+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,78 @@
+# CodeSnippet
+
+[![Ruby](https://github.com/andrewbigger/code_snippet/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/andrewbigger/code_snippet/actions/workflows/build.yml)
+
+A code snippet handling tool that makes it easy to quickly access chunks of code.
+
+## Installation
+
+Install the gem into your system:
+
+```bash
+gem install code_snippet
+```
+
+## Usage
+
+### Before you begin
+
+Before you use snippet, you need to set the `SNIPPET_DIR` environment variable to a path that contains your snippets:
+
+```bash
+export SNIPPET_DIR="/Users/me/Code/snippets"
+```
+
+### Creating snippets
+
+Snippets are just text files with the extension of the target language. For example, `for_i.go` might ontain a for loop.
+
+The code does not need to compile or be able to be interpreted for it to be displayed by snippet, it should be content that's easy to paste into the project you're currently working on.
+
+### Listing and Viewing Snippets
+
+Once you have a set of snippets, run `snippet list` to show a list of all your snippets:
+
+```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           |
++---------------------+----+-----------------------------------------------------------------+
+```
+
+You can then show a snippet by executing `snippet show <name>`:
+
+```bash
+$ snippet show for_i
+
+for 1 := 1; i < 10; i++ {
+  // do something
+}
+```
+
+You can copy the snippet straight to the clipboard by adding the `-c=true` to the end of the command.
+
+## Tests and Quality
+
+Tests cover this project and are written in RSpec. You'll find them in the spec folder.
+
+```bash
+bundle exec rspec spec
+```
+
+Tests and quality tasks are included in the default rake task which can be run thus:
+
+```bash
+bundle exec rake
+```
+
+## Contributing
+
+See CONTRIBUTING.md for more information
+
+## Licence
+
+This gem is covered by the terms of the MIT licence. See LICENCE for more information

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/gem_tasks'
+require 'bump/tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'rubycritic/rake_task'
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+RubyCritic::RakeTask.new do |task|
+  task.paths = FileList['lib/**/*.rb'] - FileList['spec/**/*_spec.rb']
+  task.options = '--no-browser --path ./target/reports/critique'
+end
+
+YARD::Rake::YardocTask.new
+
+task default: %i[spec rubocop rubycritic yard]

data/bin/snippet

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(__dir__ + '/../lib')
+
+require 'rubygems'
+require 'optparse'
+require 'highline'
+
+require 'code_snippet'
+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!
+
+begin
+  raise 'ERROR: no command provided' unless ARGV[0]
+
+  cmd = ARGV.shift
+  CodeSnippet::CLI::Commands.public_send(
+    cmd.to_sym,
+    @lang,
+    !@copy.nil?,
+    ARGV
+  )
+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)
+end
+
+exit(0)

data/bitbucket-pipelines.yml

@@ -0,0 +1,18 @@
+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/code_snippet.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'code_snippet/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'code_snippet'
+  spec.version       = CodeSnippet::VERSION
+  spec.authors       = ['Andrew Bigger']
+  spec.email         = ['andrew.bigger@gmail.com']
+  spec.summary       = 'A code snippet handling tool'
+  spec.homepage      = 'https://github.com/andrewbigger/code_snippet'
+  spec.license       = 'Private'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'clipboard'
+  spec.add_dependency 'ffi'
+  spec.add_dependency 'hashie'
+  spec.add_dependency 'highline', '~> 2.0'
+  spec.add_dependency 'logger', '~> 1.4'
+  spec.add_dependency 'tty-prompt'
+  spec.add_dependency 'tty-table'
+
+  spec.add_development_dependency 'bump', '~> 0.6'
+  spec.add_development_dependency 'byebug', '~> 11.0'
+  spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.7', '>= 3.7.0'
+  spec.add_development_dependency 'rubocop', '~> 0.58'
+  spec.add_development_dependency 'rubycritic', '~> 3.4', '>= 3.4.0'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+  spec.add_development_dependency 'yard', '~> 0.9'
+end

data/lib/code_snippet/cli/commands.rb

@@ -0,0 +1,82 @@
+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

@@ -0,0 +1,42 @@
+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