tagrity 0.3.4 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7490444ad7659b555e29f61c09d8bee1536a608345113245ea54f1f85fcb5002
-  data.tar.gz: e28e9d0d61c936ae89379913bd6b64d2e177431e985371c81b27bb2b77f287d4
+  metadata.gz: e58265edc0966bca3bec8c06593f3f565474608719eefbeb32e5430a91c9cf1b
+  data.tar.gz: e962278ba7856b479f5e5989857c356f5a24aed51a076ac633e275e7b7384676
 SHA512:
-  metadata.gz: fdd57aeb20e34e8f224d07fb893fe44ebc3bd02364dcf79c12bb404ac293e11333b7941967356ac4999b8105f22c5f7541df519265d3cced834cc4b71f6dea67
-  data.tar.gz: 80ac84ad3477f8d03275e2e814c36c668ab237cfa1bb9fb95628b0a60cc32eef554a49117871368fae9a2d5eee37ff9dbd6ab94176b89d263eaa413e3191f094
+  metadata.gz: 321f570b3fa8e9c84f2309ead1afb2d76f9975fe82ea98f3fdcfb607873bc088581e496a96c126e26146c0d5e696978b4089ea28b6557620d21250d333b39bbb
+  data.tar.gz: 60eab2019359a6016dcf8b78b65b47ce47e51f41a0589572a7df064ef2aeb424198717efbedf2c2b6987133f312f8111a4a6936a7fa6bcba2530d62c4c1c9299

data/Gemfile.lock

@@ -1,10 +1,9 @@
 PATH
   remote: .
   specs:
-    tagrity (0.3.2)
+    tagrity (0.3.8)
       cli-ui (~> 1.3.0)
       listen (~> 3.2.1)
-      pry (~> 0.9.9)
       thor (~> 0.20)
 
 GEM
@@ -48,6 +47,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.0)
+  pry (~> 0.9.9)
   rake (~> 13.0)
   ripper-tags (~> 0.8.0)
   rspec (~> 3.0)

data/README.md

@@ -16,9 +16,9 @@ $ gem install tagrity
 tagrity start
 ```
 
-That's it! It will monitor pwd and index any files which change. Check out [Configuration](#configuration) to restrict which files get indexed.
+That's it! It will monitor the current directory and generate tags for any files which change and are not ignored by git.
 
-To stop watching pwd, use
+To stop watching the current directory, use
 
 ```sh
 tagrity stop
@@ -30,6 +30,30 @@ To view directories being watched, use
 tagrity status
 ```
 
+## Less Quick Start
+
+When your computer is restarted, the process watching the directories will be killed. Add the following to your `~/.bashrc` (or `~/.zshrc`, etc.) to revive any killed processes automatically.
+
+```sh
+(tagrity revive &) &> /dev/null
+```
+
+To stop watching a directory that isn't the current working directory (but shows up in `tagrity status`), you can use:
+
+```sh
+tagrity stop --dir <path>
+```
+
+Where `<path>` is a relative or absolute path. You may be tempted to run `tagrity status` to get the pid and then kill it with `kill <pid>`. However, while this will work, `tagrity revive` will restart these processes (with different pids of course). `tagrity stop` will kill the process and stop `tagrity revive` from starting it up again.
+
+To get info on what tags are being generated, you can run:
+
+```sh
+tagrity logs
+```
+
+For a full set of subcommands, try `tagrity help`.
+
 ## Configuration
 
 Configuration can be done through use of a local `.tagrity_config.yml` file that looks like the following:
@@ -76,8 +100,7 @@ extensions_whitelist: [rb, c, h, js]
 extensions_blacklist: [erb, html, txt]
 
 # which paths (relative to pwd) to ignore
-# It's usually better to avoid this since tagrity integrates with git by
-# default using the strategy specified by git_strategy
+# this is usually not needed since tagrity doesn't index files ignored by git
 #
 # Default: []
 excluded_paths: [vendor, node_modules]
@@ -89,9 +112,11 @@ excluded_paths: [vendor, node_modules]
 Commands:
   tagrity help [COMMAND]  # Describe available commands or one specific command
   tagrity logs            # Print the logs for pwd
+  tagrity revive          # Restart any tagrity processes that died
   tagrity start           # Start watching pwd
   tagrity status          # List running tagrity processes and the directories being watched
-  tagrity stop            # Stop watching pwd
+  tagrity stop            # Stop watching a directory (default to pwd)
+  tagrity version         # print tagrity version
 ```
 
 ### start
@@ -113,7 +138,11 @@ Start watching pwd
 Usage:
   tagrity stop
 
-Stop watching pwd
+Options:
+  [--dir=DIR]  # directory to stop watching.
+               # Default: /Users/rethy/ruby/tagrity
+
+Stop watching a directory (default to pwd)
 ```
 
 ### status

data/lib/tagrity/cli.rb

@@ -20,9 +20,10 @@ module Tagrity
       Command::Start::call(options['fg'], options['fresh'])
     end
 
-    desc "stop", "Stop watching pwd"
+    desc "stop", "Stop watching a directory (default to pwd)"
+    option :dir, type: :string, default: Dir.pwd, desc: "directory to stop watching."
     def stop()
-      Command::Stop::call
+      Command::Stop::call(options['dir'])
     end
 
     desc "status", "List running tagrity processes and the directories being watched"

data/lib/tagrity/commands/stop.rb

@@ -6,16 +6,16 @@ module Tagrity
   module Command
     class Stop
       class << self
-        def call
-          dir = Dir.pwd
+        def call(dir)
           pid_files = PidFile.alive_pid_files(dir: dir)
           if pid_files.empty?
             puts ::CLI::UI.fmt "{{red:#{"😕 tagrity doesn't seem to be watching #{dir}"}}}"
           else
             pid_files.each do |pid_file|
               pid_file.delete
-              puts ::CLI::UI.fmt "{{green:#{"Successfully killed #{pid_file.pid}"}}}"
-              logger.info("Successfully killed #{pid_file.pid}")
+              msg = "Successfully killed #{pid_file.pid} for dir #{dir}"
+              puts ::CLI::UI.fmt "{{green:#{msg}}}"
+              logger.info(msg)
             end
           end
         end

data/lib/tagrity/tag_generator.rb

@@ -2,7 +2,6 @@ require 'tmpdir'
 require 'tempfile'
 require 'fileutils'
 require 'tagrity/helper'
-require 'pry'
 
 module Tagrity
   class TagGenerator

data/lib/tagrity/version.rb

@@ -1,3 +1,3 @@
 module Tagrity
-  VERSION = "0.3.4"
+  VERSION = "0.3.9"
 end

data/sample_config.yml

@@ -33,8 +33,7 @@ extensions_whitelist: [rb, c, h, js]
 extensions_blacklist: [erb, html, txt]
 
 # which paths (relative to pwd) to ignore
-# It's usually better to avoid this since tagrity integrates with git by
-# default using the strategy specified by git_strategy
+# this is usually not needed since tagrity doesn't index files ignored by git
 #
 # Default: []
 excluded_paths: [vendor, node_modules]

data/tagrity.gemspec

@@ -34,5 +34,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "ripper-tags", "~> 0.8.0"
-  spec.add_dependency "pry", "~> 0.9.9"
+  spec.add_development_dependency "pry", "~> 0.9.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tagrity
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.9
 platform: ruby
 authors:
 - Adam P. Regasz-Rethy
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-29 00:00:00.000000000 Z
+date: 2021-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -115,7 +115,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.9
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -128,7 +128,6 @@ email:
 - rethy.spud@gmail.com
 executables:
 - tagrity
-- tagrity_revive
 extensions: []
 extra_rdoc_files: []
 files:
@@ -142,11 +141,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- TODO.md
 - bin/console
 - bin/setup
 - exe/tagrity
-- exe/tagrity_revive
 - lib/tagrity.rb
 - lib/tagrity/cli.rb
 - lib/tagrity/commands/logs.rb

data/TODO.md

@@ -1,5 +0,0 @@
-# TODO
-
-* Better error handling
-* Restart process which were terminated due to a system shutdown
-    * Will have to add `tagrity stop <pid>` instead of forcing users to use `kill <pid>`

data/exe/tagrity_revive

@@ -1,3 +0,0 @@
-#! /bin/sh
-
-echo "Hello, World!"