forest_cms 0.98.1

data/lib/generators/forest/scaffold/templates/admin_controller.rb

@@ -0,0 +1,67 @@
+<% module_namespacing do -%>
+class Admin::<%= plural_name.camelize %>Controller < Admin::ForestController
+  before_action :set_<%= singular_name %>, only: [:show, :edit, :update, :destroy]
+
+  def index
+    @<%= plural_name %> = apply_scopes(<%= name %>).by_id.page(params[:page])
+  end
+
+  def show
+    authorize @<%= singular_name %>
+  end
+
+  def new
+    @<%= singular_name %> = <%= name %>.new
+    authorize @<%= singular_name %>
+  end
+
+  def edit
+    authorize @<%= singular_name %>
+  end
+
+  def create
+    @<%= singular_name %> = <%= name %>.new(<%= singular_name %>_params)
+    authorize @<%= singular_name %>
+
+    if @<%= singular_name %>.save
+      redirect_to edit_admin_<%= singular_name %>_path(@<%= singular_name %>), notice: '<%= name %> was successfully created.'
+    else
+      render :new
+    end
+  end
+
+  def update
+    authorize @<%= singular_name %>
+
+    if @<%= singular_name %>.update(<%= singular_name %>_params)
+      redirect_to edit_admin_<%= singular_name %>_path(@<%= singular_name %>), notice: '<%= name %> was successfully updated.'
+    else
+      render :edit
+    end
+  end
+
+  def destroy
+    authorize @<%= singular_name %>
+    @<%= singular_name %>.destroy
+    redirect_to admin_<%= plural_name %>_url, notice: '<%= name %> was successfully destroyed.'
+  end
+
+  private
+
+    def <%= singular_name %>_params
+      # Add blockable params to the permitted attributes if this record is blockable `**BlockSlot.blockable_params`
+<%
+        additional_attributes = []
+        additional_attributes.prepend(':status') unless options.skip_statusable?
+        additional_attributes.prepend(':slug') unless options.skip_sluggable?
+        additional_attributes = additional_attributes.join(', ')
+        additional_attributes = additional_attributes << ', ' if additional_attributes.present?
+-%>
+      params.require(:<%= singular_name %>).permit(<%= additional_attributes -%><%= attributes.collect { |a| ":#{a.column_name}" }.join(', ') %>)
+    end
+
+    def set_<%= singular_name %>
+      @<%= singular_name %> = <%= name %>.find(params[:id])
+    end
+end
+<% end -%>

data/lib/generators/forest/scaffold/templates/controller.rb

@@ -0,0 +1,20 @@
+<% module_namespacing do -%>
+class <%= plural_name.camelize %>Controller < ForestController
+  before_action :set_<%= singular_name %>, only: [:show]
+
+  def index
+    # TODO: published/statusable scope
+    @<%= plural_name %> = apply_scopes(<%= name %>)
+  end
+
+  def show
+    authorize @<%= singular_name %>
+  end
+
+  private
+
+    def set_<%= singular_name %>
+      @<%= singular_name %> = <%= name %>.find_by!(slug: params[:id])
+    end
+end
+<% end -%>

data/lib/generators/forest/scaffold/templates/create_table_migration.rb

@@ -0,0 +1,35 @@
+class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :<%= table_name %> do |t|
+<% attributes.each do |attribute| -%>
+      t.<%= attribute.type %> :<%= attribute.name %><%= attribute.inject_options %>
+<% end -%>
+<% unless options.skip_sluggable? -%>
+      t.string :slug
+<% end -%>
+<% unless options.skip_statusable? -%>
+      t.integer :status, default: 1, null: false
+<% end -%>
+<% unless options.skip_blockable? -%>
+      t.jsonb :blockable_metadata, default: {}
+<% end -%>
+
+      t.timestamps
+    end
+<% attributes.select(&:token?).each do |attribute| -%>
+    add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>, unique: true
+<% end -%>
+<% attributes_with_index.each do |attribute| -%>
+    add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>
+<% end -%>
+<% unless options.skip_sluggable? -%>
+    add_index :<%= table_name %>, :slug, unique: true
+<% end -%>
+<% unless options.skip_statusable? -%>
+    add_index :<%= table_name %>, :status
+<% end -%>
+<% unless options.skip_blockable? -%>
+    add_index :<%= table_name %>, :blockable_metadata, using: :gin
+<% end -%>
+  end
+end

