stairs 0.3.0 → 0.4.0

data/spec/lib/stairs/env_adapters_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+describe Stairs::EnvAdapters do
+  subject { described_class }
+  let(:present_adapter) { double("adapter", present?: true) }
+  let(:other_adapter) { double("adapter", present?: false) }
+  let(:another_adapter) { double("adapter", present?: false) }
+
+  before do
+    stub_const "Stairs::EnvAdapters::ADAPTERS", {
+      one: other_adapter,
+      two: present_adapter,
+      three: another_adapter
+    }
+  end
+
+  describe ".recommended_adapter" do
+    it "returns the first adapter to be `present?`" do
+      expect(described_class.recommended_adapter).to eq present_adapter
+    end
+  end
+
+  describe ".name_for_adapter_class" do
+    it "returns the name" do
+      expect(described_class.name_for_adapter_class(present_adapter)).to eq :two
+    end
+  end
+end

data/spec/lib/stairs/interactive_configuration_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+describe Stairs::InteractiveConfiguration do
+  subject { described_class.new }
+
+  describe "metadata" do
+    it "has a title" do
+      expect(described_class.step_title).not_to be_nil
+    end
+
+    it "has a description" do
+      expect(described_class.step_description).not_to be_nil
+    end
+  end
+
+  describe "#run!" do
+    before do
+      Stairs::EnvAdapters.stub recommended_adapter: Stairs::EnvAdapters::Rbenv
+    end
+
+    it "recommends an adapter" do
+      output = follow_prompts("Y") { subject.run! }
+      expect(output).to include "you're using rbenv"
+    end
+
+    it "sets the adapter" do
+      follow_prompts("Y") { subject.run! }
+      expect(Stairs.configuration.env_adapter).to be_a Stairs::EnvAdapters::Rbenv
+    end
+
+    it "allows for specifying your desired adapter" do
+      follow_prompts("N", "dotenv") { subject.run! }
+      expect(Stairs.configuration.env_adapter).to be_a Stairs::EnvAdapters::Dotenv
+    end
+  end
+end

data/spec/lib/stairs/script_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+describe Stairs::Script do
+  let(:filename) { "setup.rb" }
+  subject { described_class.new(filename) }
+
+  context "with a script present" do
+    before do
+      File.open(filename, "w") do |file|
+        file.write("self.class")
+      end
+    end
+
+    after { File.delete(filename) }
+
+    describe "#run!" do
+      it "outputs running message" do
+        output = capture_stdout { subject.run! }
+        expect(output).to include "= Running script setup.rb"
+      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:
+        expect(subject.run!).to eq Stairs::Step
+      end
+    end
+  end
+end

data/spec/lib/stairs/step_spec.rb

@@ -0,0 +1,293 @@
+require "spec_helper"
+
+describe Stairs::Step do
+  let(:anon_step) { Class.new(described_class) }
+  subject { anon_step.new }
+
+  describe "metadata" do
+    describe "step_title" do
+      it "can be set on the class using title class DSL" do
+        anon_step.title "Class Step Name"
+        expect(subject.step_title).to eq "Class Step Name"
+      end
+
+      it "can be set on the instance" do
+        subject.step_title = "Instance Step Name"
+        expect(subject.step_title).to eq "Instance Step Name"
+      end
+
+      it "prefers the value set on instance" do
+        anon_step.title "Class Step Name"
+        subject.step_title = "Instance Step Name"
+        expect(subject.step_title).to eq "Instance Step Name"
+      end
+    end
+
+    describe "step_description" do
+      it "can be set on the class using description class DSL" do
+        anon_step.description "Class Step Description"
+        expect(subject.step_description).to eq "Class Step Description"
+      end
+
+      it "can be set on the instance" do
+        subject.step_description = "Instance Step Description"
+        expect(subject.step_description).to eq "Instance Step Description"
+      end
+
+      it "prefers the value set on instance" do
+        anon_step.title "Class Step Description"
+        subject.step_description = "Instance Step Description"
+        expect(subject.step_description).to eq "Instance Step Description"
+      end
+    end
+  end
+
+  describe "#run!" do
+    before { subject.stub run: true }
+    before { anon_step.title "Step Name" }
+
+    it "outputs lead-in message" do
+      output = capture_stdout { subject.run! }
+      expect(output).to include "== Running Step Name"
+    end
+
+    it "calls #run where the implementation lives" do
+      subject.should_receive(:run)
+      subject.run!
+    end
+
+    it "outputs completed message" do
+      output = capture_stdout { subject.run! }
+      expect(output).to include "== Completed Step Name"
+    end
+  end
+
+  describe "#provide" do
+    it "prompts the user to provide input" do
+      output = follow_prompts("here") { subject.provide "Gimme" }
+      expect(output).to include "Gimme: "
+    end
+
+    it "returns the input" do
+      follow_prompts("here") do
+        expect(subject.provide("Gimme")).to eq "here"
+      end
+    end
+
+    it "requires user input" do
+      follow_prompts "", "", "", "finally" do
+        expect(subject.provide("Gimme")).to eq "finally"
+      end
+    end
+
+    context "with a default" do
+      def call_method
+        subject.provide "Gimme", default: "adefault"
+      end
+
+      it "does not require input" do
+        output = follow_prompts("here") { call_method }
+      end
+
+      context "and required" do
+        it "does not require input" do
+          follow_prompts "" do
+            expect(subject.provide("Gimme", required: true, default: "adefault")).to eq "adefault"
+          end
+        end
+      end
+
+      context "with no input" do
+        it "returns the default" do
+          follow_prompts("") do
+            expect(call_method).to eq "adefault"
+          end
+        end
+      end
+
+      context "with input" do
+        it "returns the input" do
+          follow_prompts("here") do
+            expect(call_method).to eq "here"
+          end
+        end
+      end
+    end
+
+    context "optional" do
+      it "does not require input" do
+        follow_prompts "" do
+          expect(subject.provide("Gimme", required: false)).to eq nil
+        end
+      end
+    end
+  end
+
+  describe "#choice" do
+    it "prompts the user to answer the question" do
+      output = follow_prompts("Y") { subject.choice("Should I?") }
+      expect(output).to include "Should I?"
+    end
+
+    it "defaults to a Y/N question" do
+      output = follow_prompts("Y") { subject.choice("Should I?") }
+      expect(output).to include "(Y/N)"
+    end
+
+    it "returns true for Y" do
+      follow_prompts("Y") { expect(subject.choice("Should I?")).to be_true }
+    end
+
+    it "returns true for Y" do
+      follow_prompts("N") { expect(subject.choice("Should I?")).to be_false }
+    end
+
+    context "with available choices provided" do
+      it "displays those choices" do
+        output = follow_prompts("Nick") { subject.choice("What's your name?", ["Nick", "Brendan"]) }
+        expect(output).to include "(Nick/Brendan)"
+      end
+
+      it "returns the user's choice" do
+        follow_prompts("Nick") do
+          expect(subject.choice("What's your name?", ["Nick", "Brendan"])).to eq "Nick"
+        end
+      end
+
+      it "prompts repeatedly until it receives input in available choices" do
+        follow_prompts("Sally", "Frank", "Nick") do
+          expect(subject.choice("What's your name?", ["Nick", "Brendan"])).to eq "Nick"
+        end
+      end
+    end
+
+    context "with a block" do
+      it "calls the block with the user's choice" do
+        follow_prompts("Nick") do
+          expect do |block|
+            subject.choice("What's your name?", ["Nick", "Brendan"], &block)
+          end.to yield_with_args("Nick")
+        end
+      end
+    end
+  end
+
+  describe "#bundle" do
+    before { subject.stub system: true }
+
+    it "outputs lead-in message" do
+      output = capture_stdout { subject.bundle }
+      expect(output).to include "== Running bundle"
+    end
+
+    it "runs bundle" do
+      subject.should_receive(:system).with("bundle")
+      subject.bundle
+    end
+
+    it "outputs completed message" do
+      output = capture_stdout { subject.bundle }
+      expect(output).to include "== Completed bundle"
+    end
+  end
+
+  describe "#rake" do
+    before { subject.stub system: true }
+
+    it "outputs lead-in message" do
+      output = capture_stdout { subject.rake "the_task" }
+      expect(output).to include "== Running the_task"
+    end
+
+    it "runs the rake task" do
+      subject.should_receive(:system).with("rake the_task")
+      subject.rake "the_task"
+    end
+
+    it "outputs completed message" do
+      output = capture_stdout { subject.rake "the_task" }
+      expect(output).to include "== Completed the_task"
+    end
+  end
+
+  describe "#env" do
+    let(:adapter) { double("adapter", set: true) }
+    before { Stairs.configuration.env_adapter = adapter }
+
+    it "delegates to the adapter" do
+      adapter.should_receive(:set).with("NAME", "value")
+      subject.env "NAME", "value"
+    end
+
+    it "writes to ENV simultaneously so Rubyland can access without a reload" do
+      ENV.should_receive(:[]=).with("NAME", "value")
+      subject.env "NAME", "value"
+    end
+  end
+
+  describe "#write" do
+    it "delegates to the well tested FileMutation util" do
+      Stairs::Util::FileMutation.should_receive(:write).with("something", "file.txt")
+      subject.write("something", "file.txt")
+    end
+  end
+
+  describe "#write_line" do
+    it "delegates to the well tested FileMutation util" do
+      Stairs::Util::FileMutation.should_receive(:write_line).with("something", "file.txt")
+      subject.write_line("something", "file.txt")
+    end
+  end
+
+  describe "#finish" do
+    it "outputs lead-in message" do
+      output = capture_stdout { subject.finish "Message" }
+      expect(output).to include "== All done!"
+    end
+
+    it "outputs supplied message" do
+      output = capture_stdout { subject.finish "My message" }
+      expect(output).to include "My message"
+    end
+  end
+
+  describe "#stairs_info" do
+    it "outputs the message" do
+      output = capture_stdout { subject.stairs_info "Ohai" }
+      expect(output).to include "Ohai"
+    end
+  end
+
+  describe "#setup" do
+    context "with an invalid step_name" do
+      it "raises when step_name cannot be resolved in Stairs::Steps" do
+        expect { subject.setup :blahblahbefkj }.to raise_error
+      end
+    end
+
+    context "with a valid step_name" do
+      let!(:mock_step_class) { Stairs::Steps::MockStep = Class.new(Stairs::Step) }
+
+      it "instantiates and runs the step" do
+        mock_step_class.any_instance.should_receive(:run!)
+        subject.setup :mock_step
+      end
+    end
+
+    context "with a block" do
+      def call_method
+        subject.setup(:custom_step) { puts "I'm running in #{self.class}" }
+      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"
+      end
+
+      it "runs the block in the context of the new step" do
+        output = capture_stdout { call_method }
+        expect(output).to include "I'm running in Stairs::Step"
+      end
+    end
+  end
+end

