├── .gitignore
├── .rspec
├── .travis.yml
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── Gemfile
├── Gemfile.lock
├── LICENSE.txt
├── README.md
├── Rakefile
├── bin
├── console
└── setup
├── example-app
├── .browserslistrc
├── .gitignore
├── .ruby-version
├── Gemfile
├── Gemfile.lock
├── README.md
├── Rakefile
├── app
│ ├── assets
│ │ ├── config
│ │ │ └── manifest.js
│ │ ├── images
│ │ │ └── .keep
│ │ └── stylesheets
│ │ │ └── application.css
│ ├── channels
│ │ └── application_cable
│ │ │ ├── channel.rb
│ │ │ └── connection.rb
│ ├── controllers
│ │ ├── application_controller.rb
│ │ └── concerns
│ │ │ └── .keep
│ ├── helpers
│ │ └── application_helper.rb
│ ├── javascript
│ │ ├── channels
│ │ │ ├── consumer.js
│ │ │ └── index.js
│ │ └── packs
│ │ │ └── application.js
│ ├── jobs
│ │ └── application_job.rb
│ ├── mailers
│ │ └── application_mailer.rb
│ ├── models
│ │ ├── application_record.rb
│ │ └── concerns
│ │ │ └── .keep
│ └── views
│ │ └── layouts
│ │ ├── application.html.erb
│ │ ├── mailer.html.erb
│ │ └── mailer.text.erb
├── babel.config.js
├── bin
│ ├── bundle
│ ├── rails
│ ├── rake
│ ├── setup
│ ├── spring
│ ├── webpack
│ ├── webpack-dev-server
│ └── yarn
├── config.ru
├── config
│ ├── application.rb
│ ├── boot.rb
│ ├── cable.yml
│ ├── credentials.yml.enc
│ ├── database.yml
│ ├── environment.rb
│ ├── environments
│ │ ├── development.rb
│ │ ├── production.rb
│ │ └── test.rb
│ ├── initializers
│ │ ├── application_controller_renderer.rb
│ │ ├── assets.rb
│ │ ├── backtrace_silencers.rb
│ │ ├── content_security_policy.rb
│ │ ├── cookies_serializer.rb
│ │ ├── filter_parameter_logging.rb
│ │ ├── inflections.rb
│ │ ├── mime_types.rb
│ │ └── wrap_parameters.rb
│ ├── locales
│ │ └── en.yml
│ ├── puma.rb
│ ├── routes.rb
│ ├── spring.rb
│ ├── storage.yml
│ ├── webpack
│ │ ├── development.js
│ │ ├── environment.js
│ │ ├── production.js
│ │ └── test.js
│ └── webpacker.yml
├── db
│ ├── schema.rb
│ └── seeds.rb
├── lib
│ ├── assets
│ │ └── .keep
│ └── tasks
│ │ └── .keep
├── log
│ └── .keep
├── package.json
├── postcss.config.js
├── public
│ ├── 404.html
│ ├── 422.html
│ ├── 500.html
│ ├── apple-touch-icon-precomposed.png
│ ├── apple-touch-icon.png
│ ├── favicon.ico
│ └── robots.txt
├── storage
│ └── .keep
├── tmp
│ └── .keep
├── vendor
│ └── .keep
└── yarn.lock
├── exe
└── railsdock
├── ext
└── railsdock
│ ├── extconf.rb
│ ├── railsdock.c
│ └── railsdock.h
├── lib
├── railsdock.rb
└── railsdock
│ ├── cli.rb
│ ├── command.rb
│ ├── commands
│ └── install.rb
│ ├── logo.rb
│ ├── templates
│ └── install
│ │ ├── default
│ │ ├── Dockerfile
│ │ ├── default.env.erb
│ │ ├── docker-compose.yml.erb
│ │ └── entrypoint.sh
│ │ ├── memcached
│ │ ├── Dockerfile
│ │ └── docker-compose.yml.erb
│ │ ├── mysql
│ │ ├── Dockerfile
│ │ ├── database.yml.erb
│ │ └── docker-compose.yml.erb
│ │ ├── postgres
│ │ ├── Dockerfile
│ │ ├── database.yml.erb
│ │ └── docker-compose.yml.erb
│ │ └── redis
│ │ ├── Dockerfile
│ │ └── docker-compose.yml.erb
│ └── version.rb
├── railsdock.gemspec
├── railsdock.png
└── spec
├── integration
├── .gitkeep
└── install_spec.rb
├── railsdock_spec.rb
├── spec_helper.rb
├── support
└── .gitkeep
└── unit
├── .gitkeep
└── install_spec.rb
/.gitignore:
--------------------------------------------------------------------------------
1 | /.bundle/
2 | /.yardoc
3 | /_yardoc/
4 | /coverage/
5 | /doc/
6 | /pkg/
7 | /spec/reports/
8 | /tmp/
9 | *.bundle
10 | *.so
11 | *.o
12 | *.a
13 | mkmf.log
14 | .DS_Store
15 | # rspec failure tracking
16 | .rspec_status
17 | /docker/*
18 | *.env
19 | dev-entrypoint
20 | /docker-compose.*
21 | example-app/docker/*
22 | example-app/*.env
23 | example-app/dev-entrypoint
24 | example-app/docker-compose.*
25 | /*.gem
--------------------------------------------------------------------------------
/.rspec:
--------------------------------------------------------------------------------
1 | --format documentation
2 | --color
3 | --require spec_helper
4 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | ---
2 | sudo: false
3 | language: ruby
4 | cache: bundler
5 | rvm:
6 | - 2.6.2
7 | before_install: gem install bundler -v 2.0.1
8 |
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # Changelog
2 | All notable changes to this project will be documented in this file.
3 |
4 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
5 |
6 | ## [Unreleased]
7 | ### Added
8 | ### Changed
9 | - move unset of Bundler env vars to entrypoint [PR34](https://github.com/hintmedia/railsdock/pull/34)
10 | ### Deprecated
11 | ### Removed
12 | - BUNDLE_HOME is no longer a Bundler env var [PR34](https://github.com/hintmedia/railsdock/pull/34)
13 | ### Fixed
14 | - a bug that would cause migrations not to run in certain scenarios [I31](https://github.com/hintmedia/railsdock/issues/31) [PR32](https://github.com/hintmedia/railsdock/pull/32)
15 | ### Security
16 |
17 | ## [0.4.0] - 08-08-2020
18 | ### Changed
19 | - default to exposing only necessary ports [PR26](https://github.com/hintmedia/railsdock/pull/26)
20 | - move most config to compose file [PR28](https://github.com/hintmedia/railsdock/pull/28)
21 | ### Fixed
22 | - handle new apps with no schema.rb or structure.sql [I22](https://github.com/hintmedia/railsdock/issues/22) [PR25](https://github.com/hintmedia/railsdock/pull/25)
23 |
24 | ## [0.3.1] - 07-20-2020
25 | ### Fixed
26 | - command in docker-compose template [PR21](https://github.com/hintmedia/railsdock/pull/21)
27 | ### Added
28 | - Initial Changelog
--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 | # Contributor Covenant Code of Conduct
2 |
3 | ## Our Pledge
4 |
5 | In the interest of fostering an open and welcoming environment, we as
6 | contributors and maintainers pledge to making participation in our project and
7 | our community a harassment-free experience for everyone, regardless of age, body
8 | size, disability, ethnicity, gender identity and expression, level of experience,
9 | nationality, personal appearance, race, religion, or sexual identity and
10 | orientation.
11 |
12 | ## Our Standards
13 |
14 | Examples of behavior that contributes to creating a positive environment
15 | include:
16 |
17 | * Using welcoming and inclusive language
18 | * Being respectful of differing viewpoints and experiences
19 | * Gracefully accepting constructive criticism
20 | * Focusing on what is best for the community
21 | * Showing empathy towards other community members
22 |
23 | Examples of unacceptable behavior by participants include:
24 |
25 | * The use of sexualized language or imagery and unwelcome sexual attention or
26 | advances
27 | * Trolling, insulting/derogatory comments, and personal or political attacks
28 | * Public or private harassment
29 | * Publishing others' private information, such as a physical or electronic
30 | address, without explicit permission
31 | * Other conduct which could reasonably be considered inappropriate in a
32 | professional setting
33 |
34 | ## Our Responsibilities
35 |
36 | Project maintainers are responsible for clarifying the standards of acceptable
37 | behavior and are expected to take appropriate and fair corrective action in
38 | response to any instances of unacceptable behavior.
39 |
40 | Project maintainers have the right and responsibility to remove, edit, or
41 | reject comments, commits, code, wiki edits, issues, and other contributions
42 | that are not aligned to this Code of Conduct, or to ban temporarily or
43 | permanently any contributor for other behaviors that they deem inappropriate,
44 | threatening, offensive, or harmful.
45 |
46 | ## Scope
47 |
48 | This Code of Conduct applies both within project spaces and in public spaces
49 | when an individual is representing the project or its community. Examples of
50 | representing a project or community include using an official project e-mail
51 | address, posting via an official social media account, or acting as an appointed
52 | representative at an online or offline event. Representation of a project may be
53 | further defined and clarified by project maintainers.
54 |
55 | ## Enforcement
56 |
57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be
58 | reported by contacting the project team at ksboe1@gmail.com. All
59 | complaints will be reviewed and investigated and will result in a response that
60 | is deemed necessary and appropriate to the circumstances. The project team is
61 | obligated to maintain confidentiality with regard to the reporter of an incident.
62 | Further details of specific enforcement policies may be posted separately.
63 |
64 | Project maintainers who do not follow or enforce the Code of Conduct in good
65 | faith may face temporary or permanent repercussions as determined by other
66 | members of the project's leadership.
67 |
68 | ## Attribution
69 |
70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71 | available at [http://contributor-covenant.org/version/1/4][version]
72 |
73 | [homepage]: http://contributor-covenant.org
74 | [version]: http://contributor-covenant.org/version/1/4/
75 |
--------------------------------------------------------------------------------
/Gemfile:
--------------------------------------------------------------------------------
1 | source "https://rubygems.org"
2 |
3 | gemspec
4 |
--------------------------------------------------------------------------------
/Gemfile.lock:
--------------------------------------------------------------------------------
1 | PATH
2 | remote: .
3 | specs:
4 | railsdock (0.4.0)
5 | bundler (~> 2.0)
6 | pastel (~> 0.7.2)
7 | railties (>= 4.2, < 6.1)
8 | thor (~> 1.0.0)
9 | tty-command (~> 0.8.0)
10 | tty-file (~> 0.7.0)
11 | tty-platform (~> 0.2.0)
12 | tty-prompt (~> 0.19.0)
13 |
14 | GEM
15 | remote: https://rubygems.org/
16 | specs:
17 | actionpack (6.0.3.7)
18 | actionview (= 6.0.3.7)
19 | activesupport (= 6.0.3.7)
20 | rack (~> 2.0, >= 2.0.8)
21 | rack-test (>= 0.6.3)
22 | rails-dom-testing (~> 2.0)
23 | rails-html-sanitizer (~> 1.0, >= 1.2.0)
24 | actionview (6.0.3.7)
25 | activesupport (= 6.0.3.7)
26 | builder (~> 3.1)
27 | erubi (~> 1.4)
28 | rails-dom-testing (~> 2.0)
29 | rails-html-sanitizer (~> 1.1, >= 1.2.0)
30 | activesupport (6.0.3.7)
31 | concurrent-ruby (~> 1.0, >= 1.0.2)
32 | i18n (>= 0.7, < 2)
33 | minitest (~> 5.1)
34 | tzinfo (~> 1.1)
35 | zeitwerk (~> 2.2, >= 2.2.2)
36 | appraisal (2.2.0)
37 | bundler
38 | rake
39 | thor (>= 0.14.0)
40 | builder (3.2.4)
41 | coderay (1.1.2)
42 | concurrent-ruby (1.1.8)
43 | crass (1.0.6)
44 | diff-lcs (1.3)
45 | equatable (0.6.1)
46 | erubi (1.10.0)
47 | i18n (1.8.10)
48 | concurrent-ruby (~> 1.0)
49 | loofah (2.9.1)
50 | crass (~> 1.0.2)
51 | nokogiri (>= 1.5.9)
52 | method_source (1.0.0)
53 | mini_portile2 (2.5.3)
54 | minitest (5.14.4)
55 | necromancer (0.5.1)
56 | nokogiri (1.11.7)
57 | mini_portile2 (~> 2.5.0)
58 | racc (~> 1.4)
59 | pastel (0.7.4)
60 | equatable (~> 0.6)
61 | tty-color (~> 0.5)
62 | pry (0.13.1)
63 | coderay (~> 1.1)
64 | method_source (~> 1.0)
65 | pry-rails (0.3.9)
66 | pry (>= 0.10.4)
67 | racc (1.5.2)
68 | rack (2.2.3)
69 | rack-test (1.1.0)
70 | rack (>= 1.0, < 3)
71 | rails-dom-testing (2.0.3)
72 | activesupport (>= 4.2.0)
73 | nokogiri (>= 1.6)
74 | rails-html-sanitizer (1.3.0)
75 | loofah (~> 2.3)
76 | railties (6.0.3.7)
77 | actionpack (= 6.0.3.7)
78 | activesupport (= 6.0.3.7)
79 | method_source
80 | rake (>= 0.8.7)
81 | thor (>= 0.20.3, < 2.0)
82 | rake (13.0.1)
83 | rake-compiler (1.1.0)
84 | rake
85 | rspec (3.9.0)
86 | rspec-core (~> 3.9.0)
87 | rspec-expectations (~> 3.9.0)
88 | rspec-mocks (~> 3.9.0)
89 | rspec-core (3.9.2)
90 | rspec-support (~> 3.9.3)
91 | rspec-expectations (3.9.2)
92 | diff-lcs (>= 1.2.0, < 2.0)
93 | rspec-support (~> 3.9.0)
94 | rspec-mocks (3.9.1)
95 | diff-lcs (>= 1.2.0, < 2.0)
96 | rspec-support (~> 3.9.0)
97 | rspec-support (3.9.3)
98 | thor (1.0.1)
99 | thread_safe (0.3.6)
100 | tty-color (0.5.1)
101 | tty-command (0.8.2)
102 | pastel (~> 0.7.0)
103 | tty-cursor (0.7.1)
104 | tty-file (0.7.1)
105 | diff-lcs (~> 1.3)
106 | pastel (~> 0.7.2)
107 | tty-prompt (~> 0.18)
108 | tty-platform (0.2.1)
109 | tty-prompt (0.19.0)
110 | necromancer (~> 0.5.0)
111 | pastel (~> 0.7.0)
112 | tty-reader (~> 0.6.0)
113 | tty-reader (0.6.0)
114 | tty-cursor (~> 0.7)
115 | tty-screen (~> 0.7)
116 | wisper (~> 2.0.0)
117 | tty-screen (0.8.1)
118 | tzinfo (1.2.9)
119 | thread_safe (~> 0.1)
120 | wisper (2.0.1)
121 | zeitwerk (2.4.2)
122 |
123 | PLATFORMS
124 | ruby
125 |
126 | DEPENDENCIES
127 | appraisal (= 2.2.0)
128 | pry-rails
129 | railsdock!
130 | rake (>= 12.3.3)
131 | rake-compiler
132 | rspec (~> 3.0)
133 |
134 | BUNDLED WITH
135 | 2.1.4
136 |
--------------------------------------------------------------------------------
/LICENSE.txt:
--------------------------------------------------------------------------------
1 | The MIT License (MIT)
2 |
3 | Copyright (c) 2019 Nate Vick
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy of
6 | this software and associated documentation files (the "Software"), to deal in
7 | the Software without restriction, including without limitation the rights to
8 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9 | the Software, and to permit persons to whom the Software is furnished to do so,
10 | subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17 | FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18 | COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19 | IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20 | CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | A command line tool for Dockerizing your Rails development environment.
6 |
7 | ## Prerequisite
8 |
9 | The configuration generated by this gem depends on [Docker Desktop](https://www.docker.com/products/docker-desktop). **Make sure it is installed before continuing.**
10 |
11 | ## Installation
12 |
13 | Install the gem:
14 |
15 | $ gem install railsdock
16 |
17 | Or add it to your Gemfile:
18 |
19 | ```ruby
20 | gem 'railsdock', require: false, group: :development
21 | ```
22 |
23 | Then run:
24 |
25 | $ bundle
26 |
27 | ## Usage
28 |
29 | Navigate to your project directory:
30 |
31 | $ cd /path/to/my/app
32 |
33 | Then run:
34 |
35 | $ railsdock install
36 |
37 | The gem will then walk you through configuring Docker by asking questions about your environment.
38 |
39 | ## Development
40 |
41 | 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.
42 |
43 | 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).
44 |
45 | ## Contributing
46 |
47 | Bug reports and pull requests are welcome on GitHub at https://github.com/hintmedia/railsdock. 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.
48 |
49 | ## Code of Conduct
50 |
51 | Everyone interacting in the Railsdock project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hintmedia/railsdock/blob/master/CODE_OF_CONDUCT.md).
52 |
53 | ## Copyright
54 |
55 | Copyright (c) 2019 Hint. See [MIT License](LICENSE.txt) for further details.
56 |
--------------------------------------------------------------------------------
/Rakefile:
--------------------------------------------------------------------------------
1 | require "bundler/gem_tasks"
2 | require "rspec/core/rake_task"
3 |
4 | RSpec::Core::RakeTask.new(:spec)
5 |
6 | require "rake/extensiontask"
7 |
8 | task :build => :compile
9 |
10 | Rake::ExtensionTask.new("railsdock") do |ext|
11 | ext.lib_dir = "lib/railsdock"
12 | end
13 |
14 | task :default => [:clobber, :compile, :spec]
15 |
--------------------------------------------------------------------------------
/bin/console:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env ruby
2 |
3 | require "bundler/setup"
4 | require "railsdock"
5 |
6 | # You can add fixtures and/or initialization code here to make experimenting
7 | # with your gem easier. You can also use a different console, if you like.
8 |
9 | # (If you use this, don't forget to add pry to your Gemfile!)
10 | require "pry"
11 | # Pry.start
12 |
13 | require "irb"
14 | IRB.start(__FILE__)
15 |
--------------------------------------------------------------------------------
/bin/setup:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | set -euo pipefail
3 | IFS=$'\n\t'
4 | set -vx
5 |
6 | bundle install
7 |
8 | # Do any other automated setup that you need to do here
9 |
--------------------------------------------------------------------------------
/example-app/.browserslistrc:
--------------------------------------------------------------------------------
1 | defaults
2 |
--------------------------------------------------------------------------------
/example-app/.gitignore:
--------------------------------------------------------------------------------
1 | # See https://help.github.com/articles/ignoring-files for more about ignoring files.
2 | #
3 | # If you find yourself ignoring temporary files generated by your text editor
4 | # or operating system, you probably want to add a global ignore instead:
5 | # git config --global core.excludesfile '~/.gitignore_global'
6 |
7 | # Ignore bundler config.
8 | /.bundle
9 |
10 | # Ignore all logfiles and tempfiles.
11 | /log/*
12 | /tmp/*
13 | !/log/.keep
14 | !/tmp/.keep
15 |
16 | # Ignore uploaded files in development.
17 | /storage/*
18 | !/storage/.keep
19 |
20 | /public/assets
21 | .byebug_history
22 |
23 | # Ignore master key for decrypting credentials and more.
24 | /config/master.key
25 |
26 | /public/packs
27 | /public/packs-test
28 | /node_modules
29 | /yarn-error.log
30 | yarn-debug.log*
31 | .yarn-integrity
32 |
--------------------------------------------------------------------------------
/example-app/.ruby-version:
--------------------------------------------------------------------------------
1 | ruby-2.6.6
2 |
--------------------------------------------------------------------------------
/example-app/Gemfile:
--------------------------------------------------------------------------------
1 | source 'https://rubygems.org'
2 | git_source(:github) { |repo| "https://github.com/#{repo}.git" }
3 |
4 | ruby '2.6.6'
5 |
6 | # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
7 | gem 'rails', '~> 6.0.1'
8 | # Use postgresql as the database for Active Record
9 | gem 'pg', '>= 0.18', '< 2.0'
10 | # Use Puma as the app server
11 | gem 'puma', '~> 4.3'
12 | # Use SCSS for stylesheets
13 | gem 'sass-rails', '>= 6'
14 | # Transpile app-like JavaScript. Read more: https://github.com/rails/webpacker
15 | gem 'webpacker'
16 | # Turbolinks makes navigating your web application faster. Read more: https://github.com/turbolinks/turbolinks
17 | gem 'turbolinks', '~> 5'
18 | # Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
19 | gem 'jbuilder', '~> 2.7'
20 | # Use Redis adapter to run Action Cable in production
21 | # gem 'redis', '~> 4.0'
22 | # Use Active Model has_secure_password
23 | # gem 'bcrypt', '~> 3.1.7'
24 |
25 | # Use Active Storage variant
26 | # gem 'image_processing', '~> 1.2'
27 |
28 | # Reduces boot times through caching; required in config/boot.rb
29 | gem 'bootsnap', '>= 1.4.2', require: false
30 |
31 | group :development, :test do
32 | # Call 'byebug' anywhere in the code to stop execution and get a debugger console
33 | gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
34 | end
35 |
36 | group :development do
37 | # Access an interactive console on exception pages or by calling 'console' anywhere in the code.
38 | gem 'web-console', '>= 3.3.0'
39 | gem 'listen', '>= 3.0.5', '< 3.2'
40 | # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
41 | gem 'spring'
42 | gem 'spring-watcher-listen', '~> 2.0.0'
43 | end
44 |
45 | # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
46 | gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
47 |
--------------------------------------------------------------------------------
/example-app/Gemfile.lock:
--------------------------------------------------------------------------------
1 | GEM
2 | remote: https://rubygems.org/
3 | specs:
4 | actioncable (6.0.3)
5 | actionpack (= 6.0.3)
6 | nio4r (~> 2.0)
7 | websocket-driver (>= 0.6.1)
8 | actionmailbox (6.0.3)
9 | actionpack (= 6.0.3)
10 | activejob (= 6.0.3)
11 | activerecord (= 6.0.3)
12 | activestorage (= 6.0.3)
13 | activesupport (= 6.0.3)
14 | mail (>= 2.7.1)
15 | actionmailer (6.0.3)
16 | actionpack (= 6.0.3)
17 | actionview (= 6.0.3)
18 | activejob (= 6.0.3)
19 | mail (~> 2.5, >= 2.5.4)
20 | rails-dom-testing (~> 2.0)
21 | actionpack (6.0.3)
22 | actionview (= 6.0.3)
23 | activesupport (= 6.0.3)
24 | rack (~> 2.0, >= 2.0.8)
25 | rack-test (>= 0.6.3)
26 | rails-dom-testing (~> 2.0)
27 | rails-html-sanitizer (~> 1.0, >= 1.2.0)
28 | actiontext (6.0.3)
29 | actionpack (= 6.0.3)
30 | activerecord (= 6.0.3)
31 | activestorage (= 6.0.3)
32 | activesupport (= 6.0.3)
33 | nokogiri (>= 1.8.5)
34 | actionview (6.0.3)
35 | activesupport (= 6.0.3)
36 | builder (~> 3.1)
37 | erubi (~> 1.4)
38 | rails-dom-testing (~> 2.0)
39 | rails-html-sanitizer (~> 1.1, >= 1.2.0)
40 | activejob (6.0.3)
41 | activesupport (= 6.0.3)
42 | globalid (>= 0.3.6)
43 | activemodel (6.0.3)
44 | activesupport (= 6.0.3)
45 | activerecord (6.0.3)
46 | activemodel (= 6.0.3)
47 | activesupport (= 6.0.3)
48 | activestorage (6.0.3)
49 | actionpack (= 6.0.3)
50 | activejob (= 6.0.3)
51 | activerecord (= 6.0.3)
52 | marcel (~> 0.3.1)
53 | activesupport (6.0.3)
54 | concurrent-ruby (~> 1.0, >= 1.0.2)
55 | i18n (>= 0.7, < 2)
56 | minitest (~> 5.1)
57 | tzinfo (~> 1.1)
58 | zeitwerk (~> 2.2, >= 2.2.2)
59 | bindex (0.8.1)
60 | bootsnap (1.4.6)
61 | msgpack (~> 1.0)
62 | builder (3.2.4)
63 | byebug (11.1.3)
64 | concurrent-ruby (1.1.6)
65 | crass (1.0.6)
66 | erubi (1.9.0)
67 | ffi (1.12.2)
68 | globalid (0.4.2)
69 | activesupport (>= 4.2.0)
70 | i18n (1.8.2)
71 | concurrent-ruby (~> 1.0)
72 | jbuilder (2.10.0)
73 | activesupport (>= 5.0.0)
74 | listen (3.1.5)
75 | rb-fsevent (~> 0.9, >= 0.9.4)
76 | rb-inotify (~> 0.9, >= 0.9.7)
77 | ruby_dep (~> 1.2)
78 | loofah (2.5.0)
79 | crass (~> 1.0.2)
80 | nokogiri (>= 1.5.9)
81 | mail (2.7.1)
82 | mini_mime (>= 0.1.1)
83 | marcel (0.3.3)
84 | mimemagic (~> 0.3.2)
85 | method_source (1.0.0)
86 | mimemagic (0.3.10)
87 | nokogiri (~> 1)
88 | rake
89 | mini_mime (1.0.2)
90 | mini_portile2 (2.5.3)
91 | minitest (5.14.0)
92 | msgpack (1.3.3)
93 | nio4r (2.5.7)
94 | nokogiri (1.11.7)
95 | mini_portile2 (~> 2.5.0)
96 | racc (~> 1.4)
97 | pg (1.2.3)
98 | puma (4.3.8)
99 | nio4r (~> 2.0)
100 | racc (1.5.2)
101 | rack (2.2.3)
102 | rack-proxy (0.6.5)
103 | rack
104 | rack-test (1.1.0)
105 | rack (>= 1.0, < 3)
106 | rails (6.0.3)
107 | actioncable (= 6.0.3)
108 | actionmailbox (= 6.0.3)
109 | actionmailer (= 6.0.3)
110 | actionpack (= 6.0.3)
111 | actiontext (= 6.0.3)
112 | actionview (= 6.0.3)
113 | activejob (= 6.0.3)
114 | activemodel (= 6.0.3)
115 | activerecord (= 6.0.3)
116 | activestorage (= 6.0.3)
117 | activesupport (= 6.0.3)
118 | bundler (>= 1.3.0)
119 | railties (= 6.0.3)
120 | sprockets-rails (>= 2.0.0)
121 | rails-dom-testing (2.0.3)
122 | activesupport (>= 4.2.0)
123 | nokogiri (>= 1.6)
124 | rails-html-sanitizer (1.3.0)
125 | loofah (~> 2.3)
126 | railties (6.0.3)
127 | actionpack (= 6.0.3)
128 | activesupport (= 6.0.3)
129 | method_source
130 | rake (>= 0.8.7)
131 | thor (>= 0.20.3, < 2.0)
132 | rake (13.0.1)
133 | rb-fsevent (0.10.4)
134 | rb-inotify (0.10.1)
135 | ffi (~> 1.0)
136 | ruby_dep (1.5.0)
137 | sass-rails (6.0.0)
138 | sassc-rails (~> 2.1, >= 2.1.1)
139 | sassc (2.3.0)
140 | ffi (~> 1.9)
141 | sassc-rails (2.1.2)
142 | railties (>= 4.0.0)
143 | sassc (>= 2.0)
144 | sprockets (> 3.0)
145 | sprockets-rails
146 | tilt
147 | semantic_range (2.3.0)
148 | spring (2.1.0)
149 | spring-watcher-listen (2.0.1)
150 | listen (>= 2.7, < 4.0)
151 | spring (>= 1.2, < 3.0)
152 | sprockets (4.0.0)
153 | concurrent-ruby (~> 1.0)
154 | rack (> 1, < 3)
155 | sprockets-rails (3.2.1)
156 | actionpack (>= 4.0)
157 | activesupport (>= 4.0)
158 | sprockets (>= 3.0.0)
159 | thor (1.0.1)
160 | thread_safe (0.3.6)
161 | tilt (2.0.10)
162 | turbolinks (5.2.1)
163 | turbolinks-source (~> 5.2)
164 | turbolinks-source (5.2.0)
165 | tzinfo (1.2.7)
166 | thread_safe (~> 0.1)
167 | web-console (4.0.2)
168 | actionview (>= 6.0.0)
169 | activemodel (>= 6.0.0)
170 | bindex (>= 0.4.0)
171 | railties (>= 6.0.0)
172 | webpacker (5.1.1)
173 | activesupport (>= 5.2)
174 | rack-proxy (>= 0.6.1)
175 | railties (>= 5.2)
176 | semantic_range (>= 2.3.0)
177 | websocket-driver (0.7.1)
178 | websocket-extensions (>= 0.1.0)
179 | websocket-extensions (0.1.5)
180 | zeitwerk (2.3.0)
181 |
182 | PLATFORMS
183 | ruby
184 |
185 | DEPENDENCIES
186 | bootsnap (>= 1.4.2)
187 | byebug
188 | jbuilder (~> 2.7)
189 | listen (>= 3.0.5, < 3.2)
190 | pg (>= 0.18, < 2.0)
191 | puma (~> 4.3)
192 | rails (~> 6.0.1)
193 | sass-rails (>= 6)
194 | spring
195 | spring-watcher-listen (~> 2.0.0)
196 | turbolinks (~> 5)
197 | tzinfo-data
198 | web-console (>= 3.3.0)
199 | webpacker
200 |
201 | RUBY VERSION
202 | ruby 2.6.6p146
203 |
204 | BUNDLED WITH
205 | 2.1.4
206 |
--------------------------------------------------------------------------------
/example-app/README.md:
--------------------------------------------------------------------------------
1 | # README
2 |
3 | This README would normally document whatever steps are necessary to get the
4 | application up and running.
5 |
6 | Things you may want to cover:
7 |
8 | * Ruby version
9 |
10 | * System dependencies
11 |
12 | * Configuration
13 |
14 | * Database creation
15 |
16 | * Database initialization
17 |
18 | * How to run the test suite
19 |
20 | * Services (job queues, cache servers, search engines, etc.)
21 |
22 | * Deployment instructions
23 |
24 | * ...
25 |
--------------------------------------------------------------------------------
/example-app/Rakefile:
--------------------------------------------------------------------------------
1 | # Add your own tasks in files placed in lib/tasks ending in .rake,
2 | # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
3 |
4 | require_relative 'config/application'
5 |
6 | Rails.application.load_tasks
7 |
--------------------------------------------------------------------------------
/example-app/app/assets/config/manifest.js:
--------------------------------------------------------------------------------
1 | //= link_tree ../images
2 | //= link_directory ../stylesheets .css
3 |
--------------------------------------------------------------------------------
/example-app/app/assets/images/.keep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hintmedia/railsdock/af472bd608d19a9ebc36c4e675dbdd6891477072/example-app/app/assets/images/.keep
--------------------------------------------------------------------------------
/example-app/app/assets/stylesheets/application.css:
--------------------------------------------------------------------------------
1 | /*
2 | * This is a manifest file that'll be compiled into application.css, which will include all the files
3 | * listed below.
4 | *
5 | * Any CSS and SCSS file within this directory, lib/assets/stylesheets, or any plugin's
6 | * vendor/assets/stylesheets directory can be referenced here using a relative path.
7 | *
8 | * You're free to add application-wide styles to this file and they'll appear at the bottom of the
9 | * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
10 | * files in this directory. Styles in this file should be added after the last require_* statement.
11 | * It is generally better to create a new file per style scope.
12 | *
13 | *= require_tree .
14 | *= require_self
15 | */
16 |
--------------------------------------------------------------------------------
/example-app/app/channels/application_cable/channel.rb:
--------------------------------------------------------------------------------
1 | module ApplicationCable
2 | class Channel < ActionCable::Channel::Base
3 | end
4 | end
5 |
--------------------------------------------------------------------------------
/example-app/app/channels/application_cable/connection.rb:
--------------------------------------------------------------------------------
1 | module ApplicationCable
2 | class Connection < ActionCable::Connection::Base
3 | end
4 | end
5 |
--------------------------------------------------------------------------------
/example-app/app/controllers/application_controller.rb:
--------------------------------------------------------------------------------
1 | class ApplicationController < ActionController::Base
2 | end
3 |
--------------------------------------------------------------------------------
/example-app/app/controllers/concerns/.keep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hintmedia/railsdock/af472bd608d19a9ebc36c4e675dbdd6891477072/example-app/app/controllers/concerns/.keep
--------------------------------------------------------------------------------
/example-app/app/helpers/application_helper.rb:
--------------------------------------------------------------------------------
1 | module ApplicationHelper
2 | end
3 |
--------------------------------------------------------------------------------
/example-app/app/javascript/channels/consumer.js:
--------------------------------------------------------------------------------
1 | // Action Cable provides the framework to deal with WebSockets in Rails.
2 | // You can generate new channels where WebSocket features live using the `rails generate channel` command.
3 |
4 | import { createConsumer } from "@rails/actioncable"
5 |
6 | export default createConsumer()
7 |
--------------------------------------------------------------------------------
/example-app/app/javascript/channels/index.js:
--------------------------------------------------------------------------------
1 | // Load all the channels within this directory and all subdirectories.
2 | // Channel files must be named *_channel.js.
3 |
4 | const channels = require.context('.', true, /_channel\.js$/)
5 | channels.keys().forEach(channels)
6 |
--------------------------------------------------------------------------------
/example-app/app/javascript/packs/application.js:
--------------------------------------------------------------------------------
1 | // This file is automatically compiled by Webpack, along with any other files
2 | // present in this directory. You're encouraged to place your actual application logic in
3 | // a relevant structure within app/javascript and only use these pack files to reference
4 | // that code so it'll be compiled.
5 |
6 | require("@rails/ujs").start()
7 | require("turbolinks").start()
8 | require("@rails/activestorage").start()
9 | require("channels")
10 |
11 |
12 | // Uncomment to copy all static images under ../images to the output folder and reference
13 | // them with the image_pack_tag helper in views (e.g <%= image_pack_tag 'rails.png' %>)
14 | // or the `imagePath` JavaScript helper below.
15 | //
16 | // const images = require.context('../images', true)
17 | // const imagePath = (name) => images(name, true)
18 |
--------------------------------------------------------------------------------
/example-app/app/jobs/application_job.rb:
--------------------------------------------------------------------------------
1 | class ApplicationJob < ActiveJob::Base
2 | # Automatically retry jobs that encountered a deadlock
3 | # retry_on ActiveRecord::Deadlocked
4 |
5 | # Most jobs are safe to ignore if the underlying records are no longer available
6 | # discard_on ActiveJob::DeserializationError
7 | end
8 |
--------------------------------------------------------------------------------
/example-app/app/mailers/application_mailer.rb:
--------------------------------------------------------------------------------
1 | class ApplicationMailer < ActionMailer::Base
2 | default from: 'from@example.com'
3 | layout 'mailer'
4 | end
5 |
--------------------------------------------------------------------------------
/example-app/app/models/application_record.rb:
--------------------------------------------------------------------------------
1 | class ApplicationRecord < ActiveRecord::Base
2 | self.abstract_class = true
3 | end
4 |
--------------------------------------------------------------------------------
/example-app/app/models/concerns/.keep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hintmedia/railsdock/af472bd608d19a9ebc36c4e675dbdd6891477072/example-app/app/models/concerns/.keep
--------------------------------------------------------------------------------
/example-app/app/views/layouts/application.html.erb:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Docker
5 | <%= csrf_meta_tags %>
6 | <%= csp_meta_tag %>
7 |
8 | <%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track': 'reload' %>
9 | <%= javascript_pack_tag 'application', 'data-turbolinks-track': 'reload' %>
10 |
11 |
12 |
13 | <%= yield %>
14 |
15 |
16 |
--------------------------------------------------------------------------------
/example-app/app/views/layouts/mailer.html.erb:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
8 |
9 |
10 |
11 | <%= yield %>
12 |
13 |
14 |
--------------------------------------------------------------------------------
/example-app/app/views/layouts/mailer.text.erb:
--------------------------------------------------------------------------------
1 | <%= yield %>
2 |
--------------------------------------------------------------------------------
/example-app/babel.config.js:
--------------------------------------------------------------------------------
1 | module.exports = function(api) {
2 | var validEnv = ['development', 'test', 'production']
3 | var currentEnv = api.env()
4 | var isDevelopmentEnv = api.env('development')
5 | var isProductionEnv = api.env('production')
6 | var isTestEnv = api.env('test')
7 |
8 | if (!validEnv.includes(currentEnv)) {
9 | throw new Error(
10 | 'Please specify a valid `NODE_ENV` or ' +
11 | '`BABEL_ENV` environment variables. Valid values are "development", ' +
12 | '"test", and "production". Instead, received: ' +
13 | JSON.stringify(currentEnv) +
14 | '.'
15 | )
16 | }
17 |
18 | return {
19 | presets: [
20 | isTestEnv && [
21 | '@babel/preset-env',
22 | {
23 | targets: {
24 | node: 'current'
25 | }
26 | }
27 | ],
28 | (isProductionEnv || isDevelopmentEnv) && [
29 | '@babel/preset-env',
30 | {
31 | forceAllTransforms: true,
32 | useBuiltIns: 'entry',
33 | corejs: 3,
34 | modules: false,
35 | exclude: ['transform-typeof-symbol']
36 | }
37 | ]
38 | ].filter(Boolean),
39 | plugins: [
40 | 'babel-plugin-macros',
41 | '@babel/plugin-syntax-dynamic-import',
42 | isTestEnv && 'babel-plugin-dynamic-import-node',
43 | '@babel/plugin-transform-destructuring',
44 | [
45 | '@babel/plugin-proposal-class-properties',
46 | {
47 | loose: true
48 | }
49 | ],
50 | [
51 | '@babel/plugin-proposal-object-rest-spread',
52 | {
53 | useBuiltIns: true
54 | }
55 | ],
56 | [
57 | '@babel/plugin-transform-runtime',
58 | {
59 | helpers: false,
60 | regenerator: true,
61 | corejs: false
62 | }
63 | ],
64 | [
65 | '@babel/plugin-transform-regenerator',
66 | {
67 | async: false
68 | }
69 | ]
70 | ].filter(Boolean)
71 | }
72 | }
73 |
--------------------------------------------------------------------------------
/example-app/bin/bundle:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env ruby
2 | # frozen_string_literal: true
3 |
4 | #
5 | # This file was generated by Bundler.
6 | #
7 | # The application 'bundle' is installed as part of a gem, and
8 | # this file is here to facilitate running it.
9 | #
10 |
11 | require "rubygems"
12 |
13 | m = Module.new do
14 | module_function
15 |
16 | def invoked_as_script?
17 | File.expand_path($0) == File.expand_path(__FILE__)
18 | end
19 |
20 | def env_var_version
21 | ENV["BUNDLER_VERSION"]
22 | end
23 |
24 | def cli_arg_version
25 | return unless invoked_as_script? # don't want to hijack other binstubs
26 | return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
27 | bundler_version = nil
28 | update_index = nil
29 | ARGV.each_with_index do |a, i|
30 | if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
31 | bundler_version = a
32 | end
33 | next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
34 | bundler_version = $1 || ">= 0.a"
35 | update_index = i
36 | end
37 | bundler_version
38 | end
39 |
40 | def gemfile
41 | gemfile = ENV["BUNDLE_GEMFILE"]
42 | return gemfile if gemfile && !gemfile.empty?
43 |
44 | File.expand_path("../../Gemfile", __FILE__)
45 | end
46 |
47 | def lockfile
48 | lockfile =
49 | case File.basename(gemfile)
50 | when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
51 | else "#{gemfile}.lock"
52 | end
53 | File.expand_path(lockfile)
54 | end
55 |
56 | def lockfile_version
57 | return unless File.file?(lockfile)
58 | lockfile_contents = File.read(lockfile)
59 | return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
60 | Regexp.last_match(1)
61 | end
62 |
63 | def bundler_version
64 | @bundler_version ||= begin
65 | env_var_version || cli_arg_version ||
66 | lockfile_version || "#{Gem::Requirement.default}.a"
67 | end
68 | end
69 |
70 | def load_bundler!
71 | ENV["BUNDLE_GEMFILE"] ||= gemfile
72 |
73 | # must dup string for RG < 1.8 compatibility
74 | activate_bundler(bundler_version.dup)
75 | end
76 |
77 | def activate_bundler(bundler_version)
78 | if Gem::Version.correct?(bundler_version) && Gem::Version.new(bundler_version).release < Gem::Version.new("2.0")
79 | bundler_version = "< 2"
80 | end
81 | gem_error = activation_error_handling do
82 | gem "bundler", bundler_version
83 | end
84 | return if gem_error.nil?
85 | require_error = activation_error_handling do
86 | require "bundler/version"
87 | end
88 | return if require_error.nil? && Gem::Requirement.new(bundler_version).satisfied_by?(Gem::Version.new(Bundler::VERSION))
89 | warn "Activating bundler (#{bundler_version}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_version}'`"
90 | exit 42
91 | end
92 |
93 | def activation_error_handling
94 | yield
95 | nil
96 | rescue StandardError, LoadError => e
97 | e
98 | end
99 | end
100 |
101 | m.load_bundler!
102 |
103 | if m.invoked_as_script?
104 | load Gem.bin_path("bundler", "bundle")
105 | end
106 |
--------------------------------------------------------------------------------
/example-app/bin/rails:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env ruby
2 | begin
3 | load File.expand_path('../spring', __FILE__)
4 | rescue LoadError => e
5 | raise unless e.message.include?('spring')
6 | end
7 | APP_PATH = File.expand_path('../config/application', __dir__)
8 | require_relative '../config/boot'
9 | require 'rails/commands'
10 |
--------------------------------------------------------------------------------
/example-app/bin/rake:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env ruby
2 | begin
3 | load File.expand_path('../spring', __FILE__)
4 | rescue LoadError => e
5 | raise unless e.message.include?('spring')
6 | end
7 | require_relative '../config/boot'
8 | require 'rake'
9 | Rake.application.run
10 |
--------------------------------------------------------------------------------
/example-app/bin/setup:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env ruby
2 | require 'fileutils'
3 |
4 | # path to your application root.
5 | APP_ROOT = File.expand_path('..', __dir__)
6 |
7 | def system!(*args)
8 | system(*args) || abort("\n== Command #{args} failed ==")
9 | end
10 |
11 | FileUtils.chdir APP_ROOT do
12 | # This script is a way to setup or update your development environment automatically.
13 | # This script is idempotent, so that you can run it at anytime and get an expectable outcome.
14 | # Add necessary setup steps to this file.
15 |
16 | puts '== Installing dependencies =='
17 | system! 'gem install bundler --conservative'
18 | system('bundle check') || system!('bundle install')
19 |
20 | # Install JavaScript dependencies
21 | # system('bin/yarn')
22 |
23 | # puts "\n== Copying sample files =="
24 | # unless File.exist?('config/database.yml')
25 | # FileUtils.cp 'config/database.yml.sample', 'config/database.yml'
26 | # end
27 |
28 | puts "\n== Preparing database =="
29 | system! 'bin/rails db:prepare'
30 |
31 | puts "\n== Removing old logs and tempfiles =="
32 | system! 'bin/rails log:clear tmp:clear'
33 |
34 | puts "\n== Restarting application server =="
35 | system! 'bin/rails restart'
36 | end
37 |
--------------------------------------------------------------------------------
/example-app/bin/spring:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env ruby
2 |
3 | # This file loads Spring without using Bundler, in order to be fast.
4 | # It gets overwritten when you run the `spring binstub` command.
5 |
6 | unless defined?(Spring)
7 | require 'rubygems'
8 | require 'bundler'
9 |
10 | lockfile = Bundler::LockfileParser.new(Bundler.default_lockfile.read)
11 | spring = lockfile.specs.detect { |spec| spec.name == 'spring' }
12 | if spring
13 | Gem.use_paths Gem.dir, Bundler.bundle_path.to_s, *Gem.path
14 | gem 'spring', spring.version
15 | require 'spring/binstub'
16 | end
17 | end
18 |
--------------------------------------------------------------------------------
/example-app/bin/webpack:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env ruby
2 |
3 | ENV["RAILS_ENV"] ||= ENV["RACK_ENV"] || "development"
4 | ENV["NODE_ENV"] ||= "development"
5 |
6 | require "pathname"
7 | ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
8 | Pathname.new(__FILE__).realpath)
9 |
10 | require "bundler/setup"
11 |
12 | require "webpacker"
13 | require "webpacker/webpack_runner"
14 |
15 | APP_ROOT = File.expand_path("..", __dir__)
16 | Dir.chdir(APP_ROOT) do
17 | Webpacker::WebpackRunner.run(ARGV)
18 | end
19 |
--------------------------------------------------------------------------------
/example-app/bin/webpack-dev-server:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env ruby
2 |
3 | ENV["RAILS_ENV"] ||= ENV["RACK_ENV"] || "development"
4 | ENV["NODE_ENV"] ||= "development"
5 |
6 | require "pathname"
7 | ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
8 | Pathname.new(__FILE__).realpath)
9 |
10 | require "bundler/setup"
11 |
12 | require "webpacker"
13 | require "webpacker/dev_server_runner"
14 |
15 | APP_ROOT = File.expand_path("..", __dir__)
16 | Dir.chdir(APP_ROOT) do
17 | Webpacker::DevServerRunner.run(ARGV)
18 | end
19 |
--------------------------------------------------------------------------------
/example-app/bin/yarn:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env ruby
2 | APP_ROOT = File.expand_path('..', __dir__)
3 | Dir.chdir(APP_ROOT) do
4 | begin
5 | exec "yarnpkg", *ARGV
6 | rescue Errno::ENOENT
7 | $stderr.puts "Yarn executable was not detected in the system."
8 | $stderr.puts "Download Yarn at https://yarnpkg.com/en/docs/install"
9 | exit 1
10 | end
11 | end
12 |
--------------------------------------------------------------------------------
/example-app/config.ru:
--------------------------------------------------------------------------------
1 | # This file is used by Rack-based servers to start the application.
2 |
3 | require_relative 'config/environment'
4 |
5 | run Rails.application
6 |
--------------------------------------------------------------------------------
/example-app/config/application.rb:
--------------------------------------------------------------------------------
1 | require_relative 'boot'
2 |
3 | require "rails"
4 | # Pick the frameworks you want:
5 | require "active_model/railtie"
6 | require "active_job/railtie"
7 | require "active_record/railtie"
8 | require "active_storage/engine"
9 | require "action_controller/railtie"
10 | require "action_mailer/railtie"
11 | require "action_mailbox/engine"
12 | require "action_text/engine"
13 | require "action_view/railtie"
14 | require "action_cable/engine"
15 | require "sprockets/railtie"
16 | # require "rails/test_unit/railtie"
17 |
18 | # Require the gems listed in Gemfile, including any gems
19 | # you've limited to :test, :development, or :production.
20 | Bundler.require(*Rails.groups)
21 |
22 | module Docker
23 | class Application < Rails::Application
24 | # Initialize configuration defaults for originally generated Rails version.
25 | config.load_defaults 6.0
26 |
27 | # Settings in config/environments/* take precedence over those specified here.
28 | # Application configuration can go into files in config/initializers
29 | # -- all .rb files in that directory are automatically loaded after loading
30 | # the framework and any gems in your application.
31 |
32 | # Don't generate system test files.
33 | config.generators.system_tests = nil
34 | end
35 | end
36 |
--------------------------------------------------------------------------------
/example-app/config/boot.rb:
--------------------------------------------------------------------------------
1 | ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
2 |
3 | require 'bundler/setup' # Set up gems listed in the Gemfile.
4 | require 'bootsnap/setup' # Speed up boot time by caching expensive operations.
5 |
--------------------------------------------------------------------------------
/example-app/config/cable.yml:
--------------------------------------------------------------------------------
1 | development:
2 | adapter: async
3 |
4 | test:
5 | adapter: test
6 |
7 | production:
8 | adapter: redis
9 | url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
10 | channel_prefix: docker_production
11 |
--------------------------------------------------------------------------------
/example-app/config/credentials.yml.enc:
--------------------------------------------------------------------------------
1 | LmzSjIqToSQA1xlK7RZiWvym4JwNXuTWxX/L/ngUeseM0KuFMCJaQalzEqE3iSVxhEMlmyj+/h5kQ7o305K8C50rlSryyUTXPi0BUAob5+8qsIE3UR0ko5kD9ekL4dunJMAb7OskTphxcIVB2J4sktY89EJ4IhJWcJpQd/CJKgPaWGTBU7/rivameA1ffqRlsQUR+bG1Io5NNiuTH1pCwm0jLy+m59wMOeBPaeXQCIoiE8RBB6arbq9G8s19qm3Y+85YAlGYMBZPuxyTYisQY8v1P0rpgok9Pd5S2GaQhlY/O4K1SJzHsDwq8xDZ2sYx/wWNTArXQSdw1h/sfV0toCoZSoP5SIyVsL9jJUcr4fH983Qg9CCV6jVXMCgxVEahyeXA3LPRYhhCRkbU9XZL/JgwUMeMQlvUQgN4--znpU3nQ1miPmxIKw--36m5JvluuvvsU32Kb5wyvw==
--------------------------------------------------------------------------------
/example-app/config/database.yml:
--------------------------------------------------------------------------------
1 | default: &default
2 | adapter: postgresql
3 | encoding: unicode
4 | pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
5 | host: postgres
6 | port: 5432
7 | username: postgres
8 |
9 | # Warning: The database defined as "test" will be erased and
10 | # re-generated from your development database when you run "rake".
11 | # Do not set this db to the same as development or production.
12 | test:
13 | <<: *default
14 | database: docker_test
15 |
16 | development:
17 | <<: *default
18 | database: docker_development
--------------------------------------------------------------------------------
/example-app/config/environment.rb:
--------------------------------------------------------------------------------
1 | # Load the Rails application.
2 | require_relative 'application'
3 |
4 | # Initialize the Rails application.
5 | Rails.application.initialize!
6 |
--------------------------------------------------------------------------------
/example-app/config/environments/development.rb:
--------------------------------------------------------------------------------
1 | Rails.application.configure do
2 | # Settings specified here will take precedence over those in config/application.rb.
3 |
4 | # In the development environment your application's code is reloaded on
5 | # every request. This slows down response time but is perfect for development
6 | # since you don't have to restart the web server when you make code changes.
7 | config.cache_classes = false
8 |
9 | # Do not eager load code on boot.
10 | config.eager_load = false
11 |
12 | # Show full error reports.
13 | config.consider_all_requests_local = true
14 |
15 | # Enable/disable caching. By default caching is disabled.
16 | # Run rails dev:cache to toggle caching.
17 | if Rails.root.join('tmp', 'caching-dev.txt').exist?
18 | config.action_controller.perform_caching = true
19 | config.action_controller.enable_fragment_cache_logging = true
20 |
21 | config.cache_store = :memory_store
22 | config.public_file_server.headers = {
23 | 'Cache-Control' => "public, max-age=#{2.days.to_i}"
24 | }
25 | else
26 | config.action_controller.perform_caching = false
27 |
28 | config.cache_store = :null_store
29 | end
30 |
31 | # Store uploaded files on the local file system (see config/storage.yml for options).
32 | config.active_storage.service = :local
33 |
34 | # Don't care if the mailer can't send.
35 | config.action_mailer.raise_delivery_errors = false
36 |
37 | config.action_mailer.perform_caching = false
38 |
39 | # Print deprecation notices to the Rails logger.
40 | config.active_support.deprecation = :log
41 |
42 | # Raise an error on page load if there are pending migrations.
43 | config.active_record.migration_error = :page_load
44 |
45 | # Highlight code that triggered database queries in logs.
46 | config.active_record.verbose_query_logs = true
47 |
48 | # Debug mode disables concatenation and preprocessing of assets.
49 | # This option may cause significant delays in view rendering with a large
50 | # number of complex assets.
51 | config.assets.debug = true
52 |
53 | # Suppress logger output for asset requests.
54 | config.assets.quiet = true
55 |
56 | # Raises error for missing translations.
57 | # config.action_view.raise_on_missing_translations = true
58 |
59 | # Use an evented file watcher to asynchronously detect changes in source code,
60 | # routes, locales, etc. This feature depends on the listen gem.
61 | config.file_watcher = ActiveSupport::EventedFileUpdateChecker
62 | end
63 |
--------------------------------------------------------------------------------
/example-app/config/environments/production.rb:
--------------------------------------------------------------------------------
1 | Rails.application.configure do
2 | # Settings specified here will take precedence over those in config/application.rb.
3 |
4 | # Code is not reloaded between requests.
5 | config.cache_classes = true
6 |
7 | # Eager load code on boot. This eager loads most of Rails and
8 | # your application in memory, allowing both threaded web servers
9 | # and those relying on copy on write to perform better.
10 | # Rake tasks automatically ignore this option for performance.
11 | config.eager_load = true
12 |
13 | # Full error reports are disabled and caching is turned on.
14 | config.consider_all_requests_local = false
15 | config.action_controller.perform_caching = true
16 |
17 | # Ensures that a master key has been made available in either ENV["RAILS_MASTER_KEY"]
18 | # or in config/master.key. This key is used to decrypt credentials (and other encrypted files).
19 | # config.require_master_key = true
20 |
21 | # Disable serving static files from the `/public` folder by default since
22 | # Apache or NGINX already handles this.
23 | config.public_file_server.enabled = ENV['RAILS_SERVE_STATIC_FILES'].present?
24 |
25 | # Compress CSS using a preprocessor.
26 | # config.assets.css_compressor = :sass
27 |
28 | # Do not fallback to assets pipeline if a precompiled asset is missed.
29 | config.assets.compile = false
30 |
31 | # Enable serving of images, stylesheets, and JavaScripts from an asset server.
32 | # config.action_controller.asset_host = 'http://assets.example.com'
33 |
34 | # Specifies the header that your server uses for sending files.
35 | # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
36 | # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
37 |
38 | # Store uploaded files on the local file system (see config/storage.yml for options).
39 | config.active_storage.service = :local
40 |
41 | # Mount Action Cable outside main process or domain.
42 | # config.action_cable.mount_path = nil
43 | # config.action_cable.url = 'wss://example.com/cable'
44 | # config.action_cable.allowed_request_origins = [ 'http://example.com', /http:\/\/example.*/ ]
45 |
46 | # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
47 | # config.force_ssl = true
48 |
49 | # Use the lowest log level to ensure availability of diagnostic information
50 | # when problems arise.
51 | config.log_level = :debug
52 |
53 | # Prepend all log lines with the following tags.
54 | config.log_tags = [ :request_id ]
55 |
56 | # Use a different cache store in production.
57 | # config.cache_store = :mem_cache_store
58 |
59 | # Use a real queuing backend for Active Job (and separate queues per environment).
60 | # config.active_job.queue_adapter = :resque
61 | # config.active_job.queue_name_prefix = "docker_production"
62 |
63 | config.action_mailer.perform_caching = false
64 |
65 | # Ignore bad email addresses and do not raise email delivery errors.
66 | # Set this to true and configure the email server for immediate delivery to raise delivery errors.
67 | # config.action_mailer.raise_delivery_errors = false
68 |
69 | # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
70 | # the I18n.default_locale when a translation cannot be found).
71 | config.i18n.fallbacks = true
72 |
73 | # Send deprecation notices to registered listeners.
74 | config.active_support.deprecation = :notify
75 |
76 | # Use default logging formatter so that PID and timestamp are not suppressed.
77 | config.log_formatter = ::Logger::Formatter.new
78 |
79 | # Use a different logger for distributed setups.
80 | # require 'syslog/logger'
81 | # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new 'app-name')
82 |
83 | if ENV["RAILS_LOG_TO_STDOUT"].present?
84 | logger = ActiveSupport::Logger.new(STDOUT)
85 | logger.formatter = config.log_formatter
86 | config.logger = ActiveSupport::TaggedLogging.new(logger)
87 | end
88 |
89 | # Do not dump schema after migrations.
90 | config.active_record.dump_schema_after_migration = false
91 |
92 | # Inserts middleware to perform automatic connection switching.
93 | # The `database_selector` hash is used to pass options to the DatabaseSelector
94 | # middleware. The `delay` is used to determine how long to wait after a write
95 | # to send a subsequent read to the primary.
96 | #
97 | # The `database_resolver` class is used by the middleware to determine which
98 | # database is appropriate to use based on the time delay.
99 | #
100 | # The `database_resolver_context` class is used by the middleware to set
101 | # timestamps for the last write to the primary. The resolver uses the context
102 | # class timestamps to determine how long to wait before reading from the
103 | # replica.
104 | #
105 | # By default Rails will store a last write timestamp in the session. The
106 | # DatabaseSelector middleware is designed as such you can define your own
107 | # strategy for connection switching and pass that into the middleware through
108 | # these configuration options.
109 | # config.active_record.database_selector = { delay: 2.seconds }
110 | # config.active_record.database_resolver = ActiveRecord::Middleware::DatabaseSelector::Resolver
111 | # config.active_record.database_resolver_context = ActiveRecord::Middleware::DatabaseSelector::Resolver::Session
112 | end
113 |
--------------------------------------------------------------------------------
/example-app/config/environments/test.rb:
--------------------------------------------------------------------------------
1 | # The test environment is used exclusively to run your application's
2 | # test suite. You never need to work with it otherwise. Remember that
3 | # your test database is "scratch space" for the test suite and is wiped
4 | # and recreated between test runs. Don't rely on the data there!
5 |
6 | Rails.application.configure do
7 | # Settings specified here will take precedence over those in config/application.rb.
8 |
9 | config.cache_classes = false
10 |
11 | # Do not eager load code on boot. This avoids loading your whole application
12 | # just for the purpose of running a single test. If you are using a tool that
13 | # preloads Rails for running tests, you may have to set it to true.
14 | config.eager_load = false
15 |
16 | # Configure public file server for tests with Cache-Control for performance.
17 | config.public_file_server.enabled = true
18 | config.public_file_server.headers = {
19 | 'Cache-Control' => "public, max-age=#{1.hour.to_i}"
20 | }
21 |
22 | # Show full error reports and disable caching.
23 | config.consider_all_requests_local = true
24 | config.action_controller.perform_caching = false
25 | config.cache_store = :null_store
26 |
27 | # Raise exceptions instead of rendering exception templates.
28 | config.action_dispatch.show_exceptions = false
29 |
30 | # Disable request forgery protection in test environment.
31 | config.action_controller.allow_forgery_protection = false
32 |
33 | # Store uploaded files on the local file system in a temporary directory.
34 | config.active_storage.service = :test
35 |
36 | config.action_mailer.perform_caching = false
37 |
38 | # Tell Action Mailer not to deliver emails to the real world.
39 | # The :test delivery method accumulates sent emails in the
40 | # ActionMailer::Base.deliveries array.
41 | config.action_mailer.delivery_method = :test
42 |
43 | # Print deprecation notices to the stderr.
44 | config.active_support.deprecation = :stderr
45 |
46 | # Raises error for missing translations.
47 | # config.action_view.raise_on_missing_translations = true
48 | end
49 |
--------------------------------------------------------------------------------
/example-app/config/initializers/application_controller_renderer.rb:
--------------------------------------------------------------------------------
1 | # Be sure to restart your server when you modify this file.
2 |
3 | # ActiveSupport::Reloader.to_prepare do
4 | # ApplicationController.renderer.defaults.merge!(
5 | # http_host: 'example.org',
6 | # https: false
7 | # )
8 | # end
9 |
--------------------------------------------------------------------------------
/example-app/config/initializers/assets.rb:
--------------------------------------------------------------------------------
1 | # Be sure to restart your server when you modify this file.
2 |
3 | # Version of your assets, change this if you want to expire all your assets.
4 | Rails.application.config.assets.version = '1.0'
5 |
6 | # Add additional assets to the asset load path.
7 | # Rails.application.config.assets.paths << Emoji.images_path
8 | # Add Yarn node_modules folder to the asset load path.
9 | Rails.application.config.assets.paths << Rails.root.join('node_modules')
10 |
11 | # Precompile additional assets.
12 | # application.js, application.css, and all non-JS/CSS in the app/assets
13 | # folder are already added.
14 | # Rails.application.config.assets.precompile += %w( admin.js admin.css )
15 |
--------------------------------------------------------------------------------
/example-app/config/initializers/backtrace_silencers.rb:
--------------------------------------------------------------------------------
1 | # Be sure to restart your server when you modify this file.
2 |
3 | # You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
4 | # Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
5 |
6 | # You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
7 | # Rails.backtrace_cleaner.remove_silencers!
8 |
--------------------------------------------------------------------------------
/example-app/config/initializers/content_security_policy.rb:
--------------------------------------------------------------------------------
1 | # Be sure to restart your server when you modify this file.
2 |
3 | # Define an application-wide content security policy
4 | # For further information see the following documentation
5 | # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy
6 |
7 | # Rails.application.config.content_security_policy do |policy|
8 | # policy.default_src :self, :https
9 | # policy.font_src :self, :https, :data
10 | # policy.img_src :self, :https, :data
11 | # policy.object_src :none
12 | # policy.script_src :self, :https
13 | # policy.style_src :self, :https
14 | # # If you are using webpack-dev-server then specify webpack-dev-server host
15 | # policy.connect_src :self, :https, "http://localhost:3035", "ws://localhost:3035" if Rails.env.development?
16 |
17 | # # Specify URI for violation reports
18 | # # policy.report_uri "/csp-violation-report-endpoint"
19 | # end
20 |
21 | # If you are using UJS then enable automatic nonce generation
22 | # Rails.application.config.content_security_policy_nonce_generator = -> request { SecureRandom.base64(16) }
23 |
24 | # Set the nonce only to specific directives
25 | # Rails.application.config.content_security_policy_nonce_directives = %w(script-src)
26 |
27 | # Report CSP violations to a specified URI
28 | # For further information see the following documentation:
29 | # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy-Report-Only
30 | # Rails.application.config.content_security_policy_report_only = true
31 |
--------------------------------------------------------------------------------
/example-app/config/initializers/cookies_serializer.rb:
--------------------------------------------------------------------------------
1 | # Be sure to restart your server when you modify this file.
2 |
3 | # Specify a serializer for the signed and encrypted cookie jars.
4 | # Valid options are :json, :marshal, and :hybrid.
5 | Rails.application.config.action_dispatch.cookies_serializer = :json
6 |
--------------------------------------------------------------------------------
/example-app/config/initializers/filter_parameter_logging.rb:
--------------------------------------------------------------------------------
1 | # Be sure to restart your server when you modify this file.
2 |
3 | # Configure sensitive parameters which will be filtered from the log file.
4 | Rails.application.config.filter_parameters += [:password]
5 |
--------------------------------------------------------------------------------
/example-app/config/initializers/inflections.rb:
--------------------------------------------------------------------------------
1 | # Be sure to restart your server when you modify this file.
2 |
3 | # Add new inflection rules using the following format. Inflections
4 | # are locale specific, and you may define rules for as many different
5 | # locales as you wish. All of these examples are active by default:
6 | # ActiveSupport::Inflector.inflections(:en) do |inflect|
7 | # inflect.plural /^(ox)$/i, '\1en'
8 | # inflect.singular /^(ox)en/i, '\1'
9 | # inflect.irregular 'person', 'people'
10 | # inflect.uncountable %w( fish sheep )
11 | # end
12 |
13 | # These inflection rules are supported but not enabled by default:
14 | # ActiveSupport::Inflector.inflections(:en) do |inflect|
15 | # inflect.acronym 'RESTful'
16 | # end
17 |
--------------------------------------------------------------------------------
/example-app/config/initializers/mime_types.rb:
--------------------------------------------------------------------------------
1 | # Be sure to restart your server when you modify this file.
2 |
3 | # Add new mime types for use in respond_to blocks:
4 | # Mime::Type.register "text/richtext", :rtf
5 |
--------------------------------------------------------------------------------
/example-app/config/initializers/wrap_parameters.rb:
--------------------------------------------------------------------------------
1 | # Be sure to restart your server when you modify this file.
2 |
3 | # This file contains settings for ActionController::ParamsWrapper which
4 | # is enabled by default.
5 |
6 | # Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
7 | ActiveSupport.on_load(:action_controller) do
8 | wrap_parameters format: [:json]
9 | end
10 |
11 | # To enable root element in JSON for ActiveRecord objects.
12 | # ActiveSupport.on_load(:active_record) do
13 | # self.include_root_in_json = true
14 | # end
15 |
--------------------------------------------------------------------------------
/example-app/config/locales/en.yml:
--------------------------------------------------------------------------------
1 | # Files in the config/locales directory are used for internationalization
2 | # and are automatically loaded by Rails. If you want to use locales other
3 | # than English, add the necessary files in this directory.
4 | #
5 | # To use the locales, use `I18n.t`:
6 | #
7 | # I18n.t 'hello'
8 | #
9 | # In views, this is aliased to just `t`:
10 | #
11 | # <%= t('hello') %>
12 | #
13 | # To use a different locale, set it with `I18n.locale`:
14 | #
15 | # I18n.locale = :es
16 | #
17 | # This would use the information in config/locales/es.yml.
18 | #
19 | # The following keys must be escaped otherwise they will not be retrieved by
20 | # the default I18n backend:
21 | #
22 | # true, false, on, off, yes, no
23 | #
24 | # Instead, surround them with single quotes.
25 | #
26 | # en:
27 | # 'true': 'foo'
28 | #
29 | # To learn more, please read the Rails Internationalization guide
30 | # available at https://guides.rubyonrails.org/i18n.html.
31 |
32 | en:
33 | hello: "Hello world"
34 |
--------------------------------------------------------------------------------
/example-app/config/puma.rb:
--------------------------------------------------------------------------------
1 | # Puma can serve each request in a thread from an internal thread pool.
2 | # The `threads` method setting takes two numbers: a minimum and maximum.
3 | # Any libraries that use thread pools should be configured to match
4 | # the maximum value specified for Puma. Default is set to 5 threads for minimum
5 | # and maximum; this matches the default thread size of Active Record.
6 | #
7 | max_threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }
8 | min_threads_count = ENV.fetch("RAILS_MIN_THREADS") { max_threads_count }
9 | threads min_threads_count, max_threads_count
10 |
11 | # Specifies the `port` that Puma will listen on to receive requests; default is 3000.
12 | #
13 | port ENV.fetch("PORT") { 3000 }
14 |
15 | # Specifies the `environment` that Puma will run in.
16 | #
17 | environment ENV.fetch("RAILS_ENV") { "development" }
18 |
19 | # Specifies the `pidfile` that Puma will use.
20 | pidfile ENV.fetch("PIDFILE") { "tmp/pids/server.pid" }
21 |
22 | # Specifies the number of `workers` to boot in clustered mode.
23 | # Workers are forked web server processes. If using threads and workers together
24 | # the concurrency of the application would be max `threads` * `workers`.
25 | # Workers do not work on JRuby or Windows (both of which do not support
26 | # processes).
27 | #
28 | # workers ENV.fetch("WEB_CONCURRENCY") { 2 }
29 |
30 | # Use the `preload_app!` method when specifying a `workers` number.
31 | # This directive tells Puma to first boot the application and load code
32 | # before forking the application. This takes advantage of Copy On Write
33 | # process behavior so workers use less memory.
34 | #
35 | # preload_app!
36 |
37 | # Allow puma to be restarted by `rails restart` command.
38 | plugin :tmp_restart
39 |
--------------------------------------------------------------------------------
/example-app/config/routes.rb:
--------------------------------------------------------------------------------
1 | Rails.application.routes.draw do
2 | # For details on the DSL available within this file, see https://guides.rubyonrails.org/routing.html
3 | end
4 |
--------------------------------------------------------------------------------
/example-app/config/spring.rb:
--------------------------------------------------------------------------------
1 | Spring.watch(
2 | ".ruby-version",
3 | ".rbenv-vars",
4 | "tmp/restart.txt",
5 | "tmp/caching-dev.txt"
6 | )
7 |
--------------------------------------------------------------------------------
/example-app/config/storage.yml:
--------------------------------------------------------------------------------
1 | test:
2 | service: Disk
3 | root: <%= Rails.root.join("tmp/storage") %>
4 |
5 | local:
6 | service: Disk
7 | root: <%= Rails.root.join("storage") %>
8 |
9 | # Use rails credentials:edit to set the AWS secrets (as aws:access_key_id|secret_access_key)
10 | # amazon:
11 | # service: S3
12 | # access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %>
13 | # secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %>
14 | # region: us-east-1
15 | # bucket: your_own_bucket
16 |
17 | # Remember not to checkin your GCS keyfile to a repository
18 | # google:
19 | # service: GCS
20 | # project: your_project
21 | # credentials: <%= Rails.root.join("path/to/gcs.keyfile") %>
22 | # bucket: your_own_bucket
23 |
24 | # Use rails credentials:edit to set the Azure Storage secret (as azure_storage:storage_access_key)
25 | # microsoft:
26 | # service: AzureStorage
27 | # storage_account_name: your_account_name
28 | # storage_access_key: <%= Rails.application.credentials.dig(:azure_storage, :storage_access_key) %>
29 | # container: your_container_name
30 |
31 | # mirror:
32 | # service: Mirror
33 | # primary: local
34 | # mirrors: [ amazon, google, microsoft ]
35 |
--------------------------------------------------------------------------------
/example-app/config/webpack/development.js:
--------------------------------------------------------------------------------
1 | process.env.NODE_ENV = process.env.NODE_ENV || 'development'
2 |
3 | const environment = require('./environment')
4 |
5 | module.exports = environment.toWebpackConfig()
6 |
--------------------------------------------------------------------------------
/example-app/config/webpack/environment.js:
--------------------------------------------------------------------------------
1 | const { environment } = require('@rails/webpacker')
2 |
3 | module.exports = environment
4 |
--------------------------------------------------------------------------------
/example-app/config/webpack/production.js:
--------------------------------------------------------------------------------
1 | process.env.NODE_ENV = process.env.NODE_ENV || 'production'
2 |
3 | const environment = require('./environment')
4 |
5 | module.exports = environment.toWebpackConfig()
6 |
--------------------------------------------------------------------------------
/example-app/config/webpack/test.js:
--------------------------------------------------------------------------------
1 | process.env.NODE_ENV = process.env.NODE_ENV || 'development'
2 |
3 | const environment = require('./environment')
4 |
5 | module.exports = environment.toWebpackConfig()
6 |
--------------------------------------------------------------------------------
/example-app/config/webpacker.yml:
--------------------------------------------------------------------------------
1 | # Note: You must restart bin/webpack-dev-server for changes to take effect
2 |
3 | default: &default
4 | source_path: app/javascript
5 | source_entry_path: packs
6 | public_root_path: public
7 | public_output_path: packs
8 | cache_path: tmp/cache/webpacker
9 | check_yarn_integrity: false
10 | webpack_compile_output: true
11 |
12 | # Additional paths webpack should lookup modules
13 | # ['app/assets', 'engine/foo/app/assets']
14 | resolved_paths: []
15 |
16 | # Reload manifest.json on all requests so we reload latest compiled packs
17 | cache_manifest: false
18 |
19 | # Extract and emit a css file
20 | extract_css: false
21 |
22 | static_assets_extensions:
23 | - .jpg
24 | - .jpeg
25 | - .png
26 | - .gif
27 | - .tiff
28 | - .ico
29 | - .svg
30 | - .eot
31 | - .otf
32 | - .ttf
33 | - .woff
34 | - .woff2
35 |
36 | extensions:
37 | - .mjs
38 | - .js
39 | - .sass
40 | - .scss
41 | - .css
42 | - .module.sass
43 | - .module.scss
44 | - .module.css
45 | - .png
46 | - .svg
47 | - .gif
48 | - .jpeg
49 | - .jpg
50 |
51 | development:
52 | <<: *default
53 | compile: true
54 |
55 | # Verifies that correct packages and versions are installed by inspecting package.json, yarn.lock, and node_modules
56 | check_yarn_integrity: true
57 |
58 | # Reference: https://webpack.js.org/configuration/dev-server/
59 | dev_server:
60 | https: false
61 | host: localhost
62 | port: 3035
63 | public: localhost:3035
64 | hmr: false
65 | # Inline should be set to true if using HMR
66 | inline: true
67 | overlay: true
68 | compress: true
69 | disable_host_check: true
70 | use_local_ip: false
71 | quiet: false
72 | pretty: false
73 | headers:
74 | 'Access-Control-Allow-Origin': '*'
75 | watch_options:
76 | ignored: '**/node_modules/**'
77 |
78 |
79 | test:
80 | <<: *default
81 | compile: true
82 |
83 | # Compile test packs to a separate directory
84 | public_output_path: packs-test
85 |
86 | production:
87 | <<: *default
88 |
89 | # Production depends on precompilation of packs prior to booting for performance.
90 | compile: false
91 |
92 | # Extract and emit a css file
93 | extract_css: true
94 |
95 | # Cache manifest.json for performance
96 | cache_manifest: true
97 |
--------------------------------------------------------------------------------
/example-app/db/schema.rb:
--------------------------------------------------------------------------------
1 | # This file is auto-generated from the current state of the database. Instead
2 | # of editing this file, please use the migrations feature of Active Record to
3 | # incrementally modify your database, and then regenerate this schema definition.
4 | #
5 | # This file is the source Rails uses to define your schema when running `rails
6 | # db:schema:load`. When creating a new database, `rails db:schema:load` tends to
7 | # be faster and is potentially less error prone than running all of your
8 | # migrations from scratch. Old migrations may fail to apply correctly if those
9 | # migrations use external dependencies or application code.
10 | #
11 | # It's strongly recommended that you check this file into your version control system.
12 |
13 | ActiveRecord::Schema.define(version: 0) do
14 |
15 | # These are extensions that must be enabled in order to support this database
16 | enable_extension "plpgsql"
17 |
18 | end
19 |
--------------------------------------------------------------------------------
/example-app/db/seeds.rb:
--------------------------------------------------------------------------------
1 | # This file should contain all the record creation needed to seed the database with its default values.
2 | # The data can then be loaded with the rails db:seed command (or created alongside the database with db:setup).
3 | #
4 | # Examples:
5 | #
6 | # movies = Movie.create([{ name: 'Star Wars' }, { name: 'Lord of the Rings' }])
7 | # Character.create(name: 'Luke', movie: movies.first)
8 |
--------------------------------------------------------------------------------
/example-app/lib/assets/.keep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hintmedia/railsdock/af472bd608d19a9ebc36c4e675dbdd6891477072/example-app/lib/assets/.keep
--------------------------------------------------------------------------------
/example-app/lib/tasks/.keep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hintmedia/railsdock/af472bd608d19a9ebc36c4e675dbdd6891477072/example-app/lib/tasks/.keep
--------------------------------------------------------------------------------
/example-app/log/.keep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hintmedia/railsdock/af472bd608d19a9ebc36c4e675dbdd6891477072/example-app/log/.keep
--------------------------------------------------------------------------------
/example-app/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "docker",
3 | "private": true,
4 | "dependencies": {
5 | "@rails/actioncable": "^6.0.0",
6 | "@rails/activestorage": "^6.0.0",
7 | "@rails/ujs": "^6.0.0",
8 | "@rails/webpacker": "^5.1.1",
9 | "turbolinks": "^5.2.0"
10 | },
11 | "version": "0.1.0",
12 | "devDependencies": {
13 | "webpack-dev-server": "^3.11.0"
14 | }
15 | }
16 |
--------------------------------------------------------------------------------
/example-app/postcss.config.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | plugins: [
3 | require('postcss-import'),
4 | require('postcss-flexbugs-fixes'),
5 | require('postcss-preset-env')({
6 | autoprefixer: {
7 | flexbox: 'no-2009'
8 | },
9 | stage: 3
10 | })
11 | ]
12 | }
13 |
--------------------------------------------------------------------------------
/example-app/public/404.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | The page you were looking for doesn't exist (404)
5 |
6 |
55 |
56 |
57 |
58 |
59 |
60 |
61 |
The page you were looking for doesn't exist.
62 |
You may have mistyped the address or the page may have moved.
63 |
64 |
If you are the application owner check the logs for more information.
65 |
66 |
67 |
68 |
--------------------------------------------------------------------------------
/example-app/public/422.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | The change you wanted was rejected (422)
5 |
6 |
55 |
56 |
57 |
58 |
59 |
60 |
61 |
The change you wanted was rejected.
62 |
Maybe you tried to change something you didn't have access to.
63 |
64 |
If you are the application owner check the logs for more information.
65 |
66 |
67 |
68 |
--------------------------------------------------------------------------------
/example-app/public/500.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | We're sorry, but something went wrong (500)
5 |
6 |
55 |
56 |
57 |
58 |
59 |
60 |
61 |
We're sorry, but something went wrong.
62 |
63 |
If you are the application owner check the logs for more information.
64 |
65 |
66 |
67 |
--------------------------------------------------------------------------------
/example-app/public/apple-touch-icon-precomposed.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hintmedia/railsdock/af472bd608d19a9ebc36c4e675dbdd6891477072/example-app/public/apple-touch-icon-precomposed.png
--------------------------------------------------------------------------------
/example-app/public/apple-touch-icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hintmedia/railsdock/af472bd608d19a9ebc36c4e675dbdd6891477072/example-app/public/apple-touch-icon.png
--------------------------------------------------------------------------------
/example-app/public/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hintmedia/railsdock/af472bd608d19a9ebc36c4e675dbdd6891477072/example-app/public/favicon.ico
--------------------------------------------------------------------------------
/example-app/public/robots.txt:
--------------------------------------------------------------------------------
1 | # See https://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file
2 |
--------------------------------------------------------------------------------
/example-app/storage/.keep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hintmedia/railsdock/af472bd608d19a9ebc36c4e675dbdd6891477072/example-app/storage/.keep
--------------------------------------------------------------------------------
/example-app/tmp/.keep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hintmedia/railsdock/af472bd608d19a9ebc36c4e675dbdd6891477072/example-app/tmp/.keep
--------------------------------------------------------------------------------
/example-app/vendor/.keep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hintmedia/railsdock/af472bd608d19a9ebc36c4e675dbdd6891477072/example-app/vendor/.keep
--------------------------------------------------------------------------------
/exe/railsdock:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env ruby
2 | # frozen_string_literal: true
3 |
4 | lib_path = File.expand_path('../lib', __dir__)
5 | $:.unshift(lib_path) if !$:.include?(lib_path)
6 | require 'railsdock/cli'
7 |
8 | Signal.trap('INT') do
9 | warn("\n#{caller.join("\n")}: interrupted")
10 | exit(1)
11 | end
12 |
13 | begin
14 | Railsdock::CLI.start
15 | rescue Railsdock::CLI::Error => err
16 | puts "ERROR: #{err.message}"
17 | exit 1
18 | end
19 |
--------------------------------------------------------------------------------
/ext/railsdock/extconf.rb:
--------------------------------------------------------------------------------
1 | require "mkmf"
2 |
3 | create_makefile("railsdock/railsdock")
4 |
--------------------------------------------------------------------------------
/ext/railsdock/railsdock.c:
--------------------------------------------------------------------------------
1 | #include "railsdock.h"
2 |
3 | VALUE rb_mRailsdock;
4 |
5 | void
6 | Init_railsdock(void)
7 | {
8 | rb_mRailsdock = rb_define_module("Railsdock");
9 | }
10 |
--------------------------------------------------------------------------------
/ext/railsdock/railsdock.h:
--------------------------------------------------------------------------------
1 | #ifndef RAILSDOCK_H
2 | #define RAILSDOCK_H 1
3 |
4 | #include "ruby.h"
5 |
6 | #endif /* RAILSDOCK_H */
7 |
--------------------------------------------------------------------------------
/lib/railsdock.rb:
--------------------------------------------------------------------------------
1 | require 'railsdock/version'
2 | require 'railsdock/cli'
3 |
4 | module Railsdock
5 | class Error < StandardError; end
6 | end
7 |
--------------------------------------------------------------------------------
/lib/railsdock/cli.rb:
--------------------------------------------------------------------------------
1 | # frozen_string_literal: true
2 |
3 | require 'thor'
4 |
5 | module Railsdock
6 | # Handle the application command line parsing
7 | # and the dispatch to various command objects
8 | #
9 | # @api public
10 | class CLI < Thor
11 | # Error raised by this runner
12 | Error = Class.new(StandardError)
13 |
14 | desc 'version', 'railsdock version'
15 | def version
16 | require_relative 'version'
17 | puts "Railsdock v#{Railsdock::VERSION}"
18 | end
19 | map %w[--version -v] => :version
20 |
21 | desc 'install', 'Install Railsdock in an existing rails application'
22 | method_option :help, aliases: '-h', type: :boolean,
23 | desc: 'Display usage information'
24 | def install(app_name = nil)
25 | if options[:help]
26 | invoke :help, ['install']
27 | else
28 | require_relative 'commands/install'
29 | Railsdock::Commands::Install.new(options.merge(app_name: app_name)).execute
30 | end
31 | end
32 | end
33 | end
34 |
--------------------------------------------------------------------------------
/lib/railsdock/command.rb:
--------------------------------------------------------------------------------
1 | # frozen_string_literal: true
2 |
3 | require 'forwardable'
4 |
5 | module Railsdock
6 | class Command
7 | extend Forwardable
8 |
9 | def_delegators :command, :run
10 |
11 | # Execute this command
12 | #
13 | # @api public
14 | def execute(*)
15 | raise(
16 | NotImplementedError,
17 | "#{self.class}##{__method__} must be implemented"
18 | )
19 | end
20 |
21 | # The external commands runner
22 | #
23 | # @see http://www.rubydoc.info/gems/tty-command
24 | #
25 | # @api public
26 | def cmd(**options)
27 | require 'tty-command'
28 | TTY::Command.new(options)
29 | end
30 |
31 | # File manipulation utility methods.
32 | #
33 | # @see http://www.rubydoc.info/gems/tty-file
34 | #
35 | # @api public
36 | def file
37 | require 'tty-file'
38 | TTY::File
39 | end
40 |
41 | # Terminal platform and OS properties
42 | #
43 | # @see http://www.rubydoc.info/gems/tty-platform
44 | #
45 | # @api public
46 | def platform
47 | require 'tty-platform'
48 | TTY::Platform.new
49 | end
50 |
51 | # The interactive prompt
52 | #
53 | # @see http://www.rubydoc.info/gems/tty-prompt
54 | #
55 | # @api public
56 | def prompt(**options)
57 | require 'tty-prompt'
58 | TTY::Prompt.new(options)
59 | end
60 |
61 | def color
62 | require 'pastel'
63 | Pastel.new
64 | end
65 | end
66 | end
67 |
--------------------------------------------------------------------------------
/lib/railsdock/commands/install.rb:
--------------------------------------------------------------------------------
1 | # frozen_string_literal: true
2 |
3 | require 'ostruct'
4 | require 'erb'
5 | require 'bundler'
6 | require_relative '../command'
7 | require_relative '../logo'
8 |
9 | module Railsdock
10 | module Commands
11 | class Install < Railsdock::Command
12 | OPTIONS_HASH = {
13 | database: {
14 | name: 'Database',
15 | options: %i[postgres mysql],
16 | default_port: {
17 | postgres: 5432,
18 | mysql: 3306
19 | }
20 | },
21 | mem_store: {
22 | name: 'In-Memory Store',
23 | options: %i[redis memcached]
24 | }
25 | }.freeze
26 |
27 | POST_INSTALL_MESSAGE =<<~PIM
28 | Railsdock successfully installed
29 |
30 | Run `docker-compose build` then `docker-compose up` to start your app,
31 |
32 | PIM
33 |
34 | BASE_TEMPLATE_DIR = File.expand_path("#{__dir__}/../templates/install").freeze
35 |
36 | def initialize(options)
37 | @options = options
38 | @variables = OpenStruct.new(
39 | app_name: options[:app_name] || get_app_name,
40 | is_windows?: platform.windows?,
41 | is_mac?: platform.mac?,
42 | uid: cmd.run('id -u').out.chomp,
43 | ruby_version: get_ruby_version
44 | )
45 | end
46 |
47 | def execute(input: $stdin, output: $stdout)
48 | output.puts Railsdock::Logo.call
49 | @variables[:dockerfile_dir] = prompt_for_dockerfile_directory
50 | copy_default_files
51 | service_hash = collect_service_selections
52 | service_hash.each do |type, service|
53 | file.copy_file("#{BASE_TEMPLATE_DIR}/#{service}/Dockerfile", [@variables.dockerfile_dir, service, "/Dockerfile"].join)
54 | inject_driver_config(service)
55 | append_erb_to_compose_file(service)
56 | file.inject_into_file('./docker-compose.yml', "\n #{service}:", after: "\nvolumes:")
57 | if type == :database
58 | copy_db_yml("#{BASE_TEMPLATE_DIR}/#{service}/database.yml.erb")
59 | inject_db_script_into_entrypoint(service)
60 | end
61 | end
62 | cmd.run('chmod +x ./docker/ruby/entrypoint.sh')
63 | output.puts POST_INSTALL_MESSAGE
64 | end
65 |
66 | private
67 |
68 | def get_app_name
69 | ::File.open('./config/application.rb').read.match(/module (.+)\s/)[1].downcase
70 | end
71 |
72 | def get_ruby_version
73 | ::Bundler.definition.ruby_version.versions[0] || RUBY_VERSION
74 | end
75 |
76 | def copy_db_yml(erb_file)
77 | file.copy_file(erb_file, './config/database.yml', context: @variables)
78 | end
79 |
80 | def inject_db_script_into_entrypoint(service)
81 | file.inject_into_file('./docker/ruby/entrypoint.sh', after: "echo \"DB is not ready, sleeping...\"\n") do
82 | <<~BASH
83 | until nc -vz #{service} #{OPTIONS_HASH[:database][:default_port][service]}; do
84 | sleep 1
85 | done
86 | BASH
87 | end
88 | end
89 |
90 | def collect_service_selections
91 | prompt.collect do
92 | OPTIONS_HASH.each do |key, value|
93 | key(key).select("Select the #{value[:name]} used by your application:", value[:options])
94 | end
95 | end
96 | end
97 |
98 | def inject_driver_config(service)
99 | file.inject_into_file('./docker-compose.yml', after: " node_modules:\n driver: ${VOLUMES_DRIVER}\n") do
100 | <<~YAML
101 | #{service}:
102 | driver: ${VOLUMES_DRIVER}
103 | YAML
104 | end
105 | end
106 |
107 | def generate_erb(source_path)
108 | template = if ERB.version.scan(/\d+\.\d+\.\d+/)[0].to_f >= 2.2
109 | ERB.new(::File.binread(source_path), trim_mode: '-', eoutvar: '@output_buffer')
110 | else
111 | ERB.new(::File.binread(source_path), nil, '-', '@output_buffer')
112 | end
113 | template.result(@variables.instance_eval('binding'))
114 | end
115 |
116 | def create_or_append_to_file(source_path, destination_path)
117 | if ::File.exist?(destination_path) && generate_erb(source_path) != ::File.binread(destination_path)
118 | file.safe_append_to_file(destination_path, generate_erb(source_path))
119 | else
120 | file.copy_file(source_path, destination_path, context: @variables)
121 | end
122 | end
123 |
124 | def append_erb_to_compose_file(service)
125 | file.safe_append_to_file('./docker-compose.yml') do
126 | generate_erb("#{BASE_TEMPLATE_DIR}/#{service}/docker-compose.yml.erb")
127 | end
128 | file.inject_into_file('./docker-compose.yml', " - #{service}\n", after: "depends_on:\n")
129 | end
130 |
131 | def prompt_for_dockerfile_directory
132 | prompt.ask('Where would you like your docker container configuration files to live?') do |q|
133 | q.default './docker/'
134 | q.validate(%r{\.\/[A-z\/]+\/})
135 | q.modify :remove
136 | q.messages[:valid?] = 'Invalid directory path (should start with ./ and end with /)'
137 | end
138 | end
139 |
140 | def copy_default_files
141 | Dir["#{BASE_TEMPLATE_DIR}/default/*"].each do |path|
142 | destination_file(path)
143 | end
144 | end
145 |
146 | def destination_file(path)
147 | case File.basename(path)
148 | when 'Dockerfile'
149 | file.copy_file(path, "#{@variables.dockerfile_dir}ruby/Dockerfile", context: @variables)
150 | when 'entrypoint.sh'
151 | file.copy_file(path, "#{@variables.dockerfile_dir}ruby/entrypoint.sh", context: @variables)
152 | when 'docker-compose.yml.erb'
153 | file.copy_file(path, './docker-compose.yml', context: @variables)
154 | when 'default.env.erb'
155 | create_or_append_to_file(path, './.env')
156 | else
157 | file.copy_file(path, "./#{File.basename(path)}", context: @variables)
158 | end
159 | end
160 | end
161 | end
162 | end
163 |
--------------------------------------------------------------------------------
/lib/railsdock/logo.rb:
--------------------------------------------------------------------------------
1 | require 'pastel'
2 |
3 | module Railsdock
4 | class Logo
5 | def self.call
6 | color = Pastel.new
7 | color.red(" `yy: `.
8 | -oo` .-/+ooyysooo//-/sy
9 | `+ooyyhhhhhhhhhhhhhhhys/-`
10 | `-oyhhhhhhhhhhhhhhhyyyyyhhhys/-
11 | .- .:yhhhhhhhhhhhhysoo+````:os-:/oyyy+.
12 | :yy:/yhhhhhhhhhhhyo-` :o/ `.- ``:oss:`
13 | .+shhhhhhhhhhhho++ `-+o.
14 | `oyhhhhhhhhhhhy-.so` `
15 | .shhhhhhhhhhhhy. `
16 | ` -yhhhhhhhhhhhhh/:`", color.cyan(" -+/. "), color.red("
17 | :ys/-yhhhhhhhhhhhhho/hs"), color.cyan(" -oooo/. "), color.red("
18 | /os:yhhhhhhhhhhhhhh:`::"), color.cyan(" `ooooooo: "), color.red("
19 | `ohhhhhhhhhhhhhhh."), color.cyan(" :oooooooo: "), color.red("
20 | :hhhhhhhhhhhhhhhh...`"), color.cyan(" /ooooooooo:////::.` "), color.red("
21 | `yhhhhhhhhhhhhhhhh-sys"), color.cyan(" -oooooooooooooooooo:"), color.red("
22 | -yyyyyyyyyyyyyyyyy/-/+."), color.cyan(" /oooooooooooooooo+.
23 | .-------"), color.red("/////////////////:"), color.cyan("---------------------------:/+oooooooooooooo+:`
24 | :oooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo++/-`
25 | +oooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo-..``
26 | /ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo-
27 | :oooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo-
28 | .ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo-
29 | +ooooooooooooooooooooooooooooooooooooooooooooooooooooooooo-
30 | .ooooooooooooooooooooooooooooooooooooooooooooooooooooooo+.
31 | :ooooooooooooooooooooooooooooooooooooooooooooooooooooo:`
32 | /oooooooooooooooooooooooooooooooooooooooooooooooooo:`
33 | /ooooooooooooooooooooooooooooooooooooooooooooooo/`
34 | -+oooooooooooooooooooooooooooooooooooooooooo+-`
35 | -+ooooooooooooooooooooooooooooooooooooo/-`
36 | .:/ooooooooooooooooooooooooooooo+/-.
37 | `.-:/++oooooooooooo++//:-.`
38 |
39 | ╠╬ ╠╬
40 | ╠░ ╠░"), color.red("
41 | ████████▖ ▄██████▄ ███ ███ ▟█████▌"), color.cyan(" ╓φ╬╬░╬╦╬░ ,φ╬╬░╬▒╦ ╦╬╬░╬▒╦ ╠░ ,╦╬╬"), color.red("
42 | ███ ▐███ ███ ███ ███ ███ ▐██▙▄▄"), color.cyan(" ╠░╩ `╬░ ╔░╩ ╬╬ ╒╬╩ ` ╠░╓φ╬╩╜"), color.red("
43 | ███▄▄███▘ ███▄▄███ ███ ███ ▀▀████▙"), color.cyan(" ░░ ╠░ ╠░ ░░⌐░░⌐ ╠░╜╙╬╦"), color.red("
44 | ███▀███▄ ███▀▀███ ███ ███▄▄▄▄ ▄▄▄▄▄██"), color.cyan(" ╙╬╬╖, ╓φ░╩ ╬╬╦, ,φ░╩ ╠╠╦, ,╦╦ ╠░ ╙░╦"), color.red("
45 | ▀▀▀ ▝▀▀▀ ▀▀▀ ▀▀▀ ▀▀▀ ▀▀▀▀▀▀▀ ▀▀▀▀▀▀▘"), color.cyan(" `╙╨╩╜^ `╙╨╩╜╜ ╙╙╨╜╜ ╙╜ ╙╜"))
46 |
47 | end
48 | end
49 | end
--------------------------------------------------------------------------------
/lib/railsdock/templates/install/default/Dockerfile:
--------------------------------------------------------------------------------
1 | ARG RAILSDOCK_RUBY_VERSION=2.6
2 |
3 | FROM ruby:$RAILSDOCK_RUBY_VERSION
4 |
5 | LABEL maintainer="Nate Vick "
6 |
7 | ARG DEBIAN_FRONTEND=noninteractive
8 |
9 | ###############################################################################
10 | # Base Software Install
11 | ###############################################################################
12 |
13 | ARG RAILSDOCK_NODE_VERSION=12
14 |
15 | RUN curl -sL https://deb.nodesource.com/setup_$RAILSDOCK_NODE_VERSION.x | bash -
16 |
17 | RUN curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - && \
18 | echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list
19 |
20 | RUN apt-get update && apt-get install -y \
21 | build-essential \
22 | nodejs \
23 | yarn \
24 | locales \
25 | git \
26 | netcat \
27 | vim \
28 | sudo
29 |
30 | ###############################################################################
31 | # Railsdock non-root user
32 | ###############################################################################
33 |
34 | ARG RUBY_UID
35 | ENV RUBY_UID $RUBY_UID
36 | ARG RUBY_GID
37 | ENV RUBY_GID $RUBY_GID
38 | ARG USER=ruby
39 | ENV USER $USER
40 |
41 | RUN groupadd -g $RUBY_GID $USER && \
42 | useradd -u $RUBY_UID -g $USER -m $USER && \
43 | usermod -p "*" $USER && \
44 | usermod -aG sudo $USER && \
45 | echo "$USER ALL=NOPASSWD: ALL" >> /etc/sudoers.d/50-$USER
46 |
47 | ###############################################################################
48 | # Ruby, Rubygems, and Bundler Defaults
49 | ###############################################################################
50 |
51 | ENV LANG C.UTF-8
52 |
53 | # Update Rubygems to latest
54 | RUN gem update --system
55 |
56 | # Increase how many threads Bundler uses when installing. Optional!
57 | ARG RAILSDOCK_BUNDLE_JOBS=20
58 | ENV BUNDLE_JOBS $RAILSDOCK_BUNDLE_JOBS
59 |
60 | # How many times Bundler will retry a gem download. Optional!
61 | ARG RAILSDOCK_BUNDLE_RETRY=5
62 | ENV BUNDLE_RETRY $RAILSDOCK_BUNDLE_RETRY
63 |
64 | # Where Rubygems will look for gems.
65 | ENV GEM_HOME /gems
66 | ENV GEM_PATH /gems
67 |
68 | # Add /gems/bin to the path so any installed gem binaries are runnable from bash.
69 | ENV PATH ${GEM_HOME}/bin:${GEM_HOME}/gems/bin:$PATH
70 |
71 | ###############################################################################
72 | # Optional Software Install
73 | ###############################################################################
74 |
75 | #------------------------------------------------------------------------------
76 | # Postgres Client:
77 | #------------------------------------------------------------------------------
78 |
79 | ARG INSTALL_PG_CLIENT=false
80 |
81 | RUN if [ "$INSTALL_PG_CLIENT" = true ]; then \
82 | # Install the pgsql client
83 | apt-get install -y postgresql-client \
84 | ;fi
85 |
86 | ###############################################################################
87 | # Final Touches
88 | ###############################################################################
89 |
90 | RUN mkdir -p "$GEM_HOME" && chown $USER:$USER "$GEM_HOME"
91 | RUN mkdir -p /app && chown $USER:$USER /app
92 |
93 | WORKDIR /app
94 |
95 | RUN mkdir -p node_modules && chown $USER:$USER node_modules
96 | RUN mkdir -p public/packs && chown $USER:$USER public/packs
97 | RUN mkdir -p tmp/cache && chown $USER:$USER tmp/cache
98 |
99 | USER $USER
100 |
101 | # Install latest bundler
102 | RUN gem install bundler
103 |
--------------------------------------------------------------------------------
/lib/railsdock/templates/install/default/default.env.erb:
--------------------------------------------------------------------------------
1 | ###############################################################################
2 | ############################# General Setup ###################################
3 | ###############################################################################
4 |
5 | ### Docker compose files ######################################################
6 |
7 | # Select which docker-compose files to include. If using an override append `:docker-compose.example.yml` at the end
8 | COMPOSE_FILE=docker-compose.yml
9 |
10 | # Change the separator from : to ; on Windows
11 | COMPOSE_PATH_SEPARATOR=<%= is_windows? ? ';' : ':' %>
12 |
13 | # Define the prefix of container names. This is useful when there are multiple projects using railsdock
14 | COMPOSE_PROJECT_NAME=<%= app_name %>
15 |
16 | ### User Configuration ######################################################
17 |
18 | RUBY_UID=<%= uid %>
19 | RUBY_GID=<%= uid %>
20 |
--------------------------------------------------------------------------------
/lib/railsdock/templates/install/default/docker-compose.yml.erb:
--------------------------------------------------------------------------------
1 | version: '3.7'
2 |
3 | x-ruby: &ruby-base
4 | build:
5 | context: <%= dockerfile_dir %>ruby
6 | args:
7 | - RAILSDOCK_RUBY_VERSION=<%= ruby_version %>
8 | - RAILSDOCK_NODE_VERSION=12
9 | - RAILSDOCK_BUNDLE_JOBS=10
10 | - RAILSDOCK_BUNDLE_RETRY=3
11 | - RUBY_UID=${RUBY_UID}
12 | - RUBY_GID=${RUBY_GID}
13 | volumes:
14 | - .:/app:cached
15 | - gems:/gems
16 | - node_modules:/app/node_modules
17 | - packs:/app/public/packs
18 | - rails_cache:/app/tmp/cache
19 | tmpfs:
20 | - /tmp
21 | user: ruby
22 | tty: true
23 | stdin_open: true
24 | depends_on:
25 |
26 | volumes:
27 | gems:
28 | node_modules:
29 | packs:
30 | rails_cache:
31 |
32 | services:
33 |
34 | rails:
35 | <<: *ruby-base
36 | command: bundle exec rails server -p 3000 -b '0.0.0.0'
37 | entrypoint: ./docker/ruby/entrypoint.sh
38 | ports:
39 | - "3000:3000"
--------------------------------------------------------------------------------
/lib/railsdock/templates/install/default/entrypoint.sh:
--------------------------------------------------------------------------------
1 | #! /bin/bash
2 | set -e
3 |
4 | : ${APP_PATH:="/app"}
5 | : ${APP_TEMP_PATH:="$APP_PATH/tmp"}
6 | : ${APP_SETUP_LOCK:="$APP_TEMP_PATH/setup.lock"}
7 | : ${APP_SETUP_WAIT:="5"}
8 | : ${HOST_DOMAIN:="host.docker.internal"}
9 |
10 | # 1: Define the functions lock and unlock our app containers setup
11 | # processes:
12 | function lock_setup { mkdir -p $APP_TEMP_PATH && touch $APP_SETUP_LOCK; }
13 | function unlock_setup { rm -rf $APP_SETUP_LOCK; }
14 | function wait_setup { echo "Waiting for app setup to finish..."; sleep $APP_SETUP_WAIT; }
15 | function check_host { ping -q -c1 $HOST_DOMAIN > /dev/null 2>&1; }
16 | function schema_file_exists { [[ -e "db/schema.rb" || -e "db/structure.sql" ]]; }
17 |
18 | # 2: 'Unlock' the setup process if the script exits prematurely:
19 | trap unlock_setup HUP INT QUIT KILL TERM EXIT
20 |
21 | # 3: Wait for postgres to come up
22 | echo "DB is not ready, sleeping..."
23 | echo "DB is ready, starting Rails."
24 |
25 | # 4: Specify a default command, in case it wasn't issued:
26 | if [ -z "$1" ]; then set -- bundle exec rails server -p 3000 -b 0.0.0.0 "$@"; fi
27 |
28 | # 5: Run the checks only if the app code is going to be executed:
29 | if [[ "$3" = "rails" ]]
30 | then
31 | # Clean up any orphaned lock file
32 | unlock_setup
33 | # 6: Wait until the setup 'lock' file no longer exists:
34 | while [ -f $APP_SETUP_LOCK ]; do wait_setup; done
35 |
36 | # 6: 'Lock' the setup process, to prevent a race condition when the
37 | # project's app containers will try to install gems and setup the
38 | # database concurrently:
39 | lock_setup
40 | # 8: Check if dependencies need to be installed and install them
41 | bundle check || bundle install
42 |
43 | yarn install
44 | # 9: Setup the database if it doesn't
45 | if ! schema_file_exists; then
46 | bundle exec rake db:create && bundle exec rake db:migrate
47 | elif ! bundle exec rake db:migrate 2> /dev/null; then
48 | bundle exec rake db:setup
49 | fi
50 |
51 | # check if the docker host is running on mac or windows
52 | if ! check_host; then
53 | HOST_IP=$(ip route | awk 'NR==1 {print $3}')
54 | echo "$HOST_IP $HOST_DOMAIN" | sudo tee -a /etc/hosts > /dev/null
55 | fi
56 |
57 | # 10: 'Unlock' the setup process:
58 | unlock_setup
59 |
60 | # 11: If the command to execute is 'rails server', then we must remove any
61 | # pid file present. Suddenly killing and removing app containers might leave
62 | # this file, and prevent rails from starting-up if present:
63 | if [[ "$4" = "s" || "$4" = "server" ]]; then rm -rf /app/tmp/pids/server.pid; fi
64 | fi
65 |
66 | unset BUNDLE_PATH
67 | unset BUNDLE_BIN
68 |
69 | # 10: Execute the given or default command:
70 | exec "$@"
--------------------------------------------------------------------------------
/lib/railsdock/templates/install/memcached/Dockerfile:
--------------------------------------------------------------------------------
1 | ARG MEMCACHED_VERSION=latest
2 |
3 | FROM memcached:${MEMCACHED_VERSION}-alpine
4 |
5 | CMD ["memcached"]
6 |
7 | EXPOSE 11211
8 |
--------------------------------------------------------------------------------
/lib/railsdock/templates/install/memcached/docker-compose.yml.erb:
--------------------------------------------------------------------------------
1 |
2 |
3 | memcached:
4 | build:
5 | context: <%= dockerfile_dir %>memcached
6 | args:
7 | - MEMCACHED_VERSION=1.5
8 | volumes:
9 | - memcached:/var/lib/memcached
--------------------------------------------------------------------------------
/lib/railsdock/templates/install/mysql/Dockerfile:
--------------------------------------------------------------------------------
1 | ARG MYSQL_VERSION=latest
2 |
3 | FROM mysql:${MYSQL_VERSION}
4 |
5 | CMD ["mysqld"]
6 |
7 | EXPOSE 3306
8 |
--------------------------------------------------------------------------------
/lib/railsdock/templates/install/mysql/database.yml.erb:
--------------------------------------------------------------------------------
1 | default: &default
2 | adapter: mysql2
3 | encoding: unicode
4 | pool: "<%%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>"
5 | host: mysql
6 | port: 3306
7 | username: mysql
8 |
9 | # Warning: The database defined as "test" will be erased and
10 | # re-generated from your development database when you run "rake".
11 | # Do not set this db to the same as development or production.
12 | test:
13 | <<: *default
14 | database: <%= app_name %>_test
15 |
16 | development:
17 | <<: *default
18 | database: <%= app_name %>_development
--------------------------------------------------------------------------------
/lib/railsdock/templates/install/mysql/docker-compose.yml.erb:
--------------------------------------------------------------------------------
1 |
2 |
3 | mysql:
4 | build:
5 | context: <%= dockerfile_dir %>mysql
6 | args:
7 | - MYSQL_VERSION=5.7
8 | environment:
9 | - MYSQL_ROOT_PASSWORD=Password1
10 | volumes:
11 | - mysql:/var/lib/mysql
--------------------------------------------------------------------------------
/lib/railsdock/templates/install/postgres/Dockerfile:
--------------------------------------------------------------------------------
1 | ARG POSTGRES_VERSION=latest
2 |
3 | FROM postgres:${POSTGRES_VERSION}-alpine
4 |
5 | CMD ["postgres"]
6 |
7 | EXPOSE 5432
8 |
--------------------------------------------------------------------------------
/lib/railsdock/templates/install/postgres/database.yml.erb:
--------------------------------------------------------------------------------
1 | default: &default
2 | adapter: postgresql
3 | encoding: unicode
4 | pool: <%%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
5 | host: postgres
6 | port: 5432
7 | username: postgres
8 |
9 | # Warning: The database defined as "test" will be erased and
10 | # re-generated from your development database when you run "rake".
11 | # Do not set this db to the same as development or production.
12 | test:
13 | <<: *default
14 | database: <%= app_name %>_test
15 |
16 | development:
17 | <<: *default
18 | database: <%= app_name %>_development
--------------------------------------------------------------------------------
/lib/railsdock/templates/install/postgres/docker-compose.yml.erb:
--------------------------------------------------------------------------------
1 |
2 |
3 | postgres:
4 | build:
5 | context: <%= dockerfile_dir %>postgres
6 | args:
7 | - POSTGRES_VERSION=12
8 | environment:
9 | - POSTGRES_HOST_AUTH_METHOD=trust
10 | volumes:
11 | - postgres:/var/lib/postgresql/data
--------------------------------------------------------------------------------
/lib/railsdock/templates/install/redis/Dockerfile:
--------------------------------------------------------------------------------
1 | ARG REDIS_VERSION=latest
2 |
3 | FROM redis:${REDIS_VERSION}-alpine
4 |
5 | CMD ["redis-server"]
6 |
7 | EXPOSE 6379
8 |
--------------------------------------------------------------------------------
/lib/railsdock/templates/install/redis/docker-compose.yml.erb:
--------------------------------------------------------------------------------
1 |
2 |
3 | redis:
4 | build:
5 | context: <%= dockerfile_dir %>redis
6 | args:
7 | - REDIS_VERSION=5
8 | volumes:
9 | - redis:/data
--------------------------------------------------------------------------------
/lib/railsdock/version.rb:
--------------------------------------------------------------------------------
1 | module Railsdock
2 | VERSION = '0.4.0'.freeze
3 | end
4 |
--------------------------------------------------------------------------------
/railsdock.gemspec:
--------------------------------------------------------------------------------
1 | lib = File.expand_path('../lib', __FILE__)
2 | $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
3 | require 'railsdock/version'
4 |
5 | Gem::Specification.new do |spec|
6 | spec.name = 'railsdock'
7 | spec.license = 'MIT'
8 | spec.version = Railsdock::VERSION
9 | spec.authors = ['Kyle Boe', 'Nate Vick']
10 | spec.email = ['kyle@hint.io', 'nate.vick@hint.io']
11 |
12 | spec.summary = 'Docker-ize your Rails project.'
13 | spec.description = 'CLI Application for adding Docker configuration to your Rails application.'
14 | spec.homepage = 'https://github.com/hintmedia/railsdock'
15 |
16 | # Prevent pushing this gem to RubyGems.org. To allow pushes either
17 | # set the 'allowed_push_host' to allow pushing to a single host
18 | # or delete this section to allow pushing to any host.
19 | if spec.respond_to?(:metadata)
20 | spec.metadata['homepage_uri'] = spec.homepage
21 | spec.metadata['source_code_uri'] = 'https://github.com/hintmedia/railsdock'
22 | spec.metadata['changelog_uri'] = 'https://github.com/hintmedia/railsdock/blob/master/CHANGELOG.md'
23 | else
24 | raise 'RubyGems 2.0 or newer is required to protect against ' \
25 | 'public gem pushes.'
26 | end
27 |
28 | # Specify which files should be added to the gem when it is released.
29 | # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
30 | spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
31 | `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
32 | end
33 | spec.bindir = 'exe'
34 | spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
35 | spec.require_paths = ['lib']
36 | spec.extensions = ['ext/railsdock/extconf.rb']
37 |
38 | spec.add_dependency 'railties', '>= 4.2', '< 6.1'
39 | spec.add_dependency 'bundler', '~> 2.0'
40 | spec.add_dependency 'pastel', '~> 0.7.2'
41 | spec.add_dependency 'thor', '~> 1.0.0'
42 | spec.add_dependency 'tty-command', '~> 0.8.0'
43 | spec.add_dependency 'tty-file', '~> 0.7.0'
44 | spec.add_dependency 'tty-platform', '~> 0.2.0'
45 | spec.add_dependency 'tty-prompt', '~> 0.19.0'
46 |
47 | spec.add_development_dependency 'rake', '>= 12.3.3'
48 | spec.add_development_dependency 'rake-compiler'
49 | spec.add_development_dependency 'rspec', '~> 3.0'
50 | spec.add_development_dependency 'appraisal', '2.2.0'
51 | spec.add_development_dependency 'pry-rails'
52 | end
53 |
--------------------------------------------------------------------------------
/railsdock.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hintmedia/railsdock/af472bd608d19a9ebc36c4e675dbdd6891477072/railsdock.png
--------------------------------------------------------------------------------
/spec/integration/.gitkeep:
--------------------------------------------------------------------------------
1 | #
2 |
--------------------------------------------------------------------------------
/spec/integration/install_spec.rb:
--------------------------------------------------------------------------------
1 | RSpec.describe "`railsdock install` command", type: :cli do
2 | it "executes `railsdock help install` command successfully" do
3 | output = `railsdock help install`
4 | expected_output = <<-OUT
5 | Usage:
6 | railsdock install
7 |
8 | Options:
9 | -h, [--help], [--no-help] # Display usage information
10 |
11 | Command description...
12 | OUT
13 |
14 | expect(output).to eq(expected_output)
15 | end
16 | end
17 |
--------------------------------------------------------------------------------
/spec/railsdock_spec.rb:
--------------------------------------------------------------------------------
1 | RSpec.describe Railsdock do
2 | it "has a version number" do
3 | expect(Railsdock::VERSION).not_to be nil
4 | end
5 |
6 | it "does something useful" do
7 | expect(false).to eq(true)
8 | end
9 | end
10 |
--------------------------------------------------------------------------------
/spec/spec_helper.rb:
--------------------------------------------------------------------------------
1 | require "bundler/setup"
2 | require "railsdock"
3 |
4 | RSpec.configure do |config|
5 | # Enable flags like --only-failures and --next-failure
6 | config.example_status_persistence_file_path = ".rspec_status"
7 |
8 | # Disable RSpec exposing methods globally on `Module` and `main`
9 | config.disable_monkey_patching!
10 |
11 | config.expect_with :rspec do |c|
12 | c.syntax = :expect
13 | end
14 | end
15 |
--------------------------------------------------------------------------------
/spec/support/.gitkeep:
--------------------------------------------------------------------------------
1 | #
2 |
--------------------------------------------------------------------------------
/spec/unit/.gitkeep:
--------------------------------------------------------------------------------
1 | #
2 |
--------------------------------------------------------------------------------
/spec/unit/install_spec.rb:
--------------------------------------------------------------------------------
1 | require 'railsdock/commands/install'
2 |
3 | RSpec.describe Railsdock::Commands::Install do
4 | it "executes `install` command successfully" do
5 | output = StringIO.new
6 | options = {}
7 | command = Railsdock::Commands::Install.new(options)
8 |
9 | command.execute(output: output)
10 |
11 | expect(output.string).to eq("OK\n")
12 | end
13 | end
14 |
--------------------------------------------------------------------------------