tagrity 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6a806ddd2c63796848d31f7937f7975b76c5e400530c9795fe256892edacfad
-  data.tar.gz: d191e1bb5446cd583b3a3496bdfd10a3ef8ca9cbf5f55503ba99ac78e7f3e475
+  metadata.gz: 0ee6568e2b6eece64b41ea5bfd180aff6770f909d2ae0a2d1b113d6776913bf7
+  data.tar.gz: 963d36ade8dcae0fcf5f9457c057c2ca99984c0e6c27ca5d583bfee960b0fd0e
 SHA512:
-  metadata.gz: '09f2854c20831ca036c19e6faa9af0575be22893b7601a3b0bc5ade5c2698a884509890fe5cd2a9b6fbdcfc2f8fc5873708b1c41af0abece7fab2b7f3d670fef'
-  data.tar.gz: 7c294ab265efdddc4ffd9127ebb228dad290ce5e49ced15b131d70280871df3bc072f7931497357e750673029e9885d56e6bfead8d2047959c99917ce6725bb5
+  metadata.gz: 07b68faab753df68dd50a90c0059498b35f55de439fd228e04a93d246489b3db50073d148c644bce12007d2c119bd6deaa9c3a17156d2680fa36f3f87aeea26e
+  data.tar.gz: 73d254a884b320d83fa06c794a7e30940b29d7021915ae8c4374f5d34c675a9af2a2d25c55bf42f37704e93dbba49263d0e0bcc2ca14c82e46bc6709204a836c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tagrity (0.1.2)
+    tagrity (0.1.3)
       listen (~> 3.0)
       thor (~> 0.20)
 

data/README.md

@@ -84,3 +84,44 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the Tagrity project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/tagrity/blob/master/CODE_OF_CONDUCT.md).
+
+
+
+
+tagrity config to use (default to ~/.config/tagrity/config.yml if available).
+A config file is a yaml file with the following possible values.
+Some of these can be overridden with options, however the configfile
+provided via --configfile will override the global config file in
+~/.config/tagrity/config.yml
+```
+# ext_cmds allows different tag generators to be used depending on the file extension.
+# Multiple extensions does not work, *.html.erb files will be picked up as erb.
+# ext_cmds:
+#   <file extension>: <command to use to generate tags for this file extension>
+# DEFAULT: empty
+ext_cmds:
+  rb: ripper-tags
+  c: ctags
+  go: gotags
+
+# default_cmd specifies the default command to be used to generate tags
+# default_cmd: <command>
+# DEFAULT: ctags
+default_cmd: ctags
+
+# tagf is the filename (relative) to generate tags into
+# tagf: <filename>
+# DEFAULT: tags
+tagf: tags
+
+# excluded_exts specifies which file extensions to not generate tags for.
+# excluded_exts: [<file extension>, ...]
+# DEFAULT: []
+excluded_exts: [rb, h, js]
+
+# excluded_paths specifies which paths to ignore.
+# It's usually better to avoid this since by default tagrity will only look
+# at files which are tracked by git.
+# excluded_paths: [<path>, ...]
+# DEFAULT: []
+excluded_paths: [vendor, node_modules]

data/lib/tagrity/cli.rb

@@ -6,16 +6,18 @@ require 'tagrity/commands/status'
 module Tagrity
   class CLI < Thor
     desc "start", "Start watching a directory (default to pwd)"
-    option :dir
-    option :fg, type: :boolean
-    option :configfile
-    option :tagf
-    option :default_cmd
-    option :excluded_exts, type: :array
-    option :excluded_paths, type: :array
+    option :dir, desc: "directory to watch (omit to use pwd)"
+    option :fresh, type: :boolean, default: false, desc: "index the whole codebase before watching the file system."
+    option :tagf, desc: "filename (relative) to generate tags into (default: 'tags')."
+    option :git, type: :boolean, default: true, desc: "only index files which are being tracked by git"
+    option :fg, type: :boolean, desc: "keep the tagrity process running in the foreground"
+    option :configfile, desc: "See README for more info."
+    option :default_cmd, desc: "the default command to be used to generate tags (default: 'ctags')"
+    option :excluded_exts, type: :array, desc: "which file extensions to not generate tags for."
+    option :excluded_paths, type: :array, desc: "which paths to ignore. Usually better to ignore this since by default only file tracked by git are indexed."
     def start()
       setup_config
-      Command::Start::call(dir, fg?)
+      Command::Start::call(dir, fg?, fresh?)
     end
 
     desc "stop", "Stop watching a directory (default to pwd)"
@@ -41,13 +43,18 @@ module Tagrity
       options[:fg]
     end
 
+    def fresh?
+      options[:fresh]
+    end
+
     def setup_config
       ConfigFile.instance.init(
         configfile: options[:configfile],
         default_cmd: options[:default_cmd],
         tagf: options[:tagf],
         excluded_exts: options[:excluded_exts],
-        excluded_paths: options[:excluded_paths]
+        excluded_paths: options[:excluded_paths],
+        git: options[:git]
       )
     end
   end

data/lib/tagrity/commands/start.rb

@@ -1,6 +1,6 @@
 require 'listen'
 require 'tagrity/pid_file'
-require 'tagrity/process_helper'
+require 'tagrity/helper'
 require 'tagrity/file_callbacks'
 require 'tagrity/provider'
 
@@ -10,7 +10,7 @@ module Tagrity
       class ErrorProcessAlreadyRunning < StandardError; end
 
       class << self
-        def call(dir, fg)
+        def call(dir, fg, fresh)
           assert_not_running(dir)
 
           Process.daemon(nochdir: true) unless fg
@@ -18,9 +18,10 @@ module Tagrity
           callbacks = Provider.provide(:file_callbacks)
           PidFile.write(PidFile.new(dir, Process.pid))
 
+          callbacks.on_fresh if fresh
+
           listener = Listen.to(
             dir,
-            ignore: [/^\.?tags$/],
             relative: true,
           ) do |modified, added, removed|
             callbacks.on_files_modified(modified)

data/lib/tagrity/config_file.rb

@@ -1,19 +1,21 @@
 require 'yaml'
 require 'singleton'
-require 'tagrity/executable_helper'
+require 'tagrity/helper'
 
 module Tagrity
   class ConfigFile
     include Singleton
 
     class ErrorTagFileNotWritable < StandardError; end
+    class ErrorGitNotExecutable < StandardError; end
 
     def init(
       configfile:,
       default_cmd:,
       tagf:,
       excluded_exts:,
-      excluded_paths:
+      excluded_paths:,
+      git:
     )
       fname = config_file_name(configfile)
       @config = if fname.nil? then {} else YAML.load_file(fname) end
@@ -22,11 +24,12 @@ module Tagrity
       ensure_tagf(tagf)
       ensure_excluded_exts(excluded_exts)
       ensure_excluded_paths(excluded_paths)
+      ensure_git(git)
     end
 
     def ft_to_cmd(ext)
       ft_cmd = @config['ext_cmds'][ext]
-      return @config['default_cmd'] if ft_cmd.nil? || !ExecutableHelper.is_executable(ft_cmd)
+      return @config['default_cmd'] if ft_cmd.nil? || !Helper.is_executable?(ft_cmd)
       ft_cmd
     end
 
@@ -42,6 +45,10 @@ module Tagrity
       @config['tagf']
     end
 
+    def respect_git?
+      @config['git']
+    end
+
     def to_s
       @config.to_s
     end
@@ -71,6 +78,13 @@ module Tagrity
       end
     end
 
+    def ensure_git(git)
+      set_option('git', git, true)
+      if @config['git'] && !Helper.is_executable?('git')
+        raise ErrorGitNotExecutable, "'git' must be executable to use the --git option."
+      end
+    end
+
     def set_option(key, local_val, default)
       unless local_val.nil?
         @config[key] = local_val

data/lib/tagrity/file_callbacks.rb

@@ -7,6 +7,10 @@ module Tagrity
       @tag_generator = tag_generator
     end
 
+    def on_fresh
+      @tag_generator.generate_all
+    end
+
     def on_files_modified(files)
       @tag_generator.generate(files)
     end

data/lib/tagrity/helper.rb

@@ -0,0 +1,57 @@
+module Tagrity
+  class Helper
+    root = ENV['TEST'] ? __dir__ : "#{ENV['HOME']}/.tagrity/"
+    RUN_DIR = File.join(root, 'var/run').freeze
+    LOG_DIR = File.join(root, 'var/log').freeze
+
+    class << self
+      def run_dir
+        ensure_data_dirs
+        RUN_DIR
+      end
+
+      def is_executable?(cmd)
+        !%x{command -v #{cmd}}.empty?
+      end
+
+      def kill(pid)
+        Process.kill('HUP', pid)
+      end
+
+      def alive?(pid)
+        Process.kill(0, pid) # signal 0 checks if pid is alive
+        true
+      rescue Errno::ESRCH
+        false
+      rescue Errno::EPERM
+        true
+      end
+
+      def is_git_dir?
+        return @is_git_dir unless @is_git_dir.nil?
+        `git rev-parse --git-dir &> /dev/null`
+        if $?.exitstatus == 0
+          @is_git_dir = true
+        else
+          @is_git_dir = false
+        end
+      end
+
+      def is_file_ignored?(file)
+        `git check-ignore -q #{file} &> /dev/null`
+        $?.exitstatus == 0
+      end
+
+      def is_file_tracked?(file)
+        `git ls-files --error-unmatch #{file} &> /dev/null`
+        $?.exitstatus == 0
+      end
+
+      private
+
+      def ensure_data_dirs
+        FileUtils.mkdir_p(RUN_DIR)
+      end
+    end
+  end
+end

