tagrity 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65a563d8eee08ae53bc757695cd9e307668a5222e3b841c6b1b6be7bb19043be
-  data.tar.gz: 0ba21cf9f1a2936140e8e26ec31b7b7a6cfcbca92789bafa9c2b75b2aa6944f8
+  metadata.gz: 3a5d0a4c40bcbeae4ad0312f0336030675f804a28a8a171d1963254c46efcc6a
+  data.tar.gz: f42987fb3804c6159d032653e04c9310ce22c3b6b369e61e196c69adc0d196e3
 SHA512:
-  metadata.gz: 0cc9e3b3babbdf5d048f913bbe05a85d866fe03a5f00a664aa0426f747ad15f3004fe9e674dad81ecc51e16945b8fd78a3bf93bff126927c515bf6ce881f9a0a
-  data.tar.gz: 02d9d817b50f25d6864f602fd22af3437458e458e534edfa5a26f4991bfeed5b8c976fb7ae43e608f05b148453538c026985cf155c666dfbe2440ccb198ee16a
+  metadata.gz: 4287ece1c8614b48c799ba21cbb694a38989433f4b96c7e57afb498ea066792a4831f10a701279b4599315c95ca62e69b373797b922cbeca4b1bc321388f3592
+  data.tar.gz: 58f1ee384271f30b5ebc5693fc6de8a9ae8dda286a9e39f03f28940478fb4a1eab9efe74171a73e92993107b22437e1e3a6ba03050b4e9d8280630f4216f0943

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tagrity (0.1.6)
+    tagrity (0.1.7)
       listen (~> 3.0)
       pry (~> 0.9.9)
       thor (~> 0.20)

data/lib/tagrity/cli.rb

@@ -5,59 +5,21 @@ require 'tagrity/commands/status'
 
 module Tagrity
   class CLI < Thor
-    desc "start", "Start watching a directory (default to pwd)"
-    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"
+    desc "start", "Start watching pwd"
+    option :fg, type: :boolean, default: false, 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?, fresh?)
+      Command::Start::call(options['fg'], options['fresh'])
     end
 
-    desc "stop", "Stop watching a directory (default to pwd)"
-    option :dir
+    desc "stop", "Stop watching pwd"
     def stop()
-      Command::Stop::call(dir)
+      Command::Stop::call
     end
 
     desc "status", "List running tagrity processes and the directories being watched"
     def status
       Command::Status::call
     end
-
-    private
-
-    def dir
-      dir = options[:dir] || Dir.pwd
-      raise Errno::ENOENT, "No such directory - #{dir}" unless Dir.exists?(dir)
-      dir
-    end
-
-    def fg?
-      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],
-        git: options[:git]
-      )
-    end
   end
 end

data/lib/tagrity/commands/start.rb

@@ -1,8 +1,8 @@
 require 'listen'
 require 'tagrity/pid_file'
 require 'tagrity/helper'
-require 'tagrity/file_callbacks'
 require 'tagrity/provider'
+require 'tagrity/tlogger'
 
 module Tagrity
   module Command
@@ -10,32 +10,43 @@ module Tagrity
       class ErrorProcessAlreadyRunning < StandardError; end
 
       class << self
-        def call(dir, fg, fresh)
+        def call(fg, fresh)
+          dir = Dir.pwd
           assert_not_running(dir)
 
           Process.daemon(nochdir: true) unless fg
 
-          callbacks = Provider.provide(:file_callbacks)
+          tag_generator = Provider.provide(:tag_generator)
           PidFile.write(PidFile.new(dir, Process.pid))
 
-          callbacks.on_fresh if fresh
+          logger.fg = fg
+          logger.info("Watching #{dir} with process pid #{Process.pid}")
+
+          tag_generator.generate_all if fresh
 
           listener = Listen.to(
             dir,
             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)
+            unless modified.empty?
+              logger.info("modified absolute path: #{modified}")
+              tag_generator.generate(modified)
+            end
+            unless added.empty?
+              logger.info("added absolute path: #{added}")
+              tag_generator.generate(added)
+            end
+            unless removed.empty?
+              logger.info("removed absolute path: #{removed}")
+              tag_generator.delete_files_tags(removed)
+            end
           end
           listener.start
           sleep
         rescue ErrorProcessAlreadyRunning => e
-          puts e.message
+          logger.error(e.message)
         rescue Interrupt => e
+          logger.info("Process interrupted. Killing #{Process.pid}")
           PidFile.delete(dir)
         end
 
@@ -48,6 +59,10 @@ module Tagrity
             raise ErrorProcessAlreadyRunning, "Error: tagrity is already watching #{dir} with process #{pids}"
           end
         end
+
+        def logger
+          @logger ||= Tlogger.instance
+        end
       end
     end
   end

data/lib/tagrity/commands/stop.rb

@@ -1,8 +1,11 @@
+require 'tagrity/tlogger'
+
 module Tagrity
   module Command
     class Stop
       class << self
-        def call(dir)
+        def call
+          dir = Dir.pwd
           pid_files = PidFile.alive_pid_files(dir: dir)
           if pid_files.empty?
             puts "😕 tagrity doesn't seem to be watching #{dir}"
@@ -10,6 +13,7 @@ module Tagrity
             pid_files.each do |pid_file|
               pid_file.delete
               puts "Successfully killed #{pid_file.pid}"
+              Tlogger.instance.info("Successfully killed #{pid_file.pid}")
             end
           end
         end

data/lib/tagrity/config_file.rb

@@ -7,105 +7,129 @@ module Tagrity
     include Singleton
 
     class ErrorTagFileNotWritable < StandardError; end
-    class ErrorGitNotExecutable < StandardError; end
 
-    def init(
-      configfile:,
-      default_cmd:,
-      tagf:,
-      ext_cmds:,
-      excluded_exts:,
-      excluded_paths:,
-      git:
-    )
-      fname = config_file_name(configfile)
-      @config = if fname.nil? then {} else YAML.load_file(fname) end
-      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)
+    CONFIG_FNAME = 'tagrity_config.yml'
+    LOCAL_CONFIG_PATH = File.expand_path("./.#{CONFIG_FNAME}")
+    GLOBAL_CONFIG_PATH = File.expand_path("#{ENV['XDG_CONFIG_HOME'] || "#{ENV['HOME']}/.config"}/tagrity/#{CONFIG_FNAME}")
+
+    def init
+      ensure_extension_commands
+      ensure_default_command
+      ensure_tagf
+      ensure_extensions_whitelist
+      ensure_extensions_blacklist
+      ensure_git_strategy
+      ensure_excluded_paths
+    end
+
+    def command_for_extension(extension)
+      cmd = extension_commands[extension]
+      if cmd.nil?
+        default_command
+      else
+        cmd
+      end
+    end
+
+    def ignore_extension?(extension)
+      unless extensions_whitelist.empty?
+        return !extensions_whitelist.include?(extension)
+      end
+
+      extensions_blacklist.include?(extension)
     end
 
-    def ft_to_cmd(ext)
-      ft_cmd = @config['ext_cmds'][ext]
-      return @config['default_cmd'] if ft_cmd.nil? || !Helper.is_executable?(ft_cmd)
-      ft_cmd
+    def path_ignored?(path)
+      excluded_paths.any? { |pat| /#{pat}/ =~ path }
     end
 
-    def is_ft_excluded(ext)
-      @config['excluded_exts'].include?(ext)
+    def respect_git?
+      git_strategy != 'NA'
     end
 
-    def is_path_excluded(path)
-      @config['excluded_paths'].any? { |pat| /^(\.\/)?#{pat}.*/ =~ path }
+    def extension_commands
+      config['extension_commands']
+    end
+
+    def default_command
+      config['default_command']
     end
 
     def tagf
-      @config['tagf']
+      config['tagf']
     end
 
-    def respect_git?
-      @config['git']
+    def extensions_whitelist
+      config['extensions_whitelist']
+    end
+
+    def extensions_blacklist
+      config['extensions_blacklist']
+    end
+
+    def git_strategy
+      config['git_strategy']
+    end
+
+    def excluded_paths
+      config['excluded_paths']
     end
 
     def to_s
-      @config.to_s
+      config.to_s
     end
 
     private
 
-    def ensure_ext_cmds(ext_cmds)
-      set_option('ext_cmds', ext_cmds, {})
+    def ensure_extension_commands
+      ensure_option('extension_commands', {})
     end
 
-    def ensure_default_cmd(default_cmd)
-      set_option('default_cmd', default_cmd, 'ctags')
+    def ensure_default_command
+      ensure_option('default_command', 'ctags')
     end
 
-    def ensure_excluded_exts(excluded_exts)
-      set_option('excluded_exts', excluded_exts, [])
+    def ensure_tagf
+      ensure_option('tagf', 'tags')
+      if File.exists?(tagf) && !File.writable?(tagf)
+        raise ErrorTagFileNotWritable, "#{tagf} must be writable to be used as the tag file."
+      end
     end
 
-    def ensure_excluded_paths(excluded_paths)
-      set_option('excluded_paths', excluded_paths, [])
+    def ensure_extensions_whitelist
+      ensure_option('whitelist_extensions', [])
     end
 
-    def ensure_tagf(tagf)
-      set_option('tagf', tagf, 'tags')
-      if File.exists?(@config['tagf']) && !File.writable?(@config['tagf'])
-        raise ErrorTagFileNotWritable, "#{@config['tagf']} must be writable to be used as the tag file."
-      end
+    def ensure_extensions_blacklist
+      ensure_option('blacklist_extensions', [])
     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
+    def ensure_git_strategy
+      ensure_option('git_strategy', 'TRACKED')
     end
 
-    def set_option(key, local_val, default)
-      unless local_val.nil?
-        @config[key] = local_val
-      end
-      return if @config.key?(key) && !@config[key].nil? && @config[key].is_a?(default.class)
-      @config[key] = default
+    def ensure_excluded_paths
+      ensure_option('extension_commands', [])
     end
 
-    def config_file_name(fname)
-      return fname unless fname.nil?
-      return global_config_file_name if File.file?(global_config_file_name)
-      nil
+    def ensure_option(name, default)
+      if config[name].nil? || !config[name].is_a?(default.class)
+        config[name] = default
+      end
     end
 
-    def global_config_file_name
-      "#{global_config_dir_name}/config.yml"
+    def config
+      @config ||= read_config
     end
 
-    def global_config_dir_name
-      "#{ENV["HOME"]}/.config/tagrity"
+    def read_config
+      if File.readable?(LOCAL_CONFIG_PATH)
+        @config = YAML.load_file(LOCAL_CONFIG_PATH)
+      elsif File.readable?(GLOBAL_CONFIG_PATH)
+        @config = YAML.load_file(GLOBAL_CONFIG_PATH)
+      else
+        @config = {}
+      end
     end
   end
 end

data/lib/tagrity/helper.rb

@@ -10,6 +10,11 @@ module Tagrity
         RUN_DIR
       end
 
+      def log_dir
+        ensure_data_dirs
+        LOG_DIR
+      end
+
       def is_executable?(cmd)
         !%x{command -v #{cmd}}.empty?
       end
@@ -28,21 +33,16 @@ module Tagrity
       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
+        $?.exitstatus == 0
       end
 
-      def is_file_ignored?(file)
+      def file_ignored?(file)
         `git check-ignore -q #{file} &> /dev/null`
         $?.exitstatus == 0
       end
 
-      def is_file_tracked?(file)
+      def file_tracked?(file)
         `git ls-files --error-unmatch #{file} &> /dev/null`
         $?.exitstatus == 0
       end
@@ -51,6 +51,7 @@ module Tagrity
 
       def ensure_data_dirs
         FileUtils.mkdir_p(RUN_DIR)
+        FileUtils.mkdir_p(LOG_DIR)
       end
     end
   end

data/lib/tagrity/provider.rb

@@ -1,4 +1,3 @@
-require 'tagrity/file_callbacks'
 require 'tagrity/config_file'
 require 'tagrity/tag_generator'
 
@@ -7,17 +6,11 @@ module Tagrity
     class << self
       def provide(want)
         case want
-        when :file_callbacks
-          provide_file_callbacks
         when :tag_generator
           provide_tag_generator
         end
       end
 
-      def provide_file_callbacks
-        FileCallbacks.new(provide(:tag_generator))
-      end
-
       def provide_tag_generator
         TagGenerator.new
       end

data/lib/tagrity/tag_generator.rb

@@ -1,8 +1,8 @@
 require 'tmpdir'
 require 'tempfile'
 require 'fileutils'
-require 'pry'
 require 'tagrity/helper'
+require 'tagrity/tlogger'
 
 module Tagrity
   class TagGenerator
@@ -17,15 +17,16 @@ module Tagrity
       if File.exists?(tagf)
         File.delete(tagf)
       end
-      if check_git?
-        files = `git ls-files 2> /dev/null`.split
+      cmd = if check_git?
+        'git ls-files 2> /dev/null'
       else
-        files = `find * 2> /dev/null`.split
+        'find * 2> /dev/null'
       end
+      files = `#{cmd}`.split
       if $?.exitstatus == 0
         generate(files)
       else
-        puts "Failed to get a listing of all files under pwd for use with --fresh."
+        logger.error("Failed to get a listing of all files under pwd for use with --fresh. Used #{cmd}.")
       end
     end
 
@@ -33,15 +34,15 @@ module Tagrity
       return if files.empty?
       files
         .select { |file| generate_tags?(file) }
-        .group_by { |file| @config.ft_to_cmd(file.partition('.').last) }
+        .group_by { |file| @config.command_for_extension(file.partition('.').last) }
         .each do |cmd, fnames|
         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}"
+            logger.info("{#{cmd}} generated tags for #{fnames} into #{tagf}")
           else
-            puts "{#{cmd}} failed to generate tags for #{fnames} into #{tagf}"
+            logger.info("{#{cmd}} failed to generate tags for #{fnames} into #{tagf}")
           end
         end
       end
@@ -59,7 +60,7 @@ module Tagrity
         end
         tmpf.rewind
         FileUtils.mv(tmpf.path, tagf, force: true)
-        puts "Deleted tags for #{files} from #{tagf}"
+        logger.info("Deleted tags for #{files} from #{tagf}")
       end
     end
 
@@ -74,7 +75,15 @@ module Tagrity
     end
 
     def copacetic_with_git?(file)
-      !(check_git? && !Helper.is_file_tracked?(file))
+      return true if !check_git?
+      case @config.git_strategy
+      when 'TRACKED'
+        Helper.file_tracked?(file)
+      when 'IGNORED'
+        !Helper.file_ignored?(file)
+      else
+        false
+      end
     end
 
     def check_git?
@@ -82,7 +91,7 @@ module Tagrity
     end
 
     def is_file_excluded(fname)
-      @config.is_ft_excluded(fname.partition('.').last) || @config.is_path_excluded(fname)
+      @config.ignore_extension?(fname.partition('.').last) || @config.path_ignored?(fname)
     end
 
     def assert_executables
@@ -96,5 +105,9 @@ module Tagrity
     def tagf
       @config.tagf
     end
+
+    def logger
+      Tlogger.instance
+    end
   end
 end

data/lib/tagrity/tlogger.rb

@@ -0,0 +1,30 @@
+require 'singleton'
+require 'logger'
+require 'tagrity/helper'
+
+module Tagrity
+  class Tlogger
+    include Singleton
+
+    attr_writer :fg
+
+    def info(msg)
+      logger.info(msg)
+    end
+
+    def error(msg)
+      logger.error(msg)
+    end
+
+    private
+
+    def logger
+      @logger ||= Logger.new(@fg ? STDOUT : logf, 'weekly')
+    end
+
+    def logf
+      # TODO this can cause duplicates, unlikely tho
+      "#{Helper.log_dir}/#{Dir.pwd.gsub(/\//, '--')}.log"
+    end
+  end
+end

data/lib/tagrity/version.rb

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

data/sample_config.yml

@@ -1,31 +1,41 @@
-# 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>
+# which command to use to generate tags for a specific file extension
+# overrides default_command
+# commands must support --append, -f, -L
 # DEFAULT: empty
-ext_cmds:
+extension_commands:
   rb: ripper-tags
   c: ctags
   go: gotags
 
-# default_cmd specifies the default command to be used to generate tags
-# default_cmd: <command>
+# default command to generate tags
+# command must support --append, -f, -L
 # DEFAULT: ctags
-default_cmd: ctags
+default_command: ctags
 
-# tagf is the filename (relative) to generate tags into
-# tagf: <filename>
+# filename (relative to pwd) to generate tags into
 # DEFAULT: tags
 tagf: tags
 
-# excluded_exts specifies which file extensions to not generate tags for.
-# excluded_exts: [<file extension>, ...]
+# list of extensions to exclusively generate tags for
+# this will take precendence over extensions_blacklist if it is non-empty
 # DEFAULT: []
-excluded_exts: [rb, h, js]
+extensions_whitelist: [rb, c, 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>, ...]
+# list of extensions to not generate tags for
+# this can will be ignored if extensions_whitelist is non-empty
+# DEFAULT: []
+extensions_blacklist: [erb, html, txt]
+
+# how to integrate with git
+# git_strategy: TRACKED | IGNORED | NA
+# TRACKED: only index files tracked by git
+# IGNORED: don't index files which are ignored by git
+# NA: don't use git, index all files under pwd
+# DEFAULT: TRACKED
+git_strategy: TRACKED
+
+# 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
 # DEFAULT: []
 excluded_paths: [vendor, node_modules]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tagrity
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Adam P. Regasz-Rethy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-18 00:00:00.000000000 Z
+date: 2019-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -116,7 +116,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".byebug_history"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -135,11 +134,11 @@ files:
 - lib/tagrity/commands/status.rb
 - lib/tagrity/commands/stop.rb
 - lib/tagrity/config_file.rb
-- lib/tagrity/file_callbacks.rb
 - lib/tagrity/helper.rb
 - lib/tagrity/pid_file.rb
 - lib/tagrity/provider.rb
 - lib/tagrity/tag_generator.rb
+- lib/tagrity/tlogger.rb
 - lib/tagrity/version.rb
 - sample_config.yml
 - tagrity.gemspec
@@ -165,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Regenerate tags on file changes.

data/.byebug_history

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

data/lib/tagrity/file_callbacks.rb

@@ -1,26 +0,0 @@
-require 'tagrity/tag_generator'
-require 'tagrity/config_file'
-
-module Tagrity
-  class FileCallbacks
-    def initialize(tag_generator)
-      @tag_generator = tag_generator
-    end
-
-    def on_fresh
-      @tag_generator.generate_all
-    end
-
-    def on_files_modified(files)
-      @tag_generator.generate(files)
-    end
-
-    def on_files_added(files)
-      @tag_generator.generate(files)
-    end
-
-    def on_files_removed(files)
-      @tag_generator.delete_files_tags(files)
-    end
-  end
-end