orats 0.6.5 → 0.7.0

data/lib/orats/commands/{new → project}/rails.rb

@@ -1,11 +1,12 @@
 module Orats
   module Commands
-    module New
+    module Project
       module Rails
         def check_exit_conditions
           exit_if_process :not_found, 'rails', 'git'
           exit_if_process :not_running, 'postgres', 'redis'
           exit_if_path_exists
+          exit_if_invalid_template
         end
 
         def rails_template(command, flags = '')
@@ -18,10 +19,10 @@ module Orats
         def custom_rails_template
           log_task 'Run custom rails template'
 
-          @options[:template].include?('://') ? url_to_string(@options[:template])
-          : file_to_string(@options[:template])
+          @options[:custom].include?('://') ? url_to_string(@options[:custom])
+          : file_to_string(@options[:custom])
 
-          rails_template '', "--skip --template #{@options[:template]}"
+          rails_template '', "--skip --template #{@options[:custom]}"
         end
 
         def gsub_postgres_info
@@ -43,7 +44,8 @@ module Orats
 
         def gsub_project_path
           log_task 'Update the project path'
-          gsub_file "#{@active_path}/.env", ': /full/path/to/your/project', ": #{File.expand_path(@active_path)}"
+          gsub_file "#{@active_path}/.env", ': /home/yourname/dev/testproj',
+                    ": #{File.expand_path(@active_path)}"
 
           git_commit 'Update the project path'
         end
@@ -83,6 +85,8 @@ module Orats
         end
 
         def generate_home_page
+          kill_spring_servers
+
           log_task 'Add pages controller with static page'
           run_from @active_path, 'bundle exec rails g controller Pages home'
 
@@ -95,89 +99,61 @@ module Orats
 
           gsub_file "#{@active_path}/test/controllers/pages_controller_test.rb",
                     '"should get home"', "'expect home page'"
-          gsub_file "#{@active_path}/app/views/pages/home.html.erb", /.*\n/, ''
-          append_file "#{@active_path}/app/views/pages/home.html.erb" do
-            <<-S
-<%
-  title 'Welcome to Ruby on Rails'
-  meta_description '...'
-  heading 'Welcome to Ruby on Rails'
-%>
-
-<div class="row">
-  <div class="col-sm-9">
-    <p class="lead">
-      You have successfully generated a project with <%= link_to 'orats', 'https://github.com/nickjj/orats' %> v#{VERSION}.
-    </p>
-
-    <hr />
-
-    <p>
-      <%= image_tag 'https://badge.fury.io/rb/orats.png', alt: 'Gem badge' %> is the latest version of orats.
-    </p>
-
-    <hr />
-
-    <h3>Custom rake tasks</h3>
-    <pre>
-      <code>
-      # backup the database to S3 or any other location
-      bundle exec rake orats:backup
-
-      # generate a new set of favicons to the public directory
-      bundle exec rake orats:favicons
-      </code>
-    </pre>
-
-    <hr />
-
-    <h3>Trying to figure out what to do next?</h3>
-    <p>
-      Visit the wiki guide for <%= link_to 'what to look at after making a new project', 'https://github.com/nickjj/orats/wiki/What-to-look-at-after-making-a-new-project' %>.
-    </p>
-
-    <hr />
-
-    <h3>Looking to deploy your application?</h3>
-    <p>
-      Visit the wiki guide for <%= link_to 'get your application on a server ', 'https://github.com/nickjj/orats/wiki/Get-your-application-on-a-server' %>.
-    </p>
-
-    <hr />
-
-    <h3>Want to get rid of the pages controller?</h3>
-    <p>
-      No problem, just follow these steps:
-      <ul>
-        <li>
-          Run <code>bundle exec rails d controller Pages</code>
-        </li>
-        <li>
-          Remove the root route from <code>config/routes.rb</code>
-        </li>
-        <li>
-          Remove the link in the navigation partial at <code>app/views/layouts/_navigation_links.html.erb</code>
-        </li>
-        <li>
-          Restart the server
-        </li>
-      </ul>
-    </p>
-  </div>
-
-  <div class="col-sm-3">
-    <%= image_tag '/apple-touch-icon-228x228-precomposed.png', size: '228x228', alt: 'A ruby image I found on Google' %>
-  </div>
-</div>
-            S
-          end
+
+          run_from @active_path, "rm app/views/pages/home.html.erb"
+          Commands::Common.copy_from_local_gem 'new/rails/app/views/pages/home.html.erb',
+                                               "#{@active_path}/app/views/pages/home.html.erb"
+          gsub_file "#{@active_path}/app/views/pages/home.html.erb",
+                    'vVERSION', VERSION
+
           git_commit 'Add pages controller with home page'
         end
 
+        def generate_favicons
+          log_task 'Add favicons'
+          run_rake 'orats:favicons'
+          git_commit 'Add favicons'
+        end
+
         def create_and_migrate_database
           run_rake 'db:create:all db:migrate'
           git_commit 'Add the database schema file'
         end
+
+        def migrate_and_seed_database
+          run_rake 'db:migrate db:seed'
+          git_commit 'Update the database schema file'
+        end
+
+        def template_exist?(template)
+          Exec::PROJECT_TEMPLATES.include?(template.to_sym)
+        end
+
+        private
+
+        def exit_if_invalid_template
+          if @options[:template].length > 0
+            log_task 'Check if template exists'
+
+            unless template_exist?(@options[:template])
+              log_error 'error', 'Cannot find template', 'message',
+                        "'#{@options[:template]}' is not a valid template name",
+                        true do
+                log_status_bottom 'tip',
+                                  'run `orats templates` to get a list of valid templates',
+                                  :white
+              end
+
+              exit 1
+            end
+          end
+        end
+
+        def kill_spring_servers
+          # rails generators will lock up if a spring server is running,
+          # so kill them before continuing
+          system 'pkill -f spring'
+        end
       end
     end
   end

data/lib/orats/commands/{new → project}/server.rb

@@ -3,18 +3,20 @@ require 'timeout'
 
 module Orats
   module Commands
-    module New
+    module Project
       module Server
+        START_COMMAND = 'bundle exec foreman start'
+
         def server_start
           @options[:skip_server_start] ? message = 'Start your' : message = 'Starting'
 
           puts '', '='*80
           log_status_top 'action', "#{message} server with the following commands", :cyan
           log_status_bottom 'command', "cd #{@active_path}", :magenta, true
-          log_status_bottom 'command', 'bundle exec foreman start', :magenta
+          log_status_bottom 'command', START_COMMAND, :magenta
           puts '='*80, ''
 
-          attempt_to_start
+          attempt_to_start unless @options[:skip_server_start]
         end
 
         private
@@ -28,7 +30,7 @@ module Orats
 
           puts
 
-          run_from @active_path, 'bundle exec foreman start'
+          run_from @active_path, START_COMMAND
         end
 
         def port_taken?

data/lib/orats/templates/auth.rb

@@ -43,6 +43,15 @@ end
   }
 end
 
+def copy_from_local_gem(source, dest = '')
+  dest = source if dest.empty?
+
+  base_path = "#{File.expand_path File.dirname(__FILE__)}/includes/new/rails"
+
+  run "mkdir -p #{File.dirname(dest)}" unless Dir.exist?(File.dirname(dest))
+  run "cp -f #{base_path}/#{source} #{dest}"
+end
+
 # ---
 
 def delete_app_css
@@ -119,7 +128,7 @@ end
 def add_devise_initializers
   log_task __method__
 
-  file 'config/initializers/devise_async.rb', 'Devise::Async.backend = :sidekiq'
+  copy_from_local_gem 'config/initializers/devise_async.rb'
   generate 'devise:install'
   git_commit 'Add the devise and devise async initializers'
 end
@@ -242,50 +251,7 @@ end
 def add_account_model
   log_task __method__
 