data/lib/tagrity/pid_file.rb

@@ -1,31 +1,31 @@
+require 'tagrity/helper'
+
 module Tagrity
   class PidFile
-    RUN_DIR = "#{ENV['HOME']}/.tagrity/var/run"
-
     class << self
       def write(pid_file)
-        File.write("#{run_dir}/#{pid_file.name}", pid_file.dir)
+        File.write("#{Helper.run_dir}/#{pid_file.name}", pid_file.dir)
       end
 
       def delete(dir)
-        pid_file_paths = Dir.glob("#{run_dir}/#{dir.split('/').last}.*.pid").select do |path|
+        pid_file_paths = Dir.glob("#{Helper.run_dir}/#{dir.split('/').last}.*.pid").select do |path|
           full_dir = File.read(path)
           File.realdirpath(full_dir) == File.realdirpath(dir)
         end
 
         pid_file_paths.each do |path|
           File.delete(path)
-          ProcessHelper.kill(pid_from_path(path))
+          Helper.kill(pid_from_path(path))
         end
       end
 
       def alive_pid_files(dir: nil)
-        Dir.glob("#{run_dir}/*").reduce([]) do |pid_files, path|
+        Dir.glob("#{Helper.run_dir}/*").reduce([]) do |pid_files, path|
           pid = pid_from_path(path)
           pid_file_dir = File.read(path)
 
           if dir.nil? || is_same_dirs(pid_file_dir, dir)
-            if ProcessHelper.alive?(pid)
+            if Helper.alive?(pid)
               pid_files << PidFile.new(pid_file_dir, pid)
             else
               File.delete(path)
@@ -36,23 +36,12 @@ module Tagrity
         end
       end
 
-      def run_dir
-        ensure_dirs
-        RUN_DIR
-      end
-
       private
 
       def is_same_dirs(dir1, dir2)
         File.realdirpath(dir1) == File.realdirpath(dir2)
       end
 
-      def ensure_dirs
-        return if @ensure_dirs_done
-        FileUtils.mkdir_p(RUN_DIR)
-        @ensure_dirs_done = true
-      end
-
       def pid_from_path(pid_file_name)
         pid_file_name.split('.')[-2].to_i
       end
@@ -76,13 +65,13 @@ module Tagrity
 
     def delete
       File.delete(pid_file_path)
-      ProcessHelper.kill(pid.to_i)
+      Helper.kill(pid.to_i)
     end
 
     private
 
     def pid_file_path
-      "#{PidFile.run_dir}/#{name}"
+      "#{Helper.run_dir}/#{name}"
     end
   end
 end

data/lib/tagrity/tag_generator.rb

@@ -1,4 +1,5 @@
-require 'tagrity/executable_helper'
+require 'tmpdir'
+require 'tagrity/helper'
 
 module Tagrity
   class TagGenerator
@@ -9,37 +10,73 @@ module Tagrity
       @config = ConfigFile.instance
     end
 
+    def generate_all
+      if File.exists?(tagf)
+        File.delete(tagf)
+      end
+      if check_git?
+        files = `git ls-files 2> /dev/null`.split
+      else
+        files = `find * 2> /dev/null`.split
+      end
+      if $?.exitstatus == 0
+        generate(files)
+      else
+        puts "Failed to get a listing of all files under pwd for use with --fresh."
+      end
+    end
+
     def generate(files)
       return if files.empty?
       files
-        .select { |file| !dont_index_file(file) && File.readable?(file) }
+        .select { |file| generate_tags?(file) }
         .group_by { |file| @config.ft_to_cmd(file.partition('.').last) }
         .each do |cmd, fnames|
-        `#{cmd} -f #{tagf} --append #{fnames.join(' ')}`
-        if $?.exitstatus != 0
-          puts "{#{cmd}} failed to generate tags for #{fnames} into #{tagf}"
-        else
+        `#{cmd} -f #{tagf} --append #{fnames.join(' ')} &> /dev/null`
+        if $?.exitstatus == 0
           puts "{#{cmd}} generated tags for #{fnames} into #{tagf}"
+        else
+          puts "{#{cmd}} failed to generate tags for #{fnames} into #{tagf}"
         end
       end
     end
 
     def delete_files_tags(files)
       return if files.empty?
-      `cat #{tagf} | grep -v -F #{files.map { |f| " -e \"	#{f}	\""}.join(' ')} > .tagrity.tags`
-      `mv -f .tagrity.tags #{tagf}`
-      puts "Deleted tags for #{files} from #{tagf}"
+      `cat #{tagf} | grep -v -F #{files.map { |f| " -e \"	#{f}	\""}.join(' ')} > #{tmp_file} 2> /dev/null`
+        if $?.exitstatus == 0
+          `mv -f #{tmp_file} #{tagf}`
+          puts "Deleted tags for #{files} from #{tagf}"
+        else
+          puts "Failed to delete tags for #{files} from #{tagf}"
+        end
     end
 
     private
 
-    def dont_index_file(fname)
+    def generate_tags?(file)
+      copacetic_with_git?(file) && indexable?(file)
+    end
+
+    def indexable?(file)
+      file != tagf && !is_file_excluded(file) && File.readable?(file)
+    end
+
+    def copacetic_with_git?(file)
+      !(check_git? && !Helper.is_file_tracked?(file))
+    end
+
+    def check_git?
+      @config.respect_git? && Helper.is_git_dir?
+    end
+
+    def is_file_excluded(fname)
       @config.is_ft_excluded(fname.partition('.').last) || @config.is_path_excluded(fname)
     end
 
     def assert_executables
       %w(cat grep mv).each do |exe|
-        if !ExecutableHelper.is_executable(exe)
+        if !Helper.is_executable?(exe)
           raise ExecutableNonExist, "tagrity depends on the executable #{exe}"
         end
       end
@@ -48,5 +85,11 @@ module Tagrity
     def tagf
       @config.tagf
     end
+
+    def tmp_file
+      tmpdir = "#{Dir.tmpdir}/tagrity"
+      FileUtils.mkdir_p(tmpdir)
+      "#{tmpdir}/#{Process.pid}.tmptags"
+    end
   end
 end

data/lib/tagrity/version.rb

@@ -1,3 +1,3 @@
 module Tagrity
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tagrity
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Adam P. Regasz-Rethy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-12 00:00:00.000000000 Z
+date: 2019-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -114,16 +114,16 @@ files:
 - bin/console
 - bin/setup
 - exe/tagrity
+- foobar.rb
 - lib/tagrity.rb
 - lib/tagrity/cli.rb
 - lib/tagrity/commands/start.rb
 - lib/tagrity/commands/status.rb
 - lib/tagrity/commands/stop.rb
 - lib/tagrity/config_file.rb
-- lib/tagrity/executable_helper.rb
 - lib/tagrity/file_callbacks.rb
+- lib/tagrity/helper.rb
 - lib/tagrity/pid_file.rb
-- lib/tagrity/process_helper.rb
 - lib/tagrity/provider.rb
 - lib/tagrity/tag_generator.rb
 - lib/tagrity/version.rb

data/lib/tagrity/executable_helper.rb

@@ -1,9 +0,0 @@
-module Tagrity
-  class ExecutableHelper
-    class << self
-      def is_executable(cmd)
-        !%x{command -v #{cmd}}.empty?
-      end
-    end
-  end
-end

data/lib/tagrity/process_helper.rb

@@ -1,18 +0,0 @@
-module Tagrity
-  class ProcessHelper
-    class << self
-      def kill(pid)
-        Process.kill('HUP', pid)
-      end
-
-      def alive?(pid)
-        Process.kill(0, pid) # signal 0 checks if pid is alive
-        true
-      rescue Errno::ESRCH
-        false
-      rescue Errno::EPERM
-        true
-      end
-    end
-  end
-end