snowglobe 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1a7cb4e42cb80539ad12a929b77cdbc345594797a830e1c84afc335c6f70db7d
+  data.tar.gz: 57224881549f30823d7e22b1c804e1d43a31cde9feadb159f437e09ac887e16b
+SHA512:
+  metadata.gz: 154526eb1114b432086be4722e2b8e9e4d761a3850d60ea5e75465aca291b96722f1c450666496880f81f6f81369ae6e9cb5352705943645c566969218aab794
+  data.tar.gz: a260aa8b610ad5d94019b28947814ed728b5d7d2b3a8007ac62ed2ccb5af77f40391a91a3d2e730115f5f91a250e48af4ef56de78ee21242580ebe5144592ce1

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,132 @@
+---
+AllCops:
+  Exclude:
+    - db/schema.rb
+  TargetRubyVersion: 2.5
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+Layout/ClassStructure:
+  Enabled: true
+Layout/DotPosition:
+  EnforcedStyle: trailing
+Layout/InitialIndentation:
+  Enabled: false
+Layout/IndentArray:
+  EnforcedStyle: "consistent"
+Layout/IndentHash:
+  EnforcedStyle: "consistent"
+Layout/IndentHeredoc:
+  Enabled: false
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+Layout/SpaceInLambdaLiteral:
+  Enabled: false
+Layout/SpaceInsideStringInterpolation:
+  Enabled: false
+Lint/AssignmentInCondition:
+  Enabled: false
+Lint/HandleExceptions:
+  Enabled: false
+Lint/RequireParentheses:
+  Enabled: false
+Metrics/AbcSize:
+  Max: 32
+Metrics/BlockLength:
+  ExcludedMethods:
+    - describe
+    - context
+    - it
+    - colored
+Metrics/ClassLength:
+  Enabled: false
+Metrics/LineLength:
+  Max: 80
+  IgnoredPatterns:
+    - "^\\s*describe"
+    - "^\\s*context"
+    - "^\\s*it"
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+Naming/MemoizedInstanceVariableName:
+  EnforcedStyleForLeadingUnderscores: required
+Naming/PredicateName:
+  NamePrefixBlacklist:
+    - is_
+  Exclude:
+    - spec/**/*
+Naming/UncommunicativeMethodParamName:
+  Enabled: false
+Style/Alias:
+  Enabled: false
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+Style/CollectionMethods:
+  Enabled: true
+Style/Documentation:
+  Enabled: false
+Style/EachWithObject:
+  Enabled: false
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+Style/FormatString:
+  EnforcedStyle: percent
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false
+Style/IfUnlessModifier:
+  Enabled: false
+Style/Lambda:
+  Enabled: false
+Style/LineEndConcatenation:
+  Enabled: false
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+Style/MultilineBlockChain:
+  Enabled: false
+Style/NegatedIf:
+  Enabled: false
+Style/NegatedWhile:
+  Enabled: false
+Style/OneLineConditional:
+  Enabled: false
+Style/PercentLiteralDelimiters:
+  Enabled: false
+Style/PreferredHashMethods:
+  Enabled: false
+Style/RaiseArgs:
+  Enabled: false
+Style/SafeNavigation:
+  Enabled: false
+Style/Send:
+  Enabled: true
+Style/SignalException:
+  Enabled: false
+Style/SpecialGlobalVars:
+  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+Style/StringMethods:
+  Enabled: true
+Style/SymbolArray:
+  Enabled: false
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+Style/UnneededCondition:
+  Enabled: false
+Style/WhileUntilModifier:
+  Enabled: false
+Style/WordArray:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    snowglobe (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  snowglobe!
+
+BUNDLED WITH
+   2.0.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Elliot Winkler
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# Snowglobe
+
+Snowglobe is a gem that helps erect and destroy Rails applications for use in
+tests.
+
+## Installation
+
+Add this line to your project's Gemfile:
+
+``` ruby
+gem 'snowglobe'
+```
+
+And then execute:
+
+``` bash
+bundle
+```
+
+Alternatively, install it yourself as:
+
+``` bash
+gem install snowglobe
+```
+
+## Usage
+
+(To be filled in later)
+
+## Developing
+
+* `bin/setup` to get started
+* `bundle exec rake release` to release a new version
+
+## Author/License
+
+Snowglobe is © 2019 Elliot Winkler (<elliot.winkler@gmail.com>) and is released
+under the [MIT license](LICENSE).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "snowglobe"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/snowglobe/bundle.rb

@@ -0,0 +1,93 @@
+require_relative "filesystem"
+require_relative "command_runner"
+require_relative "gem_version"
+
+module Snowglobe
+  class Bundle
+    def initialize(fs:, command_runner:)
+      @fs = fs
+      @command_runner = command_runner
+      @already_updating = false
+    end
+
+    def add_gem(gem, *args)
+      updating do
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        version = args.shift
+        line = assemble_gem_line(gem, version, options)
+        fs.append_to_file("Gemfile", line)
+      end
+    end
+
+    def remove_gem(gem)
+      updating do
+        fs.comment_lines_matching_in_file("Gemfile", /^[ ]*gem ("|')#{gem}\1/)
+      end
+    end
+
+    def updating
+      if already_updating?
+        yield self
+        return
+      end
+
+      @already_updating = true
+
+      yield self
+
+      @already_updating = false
+
+      install_gems
+    end
+
+    def install_gems
+      command_runner.run!("bundle install --local") do |runner|
+        runner.retries = 5
+      end
+    end
+
+    def version_of(gem)
+      GemVersion.new(Bundler.definition.specs[gem][0].version)
+    end
+
+    def includes?(gem)
+      Bundler.definition.dependencies.any? do |dependency|
+        dependency.name == gem
+      end
+    end
+
+    private
+
+    attr_reader :fs, :command_runner
+
+    def already_updating?
+      @already_updating
+    end
+
+    def assemble_gem_line(gem, version, options)
+      formatted_options = options.
+        map { |key, value| "#{key}: #{formatted_value(value)}" }.
+        join(", ")
+
+      line = %(gem '#{gem}')
+
+      if version
+        line << %(, '#{version}')
+      end
+
+      if options.any?
+        line << %(, #{formatted_options})
+      end
+
+      line << "\n"
+    end
+
+    def formatted_value(value)
+      if value.is_a?(Pathname)
+        value.to_s.inspect
+      else
+        value.inspect
+      end
+    end
+  end
+end

data/lib/snowglobe/command_runner.rb

@@ -0,0 +1,232 @@
+require "forwardable"
+require "timeout"
+require "shellwords"
+
+module Snowglobe
+  class CommandRunner
+    extend Forwardable
+
+    TimeoutError = Class.new(StandardError)
+
+    def self.run(*args, **options, &block)
+      new(*args, **options, &block).tap(&:call)
+    end
+
+    def self.run!(*args, **options, &block)
+      run(*args, run_successfully: true, **options, &block)
+    end
+
+    attr_reader :status, :options, :env
+    attr_accessor :command_prefix, :run_quickly, :run_successfully, :retries,
+      :timeout
+
+    def initialize(
+      *args,
+      env: {},
+      directory: Dir.pwd,
+      run_successfully: false,
+      **options
+    )
+      @reader, @writer = IO.pipe
+      @options = options.merge(err: [:child, :out], out: writer)
+
+      @args = args
+      @env = normalize_env(env)
+      self.directory = directory
+      @run_successfully = run_successfully
+
+      @wrapper = ->(block) { block.call }
+      @command_prefix = ""
+      @run_quickly = false
+      @retries = 1
+      @num_times_run = 0
+      @timeout = 20
+
+      yield self if block_given?
+    end
+
+    def directory
+      options[:chdir]
+    end
+
+    def directory=(directory)
+      if directory.nil?
+        raise ArgumentError, "Must provide a directory"
+      end
+
+      options[:chdir] = directory
+    end
+
+    def around_command(&block)
+      @wrapper = block
+    end
+
+    def formatted_command
+      [formatted_env, Shellwords.join(command)].
+        reject(&:empty?).
+        join(" ")
+    end
+
+    def call
+      possibly_retrying do
+        possibly_running_quickly do
+          run_with_debugging
+
+          if run_successfully && !success?
+            fail!
+          end
+        end
+      end
+
+      self
+    end
+
+    def stop
+      unless writer.closed?
+        writer.close
+      end
+    end
+
+    def output
+      @_output ||= begin
+        stop
+        without_colors(reader.read)
+      end
+    end
+
+    def elided_output
+      lines = output.split(/\n/)
+      new_lines = lines[0..4]
+
+      if lines.size > 10
+        new_lines << "(...#{lines.size - 10} more lines...)"
+      end
+
+      new_lines << lines[-5..-1]
+      new_lines.join("\n")
+    end
+
+    def_delegators :status, :success?
+
+    def exit_status
+      status.exitstatus
+    end
+
+    def fail!
+      raise <<-MESSAGE
+Command #{formatted_command.inspect} exited with status #{exit_status}.
+Output:
+#{divider("START") + output + divider("END")}
+      MESSAGE
+    end
+
+    def has_output?(expected_output)
+      if expected_output.is_a?(Regexp)
+        output =~ expected_output
+      else
+        output.include?(expected_output)
+      end
+    end
+
+    protected
+
+    attr_reader :args, :reader, :writer, :wrapper
+
+    private
+
+    def normalize_env(env)
+      env.reduce({}) do |hash, (key, value)|
+        hash.merge(key.to_s => value)
+      end
+    end
+
+    def command
+      ([command_prefix] + args).flatten.flat_map do |word|
+        Shellwords.split(word)
+      end
+    end
+
+    def formatted_env
+      env.map { |key, value| "#{key}=#{value.inspect}" }.join(" ")
+    end
+
+    def run
+      pid = spawn(env, *command, options)
+      Process.waitpid(pid)
+      @status = $?
+    end
+
+    def run_with_wrapper
+      wrapper.call(method(:run))
+    end
+
+    def run_with_debugging
+      debug { "\n\e[33mChanging to directory:\e[0m #{directory}" }
+      debug { "\e[32mRunning command:\e[0m #{formatted_command}" }
+
+      run_with_wrapper
+
+      debug { "\n" + divider("START") + output + divider("END") }
+    end
+
+    def possibly_running_quickly(&block)
+      if run_quickly
+        begin
+          Timeout.timeout(timeout, &block)
+        rescue Timeout::Error
+          stop
+
+          message =
+            "Command timed out after #{timeout} seconds: " +
+            "#{formatted_command}\n" +
+            "Output:\n" +
+            output
+
+          raise TimeoutError, message
+        end
+      else
+        yield
+      end
+    end
+
+    def possibly_retrying
+      @num_times_run += 1
+      yield
+    rescue StandardError => error
+      debug { "#{error.class}: #{error.message}" }
+
+      if @num_times_run < @retries
+        sleep @num_times_run
+        retry
+      else
+        raise error
+      end
+    end
+
+    def divider(title = "")
+      total_length = 72
+      start_length = 3
+
+      string = ""
+      string << ("-" * start_length)
+      string << title
+      string << "-" * (total_length - start_length - title.length)
+      string << "\n"
+      string
+    end
+
+    def without_colors(string)
+      string.gsub(/\e\[\d+(?:;\d+)?m(.+?)\e\[0m/, '\1')
+    end
+
+    def debugging_enabled?
+      ENV["DEBUG_COMMANDS"] == "1"
+    end
+
+    def debug
+      if debugging_enabled?
+        puts yield
+      end
+    end
+  end
+end

data/lib/snowglobe/configuration.rb

@@ -0,0 +1,43 @@
+module Snowglobe
+  class Configuration
+    attr_accessor :root_directory
+    attr_accessor :temporary_directory
+    attr_writer :project_name
+
+    def initialize
+      self.temporary_directory = Pathname.new("/tmp/snowglobe")
+      @project_name = nil
+      @database_name = nil
+    end
+
+    def project_name
+      if @project_name
+        "#{@project_name}-test-app"
+      else
+        raise NotConfiguredError.new(<<~EXAMPLE)
+          Snowglobe.configure do |config|
+            config.project_name = "your_project_name"
+          end
+        EXAMPLE
+      end
+    end
+
+    def database_name
+      @database_name || project_name
+    end
+
+    def update!
+      yield self
+    end
+
+    class NotConfiguredError < StandardError
+      def initialize(example)
+        super(<<~MESSAGE)
+          You need to configure Snowglobe before you can use it! For example:
+
+          #{example}
+        MESSAGE
+      end
+    end
+  end
+end

data/lib/snowglobe/database.rb

@@ -0,0 +1,28 @@
+require_relative "database_configuration"
+
+module Snowglobe
+  class Database
+    ADAPTER_NAME = ENV.fetch("DATABASE_ADAPTER", "sqlite3").to_sym
+
+    attr_reader :config
+
+    def initialize
+      @config = DatabaseConfiguration.for(
+        Snowglobe.configuration.database_name,
+        ADAPTER_NAME,
+      )
+    end
+
+    def name
+      config.database
+    end
+
+    def adapter_name
+      config.adapter
+    end
+
+    def adapter_class
+      config.adapter_class
+    end
+  end
+end