stairs 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad404f4b70626c2817effc44d7f1fc41499e31b7
-  data.tar.gz: dbd672eeff228973b99ce38f42dabe367716d831
+  metadata.gz: 3f7585f6811ddc955a889ce075fa31bc41435a88
+  data.tar.gz: c80320f149af4d28ec0d92cf92d8655f5e53f164
 SHA512:
-  metadata.gz: e8df3ad6375ce03deade1cb7018c61f1f7980cfc6aaefe94dcb0ea82c3c73a2988064035ac6d83b116232d73830f44daa62abb4eac6444366dd28601a2015ff6
-  data.tar.gz: 40ab4d5a13cb7d391969f9e632ea4b38311c59e2a095fc71f04bff1a460eb888e550d114b8bdd16cfd3bc5d59051102a5d322b49f5a711325718a47b0c76dd73
+  metadata.gz: 405fb108cd9ccb42df1829b31cd0980195818eecda482d67670a2ac36087b3e9652c00bb4b20c1952f48d0f485481bc92b55bc5862015583cd50b32a889d4272
+  data.tar.gz: de05b5f9ae3d57cdf3303b999cf14b11766caad3f2568a9d872c403cc3e780fe2c7eded0e463448856a1be34e0643d0f04d8cedcbb5c5d745f8a7507ddbd7461

data/.rubocop.yml

@@ -1,46 +1,13 @@
-StringLiterals:
-  EnforcedStyle: "double_quotes"
-
-LineLength:
-  Max: 80
-
-# This offends when not tabbed way out while using case in assignment
-CaseIndentation:
-  Enabled: false
-
-# Not a part of our coding conventions
 Documentation:
   Enabled: false
 
 DoubleNegation:
   Enabled: false
 
-TrailingComma:
-  EnforcedStyleForMultiline: comma
-
-DeprecatedClassMethods:
-  Enabled: false
-
-SingleLineBlockParams:
-  Enabled: false
-
-# Also just not something I've ever done or want to do...
-SpaceAroundEqualsInParameterDefault:
-  Enabled: false
-
-# I don't see why... It's shorthand, just know your ruby!
 SpecialGlobalVars:
   Enabled: false
 
-# This was offending for a custom method called `collect` not on an `Enumerable`
-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:
+BlockLength:
   Exclude:
-    - spec/**
+    - "spec/**/*"
+    - "stairs.gemspec"

data/.travis.yml

@@ -1,7 +1,11 @@
 language: ruby
 rvm:
-  - 2.0.0
-  - 1.9.3
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0
+install:
+  - gem update --system
+  - bundle install --jobs=3 --retry=3
 addons:
   code_climate:
     repo_token: 6b9b2949be0934c1ef9c1b4db4ec1568e616d56c9c493ff470fd70dda0d96a08

data/Guardfile

@@ -1,7 +1,7 @@
-guard "rspec" do
+guard 'rspec' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch("spec/spec_helper.rb") { "spec" }
+  watch('spec/spec_helper.rb') { 'spec' }
 end
 
 guard :rubocop do

data/Rakefile

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

data/bin/stairs

@@ -1,30 +1,30 @@
 #!/usr/bin/env ruby
 
-require "optparse"
-require "stairs"
+require 'optparse'
+require 'stairs'
 
 groups = nil
 
 Stairs.configure do |config|
   OptionParser.new do |options|
-    options.banner = "Usage: stairs [options]"
+    options.banner = 'Usage: stairs [options]'
 
-    options.on("--use-defaults", "Use defaults when available") do |value|
+    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",
+      '-g',
+      '--groups GROUPS',
+      'Specify groups to run. e.g. init,reset'
     ) do |value|
-      groups = value.split(",").map { |g| g.to_sym } if value
+      groups = value.split(',').map(&:to_sym) if value
     end
   end.parse!
 end
 
 # Load Rails environment if we're in Rails
-rails_application = File.expand_path("./config/application.rb")
-require rails_application if File.exists?(rails_application)
+rails_application = File.expand_path('./config/application.rb')
+require rails_application if File.exist?(rails_application)
 
 Stairs::Runner.new(groups).run!

data/lib/stairs.rb

@@ -1,17 +1,17 @@
-require "stairs/version"
-require "active_support"
-require "active_support/core_ext"
-require "colorize"
+require 'stairs/version'
+require 'active_support'
+require 'active_support/core_ext'
+require 'colorize'
 
 module Stairs
-  autoload :Step, "stairs/step"
-  autoload :Script, "stairs/script"
-  autoload :Steps, "stairs/steps"
-  autoload :EnvAdapters, "stairs/env_adapters"
-  autoload :Configuration, "stairs/configuration"
-  autoload :InteractiveConfiguration, "stairs/interactive_configuration"
-  autoload :Util, "stairs/util"
-  autoload :Runner, "stairs/runner"
+  autoload :Step, 'stairs/step'
+  autoload :Script, 'stairs/script'
+  autoload :Steps, 'stairs/steps'
+  autoload :EnvAdapters, 'stairs/env_adapters'
+  autoload :Configuration, 'stairs/configuration'
+  autoload :InteractiveConfiguration, 'stairs/interactive_configuration'
+  autoload :Util, 'stairs/util'
+  autoload :Runner, 'stairs/runner'
 
   class << self
     def configure
@@ -28,4 +28,4 @@ module Stairs
   end
 end
 
-require "stairs/railtie" if defined?(Rails)
+require 'stairs/railtie' if defined?(Rails)

data/lib/stairs/env_adapters.rb

@@ -1,17 +1,17 @@
 module Stairs
   module EnvAdapters
-    autoload :Rbenv, "stairs/env_adapters/rbenv"
-    autoload :RVM, "stairs/env_adapters/rvm"
-    autoload :Dotenv, "stairs/env_adapters/dotenv"
+    autoload :Rbenv, 'stairs/env_adapters/rbenv'
+    autoload :RVM, 'stairs/env_adapters/rvm'
+    autoload :Dotenv, 'stairs/env_adapters/dotenv'
 
     ADAPTERS = {
       dotenv: Dotenv,
       rbenv: Rbenv,
-      rvm: RVM,
-    }
+      rvm: RVM
+    }.freeze
 
     def self.recommended_adapter
-      ADAPTERS.values.find { |a| a.present? }
+      ADAPTERS.values.find(&:present?)
     end
 
     def self.name_for_adapter_class(adapter)

data/lib/stairs/env_adapters/dotenv.rb

@@ -2,19 +2,19 @@ module Stairs
   module EnvAdapters
     class Dotenv
       def self.present?
-        defined? ::Dotenv
+        !!defined?(::Dotenv)
       end
 
       def set(name, value)
         Util::FileMutation.replace_or_append(
           Regexp.new("^#{name}=(.*)$"),
           "#{name}=#{value}",
-          ".env",
+          '.env'
         )
       end
 
       def unset(name)
-        Util::FileMutation.remove Regexp.new("^#{name}=(.*)\n"), ".env"
+        Util::FileMutation.remove Regexp.new("^#{name}=(.*)\n"), '.env'
       end
     end
   end

data/lib/stairs/env_adapters/rbenv.rb

@@ -3,19 +3,19 @@ module Stairs
     class Rbenv
       def self.present?
         `which rbenv-vars`
-        $?.success?
+        $CHILD_STATUS.success?
       end
 
       def set(name, value)
         Util::FileMutation.replace_or_append(
           Regexp.new("^#{name}=(.*)$"),
           "#{name}=#{value}",
-          ".rbenv-vars",
+          '.rbenv-vars'
         )
       end
 
       def unset(name)
-        Util::FileMutation.remove Regexp.new("^#{name}=(.*)\n"), ".rbenv-vars"
+        Util::FileMutation.remove Regexp.new("^#{name}=(.*)\n"), '.rbenv-vars'
       end
     end
   end

data/lib/stairs/env_adapters/rvm.rb

@@ -3,19 +3,19 @@ module Stairs
     class RVM
       def self.present?
         `which rvm`
-        $?.success?
+        $CHILD_STATUS.success?
       end
 
       def set(name, value)
         Util::FileMutation.replace_or_append(
           Regexp.new("^export #{name}=(.*)$"),
           "export #{name}=#{value}",
-          ".rvmrc",
+          '.rvmrc'
         )
       end
 
       def unset(name)
-        Util::FileMutation.remove Regexp.new("^export #{name}=(.*)\n"), ".rvmrc"
+        Util::FileMutation.remove Regexp.new("^export #{name}=(.*)\n"), '.rvmrc'
       end
     end
   end

data/lib/stairs/interactive_configuration.rb

@@ -1,7 +1,7 @@
 module Stairs
   class InteractiveConfiguration < Stairs::Step
-    title "Configuration"
-    description "Interactive prompt for configuring Stairs"
+    title 'Configuration'
+    description 'Interactive prompt for configuring Stairs'
 
     def run!
       if Stairs.configuration.use_defaults
@@ -26,7 +26,7 @@ module Stairs
     end
 
     def select_env_adapter
-      choice "Which would you prefer?", adapter_names do |name|
+      choice 'Which would you prefer?', adapter_names do |name|
         adapter_class = Stairs::EnvAdapters::ADAPTERS[name.to_sym]
         Stairs.configuration.env_adapter = adapter_class.new
       end
@@ -45,9 +45,9 @@ module Stairs
     end
 
     def prompt
