tagrity 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2253313b7cf87be67d74b7fb7aaf4aac4f8150a22c0948bde3991d034cbd1840
+  data.tar.gz: 6061998ec7aca60553ada4dea8841291ea925dbf8d7a5d728a085a4b4ec5520b
+SHA512:
+  metadata.gz: c0ef31e1842dc7c257b3ac34eb1586064471073c84bbf3fda31533e965f90d2aa8617b5ce707e4cd8fddc938d61190789f338530cd5450d2bebfbc2de69f76c7
+  data.tar.gz: 3300fd5df494335d992d9152059c6254957fa58c34e89bd6cb82ba476cf6b42582492cf9fd39930925f3e0f6bfbb8139205b58fe96e9fa9694963cbddd76ba09

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/var/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at rethy.spud@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in tagrity.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    tagrity (0.1.0)
+      listen (~> 3.0)
+      thor (~> 0.20)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    ffi (1.11.1)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    ruby_dep (1.5.0)
+    thor (0.20.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  tagrity!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Adam P. Regasz-Rethy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# 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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tagrity'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tagrity
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tagrity. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 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).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tagrity"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/tagrity

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "tagrity/cli"
+Tagrity::CLI.start(ARGV)

data/lib/tagrity/cli.rb

@@ -0,0 +1,46 @@
+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"
+    option :dir
+    option :fg, type: :boolean
+    def start()
+      Command::Start::call(dir, fg?)
+    end
+
+    desc "stop", "Stop watching pwd or DIR"
+    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"
+    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
+  end
+end

data/lib/tagrity/commands/restart.rb

@@ -0,0 +1,12 @@
+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

data/lib/tagrity/commands/start.rb

@@ -0,0 +1,52 @@
+require 'listen'
+require 'tagrity/pid_file'
+require 'tagrity/process_helper'
+require 'tagrity/file_callbacks'
+
+module Tagrity
+  module Command
+    class Start
+      class ErrorProcessAlreadyRunning < StandardError; end
+
+      class << self
+        def call(dir, fg)
+          assert_not_running(dir)
+
+          callbacks = FileCallbacks.new
+
+          Process.daemon unless fg
+          PidFile.write(PidFile.new(dir, Process.pid))
+
+          listener = Listen.to(
+            dir,
+            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
+        rescue ErrorProcessAlreadyRunning => e
+          puts e.message
+        rescue Interrupt => e
+          PidFile.delete(dir)
+        end
+
+        private
+
+        def assert_not_running(dir)
+          running_processes = PidFile.alive_pid_files(dir: dir)
+          unless running_processes.empty?
+            pids = running_processes.map { |pid_file| pid_file.pid }
+            raise ErrorProcessAlreadyRunning, "Error: tagrity is already watching #{dir} with process #{pids}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tagrity/commands/status.rb

@@ -0,0 +1,13 @@
+module Tagrity
+  module Command
+    class Status
+      class << self
+        def call
+          PidFile.alive_pid_files.each do |pid_file|
+            puts "#{pid_file.pid} #{pid_file.dir}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tagrity/commands/stop.rb

@@ -0,0 +1,19 @@
+module Tagrity
+  module Command
+    class Stop
+      class << self
+        def call(dir)
+          pid_files = PidFile.alive_pid_files(dir: dir)
+          if pid_files.empty?
+            puts "😕 tagrity doesn't seem to be watching #{dir}"
+          else
+            pid_files.each do |pid_file|
+              pid_file.delete
+              puts "Successfully killed #{pid_file.pid}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tagrity/config_file.rb

@@ -0,0 +1,7 @@
+module Tagrity
+  class ConfigFile
+    def initialize(opts = {})
+
+    end
+  end
+end

data/lib/tagrity/file_callbacks.rb

@@ -0,0 +1,21 @@
+require 'tagrity/tag_generator'
+
+module Tagrity
+  class FileCallbacks
+    def initialize
+      @tag_generator = TagGenerator.new
+    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

data/lib/tagrity/pid_file.rb

@@ -0,0 +1,88 @@
+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)
+      end
+
+      def delete(dir)
+        pid_file_paths = Dir.glob("#{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))
+        end
+      end
+
+      def alive_pid_files(dir: nil)
+        Dir.glob("#{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)
+              pid_files << PidFile.new(pid_file_dir, pid)
+            else
+              File.delete(path)
+            end
+          end
+
+          pid_files
+        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
+    end
+
+    attr_reader :pid, :dir
+
+    def initialize(dir, pid)
+      @dir = dir
+      @pid = pid
+    end
+
+    def ==(other)
+      @dir == other.dir
+      @pid == other.pid
+    end
+
+    def name
+      "#{@dir.split('/').last}.#{@pid}.pid"
+    end
+
+    def delete
+      File.delete(pid_file_path)
+      ProcessHelper.kill(pid.to_i)
+    end
+
+    private
+
+    def pid_file_path
+      "#{PidFile.run_dir}/#{name}"
+    end
+  end
+end

data/lib/tagrity/process_helper.rb

@@ -0,0 +1,18 @@
+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

data/lib/tagrity/tag_generator.rb

@@ -0,0 +1,33 @@
+module Tagrity
+  class TagGenerator
+    class ExecutableNonExist < StandardError; end
+
+    def initialize
+      assert_executables
+    end
+
+    def generate_all
+    end
+
+    def generate(files)
+      return if files.empty?
+      `ctags -f tags --append #{files.join(' ')}`
+    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`
+    end
+
+    private
+
+    def assert_executables
+      %w(cat grep mv).each do |exe|
+        if %x{command -v #{exe}}.empty?
+          raise ExecutableNonExist, "tagrity depends on the executable #{exe}"
+        end
+      end
+    end
+  end
+end

data/lib/tagrity/version.rb

@@ -0,0 +1,3 @@
+module Tagrity
+  VERSION = "0.1.0"
+end

data/lib/tagrity.rb

@@ -0,0 +1,2 @@
+module Tagrity
+end

data/tagrity.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "tagrity/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "tagrity"
+  spec.version       = Tagrity::VERSION
+  spec.authors       = ["Adam P. Regasz-Rethy"]
+  spec.email         = ["rethy.spud@gmail.com"]
+
+  spec.summary       = %q{Regenerate tags on file changes.}
+  spec.description   = %q{Ditto}
+  spec.homepage      = "https://github.com/RRethy/tagrity"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/RRethy/tagrity"
+  spec.metadata["changelog_uri"] = "https://github.com/RRethy/tagrity/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'thor', '~> 0.20'
+  spec.add_dependency 'listen', '~> 3.0'
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: tagrity
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam P. Regasz-Rethy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ditto
+email:
+- rethy.spud@gmail.com
+executables:
+- tagrity
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- 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/file_callbacks.rb
+- lib/tagrity/pid_file.rb
+- lib/tagrity/process_helper.rb
+- lib/tagrity/tag_generator.rb
+- lib/tagrity/version.rb
+- tagrity.gemspec
+homepage: https://github.com/RRethy/tagrity
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/RRethy/tagrity
+  source_code_uri: https://github.com/RRethy/tagrity
+  changelog_uri: https://github.com/RRethy/tagrity/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Regenerate tags on file changes.
+test_files: []