occams 1.0.0

data/db/migrate/00_create_active_storage_tables.rb

@@ -0,0 +1,34 @@
+class CreateActiveStorageTables < ActiveRecord::Migration[6.0]
+  def change
+    create_table :active_storage_blobs do |t|
+      t.string   :key,        null: false
+      t.string   :filename,   null: false
+      t.string   :content_type
+      t.string   :service_name, null: false
+      t.text     :metadata
+      t.bigint   :byte_size,  null: false
+      t.string   :checksum,   null: false
+      t.datetime :created_at, null: false
+
+      t.index [ :key ], unique: true
+    end
+
+    create_table :active_storage_attachments do |t|
+      t.string     :name,     null: false
+      t.references :record,   null: false, polymorphic: true, index: false
+      t.references :blob,     null: false
+
+      t.datetime :created_at, null: false
+
+      t.index [ :record_type, :record_id, :name, :blob_id ], name: "index_active_storage_attachments_uniqueness", unique: true
+    end
+
+    create_table :active_storage_variant_records do |t|
+      t.belongs_to :blob, null: false, index: false
+      t.string :variation_digest, null: false
+
+      t.index %i[ blob_id variation_digest ], name: "index_active_storage_variant_records_uniqueness", unique: true
+      t.foreign_key :active_storage_blobs, column: :blob_id
+    end
+  end
+end

data/db/migrate/01_create_cms.rb

@@ -0,0 +1,143 @@
+class CreateCms < ActiveRecord::Migration[5.2]
+
+  LIMIT = 16777215
+
+  def change
+
+    # -- Sites -----------------------------------------------------------------
+    create_table :occams_cms_sites, force: true do |t|
+      t.string :label,        null: false
+      t.string :identifier,   null: false
+      t.string :hostname,     null: false
+      t.string :path
+      t.string :locale,       null: false, default: "en"
+      t.timestamps
+
+      t.index :hostname
+    end
+
+    # -- Layouts ---------------------------------------------------------------
+    create_table :occams_cms_layouts, force: true do |t|
+      t.integer :site_id,     null: false
+      t.integer :parent_id
+      t.string  :app_layout
+      t.string  :label,       null: false
+      t.string  :identifier,  null: false
+      t.text    :content,     limit: LIMIT
+      t.text    :css,         limit: LIMIT
+      t.text    :js,          limit: LIMIT
+      t.integer :position,    null: false, default: 0
+      t.timestamps
+
+      t.index [:parent_id, :position]
+      t.index [:site_id, :identifier], unique: true
+    end
+
+    # -- Pages -----------------------------------------------------------------
+    create_table :occams_cms_pages, force: true do |t|
+      t.integer :site_id,         null: false
+      t.integer :layout_id
+      t.integer :parent_id
+      t.integer :target_page_id
+      t.string  :label,           null: false
+      t.string  :slug
+      t.string  :full_path,       null: false
+      t.text    :content_cache,   limit: LIMIT
+      t.integer :position,        null: false, default: 0
+      t.integer :children_count,  null: false, default: 0
+      t.boolean :is_published,    null: false, default: true
+      t.timestamps
+
+      t.index [:site_id, :full_path]
+      t.index [:parent_id, :position]
+      t.index [:is_published]
+    end
+
+    # -- Translations ----------------------------------------------------------
+    create_table :occams_cms_translations, force: true do |t|
+      t.string  :locale,    null: false
+      t.integer :page_id,   null: false
+      t.integer :layout_id
+      t.string  :label,           null: false
+      t.text    :content_cache,   limit: LIMIT
+      t.boolean :is_published,    null: false, default: true
+      t.timestamps
+
+      t.index [:page_id]
+      t.index [:locale]
+      t.index [:is_published]
+    end
+
+    # -- Fragments -------------------------------------------------------------
+    create_table :occams_cms_fragments, force: true do |t|
+      t.references  :record,      polymorphic: true
+      t.string      :identifier,  null: false
+      t.string      :tag,         null: false, default: "text"
+      t.text        :content,     limit: LIMIT
+      t.boolean     :boolean,     null: false, default: false
+      t.datetime    :datetime
+      t.timestamps
+
+      t.index [:identifier]
+      t.index [:datetime]
+      t.index [:boolean]
+    end
+
+    # -- Snippets --------------------------------------------------------------
+    create_table :occams_cms_snippets, force: true do |t|
+      t.integer :site_id,     null: false
+      t.string  :label,       null: false
+      t.string  :identifier,  null: false
+      t.boolean :markdown
+      t.text    :content,     limit: LIMIT
+      t.integer :position,    null: false, default: 0
+      t.timestamps
+
+      t.index [:site_id, :identifier], unique: true
+      t.index [:site_id, :position]
+    end
+
+    # -- Files -----------------------------------------------------------------
+    create_table :occams_cms_files, force: true do |t|
+      t.integer :site_id,     null: false
+      t.string  :label,       null: false, default: ""
+      t.text    :description, limit: 2048
+      t.integer :position,    null: false, default: 0
+      t.timestamps
+
+      t.index [:site_id, :position]
+    end
+
+    # -- Revisions -------------------------------------------------------------
+    create_table :occams_cms_revisions, force: true do |t|
+      t.string    :record_type, null: false
+      t.integer   :record_id,   null: false
+      t.text      :data,        limit: LIMIT
+      t.datetime  :created_at
+
+      t.index [:record_type, :record_id, :created_at],
+      name: "index_cms_revisions_on_rtype_and_rid_and_created_at"
+    end
+
+    # -- Categories ------------------------------------------------------------
+    create_table :occams_cms_categories, force: true do |t|
+      t.integer :site_id,          null: false
+      t.string  :label,            null: false
+      t.string  :categorized_type, null: false
+
+      t.index [:site_id, :categorized_type, :label],
+      unique: true,
+      name:   "index_cms_categories_on_site_id_and_cat_type_and_label"
+    end
+
+    create_table :occams_cms_categorizations, force: true do |t|
+      t.integer :category_id,       null: false
+      t.string  :categorized_type,  null: false
+      t.integer :categorized_id,    null: false
+
+      t.index [:category_id, :categorized_type, :categorized_id],
+      unique: true,
+      name:   "index_cms_categorizations_on_cat_id_and_catd_type_and_catd_id"
+    end
+  end
+end

