tagrity 0.1.2 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38dc3f96b14b1ef629c339a71faf41d448b7ca5281dd9d4e69ea4a2dcf167662
-  data.tar.gz: 731c6fb5f54d8c9ca850f2ee6a38018f6a1765b1663334b52ba2ad0f9929c686
+  metadata.gz: 65a563d8eee08ae53bc757695cd9e307668a5222e3b841c6b1b6be7bb19043be
+  data.tar.gz: 0ba21cf9f1a2936140e8e26ec31b7b7a6cfcbca92789bafa9c2b75b2aa6944f8
 SHA512:
-  metadata.gz: e228435fd32b23cb6d36b184889a82a170abc8422870d4321d36d5e2a17e89a108804ca4f83613ae41ad2e71091dae20a3e59652af5d715fa1f761055f6e1f6b
-  data.tar.gz: db4f8487a44f71e366bfa83e6308ab712236ea038348a08ca6302904ab6d8cf1b09b61eb0dcc96aa233b8f964f07b41985af27043756d2001e3d697b19dfdbb6
+  metadata.gz: 0cc9e3b3babbdf5d048f913bbe05a85d866fe03a5f00a664aa0426f747ad15f3004fe9e674dad81ecc51e16945b8fd78a3bf93bff126927c515bf6ce881f9a0a
+  data.tar.gz: 02d9d817b50f25d6864f602fd22af3437458e458e534edfa5a26f4991bfeed5b8c976fb7ae43e608f05b148453538c026985cf155c666dfbe2440ccb198ee16a

data/.byebug_history

@@ -0,0 +1,4 @@
+continue
+n
+next
+ls 

data/Gemfile.lock

@@ -1,18 +1,25 @@
 PATH
   remote: .
   specs:
-    tagrity (0.1.2)
+    tagrity (0.1.6)
       listen (~> 3.0)
+      pry (~> 0.9.9)
       thor (~> 0.20)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    coderay (1.1.2)
     diff-lcs (1.3)
     ffi (1.11.3)
-    listen (3.2.0)
+    listen (3.2.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
+    method_source (0.9.2)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
     rake (10.5.0)
     rb-fsevent (0.10.3)
     rb-inotify (0.10.0)
@@ -31,6 +38,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.0)
+    slop (3.6.0)
     thor (0.20.3)
 
 PLATFORMS

data/README.md

@@ -4,19 +4,17 @@ Automatically regenerate tags on file changes.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'tagrity'
+```sh
+$ gem install tagrity
 ```
 
-And then execute:
-
-    $ bundle
+## Quick Start
 
-Or install it yourself as:
+```sh
+tagrity start
+```
 
-    $ gem install tagrity
+That's it! By default, tagrity will only index files tracked by git. You may wish to al
 
 ## Usage
 
@@ -84,3 +82,12 @@ 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

data/lib/tagrity/cli.rb

@@ -6,16 +6,19 @@ 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 :tagf, desc: "filename (relative) to generate tags into (default: 'tags')."
+    option :fg, type: :boolean, desc: "keep the tagrity process running in the foreground"
+    option :fresh, type: :boolean, default: false, desc: "index the whole codebase before watching the file system. This will be slow if the codebase is large."
+    option :git, type: :boolean, default: true, desc: "only index files which are being tracked by git"
+    option :configfile, desc: "See README for more info."
+    option :ext_cmds, type: :hash, desc: "which <command> to use to generate tags based on the file extension. <command> must support -f and --append"
+    option :default_cmd, desc: "the default <command> to be used to generate tags (default: 'ctags'). <command> must support -f and --append"
+    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 +44,19 @@ 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],
+        ext_cmds: options[:ext_cmds],
         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,11 +18,15 @@ 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|
+            puts "modified absolute path: #{modified}"
+            puts "added absolute path: #{added}"
+            puts "removed absolute path: #{removed}"
             callbacks.on_files_modified(modified)
             callbacks.on_files_added(added)
             callbacks.on_files_removed(removed)

data/lib/tagrity/config_file.rb

@@ -1,32 +1,36 @@
 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:,
+      ext_cmds:,
       excluded_exts:,
-      excluded_paths:
+      excluded_paths:,
+      git:
     )
       fname = config_file_name(configfile)
       @config = if fname.nil? then {} else YAML.load_file(fname) end
-      ensure_ext_cmds
+      ensure_ext_cmds(ext_cmds)
       ensure_default_cmd(default_cmd)
       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,14 +46,18 @@ module Tagrity
       @config['tagf']
     end
 
+    def respect_git?
+      @config['git']
+    end
+
     def to_s
       @config.to_s
     end
 
     private
 
-    def ensure_ext_cmds
-      set_option('ext_cmds', nil, {})
+    def ensure_ext_cmds(ext_cmds)
+      set_option('ext_cmds', ext_cmds, {})
     end
 
     def ensure_default_cmd(default_cmd)
@@ -66,11 +74,18 @@ module Tagrity
 
     def ensure_tagf(tagf)
       set_option('tagf', tagf, 'tags')
-      unless File.writable?(@config['tagf'])
+      if File.exists?(@config['tagf']) && !File.writable?(@config['tagf'])
         raise ErrorTagFileNotWritable, "#{@config['tagf']} must be writable to be used as the tag file."
       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 = "#{__dir__}/../../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,8 @@
-require 'tagrity/executable_helper'
+require 'tmpdir'
+require 'tempfile'
+require 'fileutils'
+require 'pry'
+require 'tagrity/helper'
 
 module Tagrity
   class TagGenerator
@@ -9,37 +13,81 @@ 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
-          puts "{#{cmd}} generated tags for #{fnames} into #{tagf}"
+        Tempfile.create do |tmpf|
+          IO::write(tmpf.path, fnames.join("\n"))
+          system(cmd, '-f', tagf, '--append', '-L', tmpf.path, out: File::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
     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}"
+      Tempfile.create do |tmpf|
+        File.open(tagf) do |f|
+          f.each_line do |line|
+            unless files.any? { |fname| line.include?("\t#{fname}\t") }
+              tmpf.write line
+            end
+          end
+        end
+        tmpf.rewind
+        FileUtils.mv(tmpf.path, tagf, force: true)
+        puts "Deleted 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

data/lib/tagrity/version.rb

@@ -1,3 +1,3 @@
 module Tagrity
-  VERSION = "0.1.2"
+  VERSION = "0.1.7"
 end

data/sample_config.yml

@@ -0,0 +1,31 @@
+# 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/tagrity.gemspec

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tagrity
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.7
 platform: ruby
 authors:
 - Adam P. Regasz-Rethy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-12 00:00:00.000000000 Z
+date: 2019-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
 description: Ditto
 email:
 - rethy.spud@gmail.com
@@ -102,6 +116,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".byebug_history"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -120,13 +135,13 @@ files:
 - 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
+- sample_config.yml
 - tagrity.gemspec
 homepage: https://github.com/RRethy/tagrity
 licenses:

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