Guard::Bundler 项目教程

Guard::Bundler 项目教程

guard-bundlerGuard::Bundler automatically install/update your gem bundle when needed项目地址:https://gitcode.com/gh_mirrors/gu/guard-bundler

1. 项目的目录结构及介绍

Guard::Bundler 是一个用于自动安装和更新 Gem 包的 Ruby 项目。以下是该项目的目录结构及其介绍：

guard-bundler/
├── Guardfile
├── LICENSE.txt
├── README.md
├── Rakefile
├── guard-bundler.gemspec
├── lib/
│   ├── guard/
│   │   ├── bundler/
│   │   │   ├── templates/
│   │   │   │   └── Guardfile
│   │   │   └── version.rb
│   │   └── bundler.rb
│   └── guard.rb
└── spec/
    ├── guard/
    │   └── bundler_spec.rb
    └── spec_helper.rb

• Guardfile: 项目的默认配置文件。
• LICENSE.txt: 项目的许可证文件。
• README.md: 项目的说明文档。
• Rakefile: 用于运行测试和构建项目的 Rake 任务文件。
• guard-bundler.gemspec: 项目的 gem 规范文件。
• lib/: 包含项目的主要代码。
  • guard/: 包含 Guard 插件的核心代码。
    • bundler/: 包含 Bundler 插件的具体实现。
      • templates/: 包含默认的 Guardfile 模板。
      • version.rb: 定义版本号的文件。
    • bundler.rb: Bundler 插件的主文件。
  • guard.rb: 加载 Guard 插件的入口文件。
• spec/: 包含项目的测试代码。
  • guard/: 包含 Bundler 插件的测试代码。
  • spec_helper.rb: 测试辅助文件。

2. 项目的启动文件介绍

Guard::Bundler 项目的启动文件是 lib/guard/bundler.rb。这个文件定义了 Bundler 插件的主要功能和行为。以下是该文件的主要内容：

require 'guard/compat/plugin'

module Guard
  class Bundler < Plugin
    def initialize(options = {})
      super
      @options = options
    end

    def start
      UI.info "Guard::Bundler is running"
      run_bundler
    end

    def run_all
      run_bundler
    end

    def run_on_changes(paths)
      run_bundler
    end

    private

    def run_bundler
      UI.info "Running bundler"
      system('bundle install')
    end
  end
end

• initialize: 初始化插件并设置选项。
• start: 启动插件并运行 Bundler。
• run_all: 在运行所有任务时调用 Bundler。
• run_on_changes: 在文件发生变化时调用 Bundler。
• run_bundler: 执行 bundle install 命令。

3. 项目的配置文件介绍

Guard::Bundler 项目的配置文件是 Guardfile。这个文件定义了 Guard 插件的监听规则和行为。以下是默认的 Guardfile 内容：

guard :bundler do
  watch('Gemfile')
  watch(/^.+\.gemspec/)
end

• guard :bundler: 定义使用 Bundler 插件。
• watch('Gemfile'): 监听 Gemfile 文件的变化。
• watch(/^.+\.gemspec/): 监听所有 .gemspec 文件的变化。

通过这个配置文件，Guard::Bundler 会在 Gemfile 或任何 .gemspec 文件发生变化时自动运行 bundle install 命令。

guard-bundlerGuard::Bundler automatically install/update your gem bundle when needed项目地址:https://gitcode.com/gh_mirrors/gu/guard-bundler