dockerfile-rails 0.4.5 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a64e87599931293e6cc232a0808acf1c30e93274db4fd3b7ce69b1adf505fae4
-  data.tar.gz: ac7188e27e291fdeb814d5fe87b7331f092db6fd8d9ddd742a4b325334c3f516
+  metadata.gz: f7578107905d7265d79a480e52c9a960e58d5b5cde92e6a3c6de22e3a7c2b269
+  data.tar.gz: 8a1a483463c405746298d425a259838d18a1128231aac5e0c68733be607f1e7b
 SHA512:
-  metadata.gz: 0e2a65afdb4224b38b76fbabd6260e0ad81e6d2f375207ae25123bfc9610d1703e13ea15637ba591f078fbaf0200aca95b20e19c510c637c05bc07d096b921d2
-  data.tar.gz: b4de5328f761669136d22a0f1763c177663a4f683b83069be87f61794da61462cfdf480aadd6125affd54bfdebebafc95907e9e36241f9e3beda2873c314f3c6
+  metadata.gz: 7d459f7291d6588b1f1b6353f27bde783f018f1f7dd16d80dc4f643cb8ec5a3934c5cc1d96eaabd857a7c0cb43a947917cdaf44b4e064e24397bfc2a8876f1cc
+  data.tar.gz: 0f4b1859a1b07a8f7b6e7e3679a7a3566a1957148f708d66be5be0ec2e2ead03706a4f7d30ac964a216e7912d0896bcf2e83612534a9c841780454c73c726b78

data/DEMO.md

@@ -1,24 +1,24 @@
-If you have Rails and Docker installed on your machine, running each of these demos is a matter of opening a terminal window, navigating to an empty directory, and copy/pasting a block of instructions into that window.  Once started, navigate to http://localhost:3000/ to see the results. 
+If you have Rails and Docker installed on your machine, running each of these demos is a matter of opening a terminal window, navigating to an empty directory, and copy/pasting a block of instructions into that window.  Once started, navigate to http://localhost:3000/ to see the results.
 
 # Demo 1 - Minimal
 
 Rails provides a _smoke test_ for new applications that makes sure that you have your software configured correctly enough to serve a page.  The following deploys that smoke test in production.  Once done take a look at the `Dockerfile` file produced.
 
-```
+```bash
 rails new welcome --minimal
 cd welcome
 echo 'Rails.application.routes.draw { root "rails/welcome#index" }' > config/routes.rb
 bundle add dockerfile-rails --group development
 bin/rails generate dockerfile
-docker buildx build . -t rails-welcome
+docker buildx build . -t rails-welcome # add --load to save the image to local Docker
 docker run -p 3000:3000 -e RAILS_MASTER_KEY=$(cat config/master.key) rails-welcome
 ```
 
 # Demo 2 - Action Cable and Active Record
 
-Real applications involve a network of services.  The following demo makes use of PostgreSQL and Redis to display a welcome screen with a live, updating, visitors counter. Once done, take a look at the 'docker-compose.yml` file produced.
+Real applications involve a network of services.  The following demo makes use of PostgreSQL and Redis to display a welcome screen with a live, updating, visitors counter. Once done, take a look at the `docker-compose.yml` file produced.
 
-```
+```bash
 rails new welcome --database postgresql
 cd welcome
 
@@ -98,7 +98,7 @@ docker compose up
 This demo deploys a [Create React App](https://create-react-app.dev/) client and a Rails API-only server.  Ruby and Rails version information is retrieved from the server and displayed below a spinning React logo.  Note that the build process installs the
 node moddules and ruby gems in parallel.
 
-```
+```bash
 rails new welcome --api
 cd welcome
 npx create-react-app client
@@ -160,14 +160,14 @@ While optional, bundling Javascript is a popular choice, and starting with
 Rails 7 there are three options: esbuild, rollup, and webpack.  The
 the following demonstrates Rails 7 with esbuild:
 
-```
+```bash
 rails new welcome --javascript esbuild
 cd welcome
 
 yarn add react react-dom
 bin/rails generate controller Time index
 
-cat <<-"EOF" >> app/javascript/application.js 
+cat <<-"EOF" >> app/javascript/application.js
 import "./components/counter"
 EOF
 

data/README.md

@@ -29,7 +29,7 @@ are actually using.  But should you be using DATABASE_URL, for example, at runti
 additional support may be needed:
 
 * `--mysql` - add mysql libraries
-* `--posgresql` - add posgresql libraries
+* `--postgresql` - add postgresql libraries
 * `--redis` - add redis libraries
 * `--sqlite3` - add sqlite3 libraries
 
@@ -40,10 +40,31 @@ Optimizations:
 * `--yjit` - enable [YJIT](https://github.com/ruby/ruby/blob/master/doc/yjit/yjit.md) optimizing compiler
 * `--swap=n` - allocate swap space.  See [falloc options](https://man7.org/linux/man-pages/man1/fallocate.1.html#OPTIONS) for suffixes
 
-Links:
+## Testing
 
-* [Demos](./DEMO.md)
-* [Preparations for Rails 7.1](https://community.fly.io/t/preparations-for-rails-7-1/9512)
-* [Rails Dockerfile futures](https://discuss.rubyonrails.org/t/rails-dockerfile-futures/82091/1)
-* [Fly Cookbooks](https://fly.io/docs/rails/cookbooks/)
-* [app/templates/Dockerfile.tt](https://github.com/rails/rails/blob/main/railties/lib/rails/generators/rails/app/templates/Dockerfile.tt)
+The current testing strategy is to run `rails new` and `generate dockerfile` with various configurations and compare the generated artifacts with expected results.  `ARG` values in `Dockerfiles` are masked before comparison.
+
+Running all tests, or even a single individual test can be done as follows:
+
+```
+rake test
+ruby test/test_minimal.rb
+```
+
+To assis with this process, outputs of tests can be captured automatically.  This is useful when adding new tests and when making a change that affects many tests.  Be sure to inspect the output (e.g., by using `git diff`) before committing.
+
+```
+rake test:capture
+TEST_CAPTURE=1 ruby test/test_minimal.rb
+```
+
+## Links
+
+Many of the following links relate to the current development status with respect to Rails 7.1 and will be removed once that is resolved.
+
+* [Demos](./DEMO.md) - scripts to copy and paste into an empty directory to launch demo apps
+* [Test Results](./test/results) - expected outputs for each test
+* [Preparations for Rails 7.1](https://community.fly.io/t/preparations-for-rails-7-1/9512) - [Fly.io](https://fly.io/)'s plans and initial discussions with DHH
+* [Rails Dockerfile futures](https://discuss.rubyonrails.org/t/rails-dockerfile-futures/82091/1) - rationale for a generator
+* [Fly Cookbooks](https://fly.io/docs/rails/cookbooks/) - deeper dive into Dockerfile design choices
+* [app/templates/Dockerfile.tt](https://github.com/rails/rails/blob/main/railties/lib/rails/generators/rails/app/templates/Dockerfile.tt) - current Rails 7.1 template

data/Rakefile

@@ -1,3 +1,17 @@
 require "bundler/gem_tasks"
 
 # Run `rake release` to release a new version of the gem.
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+namespace :test do
+  task :capture do
+    ENV['TEST_CAPTURE'] = 'true'
+    Rake::Task[:test].invoke
+  end
+end

data/lib/dockerfile-rails/scanner.rb

@@ -13,6 +13,8 @@ module DockerfileRails
         @postgresql = true
       elsif database == 'mysql' or database == 'mysql2'
         @mysql = true
+      elsif database == 'sqlserver'
+        @sqlserver = true
       end
 
       ### ruby gems ###
@@ -29,7 +31,10 @@ module DockerfileRails
         begin
           gemfile_definition = Bundler::Definition.build('Gemfile', nil, [])
           @gemfile += gemfile_definition.dependencies.map(&:name)
-          @git = !gemfile_definition.spec_git_paths.empty?
+
+          unless ENV['RAILS_ENV'] == 'test'
+            @git = !gemfile_definition.spec_git_paths.empty?
+          end
         rescue => error
           STDERR.puts error.message
         end

data/lib/generators/dockerfile_generator.rb

@@ -1,4 +1,5 @@
 require 'erb'
+require_relative '../dockerfile-rails/scanner.rb'
 
 class DockerfileGenerator < Rails::Generators::Base
   include DockerfileRails::Scanner
@@ -223,13 +224,36 @@ private
   end
 
   def node_version
-    `node --version`[/\d+\.\d+\.\d+/]
+    if File.exist? '.node_version'
+      IO.read('.node_version')[/\d+\.\d+\.\d+/]
+    else
+      `node --version`[/\d+\.\d+\.\d+/]
+    end
   rescue
     "lts" 
   end
 
   def yarn_version
-    `yarn --version`[/\d+\.\d+\.\d+/]
+    package = JSON.parse(IO.read('package.json'))
+
+    if ENV['RAILS_ENV'] == 'test'
+      # yarn install instructions changed in v2
+      version = '1.22.19'
+    elsif package['packageManager'].to_s.start_with? "yarn@"
+      version = package['packageManager'].sub('yarn@', '')
+    else
+      version = `yarn --version`[/\d+\.\d+\.\d+/] || '1.22.19'
+      system "yarn set version #{version}"
+      package = JSON.parse(IO.read('package.json'))
+      # apparently not all versions of yarn will update package.json...
+    end
+
+    unless package['packageManager']
+      package['packageManager'] = "yarn@#{version}"
+      IO.write('package.json', JSON.pretty_generate(package))
+    end
+
+    version
   rescue
     "latest"
   end

data/lib/generators/templates/Dockerfile.erb

@@ -95,7 +95,7 @@ RUN bundle exec bootsnap precompile app/ lib/
 <%= "RUN " + binfile_fixups.join(" && \\\n    ") %>
 
 <% end -%>
-<% if Dir.exist?('assets') and !api_only? -%>
+<% if Dir.exist?('app/assets') and !api_only? -%>
 # Precompiling assets for production without requiring secret RAILS_MASTER_KEY
 RUN SECRET_KEY_BASE<%= Rails::VERSION::MAJOR<7 || Rails::VERSION::STRING.start_with?('7.0') ? '=DUMMY' : '_DUMMY=1' %> ./bin/rails assets:precompile
 

data/lib/generators/templates/_apt_install.erb

@@ -8,3 +8,13 @@ RUN apt-get update -qq && \
     apt-get install --no-install-recommends -y <%= packages.join(" ") %><% if clean %> && \
     rm -rf /var/lib/apt/lists /var/cache/apt/archives<% end %>
 <% end -%>
+<% if @sqlserver -%>
+ # install freetds required by tiny_tds gem
+ RUN wget ftp://ftp.freetds.org/pub/freetds/stable/freetds-1.3.16.tar.gz && \
+ 		tar -xzf freetds-1.3.16.tar.gz && \
+ 		cd freetds-1.3.16 && \
+ 		./configure --prefix=/usr/local --with-tdsver=7.3 && \
+ 		make && \
+ 		make install
+ <% end -%>
+ 

data/lib/generators/templates/_install_node.erb

@@ -17,5 +17,14 @@ RUN curl -fsSL https://fnm.vercel.app/install | bash && \
 ENV PATH=/root/.local/share/fnm/aliases/default/bin/:$PATH
 <% end -%>
 <% if yarn_version -%>
+<% if yarn_version < '2' -%>
 RUN npm install -g yarn@$YARN_VERSION
+<% else -%>
+<% if (node_version.split('.').map(&:to_i) <=> [16,10,0]) < 0 -%>
+RUN npm i -g corepack && \
+<% else -%>
+RUN corepack enable && \
+<% end -%>
+    corepack prepare yarn@$YARN_VERSION --activate
+<% end -%>
 <% end -%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dockerfile-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.7
 platform: ruby
 authors:
 - Sam Ruby
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-19 00:00:00.000000000 Z
+date: 2023-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -46,11 +46,11 @@ files:
 - lib/generators/templates/docker-entrypoint.erb
 - lib/generators/templates/dockerignore.erb
 - lib/generators/templates/node-version.erb
-homepage: https://github.com/rubys/docker-rails
+homepage: https://github.com/rubys/dockerfile-rails
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/rubys/docker-rails
+  homepage_uri: https://github.com/rubys/dockerfile-rails
 post_install_message:
 rdoc_options: []
 require_paths: