snippet_cli 0.2.3 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef970184ca46c2d009feb5b35a23cf83b258a63aee81e1b3a61259ae2c7b0ccf
-  data.tar.gz: 06f97fc1903a6eaed6c8280d04db9e46d588818916dee30cbf600eb4c786cc73
+  metadata.gz: 657486002bc2d360c27c7c99aef89444bc0568cbfbb9014b31320b45e327d658
+  data.tar.gz: '087e66f9b9da46283e6caa6bb5559c34db1c1dc239161f6fccce2859bfa17301'
 SHA512:
-  metadata.gz: 4d13812aa194e42b1f185d890212825b99f58f135eaa632cd989f29e2bb24e537e0fae8b1b73607756b5da1802550788919856e94241f7c6792166a832ecc708
-  data.tar.gz: d3f1c06832065c52e40b2d96503e2447f3d2112660c79a33e44ecbeee557afd8387fa870f0a7b15d8f0938e84f595cdf1aa46080c2ec806d4dffd38468f6f346
+  metadata.gz: 549e67aa41e8f8c6d07ffd943b9ce872fa3a7890c6e2b1735b5e50c1ca2c9217db366c7e54bc11c6b7bc63029efa73d8fb6facc26ee65f840b64c2437b6448ab
+  data.tar.gz: 2628d10518b17461f00b05a045e95f8334ab0d65e408d4c1dd457f65a83808180e5918e685828979fdc4dddb3dcd03684cc073453e4d2b08f99a63dfe5fb8693

data/.travis.yml

@@ -1,4 +1,7 @@
----
+os:
+  - linux
+  - osx
+  - windows
 language: ruby
 cache: bundler
 rvm:

data/Gemfile

@@ -1,16 +1,17 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in snippet_cli.gemspec
-gemspec
-
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
-gem "tty-prompt"
-gem "tty-box"
-gem "tty-platform"
-gem 'tty-markdown'
-gem "pastel"
-gem "bundler"
-gem "snippets_for_espanso"
-gem "httparty"
-gem "ascii"
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in snippet_cli.gemspec
+gemspec
+
+gem "rake"
+gem "rspec", "~> 3.0"
+gem "tty-prompt"
+gem "tty-box"
+gem "tty-platform"
+gem 'tty-markdown'
+gem "pastel"
+gem "bundler"
+gem "snippets_for_espanso"
+gem "httparty"
+gem "ascii"
+gem "thor"

data/README.md

@@ -1,44 +1,43 @@
-# SnippetCli
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/snippet_cli`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'snippet_cli'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install snippet_cli
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/snippet_cli. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/snippet_cli/blob/master/CODE_OF_CONDUCT.md).
-
-
-## Code of Conduct
-
-Everyone interacting in the SnippetCli project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/snippet_cli/blob/master/CODE_OF_CONDUCT.md).
-
-## Copyright
-
-Copyright (c) 2020 AJ Markow. See [MIT License](LICENSE.txt) for further details.
+# SnippetCli
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/snippet_cli`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'snippet_cli'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install snippet_cli
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will new a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/snippet_cli. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/snippet_cli/blob/master/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the SnippetCli project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/snippet_cli/blob/master/CODE_OF_CONDUCT.md).
+
+## Copyright
+
+Copyright (c) 2020 AJ Markow. See [MIT License](LICENSE.txt) for further details.

data/Rakefile

@@ -4,3 +4,7 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+task :spec do
+  sh 'rspec spec'
+end

data/lib/Setup.rb

