stairs 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5757c8d2dd7a6f123729557b5ccf99f292f75a9f
-  data.tar.gz: 1a208a280bc33d113efc36aadc00e07213931887
+  metadata.gz: cb094a690ad438125715b25683b2d11f176432ed
+  data.tar.gz: d3eb3604d83427287293ecac50daf8ed6a5ea841
 SHA512:
-  metadata.gz: 52a26152b30d4289ac3e73b49dd33ade9ccf9270df0e6b2802f230966a223b3df34902d6cfe07efd9b9962d6b1d33c7aec51fbc13fa89874ea14c204ed5f3ddd
-  data.tar.gz: 0f39e7ab93a8335c98c7a4e1cc186882c6ba49c8c92ad5698c97aac57eeb9bc75e9c622196e97af35cf864a5428eb387873c8392e25f8f313f97c020aca86978
+  metadata.gz: 54186ff0a046b2dcbe68fb116a6915ffb7cc350105c0e633e62ff05d37460f705a2c08334c542195ddc1a7b1cfdfb14613aaf60e18f2839f5a7d66d3b381f07c
+  data.tar.gz: 6c5e729f8a7e3b8df3c5f5b0fe9c20264c9b95e688ba43e435f747cafade1426084cb81029ea59f3b3f3ad570154c43c68b3ac990589bf9d00b4c4e3e343cac4

data/.rubocop.yml

@@ -32,6 +32,10 @@ SpecialGlobalVars:
 CollectionMethods:
   Enabled: false
 
+# Cuz we don't use any fancy characters anyway
+Encoding:
+  Enabled: false
+
 # I just don't care so much about clean specs.. Like short methods and short lines
 AllCops:
   Excludes:

data/Guardfile

@@ -5,6 +5,6 @@ guard "rspec" do
 end
 
 guard :rubocop do
-  watch(%r{.+\.rb$})
+  watch(%r{^lib/(.+)\.rb$})
   watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
 end

data/README.md

@@ -43,8 +43,7 @@ $ rake newb
 
 ## Defining scripts
 
-A script composes many steps that setup a project. __Note:__ optional steps are
-not yet implemented.
+A script composes many steps that setup a project.
 
 ```ruby
 bundle
@@ -55,7 +54,7 @@ setup :s3
 setup :zencoder, required: false
 
 setup :misc do
-  env "CHECK_IT", provide "Cool check it value"
+  env "CHECK_IT", provide("Cool check it value")
 end
 
 rake "db:setup"
@@ -65,38 +64,30 @@ finish "Just run rails s and sidekiq to get rolling!"
 
 ### Example CLI
 
-Given the above script, the CLI might look like this. __Note:__ some of this
-is desired future functionality (bundle/db tasks, spacing, last words).
+Given the above script, the CLI might look like this.
 
 ```
 $ rake newb
 Looks like you're using rbenv to manage environment variables. Is this correct? (Y/N): Y
-
 = Running script setup.rb
-
 == Running bundle
 ...
 == Completed bundle
-
 == Running S3
 AWS access key: 39u39d9u291
 AWS secret: 19jd920i10is0i01i0s01ks0kfknkje
 Do you have an existing bucket? (Y/N): Y
 Bucket name (leave blank for app-dev): my-cool-bucket
 == Completed S3
-
 == Starting Zencoder
 This step is optional, would you like to perform it? (Y/N): N
 == Completed Zencoder
-
 == Starting Misc
 Cool check it value: w00t
 == Completed Misc
-
 == Running db:setup
 ...
 == Completed db:setup
-
 == All done!
 Run rails s and sidekiq to get rolling!
 ```
@@ -106,7 +97,7 @@ Run rails s and sidekiq to get rolling!
 ### Collecting values
 ```ruby
 value = provide "Something"
-value = provide "Another", required: false # Not fully implemented
+value = provide "Another", required: false
 provide "More", default: "a-default"
 ```
 
@@ -158,6 +149,7 @@ end
 #### Using predefined steps (aka plugins)
 ```ruby
 setup :s3