-  file 'app/models/account.rb' do
-    <<-'S'
-class Account < ActiveRecord::Base
-  ROLES = %w[admin guest]
-
-  devise :database_authenticatable, :registerable, :recoverable, :rememberable,
-         :trackable, :timeoutable, :lockable, :validatable, :async
-
-  before_validation :ensure_password, on: :create
-
-  after_save :invalidate_cache
-
-  validates :role, inclusion: { in: ROLES }
-
-  def self.serialize_from_session(key, salt)
-    # store the current_account in the cache so we do not perform a db lookup on each authenticated page
-    single_key = key.is_a?(Array) ? key.first : key
-
-    Rails.cache.fetch("account:#{single_key}") do
-      Account.where(id: single_key).entries.first
-    end
-  end
-
-  def self.generate_password(length = 10)
-    Devise.friendly_token.first(length)
-  end
-
-  def is?(role_check)
-    role.to_sym == role_check
-  end
-
-  private
-
-    def ensure_password
-      # only generate a password if it does not exist
-      self.password ||= Account.generate_password
-    end
-
-    def invalidate_cache
-      Rails.cache.delete("account:#{id}")
-    end
-end
-    S
-  end
+  copy_from_local_gem 'app/models/account.rb'
   git_commit 'Add account model'
 end
 
@@ -312,92 +278,14 @@ end
 
 def add_account_fixtures
   log_task __method__
-  file 'test/fixtures/accounts.yml' do
-    <<-S
-foo:
-  id: 1
-  email: foo@bar.com
-  encrypted_password: passwordisnotreallyencrypted
-  role: admin
-  created_at: 2012-01-01 01:45:17
-  current_sign_in_at: 2013-03-15 11:22:33
-
-no_role:
-  id: 2
-  email: joey@almostcool.com
-  encrypted_password: hackthegibson
-  created_at: 1995-09-15 08:10:12
-
-bad_role:
-  id: 3
-  email: hello@world.com
-  encrypted_password: reallysecure
-  role: ahhhh
-  created_at: 2011-09-20 10:10:10
-
-beep:
-  id: 4
-  email: beep@beep.com
-  encrypted_password: beepbeepbeep
-  created_at: 2010-03-6 05:15:45
-    S
-  end
+  copy_from_local_gem 'test/fixtures/accounts.yml'
   git_commit 'Add account fixtures'
 end
 
 def add_account_unit_tests
   log_task __method__
 
-  file 'test/models/account_test.rb' do
-    <<-S
-require 'test_helper'
-
-class AccountTest < ActiveSupport::TestCase
-  def setup
-    @account = accounts(:foo)
-  end
-
-  def teardown
-    @account = nil
-  end
-
-  test 'expect new account' do
-    assert @account.valid?
-    assert_not_nil @account.email
-    assert_not_nil @account.encrypted_password
-  end
-
-  test 'expect guest to be default role' do
-    no_role = accounts(:no_role)
-    assert_equal 'guest', no_role.role
-  end
-
-  test 'expect invalid role to not save' do
-    bad_role = accounts(:bad_role)
-    assert_not bad_role.valid?
-  end
-
-  test 'expect e-mail to be unique' do
-    duplicate = Account.create(email: 'foo@bar.com')
-
-    assert_not duplicate.valid?
-  end
-
-  test 'expect random password if password is empty' do
-    @account.password = ''
-    @account.encrypted_password = ''
-    @account.save
-
-    random_password = Account.generate_password
-    assert_equal 10, random_password.length
-  end
-
-  test 'expect random password of 20 characters' do
-    assert_equal 20, Account.generate_password(20).length
-  end
-end
-    S
-  end
+  copy_from_local_gem 'test/models/account_test.rb'
   git_commit 'Add account unit tests'
 end
 
@@ -436,368 +324,25 @@ end
 def add_devise_views
   log_task __method__
 
-  file 'app/views/devise/confirmations/new.html.erb' do
-    <<-S
-<%
-  title 'Confirm'
-  meta_description '...'
-  heading 'Confirm'
-%>
-
-<div class="row">
-  <div class="col-sm-4">
-    <%= form_for(resource, as: resource_name, url: confirmation_path(resource_name), html: { method: :post }) do |f| %>
-      <div class="form-group">
-        <%= f.label :email %>
-        <%= f.email_field :email, class: 'form-control', maxlength: 254, autofocus: true,
-        data: {
-          'rule-required' => 'true',
-          'rule-maxlength' => '254'
-        } %>
-      </div>
-      <%= button_tag type: 'submit', class: 'btn btn-primary' do %>
-        Send
-      <% end %>
-    <% end %>
-  </div>
-  <div class="col-sm-6 col-sm-offset-2">
-    <%= render 'devise/shared/links' %>
-  </div>
-</div>
-    S
-  end
-
-  file 'app/views/devise/mailer/confirmation_instructions.html.erb' do
-    <<-S
-<p>Welcome <%= @email %>!</p>
-
-<p>You can confirm your account email through the link below:</p>
-
-<p><%= link_to 'Confirm my account', confirmation_url(@resource, confirmation_token: @token) %></p>
-    S
-  end
-
-  file 'app/views/devise/mailer/reset_password_instructions.html.erb' do
-    <<-S
-<p>Hello <%= @resource.email %>!</p>
-
-<p>Someone has requested a link to change your password. You can do this through the link below.</p>
-
-<p><%= link_to 'Change my password', edit_password_url(@resource, reset_password_token: @token) %></p>
-
-<p>If you didn't request this, please ignore this email.</p>
-<p>Your password won't change until you access the link above and create a new one.</p>
-    S
-  end
-
-  file 'app/views/devise/mailer/unlock_instructions.html.erb' do
-    <<-S
-<p>Hello <%= @resource.email %>!</p>
-
-<p>Your account has been locked due to an excessive number of unsuccessful sign in attempts.</p>
-
-<p>Click the link below to unlock your account:</p>
-
-<p><%= link_to 'Unlock my account', unlock_url(@resource, unlock_token: @token) %></p>
-    S
-  end
-
-  file 'app/views/devise/passwords/edit.html.erb' do
-    <<-S
-<%
-  title 'Change your password'
-  meta_description '...'
-  heading 'Change your password'
-%>
-
-<div class="row">
-  <div class="col-sm-4">
-    <%= form_for resource, as: resource_name, url: password_path(resource_name), html: { method: :put } do |f| %>
-      <%= f.hidden_field :reset_password_token %>
-      <div class="form-group">
-        <%= f.label :password, 'New password' %>
-        <%= f.password_field :password, maxlength: 128, class: 'form-control', autofocus: true,
-        data: {
-          'rule-required' => 'true',
-          'rule-minlength' => '8',
-          'rule-maxlength' => '128'
-        } %>
-      </div>
-      <%= button_tag type: 'submit', class: 'btn btn-primary' do %>
-        Send
-      <% end %>
-    <% end %>
-  </div>
-  <div class="col-sm-6 col-sm-offset-2">
-    <%= render 'devise/shared/links' %>
-  </div>
-</div>
-    S
-  end
-
-  file 'app/views/devise/passwords/new.html.erb' do
-    <<-S
-<%
-  title 'Forgot your password?'
-  meta_description '...'
-  heading 'Forgot your password?'
-%>
-
-<div class="row">
-  <div class="col-sm-4">
-    <%= form_for resource, as: resource_name, url: password_path(resource_name), html: { method: :post } do |f| %>
-      <div class="form-group">
-        <%= f.label :email %>
-        <%= f.email_field :email, class: 'form-control', autofocus: true, maxlength: 254,
-        data: {
-          'rule-required' => 'true',
-          'rule-maxlength' => '254'
-        } %>
-      </div>
-      <%= button_tag type: 'submit', class: 'btn btn-primary' do %>
-        Send
-      <% end %>
-    <% end %>
-  </div>
-  <div class="col-sm-6 col-sm-offset-2">
-    <%= render 'devise/shared/links' %>
-  </div>
-</div>
-    S
-  end
-
-  file 'app/views/devise/registrations/edit.html.erb' do
-    <<-S
-<%
-  title 'Edit your account'
-  meta_description '...'
-  heading 'Edit your account'
-%>
-
-<div class="row">
-  <div class="col-sm-6">
-    <%= form_for resource, as: resource_name, url: registration_path(resource_name), html: { method: :patch } do |f| %>
-      <div class="form-group">
-        <%= f.label :current_password %>
-        <span class="help-block form-help-adjust-margin">
-          <small>
-            Supply your current password to make any changes
-          </small>
-        </span>
-        <%= f.password_field :current_password, maxlength: 128, class: 'form-control',
-        data: {
-          'rule-required' => 'true',
-          'rule-minlength' => '8',
-          'rule-maxlength' => '128'
-        } %>
-      </div>
-      <div class="form-group">
-        <%= f.label :email %>
-        <%= f.email_field :email, class: 'form-control', maxlength: 254, autofocus: true %>
-      </div>
-      <% if devise_mapping.confirmable? && resource.pending_reconfirmation? %>
-        <h3>Currently waiting confirmation for: <%= resource.unconfirmed_email %></h3>
-      <% end %>
-      <div class="form-group">
-        <%= f.label :password %>
-        <span class="help-block form-help-adjust-margin">
-          <small>
-            Leave this blank if you do not want to change it
-          </small>
-        </span>
-        <%= f.password_field :password, class: 'form-control' %>
-      </div>
-      <%= button_tag type: 'submit', class: 'btn btn-primary' do %>
-        Save
-      <% end %>
-    <% end %>
-  </div>
-  <div class="col-sm-6">
-    <p>
-      Unhappy? <%= button_to 'Cancel my account', registration_path(resource_name), method: :delete %>
-    </p>
-  </div>
-</div>
-    S
-  end
-
-  file 'app/views/devise/registrations/new.html.erb' do
-    <<-S
-<%
-  title 'Register a new account'
-  meta_description '...'
-  heading 'Register a new account'
-%>
-
-<div class="row">
-  <div class="col-sm-4">
-    <%= form_for resource, as: resource_name, url: registration_path(resource_name) do |f| %>
-      <div class="form-group">
-        <%= f.label :email %>
-        <%= f.email_field :email, class: 'form-control', maxlength: 254, autofocus: true %>
-      </div>
-      <div class="form-group">
-        <%= f.label :password %>
-        <%= f.password_field :password, maxlength: 128, class: 'form-control',
-        data: {
-          'rule-required' => 'true',
-          'rule-minlength' => '8',
-          'rule-maxlength' => '128'
-        } %>
-      </div>
-      <%= button_tag type: 'submit', class: 'btn btn-primary' do %>
-        Register
-      <% end %>
-    <% end %>
-  </div>
-  <div class="col-sm-6 col-sm-offset-2">
-    <%= render 'devise/shared/links' %>
-  </div>
-</div>
-    S
-  end
-
-  file 'app/views/devise/sessions/new.html.erb' do
-    <<-S
-<%
-  title 'Sign in'
-  meta_description '...'
-  heading 'Sign in'
-%>
-
-<div class="row">
-  <div class="col-sm-4">
-    <%= form_for resource, as: resource_name, url: session_path(resource_name) do |f| %>
-      <div class="form-group">
-        <%= f.label :email %>
-        <%= f.email_field :email, maxlength: 254, class: 'form-control', autofocus: true %>
-      </div>
-      <div class="form-group">
-        <%= f.label :password %>
-        <%= f.password_field :password, maxlength: 128, class: 'form-control',
-        data: {
-          'rule-required' => 'true',
-          'rule-minlength' => '8',
-          'rule-maxlength' => '128'
-        } %>
-      </div>
-      <% if devise_mapping.rememberable? -%>
-        <div class="checkbox">
-          <%= f.label :remember_me do %>
-            <%= f.check_box :remember_me %> Stay signed in
-          <% end %>
-        </div>
-      <% end -%>
-      <%= button_tag type: 'submit', class: 'btn btn-primary' do %>
-        Sign in
-      <% end %>
-    <% end %>
-  </div>
-  <div class="col-sm-6 col-sm-offset-2">
-    <h4 class="success-color">Having trouble accessing your account?</h4>
-    <%= render 'devise/shared/links' %>
-  </div>
-</div>
-    S
-  end
-
-  file 'app/views/devise/unlocks/new.html.erb' do
-    <<-S
-<%
-  title 'Re-send unlock instructions'
-  meta_description '...'
-  heading 'Re-send unlock instructions'
-%>
-
-<div class="row">
-  <div class="col-sm-4">
-    <%= form_for(resource, as: resource_name, url: unlock_path(resource_name), html: { method: :post }) do |f| %>
-      <div class="form-group">
-        <%= f.label :email %>
-        <%= f.email_field :email, class: 'form-control', maxlength: 254, autofocus: true,
-        data: {
-          'rule-required' => 'true',
-          'rule-maxlength' => '254'
-        } %>
-      </div>
-      <%= button_tag type: 'submit', class: 'btn btn-primary' do %>
-        Send
-      <% end %>
-    <% end %>
-  </div>
-  <div class="col-sm-6 col-sm-offset-2">
-    <%= render 'devise/shared/links' %>
-  </div>
-</div>
-    S
-  end
-
-  file 'app/views/devise/shared/_links.html.erb' do
-    <<-'S'
-<%= content_tag(:h4, 'Or do something else') if controller_name != 'sessions' %>
-<ul>
-  <%- if controller_name != 'sessions' %>
-    <li>
-      <%= link_to 'Sign in', new_session_path(resource_name) %>
-    </li>
-  <% end -%>
-
-  <%- if devise_mapping.registerable? && controller_name != 'registrations' %>
-    <li>
-      <%= link_to 'Sign up', new_registration_path(resource_name) %>
-    </li>
-  <% end -%>
-
-  <%- if devise_mapping.recoverable? && controller_name != 'passwords' && controller_name != 'registrations' %>
-    <li>
-      <%= link_to 'Forgot your password?', new_password_path(resource_name) %>
-    </li>
-  <% end -%>
-
-  <%- if devise_mapping.confirmable? && controller_name != 'confirmations' %>
-    <li>
-      <%= link_to 'Re-send confirmation instructions?', new_confirmation_path(resource_name) %>
-    </li>
-  <% end -%>
-
-  <%- if devise_mapping.lockable? && resource_class.unlock_strategy_enabled?(:email) && controller_name != 'unlocks' %>
-    <li>
-      <%= link_to 'Are you locked out of your account?', new_unlock_path(resource_name) %>
-    </li>
-  <% end -%>
-
-  <%- if devise_mapping.omniauthable? %>
-    <%- resource_class.omniauth_providers.each do |provider| %>
-      <li><%= link_to "Sign in with #{provider.to_s.titleize}", omniauth_authorize_path(resource_name, provider) %></li>
-    <% end -%>
-  <% end -%>
-</ul>
-    S
-  end
+  copy_from_local_gem 'app/views/devise/confirmations/new.html.erb'
+  copy_from_local_gem 'app/views/devise/mailer/confirmation_instructions.html.erb'
+  copy_from_local_gem 'app/views/devise/mailer/confirmation_instructions.html.erb'
+  copy_from_local_gem 'app/views/devise/mailer/reset_password_instructions.html.erb'
+  copy_from_local_gem 'app/views/devise/mailer/unlock_instructions.html.erb'
+  copy_from_local_gem 'app/views/devise/passwords/edit.html.erb'
+  copy_from_local_gem 'app/views/devise/passwords/new.html.erb'
+  copy_from_local_gem 'app/views/devise/registrations/edit.html.erb'
+  copy_from_local_gem 'app/views/devise/registrations/new.html.erb'
+  copy_from_local_gem 'app/views/devise/sessions/new.html.erb'
+  copy_from_local_gem 'app/views/devise/unlocks/new.html.erb'
+  copy_from_local_gem 'app/views/devise/shared/_links.html.erb'
   git_commit 'Add devise views'
 end
 
 def add_auth_links_to_the_navbar
   log_task __method__
 
-  file 'app/views/layouts/_navigation_auth.html.erb', <<-S
-<% if current_account %>
-  <li>
-    <%= link_to 'Settings', edit_account_registration_path %>
-  </li>
-  <li>
-    <%= link_to 'Sign out', destroy_account_session_path, method: :delete %>
-  </li>
-<% else %>
-  <li>
-    <%= link_to 'Sign in', new_account_session_path %>
-  </li>
-  <li>
-    <%= link_to 'Register', new_account_registration_path %>
-  </li>
-<% end %>
-  S
-
+  copy_from_local_gem 'app/views/layouts/_navigation_auth.html.erb'
   inject_into_file 'app/views/layouts/_navigation.html.erb', after: "</ul>\n" do
     <<-S
       <ul class="nav navbar-nav nav-auth">