guard-spring 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df2464f22010d6178d6131a2532921f919723963
-  data.tar.gz: 33f829f4196e3aa36b9c377b8d8e00afa177701f
+  metadata.gz: d05e040fb4f6e0f70b955384cb62a7bf4f99fda3
+  data.tar.gz: fd87d3675e74648373402e694f7617084565cf2a
 SHA512:
-  metadata.gz: 2a492ce4c9ad697248b4c375bd51f98f5ef0f2845cffbe3fc6af349423f3bdd7757b91703ab107744a951c5976c4dc18dbf494e1a4d76a4bafd5d4cd23b7e971
-  data.tar.gz: 99b6b1dddeebb3fb25abdcdf29a1763caab49196776977ac7a1c7f2d9a75c9fddd4971d147ee49107170f74dd8f81d996f8b097d0c895cd453ba8ad3cdeb2244
+  metadata.gz: 68b5b9320fc0e3c480f11a0376491d5004d2e456540d1ea58444f0aae3a932f8952fbad8b6e6fd1e33678a780358858e382f9656e8b33edf6db7ba0ee0620977
+  data.tar.gz: 6854b005c9d1c68d5b117ef0b3c58069ff4fd467653445e44e926dfe7c519c2f019b1f8a99eb89b25e29741a417bacc9afba0db1ed89c23d06c7cf63529c614e

data/README.md

@@ -1,11 +1,10 @@
 # Guard::Spring
 
-Guard::Spring automatically runs RSpec with [Spring](https://github.com/jonleighton/spring).
-
-Read more about [Spring](https://github.com/jonleighton/spring) - Rails application preloader.
+Guard::Spring starts, stops, and restarts [Spring](https://github.com/jonleighton/spring) - Rails application preloader. This plugin therefore most importantly ensures that Spring is not left running when Guard is stopped.
 
 Learn how to monitor file system changes with [Guard](https://github.com/guard/guard).
 
+It seems that [guard-rspec](https://github.com/guard/guard-rspec) can support *Spring* now, using the `cmd` option. This plugin is used to manage Spring itself, not to inject Spring into the running of Rspec.
 
 ## Installation
 
@@ -21,15 +20,26 @@ And then execute:
 
 Add rules to Guardfile:
 
-    $ guard init spring
+    $ bundle exec guard init spring
 
 Run guard. Press Enter to run all specs.
 
-    $ guard
+    $ bundle exec guard
+
+After any modification of monitored files Spring will be restarted.
+
+## Options
+
+### List of available options:
 
-After any modification of project file or spec should run RSpec with Spring.
+Default values shown here.
 
-You can modify the Guardfile to create your own rules and dependencies to run specs.
+    cmd: 'spring'                      # Specify a custom Spring command to run, default: 
+                                       # 'bundle exec spring' if bundler option is enabled,
+                                       # 'bin/spring' if it exists, or 'spring'.
+    bundler: false                     # If true, use 'bundle exec' to run Spring
+                                       # (cmd option overrides this).
+    environments: %w(test development) # Which environments to start when Guard starts.
 
 ## Contributing
 

data/lib/guard/spring.rb

@@ -1,60 +1,56 @@
-require 'guard'
-require 'guard/guard'
+require 'guard/compat/plugin'
 require 'spring/commands'
 
 module Guard
-  class Spring < Guard
+  class Spring < Plugin
     autoload :Runner, 'guard/spring/runner'
     attr_accessor :runner
 
     # Initialize a Guard.
     # @param [Array<Guard::Watcher>] watchers the Guard file watchers
     # @param [Hash] options the custom Guard options
-    def initialize(watchers = [], options = {})
+    def initialize(options = {})
       super
       @runner = Runner.new(options)
     end
 
-    # Call once when Guard starts. Please override initialize method to init stuff.
+    # Called once when Guard starts. Please override initialize method to init stuff.
     # @raise [:task_has_failed] when start has failed
     def start
-      runner.kill_spring
-      runner.launch_spring('Start')
+      runner.start
     end
 
     # Called when `stop|quit|exit|s|q|e + enter` is pressed (when Guard quits).
     # @raise [:task_has_failed] when stop has failed
     def stop
-      runner.kill_spring
+      runner.stop
     end
 
     # Called when `reload|r|z + enter` is pressed.
     # This method should be mainly used for "reload" (really!) actions like reloading passenger/spork/bundler/...
     # @raise [:task_has_failed] when reload has failed
     def reload
-      runner.kill_spring
-      runner.launch_spring('Reload')
+      runner.restart
     end
 
     # Called when just `enter` is pressed
     # This method should be principally used for long action like running all specs/tests/...
     # @raise [:task_has_failed] when run_all has failed
     def run_all
-      runner.run_all
     end
 
     # Called on file(s) modifications that the Guard watches.
     # @param [Array<String>] paths the changes files or paths
     # @raise [:task_has_failed] when run_on_change has failed
     def run_on_changes(paths)
-      runner.run(paths)
+      runner.restart
     end
 
     # Called on file(s) deletions that the Guard watches.
     # @param [Array<String>] paths the deleted files or paths
     # @raise [:task_has_failed] when run_on_change has failed
     def run_on_removals(paths)
-      runner.run_all
+      runner.restart
     end
   end
 end

data/lib/guard/spring/runner.rb

@@ -4,99 +4,68 @@ module Guard
   class Spring
     class Runner
       attr_reader :options
+      attr_writer :spring_command
 
       def initialize(options = {})
         @options = options
-        @options[:rspec_cli] = options[:rspec_cli].nil? ? '' : " #{options[:rspec_cli]} "
-        @spring_cmd = get_spring_cmd
-        UI.info 'Guard::Spring Initialized'
       end
 
-      def launch_spring(action)
-        UI.info "#{action}ing Spring", :reset => true
+      def start
+        UI.info "Guard::Spring starting Spring"
         start_spring
       end
 
-      def kill_spring
+      def stop
+        UI.info "Guard::Spring stopping Spring"
         stop_spring
       end
 
-      def run(paths)
-        existing_paths = paths.uniq.select { |path| File.exist? "#{Dir.pwd}/#{path}" }
-        rspec_paths = existing_paths.select { |path| path =~ /spec(\/\w+)*(\/\w+_spec\.rb)?/ }
-        run_command "#@spring_cmd rspec", "#{rspec_cli}#{existing_paths.join(' ')}" unless rspec_paths.empty?
-
-        # TBD: # testunit_paths = existing_paths.select { |path| path =~ /test(.*\.rb)?/ }
-        # TBD: # run_command 'spring testunit', existing_paths.join(' ') unless testunit_paths.empty?
-      end
-
-      def run_all
-        if rspec?
-          run(%w(spec))
-        elsif test_unit?
-          run(Dir['test/**/*_test.rb']+Dir['test/**/test_*.rb'])
-        end
+      def restart
+        UI.info "Guard::Spring restarting Spring"
+        stop_spring
+        start_spring
       end
 
       private
 
-      def run_command(cmd, options = '')
-        UI.debug "Command execution: #{cmd} #{options}"
-        system "#{cmd} #{options}"
-      end
-
-      def fork_exec(cmd, options = '')
-        fork do
-          UI.debug "(Fork) Command execution: #{cmd} #{options}"
-          exec "#{cmd} #{options}"
-        end
-      end
-
       def start_spring
-        fork_exec("#@spring_cmd start > /dev/null")
+        environments.each do |env|
+          system "#{spring_command} rake -T RAILS_ENV='#{env}' > /dev/null"
+        end
       end
 
       def stop_spring
-        run_command("#@spring_cmd stop")
-        UI.info 'Stopping Spring ', :reset => true
-      end
-
-      def push_command(paths)
-        cmd_parts = []
-        cmd_parts << "#@spring_cmd rspec"
-        cmd_parts << paths.join(' ')
-        cmd_parts.join(' ')
-      end
-
-      def get_spring_cmd
-        return './bin/spring' if create_bin_stubs %w(rspec)
-
-        UI.warning('Failed to create all required binstubs')
-        'spring'
-      end
-
-      # returns false if creation of any binstub failed
-      def create_bin_stubs(stubs)
-        results = stubs.map do |stub|
-          run_command 'spring binstub', stub unless File.exist? "#{Dir.pwd}/bin/#{stub}"
+        system "#{spring_command} stop"
+      end
+
+      def spring_command
+        @spring_command ||= begin
+          if options[:cmd]
+            options[:cmd]
+          elsif bundler?
+            'bundle exec spring'
+          elsif bin_stub_exists?
+            bin_stub
+          else
+            'spring'
+          end
         end
-        !results.any? or results.all? { |result| result }
       end
 
-      def bundler?
-        @bundler ||= options[:bundler] != false && File.exist?("#{Dir.pwd}/Gemfile")
+      def bin_stub
+        './bin/spring'
       end
 
-      def test_unit?
-        @test_unit ||= options[:test_unit] != false && File.exist?("#{Dir.pwd}/test/test_helper.rb")
+      def bin_stub_exists?
+        File.exist? bin_stub
       end
 
-      def rspec?
-        @rspec ||= options[:rspec] != false && File.exist?("#{Dir.pwd}/spec")
+      def bundler?
+        options.fetch(:bundler, false)
       end
 
-      def rspec_cli
-        options[:rspec_cli]
+      def environments
+        options.fetch(:environments, %w(test development))
       end
     end
   end

data/lib/guard/spring/templates/Guardfile

@@ -1,9 +1,6 @@
-guard 'spring', :rspec_cli => '--color' do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^spec/spec_helper\.rb$})                   { |m| 'spec' }
-  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
-  watch(%r{^lib/(.+)\.rb$})                           { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  do |m|
-    %W(spec/routing/#{m[1]}_routing_spec.rb spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb spec/requests/#{m[1]}_spec.rb)
-  end
+guard 'spring', bundler: true do
+  watch('Gemfile.lock')
+  watch(%r{^config/})
+  watch(%r{^spec/(support|factories)/})
+  watch(%r{^spec/factory.rb})
 end

data/lib/guard/spring/version.rb

@@ -1,6 +1,6 @@
 module Guard
   module SpringVersion
-    VERSION = '0.0.4'
+    VERSION = '1.0.0'
   end
 end
 

data/spec/guard/spring/runner_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+
+describe Guard::Spring::Runner do
+  let(:options) { {} }
+  let(:runner) { described_class.new options }
+
+  before do
+    allow(runner).to receive(:system).and_raise(NotImplementedError)
+  end
+
+  describe '#initialize' do
+    it 'should have default options and allow overrides' do
+      expect(runner.options).to eq(options)
+    end
+  end
+
+  describe '#start' do
+    it 'outputs a message' do
+      expect(::Guard::UI).to receive(:info).with(/starting/i)
+      allow(runner).to receive(:start_spring)
+      runner.start
+    end
+
+    it 'calls start_spring' do
+      expect(runner).to receive(:start_spring).with(no_args)
+      runner.start
+    end
+  end
+
+  describe '#stop' do
+    it 'outputs a message' do
+      expect(::Guard::UI).to receive(:info).with(/stopping/i)
+      allow(runner).to receive(:stop_spring)
+      runner.stop
+    end
+
+    it 'calls stop_spring' do
+      expect(runner).to receive(:stop_spring).with(no_args)
+      runner.stop
+    end
+  end
+
+  describe '#restart' do
+    it 'outputs a message' do
+      expect(::Guard::UI).to receive(:info).with(/restarting/i)
+      allow(runner).to receive(:stop_spring)
+      allow(runner).to receive(:start_spring)
+      runner.restart
+    end
+
+    it 'calls stop_spring and start_spring' do
+      expect(runner).to receive(:stop_spring).with(no_args).ordered
+      expect(runner).to receive(:start_spring).with(no_args).ordered
+      runner.restart
+    end
+  end
+
+  describe '#spring_command' do
+    let(:bin_stub_exists) { false }
+    let(:bin_stub_path) { 'foo' }
+    subject { runner.send(:spring_command) }
+    before do
+      allow(runner).to receive(:bin_stub_exists?).and_return(bin_stub_exists)
+      allow(runner).to receive(:bin_stub).and_return(bin_stub_path)
+    end
+
+    context 'when cmd option is present' do
+      let(:options) { {cmd: 'foobar'} }
+      it { is_expected.to eq('foobar') }
+    end
+
+    context 'when cmd option is unused' do
+      context 'with bundler: true' do
+        let(:options) { {bundler: true} }
+
+        context 'when bin stub exists' do
+          let(:bin_stub_exists) { true }
+          it { is_expected.to eq('bundle exec spring') }
+        end
+
+        context 'when bin stub does not exist' do
+          let(:bin_stub_exists) { false }
+          it { is_expected.to eq('bundle exec spring') }
+        end
+      end
+      context 'with bundler: false' do
+        let(:options) { {bundler: false} }
+
+        context 'when bin stub exists' do
+          let(:bin_stub_exists) { true }
+          it { is_expected.to eq(bin_stub_path) }
+        end
+
+        context 'when bin stub does not exist' do
+          let(:bin_stub_exists) { false }
+          it { is_expected.to eq('spring') }
+        end
+      end
+    end
+  end
+
+  describe '#bin_stub' do
+    subject { runner.send(:bin_stub) }
+    it { is_expected.to eq('./bin/spring') }
+  end
+
+  describe '#bin_stub_exists?' do
+    let(:bin_stub_path) { 'foo' }
+
+    it 'checks whether the bin_stub exists' do
+      allow(runner).to receive(:bin_stub).and_return(bin_stub_path)
+      expect(File).to receive(:exist?).with(bin_stub_path).and_return(0xdeadbeef)
+      expect(runner.send(:bin_stub_exists?)).to eq(0xdeadbeef)
+    end
+  end
+
+  describe '#start_spring' do
+    it 'makes a system call to start Spring' do
+      allow(runner).to receive(:environments).and_return(%w(env1 env2))
+      allow(runner).to receive(:spring_command).and_return('barbaz')
+      expect(runner).to receive(:system).with(/barbaz rake -T RAILS_ENV='env1'/).and_return(true)
+      expect(runner).to receive(:system).with(/barbaz rake -T RAILS_ENV='env2'/).and_return(true)
+      runner.send(:start_spring)
+    end
+  end
+
+  describe '#stop_spring' do
+    it 'makes a system call to stop Spring' do
+      allow(runner).to receive(:spring_command).and_return('spring')
+      expect(runner).to receive(:system).with(/spring stop/).and_return(true)
+      runner.send(:stop_spring)
+    end
+  end
+end

data/spec/guard/spring_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe Guard::Spring do
+  describe '#initialize' do
+    it "instantiates Runner with given options" do
+      expect(described_class::Runner).to receive(:new).with(foo: 'bar')
+      described_class.new(foo: 'bar')
+    end
+  end
+
+  context 'with a plugin instance' do
+    let(:options) { {} }
+    let(:plugin_instance) { described_class.new(options) }
+    let(:runner) { double(described_class::Runner) }
+    before do
+      allow(plugin_instance).to receive(:runner).and_return(runner)
+    end
+
+    describe '#start' do
+      it "call runner.start" do
+        expect(runner).to receive(:start).with(no_args)
+        plugin_instance.start
+      end
+    end
+
+    describe '#stop' do
+      it "call runner.stop" do
+        expect(runner).to receive(:stop).with(no_args)
+        plugin_instance.stop
+      end
+    end
+
+    describe '#reload' do
+      it "calls runner.restart" do
+        expect(runner).to receive(:restart).with(no_args)
+        plugin_instance.reload
+      end
+    end
+
+    describe '#run_all' do
+      it "does nothing" do
+        plugin_instance.run_all
+      end
+    end
+
+    describe '#run_on_changes' do
+      it "calls runner.restart" do
+        expect(runner).to receive(:restart).with(no_args)
+        plugin_instance.run_on_changes('foo')
+      end
+    end
+
+    describe '#run_on_removals' do
+      it "calls runner.restart" do
+        expect(runner).to receive(:restart).with(no_args)
+        plugin_instance.run_on_removals('foo')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+# -*- encoding : utf-8 -*-
+unless ENV['CI']
+  require 'simplecov'
+  SimpleCov.start do
+    add_group 'Guard::Spring', 'lib/guard'
+    add_group 'Specs', 'spec'
+  end
+end
+
+require 'rspec'
+require 'guard/compat/test/helper'
+require 'guard/spring'
+
+ENV["GUARD_ENV"] = 'test'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    # Silence UI.info output
+    allow(::Guard::UI).to receive(:info).and_return(true)
+    allow(::Guard::Notifier).to receive(:notify).and_return(true)
+  end
+end

metadata

@@ -1,41 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: guard-spring
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Michał Knapik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-14 00:00:00.000000000 Z
+date: 2015-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.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: spring
   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: 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: simplecov
+  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::Spring automatically runs tests with spring
@@ -45,18 +87,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- guard-spring.gemspec
 - lib/guard/spring.rb
 - lib/guard/spring/runner.rb
 - lib/guard/spring/templates/Guardfile
 - lib/guard/spring/version.rb
+- spec/guard/spring/runner_spec.rb
+- spec/guard/spring_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/mknapik/guard-spring
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -64,18 +106,21 @@ 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.0.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Pushes watched files to spring
-test_files: []
+test_files:
+- spec/guard/spring/runner_spec.rb
+- spec/guard/spring_spec.rb
+- spec/spec_helper.rb

data/.gitignore

@@ -1,19 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-coverage
-Gemfile.lock
-InstalledFiles
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-
-# YARD artifacts
-.yardoc
-_yardoc
-doc/

data/Gemfile

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

data/Rakefile

@@ -1 +0,0 @@
-require 'bundler/gem_tasks'

data/guard-spring.gemspec

@@ -1,23 +0,0 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'guard/spring/version'
-
-Gem::Specification.new do |gem|
-  gem.name          = 'guard-spring'
-  gem.version       = Guard::SpringVersion::VERSION
-  gem.platform      = Gem::Platform::RUBY
-  gem.authors       = ['Michał Knapik']
-  gem.email         = ['mknapik@student.agh.edu.pl']
-  gem.description   = %q{Guard::Spring automatically runs tests with spring}
-  gem.summary       = %q{Pushes watched files to spring}
-  gem.homepage      = 'https://github.com/mknapik/guard-spring'
-
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ['lib']
-
-  gem.add_dependency 'guard'
-  gem.add_dependency 'spring'
-end