stairs 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33b582fd2fb33082959934152985b5fde210cb23
-  data.tar.gz: 283a59e20d7e5eb6730553b305f1632a58723789
+  metadata.gz: d00a852f658b8f3191f7ae6c5f7edf56823ecc38
+  data.tar.gz: 424bc1126fe1cb6757b735a3b72a95032e225518
 SHA512:
-  metadata.gz: 79a9879b665d47712c18bd84622f896f99d3ac78ae247c0a7daf841463ec6e29dac0d523847c02593780e440a249cc36285af8eb8fd364aa7499eadfb2e0f58c
-  data.tar.gz: add58a9fd0211cc3ff9518805b6f474043848f37af26e793bbebb5c1021c2fe9a9fb1d8e3d7c3920f13005429c016b065296f672f786d95154bfe09154d18abf
+  metadata.gz: 4b7faabcf3e3168c77a3e3afb2d9da5d1cdb020ab71dd4f8a3a90870e4605b39ef37f496e5243e05fb26f4b7cb53a0d6af87d6ea939474892efeb64faefbf59e
+  data.tar.gz: 53e273c0bf8ed61bc395cae6b366e9d9e32f12f54741f021dbf3dff5d6a645ae93e7d092156a079746d46abee344fea28b87622247281b330f5cd8359283b427

data/.rubocop.yml

@@ -8,10 +8,6 @@ LineLength:
 CaseIndentation:
   Enabled: false
 
-# This was offending when it shouldn't have been, like in util/file_mutation:21
-UselessAssignment:
-  Enabled: false
-
 # Seems unnecessary?
 ReduceArguments:
   Enabled: false

data/README.md

@@ -20,6 +20,21 @@ interactive prompts for everything else.
 [![Build Status](https://travis-ci.org/patbenatar/stairs.png?branch=master)](https://travis-ci.org/patbenatar/stairs)
 [![Code Climate](https://codeclimate.com/github/patbenatar/stairs.png)](https://codeclimate.com/github/patbenatar/stairs)
 
+## Table of Contents
+
+* [Setup](#setup)
+* [Running Scripts](#running-scripts)
+  * [Command Line Utility](#advanced)
+* [Defining Scripts](#defining-scripts)
+  * [Collecting Input](#collecting-values)
+  * [Asking Questions](#asking-questions)
+  * [Setting ENV vars](#setting-env-vars)
+  * [Writing to Files](#writing-files)
+  * [Miscellaneous](#misc-helpers)
+  * [Steps](#steps)
+  * [Groups](#groups)
+* [Plugins](#plugins)
+
 ## Setup
 
 ### Rails
@@ -42,7 +57,7 @@ Same as above, but you'll have to manually add the Stairs Rake tasks to your
 require "stairs/tasks"
 ```
 
-## Usage
+## Running Scripts
 
 ### Basic
 
@@ -60,6 +75,7 @@ If you want more control, use the `stairs` command line utility:
 $ stairs --help
 Usage: stairs [options]
         --use-defaults               Use defaults when available
+    -g, --groups GROUPS              Specify groups to run. e.g. init,reset
 ```
 
 ## Defining scripts
@@ -99,8 +115,9 @@ end
 dinner = choice "Meat or vegetables?", ["Meat", "Vegetables"]
 ```
 
-### Setting env vars
-Stairs currently supports writing environment variables for rbenv-vars, RVM, and dotenv.
+### Setting ENV vars
+Stairs currently supports writing environment variables for rbenv-vars, RVM, and
+dotenv.
 
 ```ruby
 env "NAME", value
@@ -124,7 +141,9 @@ Display a message when setup completes
 finish "Now that you're done, go have a drink!"
 ```
 
-### Defining setup steps
+### Steps
+
+Group related setup procedures into named steps using `setup`:
 
 ```ruby
 setup :a_cool_service do
@@ -133,12 +152,48 @@ end
 ```
 
 #### Using predefined steps (aka plugins)
+
 ```ruby
 setup :s3
 setup :facebook, required: false
 ```
 
-## Plugins for common setups
+[Available Plugins](#plugins)
+
+### Groups
+
+Stairs supports organizing your script into groups in a way similar to what you
+may be used to with Bundler. With groups you can target specific steps to run
+for different use cases (see `-g` option in the [command line utility](#advanced)).
+
+Anything outside of a group will always be executed. Anything within a group
+will only be executed when its group is run. By default, Stairs runs the `newb`
+group with `$ rake newb`.
+
+For example, you may want to run different steps on a brand new setup than you
+would when resetting an existing setup:
+
+```ruby
+group :newb do
+  setup :s3
+end
+
+group :newb, :reset do
+  setup :balanced
+  rake "db:setup"
+end
+```
+
+And then run your reset like so:
+
+```bash
+$ stairs -g reset
+```
+
+## Plugins
+
+Many projects share dependencies. Plugins are predefined setup steps for common
+use cases.
 
 Some steps support options. Options are specified as a hash like so:
 

data/bin/stairs

@@ -3,6 +3,8 @@
 require "optparse"
 require "stairs"
 
+groups = nil
+
 Stairs.configure do |config|
   OptionParser.new do |options|
     options.banner = "Usage: stairs [options]"
@@ -10,6 +12,14 @@ Stairs.configure do |config|
     options.on("--use-defaults", "Use defaults when available") do |value|
       config.use_defaults = value
     end
+
+    options.on(
+      "-g",
+      "--groups GROUPS",
+      "Specify groups to run. e.g. init,reset"
+    ) do |value|
+      groups = value.split(",").map { |g| g.to_sym } if value
+    end
   end.parse!
 end
 
@@ -17,4 +27,4 @@ end
 rails_application = File.expand_path("./config/application.rb")
 require rails_application if File.exists?(rails_application)
 
-Stairs::Runner.new.run!
+Stairs::Runner.new(groups).run!

data/lib/stairs/runner.rb

@@ -1,8 +1,16 @@
 module Stairs
   class Runner
+    def initialize(groups=nil)
+      @groups = groups
+    end
+
     def run!
       Stairs::InteractiveConfiguration.new.run!
-      Stairs::Script.new("setup.rb").run!
+      Stairs::Script.new("setup.rb", groups).run!
     end
+
+    private
+
+    attr_reader :groups
   end
 end

data/lib/stairs/script.rb

@@ -1,8 +1,9 @@
 module Stairs
   class Script
-    def initialize(filename)
+    def initialize(filename, groups)
       @filename = filename
       @script = File.read(@filename)
+      @groups = groups
     end
 
     def run!
@@ -13,9 +14,9 @@ module Stairs
     private
 
     def run
-      Step.new.instance_eval(script)
+      Step.new(groups).instance_eval(script)
     end
 
-    attr_reader :script, :filename
+    attr_reader :script, :filename, :groups
   end
 end

data/lib/stairs/step.rb

@@ -1,9 +1,12 @@
 module Stairs
   class Step
-    attr_reader :options
+    attr_reader :options, :groups
 
-    def initialize(options={})
+    def initialize(*args)
+      options = args.extract_options!
       @options = options.reverse_merge required: true
+
+      @groups = args.first
     end
 
     def run!
@@ -85,16 +88,20 @@ module Stairs
     # of Step
     def setup(step_name, options={}, &block)
       if block_given?
-        Step.new(options).tap do |step|
+        Step.new(groups, options).tap do |step|
           step.define_singleton_method :run, &block
           step.step_title = step_name.to_s.titleize
         end.run!
       else
         klass = "Stairs::Steps::#{step_name.to_s.camelize}".constantize
-        klass.new(options).run!
+        klass.new(groups, options).run!
       end
     end
 
+    def group(*names)
+      yield if !groups || (names & groups).any?
+    end
+
     def finish(message)
       puts "== All done!".green
       puts message.green

data/lib/stairs/tasks.rb

@@ -7,7 +7,7 @@ module Stairs
     def install!
       desc "Setup the project"
       task :newb do
-        Stairs::Runner.new.run!
+        Stairs::Runner.new([:newb]).run!
       end
     end
   end

data/lib/stairs/util/file_mutation.rb

@@ -28,7 +28,7 @@ module Stairs
         def write_line(string, filename)
           File.open filename, "a+" do |file|
             # ensure file ends with newline before appending
-            last_line = file.each_line.reduce("") { |m, l| m = l }
+            last_line = file.each_line.reduce("") { |m, l| l }
             file.puts "" unless last_line == "" || last_line =~ /(.*)\n/
 
             file.puts string

data/lib/stairs/version.rb

@@ -1,3 +1,3 @@
 module Stairs
-  VERSION = "0.6.1"
+  VERSION = "0.7.0"
 end

data/spec/lib/stairs/runner_spec.rb

@@ -1,6 +1,9 @@
 require "spec_helper"
 
 describe Stairs::Runner do
+  let(:groups) { nil }
+  let(:subject) { described_class.new(groups) }
+
   describe "#run!" do
     let(:script_double) { double("script", run!: true) }
 
@@ -16,11 +19,20 @@ describe Stairs::Runner do
       subject.run!
     end
 
-    it "runs the setup.rb script" do
-      Stairs::Script.should_receive(:new).with("setup.rb").and_return(script_double)
+    it "runs all groups in the setup.rb script" do
+      Stairs::Script.should_receive(:new).with("setup.rb", groups).and_return(script_double)
       script_double.should_receive(:run!)
 
       subject.run!
     end
+
+    context "with groups provided" do
+      let(:groups) { [:reset] }
+
+      it "passes the specified groups to the script" do
+        Stairs::Script.should_receive(:new).with("setup.rb", groups)
+        subject.run!
+      end
+    end
   end
 end

data/spec/lib/stairs/script_spec.rb

@@ -2,7 +2,9 @@ require "spec_helper"
 
 describe Stairs::Script do
   let(:filename) { "setup.rb" }
-  subject { described_class.new(filename) }
+  let(:groups) { [:reset] }
+  subject { described_class.new(filename, groups) }
+
 
   context "with a script present" do
     before do
@@ -13,12 +15,23 @@ describe Stairs::Script do
 
     after { File.delete(filename) }
 
+    describe "initialize" do
+      it "receives groups" do
+        expect { described_class.new(filename, groups) }.not_to raise_error
+      end
+    end
+
     describe "#run!" do
       it "outputs running message" do
         output = capture_stdout { subject.run! }
         expect(output).to include "= Running script setup.rb"
       end
 
+      it "passes groups to the new instance of Step" do
+        Stairs::Step.should_receive(:new).with(groups)
+        subject.run!
+      end
+
       it "evaluates the script in the context of an instance of Step" do
         # because our test setup.rb only contains `self.class` we can check
         # this way:
@@ -26,4 +39,4 @@ describe Stairs::Script do
       end
     end
   end
-end
+end

data/spec/lib/stairs/step_spec.rb

@@ -2,7 +2,8 @@ require "spec_helper"
 
 describe Stairs::Step do
   let(:anon_step) { Class.new(described_class) }
-  subject { anon_step.new }
+  let(:groups) { nil }
+  subject { anon_step.new(groups) }
 
   describe "metadata" do
     describe "step_title" do
@@ -42,21 +43,27 @@ describe Stairs::Step do
     end
   end
 
-  describe "options" do
-    describe "default options" do
-      it "is required" do
-        expect(subject.options[:required]).to be_true
+  describe "#initialize" do
+    describe "options" do
+      describe "default options" do
+        it "is required" do
+          expect(subject.options[:required]).to be_true
+        end
       end
-    end
 
-    context "with options" do
-      let(:options) { { something: "cool" } }
-      subject { anon_step.new(options) }
+      context "with options" do
+        let(:options) { { something: "cool" } }
+        subject { anon_step.new(options) }
 
-      it "exposes options on the instance" do
-        expect(subject.options[:something]).to eq "cool"
+        it "exposes options on the instance" do
+          expect(subject.options[:something]).to eq "cool"
+        end
       end
     end
+
+    it "exposes supplied groups on the instance" do
+      expect(subject.groups).to eq groups
+    end
   end
 
   describe "#run!" do
@@ -314,18 +321,23 @@ describe Stairs::Step do
 
     context "with a valid step_name" do
       let!(:mock_step_class) { Stairs::Steps::MockStep = Class.new(Stairs::Step) }
+      before { mock_step_class.any_instance.stub run!: true }
 
       it "instantiates and runs the step" do
         mock_step_class.any_instance.should_receive(:run!)
         subject.setup :mock_step
       end
 
+      it "passes groups to the step" do
+        mock_step_class.should_receive(:new).with(groups, {}).and_call_original
+        subject.setup :mock_step
+      end
+
       context "with options" do
         let(:options) { { something: "cool" } }
-        before { mock_step_class.any_instance.stub run!: true }
 
         it "passes options to the step" do
-          mock_step_class.should_receive(:new).with(options).and_call_original
+          mock_step_class.should_receive(:new).with(groups, options).and_call_original
           subject.setup :mock_step, options
         end
       end
@@ -336,6 +348,12 @@ describe Stairs::Step do
         subject.setup(:custom_step) { puts "I'm running in #{self.class}" }
       end
 
+      # Initialize primary subject before asserting against #new for the Step
+      # it initializes
+      def initialize_primary_subject
+        instance = subject
+      end
+
       it "sets the new step's title to a titleized version of step_name" do
         output = capture_stdout { call_method }
         expect(output).to include "Custom Step"
@@ -346,17 +364,52 @@ describe Stairs::Step do
         expect(output).to include "I'm running in Stairs::Step"
       end
 
+      it "passes groups to the step" do
+        initialize_primary_subject
+
+        described_class.should_receive(:new).with(groups, {}).and_call_original
+        call_method
+      end
+
       context "with options" do
         let(:options) { { something: "cool" } }
         before { described_class.any_instance.stub run!: true }
 
         it "passes options to the step" do
-          instance = subject # Initialize class before asserting against #new
+          initialize_primary_subject
 
-          described_class.should_receive(:new).with(options).and_call_original
+          described_class.should_receive(:new).with(groups, options).and_call_original
           subject.setup(:custom_step, options) { true }
         end
       end
     end
   end
+
+  describe "#group" do
+    let(:name) { :reset }
+
+    context "when the name is in the groups to run" do
+      let(:groups) { [:reset, :init] }
+
+      it "calls the supplied block" do
+        expect { |b| subject.group(name, &b) }.to yield_control
+      end
+    end
+
+    context "when the name is not in the groups to run" do
+      let(:groups) { [:init] }
+
+      it "does not call the supplied block" do
+        expect { |b| subject.group(name, &b) }.not_to yield_control
+      end
+
+      context "but no groups to run are provided" do
+        let(:groups) { nil }
+
+        it "calls the supplied block" do
+          expect { |b| subject.group(name, &b) }.to yield_control
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stairs
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - patbenatar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-27 00:00:00.000000000 Z
+date: 2013-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler