guard-julia 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c4dae592b4db8e802357b8d630cf98269ba68bab
+  data.tar.gz: c3aa6141bb137975202c9465b367535a0845a125
+SHA512:
+  metadata.gz: 35bc8190b13378cd9764485dc029d113ab6a2a696685901a7c23176db5b88123d028dc16965cd853ade91268bc06df09ac068165eff81c467801bc7e1d2784e1
+  data.tar.gz: a76e4ec317fa51647f6bd8b2ca935630fa68049c78a89baad68902968fad8e8260234465506d1cf67f4b7a2f1ef8cc7c98cf442b984fe39a91d33269a0f8e5df

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+bundler_args: --without development
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/CHANGELOG.yml

@@ -0,0 +1,5 @@
+%YAML 1.2
+---
+changes:
+  v0.0.0:
+    - TODO(svs14): Update before release.

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+
+group :development, :test do
+  gem 'minitest'
+  gem 'mocha'
+  gem 'guard-minitest', require: false
+  gem 'guard-rubocop', require: false
+end
+
+# Test group will be installed
+# on Travis CI
+group :test do
+  gem 'coveralls', require: false
+end

data/Guardfile

@@ -0,0 +1,6 @@
+guard :minitest do
+  # with Minitest::Spec
+  watch(%r{^spec/(.*)_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Samuel Jenkins
+
+MIT License
+
+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,70 @@
+# Guard::Julia
+
+[![Gem Version](https://badge.fury.io/rb/guard-julia.png)](http://badge.fury.io/rb/guard-julia) 
+[![Build Status](https://travis-ci.org/svs14/guard-julia.png?branch=master)](https://travis-ci.org/svs14/guard-julia)
+[![Dependency Status](https://gemnasium.com/svs14/guard-julia.png)](https://gemnasium.com/svs14/guard-julia)
+[![Code Climate](https://codeclimate.com/github/svs14/guard-julia.png)](https://codeclimate.com/github/svs14/guard-julia)
+[![Coverage Status](https://coveralls.io/repos/svs14/guard-julia/badge.png?branch=master)](https://coveralls.io/r/svs14/guard-julia)
+[![Inline docs](http://inch-ci.org/github/svs14/guard-julia.png)](http://inch-ci.org/github/svs14/guard-julia)
+
+Julia guard automatically launches 
+respective tests when Julia files are modified.
+
+The codebase's architecture is largely derived from
+[guard-minitest](https://github.com/guard/guard-minitest).
+
+## Installation
+
+Ruby must be installed, then run:
+
+    $ gem install bundler
+    $ cd /your/julia/project/dir
+    $ bundle init
+
+Add this line to your application's Gemfile:
+
+    gem 'guard-julia'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Please read [Guard usage documentation](http://github.com/guard/guard#readme).
+
+To create the Guardfile run:
+
+    $ bundle exec guard init julia
+
+Then run guard itself:
+
+    $ bundle exec guard
+
+## Options
+
+```ruby
+all_on_start: true # Run all tests on startup
+julia_file_path: 'julia' # File path to Julia executable
+all_tests_file: 'test/runtests.jl' # File to run all tests
+cli: ['--code-coverage'] # CLI arguments to Julia
+env: {} # Environment variables
+```
+
+You can pass any of these options in the Guardfile like so:
+```ruby
+guard :julia, cli: ['--code-coverage', '-p 1'] do
+  # ...
+end
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/svs14/guard-julia/fork )
+2. Get all dependencies (`bundle`)
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Make sure tests pass (`bundle exec rake test`)
+6. Follow RuboCop's advice (`bundle exec rubocop`)
+7. Push to the branch (`git push origin my-new-feature`)
+8. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/guard-julia.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'guard/julia/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'guard-julia'
+  spec.version       = Guard::JuliaVersion::VERSION
+  spec.authors       = ['Samuel Jenkins']
+  spec.email         = ['svs14.41svs@gmail.com']
+  spec.summary       = 'Guard plugin for Julia language'
+  spec.description   = 'Guard::Julia automatically runs tests when files change'
+  spec.homepage      = 'https://rubygems.org/gems/guard-julia'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 1.9.2'
+  spec.add_dependency 'guard', '~> 2.6'
+  spec.add_dependency 'bundler', '~> 1.5'
+end

data/lib/guard/julia.rb

@@ -0,0 +1,67 @@
+require 'guard'
+require 'guard/plugin'
+
+module Guard
+  # Guard plugin for the Julia language.
+  class Julia < Plugin
+    require 'guard/julia/version'
+    require 'guard/julia/runner'
+
+    # Options for plugin.
+    attr_accessor :options
+    # Runner that handles Julia commands.
+    attr_accessor :runner
+
+    def initialize(options = {})
+      super
+
+      @options = {
+        all_on_start: true
+      }.merge(options)
+      @runner = Runner.new(@options)
+    end
+
+    def start
+      UI.info "Guard::Julia #{JuliaVersion::VERSION} is running"
+      run_all if @options[:all_on_start]
+    end
+
+    def stop
+      true
+    end
+
+    def reload
+      true
+    end
+
+    def run_all
+      UI.info 'Running: all tests', reset: true
+      throw_on_failed_tests { runner.run_all }
+    end
+
+    def run_on_changes(_)
+      true
+    end
+
+    def run_on_additions(_)
+      true
+    end
+
+    def run_on_modifications(paths)
+      UI.info "Running: #{paths.join(', ')}", reset: true
+      throw_on_failed_tests { runner.run_on_modifications(paths) }
+    end
+
+    def run_on_removals(_)
+      true
+    end
+
+    private
+
+    # Runs block and throws :task_has_failed
+    # when return is false.
+    def throw_on_failed_tests
+      throw :task_has_failed unless yield
+    end
+  end
+end

data/lib/guard/julia/runner.rb

@@ -0,0 +1,73 @@
+module Guard
+  class Julia
+    # Runner that handles Julia calls and Guard notifications.
+    class Runner
+      # Options for runner.
+      attr_accessor :options
+
+      # Initializes Runner.
+      #
+      # @param options [Dict] Options for runner.
+      def initialize(options = {})
+        @options = {
+          julia_file_path: 'julia',
+          all_tests_file: 'test/runtests.jl',
+          cli: ['--code-coverage'],
+          env: {}
+        }.merge(options)
+      end
+
+      # Runs Julia on all tests file and notifies.
+      def run_all
+        paths = [@options[:all_tests_file]]
+        ret_code = run_julia_command(paths)
+        guard_notify(paths, ret_code)
+      end
+
+      # Runs Julia on target paths (triggered by file modifications).
+      #
+      # @param paths [Array<String>] Paths of files.
+      def run_on_modifications(paths)
+        return_code = run_julia_command(paths)
+        guard_notify(paths, return_code)
+      end
+
+      private
+
+      # Runs Julia command from paths and options.
+      # Returns system return code.
+      def run_julia_command(paths)
+        cmd_parts = build_julia_command(paths)
+        system(@options[:env], *cmd_parts)
+      end
+
+      # Build Julia command from paths and options.
+      # Returns array of command parts.
+      def build_julia_command(paths)
+        cmd_parts = []
+        cmd_parts << "#{@options[:julia_file_path]}"
+        cmd_parts.push(*@options[:cli])
+        cmd_parts.push(*paths)
+
+        cmd_parts
+      end
+
+      # Guard notification of Julia success/failure.
+      def guard_notify(paths, success)
+        # Build notification
+        if success
+          title = 'Success'
+          message = paths.join('\n')
+          image = :success
+        else
+          title = 'Failed'
+          message = paths.join('\n')
+          image = :failed
+        end
+
+        # Notify via Guard
+        ::Guard::Notifier.notify(message, title: title, image: image)
+      end
+    end
+  end
+end

data/lib/guard/julia/templates/Guardfile

@@ -0,0 +1,8 @@
+guard :julia do
+  # Run all tests when [PackageName].jl changes.
+  watch(%r{^src/(.*/)?(.*?[A-Z].*)\.jl}) { |m| "test/runtests.jl" }
+  # Run respective test when a source file changes.
+  watch(%r{^src/(.*/)?([^A-Z]*)\.jl}) { |m| "test/#{m[1]}test_#{m[2]}.jl"}
+  # Run test file when it changes.
+  watch(%r{^test/(.*/)?(.*)\.jl}) { |m| "test/#{m[1]}#{m[2]}.jl" }
+end

data/lib/guard/julia/version.rb

@@ -0,0 +1,6 @@
+module Guard
+  # Julia guard plugin version.
+  module JuliaVersion
+    VERSION = '0.0.1'
+  end
+end

data/spec/guard/julia/runner_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Guard::Julia::Runner do
+  subject { Guard::Julia::Runner }
+
+  let(:default_options) do
+    {
+      julia_file_path: 'julia',
+      all_tests_file: 'test/runtests.jl',
+      cli: ['--code-coverage'],
+      env: {}
+    }
+  end
+
+  describe '#options' do
+    it 'defaults' do
+      subject.new.options.must_equal(default_options)
+    end
+  end
+
+  describe '#run_all' do
+    it 'runs all tests file' do
+      subject.any_instance.expects(:system).with(
+        {}, 'julia', '--code-coverage', 'test/runtests.jl'
+      ).returns(true)
+      ::Guard::Notifier.expects(:notify).with(
+        'test/runtests.jl', title: 'Success', image: :success
+      )
+      subject.new.run_all
+    end
+  end
+  describe '#run_on_modifications' do
+    describe 'when julia exits successfully' do
+      it 'it notifies success' do
+        subject.any_instance.expects(:system).with(
+          {}, 'julia', '--code-coverage',
+          'test/test_example.jl', 'test/test_dummy.jl'
+        ).returns(true)
+        ::Guard::Notifier.expects(:notify).with(
+          'test/test_example.jl\ntest/test_dummy.jl',
+          title: 'Success', image: :success
+        )
+
+        subject.new.run_on_modifications(
+          ['test/test_example.jl', 'test/test_dummy.jl']
+        )
+      end
+    end
+
+    describe 'when julia exits with failure' do
+      it 'it notifies failure' do
+        subject.any_instance.expects(:system).with(
+          {}, 'julia', '--code-coverage',
+          'test/test_example.jl', 'test/test_dummy.jl'
+        ).returns(false)
+        ::Guard::Notifier.expects(:notify).with(
+          'test/test_example.jl\ntest/test_dummy.jl',
+          title: 'Failed', image: :failed
+        )
+
+        subject.new.run_on_modifications(
+          ['test/test_example.jl', 'test/test_dummy.jl']
+        )
+      end
+    end
+  end
+end

data/spec/guard/julia/version_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Guard::JuliaVersion do
+  subject { Guard::JuliaVersion }
+
+  describe '::VERSION' do
+    it 'provides the version' do
+      subject::VERSION.must_match(/^[0-9]+\.[0-9]+\.[0-9]+/)
+    end
+  end
+end

data/spec/guard/julia_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe Guard::Julia do
+  subject { Guard::Julia }
+
+  let(:runner) { Guard::Julia::Runner }
+  let(:guard) { subject.new }
+
+  describe '#initialize' do
+    it 'passes options to runner' do
+      runner.expects(:new).with(all_on_start: true)
+      subject.new
+    end
+  end
+
+  describe '#start' do
+    describe 'when using defaults' do
+      it 'runs all tests' do
+        subject.any_instance.expects(:run_all)
+        subject.new.start
+      end
+    end
+    describe 'when run_all_on_start: false' do
+      it 'does not run all tests' do
+        subject.any_instance.expects(:run_all).never
+        subject.new(all_on_start: false).start
+      end
+    end
+  end
+  describe '#stop' do
+    it 'returns true' do
+      guard.stop.must_equal true
+    end
+  end
+  describe '#reload' do
+    it 'returns true' do
+      guard.reload.must_equal true
+    end
+  end
+
+  describe '#run_all' do
+    it 'delegates to runner, then notifies' do
+      runner.any_instance.expects(run_all: true)
+      Guard::UI.expects(:info).with(
+        'Running: all tests',
+        reset: true
+      )
+      guard.run_all
+    end
+  end
+
+  describe '#run_on_changes' do
+    it 'returns true' do
+      guard.run_on_changes([]).must_equal true
+    end
+  end
+  describe '#run_on_removals' do
+    it 'returns true' do
+      guard.run_on_removals([]).must_equal true
+    end
+  end
+  describe '#run_on_additions' do
+    it 'returns true' do
+      guard.run_on_additions([]).must_equal true
+    end
+  end
+
+  describe '#run_on_modifications' do
+    it 'delegates to runner, then notifies' do
+      runner.any_instance.expects(run_on_modifications: true)
+      Guard::UI.expects(:info).with(
+        'Running: test/test_example.jl, test/test_dummy.jl',
+        reset: true
+      )
+      guard.run_on_modifications(['test/test_example.jl', 'test/test_dummy.jl'])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+
+if ENV['CI']
+  require 'coveralls'
+  Coveralls.wear! do
+    add_filter 'spec'
+  end
+end
+
+ENV['GUARD_ENV'] = 'test'
+require 'guard/julia'
+
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'mocha/mini_test'
+
+module MiniTest
+  #
+  class Spec
+    before(:each) do
+      # Stub all UI methods, so no visible output appears for the UI class
+      ::Guard::UI.stubs(:info)
+      ::Guard::UI.stubs(:warning)
+      ::Guard::UI.stubs(:error)
+      ::Guard::UI.stubs(:debug)
+      ::Guard::UI.stubs(:deprecation)
+    end
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: guard-julia
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Samuel Jenkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: Guard::Julia automatically runs tests when files change
+email:
+- svs14.41svs@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- guard-julia.gemspec
+- lib/guard/julia.rb
+- lib/guard/julia/runner.rb
+- lib/guard/julia/templates/Guardfile
+- lib/guard/julia/version.rb
+- spec/guard/julia/runner_spec.rb
+- spec/guard/julia/version_spec.rb
+- spec/guard/julia_spec.rb
+- spec/spec_helper.rb
+homepage: https://rubygems.org/gems/guard-julia
+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.3.0
+signing_key: 
+specification_version: 4
+summary: Guard plugin for Julia language
+test_files:
+- spec/guard/julia/runner_spec.rb
+- spec/guard/julia/version_spec.rb
+- spec/guard/julia_spec.rb
+- spec/spec_helper.rb
+has_rdoc: