stairs 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7065dce0f1a914961380b69ee67aeab6ca1a3633
-  data.tar.gz: b9adf5378fc447b10dd8a4cb9e349b2d56faff3d
+  metadata.gz: 5757c8d2dd7a6f123729557b5ccf99f292f75a9f
+  data.tar.gz: 1a208a280bc33d113efc36aadc00e07213931887
 SHA512:
-  metadata.gz: 8838ad2217b046c6fcc40fa578df6ce8e6b282d1752224d76aab26ee437e08e72dc0b5d02af85cfddca0c9f103eedc4aebf907429928dd6c05ac94bc7d8b5cfc
-  data.tar.gz: f6ba56450cf0aafb9156f0ca625eadf3d3c4fa8374b6a25e3ea8a23489b5a932c6949b5c18a48062eb666c7df25a35e0e7218fd0429d7b863149ebb91881e281
+  metadata.gz: 52a26152b30d4289ac3e73b49dd33ade9ccf9270df0e6b2802f230966a223b3df34902d6cfe07efd9b9962d6b1d33c7aec51fbc13fa89874ea14c204ed5f3ddd
+  data.tar.gz: 0f39e7ab93a8335c98c7a4e1cc186882c6ba49c8c92ad5698c97aac57eeb9bc75e9c622196e97af35cf864a5428eb387873c8392e25f8f313f97c020aca86978

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rubocop.yml

@@ -0,0 +1,38 @@
+StringLiterals:
+  EnforcedStyle: "double_quotes"
+
+LineLength:
+  Max: 80
+
+# This offends when not tabbed way out while using case in assignment
+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
+
+# Not a part of our coding conventions
+Documentation:
+  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
+
+# I just don't care so much about clean specs.. Like short methods and short lines
+AllCops:
+  Excludes:
+    - spec/**

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3

data/Guardfile

@@ -0,0 +1,10 @@
+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" }
+end
+
+guard :rubocop do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/README.md

@@ -1,20 +1,37 @@
 # Stairs
 
-A DSL and collection of plugins for easy setup of projects on new development
-environments. Write a script that new devs can run for an interactive setup.
-For environment variables, Stairs supports rbenv-vars, RVM, and dotenv.
+It's a pain to setup new developers. Stairs is a utility and framework from
+which to write scripts for faster and easier setup of apps in new development
+environments. Scripts try to automate as much as possible and provide
+interactive prompts for everything else.
+
+Stairs currently supports writing environment variables for rbenv-vars, RVM,
+and dotenv.
+
+[![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)
 
 ## Setup
 
-1. Install gem `stairs`
+### Rails
+
+Add Stairs to your `Gemfile`:
 
-1. Require tasks in `Rakefile`
 ```ruby
-require "stairs/tasks"
+gem "stairs"
 ```
 
-1. [Define your script](#defining-scripts) in `setup.rb` at the root of your
-   project
+[Define your script](#defining-scripts) in `setup.rb` at the root of your
+project.
+
+### Not Rails
+
+Same as above, but you'll have to manually add the Stairs Rake tasks to your
+`Rakefile`.
+
+```ruby
+require "stairs/tasks"
+```
 
 ## Usage
 
@@ -172,4 +189,17 @@ extension gems for examples.
 
 [s3]: http://github.com/patbenatar/stairs-steps-s3
 [balanced]: http://github.com/patbenatar/stairs-steps-balanced
-[facebook]: http://github.com/patbenatar/stairs-steps-facebook
+[facebook]: http://github.com/patbenatar/stairs-steps-facebook
+
+## Credits
+
+### Contributors
+
+* [Nick Giancola](https://github.com/patbenatar)
+* [Brendan Loudermilk](https://github.com/bloudermilk)
+
+### Sponsor
+
+[![philosophie](http://patbenatar.github.io/showoff/images/philosophie.png)](http://gophilosophie.com)
+
+This gem is maintained partially during my open source time at [philosophie](http://gophilosophie.com).

data/Rakefile

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

data/lib/stairs/configuration.rb

@@ -2,4 +2,4 @@ module Stairs
   class Configuration
     attr_accessor :env_adapter
   end
-end
+end

data/lib/stairs/env_adapters/dotenv.rb

@@ -6,7 +6,7 @@ module Stairs
       end
 
       def set(name, value)
-        Util::FileUtils.replace_or_append(
+        Util::FileMutation.replace_or_append(
           Regexp.new("^#{name}=(.*)$"),
           "#{name}=#{value}",
           ".env",
@@ -14,4 +14,4 @@ module Stairs
       end
     end
   end
-end
+end

data/lib/stairs/env_adapters/rbenv.rb

@@ -7,7 +7,7 @@ module Stairs
       end
 
       def set(name, value)
-        Util::FileUtils.replace_or_append(
+        Util::FileMutation.replace_or_append(
           Regexp.new("^#{name}=(.*)$"),
           "#{name}=#{value}",
           ".rbenv-vars",
@@ -15,4 +15,4 @@ module Stairs
       end
     end
   end
-end
+end

data/lib/stairs/env_adapters/rvm.rb

@@ -7,7 +7,7 @@ module Stairs
       end
 
       def set(name, value)
-        Util::FileUtils.replace_or_append(
+        Util::FileMutation.replace_or_append(
           Regexp.new("^export #{name}=(.*)$"),
           "export #{name}=#{value}",
           ".rvmrc",
@@ -15,4 +15,4 @@ module Stairs
       end
     end
   end
-end
+end

data/lib/stairs/env_adapters.rb

@@ -15,7 +15,7 @@ module Stairs
     end
 
     def self.name_for_adapter_class(adapter)
-      ADAPTERS.find { |_n,a| a == adapter }.first
+      ADAPTERS.find { |_n, a| a == adapter }.first
     end
   end
-end
+end

data/lib/stairs/interactive_configuration.rb

@@ -4,19 +4,37 @@ module Stairs
     description "Interactive prompt for configuring Stairs"
 
     def run!
-      adapter_class = Stairs::EnvAdapters.recommended_adapter
-      adapter_name = Stairs::EnvAdapters.name_for_adapter_class(adapter_class)
-
-      choice "Looks like you're using #{adapter_name} to manage environment variables. Is this correct?" do |yes|
+      choice prompt do |yes|
         if yes
-          Stairs.configuration.env_adapter = adapter_class.new
+          Stairs.configuration.env_adapter = recommended_adapter.new
         else
-          choice "Which would you prefer?", Stairs::EnvAdapters::ADAPTERS.map { |n,_a| n.to_s } 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
         end
       end
     end
+
+    private
+
+    def recommended_adapter
+      @recommended_adapter ||= Stairs::EnvAdapters.recommended_adapter
+    end
+
+    def recommended_adapter_name
+      Stairs::EnvAdapters.name_for_adapter_class(recommended_adapter)
+    end
+
+    def prompt
+      "".tap do |message|
+        message << "Looks like you're using #{recommended_adapter_name} to "
+        message << "manage environment variables. Is this correct?"
+      end
+    end
+
+    def adapter_names
+      Stairs::EnvAdapters::ADAPTERS.map { |n, _a| n.to_s }
+    end
   end
-end
+end

data/lib/stairs/railtie.rb

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

data/lib/stairs/script.rb

@@ -10,12 +10,12 @@ module Stairs
       run
     end
 
+    private
+
     def run
       Step.new.instance_eval(script)
     end
 
-    private
-
     attr_reader :script, :filename
   end
-end
+end

data/lib/stairs/step.rb

@@ -1,5 +1,3 @@
-require "highline/import"
-
 module Stairs
   class Step
     def run!
@@ -10,8 +8,6 @@ module Stairs
 
     attr_writer :step_title, :step_description
 
-    private
-
     class_attribute :step_title, :step_description
 
     def self.title(title)
@@ -38,25 +34,13 @@ module Stairs
       prompt << " (leave blank for #{options[:default]})" if options[:default]
       prompt << ": "
 
-      response = ask(prompt.blue) { |q| q.validate = /\S+/ if required }
-      response.present? ? response : options[:default]
+      Stairs::Util::CLI.collect(prompt.blue, required: required) ||
+        options[:default]
     end
 
     # Prompt user to make a choice
-    # TODO shouldn't care about case
-    def choice(question, choices=["Y", "N"])
-      prompt = "#{question} (#{choices.join("/")}): "
-      response = ask(prompt.blue) { |q| q.in = choices }
-
-      case response
-      when "Y"
-        response = true
-      when "N"
-        response = false
-      end
-
-      yield response if block_given?
-      response
+    def choice(*args, &block)
+      Choice.new(*args, &block).run
     end
 
     def bundle
@@ -73,17 +57,18 @@ module Stairs
 
     # Set or update env var
     def env(name, value)
+      ENV[name] = value
       Stairs.configuration.env_adapter.set name, value
     end
 
     # Replace contents of file
     def write(string, filename)
-      Util::FileUtils.write(string, filename)
+      Util::FileMutation.write(string, filename)
     end
 
     # Append line to file
     def write_line(string, filename)
-      Util::FileUtils.write_line(string, filename)
+      Util::FileMutation.write_line(string, filename)
     end
 
     # Embed a step where step_name is a symbol that can be resolved to a class
@@ -109,5 +94,46 @@ module Stairs
     def stairs_info(message)
       puts message.light_black
     end
+
+    private
+
+    class Choice
+      # TODO: shouldn't care about case?
+      def initialize(question, choices=%w[Y N], &block)
+        @question = question
+        @choices = choices
+        @block = block
+      end
+
+      def run
+        block.call processed_response if block
+        processed_response
+      end
+
+      private
+
+      attr_reader :question, :choices, :block
+
+      def prompt
+        "#{question} (#{choices.join("/")}): "
+      end
+
+      def processed_response
+        @processed_response ||= case response
+        when "Y"
+          true
+        when "N"
+          false
+        else
+          response
+        end
+      end
+
+      def response
+        @reponse ||= Stairs::Util::CLI.collect prompt.blue do |value, i|
+          choices.include? value
+        end
+      end
+    end
   end
-end
+end

data/lib/stairs/steps/secret_token.rb

@@ -11,4 +11,4 @@ module Stairs
       end
     end
   end
-end
+end

data/lib/stairs/steps.rb

@@ -2,4 +2,4 @@ module Stairs
   module Steps
     autoload :SecretToken, "stairs/steps/secret_token"
   end
-end
+end

data/lib/stairs/tasks.rb

@@ -14,4 +14,4 @@ module Stairs
   end
 end
 
-Stairs::Tasks.new.install!
+Stairs::Tasks.new.install!

data/lib/stairs/util/cli.rb

@@ -0,0 +1,50 @@
+module Stairs
+  module Util
+    module CLI
+      class << self
+        def get(prompt)
+          print prompt
+          response = $stdin.gets.strip
+          response.present? ? response : nil
+        end
+
+        def collect(*args, &block)
+          Collector.new(*args, &block).run
+        end
+      end
+
+      private
+
+      class Collector
+        def initialize(prompt, options={}, &block)
+          @prompt = prompt
+          @options = options.reverse_merge required: true
+          @validator = block
+        end
+
+        def run
+          times, value = 0, nil
+
+          until valid?(value, times)
+            value = CLI.get(prompt.blue)
+            times += 1
+          end
+
+          value
+        end
+
+        private
+
+        def valid?(value, times)
+          if validator
+            validator.call(value, times)
+          else
+            !!value || (!options[:required] && times > 0)
+          end
+        end
+
+        attr_reader :prompt, :options, :validator
+      end
+    end
+  end
+end

data/lib/stairs/util/{file_utils.rb → file_mutation.rb}

@@ -1,6 +1,6 @@
 module Stairs
   module Util
-    module FileUtils
+    module FileMutation
       class << self
         def replace_or_append(pattern, string, filename)
           if File.exists? filename
@@ -16,16 +16,21 @@ module Stairs
         end
 
         def write_line(string, filename)
-          File.open filename, "a" do |file|
+          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 string
           end
         end
 
         def write(string, filename)
-          File.truncate filename, 0 if File.exists? filename
-          write_line string, filename
+          File.open filename, "w+" do |file|
+            file.puts string
+          end
         end
       end
     end
   end
-end
+end

data/lib/stairs/util.rb

@@ -1,5 +1,6 @@
 module Stairs
   module Util
-    autoload :FileUtils, "stairs/util/file_utils"
+    autoload :FileMutation, "stairs/util/file_mutation"
+    autoload :CLI, "stairs/util/cli"
   end
-end
+end

data/lib/stairs/version.rb

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

data/lib/stairs.rb

@@ -20,4 +20,6 @@ module Stairs
       @configuration ||= Configuration.new
     end
   end
-end
+end
+
+require "stairs/railtie" if defined?(Rails)

data/spec/lib/configuration_spec.rb

@@ -0,0 +1,12 @@
+require "spec_helper"
+
+describe Stairs::Configuration do
+  subject { described_class.new }
+
+  describe "attributes" do
+    it "allows for configuration of env_adapter" do
+      subject.env_adapter = "test"
+      expect(subject.env_adapter).to eq "test"
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+require "spec_helper"
+
+describe Stairs::EnvAdapters::Dotenv do
+  subject { described_class.new }
+
+  describe ".present?" do
+    context "when rvm is installed" do
+      before { stub_const "Dotenv", double("dotenv") }
+
+      it "returns true" do
+        expect(described_class.present?).to be_true
+      end
+    end
+
+    context "when rvm is not installed" do
+      before { Object.send(:remove_const, :Dotenv) if defined? ::Dotenv }
+
+      it "returns true" do
+        expect(described_class.present?).to be_false
+      end
+    end
+  end
+
+  describe "#set" do
+    it "delegates to the well tested FileMutation util" do
+      name = "VAR_NAME"
+      value = "the_value"
+
+      Stairs::Util::FileMutation.should_receive(:replace_or_append).with(
+        Regexp.new("^#{name}=(.*)$"),
+        "#{name}=#{value}",
+        ".env",
+      )
+
+      subject.set(name, value)
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+describe Stairs::EnvAdapters::Rbenv do
+  subject { described_class.new }
+
+  describe ".present?" do
+    before { described_class.should_receive(:`).with("which rbenv-vars") }
+
+    context "when rbenv-vars is installed" do
+      before { $?.stub success?: true }
+
+      it "returns true" do
+        expect(described_class.present?).to be_true
+      end
+    end
+
+    context "when rbenv-vars is not installed" do
+      before { $?.stub success?: false }
+
+      it "returns true" do
+        expect(described_class.present?).to be_false
+      end
+    end
+  end
+
+  describe "#set" do
+    it "delegates to the well tested FileMutation util" do
+      name = "VAR_NAME"
+      value = "the_value"
+
+      Stairs::Util::FileMutation.should_receive(:replace_or_append).with(
+        Regexp.new("^#{name}=(.*)$"),
+        "#{name}=#{value}",
+        ".rbenv-vars",
+      )
+
+      subject.set(name, value)
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+describe Stairs::EnvAdapters::RVM do
+  subject { described_class.new }
+
+  describe ".present?" do
+    before { described_class.should_receive(:`).with("which rvm") }
+
+    context "when rvm is installed" do
+      before { $?.stub success?: true }
+
+      it "returns true" do
+        expect(described_class.present?).to be_true
+      end
+    end
+
+    context "when rvm is not installed" do
+      before { $?.stub success?: false }
+
+      it "returns true" do
+        expect(described_class.present?).to be_false
+      end
+    end
+  end
+
+  describe "#set" do
+    it "delegates to the well tested FileMutation util" do
+      name = "VAR_NAME"
+      value = "the_value"
+
+      Stairs::Util::FileMutation.should_receive(:replace_or_append).with(
+        Regexp.new("^export #{name}=(.*)$"),
+        "export #{name}=#{value}",
+        ".rvmrc",
+      )
+
+      subject.set(name, value)
+    end
+  end
+end