github
/
guard
зеркало из https://github.com/github/guard.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность
Страница: Upgrading to Guard 2.0
Страницы
. Add Readline support to Ruby on Mac OS X Analysis of inotify events for different editors Command line options for Guard Configuration files Configure keyboard shortcuts Correctly using the watchdir option Create a guard Custom matchers in watches Custom pry command cookbook Efficient Filesystem Handling Enabling Color Coding for Running Through SSH Guard 2.10.3 exits when Guardfile is changed. Guard 2.10.3 exits when Guardfile is changed Guard Plugins Guard alternatives Guardfile DSL Configuring Guard Guardfile examples Hooks and callbacks Interacting with Guard List of Guard Commands Maintainers Optimizing for large projects Programmatic use of guard Run guard with RubyMine Shared configurations System notifications Terminal colors on windows Understanding Guard Upgrade guide for existing guards to Guard v1.1 Upgrading to Guard 2.0 Use Guard programmatically cookbook What people say about Guard Which Growl library should I use Why Guard? _Header
12 Upgrading to Guard 2.0
Rémy Coutable редактировал(а) эту страницу 2013-09-09 07:16:31 -07:00
Содержание

Guard 2.0 is a major update and comes with several API changes. Most of these changes are actually new methods (the old methods are deprecated). Following is the exhaustive list of these changes (mostly useful for Guard plugins authors).

Changes in Guard

New methods

  • Guard.plugin(filter): Allows to return the first plugin matching the given filter. Filtering works exactly as for Guard.plugins(filter = nil).
  • Guard.group(filter): Allows to return the first group matching the given filter. Filtering works exactly as for Guard.groups(filter = nil).

Deprecated methods

  • Guard.guards(filter = nil) is deprecated and replaced by Guard.plugins(filter = nil)
  • Guard.add_guard(name, options = {}) is deprecated and replaced by Guard.add_plugin(name, options = {})
  • Guard.get_guard_class(name, fail_gracefully = false) is deprecated and replaced by Guard::PluginUtil.new(name).plugin_class(:fail_gracefully => fail_gracefully)
  • Guard.locate_guard(name) is deprecated and replaced by Guard::PluginUtil.new(name).plugin_location
  • Guard.guard_gem_names is deprecated and replaced by Guard::PluginUtil.plugin_names

Changes in Guard::Guard

Guard::Guard deprecated in favor of Guard::Plugin

To remove the confusion between Guard and its many plugins (guard-rspec, guard-pow, guard-livereload etc.), Guard::Guard is renamed Guard::Plugin. Guard::Guard is deprecated so if you're a plugin maintainer, in your next (major) release that will depend on Guard ~> 2.0 you must make your plugin inherit from Guard::Plugin instead of Guard::Guard.

Also, please be sure to change the #initialize signature from #initialize(watchers = [], options = {}) to #initialize(options = {}) (watchers are now passed in the options argument directly).

For instance, for guard-rspec:

module Guard
  class RSpec < Guard
    def initialize(watchers = [], options = {})
      super
      # rest of the implementation...
    end
  end
end

should become:

module Guard
  class RSpec < Plugin
    def initialize(options = {})
      super
      # you can still access the watchers with options[:watchers]
      # rest of the implementation...
    end
  end
end

Changes in Guard::Dsl

Deprecated methods

  • Guard::Dsl.evaluate_guardfile(options) is deprecated and replaced by Guard::Guardfile::Evaluator.new(options).evaluate_guardfile

Changes in Guard::Guardfile

Deprecated methods

  • Guard::Guardfile.create_guardfile(options) is deprecated and replaced by Guard::Guardfile::Generator.new(options).create_guardfile
  • Guard::Guardfile.initialize_template(plugin_name) is deprecated and replaced by Guard::Guardfile::Generator.new.initialize_template(plugin_name)
  • Guard::Guardfile.initialize_all_templates is deprecated and replaced by Guard::Guardfile::Generator.new.initialize_all_templates

Removed methods

  • Guard::Guardfile.duplicate_definitions? has been removed and replaced by Guard::Guardfile::Evaluator#guardfile_include?(plugin_name)

New notifiers system

Notifiers are now classes with a common interface inherited from Guard::Notifier::Base:

  • [required] #notify(message, opts = {})
  • [optional] .supported_hosts
  • [optional] .available?(opts = {})
  • [optional] .gem_name

Breaking change: The signature of #notify in the notifiers has changed from #notify(type, title, message, image, options = {}) to notify(message, opts = {}) (:type, :title and :image must now be passed in the opts hash.

Even though the notifiers system (including the notifiers #notify methods signature) has been completely rewritten, this shouldn't create any issues since individual notifiers' interface shouldn't be called directly. You should always use the Guard::Notifier.notify method instead.

Intro

Installation

Getting Started

Troubleshooting

Advanced use of Guard

Cookbooks

Development

This wiki and the Guard README document contains a lot of information, please take your time and read these instructions carefully.

If you run into any trouble, you may start by understanding how Guard works.

We provide detailed changes for each Guard release.

Be sure to read the CONTRIBUTING guidelines before reporting a new Guard issue or open a pull request.

If you have any questions about the Guard usage or want to share some information with the Guard community, please go to one of the following places: