devup 0.5.2 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cac2c49e58ab10b2851c040543e3d0559ba2827ddb65c0194e902ddaedc7b77
-  data.tar.gz: 75645b22886ac2e5ed3935797b53ef16a0221bee4b312f0a9cb5617619b7535e
+  metadata.gz: cad20921807b07f89d5f023a3c1cdb67f99c4b0768f6dca9a92403159cc179c7
+  data.tar.gz: 91a2e16e6d0d8dd48e2eac8e02c30bd4005b09a3a63933b71dc8f5aa1e75d66f
 SHA512:
-  metadata.gz: 80c00c1ba35664e0239b66aef478ee585b96b6000d8931ff27bce090448e002e2daa358d1e28f2ecaf896d55235ec21a6dcf69d28a0507f6dbd24009e58b243b
-  data.tar.gz: 1a94f305329fc701429203c17412b41406e4f14de59596d52895f68f4d7b1b4f92dca7f9212cbaa947b74949e6697acb7f146a2dfd6c353d487e90feba85c88c
+  metadata.gz: dee679549ee12b6b27c6673e5f69df48cf410ad1d5690f6e8e238cef4b8eb6f76b32d4a7b1db28ecb43c23ad188dd449d9b0b237cbb6abc9d7866b4b694d05f0
+  data.tar.gz: 64080623291135a341af34c102b2b8223c80cafbe9eef40425851cf20bea71bb04e8a68cc7bbad567d55a883f03841f1cee53f656bc898943aa4a3646e397be5

data/.gitignore

@@ -9,12 +9,14 @@
 /tmp/
 
 # rspec failure tracking
-.rspec_status
+/spec/examples.txt
 
 # Editor config
 .vimrc
+.nvimrc
 
-.env.services
+/.env.services
+/.env.local
 spec/dummy/.env.services
 spec/dummy_rails/.env.services
 

data/.rspec

@@ -1,3 +1,4 @@
---format documentation
+--format progress
 --color
 --require spec_helper
+--tag ~@integration

data/.travis.yml

@@ -23,7 +23,8 @@ jobs:
         - chmod +x ./cc-test-reporter
         - "./cc-test-reporter before-build"
       script:
-        - bundle exec rake spec
+        - bundle exec rspec
+        - SIMPLECOV_COMMAND_NAME=integration bundle exec rspec --tag @integration
       after_script:
         - "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
     - stage: test

data/.vimrc

@@ -1 +1,3 @@
+let g:ale_linters = {'ruby': ['standardrb'], 'javascript': ['standard'], 'json': ['jsonlint']}
+let g:ale_fixers = {'ruby': ['standardrb'], 'javascript': ['standard'], 'json': ['jq']}
 let g:ale_fix_on_save = 1

data/CHANGELOG.md

@@ -0,0 +1,76 @@
+# Change Log
+
+## master (unreleased)
+
+
+## 0.6.1 
+
+  * require "devup/env" to prevent boot on every load
+
+## 0.6.0
+  * Docker Compose v2.x support added
+  * refactoring
+
+
+## 0.5.3
+
+  * readme updated
+  * fix disabled mode
+
+## 0.5.2
+
+  * NameError rescue
+  * version display fixed
+
+## 0.5.0
+
+  * local envs
+  * readme updated
+
+## 0.4.3.1
+
+  * env shortcut for a first port
+
+## 0.4.2
+
+  * performance optimization
+
+## 0.4.0
+
+  * commands rework with dry-cli
+  * hits of code metric added
+  * better spring support
+  * no port errro fixed
+
+## 0.3.3
+
+  * refactoring
+  * debug option added
+  * up timeout added
+  * magic env names removed
+
+## 0.3.2
+
+  * reverted "remove old volumes (--renew-anon-volumes)"
+
+## 0.3.1
+
+  * do not clear env each time
+
+## 0.3.0
+
+  * magic ENV names for postgres, redis, mysql
+  * readme updated
+  * Spring integaration
+  * ability to disable
+  * log errors
+  * remove old volumes (--renew-anon-volumes)
+
+## 0.2.0
+
+  * CI configured
+  * proof of concept
+
+## 0.1.0
+
+  * repo init

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    devup (0.5.2)
+    devup (0.6.1)
       dotenv
       dry-cli
 
@@ -12,7 +12,7 @@ GEM
     byebug (11.1.3)
     concurrent-ruby (1.1.7)
     diff-lcs (1.4.4)
-    docile (1.3.2)
+    docile (1.4.0)
     dotenv (2.7.6)
     dry-cli (0.6.0)
       concurrent-ruby (~> 1.0)
@@ -50,10 +50,12 @@ GEM
     rubocop-performance (1.6.1)
       rubocop (>= 0.71.0)
     ruby-progressbar (1.10.1)
-    simplecov (0.18.5)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
     standard (0.4.7)
       rubocop (~> 0.85.0)
       rubocop-performance (~> 1.6.0)

data/README.md

@@ -1,6 +1,12 @@
 # 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) [![Hits-of-Code](https://hitsofcode.com/github/sergio-fry/devup)](https://hitsofcode.com/view/github/sergio-fry/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.
+
+Instead of installing and configuring local PostgreSQL, Redis and other external services, 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.
+
+1. `bundle add aasm --group=development,test`
+2. Describe external services inside docker-compose.devup.yml
+3. `devup up`
+4. Confugure app to use ENV
 
 
 ## Requirements
@@ -28,6 +34,9 @@ Add **DevUp!** to your Gemfile
 
 ```ruby
 gem "devup", group: [:development, :test]
+
+# To prevent devup boot every time, you can require "devup/env" only:
+# gem "devup", group: [:development, :test], require: "devup/env"
 ```
 
 and
@@ -110,7 +119,7 @@ Now you can run app
 
 ### 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.
+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.test.local file.
 
 ### Override some service
 

data/devup.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.email = ["sergei@udalovs.ru"]
 
   spec.summary = "A tool to manage docker-compose for development"
-  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.description = "Describe development services with YAML"
   spec.homepage = "https://github.com/sergio-fry/devup"
   spec.license = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
-  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  spec.metadata["changelog_uri"] = "https://github.com/sergio-fry/devup/blob/master/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/lib/devup/application.rb

@@ -6,9 +6,7 @@ require "dotenv"
 module Devup
   class Application
     def run
-      return if devup_disabled?
-
-      boot
+      boot unless devup_disabled?
       load_env
     end
 
@@ -27,19 +25,17 @@ module Devup
     def devup
       @devup ||= Devup::Environment.new(
         pwd: `pwd`,
-        logger: Devup::Logger.build(log_level)
+        logger: Devup::Logger.new(level: log_level)
       )
     end
 
     def load_env
-      begin
+      if defined? ActiveSupport::Notifications
         Dotenv.instrumenter = ActiveSupport::Notifications
         ActiveSupport::Notifications.subscribe(/^dotenv/) do |*args|
           event = ActiveSupport::Notifications::Event.new(*args)
-          Spring.watch event.payload[:env].filename # if Rails.application
+          Spring.watch event.payload[:env].filename if defined? Spring
         end
-      rescue LoadError, ArgumentError, NameError
-        # Spring is not available
       end
 
       Dotenv.load(*dotenv_list.to_a)

data/lib/devup/cli/commands/command.rb

@@ -13,7 +13,7 @@ module Devup
         attr_reader :opts
 
         def logger
-          @logger ||= Devup::Logger.build(log_level)
+          @logger ||= Devup::Logger.new(level: log_level)
         end
 
         def log_level

data/lib/devup/compose/port_config.rb

@@ -0,0 +1,17 @@
+module Devup
+  module Compose
+    class PortConfig
+      def initialize(config)
+        @config = config
+      end
+
+      def from
+        @config.split(":")[-1].to_i
+      end
+
+      def ==(another)
+        from == another.from
+      end
+    end
+  end
+end

data/lib/devup/compose/v1/compose.rb