data/lib/generators/occams/cms/README

@@ -0,0 +1,17 @@
+             ____      __  __ _ ____
+  ___   ___ / ___|__ _|  \/  ( ) ___|
+ / _ \ / __| |   / _` | |\/| |/\___ \
+| (_) | (__| |__| (_| | |  | |  ___) |
+ \___/ \___|\____\__,_|_|  |_| |____/
+ 
+Prefer Simplicity. 
+
+You are almost done.  Don't forget to:
+
+  [Optional] - If you want to store files in your CMS with ActiveStorage: `rails active_storage:install`
+  [Mandatory] - Create the tables in your database: `rails db:migrate`
+
+Then you can go to http://your-rails-app/admin to start adding content.
+
+Default username and password are: user/pass
+Change these defaults in config/initializers/occams.rb

data/lib/generators/occams/cms/assets_generator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Occams
+  module Generators
+    module Cms
+      class AssetsGenerator < Rails::Generators::Base
+
+        source_root File.expand_path(File.join(File.dirname(__FILE__), "../../../../app/assets"))
+
+        def generate_assets
+          directory "javascripts/occams/admin/cms", "app/assets/javascripts/occams/admin/cms"
+          directory "stylesheets/occams/admin/cms", "app/assets/stylesheets/occams/admin/cms"
+        end
+
+      end
+    end
+  end
+end

data/lib/generators/occams/cms/cms_generator.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "rails/generators/active_record"
+
+module Occams
+  module Generators
+    class CmsGenerator < Rails::Generators::Base
+
+      include Rails::Generators::Migration
+      include Thor::Actions
+
+      source_root File.expand_path("../../../..", __dir__)
+
+      def generate_migration
+        destination   = File.expand_path("db/migrate/01_create_cms.rb", destination_root)
+        migration_dir = File.dirname(destination)
+        destination   = self.class.migration_exists?(migration_dir, "create_cms")
+
+        if destination
+          puts "\e[0m\e[31mFound existing cms_create.rb migration. Remove it if you want to regenerate.\e[0m"
+        else
+          migration_template "db/migrate/01_create_cms.rb", "db/migrate/create_cms.rb"
+        end
+      end
+
+      def generate_initializer
+        copy_file "config/initializers/occams.rb",
+          "config/initializers/occams.rb"
+      end
+
+      def generate_railties_order
+        application <<~RUBY
+          # Ensuring that ActiveStorage routes are loaded before Occams's globbing
+          # route. Without this file serving routes are inaccessible.
+          config.railties_order = [ActiveStorage::Engine, :main_app, :all]
+        RUBY
+      end
+
+      def generate_routing
+        route_string = <<~RUBY
+          occams_route :cms_admin, path: "/admin"
+          # Ensure that this route is defined last
+          occams_route :cms, path: "/"
+        RUBY
+        route route_string
+      end
+
+      def generate_cms_seeds
+        directory "db/cms_seeds", "db/cms_seeds"
+      end
+
+      def generate_assets
+        copy_file "app/assets/javascripts/occams/admin/cms/custom.js",
+          "app/assets/javascripts/occams/admin/cms/custom.js"
+        copy_file "app/assets/stylesheets/occams/admin/cms/custom.sass",
+          "app/assets/stylesheets/occams/admin/cms/custom.sass"
+      end
+
+      def show_readme
+        readme "lib/generators/occams/cms/README"
+      end
+
+      def self.next_migration_number(dirname)
+        ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+
+    end
+  end
+end

data/lib/generators/occams/cms/controllers_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Occams
+  module Generators
+    module Cms
+      class ControllersGenerator < Rails::Generators::Base
+
+        source_root File.expand_path(File.join(File.dirname(__FILE__), "../../../../app/controllers"))
+
+        def generate_controllers
+          directory "occams", "app/controllers/occams"
+        end
+
+      end
+    end
+  end
+end

data/lib/generators/occams/cms/models_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Occams
+  module Generators
+    module Cms
+      class ModelsGenerator < Rails::Generators::Base
+
+        source_root File.expand_path(File.join(File.dirname(__FILE__), "../../../../app/models"))
+
+        def generate_models
+          directory "occams", "app/models/occams"
+        end
+
+      end
+    end
+  end
+end

data/lib/generators/occams/cms/views_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Occams
+  module Generators
+    module Cms
+      class ViewsGenerator < Rails::Generators::Base
+
+        source_root File.expand_path(File.join(File.dirname(__FILE__), "../../../../app/views"))
+
+        def generate_views
+          directory "occams", "app/views/occams"
+        end
+
+      end
+    end
+  end
+end

data/lib/generators/occams/scaffold/scaffold_generator.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "rails/generators/generated_attribute"
+require "rails/generators/active_record"
+
+module Occams
+  module Generators
+    class ScaffoldGenerator < Rails::Generators::NamedBase
+
+      include Rails::Generators::Migration
+
+      no_tasks do
+        attr_accessor :model_attrs
+      end
+
+      source_root File.expand_path(File.join(File.dirname(__FILE__), "templates"))
+
+      argument :model_args, type: :array, default: [], banner: "attribute:type"
+
+      def initialize(*args, &block)
+        super
+        @model_attrs = []
+        model_args.each do |arg|
+          next unless arg.include?(":")
+          @model_attrs << Rails::Generators::GeneratedAttribute.new(*arg.split(":"))
+        end
+      end
+
+      def self.next_migration_number(dirname)
+        ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+
+      def generate_model
+        migration_template "migration.rb", "db/migrate/create_#{file_name.pluralize}.rb"
+        template "model.rb", "app/models/#{file_name}.rb"
+        template "tests/model.rb", "test/models/#{file_name}_test.rb"
+        template "tests/fixture.yml", "test/fixtures/#{file_name.pluralize}.yml"
+      end
+
+      def generate_controller
+        template "controller.rb", "app/controllers/admin/#{file_name.pluralize}_controller.rb"
+        template "tests/controller.rb", "test/controllers/admin/#{file_name.pluralize}_controller_test.rb"
+      end
+
+      def generate_views
+        template "views/index.haml", "app/views/admin/#{file_name.pluralize}/index.html.haml"
+        template "views/show.haml", "app/views/admin/#{file_name.pluralize}/show.html.haml"
+        template "views/new.haml", "app/views/admin/#{file_name.pluralize}/new.html.haml"
+        template "views/edit.haml", "app/views/admin/#{file_name.pluralize}/edit.html.haml"
+        template "views/_form.haml", "app/views/admin/#{file_name.pluralize}/_form.html.haml"
+      end
+
+      def generate_route
+        route_string = <<~TEXT
+          namespace :admin do
+            resources :#{file_name.pluralize}
+          end
+
+        TEXT
+        route route_string
+      end
+
+      def generate_navigation_link
+        partial_path = "app/views/occams/admin/cms/partials/_navigation_inner.html.haml"
+
+        unless File.exist?(File.join(destination_root, partial_path))
+          create_file partial_path
+        end
+
+        append_file partial_path do
+          <<~HAML
+            %li.nav-item
+              = active_link_to '#{class_name.pluralize}', admin_#{file_name.pluralize}_path, class: 'nav-link'
+          HAML
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/occams/scaffold/templates/controller.rb.tt

@@ -0,0 +1,62 @@
+class Admin::<%= class_name.pluralize %>Controller < Comfy::Admin::BaseController
+
+  before_action :build_<%= file_name %>,  only: [:new, :create]
+  before_action :load_<%= file_name %>,   only: [:show, :edit, :update, :destroy]
+
+  def index
+    @<%= file_name.pluralize %> = <%= class_name %>.page(params[:page])
+  end
+
+  def show
+    render
+  end
+
+  def new
+    render
+  end
+
+  def edit
+    render
+  end
+
+  def create
+    @<%= file_name %>.save!
+    flash[:success] = '<%= class_name.titleize %> created'
+    redirect_to action: :show, id: @<%= file_name %>
+  rescue ActiveRecord::RecordInvalid
+    flash.now[:danger] = 'Failed to create <%= class_name.titleize %>'
+    render action: :new
+  end
+
+  def update
+    @<%= file_name %>.update!(<%= file_name %>_params)
+    flash[:success] = '<%= class_name.titleize %> updated'
+    redirect_to action: :show, id: @<%= file_name %>
+  rescue ActiveRecord::RecordInvalid
+    flash.now[:danger] = 'Failed to update <%= class_name.titleize %>'
+    render action: :edit
+  end
+
+  def destroy
+    @<%= file_name %>.destroy
+    flash[:success] = '<%= class_name.titleize %> deleted'
+    redirect_to action: :index
+  end
+
+protected
+
+  def build_<%= file_name %>
+    @<%= file_name %> = <%= class_name %>.new(<%= file_name %>_params)
+  end
+
+  def load_<%= file_name %>
+    @<%= file_name %> = <%= class_name %>.find(params[:id])
+  rescue ActiveRecord::RecordNotFound
+    flash[:danger] = '<%= class_name.titleize %> not found'
+    redirect_to action: :index
+  end
+
+  def <%= file_name %>_params
+    params.fetch(:<%= file_name %>, {}).permit(<%= model_attrs.collect{|attr| ":#{attr.name}"}.join(', ') %>)
+  end
+end

data/lib/generators/occams/scaffold/templates/migration.rb.tt

@@ -0,0 +1,11 @@
+class Create<%= class_name.pluralize %> < ActiveRecord::Migration[5.2]
+
+  def change
+    create_table :<%= file_name.pluralize %> do |t|
+    <%- model_attrs.each do |attr| -%>
+      t.<%= attr.type %> :<%= attr.name %>
+    <%- end -%>
+      t.timestamps
+    end
+  end
+end

data/lib/generators/occams/scaffold/templates/model.rb.tt

@@ -0,0 +1,21 @@
+class <%= class_name %> < ActiveRecord::Base
+
+  # -- Relationships -----------------------------------------------------------
+
+
+  # -- Callbacks ---------------------------------------------------------------
+
+
+  # -- Validations -------------------------------------------------------------
+
+
+  # -- Scopes ------------------------------------------------------------------
+
+
+  # -- Class Methods -----------------------------------------------------------
+
+
+  # -- Instance Methods --------------------------------------------------------
+
+
+end

data/lib/generators/occams/scaffold/templates/tests/controller.rb.tt

@@ -0,0 +1,115 @@
+require_relative '../../test_helper'
+
+class Admin::<%= class_name.pluralize %>ControllerTest < ActionDispatch::IntegrationTest
+
+  setup do
+    @<%= file_name %> = <%= file_name.pluralize %>(:default)
+  end
+
+  # Vanilla CMS has BasicAuth, so we need to send that with each request.
+  # Change this to fit your app's authentication strategy.
+  # Move this to test_helper.rb
+  def r(verb, path, options = {})
+    headers = options[:headers] || {}
+    headers['HTTP_AUTHORIZATION'] =
+      ActionController::HttpAuthentication::Basic.encode_credentials(
+        Occams::AccessControl::AdminAuthentication.username,
+        Occams::AccessControl::AdminAuthentication.password
+      )
+    options.merge!(headers: headers)
+    send(verb, path, options)
+  end
+
+  def test_get_index
+    r :get, admin_<%= file_name.pluralize %>_path
+    assert_response :success
+    assert assigns(:<%= file_name.pluralize %>)
+    assert_template :index
+  end
+
+  def test_get_show
+    r :get, admin_<%= file_name %>_path(@<%= file_name %>)
+    assert_response :success
+    assert assigns(:<%= file_name %>)
+    assert_template :show
+  end
+
+  def test_get_show_failure
+    r :get, admin_<%= file_name %>_path('invalid')
+    assert_response :redirect
+    assert_redirected_to action: :index
+    assert_equal '<%= class_name.titleize %> not found', flash[:danger]
+  end
+
+  def test_get_new
+    r :get, new_admin_<%= file_name %>_path
+    assert_response :success
+    assert assigns(:<%= file_name %>)
+    assert_template :new
+    assert_select "form[action='/admin/<%= file_name.pluralize %>']"
+  end
+
+  def test_get_edit
+    r :get, edit_admin_<%= file_name %>_path(@<%= file_name %>)
+    assert_response :success
+    assert assigns(:<%= file_name %>)
+    assert_template :edit
+    assert_select "form[action='/admin/<%= file_name.pluralize %>/#{@<%= file_name %>.id}']"
+  end
+
+  def test_creation
+    assert_difference '<%= class_name %>.count' do
+      r :post, admin_<%= file_name.pluralize %>_path, params: {<%= file_name %>: {
+      <%- model_attrs.each do |attr| -%>
+        <%= attr.name %>: 'test <%= attr.name %>',
+      <%- end -%>
+      }}
+      <%= file_name %> = <%= class_name %>.last
+      assert_response :redirect
+      assert_redirected_to action: :show, id: <%= file_name %>
+      assert_equal '<%= class_name.titleize %> created', flash[:success]
+    end
+  end
+
+  def test_creation_failure
+    assert_no_difference '<%= class_name %>.count' do
+      r :post, admin_<%= file_name.pluralize %>_path, params: {<%= file_name %>: { }}
+      assert_response :success
+      assert_template :new
+      assert_equal 'Failed to create <%= class_name.titleize %>', flash[:danger]
+    end
+  end
+
+  def test_update
+    r :put, admin_<%= file_name %>_path(@<%= file_name %>), params: {<%= file_name %>: {
+    <%- if attr = model_attrs.first -%>
+      <%= attr.name %>: 'Updated'
+    <%- end -%>
+    }}
+    assert_response :redirect
+    assert_redirected_to action: :show, id: @<%= file_name %>
+    assert_equal '<%= class_name.titleize %> updated', flash[:success]
+    @<%= file_name %>.reload
+    assert_equal 'Updated', @<%= file_name %>.<%= attr.try(:name) || 'attribute' %>
+  end
+
+  def test_update_failure
+    r :put, admin_<%= file_name %>_path(@<%= file_name %>), params: {<%= file_name %>: {
+      <%= attr.try(:name) || 'attribute' %>: ''
+    }}
+    assert_response :success
+    assert_template :edit
+    assert_equal 'Failed to update <%= class_name.titleize %>', flash[:danger]
+    @<%= file_name %>.reload
+    refute_equal '', @<%= file_name %>.<%= attr.try(:name) || 'attribute' %>
+  end
+
+  def test_destroy
+    assert_difference '<%= class_name %>.count', -1 do
+      r :delete, admin_<%= file_name %>_path(@<%= file_name %>)
+      assert_response :redirect
+      assert_redirected_to action: :index
+      assert_equal '<%= class_name.titleize %> deleted', flash[:success]
+    end
+  end
+end

data/lib/generators/occams/scaffold/templates/tests/fixture.yml.tt

@@ -0,0 +1,4 @@
+default:
+<%- model_attrs.each do |attr| -%>
+  <%= attr.name %>: default <%= attr.name %>
+<%- end -%>

data/lib/generators/occams/scaffold/templates/tests/model.rb.tt

@@ -0,0 +1,26 @@
+require_relative '../test_helper'
+
+class <%= class_name %>Test < ActiveSupport::TestCase
+
+  def test_fixtures_validity
+    <%= class_name %>.all.each do |<%= file_name %>|
+      assert <%= file_name %>.valid?, <%= file_name %>.errors.inspect
+    end
+  end
+
+  def test_validation
+    <%= file_name %> = <%= class_name %>.new
+    assert <%= file_name %>.invalid?
+    assert_equal [<%= model_attrs.collect{|attr| ":#{attr.name}"}.join(', ')%>], <%= file_name %>.errors.keys
+  end
+
+  def test_creation
+    assert_difference '<%= class_name %>.count' do
+      <%= class_name %>.create(
+      <%- model_attrs.each do |attr| -%>
+        <%= attr.name %>: 'test <%= attr.name %>',
+      <%- end -%>
+      )
+    end
+  end
+end

data/lib/generators/occams/scaffold/templates/views/_form.haml.tt

@@ -0,0 +1,7 @@
+<%- model_attrs.each do |attr| -%>
+= form.text_field :<%= attr.name %>
+<%- end -%>
+
+= form.form_actions do
+  = form.submit class: "btn btn-primary"
+  = link_to 'Cancel', admin_<%= file_name.pluralize %>_path, class: "btn btn-link"

data/lib/generators/occams/scaffold/templates/views/edit.haml.tt

@@ -0,0 +1,5 @@
+.page-header
+  %h2 Edit <%= class_name.titleize %>
+
+= occams_form_with model: @<%= file_name %>, url: [:admin, @<%= file_name %>] do |form|
+  = render form