boxen 3.0.0.beta1 → 3.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2446bd003647a42616bee6f20530f55b3b56b678
+  data.tar.gz: a5bc7868ad7ba25d216e9cdc0feaa10166b0e35f
+SHA512:
+  metadata.gz: c8ace9ed36907e0cf2ac8679a33d4fe7f253c927ea5460ef05ce9a34e0d64c5590e081e0a1917717f971ffca97fd809f1fbf89d9df2863ed5e08938a922bdba9
+  data.tar.gz: 3ef57a22a4192307c3c67ddee992d693fe37f3830c5a1aa398282adc66af7733306f4471bc270514db924bb8b8e03a66567e54f9de06e35948a7a16f8ca9b96d

data/.travis.yml

@@ -3,5 +3,4 @@ before_install: gem update --system 2.1.11
 script: "./script/tests"
 gemfile: "this/does/not/exist"
 rvm:
-  - "1.8.7"
   - "2.0.0"

data/README.md

@@ -42,7 +42,7 @@ and we can't just modify the sudoers file due to a chicken-egg problem.
 
 ## Contributing
 
-Use the OS X system Ruby (1.8.7 or 2.0.0). Run `script/tests` often. Open PR's.
+Use the OS X system Ruby (2.0 or newer). Run `script/tests` often. Open PR's.
 Use the CI.
 
 ## Halp!

data/boxen.gemspec

@@ -1,30 +1,30 @@
 # -*- encoding: utf-8 -*-
 
-$:.unshift File.expand_path("../lib", __FILE__)
-require "boxen/version"
-
 Gem::Specification.new do |gem|
   gem.name          = "boxen"
-  gem.version       = Boxen::VERSION
-  gem.authors       = ["John Barnette", "Will Farrington", "David Goodlad"]
-  gem.email         = ["jbarnette@github.com", "wfarr@github.com", "dgoodlad@github.com"]
+  gem.version       = "3.1.0"
+  # Thanks go out to the previous maintainers John Barnette, Will
+  # Farrington, David Goodlad and Mike McQuaid for getting this project
+  # to where it is today.
+  gem.authors       = ["Jacob Bednarz"]
+  gem.email         = ["jacob.bednarz@gmail.com"]
   gem.description   = "Manage Mac development boxes with love (and Puppet)."
   gem.summary       = "You know, for laptops and stuff."
   gem.homepage      = "https://github.com/boxen/boxen"
+  gem.license       = 'MIT'
 
-  gem.files         = `git ls-files`.split( $/)
-  gem.test_files    = gem.files.grep(/^test/)
-  gem.executables   = gem.files.grep(/^bin/).map { |bin| File.basename(bin) }
+  gem.files         = `git ls-files`.split $/
+  gem.test_files    = gem.files.grep /^test/
   gem.require_paths = ["lib"]
 
   gem.add_dependency "ansi",             "~> 1.4"
   gem.add_dependency "hiera",            "~> 1.0"
-  gem.add_dependency "highline",         "~> 1.6"
+  gem.add_dependency "highline",         "~> 1.6.0"
   gem.add_dependency "json_pure",        [">= 1.7.7", "< 2.0"]
-  gem.add_dependency "librarian-puppet", "~> 1.0.0"
+  gem.add_dependency "librarian-puppet", "~> 2.2"
   gem.add_dependency "octokit",          "~> 2.7", ">= 2.7.1"
-  gem.add_dependency "puppet",           "~> 3.0"
+  gem.add_dependency "puppet",           "~> 3.7"
 
-  gem.add_development_dependency "minitest", "~> 5.0" # pinned for mocha
+  gem.add_development_dependency "minitest", "4.4.0" # pinned for mocha
   gem.add_development_dependency "mocha",    "~> 0.13"
 end

data/lib/boxen/check.rb

@@ -1,11 +1,20 @@
-require "boxen/util/logging"
+require "ansi"
 
 module Boxen
 
   # The superclass for preflight and postflight sanity checks.
 
   class Check
-    include Boxen::Util::Logging
+
+    # A collection of preflight instances for `config`. An instance is
+    # created for every constant under `self` that's also a
+    # subclass of `self`.
+
+    def self.checks(config)
+      constants.map { |n| const_get n }.
+        select { |c| c < self }.
+        map { |c| c.new config }
+    end
 
     # Search `dir` and load all Ruby files under it.
 
@@ -13,12 +22,16 @@ module Boxen
       Dir["#{dir}/*.rb"].sort.each { |f| load f }
     end
 
+    # Check each instance against `config`.
+
+    def self.run(config)
+      checks(config).each { |check| check.run unless check.ok? }
+    end
+
     attr_reader :config
-    attr_reader :command
 
-    def initialize(config, command)
-      @config  = config
-      @command = command
+    def initialize(config)
+      @config = config
     end
 
     # Is everything good to go? Implemented by subclasses.
@@ -33,9 +46,27 @@ module Boxen
       raise "Subclasses must implement this method."
     end
 
+    # A fancier `abort` and `warn`. This will probably really annoy
+    # someone at some point because it's overriding a Kernel method,
+    # but it's limited to checks.
+
+    def abort(message, *extras)
+      extras << { :color => :red }
+      warn message, *extras
+      exit 1
+    end
+
+    def warn(message, *extras)
+      options = Hash === extras.last ? extras.pop : {}
+      color   = options[:color] || :yellow
+
+      $stderr.puts ANSI.send(color) { "--> #{message}" }
+
+      unless extras.empty?
+        extras.each { |line| $stderr.puts "    #{line}" }
+      end
 
-    def debug?
-      @config.debug?
+      $stderr.puts
     end
   end
 end

data/lib/boxen/cli.rb

@@ -1,35 +1,61 @@
-require "boxen/command"
 require "boxen/config"
-require "boxen/util/logging"
+require "boxen/flags"
+require "boxen/postflight"
+require "boxen/preflight"
+require "boxen/runner"
+require "boxen/util"
 
 module Boxen
   class CLI
-    include Boxen::Util::Logging
-
-    def self.run(*args)
-      new.run(*args)
+    attr_reader :config
+    attr_reader :flags
+    attr_reader :runner
+
+    def initialize(config, flags)
+      @config = config
+      @flags  = flags
+      @runner = Boxen::Runner.new(@config, @flags)
     end
 
-    def initialize
+    def run
+      if flags.help?
+        puts flags
+        exit
+      end
+
+      runner.run
     end
 
-    def run(*args)
-      cmd, *cmd_args = args.flatten
+    # Run Boxen by wiring together the command-line flags, config,
+    # preflights, Puppet execution, and postflights. Returns Puppet's
+    # exit code.
+
+    def self.run(*args)
+      config = Boxen::Config.load
+      flags  = Boxen::Flags.new args
+
+      # Apply command-line flags to the config in case we're changing or
+      # overriding anything.
+      flags.apply config
 
-      with_friendly_errors do
-        config = Boxen::Config.load
-        status = Boxen::Command.invoke cmd, config, *cmd_args
+      if flags.run?
+        # Run the preflight checks.
+        Boxen::Preflight.run config
 
-        status.code
+        # Save the config for Puppet (and next time).
+        Boxen::Config.save config
       end
-    end
 
-    private
+      # Make the magic happen.
+      status = Boxen::CLI.new(config, flags).run
+
+      if flags.run?
+        # Run the postflight checks.
+        Boxen::Postflight.run config if status.success?
+      end
 
-    def with_friendly_errors(&block)
-      yield
-    rescue => e
-      abort "#{e.class.name}: #{e.message}"
+      # Return Puppet's exit status.
+      return status.code
     end
   end
 end

data/lib/boxen/config.rb

@@ -25,6 +25,9 @@ module Boxen
           end
         end
 
+        keychain        = Boxen::Keychain.new config.user
+        config.token    = keychain.token
+
         if config.enterprise?
           # configure to talk to GitHub Enterprise
           Octokit.configure do |c|
@@ -77,19 +80,10 @@ module Boxen
     def initialize(&block)
       @fde  = true
       @pull = true
-      @debug = false
 
       yield self if block_given?
     end
 
-    def keychain
-      @keychain ||= Boxen::Keychain.new self.user
-    end
-
-    def token
-      @token ||= keychain.token
-    end
-
     # Create an API instance using the current user creds. A new
     # instance is created any time `token` changes.
 
@@ -100,32 +94,11 @@ module Boxen
     # Spew a bunch of debug logging? Default is `false`.
 
     def debug?
-      # TODO: fix this
       !!@debug
     end
 
     attr_writer :debug
 
-    def offline?
-      @offline ||= false
-    end
-
-    attr_writer :offline
-
-    def report?
-      # TODO: Actually make this a thing
-      @report = false
-    end
-
-    attr_writer :report
-
-    def profile?
-      #TODO: Actually make this a thing
-      @profile = true
-    end
-
-    attr_writer :profile
-
     # A GitHub user's public email.
 
     attr_accessor :email
@@ -149,7 +122,7 @@ module Boxen
     # `BOXEN_HOME` environment variable.
 
     def homedir
-      @homedir ||= (ENV["BOXEN_HOME"] || "/opt/boxen")
+      @homedir || ENV["BOXEN_HOME"] || "/opt/boxen"
     end
 
     attr_writer :homedir
@@ -159,7 +132,7 @@ module Boxen
     # overwritten on every run.
 
     def logfile
-      @logfile ||= (ENV["BOXEN_LOG_FILE"] || "#{repodir}/log/boxen.log")
+      @logfile || ENV["BOXEN_LOG_FILE"] || "#{repodir}/log/boxen.log"
     end
 
     attr_writer :logfile
@@ -172,6 +145,46 @@ module Boxen
 
     attr_accessor :name
 
+    # Just go through the motions? Default is `false`.
+
+    def pretend?
+      !!@pretend
+    end
+
+    attr_writer :pretend
+
+    # Run a profiler on Puppet? Default is `false`.
+
+    def profile?
+      !!@profile
+    end
+
+    attr_writer :profile
+
+    # Enable the Puppet future parser? Default is `false`.
+
+    def future_parser?
+      !!@future_parser
+    end
+
+    attr_writer :future_parser
+
+    # Enable puppet reports ? Default is `false`.
+
+    def report?
+      !!@report
+    end
+
+    attr_writer :report
+
+    # Enable generation of dependency graphs.
+
+    def graph?
+      !!@graph
+    end
+
+    attr_writer :graph
+
     # An Array of Boxen::Project entries, one for each project Boxen
     # knows how to manage.
     #
@@ -195,7 +208,7 @@ module Boxen
     # `BOXEN_PUPPET_DIR` environment variable.
 
     def puppetdir
-      @puppetdir ||= (ENV["BOXEN_PUPPET_DIR"] || "/tmp/boxen/puppet")
+      @puppetdir || ENV["BOXEN_PUPPET_DIR"] || "/tmp/boxen/puppet"
     end
 
     attr_writer :puppetdir
@@ -204,7 +217,7 @@ module Boxen
     # `Dir.pwd`. Respects the `BOXEN_REPO_DIR` environment variable.
 
     def repodir
-      @repodir ||= (ENV["BOXEN_REPO_DIR"] || Dir.pwd)
+      @repodir || ENV["BOXEN_REPO_DIR"] || Dir.pwd
     end
 
     attr_writer :repodir
@@ -215,7 +228,7 @@ module Boxen
     # Respects the `BOXEN_REPO_NAME` environment variable.
 
     def reponame
-      override = @reponame ||= ENV["BOXEN_REPO_NAME"]
+      override = @reponame || ENV["BOXEN_REPO_NAME"]
       return override unless override.nil?
 
       if File.directory? repodir
@@ -225,7 +238,7 @@ module Boxen
         # find the path and strip off the .git suffix
         repo_exp = Regexp.new Regexp.escape(ghuri.host) + "[/:]([^/]+/[^/]+)"
         if $?.success? && repo_exp.match(url)
-          @reponame = $1.sub(/\.git$/, "")
+          @reponame = $1.sub /\.git$/, ""
         end
       end
     end
@@ -235,7 +248,7 @@ module Boxen
     # GitHub location (public or GitHub Enterprise)
 
     def ghurl
-      @ghurl ||= (ENV["BOXEN_GITHUB_ENTERPRISE_URL"] || "https://github.com")
+      @ghurl || ENV["BOXEN_GITHUB_ENTERPRISE_URL"] || "https://github.com"
     end
 
     attr_writer :ghurl
@@ -243,7 +256,8 @@ module Boxen
     # Repository URL template (required for GitHub Enterprise)
 
     def repotemplate
-      @repotemplate ||= (ENV["BOXEN_REPO_URL_TEMPLATE"] || "https://github.com/%s")
+      default = 'https://github.com/%s'
+      @repotemplate || ENV["BOXEN_REPO_URL_TEMPLATE"] || default
     end
 
     attr_writer :repotemplate
@@ -258,7 +272,7 @@ module Boxen
     # `"/Users/#{user}/src"`.
 
     def srcdir
-      @srcdir ||= (ENV["BOXEN_SRC_DIR"] || "/Users/#{user}/src")
+      @srcdir || ENV["BOXEN_SRC_DIR"] || "/Users/#{user}/src"
     end
 
     attr_writer :srcdir
@@ -267,11 +281,15 @@ module Boxen
     # Respects the `BOXEN_NO_ISSUE` environment variable.
 
     def stealth?
-      @stealth ||= !!ENV["BOXEN_NO_ISSUE"]
+      !!ENV["BOXEN_NO_ISSUE"] || @stealth
     end
 
     attr_writer :stealth
 
+    # A GitHub OAuth token. Default is `nil`.
+
+    attr_reader :token
+
     def token=(token)
       @token = token
       @api = nil
@@ -280,7 +298,7 @@ module Boxen
     # A local user login. Default is the `USER` environment variable.
 
     def user
-      @user ||= ENV["USER"]
+      @user || ENV["USER"]
     end
 
     attr_writer :user
@@ -295,7 +313,7 @@ module Boxen
     # Respects the `BOXEN_S3_HOST` environment variable.
 
     def s3host
-      @s3host ||= (ENV["BOXEN_S3_HOST"] || "s3.amazonaws.com")
+      @s3host || ENV["BOXEN_S3_HOST"] || "s3.amazonaws.com"
     end
 
     attr_writer :s3host
@@ -304,7 +322,7 @@ module Boxen
     # Respects the `BOXEN_S3_BUCKET` environment variable.
 
     def s3bucket
-      @s3bucket ||= (ENV["BOXEN_S3_BUCKET"] || "boxen-downloads")
+      @s3bucket || ENV["BOXEN_S3_BUCKET"] || "boxen-downloads"
     end
 
     attr_writer :s3bucket