@@ -0,0 +1,103 @@
+require "yaml"
+
+require "devup/compose/v1/processes"
+require "devup/compose/port_config"
+
+module Devup
+  module Compose
+    module V1
+      class Compose
+        attr_reader :path, :project, :logger, :shell
+
+        class Error < StandardError; end
+
+        def initialize(path, project: "devup", logger:, shell:)
+          @path = path
+          @project = project
+          @logger = logger
+          @shell = shell
+        end
+
+        def check
+          true
+        end
+
+        def services
+          config["services"].keys
+        end
+
+        def service_ports(name)
+          return [] if config["services"][name]["ports"].nil?
+
+          config["services"][name]["ports"].map { |el| PortConfig.new(el.to_s) }
+        end
+
+        def port_mapping(port)
+          processes.port_mapping(port)
+        end
+
+        def up
+          exec "up -d --remove-orphans"
+
+          wait_alive 3
+        end
+
+        def stop
+          exec "stop"
+        end
+
+        def rm
+          exec "rm -f"
+        end
+
+        private
+
+        def wait_alive(timeout, retry_sleep: 0.3)
+          start = Time.now
+
+          loop {
+            break if alive?
+
+            if Time.now - start > timeout
+              logger.error "can't run services"
+              break
+            end
+            sleep retry_sleep
+          }
+        end
+
+        def alive?
+          processes(cached: false).up?
+        end
+
+        def processes(cached: true)
+          Processes.new(cached ? exec_ps_cached : exec_ps)
+        end
+
+        def exec_ps
+          @exec_ps_output = exec("ps")
+        end
+
+        def exec_ps_cached
+          @exec_ps_output ||= exec("ps")
+        end
+
+        def exec(cmd)
+          resp = shell.exec "docker-compose -p #{project} -f #{path} #{cmd}"
+
+          raise(Error) unless resp.success?
+
+          resp.data
+        end
+
+        def config
+          YAML.safe_load(config_content)
+        end
+
+        def config_content
+          File.read(path)
+        end
+      end
+    end
+  end
+end

data/lib/devup/compose/v1/processes.rb