@@ -1,74 +1,74 @@
-require 'tty/prompt'
-require 'tty/box'
-prompt = TTY::Prompt.new
-
-
-class Setup
-  @leading = "                                      "
-  @divider = "------------------------------------"
-  attr_accessor :user_name,:user_os,:user_storage,:config_present
-
-    def initialize(user_name,user_os,user_storage,config_present)
-      @user_name = user_name
-      @user_os = user_os 
-      @user_storage = user_storage 
-      @config_present = config_present 
-    end
-
-    class Error < StandardError; end
-
-
-    def get_name()
-      puts @leading
-      prompt = TTY::Prompt.new
-        name = prompt.ask("To begin setup, may I have your name?", default: ENV["USER"], active_color: :bright_blue) do |q|
-          q.required true
-        end
-      puts @leading
-      self.user_name = name
-    end
-
-    def get_os()
-      puts @leading
-      prompt = TTY::Prompt.new
-          config_path = prompt.ask("What OS are you using?", default: ENV["OS"], active_color: :bright_blue) do |q|
-            q.required true
-          end
-          if (config_path.include? "Windows")
-            return config_path = "\\Roaming\\AppData\\espanso\\default.yml"
-          elsif (config_path.include?"OS X")
-            return config_path = "#{ENV["HOME"]}/Library/Preferences/espanso/default.yml"
-          else config_path.include?("Linux")
-            return config_path = "#{ENV["HOME"]}/.config/espanso/default.yml"
-          end
-      puts @leading
-      self.user_os=config_path
-    end
-
-  # REFACTOR TO PROVIDE PATH
-    def get_storage()
-      puts @leading
-      prompt = TTY::Prompt.new
-      return snippet_storage = prompt.select("Do your store your snippets in Dropbox or a different directory?", default: 1, active_color: :bright_blue) do |menu|
-      menu.enum "."
-
-      menu.choice "No I use the default folder.", 1
-      menu.choice "I use Dropbox.", 2
-      menu.choice "I use Google Drive", 3
-      menu.choice "I use Another Directory.", 4
-      end
-      puts @leading
-      self.user_storage = snippet_storage
-    end
-
-  def generate_config()
-    if File.exist?("#{ENV["HOME"]}/snippet_cli_config.txt") then
-
-    else
-      File.open("#{ENV["HOME"]}/snippet_cli_config.txt", "a") { |f| f.write "NAME = #{self.user_name}\n"}
-      File.open("#{ENV["HOME"]}/snippet_cli_config.txt", "a") { |f| f.write "OS = #{self.user_os}\n"}
-      File.open("#{ENV["HOME"]}/snippet_cli_config.txt", "a") { |f| f.write "STORAGE = #{self.user_storage}\n"}
-      File.open("#{ENV["HOME"]}/snippet_cli_config.txt", "a") { |f| f.write "CONFIG_PRESENT = TRUE\n"}
-    end
-  end
+require 'tty-prompt'
+require 'tty-box'
+prompt = TTY::Prompt.new
+
+
+class Setup
+  @leading = "                                      "
+  @divider = "------------------------------------"
+  attr_accessor :user_name,:user_os,:user_storage,:config_present
+
+    def initialize(user_name,user_os,user_storage,config_present)
+      @user_name = user_name
+      @user_os = user_os 
+      @user_storage = user_storage 
+      @config_present = config_present 
+    end
+
+    class Error < StandardError; end
+
+
+    def get_name()
+      puts @leading
+      prompt = TTY::Prompt.new
+        name = prompt.ask("To begin setup, may I have your name?", default: ENV["USER"], active_color: :bright_blue) do |q|
+          q.required true
+        end
+      puts @leading
+      self.user_name = name
+    end
+
+    def get_os()
+      puts @leading
+      prompt = TTY::Prompt.new
+          config_path = prompt.ask("What OS are you using?", default: ENV["OS"], active_color: :bright_blue) do |q|
+            q.required true
+          end
+          if (config_path.include? "Windows")
+            return config_path = "\\Roaming\\AppData\\espanso\\default.yml"
+          elsif (config_path.include?"OS X")
+            return config_path = "#{ENV["HOME"]}/Library/Preferences/espanso/default.yml"
+          else config_path.include?("Linux")
+            return config_path = "#{ENV["HOME"]}/.config/espanso/default.yml"
+          end
+      puts @leading
+      self.user_os=config_path
+    end
+
+  # REFACTOR TO PROVIDE PATH
+    def get_storage()
+      puts @leading
+      prompt = TTY::Prompt.new
+      return snippet_storage = prompt.select("Do your store your snippets in Dropbox or a different directory?", default: 1, active_color: :bright_blue) do |menu|
+      menu.enum "."
+
+      menu.choice "No I use the default folder.", 1
+      menu.choice "I use Dropbox.", 2
+      menu.choice "I use Google Drive", 3
+      menu.choice "I use Another Directory.", 4
+      end
+      puts @leading
+      self.user_storage = snippet_storage
+    end
+
+  def generate_config()
+    if File.exist?("#{ENV["HOME"]}/snippet_cli_config.txt") then
+
+    else
+      File.open("#{ENV["HOME"]}/snippet_cli_config.txt", "a") { |f| f.write "NAME = #{self.user_name}\n"}
+      File.open("#{ENV["HOME"]}/snippet_cli_config.txt", "a") { |f| f.write "OS = #{self.user_os}\n"}
+      File.open("#{ENV["HOME"]}/snippet_cli_config.txt", "a") { |f| f.write "STORAGE = #{self.user_storage}\n"}
+      File.open("#{ENV["HOME"]}/snippet_cli_config.txt", "a") { |f| f.write "CONFIG_PRESENT = TRUE\n"}
+    end
+  end
 end

