dckerize 0.2.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e327ff0b2bc1abdea3a2386231b0077c5ef83ec9
-  data.tar.gz: 9f3c06125564f73841992c9ad1ce5f36f4f3985e
+  metadata.gz: 2d40a2a22aa0a03a3406e9f6dd3e59500935dbe7
+  data.tar.gz: 7023801fff0459073316a43f3e2df9e241eeffd4
 SHA512:
-  metadata.gz: 76d90d00c9a4af403648924777ef400e3ff095006bfd72ee9ff50ffaa84a0586eaafca8e8f6bf154f5f5e9ec79c3106132a38b66f51e29cd692027cedfef2784
-  data.tar.gz: 32e6e46e2834254a71e77b9e43efcccff72df9a98755b8f4aeaeaf34e95b86eeed51a8a962e6a7f090ae4873835675abc8e71a879f7a284377f6557b7425512f
+  metadata.gz: 9f6a947f040f081cd67ee37b46cee9cc9036ba02d0b04894ff2a6f3f93114cba8311b1fc55729882bb6670195a9f705a6e6f5b4082791d5c260dcf2f1769de9d
+  data.tar.gz: 4638884421623e3cf7a04402ef6b2ba58fb07b431ace32e937fe864051716040f0bbd4fcd62c51575906b8d1b2fd75a9c70e4b959048e3fe2b2f3aa7033e88d4

data/README.md

@@ -1,5 +1,6 @@
 # Dckerize
 [![Gem Version](https://badge.fury.io/rb/dckerize.svg)](http://badge.fury.io/rb/dckerize)
+[![Build Status](https://travis-ci.org/pacuna/dckerize.svg?branch=master)](https://travis-ci.org/pacuna/dckerize)
 
 Supercharged Rails development using Docker and Vagrant 
 
@@ -14,6 +15,7 @@ You'll get
 - An nginx/passenger container environment for serving your application and all the necessary configurations.
 - A separate container running MySQL/postgres for your DB.
 - A separate container for keeping your data using the data-only container pattern.
+- Extras (elasticsearch for now)
 
 ## Requirements
 
@@ -28,9 +30,22 @@ You'll get
 
 You need to have a Rails application already created.
 
-In the root of your application run:
+General usage:
+
+    $ dckerize up APP_NAME --database=[mysql|postgres] [--extras=elasticsearch]
+
+So for example in the root of your application run:
+
+    $ dckerize up APP_NAME --database=mysql
+
+Or
+
+    $ dckerize up APP_NAME --database=postgres
+
+Or
+
+    $ dckerize up APP_NAME --database=postgres --extras=elasticsearch
 
-    $ dckerize up APP_NAME --database=[mysql|postgres]
 
 Where APP_NAME should be the same name of your application and you must specify the database
 that you want to use.
@@ -62,6 +77,15 @@ In your config/database.yml add these lines to your configuration:
     password: <%= ENV['POSTGRES_ENV_POSTGRES_PASSWORD'] %> 
     host: postgres
 
+### Extras configuration
+
+#### Elasticsearch
+
+If you're using the elasticsearch-rails gem, you just need to specify the environment variables
+linked between the containers in your elasticsearch initializer and you'll be ready to go
+
+    ELASTICSEARCH_URL = ENV['ELASTICSEARCH_URL'] || ENV['ELASTICSEARCH_PORT_9200_TCP_ADDR']
+
 ### Developing
 
 Go inside the generated vagrant folder and run
@@ -104,6 +128,14 @@ And etc.
 The nginx container is mapping its port 80 with the port 80 of the guest host, and since we're declaring a private network in our Vagranfile
 you can access your application by visiting http://192.168.50.4.
 
+## TODO
+
+- [x] Support for more services (redis, elasticsearch)
+- Support for other ruby/rails versions
+- More workflow examples
+
+
+
 ## Video demo
 
 [![Dckerize](http://img.youtube.com/vi/X8IVAoBUtbs/0.jpg)](http://www.youtube.com/watch?v=X8IVAoBUtbs)

data/dckerize.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib", "templates"]
 
-  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
 end

data/exe/dckerize

@@ -2,23 +2,9 @@
 
 require "dckerize"
 
-up_command = ARGV[0]
-app_name = ARGV[1]
-db_name = ARGV[2]
-
-if up_command.to_s != 'up' || app_name.to_s == '' || db_name.to_s == ''
-  puts 'Usage: dckerize up APP_NAME --database==[postgres|mysql]'
-  exit 0;
-end
-
-if db_name == '--database=postgres'
-  generator = Dckerize::Generator.new(app_name, 'postgres')
-elsif db_name == '--database=mysql'
-  generator = Dckerize::Generator.new(app_name, 'mysql')
-else
-  puts 'Usage: dckerize up APP_NAME --database==[postgres|mysql]'
-  exit 0;
+begin
+Dckerize::Runner.new(ARGV).execute
+rescue Exception => e
+  puts e.message
+  exit 0
 end
-generator.up
-
-

data/lib/dckerize/extra.rb

@@ -0,0 +1,33 @@
+module Dckerize
+  class Extra
+    attr_accessor :name
+    def initialize(name)
+      @name = name
+    end
+
+    def image
+      if name == 'elasticsearch'
+        'elasticsearch'
+      end
+    end
+
+    def service_name
+      if name == 'elasticsearch'
+        'elasticsearch'
+      end
+    end
+
+    def alias
+      if name == 'elasticsearch'
+        'elasticsearch'
+      end
+    end
+
+    def env_variables
+      if name == 'elasticsearch'
+        ['ELASTICSEARCH_PORT_9200_TCP_ADDR', 'ELASTICSEARCH_URL']
+      end
+    end
+  end
+
+end

data/lib/dckerize/generator.rb

@@ -0,0 +1,57 @@
+module Dckerize
+  class Generator
+    attr_accessor :name, :db, :extras
+    def initialize(name, db, extras = [])
+      if db == 'mysql'
+        @db                      = 'mysql:5.7'
+        @db_password             = 'MYSQL_ROOT_PASSWORD'
+        @db_password_env         = 'MYSQL_ENV_MYSQL_ROOT_PASSWORD'
+        @db_host_env             = 'MYSQL_PORT_3306_TCP_ADDR'
+        @db_name_for_data_volume = 'mysql'
+        @db_service_name         = 'mysql'
+      elsif db == 'postgres'
+        @db                      = 'postgres'
+        @db_password             = 'POSTGRES_PASSWORD'
+        @db_password_env         = 'POSTGRES_ENV_POSTGRES_PASSWORD'
+        @db_host_env             = 'POSTGRES_PORT_5432_TCP_ADDR'
+        @db_name_for_data_volume = 'postgresql'
+        @db_service_name         = 'postgres'
+      end
+      @name = name
+
+      @extras = Array.new
+      extras.each do |extra|
+        @extras << Dckerize::Extra.new(extra)
+      end
+    end
+
+    def get_binding
+      binding
+    end
+
+    def templates
+      Dckerize.templates
+    end
+
+    def up
+      FileUtils.mkdir_p('conf')
+      FileUtils.mkdir_p('vagrant')
+
+      create_from_template('Vagrantfile.erb', 'vagrant/Vagrantfile')
+      create_from_template('Dockerfile.erb', 'Dockerfile')
+      create_from_template('site.conf.erb', "conf/#{@name}.conf")
+      create_from_template('env.conf.erb', "conf/env.conf")
+      create_from_template('docker-compose.yml.erb', "docker-compose.yml")
+      create_from_template('docker-compose-installer.sh.erb', "vagrant/docker-compose-installer.sh")
+    end
+
+    private
+    def create_from_template(template_name, output_file)
+      template = ERB.new(File.read("#{templates}/#{template_name}"), nil, '-')
+      result = template.result(binding)
+      File.open("#{output_file}", 'w') { |file| file.write(result) }
+    end
+
+  end
+
+end

data/lib/dckerize/runner.rb

@@ -0,0 +1,40 @@
+module Dckerize
+  class Runner
+
+    VALID_OPTIONS = ['--database=mysql', '--database=postgres', '--extras=elasticsearch']
+    ERROR_MESSAGE = 'USAGE: dckerize up --database=[mysql|postgres] [--extras=elasticsearch]'
+    def initialize(options)
+      @options = options
+    end
+
+    def execute
+      extras = []
+      db = ''
+      raise ERROR_MESSAGE unless valid?
+      @options[2..-1].each do |option|
+        splitted_option = option.split('=')
+        if splitted_option[0] == '--database'
+          db = splitted_option[1]
+        elsif splitted_option[0] == '--extras'
+          extras << splitted_option[1].split(',')
+        else
+          raise_error ERROR_MESSAGE
+        end
+      end
+      Dckerize::Generator.new(@options[1], db, extras.flatten).up
+    end
+
+    def valid?
+      # first option should always be up
+      return false if @options[0] != 'up'
+      # db is mandatory
+      return false unless @options.grep(/--database=/).any?
+      # only valid options allowed
+      @options[2..-1].each do |option|
+        return false unless VALID_OPTIONS.include?(option)        
+      end
+      true
+    end
+  end
+
+end

data/lib/dckerize/version.rb

@@ -1,3 +1,3 @@
 module Dckerize
-  VERSION = "0.2.3"
+  VERSION = "0.5.0"
 end

data/lib/dckerize.rb

@@ -1,4 +1,7 @@
 require "dckerize/version"
+require "dckerize/extra"
+require "dckerize/generator"
+require "dckerize/runner"
 require 'erb'
 require 'fileutils'
 
@@ -11,53 +14,4 @@ module Dckerize
     File.join root, 'templates'
   end
 
-  class Generator
-    attr_accessor :name, :db
-    def initialize(name, db)
-      if db == 'mysql'
-        @db                      = 'mysql:5.7'
-        @db_password             = 'MYSQL_ROOT_PASSWORD'
-        @db_password_env         = 'MYSQL_ENV_MYSQL_ROOT_PASSWORD'
-        @db_host_env             = 'MYSQL_PORT_3306_TCP_ADDR'
-        @db_name_for_data_volume = 'mysql'
-        @db_service_name         = 'mysql'
-      elsif db == 'postgres'
-        @db                      = 'postgres'
-        @db_password             = 'POSTGRES_PASSWORD'
-        @db_password_env         = 'POSTGRES_ENV_POSTGRES_PASSWORD'
-        @db_host_env             = 'POSTGRES_PORT_5432_TCP_ADDR'
-        @db_name_for_data_volume = 'postgresql'
-        @db_service_name         = 'postgres'
-      end
-      @name = name
-    end
-
-    def get_binding
-      binding
-    end
-
-    def templates
-      Dckerize.templates
-    end
-
-    def up
-      FileUtils.mkdir_p('conf')
-      FileUtils.mkdir_p('vagrant')
-
-      create_from_template('Vagrantfile.erb', 'vagrant/Vagrantfile')
-      create_from_template('Dockerfile.erb', 'Dockerfile')
-      create_from_template('site.conf.erb', "conf/#{@name}.conf")
-      create_from_template('env.conf.erb', "conf/env.conf")
-      create_from_template('docker-compose.yml.erb', "docker-compose.yml")
-      create_from_template('docker-compose-installer.sh.erb', "vagrant/docker-compose-installer.sh")
-    end
-
-    private
-    def create_from_template(template_name, output_file)
-      template = ERB.new(File.read("#{templates}/#{template_name}"))
-      result = template.result(binding)
-      File.open("#{output_file}", 'w') { |file| file.write(result) }
-    end
-
-  end
 end

data/templates/Vagrantfile.erb

@@ -19,6 +19,9 @@ Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
   config.vm.provision "docker" do |d|
     d.pull_images "<%= @db %>"
     d.pull_images "phusion/passenger-ruby22:0.9.15"
+    <%- @extras.each do |extra| -%>
+    d.pull_images "<%= extra.image %>"
+    <%- end -%>
   end
 
 

data/templates/docker-compose.yml.erb

@@ -22,5 +22,13 @@ webapp:
     - PASSENGER_APP_ENV=development
   links:
     - <%= @db_service_name %>:<%= @db_service_name %>
+    <%- @extras.each do |extra| -%>
+    - <%= extra.service_name %>:<%= extra.alias %>
+    <%- end -%>
   volumes:
     - /<%= @name %>:/home/app/<%= @name %>
+<%- @extras.each do |extra| -%>
+<%= extra.service_name %>:
+  image: <%= extra.image %>
+  name: <%= @name %>-<%= extra.service_name %>
+<%- end -%>

data/templates/env.conf.erb

@@ -1,2 +1,7 @@
 env <%= @db_password_env %>;
 env <%= @db_host_env %>;
+<% @extras.each do |extra| -%>
+<% extra.env_variables.each do |env_variable| -%>
+env <%= env_variable %>;
+<% end -%>
+<% end -%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dckerize
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Pablo Acuña
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-07 00:00:00.000000000 Z
+date: 2015-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +72,9 @@ files:
 - dckerize.gemspec
 - exe/dckerize
 - lib/dckerize.rb
+- lib/dckerize/extra.rb
+- lib/dckerize/generator.rb
+- lib/dckerize/runner.rb
 - lib/dckerize/version.rb
 - templates/Dockerfile.erb
 - templates/Vagrantfile.erb