guard-symlink 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ea5457f511c559688612b1034b2399005a2240b
+  data.tar.gz: c226047ebc4e6bd9a4ecbf797fca3fca3d74b842
+SHA512:
+  metadata.gz: fd91baae1dd834fcca5d7ff4580e6634b47a3d011f037b18f7baadbf4d4411159d93f9d6f8bb51e6595c4c645b89a80d86f429ee43deb3fd9d93e33f06fc9dae
+  data.tar.gz: 4f39727426d0904aab129120f29778e4508180d720972ac36e07619488404f007f46a951ab47a984eda8271b4facf22e4101e8c5970adff7b10885d3dfe6f661

data/lib/guard/symlink/bugfix.rb

@@ -0,0 +1,40 @@
+# https://github.com/guard/listen/issues/426
+require 'listen'
+require 'listen/record'
+
+module Listen
+  class Record
+    def dir_entries(rel_path)
+      subtree =
+        if [nil, '', '.'].include? rel_path.to_s
+          tree
+        else
+          sub_dir_entries(rel_path)
+        end
+
+      result = {}
+      subtree.each do |key, values|
+        # only get data for file entries
+        result[key] = values.key?(:mtime) ? values : {}
+      end
+      result
+    end
+
+    private
+
+    def sub_dir_entries(rel_path)
+      result = {}
+      tree.each do |path, meta|
+        next unless path.start_with?(rel_path)
+
+        if path == rel_path
+          result.merge!(meta)
+        else
+          sub_path = path.sub(%r{\A#{rel_path}/?}, '')
+          result[sub_path] = meta
+        end
+      end
+      result
+    end
+  end
+end

data/lib/guard/symlink/pry.rb

@@ -0,0 +1,24 @@
+require 'guard/jobs/pry_wrapper'
+
+Pry::Commands.create_command 'unlink_all' do
+  group 'Guard'
+  description 'Unlink all symlinks of watched directories.'
+
+  banner <<-BANNER
+  Usage: unlink_all <scope>
+  Run the Guard plugin `unlink_all` action.
+  You may want to specify an optional scope to the action,
+  either the name of a Guard plugin or a plugin group.
+  BANNER
+
+  def process(*entries)
+    scopes, unknown = ::Guard.state.session.convert_scope(entries)
+
+    unless unknown.empty?
+      output.puts "Unknown scopes: #{unknown.join(', ')}"
+      return
+    end
+
+    ::Guard::Runner.new.run(:unlink_all, scopes)
+  end
+end

data/lib/guard/symlink/templates/Guardfile

@@ -0,0 +1,3 @@
+guard :symlink, ignore: [] do
+  watch(/.*/)
+end

data/lib/guard/symlink/version.rb

@@ -0,0 +1,7 @@
+require 'guard/compat/plugin'
+
+module Guard
+  class Symlink < Guard::Plugin
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/guard/symlink.rb

@@ -0,0 +1,189 @@
+require 'guard/compat/plugin'
+require 'guard/symlink/version'
+require 'guard/symlink/bugfix'
+require 'guard/symlink/pry'
+
+module Guard
+  class Symlink < Guard::Plugin
+    def initialize(options = {})
+      opts    = options.dup
+      @ignore = opts.delete(:ignore)
+      super(opts)
+    end
+
+    # Called once when Guard starts. Please override initialize method to init stuff.
+    #
+    # @raise [:task_has_failed] when start has failed
+    # @return [Object] the task result
+    #
+    def start
+      watchdirs.each do |directory|
+        files = package_files(directory)
+        link(files)
+      end
+    end
+
+    # Called on file(s) additions that the Guard plugin watches.
+    #
+    # @param [Array<String>] paths the changes files or paths
+    # @raise [:task_has_failed] when run_on_additions has failed
+    # @return [Object] the task result
+    #
+    def run_on_additions(paths)
+      link(paths)
+    end
+
+    # Called on file(s) removals that the Guard plugin watches.
+    #
+    # @param [Array<String>] paths the changes files or paths
+    # @raise [:task_has_failed] when run_on_removals has failed
+    # @return [Object] the task result
+    #
+    def run_on_removals(paths)
+      unlink(paths)
+    end
+
+    def unlink_all
+      watchdirs.each do |directory|
+        files = package_files(directory)
+        unlink(files)
+      end
+    end
+
+    def link(paths)
+      paths.each do |entry|
+        source_path       = ::File.expand_path(entry)
+        relative_sub_path = relative_sub_path(source_path)
+
+        next if @ignore.include?(relative_sub_path)
+
+        target_path       = "#{::Dir.pwd}/#{relative_sub_path}"
+        target_directory  = ::File.dirname(target_path)
+        ensure_directory(target_directory)
+
+        next if link_exists?(source_path, target_path)
+        backup(target_path)
+
+        create_symlink(source_path, target_path)
+      end
+    end
+
+    def unlink(paths)
+      target_folders = []
+      paths.each do |entry|
+        source_path       = ::File.expand_path(entry)
+        relative_sub_path = relative_sub_path(source_path)
+        target_path       = "#{::Dir.pwd}/#{relative_sub_path}"
+
+        next unless link_exists?(source_path, target_path)
+        next unless file_removed?(target_path)
+
+        target_directory = ::File.dirname(target_path)
+        next if target_folders.include?(target_directory)
+        target_folders.push(target_directory)
+      end
+
+      remove_empty(target_folders)
+    end
+
+    private
+
+    def remove_empty(directories)
+      return if directories.empty?
+
+      parent_directories = []
+      directories.uniq.each do |directory|
+        next unless ::File.directory?(directory)
+        next unless directory_empty?(directory)
+        ::Dir.rmdir(directory)
+        ::Guard::Compat::UI.info "Removed empty directory #{directory}"
+
+        parent_directory = ::File.dirname(directory)
+
+        next if parent_directories.include?(parent_directory)
+        parent_directories.push(parent_directory)
+      end
+      remove_empty(parent_directories)
+    end
+
+    def file_removed?(path)
+      return true if backup_restored?(path)
+      ::File.delete(path)
+      # p caller
+      ::Guard::Compat::UI.info "Removed link #{path}"
+      true
+    end
+
+    def package_files(directory)
+      ::Dir.glob(directory + '/**/*').reject { |fn| ::File.directory?(fn) }
+    end
+
+    def relative_sub_path(path_org)
+      path = path_org.dup
+      watchdirs.each do |directory|
+        directory += '/'
+        next unless path.start_with?(directory)
+        path.slice!(directory)
+        break
+      end
+      path
+    end
+
+    def directory_empty?(directory)
+      (::Dir.entries(directory) - %w(. ..)).empty?
+    end
+
+    def ensure_directory(dir)
+      return if ::File.directory?(dir)
+      ::FileUtils.mkdir_p(dir)
+    end
+
+    def create_symlink(source, target)
+      if link_exists?(source, target)
+        ::File.delete(target)
+        return false
+      end
+      ::File.symlink(source, target)
+      ::Guard::Compat::UI.info "Created symlink #{source} -> #{target}"
+    end
+
+    def link_exists?(source, target)
+      return false unless ::File.symlink?(target)
+      ::File.readlink(target) == source
+    end
+
+    def backup(path)
+      return unless ::File.file?(path)
+
+      backup_file = backup_name(path)
+
+      if ::File.exist?(backup_file)
+        raise "Can't link #{path}, destination and #{backup_suffix} already exist!"
+      end
+
+      ::File.rename(path, backup_file)
+      ::Guard::Compat::UI.info "Created backup #{path} -> #{backup_file}"
+    end
+
+    def backup_restored?(path)
+      backup_file = backup_name(path)
+      return false unless ::File.exist?(backup_file)
+      ::File.delete(path)
+      ::File.rename(backup_file, path)
+      ::Guard::Compat::UI.info "Removed link by restoring backup #{backup_file} -> #{path}"
+      true
+    end
+
+    def backup_name(path)
+      "#{path}#{backup_suffix}"
+    end
+
+    def backup_suffix
+      '.link_backup'
+    end
+
+    def watchdirs
+      @watchdirs ||= ::Guard.state.session.watchdirs
+    end
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: guard-symlink
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thorsten Eckel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-compat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: Guard to symlink a watched folder recursivly into the current.
+email:
+- te@znuny.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/guard/symlink.rb
+- lib/guard/symlink/bugfix.rb
+- lib/guard/symlink/pry.rb
+- lib/guard/symlink/templates/Guardfile
+- lib/guard/symlink/version.rb
+homepage: https://github.com/thorsteneckel/guard-symlink
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Guard to symlink a watched folder recursivly into the current.
+test_files: []