data/lib/generators/forest/scaffold/templates/model.rb

@@ -0,0 +1,21 @@
+<% module_namespacing do -%>
+class <%= class_name %> < Forest::ApplicationRecord
+<% unless options.skip_blockable? -%>
+  include Blockable
+<% end -%>
+<% unless options.skip_sluggable? -%>
+  include Sluggable
+<% end -%>
+<% unless options.skip_statusable? -%>
+  include Statusable
+<% end -%>
+
+<% attributes.each do |attribute| %><% if attribute.reference? -%>
+  belongs_to :<%= attribute.name %>
+
+<% end -%><% end -%>
+  # def self.resource_description
+  #   'Briefly describe this resource.'
+  # end
+end
+<% end -%>

data/lib/generators/forest/scaffold/templates/policy.rb

@@ -0,0 +1,2 @@
+class <%= name %>Policy < BlockRecordPolicy
+end

data/lib/generators/forest/scaffold/templates/views/admin/_form.html.erb

@@ -0,0 +1,56 @@
+<%%= simple_form_for([:admin, @<%= singular_table_name %>]) do |f| %>
+  <%%= f.error_notification %>
+  <div class="row">
+    <div class="col-sm-12">
+      <div class="panel panel-default" data-collapse-parent>
+        <div class="panel-heading">
+          <h3 class="panel-title">
+            Metadata
+            <button type="button" class="btn btn-default btn-xs pull-right" data-collapse-trigger>
+              <div class="collapsable-icon glyphicon glyphicon-chevron-up"></div>
+            </button>
+          </h3>
+        </div>
+        <div class="panel-body" data-collapse-body>
+          <div class="form-inputs">
+            <div class="row">
+              <div class="col-sm-6">
+<% unless options.skip_sluggable? -%>
+                <%%= render 'admin/form_inputs/slug', f: f %>
+<% end -%>
+                <%- for attribute in attributes -%>
+                <%- if attribute.reference? -%>
+                  <%- if attribute.name =~ /media_item/ -%>
+                <%%= f.association :<%= attribute.name %>, as: :image %>
+                  <%- else -%>
+                <%%= f.association :<%= attribute.name %> %>
+                  <%- end -%>
+                <%- else -%>
+                  <%- if attribute.name =~ /date/ -%>
+                <%%= f.input :<%= attribute.name %>, as: :datepicker %>
+                  <%- elsif attribute.name =~ /text/ -%>
+                <%%= f.input :<%= attribute.name %>, markdown: true %>
+                  <%- else -%>
+                <%%= f.input :<%= attribute.name %> %>
+                  <%- end -%>
+                <%- end -%>
+                <%- end -%>
+                <%%= f.button :submit, class: 'btn-success' %>
+              </div>
+              <div class="col-sm-6">
+<% unless options.skip_statusable? -%>
+                <%%= render 'admin/form_inputs/status', f: f, record: @<%= singular_table_name %> %>
+<% end -%>
+              </div>
+            </div>
+          </div>
+        </div>
+      </div>
+<% unless options.skip_blockable? -%>
+      <%# Uncomment this if the record is blockable. Optionally pass the block_layout or block_kinds to the partial. %>
+      <%%#= render 'admin/block_record/block_layout', f: f, block_layout: @block_layout, block_kinds: @block_kinds %>
+      <%%#= f.button :submit, class: 'btn-success' %>
+<% end %>
+    </div>
+  </div>
+<%% end %>

data/lib/generators/forest/scaffold/templates/views/admin/edit.html.erb

@@ -0,0 +1,3 @@
+<%%= render 'admin/headers/edit', record: @<%= singular_name %> %>
+
+<%%= render 'form', record: @<%= singular_name %> %>

data/lib/generators/forest/scaffold/templates/views/admin/index.html.erb

@@ -0,0 +1,58 @@
+<%%= render 'admin/headers/index', records: @<%= plural_name %>, model_name: '<%= name %>' %>
+
+<div class="table-responsive">
+  <table class="forest-table table table-striped">
+    <thead>
+      <tr>
+        <%% if <%= name %>.statusable? %>
+          <th></th>
+        <%% end %>
+        <th><%%= table_sorter title: 'ID', path: :admin_<%= plural_name %>_path, scope: :by_id, default_order: :desc %></th>
+<%- unless options.skip_sluggable? -%>
+        <th><%%= table_sorter title: 'Slug', path: :admin_<%= plural_name %>_path, scope: :by_slug, default_order: :asc %></th>
+<% end -%>
+<%- for attribute in attributes -%>
+        <th><%= attribute.human_name.titleize %></th>
+<% end -%>
+        <th><%%= table_sorter title: 'Created&nbsp;at'.html_safe, path: :admin_<%= plural_name %>_path, scope: :by_created_at, default_order: :desc %></th>
+        <th><%%= table_sorter title: 'Updated&nbsp;at'.html_safe, path: :admin_<%= plural_name %>_path, scope: :by_updated_at, default_order: :desc %></th>
+        <th colspan="3"></th>
+      </tr>
+    </thead>
+
+    <tbody>
+      <%% @<%= plural_name %>.each do |<%= singular_name %>| %>
+        <tr>
+          <%% if <%= name %>.statusable? %>
+            <td><%%= status_indicator <%= singular_name %> %></td>
+          <%% end %>
+          <td><%%= <%= singular_name %>.id %></td>
+<%- unless options.skip_sluggable? -%>
+          <td><%%= <%= singular_name %>.slug %></td>
+<% end -%>
+<%- for attribute in attributes -%>
+          <td><%%= <%= singular_name %>.<%= attribute.column_name %> %></td>
+<% end -%>
+          <td><%%= forest_date <%= singular_name %>.created_at %></td>
+          <td><%%= forest_date <%= singular_name %>.updated_at %></td>
+          <td width="1"><%%= link_to 'Edit', edit_admin_<%= singular_name %>_path(<%= singular_name %>), class: 'btn btn-xs btn-primary', role: 'button' %></td>
+          <td width="1">
+            <%% if try('<%= singular_name %>_path', <%= singular_name %>) %>
+              <%% if <%= singular_name %>.respond_to?(:to_friendly_param) %>
+                <%% param = <%= singular_name %>.to_friendly_param %>
+              <%% else %>
+                <%% param = <%= singular_name %> %>
+              <%% end %>
+              <%%= link_to 'Show', <%= singular_name %>_path(param), class: 'btn btn-xs btn-info', role: 'button', data: { turbolinks: false } %>
+            <%% else %>
+              <%%= link_to 'Show', admin_<%= singular_name %>_path(<%= singular_name %>), class: 'btn btn-xs btn-info', role: 'button', data: { turbolinks: false } %>
+            <%% end %>
+          </td>
+          <td width="1"><%%= link_to 'Destroy', [:admin, <%= singular_name %>], method: :delete, class: 'btn btn-xs btn-danger', role: 'button', data: { confirm: 'Are you sure you want to destroy this <%= singular_name.titleize %>?' } %></td>
+        </tr>
+      <%% end %>
+    </tbody>
+  </table>
+</div>
+
+<%%= paginate @<%= plural_name %> %>

data/lib/generators/forest/scaffold/templates/views/admin/index.json.jbuilder

@@ -0,0 +1,2 @@
+json.partial! 'admin/api/index/header', records: @<%= plural_name %>
+json.partial! 'admin/api/index/records', records: @<%= plural_name %>

data/lib/generators/forest/scaffold/templates/views/admin/new.html.erb

@@ -0,0 +1,3 @@
+<%%= render 'admin/headers/new', record: @<%= singular_name %> %>
+
+<%%= render 'form', <%= singular_name %>: @<%= singular_name %> %>

data/lib/generators/forest/scaffold/templates/views/admin/show.html.erb

@@ -0,0 +1,12 @@
+<p>Find me in app/views/forest/<%= plural_name %>/show.html.erb</p>
+
+<%%# content_for :page_description, @<%= singular_name %>.description if @<%= singular_name %>.try(:description).present? %>
+
+<%- for attribute in attributes -%>
+<p>
+  <b><%= attribute.name.titleize %></b>
+  <%%= @<%= singular_name %>.<%= attribute.name %> %>
+</p>
+<%- end -%>
+
+<%%= render_blocks @<%= singular_name %> %>

data/lib/generators/forest/scaffold/templates/views/public/index.html.erb

@@ -0,0 +1 @@
+<p>Find me in app/views/forest/<%= plural_name %>/index.html.erb</p>

