orats 0.6.5 → 0.7.0

data/lib/orats/templates/includes/common/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) Time.now.year author_name author_email
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/orats/templates/includes/new/rails/.env

@@ -0,0 +1,43 @@
+RAILS_ENV: development
+
+PROJECT_PATH: /home/yourname/dev/testproj
+TIME_ZONE: Eastern Time (US & Canada)
+DEFAULT_LOCALE: en
+
+GOOGLE_ANALYTICS_UA: ""
+DISQUS_SHORT_NAME: ""
+S3_ACCESS_KEY_ID: ""
+S3_SECRET_ACCESS_KEY: ""
+S3_REGION: ""
+
+TOKEN_RAILS_SECRET: generate_token
+
+SMTP_ADDRESS: smtp.gmail.com
+SMTP_PORT: 587 # 465 if you use ssl
+SMTP_DOMAIN: gmail.com
+SMTP_USERNAME: app_name@gmail.com
+SMTP_PASSWORD: thebestpassword
+SMTP_AUTH: plain
+SMTP_ENCRYPTION: starttls
+
+ACTION_MAILER_HOST: localhost:3000
+ACTION_MAILER_DEFAULT_FROM: info@app_name.com
+ACTION_MAILER_DEFAULT_TO: me@app_name.com
+
+DATABASE_NAME: app_name
+DATABASE_HOST: localhost
+DATABASE_POOL: 25
+DATABASE_TIMEOUT: 5000
+DATABASE_USERNAME: postgres
+DATABASE_PASSWORD: supersecrets
+
+CACHE_HOST: localhost
+CACHE_PORT: 6379
+CACHE_DATABASE: 0
+CACHE_PASSWORD: ""
+
+PUMA_THREADS_MIN: 0
+PUMA_THREADS_MAX: 1
+PUMA_WORKERS: 0
+
+SIDEKIQ_CONCURRENCY: 25

data/lib/orats/templates/includes/{Gemfile → new/rails/Gemfile}

@@ -21,7 +21,7 @@ gem 'backup', '~> 4.0.1', require: false
 
 gem 'sitemap_generator', '~> 5.0.2'
 gem 'favicon_maker', '~> 1.3'
-gem 'kaminari', '~> 0.16.0'
+gem 'kaminari', '~> 0.16.1'
 
 group :development do
   gem 'foreman', require: false

data/lib/orats/templates/includes/new/rails/Procfile

@@ -0,0 +1,3 @@
+web: puma -C config/puma.rb | grep -v --line-buffered ' 304 -'
+worker: sidekiq -C config/sidekiq.yml
+log: tail -f log/development.log | grep -xv --line-buffered '^[[:space:]]*' | grep -v --line-buffered '/assets/'

data/lib/orats/templates/includes/new/rails/README.md

@@ -0,0 +1,3 @@
+## Project information
+
+This project was generated with [orats](https://github.com/nickjj/orats) vVERSION.

data/lib/orats/templates/includes/new/rails/app/helpers/application_helper.rb

@@ -0,0 +1,53 @@
+module ApplicationHelper
+  def title(page_title)
+    content_for(:title) { page_title }
+  end
+
+  def meta_description(page_meta_description)
+    content_for(:meta_description) { page_meta_description }
+  end
+
+  def heading(page_heading)
+    content_for(:heading) { page_heading }
+  end
+
+  def link_to_all_favicons
+    '<link href="speeddial-160x160.png" rel="icon" type="image/png" />
+      <link href="apple-touch-icon-228x228-precomposed.png" rel="apple-touch-icon-precomposed" sizes="228x228" type="image/png" />
+      <link href="apple-touch-icon-152x152-precomposed.png" rel="apple-touch-icon-precomposed" sizes="152x152" type="image/png" />
+      <link href="apple-touch-icon-144x144-precomposed.png" rel="apple-touch-icon-precomposed" sizes="144x144" type="image/png" />
+      <link href="apple-touch-icon-120x120-precomposed.png" rel="apple-touch-icon-precomposed" sizes="120x120" type="image/png" />
+      <link href="apple-touch-icon-114x114-precomposed.png" rel="apple-touch-icon-precomposed" sizes="114x114" type="image/png" />
+      <link href="apple-touch-icon-76x76-precomposed.png" rel="apple-touch-icon-precomposed" sizes="76x76" type="image/png" />
+      <link href="apple-touch-icon-72x72-precomposed.png" rel="apple-touch-icon-precomposed" sizes="72x72" type="image/png" />
+      <link href="apple-touch-icon-60x60-precomposed.png" rel="apple-touch-icon-precomposed" sizes="60x60" type="image/png" />
+      <link href="apple-touch-icon-57x57-precomposed.png" rel="apple-touch-icon-precomposed" sizes="57x57" type="image/png" />
+      <link href="favicon-196x196.png" rel="icon" sizes="196x196" type="image/png" />
+      <link href="favicon-160x160.png" rel="icon" sizes="160x160" type="image/png" />
+      <link href="favicon-96x96.png" rel="icon" sizes="96x96" type="image/png" />
+      <link href="favicon-64x64.png" rel="icon" sizes="64x64" type="image/png" />
+      <link href="favicon-32x32.png" rel="icon" sizes="32x32" type="image/png" />
+      <link href="favicon-24x24.png" rel="icon" sizes="24x24" type="image/png" />
+      <link href="favicon-16x16.png" rel="icon" sizes="16x16" type="image/png" />
+      <link href="favicon.ico" rel="icon" type="image/x-icon" />
+      <link href="favicon.ico" rel="shortcut icon" type="image/x-icon" />'.html_safe
+  end
+
+  def humanize_boolean(input)
+    input ||= ''
+    case input.to_s.downcase
+      when 't', 'true'
+        'Yes'
+      else
+        'No'
+    end
+  end
+
+  def css_for_boolean(input)
+    if input
+      'success'
+    else
+      'danger'
+    end
+  end
+end

data/lib/orats/templates/includes/new/rails/app/models/account.rb

@@ -0,0 +1,40 @@
+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

data/lib/orats/templates/includes/new/rails/app/views/devise/confirmations/new.html.erb

@@ -0,0 +1,26 @@
+<%
+   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>

data/lib/orats/templates/includes/new/rails/app/views/devise/mailer/confirmation_instructions.html.erb

@@ -0,0 +1,5 @@
+<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>

data/lib/orats/templates/includes/new/rails/app/views/devise/mailer/reset_password_instructions.html.erb

@@ -0,0 +1,10 @@
+<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>

data/lib/orats/templates/includes/new/rails/app/views/devise/mailer/unlock_instructions.html.erb

@@ -0,0 +1,8 @@
+<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>

data/lib/orats/templates/includes/new/rails/app/views/devise/passwords/edit.html.erb

@@ -0,0 +1,28 @@
+<%
+   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>

data/lib/orats/templates/includes/new/rails/app/views/devise/passwords/new.html.erb

@@ -0,0 +1,26 @@
+<%
+   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>

data/lib/orats/templates/includes/new/rails/app/views/devise/registrations/edit.html.erb

@@ -0,0 +1,51 @@
+<%
+   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>

data/lib/orats/templates/includes/new/rails/app/views/devise/registrations/new.html.erb

@@ -0,0 +1,31 @@
+<%
+   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>

data/lib/orats/templates/includes/new/rails/app/views/devise/sessions/new.html.erb

@@ -0,0 +1,39 @@
+<%
+   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>

data/lib/orats/templates/includes/new/rails/app/views/devise/shared/_links.html.erb

@@ -0,0 +1,38 @@
+<%= 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>