stairs 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1035904a5f2df9f1310a2a7499500e6bb123589
-  data.tar.gz: b96bd24c537f525276cc2c585a12bc8372175e61
+  metadata.gz: f617dda7fd3f43d796cde18e6cd509b7556ea2f4
+  data.tar.gz: 8e2926466d8c307a8dbcd9be9a5a320e320495c5
 SHA512:
-  metadata.gz: 2c1fe6a87b3af48fb04782a2e773e4fa6284e23141fb34f38dd78e6aebeae835f459d75ad8e6b2f945ee0613701db1345fc83a97d990ee3dc9c3702a50292145
-  data.tar.gz: 05cdd22e964203a638fad22ba4e757bb479e1b54611aad59162caf8af8bdf2604527d3399bfa492aa8bba5aa0e571102479406698cdd694f9b963a1c7486b3fd
+  metadata.gz: eb0910186b1a3886ecff848942bb6c119cc58f7017fc74b0720ccf142aa0495eba3a0ba3461de3d9af65276fc3272da90b6d769067bc299b8525e35efe0ad9e2
+  data.tar.gz: fc18be8d140dbd7c1c1b07d3252f3b7a389e0826d855693120b86c6edc30a7fdb424a3fb9ab1f8d449eaa79aa59a5554bbdffc99eb1a2201066c3f1f08081978

data/README.md

@@ -1,13 +1,14 @@
 # Stairs
 
 A DSL and collection of plugins for easy setup of projects on new development
-environments.
+environments. Write a script that new devs can run for an interactive setup.
+For environment variables, Stairs supports rbenv-vars, RVM, and dotenv.
 
 ## Setup
 
 1. Install gem `stairs`
 
-1. Require tasks in Rakefile
+1. Require tasks in `Rakefile`
 ```ruby
 require "stairs/tasks"
 ```
@@ -41,7 +42,8 @@ puts "Sweet you're good to go. Just run `rails s` and `sidekiq` to get rolling!"
 
 ### Example CLI
 
-Given the above script, the CLI would look like this:
+Given the above script, the CLI might look like this. __Note:__ some of this
+is desired future functionality (bundle/db tasks, spacing, last words).
 
 ```
 $ rake newb
@@ -69,7 +71,7 @@ Run rails s and sidekiq to get rolling!
 ### Collecting values
 ```ruby
 value = provide "Something"
-value = provide "Another", required: false
+value = provide "Another", required: false # Not fully implemented
 provide "More", default: "a-default"
 ```
 
@@ -111,11 +113,16 @@ setup :s3
 
 ## Plugins for common setups
 
+### Built-in
 * `:secret_token` sets a secure random secret token
+
+### Available as extension gems
 * `:s3` interactive prompt for setting AWS + S3 bucket access credentials:
   [patbenatar/stairs-steps-s3][s3]
-* `:balanced`: automatically creates a test Marketplace on Balanced:
+* `:balanced` automatically creates a test Marketplace on Balanced:
   [patbenatar/stairs-steps-balanced][balanced]
+* `:facebook` interactive prompt for setting Facebook app credentials:
+  [patbenatar/stairs-steps-facebook][facebook]
 
 ### Defining custom plugins
 
@@ -132,4 +139,5 @@ extension gems for examples.
 5. Create new Pull Request
 
 [s3]: http://github.com/patbenatar/stairs-steps-s3
-[balanced]: http://github.com/patbenatar/stairs-steps-balanced
+[balanced]: http://github.com/patbenatar/stairs-steps-balanced
+[facebook]: http://github.com/patbenatar/stairs-steps-facebook

data/lib/stairs/configuration.rb

@@ -0,0 +1,5 @@
+module Stairs
+  class Configuration
+    attr_accessor :env_adapter
+  end
+end

data/lib/stairs/env_adapters/dotenv.rb

@@ -0,0 +1,17 @@
+module Stairs
+  module EnvAdapters
+    class Dotenv
+      def self.present?
+        defined? ::Dotenv
+      end
+
+      def set(name, value)
+        Util::FileUtils.replace_or_append(
+          Regexp.new("^#{name}=(.*)$"),
+          "#{name}=#{value}",
+          ".env",
+        )
+      end
+    end
+  end
+end

data/lib/stairs/env_adapters/rbenv.rb

@@ -0,0 +1,18 @@
+module Stairs
+  module EnvAdapters
+    class Rbenv
+      def self.present?
+        `which rbenv-vars`
+        $?.success?
+      end
+
+      def set(name, value)
+        Util::FileUtils.replace_or_append(
+          Regexp.new("^#{name}=(.*)$"),
+          "#{name}=#{value}",
+          ".rbenv-vars",
+        )
+      end
+    end
+  end
+end

data/lib/stairs/env_adapters/rvm.rb

@@ -0,0 +1,18 @@
+module Stairs
+  module EnvAdapters
+    class RVM
+      def self.present?
+        `which rvm`
+        $?.success?
+      end
+
+      def set(name, value)
+        Util::FileUtils.replace_or_append(
+          Regexp.new("^export #{name}=(.*)$"),
+          "export #{name}=#{value}",
+          ".rvmrc",
+        )
+      end
+    end
+  end
+end

data/lib/stairs/env_adapters.rb

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

data/lib/stairs/interactive_configuration.rb

@@ -0,0 +1,22 @@
+module Stairs
+  class InteractiveConfiguration < Stairs::Step
+    title "Configuration"
+    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|
+        if yes
+          Stairs.configuration.env_adapter = adapter_class.new
+        else
+          choice "Which would you prefer?", Stairs::EnvAdapters::ADAPTERS.map { |n,_a| n.to_s } do |name|
+            adapter_class = Stairs::EnvAdapters::ADAPTERS[name.to_sym]
+            Stairs.configuration.env_adapter = adapter_class.new
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stairs/step.rb

@@ -50,32 +50,17 @@ module Stairs
 
     # Set or update env var in .rbenv-vars
     def env(name, value)
-      string = "#{name}=#{value}"
-
-      if File.exists? ".rbenv-vars"
-        contents = File.read ".rbenv-vars"
-        regexp = Regexp.new "^#{name}=(.*)$"
-        if contents.index regexp
-          contents.sub! regexp, string
-          write contents, ".rbenv-vars"
-          return
-        end
-      end
-
-      write_line string, ".rbenv-vars"
+      Stairs.configuration.env_adapter.set name, value
     end
 
     # Replace contents of file
     def write(string, filename)
-      File.truncate filename, 0 if File.exists? filename
-      write_line string, filename
+      Util::FileUtils.write(string, filename)
     end
 
     # Append line to file
     def write_line(string, filename)
-      File.open filename, "a" do |file|
-        file.puts string
-      end
+      Util::FileUtils.write_line(string, filename)
     end
 
     # Embed a step where step_name is a symbol that can be resolved to a class

data/lib/stairs/tasks.rb

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

data/lib/stairs/util/file_utils.rb

@@ -0,0 +1,31 @@
+module Stairs
+  module Util
+    module FileUtils
+      class << self
+        def replace_or_append(pattern, string, filename)
+          if File.exists? filename
+            contents = File.read filename
+            if contents.index pattern
+              contents.sub! pattern, string
+              write contents, filename
+              return
+            end
+          end
+
+          write_line string, filename
+        end
+
+        def write_line(string, filename)
+          File.open filename, "a" do |file|
+            file.puts string
+          end
+        end
+
+        def write(string, filename)
+          File.truncate filename, 0 if File.exists? filename
+          write_line string, filename
+        end
+      end
+    end
+  end
+end

data/lib/stairs/util.rb

@@ -0,0 +1,5 @@
+module Stairs
+  module Util
+    autoload :FileUtils, "stairs/util/file_utils"
+  end
+end

data/lib/stairs/version.rb

@@ -1,3 +1,3 @@
 module Stairs
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/stairs.rb

@@ -5,4 +5,18 @@ 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"
+
+  class << self
+    def configure
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stairs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - patbenatar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-28 00:00:00.000000000 Z
+date: 2013-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,11 +80,19 @@ files:
 - README.md
 - Rakefile
 - lib/stairs.rb
+- lib/stairs/configuration.rb
+- lib/stairs/env_adapters.rb
+- lib/stairs/env_adapters/dotenv.rb
+- lib/stairs/env_adapters/rbenv.rb
+- lib/stairs/env_adapters/rvm.rb
+- lib/stairs/interactive_configuration.rb
 - lib/stairs/script.rb
 - lib/stairs/step.rb
 - lib/stairs/steps.rb
 - lib/stairs/steps/secret_token.rb
 - lib/stairs/tasks.rb
+- lib/stairs/util.rb
+- lib/stairs/util/file_utils.rb
 - lib/stairs/version.rb
 - stairs.gemspec
 homepage: http://github.com/patbenatar/stairs