occams 1.0.0

data/app/views/occams/admin/cms/sites/_form.html.haml

@@ -0,0 +1,15 @@
+= occams_admin_partial "occams/admin/cms/partials/site_form_before", form: form
+
+= form.text_field :label, data: {slugify: @site.new_record?}
+= form.text_field :identifier, data: {slug: true}
+= form.text_field :hostname
+= form.text_field :path
+
+- locales = Occams.config.locales.to_a.collect{|l| ["#{l[1]} (#{l[0]})", l[0]]}
+= form.select :locale, locales, bootstrap: {custom_control: true}
+
+= occams_admin_partial "occams/admin/cms/partials/site_form_after", form: form
+
+= form.form_actions do
+  = submit_tag t(@site.new_record? ? ".create" : ".update"), class: "btn btn-primary"
+  = link_to t(".cancel"), occams_admin_cms_sites_path, class: "btn btn-link"

data/app/views/occams/admin/cms/sites/edit.html.haml

@@ -0,0 +1,5 @@
+.page-header
+  %h2= t('.title')
+
+= occams_form_with model: @site, scope: :site, url: {action: :update} do |form|
+  = render form

data/app/views/occams/admin/cms/sites/index.html.haml

@@ -0,0 +1,28 @@
+.page-header
+  = link_to t('.new_link'), new_occams_admin_cms_site_path, class: "btn btn-secondary float-right"
+  %h2= t('.title')
+
+= occams_admin_partial "occams/admin/cms/partials/sites_before"
+
+%ul.list
+  - @sites.each do |site|
+    %li
+      .row
+        .col-md-8.item
+          .item-content
+            .item-title
+              = link_to site.label, occams_admin_cms_site_pages_path(site)
+            .item-meta
+              .identifier
+                = site.identifier
+                = "(#{site.locale})"
+              .host
+              = link_to site.url, site.url, target: '_blank'
+
+        .col-md-4.d-flex.align-items-center.justify-content-md-end
+          .btn-group.btn-group-sm
+            = link_to t('.select'),  occams_admin_cms_site_pages_path(site), class: 'btn btn-outline-secondary'
+            = link_to t('.edit'), edit_occams_admin_cms_site_path(site), class: 'btn btn-outline-secondary'
+            = link_to t('.delete'), occams_admin_cms_site_path(site), method: :delete, data: {confirm: t('.are_you_sure')}, class: 'btn btn-danger'
+
+= occams_admin_partial "occams/admin/cms/partials/sites_after"

data/app/views/occams/admin/cms/sites/new.html.haml

@@ -0,0 +1,5 @@
+.page-header
+  %h2= t(".title")
+
+= occams_form_with model: @site, scope: :site, url: {action: :create} do |form|
+  = render form

data/app/views/occams/admin/cms/snippets/_form.html.haml

@@ -0,0 +1,18 @@
+= occams_admin_partial "occams/admin/cms/partials/snippet_form_before", form: form
+
+= form.text_field :label, data: {slugify: @snippet.new_record?}
+= form.text_field :identifier, data: {slug: true}
+= form.check_box :markdown
+
+- if @snippet.markdown
+  = form.text_area :content, data: {'cms-cm-mode' => 'text/x-markdown'}
+- else
+  = form.text_area :content, data: {'cms-cm-mode' => 'text/html'}
+
+= render 'occams/admin/cms/categories/form', form: form
+
+= occams_admin_partial "occams/admin/cms/partials/snippet_form_after", form: form
+
+= form.form_actions do
+  = submit_tag t(@snippet.new_record? ? ".create" : ".update"), class: "btn btn-primary"
+  = link_to t(".cancel"), occams_admin_cms_site_snippets_path, class: "btn btn-link"

data/app/views/occams/admin/cms/snippets/edit.html.haml

@@ -0,0 +1,9 @@
+- content_for :right_column do
+  - link = occams_admin_cms_site_snippet_revisions_path(@site, @snippet)
+  = render "occams/admin/cms/revisions/sidebar", record: @snippet, link: link
+
+.page-header
+  %h2= t('.title')
+
+= occams_form_with model: @snippet, scope: :snippet, url: {action: :update} do |form|
+  = render form

data/app/views/occams/admin/cms/snippets/index.html.haml

@@ -0,0 +1,33 @@
+- content_for :right_column do
+  = render "occams/admin/cms/categories/index", type: "Occams::Cms::Snippet"
+
+.page-header
+  = link_to t('.new_link'), new_occams_admin_cms_site_snippet_path(@site), class: "btn btn-secondary float-right"
+  %h2= t('.title')
+
+= occams_admin_partial "occams/admin/cms/partials/snippets_before"
+
+%ul.list.sortable
+  - @snippets.each do |snippet|
+    %li{data: {id: snippet.id}}
+      .row
+        .col-md-6.item
+          .item-controls.d-none.d-lg-block
+            - if !params[:categories].present? && @site.snippets.count > 1
+              .dragger
+                %i.fas.fa-bars
+          .item-content
+            .item-title
+              = link_to snippet.label, edit_occams_admin_cms_site_snippet_path(@site, snippet)
+            .item-meta
+              = snippet.identifier
+
+        .col-md-2.item-categories.d-flex.align-items-center
+          = render "occams/admin/cms/categories/categories", object: snippet
+
+        .col-md-4.d-flex.align-items-center.justify-content-md-end
+          .btn-group.btn-group-sm
+            = link_to t('.edit'), edit_occams_admin_cms_site_snippet_path(@site, snippet), class: 'btn btn-outline-secondary'
+            = link_to t('.delete'), occams_admin_cms_site_snippet_path(@site, snippet), method: :delete, data: {confirm: t('.are_you_sure')}, class: 'btn btn-danger'
+
+= occams_admin_partial "occams/admin/cms/partials/snippets_after"

data/app/views/occams/admin/cms/snippets/new.html.haml

@@ -0,0 +1,5 @@
+.page-header
+  %h2= t(".title")
+
+= occams_form_with model: @snippet, scope: :snippet, url: {action: :create} do |form|
+  = render form

data/app/views/occams/admin/cms/translations/_form.html.haml

@@ -0,0 +1,20 @@
+= occams_admin_partial "occams/admin/cms/partials/translation_form_before", form: form
+
+= form.select :locale, translation_select_options
+
+= form.text_field :label
+
+- if (options = ::Occams::Cms::Layout.options_for_select(@site)).present?
+  = form.select :layout_id, options, {}, {data: {url: form_fragments_occams_admin_cms_site_page_translation_path(@site, @page, @translation.id.to_i)}, id: "fragments-toggle"}
+
+#form-fragments-container
+  = render "occams/admin/cms/fragments/form_fragments", record: @translation, scope: :translation
+
+= form.check_box :is_published
+
+= occams_admin_partial "occams/admin/cms/partials/translation_form_after", form: form
+
+= form.form_actions do
+  = submit_tag t(".preview"), name: "preview", formtarget: "occams-cms-preview", id: nil, class: "btn btn-secondary", data: {disable_with: false}
+  = submit_tag t(@translation.new_record? ? ".create" : ".update"), class: "btn btn-primary", data: {disable_with: false}
+  = link_to t(".cancel"), edit_occams_admin_cms_site_page_path(@site, @page), class: "btn btn-link"

data/app/views/occams/admin/cms/translations/_sidebar.html.haml

@@ -0,0 +1,19 @@
+.box.translations
+
+  = active_link_to edit_occams_admin_cms_site_page_path(@site, @page), class: "btn btn-block btn-sm btn-light text-left text-truncate mb-1" do
+    = content_tag(:span, @site.locale, class: "badge badge-light text-uppercase")
+    = @page.label
+
+  - @page.translations.each do |translation|
+    .btn-group.btn-group-sm.d-flex.mb-1
+      - url = edit_occams_admin_cms_site_page_translation_path(@site, @page, translation)
+      - published_css_class = translation.is_published? ? "published" : "draft"
+      = active_link_to url, class: "#{published_css_class} translation btn text-left text-truncate btn-light w-100" do
+        = content_tag(:span, translation.locale, class: "badge badge-light text-uppercase")
+        = translation.label
+
+      - url = occams_admin_cms_site_page_translation_path(@site, @page, translation)
+      = link_to url, method: :delete, data: {confirm: t(".confirm")}, class: "btn btn-danger" do
+        %i.fas.fa-fw.fa-times
+
+  = link_to t(".new"), new_occams_admin_cms_site_page_translation_path(@site, @page), class: "btn btn-sm btn-secondary d-block mb-1"

data/app/views/occams/admin/cms/translations/edit.html.haml

@@ -0,0 +1,10 @@
+- content_for :right_column do
+  - link = occams_admin_cms_site_page_translation_revisions_path(@site, @page, @translation)
+  = render "occams/admin/cms/revisions/sidebar", record: @translation, link: link
+  = render "occams/admin/cms/translations/sidebar"
+
+.page-header
+  %h2= t('.title')
+
+= occams_form_with model: @translation, scope: :translation, url: {action: :update}, html: {multipart: true} do |form|
+  = render form

data/app/views/occams/admin/cms/translations/new.html.haml

@@ -0,0 +1,5 @@
+.page-header
+  %h2= t(".title")
+
+= occams_form_with model: @translation, scope: :translation, url: {action: :create}, html: {multipart: true} do |form|
+  = render form

data/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+load Gem.bin_path('bundler', 'bundle')

data/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/bin/setup

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/bin/update

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
+
+  puts "\n== Updating database =="
+  system! 'bin/rails db:migrate'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/bin/yarn

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+VENDOR_PATH = File.expand_path('..', __dir__)
+Dir.chdir(VENDOR_PATH) do
+  begin
+    exec "yarnpkg #{ARGV.join(' ')}"
+  rescue Errno::ENOENT
+    $stderr.puts "Yarn executable was not detected in the system."
+    $stderr.puts "Download Yarn at https://yarnpkg.com/en/docs/install"
+    exit 1
+  end
+end

data/config/application.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "boot"
+
+require "rails/all"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+module Occams
+  class Application < Rails::Application
+
+    require_relative "../lib/occams"
+
+    config.load_defaults 5.2
+
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Ensuring that all ActiveStorage routes are loaded before out globbing route.
+    config.railties_order = [ActiveStorage::Engine, :main_app, :all]
+
+    # Making sure we don't load our dev routes as part of the engine
+    config.paths["config/routes.rb"] << "config/cms_routes.rb"
+
+    config.i18n.enforce_available_locales = true
+
+  end
+end

data/config/boot.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+File.exist?(ENV["BUNDLE_GEMFILE"])

data/config/cms_routes.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# We can't have this in config/routes.rb as they will get pulled in into parent
+# application automatically. We want user to manually place them.
+Occams::Application.routes.draw do
+  occams_route :cms_admin
+  occams_route :cms
+end

data/config/database.yml

@@ -0,0 +1,11 @@
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 10000
+
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 10000

data/config/environment.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Load the rails application
+require File.expand_path("application", __dir__)
+
+# Initialize the rails application
+Occams::Application.initialize!

data/config/environments/development.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+defined?(Occams::Application) && Occams::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Enable/disable caching. By default caching is disabled.
+  # Run rails dev:cache to toggle caching.
+  if Rails.root.join("tmp/caching-dev.txt").exist?
+    config.action_controller.perform_caching = true
+
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      "Cache-Control" => "public, max-age=#{2.days.to_i}"
+    }
+  else
+    config.action_controller.perform_caching = false
+
+    config.cache_store = :null_store
+  end
+
+  # Store uploaded files on the local file system (see config/storage.yml for options)
+  config.active_storage.service = :local
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  config.action_mailer.perform_caching = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Suppress logger output for asset requests.
+  config.assets.quiet = true
+
+  # Use an evented file watcher to asynchronously detect changes in source code,
+  # routes, locales, etc. This feature depends on the listen gem.
+  config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+
+  config.active_job.queue_adapter = :inline
+end

data/config/environments/test.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+defined?(Occams::Application) && Occams::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure public file server for tests with Cache-Control for performance.
+  config.public_file_server.enabled = true
+  config.public_file_server.headers = {
+    "Cache-Control" => "public, max-age=#{1.hour.to_i}"
+  }
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Store uploaded files on the local file system in a temporary directory
+  config.active_storage.service = :test
+  config.action_mailer.perform_caching = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+
+  config.active_job.queue_adapter = :inline
+
+  # TODO: This is temporary fix so TravisCI runs until Rails 5.2.3 is out.
+  # See: https://github.com/rails/rails/pull/35607
+  config.secret_key_base = SecureRandom.hex(64)
+end