+setup :facebook, required: false
 ```
 
 ## Plugins for common setups
@@ -175,9 +167,9 @@ setup :s3
 
 ### Defining custom plugins
 
-Steps inherit from `Stairs::Step`, have a title, description, and
-implement the `run` method. See those included and in the various
-extension gems for examples.
+Steps inherit from `Stairs::Step` and live in `Stairs::Steps`, have a title,
+description, and implement the `run` method. See those included and in the
+various extension gems for examples.
 
 ## Contributing
 

data/Rakefile

@@ -1,6 +1,8 @@
 require "bundler/gem_tasks"
-
 require "rspec/core/rake_task"
+require "rubocop/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
-task default: :spec
+Rubocop::RakeTask.new
+
+task default: [:spec, :rubocop]

data/lib/stairs/env_adapters/dotenv.rb

@@ -12,6 +12,10 @@ module Stairs
           ".env",
         )
       end
+
+      def unset(name)
+        Util::FileMutation.remove Regexp.new("^#{name}=(.*)\n"), ".env"
+      end
     end
   end
 end

data/lib/stairs/env_adapters/rbenv.rb

@@ -13,6 +13,10 @@ module Stairs
           ".rbenv-vars",
         )
       end
+
+      def unset(name)
+        Util::FileMutation.remove Regexp.new("^#{name}=(.*)\n"), ".rbenv-vars"
+      end
     end
   end
 end

data/lib/stairs/env_adapters/rvm.rb

@@ -13,6 +13,10 @@ module Stairs
           ".rvmrc",
         )
       end
+
+      def unset(name)
+        Util::FileMutation.remove Regexp.new("^export #{name}=(.*)\n"), ".rvmrc"
+      end
     end
   end
 end

data/lib/stairs/step.rb

@@ -1,8 +1,14 @@
 module Stairs
   class Step
+    attr_reader :options
+
+    def initialize(options={})
+      @options = options.reverse_merge required: true
+    end
+
     def run!
       stairs_info "== Running #{step_title}"
-      run
+      run if run_step?
       stairs_info "== Completed #{step_title}"
     end
 
@@ -58,7 +64,12 @@ module Stairs
     # Set or update env var
     def env(name, value)
       ENV[name] = value
-      Stairs.configuration.env_adapter.set name, value
+
+      if value
+        Stairs.configuration.env_adapter.set name, value
+      else
+        Stairs.configuration.env_adapter.unset name
+      end
     end
 
     # Replace contents of file
@@ -74,15 +85,15 @@ module Stairs
     # Embed a step where step_name is a symbol that can be resolved to a class
     # in Stairs::Steps or a block is provided to be executed in an instance
     # of Step
-    def setup(step_name, &block)
+    def setup(step_name, options={}, &block)
       if block_given?
-        Step.new.tap do |step|
+        Step.new(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.run!
+        klass.new(options).run!
       end
     end
 
@@ -97,6 +108,11 @@ module Stairs
 
     private
 
+    def run_step?
+      return true if options[:required]
+      choice "This step is optional, would you like to perform it?"
+    end
+
     class Choice
       # TODO: shouldn't care about case?
       def initialize(question, choices=%w[Y N], &block)

data/lib/stairs/util/file_mutation.rb

@@ -5,7 +5,7 @@ module Stairs
         def replace_or_append(pattern, string, filename)
           if File.exists? filename
             contents = File.read filename
-            if contents.index pattern
+            if contents =~ pattern
               contents.sub! pattern, string
               write contents, filename
               return
@@ -15,11 +15,21 @@ module Stairs
           write_line string, filename
         end
 
+        def remove(pattern, filename)
+          return unless File.exists? filename
+
+          contents = File.read filename
+          if contents =~ pattern
+            contents.slice!(pattern)
+            write contents, filename
+          end
+        end
+
         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 }
-            file.puts "" unless last_line.index /(.*)\n/
+            file.puts "" unless last_line == "" || last_line =~ /(.*)\n/
 
             file.puts string
           end

data/lib/stairs/version.rb

@@ -1,3 +1,3 @@
 module Stairs
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/spec/lib/stairs/env_adapters/dotenv_spec.rb

@@ -35,4 +35,14 @@ describe Stairs::EnvAdapters::Dotenv do
       subject.set(name, value)
     end
   end
-end
+
+  describe "#unset" do
+    it "delegates to the well tested FileMutation util" do
+      Stairs::Util::FileMutation.should_receive(:remove).with(
+        Regexp.new("^SOMETHING=(.*)\n"),
+        ".env",
+      )
+      subject.unset "SOMETHING"
+    end
+  end
+end

data/spec/lib/stairs/env_adapters/rbenv_spec.rb

@@ -37,4 +37,14 @@ describe Stairs::EnvAdapters::Rbenv do
       subject.set(name, value)
     end
   end
-end
+
+  describe "#unset" do
+    it "delegates to the well tested FileMutation util" do
+      Stairs::Util::FileMutation.should_receive(:remove).with(
+        Regexp.new("^SOMETHING=(.*)\n"),
+        ".rbenv-vars",
+      )
+      subject.unset "SOMETHING"
+    end
+  end
+end

data/spec/lib/stairs/env_adapters/rvm_spec.rb

@@ -37,4 +37,14 @@ describe Stairs::EnvAdapters::RVM do
       subject.set(name, value)
     end
   end
-end
+
+  describe "#unset" do
+    it "delegates to the well tested FileMutation util" do
+      Stairs::Util::FileMutation.should_receive(:remove).with(
+        Regexp.new("^export SOMETHING=(.*)\n"),
+        ".rvmrc",
+      )
+      subject.unset "SOMETHING"
+    end
+  end
+end

data/spec/lib/stairs/step_spec.rb

@@ -42,6 +42,23 @@ describe Stairs::Step do
     end
   end
 
+  describe "options" do
+    describe "default options" do
+      it "is required" do
+        expect(subject.options[:required]).to be_true
+      end
+    end
+
+    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"
+      end
+    end
+  end
+
   describe "#run!" do
     before { subject.stub run: true }
     before { anon_step.title "Step Name" }
@@ -60,6 +77,30 @@ describe Stairs::Step do
       output = capture_stdout { subject.run! }
       expect(output).to include "== Completed Step Name"
     end
+
+    context "when the step is not required" do
+      subject { anon_step.new required: false }
+      before { subject.stub run: true }
+
+      it "prompts the user to decide if we should run the step" do
+        output = follow_prompts("Y") { subject.run! }
+        expect(output).to include "This step is optional, would you like to perform it? (Y/N): "
+      end
+
+      context "user says yes" do
+        it "runs the step" do
+          subject.should_receive :run
+          follow_prompts("Y") { subject.run! }
+        end
+      end
+
+      context "user says no" do
+        it "doesn't run the step" do
+          subject.should_not_receive :run
+          follow_prompts("N") { subject.run! }
+        end
+      end
+    end
   end
 
   describe "#provide" do
@@ -214,7 +255,7 @@ describe Stairs::Step do
     let(:adapter) { double("adapter", set: true) }
     before { Stairs.configuration.env_adapter = adapter }
 
-    it "delegates to the adapter" do
+    it "delegates to the adapter's set" do
       adapter.should_receive(:set).with("NAME", "value")
       subject.env "NAME", "value"
     end
@@ -223,6 +264,13 @@ describe Stairs::Step do
       ENV.should_receive(:[]=).with("NAME", "value")
       subject.env "NAME", "value"
     end
+
+    context "with no value" do
+      it "delegates to the adapter's unset" do
+        adapter.should_receive(:unset).with("NAME")
+        subject.env "NAME", nil
+      end
+    end
   end
 
   describe "#write" do
@@ -272,6 +320,16 @@ describe Stairs::Step do
         mock_step_class.any_instance.should_receive(:run!)
         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
+          subject.setup :mock_step, options
+        end
+      end
     end
 
     context "with a block" do
@@ -288,6 +346,18 @@ describe Stairs::Step do
         output = capture_stdout { call_method }
         expect(output).to include "I'm running in Stairs::Step"
       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
+
+          described_class.should_receive(:new).with(options).and_call_original
+          subject.setup(:custom_step, options) { true }
+        end
+      end
     end
   end
-end
+end

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

@@ -35,6 +35,41 @@ describe Stairs::Util::FileMutation do
     end
   end
 
+  describe ".remove" do
+    before do
+      File.open(filename, "w") do |file|
+        file.write "VAR_1=hey\nVAR_2=hello\nVAR_3=hi\n"
+      end
+    end
+
+    context "when the pattern exists in file" do
+      it "removes the match from the file" do
+        subject.remove /^VAR_2=(.*)\n/, filename
+        expect(File.read(filename)).to eq "VAR_1=hey\nVAR_3=hi\n"
+      end
+
+      context "and is the last line without a trailing newline" do
+        before do
+          File.open(filename, "w+") do |file|
+            file.write "VAR_1=hey\nVAR_2=hello\nVAR_3=hi"
+          end
+
+          it "still matches and removes it" do
+            subject.remove /^VAR_3=(.*)\n/, filename
+            expect(File.read(filename)).to eq "VAR_1=hey\nVAR_2=hello\n"
+          end
+        end
+      end
+    end
+
+    context "when the pattern does not exist in file" do
+      it "leaves the file untouched" do
+        subject.remove /^VAR_2=(.*)\n/, filename
+        expect(File.read(filename)).to eq "VAR_1=hey\nVAR_3=hi\n"
+      end
+    end
+  end
+
   describe ".write_line" do
     before do
       File.open(filename, "w") do |file|
@@ -51,9 +86,7 @@ describe Stairs::Util::FileMutation do
 
     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.open(filename, "w+") do |file|
           file.write("line1\nline2")
         end
       end
@@ -63,6 +96,19 @@ describe Stairs::Util::FileMutation do
         expect(File.read(filename)).to eq "line1\nline2\nline3\n"
       end
     end
+
+    context "when the file is empty" do
+      before do
+        File.open filename, "w+" do |file|
+          file.write ""
+        end
+      end
+
+      it "writes to the first line of the line" do
+        described_class.write_line "line1", filename
+        expect(File.read(filename)).to eq "line1\n"
+      end
+    end
   end
 
   describe ".write" do
@@ -95,4 +141,4 @@ describe Stairs::Util::FileMutation do
       end
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stairs
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - patbenatar