devup 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16b7a8648ef05f7206cc02900450f8f303fc948a0976ac959472451eeef1988f
-  data.tar.gz: a58834288dcd48d1cde4e353f1a77fb40b15419751896bdd7680b71be64a7266
+  metadata.gz: f3111015b0f138014ede5086a6df15c4e3e4f1b30d1bd7a199ec16a69b7eb84e
+  data.tar.gz: afab2b2376b8137be5bbbc2a3f85d3464720f63312d1a7cefbc948abbf07168d
 SHA512:
-  metadata.gz: 340f23ba29e0cd7e9c187f3ddb20d5e7c825503c5095fd4e3acd244ae2f714f89c2cfe636533207391292685244f4459b70af87a09ad82e7e8b3d9e70639aead
-  data.tar.gz: d596434a6a8450bf01b433a2f2e4c3abbed3f465046463954595badb82468fabd0f3fc6479d0fe9935dc1bbd48b246e11aabd723251b81b2d288ff7d103b822c
+  metadata.gz: 58a825f460fce341d66aa22e3b6c257c920908967a1ae64a207f274ebf051144cfba56a19e526e8555c5061d4f2bc37b14ae86bafc3f03a35315352d78aa98ee
+  data.tar.gz: c6897be6a6378476b21e65a0a7d59402641658a400bbc20b655f234d19ab5144e5d23b2bdd764558248519c63fdfc81eee7951c17bcadd779d4c2104377df091

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

@@ -5,6 +5,8 @@ language: ruby
 cache: bundler
 rvm:
 - 2.7.1
+- 2.6.6
+- 2.5.8
 services:
 - docker
 before_install:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    devup (0.2.0)
+    devup (0.3.0)
       dotenv
 
 GEM

data/README.md

@@ -1,96 +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)
 
-[![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)
+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.
 
-**DevUp!** is a tool to run dev dependencies. It builds ENV vars with dynamic exposed ports for services defined in a docker-compose.yml to access from application.
 
-![demo](demo.gif)
+## Requirements
 
-## Installation
+* Docker (>= 19.03.8)
+* Docker Compose (>= 1.25.5)
 
-    $ gem install devup
 
-## Usage
 
+## Rails
 
-Create a docker-compose.yml with app dependencies like:
+Create a docker-compose.devup.yml with app dependencies like:
 
 ```yaml
-version: '3'
+version: "3"
 
 services:
   postgres:
-    image: postgres
+    image: postgres:10-alpine
     ports:
       - "5432"
 ```
 
-Add devup/dotenv to your Gemfile:
+Add **DevUp!** to your Gemfile
 
-    gem "devup"
-
-For each service from docker-compose.yml **DevUp!**  will export ENV variable like
+```ruby
+gem "devup", group: [:development, :test]
+```
 
-    POSTGRES_HOST=0.0.0.0
-    POSTGRES_PORT=5432
+and
 
-### Rails
+    bundle install
 
 
 Update your database.yml to use ENV:
 
 ```yaml
-default: &default
-  adapter: postgresql
-  encoding: unicode
-  host: <%= ENV.fetch("POSTGRES_HOST") %>
-  port: <%= ENV.fetch("POSTGRES_PORT") %>
-  username: postgres
-  password:
+test:
+  url: <%= ENV.fetch("DATABASE_URL") %>
 
 development:
-  <<: *default
-  database: development
+  url: <%= ENV.fetch("DATABASE_URL") %>
 
-test:
-  <<: *default
-  database: test
 ```
 
 
-You are ready to start rails
+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
+## Without Rails
+
+ENV vars from .env.services are loaded with dotenv automatically.
 
 
 ```ruby
 require "devup"
 require "sequel"
 
-DB = Sequel.connect("postgres://postgres@#{ENV.fetch( "POSTGRES_HOST" )}:#{ENV.fetch("POSTGRES_PORT")}/database_name")
+DB = Sequel.connect(ENV.fetch("DATABASE_URL"))
 ```
 
 
-### Without Ruby (PHP, nodejs, Java, ...)
+## 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), ...)
 
-Load ENV vars from generated .env.services
+Or load ENV vars manually
 
     $ source .env.services
 
 Now you can run app
 
+## How To
+
+### Disable **DevUp!**
+
+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.
+
 
 ## Development
 

data/lib/devup/boot.rb

@@ -1,2 +1,12 @@
-devup = Devup::Environment.new pwd: `pwd`
-devup.up
+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
@@ -18,7 +28,7 @@ module Devup
     end
 
     def up
-      exec "up -d --remove-orphans"
+      exec "up -d --remove-orphans --renew-anon-volumes"
     end
 
     def stop
@@ -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/environment.rb

@@ -1,52 +1,49 @@
 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
-    end
-
     def env
-      vars.reduce({}, :merge).map { |k, v| "export #{k}=#{v}" }.join("\n")
+      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"
+      clear_dotenv
+
+    rescue StandardError
+      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 StandardError
+      logger.info "DevUp! halted"
     end
 
     def root
@@ -55,6 +52,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
@@ -70,7 +93,9 @@ module Devup
         #     Home: https://github.com/sergio-fry/devup    #
         ####################################################
         # START
+
         #{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.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devup
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Sergei O. Udalov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-05 00:00:00.000000000 Z
+date: 2020-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -35,6 +35,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
+- ".standard.yml"
 - ".travis.yml"
 - ".vimrc"
 - CODE_OF_CONDUCT.md
@@ -45,7 +46,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- demo.gif
 - devup.gemspec
 - exe/devup
 - lib/devup.rb
@@ -53,7 +53,9 @@ files:
 - 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: