contur 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bad06811aed7b745ee20052f281999fbcd20a167
+  data.tar.gz: 29a68d32449352c9b61d7074663ec1da2e37ae5c
+SHA512:
+  metadata.gz: e9fb48b4fdb9ff38f75c5de61f903cdafd7e3765628b20b3c4eabe01774b9a4b863736244c1c9c87269b446a3fffa8f2c78079c783b32a403f9417b547cd836f
+  data.tar.gz: ece91a164002d96803dd0f456debd60f3199ca64e0aad0d476314d98278b1d1fb840e95111c698b613f6f4a40c6525c5a85f3fe586c06e75a2312e84b1dae916

data/.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{sh,markdown,md}]
+indent_size = 4
+
+[*.{markdown,md}]
+trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/webroot/
+/iniscripts/
+.contur.yml
+.contur.yaml
+erl_crash.dump

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  Exclude:
+    - 'templates/**/*'
+    - 'vendor/**/*'
+  TargetRubyVersion: 2.3
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 50
+
+Metrics/BlockLength:
+  Exclude:
+    - 'contur.gemspec'
+
+Style/GuardClause:
+  Exclude:
+    - 'contur.gemspec'

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.1
+script: bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This CHANGELOG follows [Keep a CHANGELOG](http://keepachangelog.com/).
+
+## [0.0.3] - 2016-10-24
+### Added
+- Travis support
+- Accept config file with both `.yml` and `.yaml` extensions
+
+### Changed
+- Project name changed to Contur
+
+## [0.0.2] - 2016-10-20
+### First open-source release
+
+## [0.0.1] - 2016-10-10
+### First internal release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at gabor.takacs@cheppers.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in contur.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Cheppers Ltd. <info@cheppers.com>
+
+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,166 @@
+![Contur Logo](contur-logo.png)
+
+# Contur
+Contur is an open-source command line application simplifying your local web development environment. It hosts your site using Docker containers so you don't have to install Apache, MySQL, PHP and PHP extensions on your own machine. Contur is written in Ruby and uses the Docker HTTP API.
+
+[![Build Status](https://travis-ci.org/Cheppers/contur.svg?branch=master)](https://travis-ci.org/Cheppers/contur)
+
+## Requirements
+* Ruby 2.3.0+ (recommended installation method [via rvm](https://rvm.io/rvm/install))
+* Docker (for Mac see [this](https://docs.docker.com/engine/installation/mac/#/docker-for-mac))
+
+## Installation
+1. Install requirements (see above)
+2. `gem install contur`
+
+## Usage
+1. Create a `.contur.yml` file in the root of your repository
+2. Launch docker
+3. Run `$ contur start` to build the image, launch the MySQL container and the Contur container
+4. Run `$ contur restart` to restart the Contur container
+
+When you run the `start` command the following will happen:
+
+1. Contur builds a Docker image with apache, php-fpm and a couple of PHP extensions and configure them to work together
+2. Contur downloads and starts a MySQL container (of your choice or the latest one if undefined in the YAML)
+3. Contur starts the container
+4. Contur runs the init script
+5. You can access the site on `localhost:8088`
+6. If your root directory is empty, Contur will create an index.php file with a phpinfo inside
+
+When you run the `restart` command the following will happen:
+
+1. Contur checks if your image is up-to-date and builds a new one if needed
+2. Contur kills the currently running Contur container
+3. Contur starts a new container and re-runs the init script
+
+## The container
+The following happens in the container when you start it:
+
+1. Export the specified envrionment variables (`env` section)
+2. Runs the commands from the `before` section
+3. Starts apache
+4. Starts php-fpm to keep alive the container
+
+## The .contur.yml
+The build file consists of sections: `version`, `use`, `before`, `env`.
+The minimal YAML file for contur to work properly:
+```yaml
+---
+version: 1.0
+```
+
+## Sections of the build file
+### version - [required]
+Version of the build file. Currently this is the only required section.
+
+Allowed values: `1.0`
+
+**Example**
+```yaml
+---
+version: 1.0
+```
+
+### use - [optional]
+Specify the MySQL and PHP versions you want to use.
+
+#### PHP
+Current default PHP version: **5.6.25**
+
+At the moment specifying a PHP version is not working (to be implemented soon).
+
+#### MySQL
+Default is the latest from Dockerhub
+
+To connect:
+
+* no username
+* password is 'admin'
+* host address: $MYSQL_PORT_3306_TCP_ADDR
+
+**Example**
+```yaml
+---
+version: 1.0
+use:
+  mysql: 5.6.20
+```
+
+### env - [optional]
+Specify environment variables to use them in the `before` script or in your site
+
+**Example**
+```yaml
+---
+version: 1.0
+env:
+  THE_ANSWER: 42
+  DOCTOR: Who
+```
+
+### before - [optional]
+Run scrips before starting php-fpm.
+
+**Example**
+```yaml
+---
+version: 1.0
+before:
+  - composer install
+```
+
+## Example .contur.yml
+```yaml
+---
+version: 1.0
+use:
+  mysql: 5.6.20
+env:
+  YAML_DEFINED: envvar
+  ANOTHER_ENV_VAR: Contur
+before:
+  - echo "Hello, $ANOTHER_ENV_VAR!<br />Generated at $(date)<br /> MySQL version $MYSQL_ENV_MYSQL_VERSION" > /www/index.php
+```
+
+## Commands
+```bash
+$ contur help
+Commands:
+  contur --version, -V          # Current version
+  contur delete [-CIM]  # Delete container, image or MySQL container(s)
+  contur help [COMMAND]         # Describe available commands or one specific command
+  contur log                    # Get container log
+  contur restart                # Restart contur container
+  contur start                  # Build and start everything
+  contur validate               # Validate build definition file
+
+Options:
+  -v, [--verbose], [--no-verbose]
+  -f, [--force]
+```
+
+## Near-future goals and features to be implemented
+- [ ] Selectable PHP version
+- [ ] Configurable port mapping for MySQL and your site
+- [ ] Multiple running environments
+- [ ] Ability to choose between Apache and Nginx for server
+- [ ] Ability to select/add PHP extensions
+
+## Development
+After checking out the repo, run `bin/setup` to install dependencies.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+1. Fork the repo
+2. Commit your changes to your own repo on a separate branch
+3. Submit pull request
+
+If you can, please use the provided [EditorConfig](http://editorconfig.org/) file!
+
+## Milestones
+[List of Star Wars planets and moons](https://en.wikipedia.org/wiki/List_of_Star_Wars_planets_and_moons)
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). See more in LICENSE.txt

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new(:rubocop) { |task| task.options << '-D' }
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:rubocop, :spec]

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'contur'
+
+require 'pry'
+Pry.start

data/bin/contur

@@ -0,0 +1,172 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'contur'
+require 'colorize'
+require 'pp'
+require 'thor'
+
+# rubocop:disable Metrics/AbcSize, Metrics/ClassLength
+# Contur CLI
+class ConturCLI < Thor
+  no_commands do # rubocop:disable Metrics/BlockLength
+    def build_image(options: {})
+      if Contur::Controller.image_exist?
+        puts 'Image already exists, skipping image build' if options[:verbose]
+        return
+      end
+      if options[:verbose]
+        Contur::Controller.build { |message| puts message }
+      else
+        start = Time.now
+        Contur::Controller.build do |message|
+          message.match(/step \d{1,2}/i) do |match|
+            num = match.to_s.split[1].to_i
+            step = '['.green + "#{(Time.now - start).round(2)}s".rjust(6) + ']'.green
+            text = "Building your image#{'.' * num}".green
+            print "#{step} #{text}\r"
+            $stdout.flush
+          end
+        end
+      end
+      print "\n"
+      $stdout.flush
+      puts 'Image build successfully'.green
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    def run_container(restart: false, options: {})
+      if (c = Contur::Controller.container?) && restart
+        Contur::Controller.delete_container
+        puts 'Container killed and deleted'.green
+      elsif c
+        puts "Container already exists, run 'contur restart' to relaunch it" if options[:verbose]
+        return
+      end
+
+      controller_run = Contur::Controller.run(webroot: Dir.pwd) do |log|
+        puts log if options[:verbose]
+      end
+
+      unless controller_run
+        puts 'Could not start container :('.red
+        exit 1
+      end
+
+      puts 'Container started'.green
+      puts "Container id: #{Contur::Controller.container_id}" if options[:verbose]
+    end
+
+    def delete_mysql_containers
+      if Contur::Controller.delete_mysql_containers
+        'MySQL container(s) killed and deleted'.green
+      else
+        'MySQL container(s) not found'.yellow
+      end
+    end
+
+    def delete_image
+      if Contur::Controller.delete_image
+        'Image deleted'.green
+      else
+        'Image not found'.yellow
+      end
+    end
+
+    def delete_container
+      if Contur::Controller.delete_container
+        'Container killed'.green
+      else
+        'Container not found'.yellow
+      end
+    end
+  end
+
+  class_option :verbose, type: :boolean, aliases: '-v'
+  class_option :force, type: :boolean, aliases: '-f'
+
+  map %w(--version -V) => :__print_version
+  desc '--version, -V', 'Current version'
+  def __print_version
+    puts Contur::VERSION
+  end
+
+  desc 'start', 'Build and start everything'
+  def start
+    build_image(options: options)
+
+    run_container(options: options)
+
+    puts "Build environment up and running; run 'contur restart' to relaunch container".green
+  end
+
+  desc 'restart', 'Restart Contur container'
+  def restart
+    build_image(options: options)
+
+    run_container(restart: true, options: options)
+
+    puts "Build environment up and running; run 'contur restart' to relaunch container".green
+  end
+
+  desc 'log', 'Get container log'
+  def log
+    puts Contur::Controller.container_logs
+  end
+
+  desc 'delete [-C] [-I] [-M]', 'Delete container, image or MySQL container(s)'
+  method_option :container, aliases: '-C', type: :boolean, default: false, desc: 'Delete container'
+  method_option :image, aliases: '-I', type: :boolean, default: false, desc: 'Delete image'
+  method_option 'mysql-container',
+                aliases: '-M',
+                type: :boolean,
+                default: false,
+                desc: 'Delete MySQL container(s)'
+  def delete
+    puts delete_container if options[:container]
+
+    puts delete_image if options[:image]
+
+    puts delete_mysql_containers if options['mysql-container']
+
+  rescue => e
+    puts e.message.red
+    exit 1
+  end
+
+  desc 'validate', 'Validate build definition file'
+  method_option :path,
+                aliases: '-p',
+                default: File.join(Dir.pwd, Dir['.contur.y*ml'].first),
+                desc: 'Build definition file path'
+  def validate
+    begin
+      config = Contur::Controller.config(options[:path])
+    rescue Contur::Config::NotFoundError => e
+      puts "ERROR: #{e.message}".red
+      exit 1
+    end
+
+    puts "Config path: #{config.path}".green
+
+    if options[:verbose]
+      puts 'Config from file:'.yellow
+      pp config.raw
+      puts 'Final config:'.yellow
+      pp config
+    end
+
+    if config.errors.length.zero?
+      puts 'Looks good'.green
+      return
+    end
+
+    puts "Errors:\n".red
+    config.errors.each do |err|
+      puts err.red
+    end
+    exit 1
+  end
+end
+
+ConturCLI.start(ARGV)

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/contur.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative 'lib/contur/version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'contur'
+  spec.version       = Contur::VERSION
+  spec.author        = 'Cheppers Ltd.'
+  spec.email         = 'info@cheppers.com'
+  spec.summary       = 'Contur - Local Web Development Tool'
+  spec.homepage      = 'https://github.com/Cheppers/contur'
+  spec.license       = 'MIT'
+  spec.description   = IO.read('README.md').match(/# Contur\n^(?<desc>.*)$/)[:desc]
+
+  spec.required_ruby_version = '>= 2.3.0'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = ['contur']
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'colorize', '~> 0.8'
+  spec.add_dependency 'excon', '~> 0.46', '>= 0.46'
+  spec.add_dependency 'docker-api', '~> 1.31', '>= 1.31'
+  spec.add_dependency 'thor', '~> 0.19'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.44'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/contur/bindable_hash.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+# Contur module :D
+module Contur
+  # BindableHash is for ERB templates
+  class BindableHash
+    def initialize(hash)
+      hash.each do |key, value|
+        singleton_class.send(:define_method, key) { value }
+      end
+    end
+
+    def get_binding # rubocop:disable Style/AccessorMethodName
+      binding
+    end
+  end
+end

data/lib/contur/config/before.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+module Contur
+  class Config
+    # Before section
+    class Before < Array
+      # before_commands is required so no default value
+      def initialize(before_commands)
+        super([])
+        validate!(before_commands)
+        replace(before_commands) unless before_commands.nil?
+      end
+
+      def validate!(before_commands)
+        @errors = []
+        @errors << 'Required' if before_commands.nil?
+        @errors << 'Cannot be empty' if before_commands == []
+      end
+
+      attr_reader :errors
+
+      def name
+        "Section 'before'"
+      end
+
+      def to_bash_script
+        reduce('') { |a, e| a + "#{e}\n" }
+      end
+    end
+  end
+end

data/lib/contur/config/env.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+module Contur
+  class Config
+    # Env section
+    class Env < Hash
+      def initialize(env = {})
+        validate!(env)
+        super
+        replace(env) unless env.nil?
+      end
+
+      def validate!(_env)
+        true
+      end
+
+      def errors
+        []
+      end
+
+      def name
+        "Section 'env'"
+      end
+
+      def to_bash_script
+        reduce('') { |a, (k, v)| a + "export #{k}=\"#{v}\"\n" }
+      end
+    end
+  end
+end

data/lib/contur/config/errors.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+module Contur
+  class Config
+    # NotFoundError
+    class NotFoundError < StandardError; end
+  end
+end