@@ -0,0 +1,34 @@
+require "devup/port_mapping"
+
+module Devup
+  module Compose
+    module V1
+      class Processes
+        attr_reader :output
+        def initialize(output)
+          @output = output
+        end
+
+        def up?
+          service_lines.map { |line|
+            line.match(/Up/) && !line.match(/Exit/)
+          }.all?
+        end
+
+        def port_mapping(port)
+          m = output.match(/\d{1,3}.\d{1,3}.\d{1,3}.\d{1,3}:(\d+)->#{port}\/tcp/)
+
+          return PortMapping.new(port, nil) if m.nil?
+
+          PortMapping.new(port, m[1].to_i)
+        end
+
+        private
+
+        def service_lines
+          output.split("\n")[2..-1]
+        end
+      end
+    end
+  end
+end

data/lib/devup/compose/v2/compose.rb

@@ -0,0 +1,14 @@
+require "devup/compose/v1/compose"
+require "devup/compose/v2/processes"
+
+module Devup
+  module Compose
+    module V2
+      class Compose < V1::Compose
+        def processes(cached: true)
+          Processes.new(cached ? exec_ps_cached : exec_ps)
+        end
+      end
+    end
+  end
+end

data/lib/devup/compose/v2/processes.rb

@@ -0,0 +1,21 @@
+require "devup/compose/v1/processes"
+
+module Devup
+  module Compose
+    module V2
+      class Processes < V1::Processes
+        def up?
+          service_lines.map { |line|
+            line.match(/running/) && !line.match(/exited/)
+          }.all?
+        end
+
+        private
+
+        def service_lines
+          output.split("\n")[1..-1]
+        end
+      end
+    end
+  end
+end

data/lib/devup/compose.rb

@@ -1,94 +1,17 @@
-require "yaml"
-
-require "devup/compose/ps"
+require "devup/compose/v1/compose"
+require "devup/compose/v2/compose"
 
 module Devup
-  class Compose
-    attr_reader :path, :project, :logger, :shell
-
-    class Error < StandardError; end
-
-    def initialize(path, project: "devup", logger:, shell:)
-      @path = path
-      @project = project
-      @logger = logger
-      @shell = shell
-    end
-
-    def check
-      true
-    end
-
-    def services
-      config["services"].keys
-    end
-
-    def service_ports(name)
-      return [] if config["services"][name]["ports"].nil?
-
-      config["services"][name]["ports"].map { |el| el.to_s.split(":")[-1].to_i }
-    end
-
-    def port_mapping(port)
-      ComposeHelpers::Ps.new(exec_ps_cached).port_mapping(port)
-    end
-
-    def up
-      exec "up -d --remove-orphans"
-
-      wait_alive 3
-    end
-
-    def stop
-      exec "stop"
-    end
-
-    def rm
-      exec "rm -f"
-    end
-
-    private
-
-    def wait_alive(timeout, retry_sleep: 0.3)
-      start = Time.now
-
-      loop {
-        break if alive?
-
-        if Time.now - start > timeout
-          logger.error "can't run services"
-          break
-        end
-        sleep retry_sleep
-      }
-    end
-
-    def alive?
-      ComposeHelpers::Ps.new(exec_ps).up?
-    end
-
-    def exec_ps
-      @exec_ps_output = exec("ps")
-    end
-
-    def exec_ps_cached
-      @exec_ps_output ||= exec("ps")
-    end
-
-    def exec(cmd)
-      resp = shell.exec "docker-compose -p #{project} -f #{path} #{cmd}"
-
-      raise(Error) unless resp.success?
-
-      resp.data
-    end
-
-    def config
-      YAML.safe_load(config_content)
-    end
-
-    def config_content
-      File.read(path)
+  module Compose
+    def self.current_version(version = `docker-compose -v`)
+      case version.match(/(\d).\d+.\d+/)[1].to_i
+      when 1
+        V1::Compose
+      when 2
+        V2::Compose
+      else
+        raise "Can't detect compose version"
+      end
     end
   end
 end

data/lib/devup/dotenv_load_list.rb

@@ -1,14 +1,18 @@
 module Devup
   class DotenvLoadList
     def initialize(env: nil)
-      @env = env.to_sym unless env.nil?
+      @env = env&.to_sym
     end
 
     def to_a
       list = []
 
       list << ".env.#{@env}.local" if env_defined?
+
+      # .env.local is ignored by dotenv-rails too. So behaviour is the same.
+      # https://github.com/bkeepers/dotenv/blob/08f22148fb14019dce1e9b1d8ac1a74788e49e1b/lib/dotenv/rails.rb#L69
       list << ".env.local" unless test?
+
       list << ".env.services"
       list << ".env.#{@env}" if env_defined?
       list << ".env"

data/lib/devup/env.rb

@@ -0,0 +1,10 @@
+require "devup/version"
+require "devup/environment"
+require "devup/application"
+
+module Devup
+  class Error < StandardError; end
+end
+
+app = Devup::Application.new
+app.load_env

data/lib/devup/environment.rb

@@ -1,16 +1,17 @@
 require "yaml"
 
 require "devup/logger"
-require "devup/compose"
 require "devup/service"
-require "devup/service_presenter"
+require "devup/service_dotenv"
 require "devup/shell"
 
+require "devup/compose"
+
 module Devup
   class Environment
     attr_reader :pwd, :logger, :shell
 
-    def initialize(pwd:, compose: nil, logger: Logger.build, shell: Shell.new(pwd: pwd, logger: logger))
+    def initialize(pwd:, compose: nil, logger:, shell: Shell.new(pwd: pwd, logger: logger))
       @pwd = pwd.to_s.strip
       @compose = compose
       @logger = logger
@@ -75,7 +76,7 @@ module Devup
     end
 
     def service_env(service)
-      ServicePresenter.new(service, project: project).call
+      ServiceDotenv.new(service, project: project).text
     end
 
     def write_dotenv
@@ -103,7 +104,7 @@ module Devup
 
     def compose
       @compose ||= begin
-                     Compose.new(
+                     Compose.current_version.new(
                        root.join("docker-compose.devup.yml"),
                        project: project, logger: logger, shell: shell
                      )

data/lib/devup/logger.rb

@@ -1,14 +1,36 @@
 require "logger"
 
 module Devup
-  class Logger < ::Logger
-    def self.build(level = :info)
-      formatter = ->(severity, _time, _progname, msg) { "DevUp! #{severity} #{msg}\n" }
-      logger = new(STDOUT, formatter: formatter)
+  class Logger
+    def initialize(device: STDOUT, level: :info)
+      @level = level
+      @device = device
+    end
+
+    def debug(msg)
+      logger.debug msg
+    end
 
-      logger.level = level
+    def info(msg)
+      logger.info msg
+    end
+
+    def error(msg)
+      logger.error msg
+    end
+
+    private
+
+    def logger
+      logger = ::Logger.new(@device, formatter: formatter)
+
+      logger.level = @level
 
       logger
     end
+
+    def formatter
+      ->(severity, _time, _progname, msg) { "DevUp! #{severity} #{msg}\n" }
+    end
   end
 end

data/lib/devup/port_checker.rb

@@ -2,6 +2,7 @@ require "socket"
 require "timeout"
 
 module Devup
+  # TODO we should use this to check ports are ready
   class PortChecker
     def call(port)
       s = TCPSocket.new("0.0.0.0", port)

data/lib/devup/port_mapping.rb

@@ -0,0 +1,14 @@
+module Devup
+  class PortMapping
+    def initialize(from, to)
+      @from = from
+      @to = to
+    end
+
+    attr_reader :from, :to
+
+    def ==(another)
+      @from == another.from && @to == another.to
+    end
+  end
+end

data/lib/devup/service.rb

@@ -1,4 +1,4 @@
-require "ostruct"
+require_relative "port_mapping"
 
 module Devup
   class Service
@@ -16,11 +16,8 @@ module Devup
     private
 
     def fetch_ports
-      compose.service_ports(name).map do |from|
-        OpenStruct.new(
-          from: from,
-          to: compose.port_mapping(from)
-        )
+      compose.service_ports(name).map do |el|
+        compose.port_mapping(el.from)
       end
     end
   end

data/lib/devup/{service_presenter.rb → service_dotenv.rb}

@@ -1,5 +1,5 @@
 module Devup
-  class ServicePresenter
+  class ServiceDotenv
     attr_reader :service, :project
 
     def initialize(service, project: nil)
@@ -7,7 +7,7 @@ module Devup
       @project = project
     end
 
-    def call
+    def text
       res = []
 
       res << "# #{service.name}"

data/lib/devup/shell.rb

@@ -9,6 +9,7 @@ module Devup
       @logger = logger
     end
 
+    # TODO maybe it should become somthing like ExecutedShellCommand ?
     Result = Struct.new(:data, :status) {
       def success?
         status

data/lib/devup/version.rb

@@ -1,3 +1,3 @@
 module Devup
-  VERSION = "0.5.2"
+  VERSION = "0.6.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devup
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.1
 platform: ruby
 authors:
 - Sergei O. Udalov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-15 00:00:00.000000000 Z
+date: 2022-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: Describe development services with YAML
 email:
 - sergei@udalovs.ru
 executables:
@@ -52,6 +52,7 @@ files:
 - ".standard.yml"
 - ".travis.yml"
 - ".vimrc"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -70,13 +71,19 @@ files:
 - lib/devup/cli/commands/down.rb
 - lib/devup/cli/commands/up.rb
 - lib/devup/compose.rb
-- lib/devup/compose/ps.rb
+- lib/devup/compose/port_config.rb
+- lib/devup/compose/v1/compose.rb
+- lib/devup/compose/v1/processes.rb
+- lib/devup/compose/v2/compose.rb
+- lib/devup/compose/v2/processes.rb
 - lib/devup/dotenv_load_list.rb
+- lib/devup/env.rb
 - lib/devup/environment.rb
 - lib/devup/logger.rb
 - lib/devup/port_checker.rb
+- lib/devup/port_mapping.rb
 - lib/devup/service.rb
-- lib/devup/service_presenter.rb
+- lib/devup/service_dotenv.rb
 - lib/devup/shell.rb
 - lib/devup/version.rb
 homepage: https://github.com/sergio-fry/devup
@@ -85,6 +92,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/sergio-fry/devup
   source_code_uri: https://github.com/sergio-fry/devup
+  changelog_uri: https://github.com/sergio-fry/devup/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:

data/lib/devup/compose/ps.rb

@@ -1,30 +0,0 @@
-module Devup
-  module ComposeHelpers
-    class Ps
-      attr_reader :output
-      def initialize(output)
-        @output = output
-      end
-
-      def up?
-        service_lines.map { |line|
-          line.match(/Up/) && !line.match(/Exit/)
-        }.all?
-      end
-
-      def port_mapping(port)
-        m = output.match(/\d{1,3}.\d{1,3}.\d{1,3}.\d{1,3}:(\d+)->#{port}\/tcp/)
-
-        return if m.nil?
-
-        m[1].to_i
-      end
-
-      private
-
-      def service_lines
-        output.split("\n")[2..-1]
-      end
-    end
-  end
-end