devup 0.1.1 → 0.3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af85549b1c01b89de550c6c7857c23d1b80cc06997e3fd6ceee8709e8587f85c
-  data.tar.gz: 8523baac5e3d05d235feb677a66857622a97cf3432f62f9726144d86b8fa01f6
+  metadata.gz: 3e2a14e12cc9c1661134d64021d14f6553df35ab4021c85b3512103d1171503e
+  data.tar.gz: 9a63920fc33cbe3f0d312ef5dd4bd3e1b220618435ac1dab117e87aab0362267
 SHA512:
-  metadata.gz: f3c80f5bbbed5b595e58eeb2b7089c2e5743f62fa629b850c98f559be401a5c77767b3485a3140b69ffb9158473f6dc2993919cdc2e416711433772811a4553d
-  data.tar.gz: 15e5cc91441dc2eb5b251d25fd72d4dad66c2fa6ce43744c66ec30a518c7e5791504c70c91f059fd9211cc98dd198e0c69f88d94452b5037e77f6af8b3c0945d
+  metadata.gz: 8617036ce5f17bcae494dde0f333faa65c355b71fe2d1b360d9a1f6c41d09762340fe6ca4c8050f547983115e7849f87aa8818c76c396aed9ce430a0f354721f
+  data.tar.gz: c016d3af0f75c8c64849429ea68e3d4a156ff75cc729a286b123f78fa96d3e5c574193aa78b27e2600a9edd0bc8c883bdd3021aa27e61c14965ef2794b1364d1

data/.gitignore

@@ -15,5 +15,6 @@
 .vimrc
 
 spec/dummy/.env.services
+spec/dummy_rails/.env.services
 
 devup-*.gem

data/.standard.yml

@@ -0,0 +1,2 @@
+ignore:
+  - 'spec/dummy_rails/**/*'

data/.travis.yml

@@ -1,11 +1,14 @@
+env:
+  matrix:
+  - BUNDLER_VERSION=2.1.4
 language: ruby
 cache: bundler
 rvm:
 - 2.7.1
+- 2.6.6
+- 2.5.8
 services:
 - docker
-env:
-- BUNDLER_VERSION=2.1.4
 before_install:
 - gem install bundler -v $BUNDLER_VERSION
 bundler_args: "--jobs=3 --retry=3"
@@ -18,3 +21,21 @@ deploy:
     tags: true
     repo: sergio-fry/devup
   skip_cleanup: 'true'
+
+jobs:
+  include:
+    - stage: test
+      name: RSpec
+      before_script:
+        - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64
+          > ./cc-test-reporter
+        - chmod +x ./cc-test-reporter
+        - "./cc-test-reporter before-build"
+      script:
+        - bundle exec rake spec
+      after_script:
+        - "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
+    - stage: test
+      name: Lint
+      script:
+        - bundle exec standardrb

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    devup (0.1.1)
+    devup (0.3.2.1)
+      dotenv
 
 GEM
   remote: https://rubygems.org/
@@ -10,6 +11,7 @@ GEM
     byebug (11.1.3)
     diff-lcs (1.3)
     docile (1.3.2)
+    dotenv (2.7.5)
     jaro_winkler (1.5.4)
     json (2.3.0)
     parallel (1.19.1)
@@ -42,7 +44,7 @@ GEM
     rubocop-performance (1.5.2)
       rubocop (>= 0.71.0)
     ruby-progressbar (1.10.1)
-    simplecov (0.17.1)
+    simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)

data/README.md

@@ -1,28 +1,105 @@
-# Devup
+# DevUp!  [![Travis (.com) branch](https://img.shields.io/travis/com/sergio-fry/devup/master)](https://travis-ci.com/github/sergio-fry/devup) [![Gem](https://img.shields.io/gem/v/devup)](https://rubygems.org/gems/devup) [![Code Climate coverage](https://img.shields.io/codeclimate/coverage/sergio-fry/devup)](https://codeclimate.com/github/sergio-fry/devup) [![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/sergio-fry/devup)](https://codeclimate.com/github/sergio-fry/devup) [![Gem](https://img.shields.io/gem/dt/devup)](https://rubygems.org/gems/devup)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/devup`. To experiment with that code, run `bin/console` for an interactive prompt.
+Describe development dependencies with docker-compose. It is not required to remember any fancy command to start docker. Just start developing your app. Rails is a first-class citizen, but could be used without ruby.
 