data/spec/lib/stairs/steps/secret_token_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+describe Stairs::Steps::SecretToken do
+  subject { described_class.new }
+
+  describe "#run" do
+    it "generates a securerandom hex and sets to SECRET_TOKEN" do
+      SecureRandom.stub hex: "imtotallysecurebro"
+      subject.should_receive(:env).with("SECRET_TOKEN", "imtotallysecurebro")
+      subject.run
+    end
+  end
+end

data/spec/lib/stairs/util/cli_spec.rb

@@ -0,0 +1,57 @@
+require "spec_helper"
+
+describe Stairs::Util::CLI do
+  subject { described_class }
+
+  describe ".get" do
+    it "outputs the prompt to screen" do
+      output = follow_prompts("test") { subject.get("itefeffe") }
+      expect(output).to include "itefeffe"
+    end
+
+    it "collects and returns trimmed input" do
+      follow_prompts "test" do
+        expect(subject.get("it")).to eq "test"
+      end
+    end
+
+    it "returns nil for empty input" do
+      follow_prompts "" do
+        expect(subject.get("it")).to eq nil
+      end
+    end
+  end
+
+  describe ".collect" do
+    it "returns the user provided input" do
+      follow_prompts "test" do
+        expect(subject.collect("itefeffe")).to eq "test"
+      end
+    end
+
+    context "required" do
+      it "repeatedly prompts until a non-empty value is received" do
+        follow_prompts "", "", "", "finally" do
+          expect(subject.collect("a value")).to eq "finally"
+        end
+      end
+    end
+
+    context "not required" do
+      it "returns nil for empty input" do
+        follow_prompts "" do
+          expect(subject.collect("gimme", required: false)).to eq nil
+        end
+      end
+    end
+
+    context "with custom validation block" do
+      it "repeatedly prompts until a valid value is received" do
+        follow_prompts "", "", "wrong", "right" do
+          response = subject.collect("a value") { |v, i| v == "right" }
+          expect(response).to eq "right"
+        end
+      end
+    end
+  end
+end

data/spec/lib/stairs/util/file_mutation_spec.rb

@@ -0,0 +1,98 @@
+require "spec_helper"
+
+describe Stairs::Util::FileMutation do
+  let(:filename) { "file.txt" }
+
+  describe ".replace_or_append" do
+    context "when the pattern exists in the file" do
+      before do
+        File.open(filename, "w") do |file|
+          file.write("line1\nline2\nline3\n")
+        end
+      end
+
+      after { File.delete(filename) }
+
+      it "replaces the match and writes back to the file" do
+        described_class.replace_or_append /line2/, "newLINE2", filename
+        expect(File.read(filename)).to eq "line1\nnewLINE2\nline3\n"
+      end
+    end
+
+    context "when the pattern does not exist in the file" do
+      before do
+        File.open(filename, "w") do |file|
+          file.write("line1\nline2\nline3\n")
+        end
+      end
+
+      after { File.delete(filename) }
+
+      it "appends to the end of the file" do
+        described_class.replace_or_append /line4/, "line4", filename
+        expect(File.read(filename)).to eq "line1\nline2\nline3\nline4\n"
+      end
+    end
+  end
+
+  describe ".write_line" do
+    before do
+      File.open(filename, "w") do |file|
+        file.write("line1\nline2\n")
+      end
+    end
+
+    after { File.delete(filename) }
+
+    it "appends a line to the bottom of the file" do
+      described_class.write_line "line3", filename
+      expect(File.read(filename)).to eq "line1\nline2\nline3\n"
+    end
+
+    context "when there is no newline at the bottom" do
+      before do
+        File.delete(filename) if File.exists?(filename)
+
+        File.open(filename, "w") do |file|
+          file.write("line1\nline2")
+        end
+      end
+
+      it "adds a newline before appending the line" do
+        described_class.write_line "line3", filename
+        expect(File.read(filename)).to eq "line1\nline2\nline3\n"
+      end
+    end
+  end
+
+  describe ".write" do
+    context "when the file exists" do
+      before do
+        File.open(filename, "w") do |file|
+          file.write("some content\n")
+        end
+      end
+
+      after { File.delete(filename) }
+
+      it "replaces the contents of the file and leaves trailing newline" do
+        described_class.write "new content", filename
+        expect(File.read(filename)).to eq "new content\n"
+      end
+    end
+
+    context "when the file doesn't exist" do
+      after { File.delete(filename) }
+
+      it "creates a file" do
+        described_class.write "other content", filename
+        expect(File.exists?(filename)).to be_true
+      end
+
+      it "writes the contents to the file" do
+        described_class.write "my favorite content", filename
+        expect(File.read(filename)).to eq "my favorite content\n"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require "bundler"
+Bundler.require
+
+require "stairs"
+
+Dir["./spec/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.include MockStdIO
+
+  config.before(:all, &:silence_output)
+  config.after(:all, &:enable_output)
+end

data/spec/support/mock_stdout.rb

@@ -0,0 +1,52 @@
+require "stringio"
+
+module MockStdIO
+  def follow_prompts(*responses, &block)
+    old_stdin = $stdin
+    old_stdout = $stdout
+
+    $stdin = StringIO.new("", "r+")
+    fake_stdout = StringIO.new
+    $stdout = fake_stdout
+
+    responses.each { |r| $stdin << "#{r}\n" }
+    $stdin.rewind
+
+    block.call
+
+    fake_stdout.string
+  ensure
+    $stdin = old_stdin
+    $stdout = old_stdout
+  end
+
+  def capture_stdout(&block)
+    old_stdout = $stdout
+
+    fake_stdout = StringIO.new
+    $stdout = fake_stdout
+
+    block.call
+
+    fake_stdout.string
+  ensure
+    $stdout = old_stdout
+  end
+
+  def silence_output
+    @orig_stderr = $stderr
+    @orig_stdout = $stdout
+
+    # redirect stderr and stdout to /dev/null
+    $stderr = File.new("/dev/null", "w")
+    $stdout = File.new("/dev/null", "w")
+  end
+
+  # Replace stdout and stderr so anything else is output correctly.
+  def enable_output
+    $stderr = @orig_stderr
+    $stdout = @orig_stdout
+    @orig_stderr = nil
+    @orig_stdout = nil
+  end
+end

data/stairs.gemspec

@@ -20,8 +20,15 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+  spec.add_development_dependency "guard-rspec", "~> 4.0.3"
+  spec.add_development_dependency "rb-fsevent", "~> 0.9.3"
+  spec.add_development_dependency "awesome_print", "~> 1.2.0"
+  spec.add_development_dependency "fakefs", "~> 0.4.3"
+  spec.add_development_dependency "rubocop", "~> 0.14.1"
+  spec.add_development_dependency "guard-rubocop", "~> 1.0.0"
 
-  spec.add_dependency "highline", "~> 1.6.20"
   spec.add_dependency "activesupport", ">= 3.2.0"
   spec.add_dependency "colorize", "~> 0.6.0"
 end