guard-git 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3dc0c3f3652cb23728f23322b379ff06b3127ef5
+  data.tar.gz: 5bebdf6476fc16d384fd3a74095ab40a6e002029
+SHA512:
+  metadata.gz: b537965d8cc47c7e31d86d338db6d085f15390b5659e3218c5b19ef4af0a046120b0b357e4b79186d53f9625728c3f6317cf1cac47ed14dd2719b57b7cfb47c7
+  data.tar.gz: ef88243bde5d8d0256c2eda77a5e561c2f60d0f78d224bf2f994383cfe5b629e9620f70e103f617e56cba871d27bb15609a04e48567ff07c5bc246f50e12c2ee

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  NewCops: enable
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in guard-git.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,98 @@
+PATH
+  remote: .
+  specs:
+    guard-git (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    ffi (1.13.1)
+    formatador (0.2.5)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    guard-rubocop (1.3.0)
+      guard (~> 2.0)
+      rubocop (~> 0.20)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.7)
+    method_source (1.0.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rb-readline (0.5.5)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.89.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
+    ruby-progressbar (1.10.1)
+    shellany (0.0.1)
+    thor (1.0.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  guard (~> 2.16)
+  guard-git!
+  guard-rspec (~> 4.7)
+  guard-rubocop (~> 1.3)
+  rake (~> 10.0)
+  rb-readline (~> 0.5)
+  rspec (~> 3.0)
+  rubocop (~> 0.89.0)
+
+BUNDLED WITH
+   1.16.2

data/Guardfile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+ignore(%r{.*test_project/.*})
+
+group :red_green_refactor, halt_on_fail: true do
+  guard :rspec, cmd: 'bundle exec rspec' do
+    require 'guard/rspec/dsl'
+    dsl = Guard::RSpec::Dsl.new(self)
+
+    # RSpec files
+    rspec = dsl.rspec
+    watch(rspec.spec_helper) { rspec.spec_dir }
+    watch(rspec.spec_support) { rspec.spec_dir }
+    watch(rspec.spec_files)
+
+    # lib files
+    watch(%r{^lib/(.*)\.rb$}) { |m| "#{rspec.spec_dir}/#{m}_spec.rb" }
+    watch(%r{^lib/.*\.rb$}) { 'spec/guard/git_integration_spec.rb' }
+  end
+
+  guard :rubocop, cli: ['--auto-correct'] do
+    watch(/.+\.rb$/)
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Daniel Patterson
+
+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,117 @@
+# Guard::Git
+
+Stops [Guard](https://github.com/guard/guard/) triggering plugins whenever
+you change branches.
+
+## Installation
+
+**NOTE:** This has not yet been released, so cannot be installed without
+cloning this repo.
+
+~Add this line to your application's Gemfile:~
+
+```ruby
+gem 'guard-git'
+```
+
+~And then execute:~
+
+    $ bundle
+
+~Or install it yourself as:~
+
+    $ gem install guard-git
+
+## Usage
+
+There are two ways to use this gem:
+
+### Make all `watch` calls git aware
+
+This is the simplest way to get started and the default way to use this gem.
+
+Add the following to the top of your `Guardfile`:
+
+```ruby
+require `guard/git`
+
+Guard::Git.enable!
+```
+
+All of the calls to `watch` will now only be triggered if the file changes on
+disk and one of the follwing is true:
+
+- The file has changed since `HEAD`
+- The file is untracked
+- The file is gitignored
+
+### Explicitly use the git matcher
+
+If you only want to use git-aware matchers for a subset of `watch` calls or
+you'd prefer not to monkeypatch Guard, you can use the
+`Guard::Git::ChangedFilesMatcher` instead.
+
+For example, if you had the follwing `Guardfile`:
+
+```ruby
+guard :shell do
+  watch(/.*/) do
+    # do something
+  end
+end
+```
+
+you can make that single `watch` git-aware by changing the file to:
+
+```ruby
+require `guard/git`
+
+guard :shell do
+  watch(Guard::Git::ChangedFilesMatcher.new(/.*/)) do
+    # do something
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+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`.
+
+### Testing
+
+To properly end-to-end test this gem it's necessary to have a process running
+`guard` to verify which file changes cause plugins to be triggered. `guard`
+needs to run in a tty rather than a background process. Therefore, before
+running any specs, run `bin/setup_integration_test` in a terminal to create a
+test guard process.
+
+Once you have the test `guard` process set up, run `bundle exec rake spec`
+to run all the tests once, or `bin/guard` to start a guard process that will
+run relevant tests and linting on any file change.
+
+You may need to restart `bin/setup_integration_test` between some test runs
+during development as the test `guard` process only loads the gem at the start
+rather than before each test (it `require`s the files in
+[the `Guardfile`](test_project/Guardfile)).
+
+### Releasing new versions
+
+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/dp28/guard-git.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/guard-git.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'guard/git/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'guard-git'
+  spec.version       = Guard::Git::VERSION
+  spec.authors       = ['Daniel Patterson']
+  spec.email         = ['apps.djpdev@gmail.com']
+
+  spec.summary       = 'Make Guard git-aware'
+  spec.homepage      = 'https://github.com/dp28/guard-git'
+  spec.license       = 'MIT'
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features|test_project|bin|Rakefile)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.4'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'guard', '~> 2.16'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency 'guard-rubocop', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rb-readline', '~> 0.5'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.89.0'
+end

data/lib/guard/git.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'guard/git/version'
+require 'guard/git/dsl_extensions'
+require 'guard/git/changed_files_matcher'
+
+module Guard
+  module Git
+    def self.enable!
+      ::Guard::Dsl.prepend Guard::Git::DslExtensions
+    end
+  end
+end

data/lib/guard/git/changed_files_matcher.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Guard
+  module Git
+    # Only matches files that both:
+    #
+    # * Match the passed-in pattern AND
+    # * Are either ignored by git or identified as changed
+    class ChangedFilesMatcher
+      def initialize(pattern)
+        @pattern = pattern
+      end
+
+      def match(filename_or_pathname)
+        path = filename_or_pathname.to_s
+        result = @pattern.match(path)
+        return nil if result.nil? || skip_file?(path)
+
+        result
+      end
+
+      private
+
+      def skip_file?(path)
+        !changed?(path) && !always_allowed?(path)
+      end
+
+      def changed?(path)
+        changed_files.include?(path)
+      end
+
+      def always_allowed?(path)
+        ignored_files.include?(path)
+      end
+
+      def ignored_files
+        `git ls-files --others -i --exclude-standard`.lines.map(&:chomp)
+      end
+
+      def changed_files
+        `git status --porcelain`.lines.map do |line|
+          line.chomp.split(' ').last
+        end
+      end
+    end
+  end
+end

data/lib/guard/git/dsl_extensions.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'guard/git/changed_files_matcher'
+
+module Guard
+  module Git
+    module DslExtensions
+      def watch(pattern, &action)
+        super(ChangedFilesMatcher.new(pattern), &action)
+      end
+    end
+  end
+end

data/lib/guard/git/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Guard
+  module Git
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: guard-git
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Patterson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: rb-readline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.89.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.89.0
+description: 
+email:
+- apps.djpdev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- guard-git.gemspec
+- lib/guard/git.rb
+- lib/guard/git/changed_files_matcher.rb
+- lib/guard/git/dsl_extensions.rb
+- lib/guard/git/version.rb
+homepage: https://github.com/dp28/guard-git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Make Guard git-aware
+test_files: []