tagrity 0.1.12 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42e6594cf3699cc2f960b28ecb7d06b3ec2c75b8f39d9eb9d6296b6385bb5a52
-  data.tar.gz: 7bf5d6fd08a760d9f2c99a7e3419dec5580f0bd040a680cb9081ace9922ea25a
+  metadata.gz: 20de67060444a9805be57457f42fbead18066cf3f65c7a51f6262328f86381c6
+  data.tar.gz: b342a4934b3d604f5fadc98d559a9863346d35e984641606fe6f3697a1829787
 SHA512:
-  metadata.gz: b9d20591c5e50bd0d1e662511d1f51095bf91c862b2d1ba7bf38e5c6455a80bcbdcaab1b59831af4a6dcaee53fe74b6dfa04e9090b1a7d0cc9a2382c59b2fce2
-  data.tar.gz: c8ac398b851e39503f9a68d8c8655dadadbddaff7d5ff82ff5843ec555ac52ec586d6be39f0456440187742f31fb53343ab1605b14c7f6a4a4426eded189caf6
+  metadata.gz: 227ecdbf6ea0faa4b24b5ec2b6238285ef1cb8c585e42abef2aa82baeaf6a1b65d403e34dd42aafff3acf1ac7eaeec798f87ec7c318e416f7b1acc897eeaf5ba
+  data.tar.gz: 16c33ed46225a24a24bd090661d88866c5a760ef5ee373e718f2ae93f97cbd221142e1634ddeb83362645c203ae9001c38e9e2161d9684addb48b92997f6ce64

data/.tagrity_config.yml

@@ -0,0 +1,38 @@
+# which command to use to generate tags for a specific file extension
+# overrides default_command
+# DEFAULT: empty
+extension_commands:
+  rb: ripper-tags
+  c: ctags
+
+# default command to generate tags
+# DEFAULT: ctags
+default_command: ctags
+
+# filename (relative to pwd) to generate tags into
+# DEFAULT: tags
+tagf: tags
+
+# list of extensions to exclusively generate tags for
+# this will take precendence over extensions_blacklist if it is non-empty
+# DEFAULT: []
+extensions_whitelist: [rb]
+
+# 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: [test_files]

data/.travis.yml

@@ -4,4 +4,9 @@ language: ruby
 cache: bundler
 rvm:
   - 2.6.3
-before_install: gem install bundler -v 2.0.2
+before_install:
+  - gem install bundler -v 2.0.2
+  - gem install ripper-tags -v 0.8.1
+  - brew unlink python@2
+  - brew install --HEAD universal-ctags/universal-ctags/universal-ctags
+os: osx

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tagrity (0.1.11)
+    tagrity (0.2.0)
       cli-ui (~> 1.3.0)
       listen (~> 3.0)
       pry (~> 0.9.9)

data/README.md

@@ -1,5 +1,7 @@
 # Tagrity
 
+[![Build Status](https://travis-ci.com/RRethy/tagrity.svg?branch=master)](https://travis-ci.com/RRethy/tagrity)
+
 Automatically regenerate tags on file changes.
 
 ## Installation
@@ -38,7 +40,8 @@ Configuration can be done through use of a `tagrity_config.yml` file that looks
 # which command to use to generate tags for a specific file extension
 # overrides default_command
 # commands must support --append, -f, -L
-# DEFAULT: empty
+#
+# Default: empty
 extension_commands:
   rb: ripper-tags
   c: ctags
@@ -46,21 +49,25 @@ extension_commands:
 
 # default command to generate tags
 # command must support --append, -f, -L
-# DEFAULT: ctags
+#
+# Default: ctags
 default_command: ctags
 
 # filename (relative to pwd) to generate tags into
-# DEFAULT: tags
+#
+# Default: tags
 tagf: tags
 
 # list of extensions to exclusively generate tags for
 # this will take precendence over extensions_blacklist if it is non-empty
-# DEFAULT: []
+#
+# Default: []
 extensions_whitelist: [rb, c, h, js]
 
 # list of extensions to not generate tags for
 # this can will be ignored if extensions_whitelist is non-empty
-# DEFAULT: []
+#
+# Default: []
 extensions_blacklist: [erb, html, txt]
 
 # how to integrate with git
@@ -69,13 +76,14 @@ extensions_blacklist: [erb, html, txt]
 # IGNORED: don't index files which are ignored by git
 # NA: don't use git, index all files under pwd
 #
-# DEFAULT: TRACKED
+# 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: []
+#
+# Default: []
 excluded_paths: [vendor, node_modules]
 ```
 

data/lib/tagrity/config_file.rb

@@ -12,18 +12,16 @@ module Tagrity
     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
+    def reload_local
+      read_config(fname: local_config_path)
+    end
+
+    def reload_global
+      read_config(fname: global_config_path)
     end
 
     def command_for_extension(extension)
-      cmd = extension_commands[extension]
+      cmd = extension_commands[extension.to_s]
       if cmd.nil?
         default_command
       else
@@ -33,14 +31,14 @@ module Tagrity
 
     def ignore_extension?(extension)
       unless extensions_whitelist.empty?
-        return !extensions_whitelist.include?(extension)
+        return !extensions_whitelist.include?(extension.to_s)
       end
 
-      extensions_blacklist.include?(extension)
+      extensions_blacklist.include?(extension.to_s)
     end
 
     def path_ignored?(path)
-      excluded_paths.any? { |pat| /#{pat}/ =~ path }
+      excluded_paths.any? { |pat| !(/^#{pat}/ =~ path.to_s).nil? }
     end
 
     def respect_git?
@@ -81,6 +79,16 @@ module Tagrity
 
     private
 
+    def init
+      ensure_extension_commands
+      ensure_default_command
+      ensure_tagf
+      ensure_extensions_whitelist
+      ensure_extensions_blacklist
+      ensure_git_strategy
+      ensure_excluded_paths
+    end
+
     def ensure_extension_commands
       ensure_option('extension_commands', {})
     end
@@ -109,7 +117,7 @@ module Tagrity
     end
 
     def ensure_excluded_paths
-      ensure_option('extension_commands', [])
+      ensure_option('excluded_paths', [])
     end
 
     def ensure_option(name, default)
@@ -122,14 +130,27 @@ module Tagrity
       @config ||= read_config
     end
 
-    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)
+    def read_config(fname: nil)
+      @config = {}
+      if fname.nil?
+        if File.readable?(local_config_path)
+          read_config(fname: local_config_path)
+        elsif File.readable?(global_config_path)
+          read_config(fname: global_config_path)
+        end
       else
-        @config = {}
+        @config = YAML.load_file(fname)
       end
+      init
+      @config
+    end
+
+    def global_config_path
+      File.expand_path("#{ENV['XDG_CONFIG_HOME'] || "#{ENV['HOME']}/.config"}/tagrity/#{CONFIG_FNAME}")
+    end
+
+    def local_config_path
+      File.expand_path("./.#{CONFIG_FNAME}")
     end
   end
 end

data/lib/tagrity/helper.rb

@@ -15,7 +15,7 @@ module Tagrity
         LOG_DIR
       end
 
-      def is_executable?(cmd)
+      def executable?(cmd)
         !%x{command -v #{cmd}}.empty?
       end
 
@@ -32,7 +32,7 @@ module Tagrity
         true
       end
 
-      def is_git_dir?
+      def git_dir?
         `git rev-parse --git-dir &> /dev/null`
         $?.exitstatus == 0
       end

data/lib/tagrity/pid_file.rb

@@ -24,7 +24,7 @@ module Tagrity
           pid = pid_from_path(path)
           pid_file_dir = File.read(path)
 
-          if dir.nil? || is_same_dirs(pid_file_dir, dir)
+          if dir.nil? || same_dirs?(pid_file_dir, dir)
             if Helper.alive?(pid)
               pid_files << PidFile.new(pid_file_dir, pid)
             else
@@ -38,7 +38,7 @@ module Tagrity
 
       private
 
-      def is_same_dirs(dir1, dir2)
+      def same_dirs?(dir1, dir2)
         File.realdirpath(dir1) == File.realdirpath(dir2)
       end
 

data/lib/tagrity/provider.rb

@@ -1,5 +1,6 @@
 require 'tagrity/config_file'
 require 'tagrity/tag_generator'
+require 'tagrity/tlogger'
 
 module Tagrity
   class Provider
@@ -12,7 +13,7 @@ module Tagrity
       end
 
       def provide_tag_generator
-        TagGenerator.new
+        TagGenerator.new(ConfigFile.instance, Tlogger.instance)
       end
     end
   end

data/lib/tagrity/tag_generator.rb

@@ -2,15 +2,15 @@ require 'tmpdir'
 require 'tempfile'
 require 'fileutils'
 require 'tagrity/helper'
-require 'tagrity/tlogger'
+require 'pry'
 
 module Tagrity
   class TagGenerator
     class ExecutableNonExist < StandardError; end
 
-    def initialize
-      assert_executables
-      @config = ConfigFile.instance
+    def initialize(config, logger)
+      @config = config
+      @logger = logger
     end
 
     def generate_all
@@ -26,7 +26,7 @@ module Tagrity
       if $?.exitstatus == 0
         generate(files)
       else
-        logger.error("Failed to get a listing of all files under pwd for use with --fresh. Used #{cmd}.")
+        @logger.error("Failed to get a listing of all files under pwd for use with --fresh. Used #{cmd}.")
       end
     end
 
@@ -40,9 +40,9 @@ module Tagrity
           IO::write(tmpf.path, fnames.join("\n"))
           system(cmd, '-f', tagf, '--append', '-L', tmpf.path, out: File::NULL)
           if $?.exitstatus == 0
-            logger.info("{#{cmd}} generated tags for #{fnames} into #{tagf}")
+            @logger.info("{#{cmd}} generated tags for #{fnames} into #{tagf}")
           else
-            logger.info("{#{cmd}} failed to generate tags for #{fnames} into #{tagf}")
+            @logger.info("{#{cmd}} failed to generate tags for #{fnames} into #{tagf}")
           end
         end
       end
@@ -60,7 +60,7 @@ module Tagrity
         end
         tmpf.rewind
         FileUtils.mv(tmpf.path, tagf, force: true)
-        logger.info("Deleted tags for #{files} from #{tagf}")
+        @logger.info("Deleted tags for #{files} from #{tagf}")
       end
     end
 
@@ -71,7 +71,7 @@ module Tagrity
     end
 
     def indexable?(file)
-      file != tagf && !is_file_excluded(file) && File.readable?(file)
+      file != tagf && !file_excluded?(file) && File.readable?(file)
     end
 
     def copacetic_with_git?(file)
@@ -87,27 +87,15 @@ module Tagrity
     end
 
     def check_git?
-      @config.respect_git? && Helper.is_git_dir?
+      @check_git ||= @config.respect_git? && Helper.git_dir?
     end
 
-    def is_file_excluded(fname)
+    def file_excluded?(fname)
       @config.ignore_extension?(fname.partition('.').last) || @config.path_ignored?(fname)
     end
 
-    def assert_executables
-      %w(cat grep mv).each do |exe|
-        if !Helper.is_executable?(exe)
-          raise ExecutableNonExist, "tagrity depends on the executable #{exe}"
-        end
-      end
-    end
-
     def tagf
       @config.tagf
     end
-
-    def logger
-      Tlogger.instance
-    end
   end
 end

data/lib/tagrity/version.rb

@@ -1,3 +1,3 @@
 module Tagrity
-  VERSION = "0.1.12"
+  VERSION = "0.2.0"
 end

data/sample_config.yml

@@ -1,7 +1,8 @@
 # which command to use to generate tags for a specific file extension
 # overrides default_command
 # commands must support --append, -f, -L
-# DEFAULT: empty
+#
+# Default: empty
 extension_commands:
   rb: ripper-tags
   c: ctags
@@ -9,21 +10,25 @@ extension_commands:
 
 # default command to generate tags
 # command must support --append, -f, -L
-# DEFAULT: ctags
+#
+# Default: ctags
 default_command: ctags
 
 # filename (relative to pwd) to generate tags into
-# DEFAULT: tags
+#
+# Default: tags
 tagf: tags
 
 # list of extensions to exclusively generate tags for
 # this will take precendence over extensions_blacklist if it is non-empty
-# DEFAULT: []
+#
+# Default: []
 extensions_whitelist: [rb, c, h, js]
 
 # list of extensions to not generate tags for
 # this can will be ignored if extensions_whitelist is non-empty
-# DEFAULT: []
+#
+# Default: []
 extensions_blacklist: [erb, html, txt]
 
 # how to integrate with git
@@ -32,11 +37,12 @@ extensions_blacklist: [erb, html, txt]
 # IGNORED: don't index files which are ignored by git
 # NA: don't use git, index all files under pwd
 #
-# DEFAULT: TRACKED
+# 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: []
+#
+# Default: []
 excluded_paths: [vendor, node_modules]

data/test_files/.gitignore

@@ -0,0 +1 @@
+foobar.rb

data/test_files/.tagrity_config.yml

@@ -0,0 +1,37 @@
+# which command to use to generate tags for a specific file extension
+# overrides default_command
+# DEFAULT: empty
+extension_commands:
+  rb: ripper-tags
+
+# default command to generate tags
+# DEFAULT: ctags
+default_command: ctags
+
+# filename (relative to pwd) to generate tags into
+# DEFAULT: tags
+tagf: tags
+
+# list of extensions to exclusively generate tags for
+# this will take precendence over extensions_blacklist if it is non-empty
+# DEFAULT: []
+extensions_whitelist: [rb, c, vim]
+
+# 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: IGNORED
+
+# 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]

data/test_files/barbaz.c

@@ -0,0 +1,7 @@
+int barbaz_one() {
+  return 0;
+}
+
+int barbaz_two() {
+  return 0;
+}

data/test_files/expected_after_delete

@@ -0,0 +1,6 @@
+barbaz_fun_one	foo/barbaz.rb	/^def barbaz_fun_one$/;"	f	class:Object
+barbaz_fun_two	foo/barbaz.rb	/^def barbaz_fun_two$/;"	f	class:Object
+barbaz_one	barbaz.c	/^int barbaz_one() {$/;"	f	typeref:typename:int
+barbaz_two	barbaz.c	/^int barbaz_two() {$/;"	f	typeref:typename:int
+foobar_fun_one	foo/foobar.rb	/^def foobar_fun_one$/;"	f	class:Object
+foobar_fun_two	foo/foobar.rb	/^def foobar_fun_two$/;"	f	class:Object

data/test_files/expected_genall_git_tags

@@ -0,0 +1,6 @@
+barbaz_fun_one	foo/barbaz.rb	/^def barbaz_fun_one$/;"	f	class:Object
+barbaz_fun_two	foo/barbaz.rb	/^def barbaz_fun_two$/;"	f	class:Object
+barbaz_one	barbaz.c	/^int barbaz_one() {$/;"	f	typeref:typename:int
+barbaz_one	foo/foobar.c	/^int barbaz_one() {$/;"	f	typeref:typename:int
+barbaz_two	barbaz.c	/^int barbaz_two() {$/;"	f	typeref:typename:int
+barbaz_two	foo/foobar.c	/^int barbaz_two() {$/;"	f	typeref:typename:int

data/test_files/expected_genall_nongit_tags

@@ -0,0 +1,10 @@
+barbaz_fun_one	foo/barbaz.rb	/^def barbaz_fun_one$/;"	f	class:Object
+barbaz_fun_two	foo/barbaz.rb	/^def barbaz_fun_two$/;"	f	class:Object
+barbaz_one	barbaz.c	/^int barbaz_one() {$/;"	f	typeref:typename:int
+barbaz_one	foo/foobar.c	/^int barbaz_one() {$/;"	f	typeref:typename:int
+barbaz_two	barbaz.c	/^int barbaz_two() {$/;"	f	typeref:typename:int
+barbaz_two	foo/foobar.c	/^int barbaz_two() {$/;"	f	typeref:typename:int
+foobar_fun_one	foo/foobar.rb	/^def foobar_fun_one$/;"	f	class:Object
+foobar_fun_one	foobar.rb	/^def foobar_fun_one$/;"	f	class:Object
+foobar_fun_two	foo/foobar.rb	/^def foobar_fun_two$/;"	f	class:Object
+foobar_fun_two	foobar.rb	/^def foobar_fun_two$/;"	f	class:Object

data/test_files/foo/barbaz.rb

@@ -0,0 +1,5 @@
+def barbaz_fun_one
+end
+
+def barbaz_fun_two
+end

data/test_files/foo/foobar.c

@@ -0,0 +1,7 @@
+int barbaz_one() {
+  return 0;
+}
+
+int barbaz_two() {
+  return 0;
+}

data/test_files/foo/foobar.rb

@@ -0,0 +1,5 @@
+def foobar_fun_one
+end
+
+def foobar_fun_two
+end

data/test_files/foobar.rb

@@ -0,0 +1,5 @@
+def foobar_fun_one
+end
+
+def foobar_fun_two
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tagrity
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.2.0
 platform: ruby
 authors:
 - Adam P. Regasz-Rethy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-25 00:00:00.000000000 Z
+date: 2020-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -132,6 +132,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".tagrity_config.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -157,6 +158,16 @@ files:
 - lib/tagrity/version.rb
 - sample_config.yml
 - tagrity.gemspec
+- test_files/.gitignore
+- test_files/.tagrity_config.yml
+- test_files/barbaz.c
+- test_files/expected_after_delete
+- test_files/expected_genall_git_tags
+- test_files/expected_genall_nongit_tags
+- test_files/foo/barbaz.rb
+- test_files/foo/foobar.c
+- test_files/foo/foobar.rb
+- test_files/foobar.rb
 homepage: https://github.com/RRethy/tagrity
 licenses:
 - MIT