-TODO: Delete this and the text above, and describe your gem
 
-## Installation
+## Requirements
 
-Add this line to your application's Gemfile:
+* Docker (>= 19.03.8)
+* Docker Compose (>= 1.25.5)
+
+
+
+## Rails
+
+Create a docker-compose.devup.yml with app dependencies like:
+
+```yaml
+version: "3"
+
+services:
+  postgres:
+    image: postgres:10-alpine
+    ports:
+      - "5432"
+```
+
+Add **DevUp!** to your Gemfile
 
 ```ruby
-gem 'devup'
+gem "devup", group: [:development, :test]
+```
+
+and
+
+    bundle install
+
+
+Update your database.yml to use ENV:
+
+```yaml
+test:
+  url: <%= ENV.fetch("DATABASE_URL") %>
+
+development:
+  url: <%= ENV.fetch("DATABASE_URL") %>
+
 ```
 
-And then execute:
 
-    $ bundle install
+You are ready to use rails with PostgreSQL configured
+
+    $ bundle exec rake db:create db:migrate
+    Creating blog_postgres_1 ... done
+    Created database 'blog_development'
+
+    $ bundle exec rails server
+
+
+## Without Rails
+
+ENV vars from .env.services are loaded with dotenv automatically.
+
+
+```ruby
+require "devup"
+require "sequel"
+
+DB = Sequel.connect(ENV.fetch("DATABASE_URL"))
+```
+
+
+## Without Ruby (PHP, nodejs, Java, ...)
+
+Start up services
+
+    $ devup
+    dummy_rails_postgres_1 is up-to-date
+    dummy_rails_redis_1 is up-to-date
+    dummy_rails_memcached_1 is up-to-date
+
+    $ cat .env.services
+    export POSTGRES_HOST=0.0.0.0
+    export POSTGRES_PORT=32944
+    export POSTGRES_PORT_5432=32944
+    export MEMCACHED_HOST=0.0.0.0
+    export MEMCACHED_PORT=32943
+    ...
+
+Use your favourite dotenv extension to load vars from .env.services ([node-dotenv](https://www.npmjs.com/package/dotenv), [python-dotenv](https://pypi.org/project/python-dotenv/), [phpdotenv](https://github.com/vlucas/phpdotenv), ...)
+
+Or load ENV vars manually
+
+    $ source .env.services
+
+Now you can run app
 
-Or install it yourself as:
+## How To
 
-    $ gem install devup
+### Disable **DevUp!**
 
-## Usage
+If you don't want devup to setup your dev services, you can disable it by using `DEVUP_ENABLED=false`. Just add it to .env.local file.
 
-TODO: Write usage instructions here
 
 ## Development
 

data/devup.gemspec

@@ -30,4 +30,6 @@ Gem::Specification.new do |spec|
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+
+  spec.add_dependency "dotenv"
 end

data/exe/devup

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require "devup"
+require "devup/environment"
 
 devup = Devup::Environment.new pwd: `pwd`
 

data/lib/devup.rb

@@ -3,9 +3,7 @@ require "devup/environment"
 
 module Devup
   class Error < StandardError; end
-  # Your code goes here...
-
-  def self.root
-    Pathname.new File.dirname(__dir__)
-  end
 end
+
+require "devup/boot"
+require "devup/dotenv"

data/lib/devup/boot.rb

@@ -0,0 +1,12 @@
+if ENV.fetch("DEVUP_ENABLED", "true") == "true"
+  devup = Devup::Environment.new pwd: `pwd`
+  devup.up
+
+  begin
+    require "spring/commands"
+
+    Spring.watch devup.root.join("docker-compose.yml")
+  rescue LoadError, ArgumentError
+    # Spring is not available
+  end
+end

data/lib/devup/compose.rb

@@ -1,12 +1,22 @@
 require "yaml"
+require "open3"
 
 module Devup
   class Compose
-    attr_reader :path, :project
+    attr_reader :path, :project, :logger
 
-    def initialize(path, project: "devup")
+    class Error < StandardError; end
+
+    def initialize(path, project: "devup", logger:)
       @path = path
       @project = project
+      @logger = logger
+    end
+
+    def check
+      _output, status = safe_exec("docker-compose -v")
+
+      status
     end
 
     def services
@@ -30,11 +40,23 @@ module Devup
     end
 
     def exec(cmd)
-      `docker-compose -p #{project} -f #{path} #{cmd}`
+      output, status = safe_exec "docker-compose -p #{project} -f #{path} #{cmd}"
+
+      raise(Error) unless status
+
+      output
     end
 
     private
 
+    def safe_exec(cmd)
+      output, error, status = Open3.capture3(cmd + ";")
+
+      logger.error(error) unless status.success?
+
+      [output, status.success?]
+    end
+
     def config
       YAML.safe_load(config_content)
     end

data/lib/devup/dotenv.rb

@@ -0,0 +1,2 @@
+require "dotenv"
+Dotenv.load ".env.services"

data/lib/devup/environment.rb

@@ -1,48 +1,47 @@
 require "yaml"
 
+require "devup/logger"
 require "devup/compose"
 require "devup/service"
+require "devup/service_presenter"
 
 module Devup
   class Environment
-    attr_reader :pwd, :compose
+    attr_reader :pwd, :compose, :logger
 
-    def initialize(pwd:, compose: nil)
+    def initialize(pwd:, compose: nil, logger: Logger.default)
       @pwd = pwd.to_s.strip
-      @compose = compose || Compose.new(root.join("docker-compose.yml"), project: project)
+      @compose = compose || Compose.new(root.join("docker-compose.devup.yml"), project: project, logger: logger)
+      @logger = logger
     end
 
     def project
       pwd.split("/")[-1].strip
     end
 
-    def vars
-      compose.services.map { |name| Service.new(compose, name) }.map { |service|
-        res = []
-
-        res << {"#{service.name}_HOST".upcase => "0.0.0.0"}
-
-        if service.ports.size > 0
-          res << {"#{service.name}_PORT".upcase => service.ports.first.to}
-
-          service.ports.each do |port|
-            res << {"#{service.name}_PORT_#{port.from}".upcase => port.to}
-          end
-        end
-
-        res
-      }.flatten
+    def env
+      services.map { |s| service_env(s) }.join("\n\n")
     end
 
     def up
+      logger.info "DevUp! is starting up services..."
+      check
       compose.up
       write_dotenv
+      logger.info "DevUp! is up"
+    rescue
+      clear_dotenv
+      logger.info "DevUp! halted"
     end
 
     def down
+      logger.info "DevUp! is shutting down services..."
       compose.stop
       compose.rm
       clear_dotenv
+      logger.info "DevUp! is down"
+    rescue
+      logger.info "DevUp! halted"
     end
 
     def root
@@ -51,6 +50,32 @@ module Devup
 
     private
 
+    def check
+      return false if missing_config
+
+      compose.check
+
+      true
+    end
+
+    def missing_config
+      if File.exist?(compose.path)
+        false
+      else
+        logger.error "missing #{compose.path}"
+
+        true
+      end
+    end
+
+    def services
+      @services ||= compose.services.map { |name| Service.new(compose, name) }
+    end
+
+    def service_env(service)
+      ServicePresenter.new(service, project: project).call
+    end
+
     def write_dotenv
       File.open(root.join(".env.services"), "w") { |f| f.write dotenv }
     end
@@ -61,11 +86,14 @@ module Devup
 
     def dotenv
       <<~DOTENV
-        ############################################
-        # This file is generated by devup command. #
-        ############################################
+        ####################################################
+        #     This file is generated by devup command.     #
+        #     Home: https://github.com/sergio-fry/devup    #
+        ####################################################
         # START
-        #{vars.reduce({}, :merge).map { |k, v| "#{k}=#{v}" }.join("\n")}
+
+        #{env}
+
         # END
 
       DOTENV

data/lib/devup/logger.rb

@@ -0,0 +1,10 @@
+require "logger"
+
+module Devup
+  class Logger < ::Logger
+    def self.default
+      formatter = ->(_severity, _time, _progname, msg) { "#{msg}\n" }
+      new(STDOUT, formatter: formatter)
+    end
+  end
+end

data/lib/devup/service.rb

@@ -10,10 +10,16 @@ module Devup
     end
 
     def ports
+      @ports ||= fetch_ports
+    end
+
+    private
+
+    def fetch_ports
       compose.service_ports(name).map { |el| el.to_s.split(":")[-1] }.map do |from|
         OpenStruct.new(
-          from: from,
-          to: compose.exec("port #{name} #{from}").split(":")[-1].strip
+          from: from.to_i,
+          to: compose.exec("port #{name} #{from}").split(":")[-1].strip.to_i
         )
       end
     end

data/lib/devup/service_presenter.rb

@@ -0,0 +1,88 @@
+module Devup
+  class ServicePresenter
+    attr_reader :service, :project
+
+    def initialize(service, project: nil)
+      @service = service
+      @project = project
+    end
+
+    def call
+      res = []
+
+      res << "# #{service.name}"
+      res << magic if magic?
+
+      if has_ports?
+        res << host_env
+        res << ports_env
+      else
+        res << "# no exposed ports"
+      end
+
+      res.join "\n"
+    end
+
+    private
+
+    def host_env
+      "export #{service.name.upcase}_HOST=0.0.0.0"
+    end
+
+    def ports_env
+      res = []
+
+      res << port_env(to: service.ports.first.to) if service.ports.size == 1
+
+      service.ports.each do |port|
+        res << port_env(from: port.from, to: port.to)
+      end
+
+      res.join "\n"
+    end
+
+    def port_env(from: nil, to:)
+      if from.nil?
+        "export #{service.name.upcase}_PORT=#{to}"
+      else
+        "export #{service.name.upcase}_PORT_#{from}=#{to}"
+      end
+    end
+
+    def has_ports?
+      service.ports.size > 0
+    end
+
+    def magic?
+      %w[postgres redis mysql memcached].include? service.name
+    end
+
+    def magic
+      case service.name
+      when "postgres"
+        "export DATABASE_URL=postgres://postgres@0.0.0.0:#{port_to(5432)}/#{database_name}"
+      when "mysql"
+        "export DATABASE_URL=mysql2://root@0.0.0.0:#{port_to(3306)}/#{database_name}"
+      when "redis"
+        "export REDIS_URL=redis://0.0.0.0:#{port_to(6379)}"
+      when "memcached"
+        "export MEMCACHE_SERVERS=0.0.0.0:#{port_to(11211)}"
+      end
+    end
+
+    def port_to(from)
+      service.ports.find { |p| p.from == from }&.to
+    end
+
+    def database_name
+      if defined? Rails
+        [
+          project,
+          Rails.env
+        ].join("_")
+      else
+        "db"
+      end
+    end
+  end
+end

data/lib/devup/version.rb

@@ -1,3 +1,3 @@
 module Devup
-  VERSION = "0.1.1"
+  VERSION = "0.3.2.1"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: devup
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.2.1
 platform: ruby
 authors:
 - Sergei O. Udalov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-03 00:00:00.000000000 Z
-dependencies: []
+date: 2020-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 - sergei@udalovs.ru
@@ -21,6 +35,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
+- ".standard.yml"
 - ".travis.yml"
 - ".vimrc"
 - CODE_OF_CONDUCT.md
@@ -34,9 +49,13 @@ files:
 - devup.gemspec
 - exe/devup
 - lib/devup.rb
+- lib/devup/boot.rb
 - lib/devup/compose.rb
+- lib/devup/dotenv.rb
 - lib/devup/environment.rb
+- lib/devup/logger.rb
 - lib/devup/service.rb
+- lib/devup/service_presenter.rb
 - lib/devup/version.rb
 homepage: https://github.com/sergio-fry/devup
 licenses: