orats 0.9.7 → 5.0.0

data/lib/orats/cli_help/destroy

@@ -0,0 +1,11 @@
+Destroy the target path and optionally all Docker data associated to it.
+
+Options:
+
+`--rm-docker` to delete Docker specific data for this project [false]
+
+In order to use `--rm-docker` you must be running orats from a terminal
+capable of connecting to Docker.
+
+When set, it will delete all Docker images, containers, volumes and networks
+associated to this project.

data/lib/orats/cli_help/new

@@ -1,29 +1,5 @@
-Create a new shiny rails app with quite a few best practices and opinions.
-
-Development server credentials:
-
-`--pg-location` to supply a custom postgres location [localhost]
-
-`--pg-username` to supply a custom postgres username [postgres]
-
-`--pg-password` to supply your postgres password to run migrations []
-
-`--redis-location` to supply a custom redis location [localhost]
-
-`--redis-password` to supply your redis password []
+Create a shiny Dockerized Rails application
 
 Options:
 
-`--rc` to supply an .oratsrc file path to automatically populate credentials []
-
-Template features:
-
-`--template` to mix in an official orats template by supplying its name []
-
-`--custom` to add your own template at the very end, a url or file is ok []
-
-Project features:
-
-`--backend` to switch to a different server backend, ie. puma
-
-`--skip-server-start` to skip automatically running puma and sidekiq [false]
+`--template` to supply the template name to use [base]

data/lib/orats/commands/new.rb

@@ -0,0 +1,127 @@
+require 'pathname'
+
+require 'orats/common'
+require 'orats/util'
+require 'orats/version'
+
+module Orats
+  module Commands
+    class New < Common
+      AVAILABLE_TEMPLATES = {
+        base: 'dockerized production ready application'
+      }.freeze
+
+      def initialize(target_path = '', options = {})
+        super
+      end
+
+      def init
+        check_exit_conditions
+        create_template
+        personalize_template
+        what_to_do_next
+      end
+
+      def available_templates
+        puts
+        log 'templates',
+            'Add `-t TEMPLATE` to the new command to use a template',
+            :magenta
+        puts
+
+        AVAILABLE_TEMPLATES.each_pair do |key, value|
+          log key, value, :cyan
+        end
+      end
+
+      private
+
+      def check_exit_conditions
+        exit_if_path_exists
+        exit_if_invalid_template
+      end
+
+      def exit_if_invalid_template
+        template = @options[:template] || ''
+        task 'Check if template exists'
+
+        return if template.empty? || template_exist?
+
+        error 'Cannot find template',
+              "'#{template}' is not a valid template name"
+
+        available_templates
+        exit 1
+      end
+
+      def template_exist?
+        AVAILABLE_TEMPLATES.include?(@options[:template].to_sym)
+      end
+
+      def create_template
+        task "Create '#{@options[:template]}' project"
+        log 'path', @target_path, :cyan
+
+        source = "#{base_path}/templates/#{@options[:template]}"
+
+        FileUtils.copy_entry source, @target_path
+      end
+
+      def personalize_template
+        template_replacements = set_template_replacements
+
+        Dir.glob("#{@target_path}/**/*", File::FNM_DOTMATCH) do |file|
+          next if file == '.' || file == '..' || File.directory?(file)
+
+          text = File.read(file)
+
+          template_replacements.each do |key, value|
+            text.gsub!(key.to_s, value)
+          end
+
+          File.open(file, 'w') { |f| f.puts text }
+        end
+      end
+
+      def set_template_replacements
+        project_name = Pathname.new(@target_path).basename.to_s
+
+        {
+          'orats_base' => Util.underscore(project_name),
+          'OratsBase'  => Util.classify(project_name),
+          'VERSION'    => VERSION
+        }
+      end
+
+      def what_to_do_next
+        prepare_and_run_everything
+        init_the_database
+        visit_the_page
+      end
+
+      def prepare_and_run_everything
+        task 'Prepare and run everything'
+        log 'open', 'carefully read and edit the `.env` file', :cyan
+        log 'move', "cd #{@target_path}", :cyan
+        log 'run', 'docker-compose up --build', :cyan
+      end
+
+      def init_the_database
+        run = 'docker-compose exec --user "$(id -u):$(id -g)" website rails'
+
+        task 'Initialize the database in a 2nd Docker-enabled terminal'
+        log 'note', 'OSX / Windows users can skip the --user flag', :yellow
+        log 'run', "#{run} db:reset", :cyan
+        log 'run', "#{run} db:migrate", :cyan
+      end
+
+      def visit_the_page
+        task 'Visit the page in your browser'
+        log 'visit', 'Running Docker natively? http://localhost:3000', :cyan
+        log 'visit',
+            'Running Docker with the Toolbox? http://192.168.99.100:3000',
+            :cyan
+      end
+    end
+  end
+end

data/lib/orats/common.rb

@@ -1,7 +1,3 @@
-require 'orats/postgres'
-require 'orats/process'
-require 'orats/redis'
-require 'orats/shell'
 require 'orats/ui'
 
 module Orats
@@ -10,11 +6,7 @@ module Orats
     include Thor::Base
     include Thor::Shell
     include Thor::Actions
-    include Shell
     include UI
-    include Process
-    include Postgres
-    include Redis
 
     def initialize(target_path = '', options = {})
       @target_path = target_path
@@ -28,13 +20,6 @@ module Orats
       File.join(File.expand_path(File.dirname(__FILE__)))
     end
 
-    def url_to_string(url)
-      open(url).read
-      rescue *[OpenURI::HTTPError, SocketError] => ex
-        error 'Unable to access URL', ex
-        exit 1
-    end
-
     def file_to_string(path)
       if File.exist?(path) && File.file?(path)
         IO.read path
@@ -58,19 +43,5 @@ module Orats
       error 'Path already exists', extended_path
       exit 1
     end
-
-    def exit_if_invalid_system
-      exit_if_process :not_found, 'rails', 'git', 'psql', 'redis-cli'
-      exit_if_process :not_running, 'postgres', 'redis'
-
-      exit_if_postgres_unreachable
-      exit_if_redis_unreachable
-    end
-
-    def run_rake(command)
-      task 'Run rake command'
-
-      run_from @target_path, "bundle exec rake #{command}"
-    end
   end
 end

data/lib/orats/templates/base/.dockerignore

@@ -0,0 +1,5 @@
+.git
+.dockerignore
+.byebug_history
+/log/*
+/tmp/*

data/lib/orats/templates/base/.gitignore

@@ -0,0 +1,22 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring
+# files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore Byebug command history file.
+.byebug_history
+
+/vendor/bundle
+/public/assets/*
+.env

data/lib/orats/templates/base/.rubocop.yml

@@ -0,0 +1,29 @@
+AllCops:
+  TargetRubyVersion: 2.0
+
+  Exclude:
+    - 'db/**/*'
+    - 'log/**/*'
+    - 'tmp/**/*'
+
+Documentation:
+  # Skips checking to make sure top level modules / classes have a comment.
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  # Skips checking the style of children definitions at classes and modules.
+  #
+  # Basically there are two different styles:
+  #
+  # `nested` - have each child on a separate line
+  #   class Foo
+  #     class Bar
+  #     end
+  #   end
+  #
+  # `compact` - combine definitions as much as possible
+  #   class Foo::Bar
+  #   end
+  #
+  # With it disabled, either or is valid.
+  Enabled: false

data/lib/orats/templates/base/Dockerfile

@@ -0,0 +1,102 @@
+FROM ruby:2.3-slim
+# Docker images can start off with nothing, but it's extremely
+# common to pull in from a base image. In our case we're pulling
+# in from the slim version of the official Ruby 2.3 image.
+#
+# Details about this image can be found here:
+# https://hub.docker.com/_/ruby/
+#
+# Slim is pulling in from the official Debian Jessie image.
+#
+# You can tell it's using Debian Jessie by clicking the
+# Dockerfile link next to the 2.3-slim bullet on the Docker hub.
+#
+# The Docker hub is the standard place for you to find official
+# Docker images. Think of it like GitHub but for Docker images.
+
+MAINTAINER Nick Janetakis <nick.janetakis@gmail.com>
+# It is good practice to set a maintainer for all of your Docker
+# images. It's not necessary but it's a good habit.
+
+RUN apt-get update && apt-get install -qq -y --no-install-recommends \
+      build-essential nodejs libpq-dev
+# Ensure that our apt package list is updated and install a few
+# packages to ensure that we can compile assets (nodejs) and
+# communicate with PostgreSQL (libpq-dev).
+
+ENV INSTALL_PATH /my_dockerized_app
+# The name of the application is my_dockerized_app and while there
+# is no standard on where your project should live inside of the Docker
+# image, I like to put it in the root of the image and name it
+# after the project.
+#
+# We don't even need to set the INSTALL_PATH variable, but I like
+# to do it because we're going to be referencing it in a few spots
+# later on in the Dockerfile.
+#
+# The variable could be named anything you want.
+
+RUN mkdir -p $INSTALL_PATH
+# This just creates the folder in the Docker image at the
+# install path we defined above.
+
+WORKDIR $INSTALL_PATH
+# We're going to be executing a number of commands below, and
+# having to CD into the /my_dockerized_app folder every time would be
+# lame, so instead we can set the WORKDIR to be /my_dockerized_app.
+#
+# By doing this, Docker will be smart enough to execute all
+# future commands from within this directory.
+
+COPY Gemfile Gemfile.lock ./
+# This is going to copy in the Gemfile and Gemfile.lock from our
+# work station at a path relative to the Dockerfile to the
+# my_dockerized_app/ path inside of the Docker image.
+#
+# It copies it to /my_dockerized_app because of the WORKDIR being set.
+#
+# We copy in our Gemfile before the main app because Docker is
+# smart enough to cache "layers" when you build a Docker image.
+#
+# You see, each command we have in the Dockerfile is going to be
+# ran and then saved as a separate layer. Docker is smart enough
+# to only re-build pieces that change, in order from top to bottom.
+#
+# This is an advanced concept but it means that we'll be able to
+# cache all of our gems so that if we make an application code
+# change, it won't re-run bundle install unless a gem changed.
+
+RUN bundle install --binstubs
+# We want binstubs to be available so we can directly call sidekiq and
+# potentially other binaries as command overrides without depending on
+# bundle exec.
+# This is mainly due for production compatibility assurance.
+
+COPY . .
+# This might look a bit alien but it's copying in everything from
+# the current directory relative to the Dockerfile, over to the
+# /my_dockerized_app folder inside of the Docker image.
+#
+# We can get away with using the . for the second argument because
+# this is how the unix command cp (copy) works. It stands for the
+# current directory.
+
+RUN bundle exec rake RAILS_ENV=production DATABASE_URL=postgresql://user:pass@127.0.0.1/dbname ACTION_CABLE_ALLOWED_REQUEST_ORIGINS=foo,bar SECRET_TOKEN=dummytoken assets:precompile
+# Provide a dummy DATABASE_URL and more to Rails so it can pre-compile
+# assets. The values do not need to be real, just valid syntax.
+#
+# If you're saving your assets to a CDN and are working with multiple
+# app instances, you may want to remove this step and deal with asset
+# compilation at a different stage of your deployment.
+
+VOLUME ["$INSTALL_PATH/public"]
+# In production you will very likely reverse proxy Rails with nginx.
+# This sets up a volume so that nginx can read in the assets from
+# the Rails Docker image without having to copy them to the Docker host.
+
+CMD puma -C config/puma.rb
+# This is the command that's going to be ran by default if you run the
+# Docker image without any arguments.
+#
+# In our case, it will start the Puma app server while passing in
+# its config file.

data/lib/orats/templates/base/Gemfile

@@ -0,0 +1,69 @@
+source 'https://rubygems.org'
+
+# Looking to use the Edge version? gem 'rails', github: 'rails/rails'
+gem 'rails', '~> 5.0.0'
+
+# Use Puma as the app server
+gem 'puma', '~> 3.0'
+
+# Use Rack Timeout. Read more: https://github.com/heroku/rack-timeout
+gem 'rack-timeout', '~> 0.4'
+
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 2.5'
+
+# Use PostgreSQL as the database for Active Record
+gem 'pg', '~> 0.18'
+
+# Use Redis Rails to set up a Redis backed Cache and / or Session
+gem 'redis-rails', '~> 5.0.0.pre'
+
+# Use Sidekiq as a background job processor through Active Job
+gem 'sidekiq', '~> 4.1'
+
+# Use Clockwork for recurring background tasks without needing cron
+# gem 'clockwork', '~> 2.0'
+
+# Use Kaminari for pagination
+# gem 'kaminari', '~> 0.16'
+
+# Use SCSS for stylesheets
+gem 'sass-rails', '~> 5.0'
+
+# Use Uglifier as the compressor for JavaScript assets
+gem 'uglifier', '>= 1.3.0'
+
+# Use jQuery as the JavaScript library
+gem 'jquery-rails'
+
+# Use Turbolinks. Read more: https://github.com/turbolinks/turbolinks
+gem 'turbolinks', '~> 5'
+
+# Use Bootstrap SASS for Bootstrap support
+gem 'bootstrap-sass', '~> 3.3'
+
+# Use Font Awesome Rails for Font Awesome icons
+gem 'font-awesome-rails', '~> 4.6'
+
+group :development, :test do
+  # Call 'byebug' anywhere in your code to drop into a debugger console
+  gem 'byebug', platform: :mri
+end
+
+group :development do
+  # Enable a debug toolbar to help profile your application
+  gem 'rack-mini-profiler', '~> 0.10'
+
+  # Access an IRB console on exception pages or by using <%= console %>
+  gem 'web-console'
+
+  # Get notified of file changes. Read more: https://github.com/guard/listen
+  gem 'listen', '~> 3.0.5'
+
+  # Use Spring. Read more: https://github.com/rails/spring
+  gem 'spring'
+  gem 'spring-watcher-listen', '~> 2.0.0'
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]