data/lib/generators/forest/scaffold/templates/views/public/show.html.erb

@@ -0,0 +1,17 @@
+<p>Find me in app/views/forest/<%= plural_name %>/show.html.erb</p>
+
+<%%# content_for :page_description, @<%= singular_name %>.description if @<%= singular_name %>.try(:description).present? %>
+
+<%- for attribute in attributes -%>
+<p>
+  <b><%= attribute.name.titleize %></b>
+  <%%= @<%= singular_name %>.<%= attribute.name %> %>
+</p>
+<%- end -%>
+
+<p>
+  <b>Status:</b>
+  <%%= @<%= singular_name %>.try(:status) %>
+</p>
+
+<%%= render_blocks @<%= singular_name %> %>

data/lib/tasks/forest_db_tasks.rake

@@ -0,0 +1,176 @@
+require 'open-uri'
+
+namespace :forest do
+  desc "Download and replace this database with a current capture from heroku."
+  task 'db:capture' => :environment do
+    db = Rails.application.config.database_configuration[Rails.env]
+    user = db['username']
+    database = db['database']
+    puts "[Forest] This command captures a snapshot of the Heroku database, downloads it, drops the local database and recreates it from the Heroku snapshot."
+    puts "[Forest] Please run:"
+    puts "heroku pg:backups:capture && heroku pg:backups:download && bin/rails db:drop DISABLE_DATABASE_ENVIRONMENT_CHECK=1 && bin/rails db:create && pg_restore --verbose --clean --no-acl --no-owner -h localhost #{if user then "-U #{user}" end} -d #{database} latest.dump; rm latest.dump"
+  end
+
+  # https://gist.github.com/hopsoft/56ba6f55fe48ad7f8b90
+  desc "Dumps the database to db/APP_NAME.dump"
+  task 'db:dump' => :environment do
+    with_config do |app, db, user|
+      puts "[Forest] This task dumps the database to #{Rails.root}/db/#{app}.dump"
+      puts "[Forest] Please run:"
+      puts "pg_dump --host localhost #{if user then "-U #{user}" end} --verbose --clean --no-owner --no-acl --format=c #{db} > #{Rails.root}/db/#{app}.dump"
+    end
+  end
+
+  # https://gist.github.com/hopsoft/56ba6f55fe48ad7f8b90
+  desc "Restores the database dump at db/APP_NAME.dump"
+  task 'db:restore' => :environment do
+    with_config do |app, db, user|
+      puts "[Forest] This task restores the database from #{Rails.root}/db/#{app}.dump"
+      puts "[Forest] Please run:"
+      puts 'bin/rails db:drop DISABLE_DATABASE_ENVIRONMENT_CHECK=1 && bin/rails db:create'
+      puts "pg_restore --verbose --host localhost #{if user then "-U #{user}" end} --clean --no-owner --no-acl --dbname #{db} #{Rails.root}/db/#{app}.dump"
+    end
+  end
+
+  desc "Import the database to Heroku."
+  task 'db:import_to_heroku' => :environment do
+    with_config do |app, db, user|
+      check_for_s3_env_variables!
+
+      timestamp = Time.now.to_i
+
+      object_key = "forest/forest_db_dumps/#{app}_#{timestamp}.dump"
+      if s3_bucket.object(object_key).upload_file("#{Rails.root}/db/#{app}.dump")
+        s3.client.put_object_acl({
+          acl: 'public-read',
+          bucket: s3_bucket.name,
+          key: object_key
+        })
+
+        puts "[Forest] Careful! You just uploaded a publicly accessible db dump to the #{s3_bucket.name} bucket."
+        puts "[Forest] To import that db dump to Heroku, please run:"
+
+        if aws_region == 'us-east-1'
+          puts "heroku pg:backups:restore 'https://s3.amazonaws.com/#{s3_bucket_name}/#{object_key}' DATABASE_URL"
+        else
+          puts "heroku pg:backups:restore 'https://#{s3_bucket_name}.s3.amazonaws.com/#{object_key}' DATABASE_URL"
+        end
+
+        puts "\n"
+        puts "[Forest] ** After importing to Heroku, run this command to delete the public db dump from Amazon S3. Don't leave the db dump publicly accessible! **"
+        puts "bin/rails forest:db:destroy_s3_dump object_key=#{object_key}"
+      else
+        puts "[Forest] Error: unable to upload object to S3."
+      end
+    end
+  end
+
+  desc "Destroy a database dump from Amazon S3."
+  task 'db:destroy_s3_dump' => :environment do
+    check_for_s3_env_variables!
+
+    if s3_bucket.object(ENV['object_key']).delete
+      puts "[Forest] #{ENV['object_key']} destroyed"
+      remaining_objects = s3_bucket.objects(prefix: 'forest/forest_db_dumps/').collect(&:key).reject { |k| k == 'forest/forest_db_dumps/' }
+      if remaining_objects.present?
+        puts "[Forest] Warning: There are still files in the forest/forest_db_dumps directory (this directory should be empty!). Please delete these publicly accessible files."
+        puts "[Forest] Run the following commands to delete the objects:"
+        remaining_objects.each do |object_key|
+          puts "bin/rails forest:db:destroy_s3_dump object_key=#{object_key}"
+        end
+      end
+    else
+      puts "[Forest] Error: unable to destroy #{ENV['object_key']}. Log in to Amazon S3 and destroy the object manually."
+    end
+  end
+
+  desc "Upload the latest Heroku database to S3 for archival purposes. This assumes you have already enabled daily pg backups on Heroku."
+  task 'db:archive_to_s3' => :environment do
+    # TODO: This won't work as is because the heroku CLI isn't available by default on
+    # heroku. It may be better to use https://github.com/kbaum/heroku-database-backups.
+    # TODO: add configuration that allows setting a maximum number of database backups.
+    # The price class could also be adjusted, for example setting S3 One Zone-IA Storage
+    # for very old files to save $$.
+
+    check_for_s3_env_variables!
+
+    url = `heroku pg:backups public-url`
+    url.sub!(/\n$/, '')
+
+    db_uri = URI.parse(url)
+
+    file_name = db_uri.path.split('/').reject(&:blank?).join('_')
+    object_key = "forest/forest_db_archives/#{database_name}/#{file_name}.gz"
+    object = s3_bucket.object(object_key)
+
+    abort("[Forest] Database already exists on S3, aborting #{s3_bucket_name} #{object_key}") if object.exists?
+
+    file = Tempfile.new(["#{file_name}", '.sql'])
+
+    puts "[Forest] Downloading database from Heroku"
+    open(url) do |f|
+      IO.copy_stream(f, file)
+    end
+
+    puts "[Forest] Compressing database file"
+
+    zipped_file = Tempfile.new(["#{file_name}", '.gz'])
+
+    Zlib::GzipWriter.open(zipped_file) do |gz|
+      gz.mtime = File.mtime(file)
+      gz.orig_name = "#{file_name}.sql"
+      File.open(file) do |file|
+        while chunk = file.read(16*1024) do
+          gz.write(chunk)
+        end
+      end
+    end
+
+    puts "[Forest] Uploading database file to S3"
+    if object.upload_file(zipped_file)
+      s3.client.put_object_acl({
+        acl: 'private',
+        bucket: s3_bucket.name,
+        key: object_key
+      })
+    else
+      puts "[Forest] Error: unable to upload object to S3."
+    end
+
+    file.delete
+    zipped_file.delete
+  end
+
+  private
+
+    def with_config
+      yield Rails.application.class.parent_name.underscore,
+        database_name,
+        ActiveRecord::Base.connection_config[:username]
+    end
+
+    def s3
+      @s3 ||= Aws::S3::Resource.new(region: aws_region)
+    end
+
+    def s3_bucket
+      @s3_bucket ||= s3.bucket(s3_bucket_name)
+    end
+
+    def check_for_s3_env_variables!
+      abort('[Forest] Error: Please specify an AWS_REGION environment variable') if aws_region.blank?
+      abort('[Forest] Error: Please specify an S3_BUCKET_NAME environment variable') if s3_bucket_name.blank?
+    end
+
+    def aws_region
+      @aws_region ||= ENV['AWS_REGION'].presence || Rails.application.credentials&.dig(:aws, :aws_region)
+    end
+
+    def s3_bucket_name
+      @s3_bucket_name ||= ENV['S3_BUCKET_NAME'].presence || Rails.application.credentials&.dig(:aws, :s3_bucket_name)
+    end
+
+    def database_name
+      @database_name ||= ActiveRecord::Base.connection_config[:database]
+    end
+end