stairs 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14d977e07291f0a8476d22451cd1855c86b0c16a
-  data.tar.gz: d3f3a5361958cab856dc009dd853cc266fb3fbee
+  metadata.gz: e22ee09384364f5f56adf9797d39f011a3cd9f99
+  data.tar.gz: a28246d9990d4e12ad7a7823ac386a3af1ef8d07
 SHA512:
-  metadata.gz: a3916c63010aac63cee506da23393c36dae632ec722fa8dc430ba32df5eef14b71da1b70e3ab1022e08b5df3d9062f2871af71dd7d1b87db2bd7fab80f698a2a
-  data.tar.gz: b4426ff951d58d03806047cf89bbf24fb42dd7ca5f66b78c2b79a5881128a30f4b2886b714b4acf496f2f9442ae0a68211404241166fc88fc787be7dd59faca6
+  metadata.gz: acecec427e75b4a218174046155a130837d6f69fd41b18ded6fe4b3de121088051b5339a4f107c83feb8d58c3435c05a10dff1cbbc8fc1a07b44d842fa1995d5
+  data.tar.gz: d0b036abcd2ea50371cf2ed69b6785f74ef79c0194b655c2e4604f9c6f9a9ecc310a20a2b9627eae1a37088a0874aa3595fc6a43e1eff20156f12111ba67ee8a

data/README.md

@@ -44,19 +44,29 @@ require "stairs/tasks"
 
 ## Usage
 
+### Basic
+
 In an app with a `setup.rb`, just run the rake task:
 
 ```
 $ rake newb
 ```
 
+### Advanced
+
+If you want more control, use the `stairs` command line utility:
+
+```
+$ stairs --help
+Usage: stairs [options]
+        --use-defaults               Use defaults when available
+```
+
 ## Defining scripts
 
 A script composes many steps that setup a project.
 
 ```ruby
-bundle
-
 setup :secret_token
 
 setup :s3
@@ -104,11 +114,6 @@ write_line "more: false", "config/settings.yml"
 
 ### Misc helpers
 
-Run bundle to install gems
-```ruby
-bundle
-```
-
 Run rake tasks
 ```ruby
 rake "task_name"
@@ -166,9 +171,6 @@ 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

data/bin/stairs

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "stairs"
+
+Stairs.configure do |config|
+  OptionParser.new do |options|
+    options.banner = "Usage: stairs [options]"
+
+    options.on("--use-defaults", "Use defaults when available") do |value|
+      config.use_defaults = value
+    end
+  end.parse!
+end
+
+Stairs::Runner.new.run!

data/lib/stairs/configuration.rb

@@ -1,5 +1,10 @@
 module Stairs
   class Configuration
     attr_accessor :env_adapter
+    attr_accessor :use_defaults
+
+    def initialize
+      self.use_defaults = false
+    end
   end
 end

data/lib/stairs/interactive_configuration.rb

@@ -4,9 +4,19 @@ module Stairs
     description "Interactive prompt for configuring Stairs"
 
     def run!
+      if Stairs.configuration.use_defaults
+        use_recommended_adapter!
+      else
+        configure_env_adapter
+      end
+    end
+
+    private
+
+    def configure_env_adapter
       choice prompt do |yes|
         if yes
-          Stairs.configuration.env_adapter = recommended_adapter.new
+          use_recommended_adapter!
         else
           choice "Which would you prefer?", adapter_names do |name|
             adapter_class = Stairs::EnvAdapters::ADAPTERS[name.to_sym]
@@ -16,7 +26,9 @@ module Stairs
       end
     end
 
-    private
+    def use_recommended_adapter!
+      Stairs.configuration.env_adapter = recommended_adapter.new
+    end
 
     def recommended_adapter
       @recommended_adapter ||= Stairs::EnvAdapters.recommended_adapter

data/lib/stairs/runner.rb

@@ -0,0 +1,8 @@
+module Stairs
+  class Runner
+    def run!
+      Stairs::InteractiveConfiguration.new.run!
+      Stairs::Script.new("setup.rb").run!
+    end
+  end
+end

data/lib/stairs/step.rb

@@ -40,8 +40,12 @@ module Stairs
       prompt << " (leave blank for #{options[:default]})" if options[:default]
       prompt << ": "
 
-      Stairs::Util::CLI.collect(prompt.blue, required: required) ||
+      if Stairs.configuration.use_defaults && options[:default]
         options[:default]
+      else
+        Stairs::Util::CLI.collect(prompt.blue, required: required) ||
+          options[:default]
+      end
     end
 
     # Prompt user to make a choice
@@ -49,12 +53,6 @@ module Stairs
       Choice.new(*args, &block).run
     end
 
-    def bundle
-      stairs_info "== Running bundle"
-      system "bundle"
-      stairs_info "== Completed bundle"
-    end
-
     def rake(task)
       stairs_info "== Running #{task}"
       system "rake #{task}"

data/lib/stairs/tasks.rb

@@ -7,8 +7,7 @@ module Stairs
     def install!
       desc "Setup the project"
       task :newb do
-        Stairs::InteractiveConfiguration.new.run!
-        Stairs::Script.new("setup.rb").run!
+        Stairs::Runner.new.run!
       end
     end
   end

data/lib/stairs/version.rb

@@ -1,3 +1,3 @@
 module Stairs
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

data/lib/stairs.rb

@@ -10,6 +10,7 @@ module Stairs
   autoload :Configuration, "stairs/configuration"
   autoload :InteractiveConfiguration, "stairs/interactive_configuration"
   autoload :Util, "stairs/util"
+  autoload :Runner, "stairs/runner"
 
   class << self
     def configure
@@ -19,6 +20,10 @@ module Stairs
     def configuration
       @configuration ||= Configuration.new
     end
+
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
   end
 end
 

data/spec/lib/configuration_spec.rb

@@ -8,5 +8,16 @@ describe Stairs::Configuration do
       subject.env_adapter = "test"
       expect(subject.env_adapter).to eq "test"
     end
+
+    describe "use_defaults to automatically use default values" do
+      it "defaults to false" do
+        expect(subject.use_defaults).to eq false
+      end
+
+      it "allows for configuration" do
+        subject.use_defaults = true
+        expect(subject.use_defaults).to eq true
+      end
+    end
   end
-end
+end

data/spec/lib/stairs/interactive_configuration_spec.rb

@@ -32,5 +32,14 @@ describe Stairs::InteractiveConfiguration do
       follow_prompts("N", "dotenv") { subject.run! }
       expect(Stairs.configuration.env_adapter).to be_a Stairs::EnvAdapters::Dotenv
     end
+
+    context "when Stairs is configured to use defaults" do
+      before { Stairs.configuration.use_defaults = true }
+
+      it "uses the default adapter without asking" do
+        subject.run!
+        expect(Stairs.configuration.env_adapter).to be_a Stairs::EnvAdapters::Rbenv
+      end
+    end
   end
-end
+end

data/spec/lib/stairs/runner_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+
+describe Stairs::Runner do
+  describe "#run!" do
+    let(:script_double) { double("script", run!: true) }
+
+    before do
+      # Stub things as to not block IO
+      Stairs::InteractiveConfiguration.any_instance.stub :run!
+      Stairs::Script.any_instance.stub :run!
+      Stairs::Script.stub(:new).and_return(script_double)
+    end
+
+    it "runs the interactive configuration" do
+      Stairs::InteractiveConfiguration.any_instance.should_receive(:run!)
+      subject.run!
+    end
+
+    it "runs the setup.rb script" do
+      Stairs::Script.should_receive(:new).with("setup.rb").and_return(script_double)
+      script_double.should_receive(:run!)
+
+      subject.run!
+    end
+  end
+end

data/spec/lib/stairs/step_spec.rb

@@ -121,6 +121,24 @@ describe Stairs::Step do
       end
     end
 
+    context "Stairs is configured to use defaults automatically" do
+      before { Stairs.configuration.use_defaults = true }
+
+      context "but no default is provided" do
+        it "prompts for input as usual" do
+          follow_prompts "here ya go" do
+            expect(subject.provide("Gimme")).to eq "here ya go"
+          end
+        end
+      end
+
+      context "and a default is provided" do
+        it "returns the default without prompting" do
+          expect(subject.provide("Gimme", default: "adefault")).to eq "adefault"
+        end
+      end
+    end
+
     context "with a default" do
       def call_method
         subject.provide "Gimme", default: "adefault"
@@ -213,25 +231,6 @@ describe Stairs::Step do
     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 }
 

data/spec/spec_helper.rb

@@ -16,7 +16,9 @@ RSpec.configure do |config|
   config.filter_run :focus
 
   config.include MockStdio
+  config.include ConfigurationHelper
 
   config.before(:all, &:silence_output)
   config.after(:all, &:enable_output)
+  config.after(:each, &:reset_configuration)
 end

data/spec/support/configuration_helper.rb

@@ -0,0 +1,5 @@
+module ConfigurationHelper
+  def reset_configuration
+    Stairs.reset_configuration!
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stairs
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - patbenatar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-15 00:00:00.000000000 Z
+date: 2013-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -212,7 +212,8 @@ description: It's a pain to setup new developers. Stairs is a utility and framew
   prompts for everything else.
 email:
 - nick@gophilosophie.com
-executables: []
+executables:
+- stairs
 extensions: []
 extra_rdoc_files: []
 files:
@@ -225,6 +226,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/stairs
 - lib/stairs.rb
 - lib/stairs/configuration.rb
 - lib/stairs/env_adapters.rb
@@ -233,6 +235,7 @@ files:
 - lib/stairs/env_adapters/rvm.rb
 - lib/stairs/interactive_configuration.rb
 - lib/stairs/railtie.rb
+- lib/stairs/runner.rb
 - lib/stairs/script.rb
 - lib/stairs/step.rb
 - lib/stairs/steps.rb
@@ -250,12 +253,14 @@ files:
 - spec/lib/stairs/env_adapters/rvm_spec.rb
 - spec/lib/stairs/env_adapters_spec.rb
 - spec/lib/stairs/interactive_configuration_spec.rb
+- spec/lib/stairs/runner_spec.rb
 - spec/lib/stairs/script_spec.rb
 - spec/lib/stairs/step_spec.rb
 - spec/lib/stairs/steps/secret_token_spec.rb
 - spec/lib/stairs/util/cli_spec.rb
 - spec/lib/stairs/util/file_mutation_spec.rb
 - spec/spec_helper.rb
+- spec/support/configuration_helper.rb
 - stairs.gemspec
 - templates/postgresql/database.yml
 homepage: http://github.com/patbenatar/stairs
@@ -289,9 +294,11 @@ test_files:
 - spec/lib/stairs/env_adapters/rvm_spec.rb
 - spec/lib/stairs/env_adapters_spec.rb
 - spec/lib/stairs/interactive_configuration_spec.rb
+- spec/lib/stairs/runner_spec.rb
 - spec/lib/stairs/script_spec.rb
 - spec/lib/stairs/step_spec.rb
 - spec/lib/stairs/steps/secret_token_spec.rb
 - spec/lib/stairs/util/cli_spec.rb
 - spec/lib/stairs/util/file_mutation_spec.rb
 - spec/spec_helper.rb
+- spec/support/configuration_helper.rb