guard-minitest_cr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a0c7b8029e6e13df4af3720697f56c2ceeecac725a0c5f8c97951232b051fb73
+  data.tar.gz: ab8859e9d537b8012ac8e5ec27bebd8701c335c5dff7d4f5c16627b604cc0377
+SHA512:
+  metadata.gz: 69532eb63bdf3e6860df158e0f5ae29930b1321c14f6b2938d739d0bfaef1d2b1cfcd254e1c3dfc3a1c34ef2e82c2c2cc9cc06dd62fea788da7eebc344beee02
+  data.tar.gz: fa5d1acaaf9b9619c8719879466ca3ea220be3001ad6575e910f444b1bc788c311372c8cf6b54cf49969d7869af96ae2b2e20298d3e1f251a800cf58fca194ec

data/CHANGELOG.md

@@ -0,0 +1 @@
+# Moved to [GitHub releases](https://github.com/felixbuenemann/guard-minitest_cr/releases) page.

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Yann Lugrin, Rémy Coutable
+
+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,122 @@
+# Guard::MinitestCr
+[![Gem Version](https://badge.fury.io/rb/guard-minitest_cr.svg)](http://badge.fury.io/rb/guard-minitest_cr) [![Build Status](https://travis-ci.org/felixbuenemann/guard-minitest_cr.svg?branch=master)](https://travis-ci.org/felixbuenemann/guard-minitest_cr)
+
+Guard::MinitestCr allows to automatically & intelligently launch tests with the Crystal
+[minitest.cr framework](https://github.com/ysbaddaden/minitest.cr) when files are modified.
+
+## Install
+
+Please be sure to have [Guard](http://github.com/guard/guard) installed before you continue.
+
+The simplest way to install Guard::MinitestCr is to use [Bundler](http://gembundler.com/).
+
+Add Guard::MinitestCr to your `Gemfile`:
+
+```ruby
+group :development do
+  gem 'guard-minitest_cr'
+end
+```
+
+and install it by running Bundler:
+
+```bash
+$ bundle
+```
+
+Add guard definition to your Guardfile by running the following command:
+
+```bash
+guard init minitest_cr
+```
+
+## Usage
+
+Please read [Guard usage doc](http://github.com/guard/guard#readme)
+
+## Guardfile
+
+Guard::MinitestCr can be adapated to all kind of projects.
+Please read [guard doc](http://github.com/guard/guard#readme) for more info about the Guardfile DSL.
+
+### Standard Guardfile when using Minitest::Test
+
+```ruby
+guard :minitest_cr do
+  watch(%r{^test/(.+)_test\.cr$})
+  watch(%r{^src/(.+)\.cr$})         { |m| "test/#{m[1]}_test.cr" }
+  watch(%r{^test/test_helper\.cr$}) { Dir.glob("test/**/*_test.cr") }
+end
+```
+
+### Standard Guardfile when using Minitest::Spec
+
+```ruby
+guard :minitest_cr do
+  watch(%r{^spec/(.+)_spec\.cr$})
+  watch(%r{^src/(.+)\.cr$})         { |m| "spec/#{m[1]}_spec.cr" }
+  watch(%r{^spec/spec_helper\.cr$}) { Dir.glob("spec/**/*_spec.cr") }
+end
+```
+
+## Options
+
+### List of available options
+
+```ruby
+all_on_start: false               # run all tests in group on startup, default: true
+all_after_pass: true              # run all tests in group after changed specs pass, default: false
+cli: '--verbose'                  # pass arbitrary Minitest CLI arguments, default: ''
+test_folders: ['tests']           # specify an array of paths that contain test files, default: %w[test spec]
+test_file_patterns: %w[test_*.cr] # specify an array of patterns that test files must match in order to be run, default: %w[*_test.cr test_*.cr *_spec.cr]
+test_helpers: ['test_helper.cr']  # specify an array of test helpers that should be excluded from test files, default: %w[test_helper.cr spec_helper.cr]
+env: {}                           # specify some environment variables to be set when the test command is invoked, default: {}
+all_env: {}                       # specify additional environment variables to be set when all tests are being run, default: false
+```
+
+### Options usage examples
+
+#### `:test_folders` and `:test_file_patterns`
+
+You can change the default location of test files using the `:test_folders` option and change the pattern of test files using the `:test_file_patterns` option:
+
+```ruby
+guard :minitest_cr, test_folders: 'test/unit', test_file_patterns: '*_test.rb' do
+  # ...
+end
+```
+
+#### `:cli`
+
+You can pass any of the standard MiniTest CLI options using the `:cli` option:
+
+```ruby
+guard :minitest_cr, cli: '--seed 123456 --verbose' do
+  # ...
+end
+```
+
+## Development
+
+* Documentation hosted at [RubyDoc](http://rubydoc.info/github/felixbuenemann/guard-minitest_cr/master/frames).
+* Source hosted at [GitHub](https://github.com/felixbuenemann/guard-minitest_cr).
+
+Pull requests are very welcome! Please try to follow these simple rules if applicable:
+
+* Please create a topic branch for every separate change you make.
+* Make sure your patches are well tested. All specs run by Travis CI must pass.
+* Update the [README](https://github.com/felixbuenemann/guard-minitest_cr/blob/master/README.md).
+* Please **do not change** the version number.
+
+For questions please join us in our [Google group](http://groups.google.com/group/guard-dev) or on
+`#guard` (irc.freenode.net).
+
+## Author
+
+[Felix Bünemann](https://github.com/felixbuenemann)
+
+This is a fork of the [guard-minitest](https://github.com/guard/guard-minitest) gem that was adapted to work with the minitest.cr Crystal Shard.
+
+## Contributors
+
+[https://github.com/felixbuenemann/guard-minitest\_cr/graphs/contributors](https://github.com/felixbuenemann/guard-minitest_cr/graphs/contributors)

data/lib/guard/minitest_cr.rb

@@ -0,0 +1,53 @@
+require 'guard/compat/plugin'
+
+module Guard
+  class MinitestCr < Plugin
+    require 'guard/minitest_cr/runner'
+    require 'guard/minitest_cr/version'
+
+    attr_accessor :runner
+
+    def initialize(options = {})
+      super
+      @options = {
+        all_on_start: true
+      }.merge(options)
+      @runner  = Runner.new(@options)
+    end
+
+    def start
+      Compat::UI.info "Guard::MinitestCr #{MinitestCrVersion::VERSION} is running!"
+      run_all if @options[:all_on_start]
+    end
+
+    def stop
+      true
+    end
+
+    def reload
+      true
+    end
+
+    def run_all
+      throw_on_failed_tests { runner.run_all }
+    end
+
+    def run_on_modifications(paths = [])
+      throw_on_failed_tests { runner.run_on_modifications(paths) }
+    end
+
+    def run_on_additions(paths)
+      runner.run_on_additions(paths)
+    end
+
+    def run_on_removals(paths)
+      runner.run_on_removals(paths)
+    end
+
+    private
+
+    def throw_on_failed_tests
+      throw :task_has_failed unless yield
+    end
+  end
+end

data/lib/guard/minitest_cr/inspector.rb

@@ -0,0 +1,57 @@
+require 'guard/minitest_cr'
+
+module Guard
+  class MinitestCr < Plugin
+    class Inspector
+      attr_reader :test_folders, :test_file_patterns, :test_helpers
+
+      def initialize(test_folders, test_file_patterns, test_helpers)
+        @test_folders = test_folders.uniq.compact
+        @test_file_patterns = test_file_patterns.uniq.compact
+        @test_helpers = test_helpers.uniq.compact
+      end
+
+      def clean_all
+        clean(test_folders)
+      end
+
+      def clean(paths)
+        paths.reduce([]) do |memo, path|
+          if File.directory?(path)
+            memo += _test_files_for_paths(path)
+          else
+            memo << path if _test_file?(path)
+          end
+          memo
+        end.uniq
+      end
+
+      def clear_memoized_test_files
+        @all_test_files = nil
+      end
+
+      def all_test_files
+        @all_test_files ||= _test_files_for_paths
+      end
+
+      private
+
+      def _test_files_for_paths(paths = test_folders)
+        paths = _join_for_glob(Array(paths))
+        files = _join_for_glob(test_file_patterns)
+        helpers = _join_for_glob(test_helpers)
+
+        Dir["#{paths}/**/#{files}"] - Dir["#{paths}/**/#{helpers}"]
+      end
+
+      def _test_file?(path)
+        _test_files_for_paths.map {|path| File.expand_path(path) }
+                             .include?(File.expand_path(path))
+      end
+
+      def _join_for_glob(fragments)
+        "{#{fragments.join(',')}}"
+      end
+    end
+  end
+end

data/lib/guard/minitest_cr/runner.rb

@@ -0,0 +1,135 @@
+require 'guard/minitest_cr/inspector'
+require 'English'
+
+module Guard
+  class MinitestCr < Plugin
+    class Runner
+      attr_accessor :inspector
+
+      def initialize(options = {})
+        @options = {
+          all_after_pass:     false,
+          all_env:            {},
+          env:                {},
+          test_folders:       %w(test spec),
+          test_file_patterns: %w(*_test.cr test_*.cr *_spec.cr),
+          test_helpers:       %w(test_helper.cr spec_helper.cr),
+          cli:                nil
+        }.merge(options)
+
+        [:test_folders, :test_file_patterns, :test_helpers].each do |k|
+          @options[k] = Array(@options[k]).uniq.compact
+        end
+
+        @inspector = Inspector.new(test_folders, test_file_patterns, test_helpers)
+      end
+
+      def run(paths, options = {})
+        return unless options[:all] || !paths.empty?
+
+        message = "Running: #{options[:all] ? 'all tests' : paths.join(' ')}"
+        Compat::UI.info message, reset: true
+
+        begin
+          status = _run(*minitest_command(paths, options[:all]))
+        rescue Errno::ENOENT => e
+          Compat::UI.error e.message
+          throw :task_has_failed
+        end
+
+        success = status.zero?
+
+        Compat::UI.notify(message, title: 'Minitest results', image: success ? :success : :failed)
+
+        run_all_coz_ok = @options[:all_after_pass] && success && !options[:all]
+        run_all_coz_ok ?  run_all : success
+      end
+
+      def run_all
+        paths = inspector.clean_all
+        run(paths, all: true)
+      end
+
+      def run_on_modifications(paths = [])
+        paths = inspector.clean(paths)
+        run(paths, all: all_paths?(paths))
+      end
+
+      def run_on_additions(_paths)
+        inspector.clear_memoized_test_files
+        true
+      end
+
+      def run_on_removals(_paths)
+        inspector.clear_memoized_test_files
+      end
+
+      private
+
+      def cli_options
+        @cli_options ||= Array(@options[:cli])
+      end
+
+      def all_after_pass?
+        @options[:all_after_pass]
+      end
+
+      def test_folders
+        @options[:test_folders]
+      end
+
+      def test_file_patterns
+        @options[:test_file_patterns]
+      end
+
+      def test_helpers
+        @options[:test_helpers]
+      end
+
+      def _run(*args)
+        Compat::UI.debug "Running: #{args.join(' ')}"
+        return $CHILD_STATUS.exitstatus unless Kernel.system(*args).nil?
+
+        fail Errno::ENOENT, args.join(' ')
+      end
+
+      def minitest_command(paths, all)
+        cmd_parts = []
+
+        cmd_parts << crystal_command(paths)
+
+        [cmd_parts.compact.join(' ')].tap do |args|
+          env = generate_env(all)
+          args.unshift(env) if env.length > 0
+        end
+      end
+
+      def crystal_command(paths)
+        cmd_parts  = ['crystal', 'run']
+        cmd_parts.concat(paths)
+
+        cmd_parts << '--'
+        cmd_parts += cli_options
+        cmd_parts
+      end
+
+      def generate_env(all = false)
+        base_env.merge(all ? all_env : {})
+      end
+
+      def base_env
+        Hash[(@options[:env] || {}).map { |key, value| [key.to_s, value.to_s] }]
+      end
+
+      def all_env
+        return { @options[:all_env].to_s => 'true' } unless @options[:all_env].is_a? Hash
+        Hash[@options[:all_env].map { |key, value| [key.to_s, value.to_s] }]
+      end
+
+      def all_paths?(paths)
+        paths == inspector.all_test_files
+      end
+
+    end
+  end
+end

data/lib/guard/minitest_cr/templates/Guardfile

@@ -0,0 +1,16 @@
+guard :minitest_cr do
+  # with Minitest::Test ("_test" suffix)
+  watch(%r{^test/(.+)_test\.cr$})
+  watch(%r{^src/(.+)\.cr$})         { |m| "test/#{m[1]}_test.cr" }
+  watch(%r{^test/test_helper\.cr$}) { Dir.glob("test/**/*_test.cr") }
+
+  # with Minitest::Test ("test_" prefix)
+  # watch(%r{^test/(.*)\/?test_(.*)\.cr$})
+  # watch(%r{^src/(.*/)?([^/]+)\.cr$})     { |m| "test/#{m[1]}test_#{m[2]}.cr" }
+  # watch(%r{^test/test_helper\.cr$})      { Dir.glob("test/**/test_*.cr") }
+
+  # with Minitest::Spec ("_spec" suffix)
+  # watch(%r{^spec/(.+)_spec\.cr$})
+  # watch(%r{^src/(.+)\.cr$})         { |m| "spec/#{m[1]}_spec.cr" }
+  # watch(%r{^spec/spec_helper\.cr$}) { Dir.glob("spec/**/*_spec.cr") }
+end

data/lib/guard/minitest_cr/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  class MinitestCrVersion
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: guard-minitest_cr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Felix Bünemann
+- Yann Lugrin
+- Rémy Coutable
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: guard-compat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Guard::Minitest automatically run your tests with Minitest.cr framework
+  (much like autotest)
+email:
+- felix.buenemann@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/guard/minitest_cr.rb
+- lib/guard/minitest_cr/inspector.rb
+- lib/guard/minitest_cr/runner.rb
+- lib/guard/minitest_cr/templates/Guardfile
+- lib/guard/minitest_cr/version.rb
+homepage: https://github.com/felixbuenemann/guard-minitest-cr
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Guard plugin for the Crystal Minitest.cr framework
+test_files: []