The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
App-Sqitch-0.30-TRIAL
River stage one • 2 direct dependents • 2 total dependents
43 ++
/ App::Sqitch::Plan::Step

Name

App::Sqitch::Plan::Step - Sqitch deployment plan tag

Synopsis

  my $plan = App::Sqitch::Plan::Step->new(
      names => \@tag_names,
      steps => \@steps,
  );

Description

A App::Sqitch::Plan::Step represents a tagged list of deployment steps in a Sqitch plan. A tag may have one or more names (as multiple tags can represent a single point in time in the plan), and any number of steps.

Interface

Constructors

new

  my $step = App::Sqitch::Step::Step->new(%params);

Instantiates and returns a App::Sqitch::Step::Step object. The requires and conflicts attributes must both be present or both be absent.

Accessors

names

  my $name = $step->name;

Returns the name of the step.

tag

  my $tag = $step->tag;

Returns the App::Sqitch::Plan::Tag object with which the step is associated.

deploy_file

  my $file = $step->deploy_file;

Returns the path to the deploy script file for the step.

revert_file

  my $file = $step->revert_file;

Returns the path to the revert script file for the step.

test_file

  my $file = $step->test_file;

Returns the path to the test script file for the step.

Instance Methods

names

  my $steps = $step->steps;

Returns an array reference of deployment steps.

requires

  my @requires = $step->requires;

Returns a list of the names of steps required by this step.

conflicts

  my @conflicts = $step->conflicts;

Returns a list of the names of steps with which this step conflicts.

deploy_handle

  my $fh = $step->deploy_handle;

Returns an IO::File file handle, opened for reading, for the deploy script for the step.

revert_handle

  my $fh = $step->revert_handle;

Returns an IO::File file handle, opened for reading, for the revert script for the step.

test_handle

  my $fh = $step->test_handle;

Returns an IO::File file handle, opened for reading, for the test script for the step.

See Also

App::Sqitch::Plan

Class representing a plan.

sqitch

The Sqitch command-line client.

Author

David E. Wheeler <david@justatheory.com>

License

Copyright (c) 2012 iovation Inc.

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.