tagrity 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcfed080b9e287731b704e80488adac996f1c4fa1b8157eb0e0836267eaed3c0
-  data.tar.gz: a0f2b636f77d14d419efc7b6e899b1c34b9e0ef3e9ed582bfc705e8e1270b84c
+  metadata.gz: 38dc3f96b14b1ef629c339a71faf41d448b7ca5281dd9d4e69ea4a2dcf167662
+  data.tar.gz: 731c6fb5f54d8c9ca850f2ee6a38018f6a1765b1663334b52ba2ad0f9929c686
 SHA512:
-  metadata.gz: 5a97461685ed84ae3c4488ad93469079cee4b24e778222d4d2ea6db47945fe52d10c0665bccd89de431468dffee0aaf6bab776da40710362943e05b876666683
-  data.tar.gz: 48a82ca820c24f146dec57e888d9621a595e8fd89bd0d76ca4233eab2a54d2b517547192cf1ae5f712e4c8b828a32f46780a6d371c06612e34f263b096ed2016
+  metadata.gz: e228435fd32b23cb6d36b184889a82a170abc8422870d4321d36d5e2a17e89a108804ca4f83613ae41ad2e71091dae20a3e59652af5d715fa1f761055f6e1f6b
+  data.tar.gz: db4f8487a44f71e366bfa83e6308ab712236ea038348a08ca6302904ab6d8cf1b09b61eb0dcc96aa233b8f964f07b41985af27043756d2001e3d697b19dfdbb6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tagrity (0.1.0)
+    tagrity (0.1.2)
       listen (~> 3.0)
       thor (~> 0.20)
 
@@ -17,6 +17,7 @@ GEM
     rb-fsevent (0.10.3)
     rb-inotify (0.10.0)
       ffi (~> 1.0)
+    ripper-tags (0.8.0)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -38,6 +39,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.0)
   rake (~> 10.0)
+  ripper-tags (~> 0.8.0)
   rspec (~> 3.0)
   tagrity!
 

data/README.md

@@ -1,8 +1,6 @@
 # Tagrity
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tagrity`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Automatically regenerate tags on file changes.
 
 ## Installation
 
@@ -22,7 +20,52 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```
+Commands:
+  tagrity help [COMMAND]  # Describe available commands or one specific command
+  tagrity start           # Start watching a directory (default to pwd)
+  tagrity status          # List running tagrity processes and the directories being watched
+  tagrity stop            # Stop watching a directory (default to pwd)
+```
+
+### start
+
+```
+Usage:
+  tagrity start
+
+Options:
+  [--dir=DIR]
+  [--fg], [--no-fg]
+  [--configfile=CONFIGFILE]
+  [--tagf=TAGF]
+  [--default-cmd=DEFAULT_CMD]
+  [--excluded-exts=one two three]
+  [--excluded-paths=one two three]
+
+Start watching a directory (default to pwd)
+```
+
+### stop
+
+```
+Usage:
+  tagrity stop
+
+Options:
+  [--dir=DIR]
+
+Stop watching a directory (default to pwd)
+```
+
+### status
+
+```
+Usage:
+  tagrity status
+
+List running tagrity processes and the directories being watched
+```
 
 ## Development
 

data/lib/tagrity/cli.rb

@@ -1,32 +1,30 @@
 require 'thor'
 require 'tagrity/commands/start'
 require 'tagrity/commands/stop'
-require 'tagrity/commands/restart'
 require 'tagrity/commands/status'
 
 module Tagrity
   class CLI < Thor
-    desc "start", "Start watching pwd or DIR"
+    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
     def start()
+      setup_config
       Command::Start::call(dir, fg?)
     end
 
-    desc "stop", "Stop watching pwd or DIR"
+    desc "stop", "Stop watching a directory (default to pwd)"
     option :dir
     def stop()
       Command::Stop::call(dir)
     end
 
-    desc "restart", "Stop watching pwd or DIR. Start watching pwd or DIR again"
-    option :dir
-    option :fg, type: :boolean
-    def restart()
-      Command::Restart::call(dir, fg?)
-    end
-
-    desc "status", "status running tagrity processes watching directories"
+    desc "status", "List running tagrity processes and the directories being watched"
     def status
       Command::Status::call
     end
@@ -42,5 +40,15 @@ module Tagrity
     def fg?
       options[:fg]
     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]
+      )
+    end
   end
 end

data/lib/tagrity/commands/start.rb

@@ -2,6 +2,7 @@ require 'listen'
 require 'tagrity/pid_file'
 require 'tagrity/process_helper'
 require 'tagrity/file_callbacks'
+require 'tagrity/provider'
 
 module Tagrity
   module Command
@@ -12,22 +13,19 @@ module Tagrity
         def call(dir, fg)
           assert_not_running(dir)
 
-          callbacks = FileCallbacks.new
+          Process.daemon(nochdir: true) unless fg
 
-          Process.daemon unless fg
+          callbacks = Provider.provide(:file_callbacks)
           PidFile.write(PidFile.new(dir, Process.pid))
 
           listener = Listen.to(
             dir,
-            ignore: [/tags/],
+            ignore: [/^\.?tags$/],
             relative: true,
           ) do |modified, added, removed|
             callbacks.on_files_modified(modified)
             callbacks.on_files_added(added)
             callbacks.on_files_removed(removed)
-            puts "modified absolute paths: #{modified}"
-            puts "added absolute paths: #{added}"
-            puts "removed absolute paths: #{removed}"
           end
           listener.start
           sleep

data/lib/tagrity/config_file.rb

@@ -1,7 +1,96 @@
+require 'yaml'
+require 'singleton'
+require 'tagrity/executable_helper'
+
 module Tagrity
   class ConfigFile
-    def initialize(opts = {})
+    include Singleton
+
+    class ErrorTagFileNotWritable < StandardError; end
+
+    def init(
+      configfile:,
+      default_cmd:,
+      tagf:,
+      excluded_exts:,
+      excluded_paths:
+    )
+      fname = config_file_name(configfile)
+      @config = if fname.nil? then {} else YAML.load_file(fname) end
+      ensure_ext_cmds
+      ensure_default_cmd(default_cmd)
+      ensure_tagf(tagf)
+      ensure_excluded_exts(excluded_exts)
+      ensure_excluded_paths(excluded_paths)
+    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)
+      ft_cmd
+    end
+
+    def is_ft_excluded(ext)
+      @config['excluded_exts'].include?(ext)
+    end
+
+    def is_path_excluded(path)
+      @config['excluded_paths'].any? { |pat| /^(\.\/)?#{pat}.*/ =~ path }
+    end
+
+    def tagf
+      @config['tagf']
+    end
+
+    def to_s
+      @config.to_s
+    end
+
+    private
+
+    def ensure_ext_cmds
+      set_option('ext_cmds', nil, {})
+    end
+
+    def ensure_default_cmd(default_cmd)
+      set_option('default_cmd', default_cmd, 'ctags')
+    end
+
+    def ensure_excluded_exts(excluded_exts)
+      set_option('excluded_exts', excluded_exts, [])
+    end
+
+    def ensure_excluded_paths(excluded_paths)
+      set_option('excluded_paths', excluded_paths, [])
+    end
+
+    def ensure_tagf(tagf)
+      set_option('tagf', tagf, 'tags')
+      unless File.writable?(@config['tagf'])
+        raise ErrorTagFileNotWritable, "#{@config['tagf']} must be writable to be used as the tag file."
+      end
+    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
+    end
+
+    def config_file_name(fname)
+      return fname unless fname.nil?
+      return global_config_file_name if File.file?(global_config_file_name)
+      nil
+    end
+
+    def global_config_file_name
+      "#{global_config_dir_name}/config.yml"
+    end
 
+    def global_config_dir_name
+      "#{ENV["HOME"]}/.config/tagrity"
     end
   end
 end

data/lib/tagrity/executable_helper.rb

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

data/lib/tagrity/file_callbacks.rb

@@ -1,9 +1,10 @@
 require 'tagrity/tag_generator'
+require 'tagrity/config_file'
 
 module Tagrity
   class FileCallbacks
-    def initialize
-      @tag_generator = TagGenerator.new
+    def initialize(tag_generator)
+      @tag_generator = tag_generator
     end
 
     def on_files_modified(files)

data/lib/tagrity/provider.rb

@@ -0,0 +1,26 @@
+require 'tagrity/file_callbacks'
+require 'tagrity/config_file'
+require 'tagrity/tag_generator'
+
+module Tagrity
+  class Provider
+    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
+    end
+  end
+end

data/lib/tagrity/tag_generator.rb

@@ -1,33 +1,52 @@
+require 'tagrity/executable_helper'
+
 module Tagrity
   class TagGenerator
     class ExecutableNonExist < StandardError; end
 
     def initialize
       assert_executables
-    end
-
-    def generate_all
+      @config = ConfigFile.instance
     end
 
     def generate(files)
       return if files.empty?
-      `ctags -f tags --append #{files.join(' ')}`
+      files
+        .select { |file| !dont_index_file(file) && File.readable?(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}"
+        end
+      end
     end
 
     def delete_files_tags(files)
       return if files.empty?
-      `cat tags | grep -v -F #{files.map { |f| " -e \"#{f}\""}.join(' ')} > .tags`
-      `mv .tags tags`
+      `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}"
     end
 
     private
 
+    def dont_index_file(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 %x{command -v #{exe}}.empty?
+        if !ExecutableHelper.is_executable(exe)
           raise ExecutableNonExist, "tagrity depends on the executable #{exe}"
         end
       end
     end
+
+    def tagf
+      @config.tagf
+    end
   end
 end

data/lib/tagrity/version.rb

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

data/tagrity.gemspec

@@ -32,4 +32,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "ripper-tags", "~> 0.8.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tagrity
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Adam P. Regasz-Rethy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-05 00:00:00.000000000 Z
+date: 2019-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: ripper-tags
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 description: Ditto
 email:
 - rethy.spud@gmail.com
@@ -102,14 +116,15 @@ files:
 - exe/tagrity
 - lib/tagrity.rb
 - lib/tagrity/cli.rb
-- lib/tagrity/commands/restart.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/pid_file.rb
 - lib/tagrity/process_helper.rb
+- lib/tagrity/provider.rb
 - lib/tagrity/tag_generator.rb
 - lib/tagrity/version.rb
 - tagrity.gemspec
@@ -135,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Regenerate tags on file changes.

data/lib/tagrity/commands/restart.rb

@@ -1,12 +0,0 @@
-module Tagrity
-  module Command
-    class Restart
-      class << self
-        def call(dir, fg)
-          Command::Stop.call(dir)
-          Command::Start.call(dir, fg)
-        end
-      end
-    end
-  end
-end