rails-docker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 04d6696ec1a18b9771455cfca1181b2107ff1745
+  data.tar.gz: 0dad95eab5a3e23a92e9a0fc0c0b6a7efa964510
+SHA512:
+  metadata.gz: 88f7d294c1eac688be18aab02d7e51a3a4bd7f0bcaae9ec016c8ca2ea991fcca6c1a4222b0b371cf53e271f9aa9b1abd8b39b83539b3ddf3445e22849faa083b
+  data.tar.gz: 0705805b0a2beb2b0f1fd59b0b092ca6a1e09a97af62167733a6975b3147c29071e06cc427614dbab2b9444f42d789bb2b2f1ae3cd5a0e59082cc7c694c3da8e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.0

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 ritschel@gmail.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 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails-docker.gemspec
+gemspec
+require 'rails'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 nicosuave
+
+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,78 @@
+# Rails::Docker
+
+New to Docker? Want to run your entire app self-contained in Docker during
+development? (No need to install Postgres on your development machine).
+
+Sick of `Dockerfile`, `.docker-ignore`, & `docker-compose.yml` copy pasta into
+each of your projects? `Rails::Docker` to the rescue!
+
+To begin with, `Rails::Docker` is fairly opinionated. Postgres is the only
+supported database.
+
+## Installation
+
+Add this line to your Rails (`>= 3.0`) application's Gemfile:
+
+```ruby
+gem 'rails-docker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails-docker
+
+## Prerequisites
+
+[Install docker](https://www.docker.com/products/overview)
+
+## Usage
+
+- `rails g docker:dockerfile` generates a relatively standard Dockerfile
+for running your rails projects into the root of your project.
+
+- `rails g docker:dockercompose` generates a Docker-based development
+environment, ready to rock with Postgres as your database
+
+To run your app in your newly-created Docker-based development environment,
+issue a `docker-compose up` from the root of your project.
+
+To execute a bash shell inside your container, issue a `docker-compose run bash`
+from the root of your project.
+
+To run a command inside your container (like running migrations or specs), issue
+a `docker compose run rake db:migrate`
+
+### Database Configuration
+Docker Compose links containers by default and sets the host name to the name of
+the service set in docker compose. By default, your Postgres database host will
+be `postgres`. I suggest using the `Postgres` user & a blank password in your
+`database.yml`.
+
+By default, port 3000 is exposed to your Docker host for serving your app. Port
+5432 of Postgres is mapped to 5433 on your host to avoid any port collisions
+if you already have Postgres running on the host.
+
+## The Future
+
+- [] - Support additional container types for docker-compose (MYSQL, MariaDB, Redis)
+- [] - Add Docker Swarm support
+- [] - Set the development database configuration via generator
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails-docker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails/docker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

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/lib/generators/docker/dockercompose_generator.rb

@@ -0,0 +1,10 @@
+module Docker
+  class DockercomposeGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+
+    desc 'Generate a .docker-compose for developement (includes Postgres)'
+    def generate_dockercompose
+      copy_file 'docker-compose.yml', 'docker-compose.yml'
+    end
+  end
+end

data/lib/generators/docker/dockerfile_generator.rb

@@ -0,0 +1,13 @@
+require 'erubis'
+
+module Docker
+  class DockerfileGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+
+    desc 'Generate a Dockerfile & .dockerignore'
+    def generate_dockerfile
+      copy_file 'Dockerfile', 'Dockerfile'
+      copy_file '.dockerignore', '.dockerignore'
+    end
+  end
+end

data/lib/generators/docker/templates/.dockerignore

@@ -0,0 +1,3 @@
+tmp/*
+log/*
+.bundle/*

data/lib/generators/docker/templates/Dockerfile

@@ -0,0 +1,19 @@
+FROM ruby:2.3.1
+
+RUN apt-get update -qq && apt-get install -y build-essential libpq-dev nodejs
+RUN apt-get install -y libxml2-dev libxslt1-dev libqt4-webkit libqt4-dev xvfb
+
+RUN gem install bundler
+
+WORKDIR /var/app
+
+COPY Gemfile Gemfile
+COPY Gemfile.lock Gemfile.lock
+
+RUN bundle install
+
+COPY . .
+
+EXPOSE 3000
+
+CMD bundle exec rails server --binding 0.0.0.0

data/lib/generators/docker/templates/docker-compose.yml

@@ -0,0 +1,13 @@
+version: '2'
+services:
+  postgres:
+    image: postgres:latest
+    ports:
+      - "5433:5432"
+  web:
+    build: .
+    command: bundle exec rails server --port 3000 --binding 0.0.0.0
+    ports:
+      - "3000:3000"
+    volumes:
+      - .:/var/app

data/lib/rails/docker/version.rb

@@ -0,0 +1,5 @@
+module Rails
+  module Docker
+    VERSION = "0.1.0"
+  end
+end

data/lib/rails/docker.rb

@@ -0,0 +1,2 @@
+require_relative '../generators/docker/dockerfile_generator'
+require_relative '../generators/docker/dockercompose_generator'

data/rails-docker.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails/docker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rails-docker'
+  spec.version       = Rails::Docker::VERSION
+  spec.authors       = ['nicosuave']
+  spec.email         = ['ritschel@gmail.com']
+
+  spec.summary       = %q{Docker generators for Rails}
+  spec.homepage      = 'https://github.com/nicosuave/rails-docker'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_runtime_dependency 'rails', '>= 3.0'
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: rails-docker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- nicosuave
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- ritschel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/docker/dockercompose_generator.rb
+- lib/generators/docker/dockerfile_generator.rb
+- lib/generators/docker/templates/.dockerignore
+- lib/generators/docker/templates/Dockerfile
+- lib/generators/docker/templates/docker-compose.yml
+- lib/rails/docker.rb
+- lib/rails/docker/version.rb
+- rails-docker.gemspec
+homepage: https://github.com/nicosuave/rails-docker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: Docker generators for Rails
+test_files: []