data/lib/banner.rb

@@ -1,16 +1,16 @@
-require 'tty-box'
-
-      def show_banner()
-        box = TTY::Box::frame(width:67, height:11, border: :thick, align: :left) do 
-        "
-        #####   #     # ### ######  ######  ####### ####### 
-        #     # ##    #  #  #     # #     # #          #    
-        #       # #   #  #  #     # #     # #          #    
-         #####  #  #  #  #  ######  ######  #####      #    
-              # #   # #  #  #       #       #          #    
-        #     # #    ##  #  #       #       #          #    
-         #####  #     # ### #       #       #######    #    CLI                                                                
-        "
-        end
-        puts box
+require 'tty-box'
+
+      def show_banner()
+        box = TTY::Box::frame(width:67, height:11, border: :thick, align: :left) do 
+        "
+        #####   #     # ### ######  ######  ####### ####### 
+        #     # ##    #  #  #     # #     # #          #    
+        #       # #   #  #  #     # #     # #          #    
+         #####  #  #  #  #  ######  ######  #####      #    
+              # #   # #  #  #       #       #          #    
+        #     # #    ##  #  #       #       #          #    
+         #####  #     # ### #       #       #######    #    CLI                                                                
+        "
+        end
+        puts box
       end

data/lib/snippet_cli/cli.rb

@@ -1,58 +1,62 @@
-# frozen_string_literal: true
-
-require 'thor'
-
-module SnippetCli
-  # Handle the application command line parsing
-  # and the dispatch to various command objects
-  #
-  # @api public
-  class CLI < Thor
-    # Error raised by this runner
-    Error = Class.new(StandardError)
-
-    desc 'version', 'snippet_cli version'
-    def version
-      require_relative 'version'
-      puts "v#{SnippetCli::VERSION}"
-    end
-    map %w(--version -v) => :version
-
-    desc 'info [DOCS]', 'Show info and docs about using the program.'
-    method_option :help, aliases: '-h', type: :boolean,
-                         desc: 'Display usage information'
-    def info(docs = nil)
-      if options[:help]
-        invoke :help, ['info']
-      else
-        require_relative 'commands/info'
-        SnippetCli::Commands::Info.new(docs, options).execute
-      end
-    end
-
-    desc 'new', 'Guides you through adding a new snippet.'
-    method_option :help, aliases: '-h', type: :boolean,
-                         desc: 'Display usage information'
-    def new(*)
-      if options[:help]
-        invoke :help, ['new']
-      else
-        require_relative 'commands/new'
-        SnippetCli::Commands::New.new(options).execute
-      end
-    end
-
-    desc 'setup', 'Sets up snippet_cli to modify correct.'
-    method_option :help, aliases: '-h', type: :boolean,
-                         desc: 'Set directory to write to snippet file in'
-    def setup(*)
-      if options[:help]
-        invoke :help, ['setup']
-      else
-        require_relative 'commands/setup'
-        SnippetCli::Commands::Setup.new().execute
-      end
-    end
-
-  end
-end
+# frozen_string_literal: true
+
+require 'thor'
+
+module SnippetCli
+  # Handle the application command line parsing
+  # and the dispatch to various command objects
+  #
+  # @api public
+  class CLI < Thor
+  def self.exit_on_failure?
+    true
+    puts "Something went wrong, try again."
+  end
+    # Error raised by this runner
+    Error = Class.new(StandardError)
+
+    desc 'version', 'snippet_cli version'
+    def version
+      require_relative 'version'
+      puts "v#{SnippetCli::VERSION}"
+    end
+    map %w(--version -v) => :version
+
+    desc 'info [DOCS]', 'Show info and docs about using the program.'
+    method_option :help, aliases: '-h', type: :boolean,
+                         desc: 'Shows you where you can find more documentation and leave feedback for the program.'
+    def info(docs = nil)
+      if options[:help]
+        invoke :help, ['info']
+      else
+        require_relative 'commands/info'
+        SnippetCli::Commands::Info.new(docs, options).execute
+      end
+    end
+
+    desc 'new', 'Guides you through adding a new snippet.'
+    method_option :help, aliases: '-h', type: :boolean,
+                         desc: 'Adds a new snippet to your yml file.'
+    def new(*)
+      if options[:help]
+        invoke :help, ['new']
+      else
+        require_relative 'commands/new'
+        SnippetCli::Commands::New.new(options).execute
+      end
+    end
+
+    desc 'setup', 'Sets up snippet_cli to modify correct file.'
+    method_option :help, aliases: '-h', type: :boolean,
+                         desc: 'Sets directory to write to snippet file in.'
+    def setup(*)
+      if options[:help]
+        invoke :help, ['setup']
+      else
+        require_relative 'commands/setup'
+        SnippetCli::Commands::Setup.new().execute
+      end
+    end
+
+  end
+end

data/lib/{info.md → snippet_cli/commands/info.md}

@@ -1,20 +1,20 @@
-# Thanks for trying Snippet CLI!
-
-Hi! Have any feedback?  
-We'd love to hear it.  
-Click the link below to send an email to the developer.
-
-## Links
-
-- [Install Espanso](https://espanso.org/)
-- [Snippet CLI Github](https://www.github.com/ajmarkow/snippet_cli)
-- [Snippet CLI Docs](https:/docs.snippetcli.com)
-- [Email Me Feedback](mailto:aj@ajm.codes)
-
-## Commands
-
-| **Command**  |      **Purpose**      |
-|----------|:------------------:|
-| setup |  Sets up path to snippet file |
-| new |    Opens dialog to add new snippet or form.  |
+# Thanks for trying Snippet CLI!
+
+Hi! Have any feedback?  
+We'd love to hear it.  
+Click the link below to send an email to the developer.
+
+## Links
+
+- [Install Espanso](https://espanso.org/)
+- [Snippet CLI Github](https://www.github.com/ajmarkow/snippet_cli)
+- [Snippet CLI Docs](https:/docs.snippetcli.com)
+- [Email Me Feedback](mailto:aj@ajm.codes)
+
+## Commands
+
+| **Command**  |      **Purpose**      |
+|----------|:------------------:|
+| setup |  Sets up path to snippet file |
+| new |    Opens dialog to add new snippet or form.  |
 | info| Docs, Contact Info, and Resources |

data/lib/snippet_cli/commands/info.rb

@@ -13,7 +13,7 @@ module SnippetCli
       end
 
       def execute(input: $stdin, output: $stdout)
-              def show_banner()
+            def show_banner()
         box = TTY::Box::frame(width:67, height:11, border: :thick, align: :left) do 
         "
         #####   #     # ### ######  ######  ####### ####### 
@@ -28,7 +28,7 @@ module SnippetCli
         puts box
       end
         puts show_banner()
-        parsed_markdown=TTY::Markdown.parse_file('./lib/info.md')
+        parsed_markdown=TTY::Markdown.parse_file('/snippet_cli/commands/info.md')
         output.puts parsed_markdown
       end
     end