data/config/initializers/occams.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+Occams.configure do |config|
+  # Title of the admin area
+  #   config.cms_title = 'Occams CMS Engine'
+
+  # Controller that is inherited from CmsAdmin::BaseController
+  #   config.admin_base_controller = 'ApplicationController'
+
+  # Controller that Occams::Cms::BaseController will inherit from
+  #   config.public_base_controller = 'ApplicationController'
+
+  # Module responsible for authentication. You can replace it with your own.
+  # It simply needs to have #authenticate method. See http_auth.rb for reference.
+  #   config.admin_auth = 'OccamsAdminAuthentication'
+
+  # Module responsible for authorization on admin side. It should have #authorize
+  # method that returns true or false based on params and loaded instance
+  # variables available for a given controller.
+  #   config.admin_authorization = 'OccamsAdminAuthorization'
+
+  # Module responsible for public authentication. Similar to the above. You also
+  # will have access to @cms_site, @cms_layout, @cms_page so you can use them in
+  # your logic. Default module doesn't do anything.
+  #   config.public_auth = 'OccamsPublicAuthentication'
+
+  # Module responsible for public authorization. It should have #authorize
+  # method that returns true or false based on params and loaded instance
+  # variables available for a given controller.
+  #   config.public_authorization = 'OccamsPublicAuthorization'
+
+  # When arriving at /cms-admin you may chose to redirect to arbirtary path,
+  # for example '/cms-admin/users'
+  #   config.admin_route_redirect = ''
+
+  # Sofa allows you to setup entire site from files. Database is updated with each
+  # request (if necessary). Please note that database entries are destroyed if there's
+  # no corresponding file. Seeds are disabled by default.
+  #   config.enable_seeds = false
+
+  # Path where seeds can be located.
+  #   config.seeds_path = File.expand_path('db/cms_seeds', Rails.root)
+
+  # Content for Layouts, Pages and Snippets has a revision history. You can revert
+  # a previous version using this system. You can control how many revisions per
+  # object you want to keep. Set it to 0 if you wish to turn this feature off.
+  #   config.revisions_limit = 25
+
+  # Locale definitions. If you want to define your own locale merge
+  # {:locale => 'Locale Title'} with this.
+  #   config.locales = {:en => 'English', :es => 'Español'}
+
+  # Admin interface will respect the locale of the site being managed. However you can
+  # force it to English by setting this to `:en`
+  #   config.admin_locale = nil
+
+  # A class that is included as a sweeper to admin base controller if it's set
+  #   config.admin_cache_sweeper = nil
+
+  # By default you cannot have irb code inside your layouts/pages/snippets.
+  # Generally this is to prevent putting something like this:
+  # <% User.delete_all %> but if you really want to allow it...
+  #   config.allow_erb = false
+
+  # Whitelist of all helper methods that can be used via {{cms:helper}} tag. By default
+  # all helpers are allowed except `eval`, `send`, `call` and few others. Empty array
+  # will prevent rendering of all helpers.
+  #   config.allowed_helpers = nil
+
+  # Whitelist of partials paths that can be used via {{cms:partial}} tag. All partials
+  # are accessible by default. Empty array will prevent rendering of all partials.
+  #   config.allowed_partials = nil
+
+  # Site aliases, if you want to have aliases for your site. Good for harmonizing
+  # production env with dev/testing envs.
+  # e.g. config.hostname_aliases = {'host.com' => 'host.inv', 'host_a.com' => ['host.lvh.me', 'host.dev']}
+  # Default is nil (not used)
+  #   config.hostname_aliases = nil
+
+  # Reveal partials that can be overwritten in the admin area.
+  # Default is false.
+  #   config.reveal_cms_partials = false
+  #
+  # Customize the returned content json data
+  # include fragments in content json
+  #   config.content_json_options = {
+  #     include: [:fragments]
+  #   }
+end
+
+# Default credentials for Occams::AccessControl::AdminAuthentication
+# YOU REALLY WANT TO CHANGE THIS BEFORE PUTTING YOUR SITE LIVE
+Occams::AccessControl::AdminAuthentication.username = "user"
+Occams::AccessControl::AdminAuthentication.password = "pass"
+
+# Uncomment this module and `config.admin_auth` above to use custom admin authentication
+# module OccamsAdminAuthentication
+#   def authenticate
+#     return true
+#   end
+# end
+
+# Uncomment this module and `config.admin_authorization` above to use custom admin authorization
+# module OccamsAdminAuthorization
+#   def authorize
+#     return true
+#   end
+# end
+
+# Uncomment this module and `config.public_auth` above to use custom public authentication
+# module OccamsPublicAuthentication
+#   def authenticate
+#     return true
+#   end
+# end
+
+# Uncomment this module and `config.public_authorization` above to use custom public authorization
+# module OccamsPublicAuthorization
+#   def authorize
+#     return true
+#   end
+# end