-      "".tap do |message|
+      ''.tap do |message|
         message << "Looks like you're using #{recommended_adapter_name} to "
-        message << "manage environment variables. Is this correct?"
+        message << 'manage environment variables. Is this correct?'
       end
     end
 
@@ -56,12 +56,12 @@ module Stairs
     end
 
     def require_installed_adapter!
-      unless recommended_adapter
-        abort <<-MSG
-          Please install a supported ENV variable manager:
-          #{adapter_names.join(", ")}
-        MSG
-      end
+      return if recommended_adapter
+
+      abort <<-MSG
+        Please install a supported ENV variable manager:
+        #{adapter_names.join(', ')}
+      MSG
     end
   end
 end

data/lib/stairs/railtie.rb

@@ -1,7 +1,7 @@
 module Stairs
   class Railtie < Rails::Railtie
     rake_tasks do
-      load "stairs/tasks.rb"
+      load 'stairs/tasks.rb'
     end
   end
 end

data/lib/stairs/runner.rb

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

data/lib/stairs/step.rb

@@ -36,12 +36,10 @@ module Stairs
     end
 
     # Prompt user to provide input
-    def provide(prompt, options={})
+    def provide(prompt, options = {})
       options.reverse_merge! required: true, default: nil
       required = options[:required] && !options[:default]
-
-      prompt << " (leave blank for #{options[:default]})" if options[:default]
-      prompt << ": "
+      prompt = "#{defaulted_prompt(prompt, options[:default])}: "
 
       if Stairs.configuration.use_defaults && options[:default]
         options[:default]
@@ -86,7 +84,7 @@ 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, options={}, &block)
+    def setup(step_name, options = {}, &block)
       if block_given?
         Step.new(groups, options).tap do |step|
           step.define_singleton_method :run, &block
@@ -103,7 +101,7 @@ module Stairs
     end
 
     def finish(message)
-      puts "== All done!".green
+      puts '== All done!'.green
       puts message.green
     end
 
@@ -115,12 +113,17 @@ module Stairs
 
     def run_step?
       return true if options[:required]
-      choice "This step is optional, would you like to perform it?"
+      choice 'This step is optional, would you like to perform it?'
+    end
+
+    def defaulted_prompt(prompt, default = nil)
+      return prompt if default.nil?
+      "#{prompt} (leave blank for #{default})"
     end
 
     class Choice
       # TODO: shouldn't care about case?
-      def initialize(question, choices=%w(Y N), &block)
+      def initialize(question, choices = %w(Y N), &block)
         @question = question
         @choices = choices
         @block = block
@@ -136,22 +139,22 @@ module Stairs
       attr_reader :question, :choices, :block
 
       def prompt
-        "#{question} (#{choices.join("/")}): "
+        "#{question} (#{choices.join('/')}): "
       end
 
       def processed_response
         @processed_response ||= case response
-        when "Y"
-          true
-        when "N"
-          false
-        else
-          response
-        end
+                                when 'Y'
+                                  true
+                                when 'N'
+                                  false
+                                else
+                                  response
+                                end
       end
 
       def response
-        @reponse ||= Stairs::Util::CLI.collect prompt.blue do |value, i|
+        @reponse ||= Stairs::Util::CLI.collect prompt.blue do |value, _i|
           choices.include? value
         end
       end

data/lib/stairs/steps.rb

@@ -1,7 +1,7 @@
 module Stairs
   module Steps
-    autoload :SecretKeyBase, "stairs/steps/secret_key_base"
-    autoload :Postgresql, "stairs/steps/postgresql"
-    autoload :Facebook, "stairs/steps/facebook"
+    autoload :SecretKeyBase, 'stairs/steps/secret_key_base'
+    autoload :Postgresql, 'stairs/steps/postgresql'
+    autoload :Facebook, 'stairs/steps/facebook'
   end
 end

data/lib/stairs/steps/facebook.rb

@@ -1,22 +1,22 @@
 module Stairs
   module Steps
     class Facebook < Stairs::Step
-      title "Facebook App"
-      description "Configure credentials for Facebook app"
+      title 'Facebook App'
+      description 'Configure credentials for Facebook app'
 
       def run
-        env id_name, provide("Facebook App ID")
-        env secret_name, provide("Facebook App Secret")
+        env id_name, provide('Facebook App ID')
+        env secret_name, provide('Facebook App Secret')
       end
 
       private
 
       def id_name
-        options[:app_id] || "FACEBOOK_ID"
+        options[:app_id] || 'FACEBOOK_ID'
       end
 
       def secret_name
-        options[:app_secret] || "FACEBOOK_SECRET"
+        options[:app_secret] || 'FACEBOOK_SECRET'
       end
     end
   end