cas-cms 0.1.3 → 1.0.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e4cf4081ecbfe1307e6d39d6b64156b98a494f3b
-  data.tar.gz: b1b59204366430b4ff05abf74dd64107524373d5
+SHA256:
+  metadata.gz: 8f12f0fb6a3b7c3c29caf99a139194aac107be867f347f5738d2b9cc215a5581
+  data.tar.gz: 950fd904a33eb23cd9467cc2324a6bea612a1e920a4c90d227ace4d299276257
 SHA512:
-  metadata.gz: 4144df8905ec86fd3102dcf0cfc7cef2053b314f40a749059a305e97b552187144fc8f669e13e90de69649092522a6edf3c9fc8f40bc23f9637be297d8d436da
-  data.tar.gz: d66d1a0ea481f0e9562e0f370a8dda0fbadcd23787fcbe260a9bfeb9ee3c3e9a8314ae7553312b2854258ffe17343037c24f89a31b5c579a7fe72836217e3336
+  metadata.gz: b7f891b42b447860a676e36aa868221a0165d81819f95e3d3ea3f9b88111eeb21eaa3788468156e9818e0d7c119b285faba5538cb47a8b27f76fea776505c7be
+  data.tar.gz: 8c720e1eb5382606cdf7679d242617734efcfb40501c5a813da22fcafe9a0d958c7c4be431805c9d8f262e0dd16725ce106cef2398b290d8c5040cd77ecb3445

data/README.md

@@ -1,34 +1,32 @@
 # Cas
-Short description and motivation.
 
 ## Usage
 
-How to use my plugin.
-
-## Installation
-
 Add this line to your application's Gemfile:
 
 ```ruby
 gem 'cas'
 ```
 
-### Setup
+### Installation
+
+```
+bin/rails generate cas:install
+```
 
-**Engine:** Cas is mounted in your main Rails application. Say your application
-is called MyBlog, you make can make it accessible at `myblog.com/admin`
-by setting the following in the `config/routes.rb` file in your main
-application:
+This adds an `/admin` entry to `config/routes.rb` and generates a new file,
+`config/cas.config.yml` which contains all sections your site is supposed to
+have. 
 
-```ruby
-Rails.application.routes.draw do
-   mount Cas::Engine, at: "/admin"
+Once the file is edited, run
 
-   # ... other routes
-end
 ```
+bin/rails cas:apply_config
+```
+
+### File Uploads
 
-**S3:** you need S3 credentials to use Cas (for file uploads). Set the
+You need S3 credentials to use Cas (for file uploads). Set the
 following ENV vars (e.g paste in your `~/.bash_profile` or use the `dotenv`
 gem in your main Rails application):
 
@@ -37,8 +35,20 @@ gem in your main Rails application):
     export S3_REGION="value"
     export S3_BUCKET="value"
 
-## Contributing
-Contribution directions go here.
+## Development
+
+Quick start:
+
+```
+bundle install
+bundle exec rake db:create db:migrate db:test:prepare
+cd spec/test_app/ && bin/rails server
+```
+
+### The Longer Version
+
+
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/app/assets/config/cas_manifest.js

@@ -1,2 +1,4 @@
+//= link cas/application.js
+//= link cas/application.css
 //= link_directory ../javascripts/cas .js
 //= link_directory ../stylesheets/cas .css

data/app/assets/javascripts/cas/application.js

@@ -1,6 +1,6 @@
 //= require jquery
 //= require jquery_ujs
-//= require tinymce-jquery
+//= require tinymce
 //= require cas/vendor/selectize.min
 //= require_self
 
@@ -37,6 +37,8 @@ $(document).ready(function() {
   });
 
   tinyMCE.init({
+    branding: false,
+    promotion: false,
     selector: 'textarea.editor',
     mode : "exact",
     relative_urls : false,
@@ -48,7 +50,7 @@ $(document).ready(function() {
     inline_styles: false,
     extended_valid_elements: "embed,param,object,iframe[src|title|width|height|allowfullscreen|frameborder]",
     language : "pt_BR",
-    plugins : 'image,imagetools,code,paste,pagebreak,table,wordcount,link',
+    plugins : 'image code pagebreak table wordcount link',
     default_link_target: "_blank",
     images_upload_url: paths.fileUpload.path,
     images_upload_credentials: true

data/app/assets/javascripts/cas/fileupload_manifest.js

@@ -30,7 +30,7 @@ var UploadSharedFunctions = {
     console.log("error", e);
     console.log("data", data);
     data.progressBar.remove();
-    alert('Falha ao enviar arquivo: '+data.files[0].name);
+    alert('Failed sending file: '+data.files[0].name);
   }
 };
 
@@ -47,7 +47,7 @@ var ImageGalleryUploadFunctions = {
     for (var index in data.originalFiles) {
       var file = data.originalFiles[index];
       if(file['type'].length && !acceptFileTypes.test(file['type'])) {
-        alert('O arquivo enviado não é uma imagem.');
+        alert('File is not a valid image.');
         return false;
       }
     }

data/app/assets/stylesheets/cas/application.sass

@@ -1,10 +1,10 @@
-
 /*
- * require_tree .
  *= require_self
+ * require cas/vendors/simplegrid.css
+ * require ./cas/vendors/selectize.default.css
  */
-@import 'vendors/simplegrid.css'
-@import 'vendors/selectize.default.css'
+@import 'cas/vendors/selectize.css'
+@import 'cas/vendors/simplegrid.css'
 
 @import 'mixins'
 @import 'colors'

data/app/assets/stylesheets/cas/form.sass

@@ -1,3 +1,5 @@
+@import 'colors'
+
 label
   display: block
 div.input.boolean

data/app/assets/stylesheets/cas/layout.sass

@@ -1,3 +1,5 @@
+@import 'colors'
+@import 'mixins'
 
 body
   margin: 0

data/app/assets/stylesheets/cas/tables.sass

@@ -1,3 +1,6 @@
+@import 'colors'
+@import 'mixins'
+
 table
   width: 100%
   border-spacing: 0

data/app/assets/stylesheets/cas/typography.sass

@@ -1,4 +1,6 @@
 // @import url('https://fonts.googleapis.com/css?family=Lato')
+@import 'colors'
+@import 'mixins'
 
 body
   margin: 0

data/app/controllers/cas/activities_controller.rb

@@ -0,0 +1,9 @@
+class Cas::ActivitiesController < Cas::ApplicationController
+  def index
+    @activities = Cas::Activity
+      .where(site_id: current_user.sites.map(&:id))
+      .order('created_at DESC')
+      .page(params[:page])
+      .per(25)
+  end
+end

data/app/controllers/cas/application_controller.rb

@@ -5,6 +5,7 @@ module Cas
     before_action :set_current_user
     before_action :set_user_sites
     before_action :set_domain
+    before_action :set_site
 
     private
 
@@ -22,6 +23,18 @@ module Cas
       if @domain.blank? || (ENV["DOMAIN"].blank? && @domain == "localhost")
         @domain = ::Cas::Site.first!.domains.first
       end
+    rescue ActiveRecord::RecordNotFound => e
+      raise Cas::Exceptions::IncompleteSetup, "IncompleteSetup: check README.md. #{e.message}: #{e.inspect}"
+    end
+
+    def set_site
+      if params[:site_id].present?
+        @site = ::Cas::Site.find_by!(slug: params[:site_id])
+      else
+        @site = ::Cas::Site
+          .where("cas_sites.domains::text[] && '{#{@domain}}'::text[]")
+          .first!
+      end
     end
   end
 end

data/app/controllers/cas/file_uploads_controller.rb

@@ -1,6 +1,6 @@
 class Cas::FileUploadsController < Cas::ApplicationController
   skip_before_action :authenticate_user!
-  skip_before_filter :verify_authenticity_token
+  skip_before_action :verify_authenticity_token
 
   def create
     file = params.fetch(:file)

data/app/controllers/cas/sites/application_controller.rb

@@ -1,15 +1,2 @@
 class Cas::Sites::ApplicationController < ::Cas::ApplicationController
-  before_action :set_site
-
-  private
-
-  def set_site
-    if params[:site_id].present?
-      @site = ::Cas::Site.find_by!(slug: params[:site_id])
-    else
-      @site = ::Cas::Site
-        .where("cas_sites.domains::text[] && '{#{@domain}}'::text[]")
-        .first!
-    end
-  end
 end

data/app/controllers/cas/sites/sections/contents_controller.rb

@@ -25,10 +25,12 @@ module Cas
           @content.section_id = @section.id
           @content.tag_list = content_params[:tag_list] if content_params[:tag_list]
           success = @content.save!
+          ::Cas::Activity.create!(user: current_user, site: @site, subject: @content, event_name: 'create')
           associate_files(@content, :images)
           associate_files(@content, :attachments)
         end
       rescue ActiveRecord::RecordInvalid
+        Rails.logger.info "Errors: #{@content.errors.full_messages.inspect}"
         success = nil
       end
 
@@ -62,6 +64,7 @@ module Cas
           success = @content.update!(content_params)
           associate_files(@content, :images)
           associate_files(@content, :attachments)
+          ::Cas::Activity.create!(user: current_user, site: @site, subject: @content, event_name: 'update')
         end
       rescue ActiveRecord::RecordInvalid
         success = nil
@@ -90,6 +93,11 @@ module Cas
 
     def content_params
       @content_params ||= begin
+        # When no file is uploaded, when the content form is submitted the
+        # `file` input ends up being sent empty (e.g file: [""]). This confuses
+        # Rails.
+        params[:content].delete(:file) if params[:content][:file].map(&:presence).compact.blank?
+
         result = params.require(:content).permit(
           :category_id,
           :title,
@@ -100,7 +108,8 @@ module Cas
           :text,
           :url,
           :embedded,
-          :tag_list
+          :tag_list,
+          :file
         )
 
         unless result.keys.map(&:to_sym).include?(:published)

data/app/controllers/cas/sites/users_controller.rb

@@ -36,7 +36,7 @@ module Cas
         without_password = user_params.except(:password, :password_confirmation)
         success = @user.update_without_password(without_password)
       else
-        success = @user.update_attributes(user_params)
+        success = @user.update(user_params)
       end
 
       if success

data/app/models/cas/activity.rb

@@ -0,0 +1,30 @@
+module Cas
+  class Activity < ApplicationRecord
+    belongs_to :site
+    belongs_to :user, optional: true
+    belongs_to :subject, polymorphic: true
+
+    # To prevent losing data in case the subject is ever destroyed
+    before_validation :cache_description
+
+    private
+
+    def cache_description
+      if self.user_description.blank?
+        user_string = [user.name]
+        user_string << ["(admin)"] if user.admin?
+        self.user_description = user_string.join(" ")
+      end
+
+      if self.subject_description.blank?
+        subject_string = []
+        if subject.respond_to?(:title)
+          subject_string << [subject.title]
+        elsif subject.respond_to?(:name)
+          subject_string << [subject.name]
+        end
+        self.subject_description = subject_string.join(" ")
+      end
+    end
+  end
+end

data/app/models/cas/content.rb

@@ -9,12 +9,21 @@ module Cas
     serialize :metadata
 
     belongs_to :section
+    belongs_to :category, optional: true
+    belongs_to :author, class_name: "::Cas::User"
+
+    has_many :images,
+      ->{ where(media_type: :image).order("cas_media_files.order ASC") },
+      class_name: "::Cas::MediaFile", as: :attachable, dependent: :destroy
+    has_many :attachments,
+      ->{ where(media_type: :attachment).order("cas_media_files.order ASC") },
+      class_name: "::Cas::MediaFile", as: :attachable, dependent: :destroy
+    has_many :activities, as: :subject
+
     has_one :site, through: :section
-    belongs_to :category
-    belongs_to :author, class_name: Cas::User
-    has_many :images, ->{ where(media_type: :image).order("cas_media_files.order ASC") }, class_name: Cas::MediaFile, as: :attachable, dependent: :destroy
-    has_many :attachments, ->{ where(media_type: :attachment).order("cas_media_files.order ASC") }, class_name: Cas::MediaFile, as: :attachable, dependent: :destroy
-    has_one :cover_image, ->{ where(media_type: :image, cover: true) }, class_name: Cas::MediaFile, as: :attachable
+    has_one :cover_image,
+      ->{ where(media_type: :image, cover: true) },
+      class_name: "::Cas::MediaFile", as: :attachable
 
     validates :title, presence: true
 

data/app/models/cas/media_file.rb

@@ -6,7 +6,7 @@ module Cas
     class UnknownFileService < StandardError; end
 
     belongs_to :attachable, polymorphic: true
-    belongs_to :author, class_name: "Cas::User"
+    belongs_to :author, class_name: "::Cas::User"
 
     before_validation :set_media_type
     before_save :set_image_as_unique_cover

data/app/models/cas/sites_user.rb

@@ -2,6 +2,6 @@ module Cas
   class SitesUser < ApplicationRecord
     belongs_to :site
     belongs_to :user
-    belongs_to :owner, class_name: '::Cas::User'
+    belongs_to :owner, class_name: '::Cas::User', optional: true
   end
 end

data/app/models/cas/user.rb

@@ -6,9 +6,10 @@ module Cas
            :rememberable, :trackable, :validatable, request_keys: [:domain]
 
     has_many :contents
-    has_many :files, class_name: 'Cas::MediaFile', as: :attachable
-    has_many :sites_users, class_name: 'Cas::SitesUser'
+    has_many :files, class_name: '::Cas::MediaFile', as: :attachable
+    has_many :sites_users, class_name: '::Cas::SitesUser'
     has_many :sites, through: :sites_users
+    has_many :activities, as: :subject
 
     validates :name, presence: true, length: { maximum: 50 }
     validates :email, presence: true, length: { maximum: 255 },

data/app/uploaders/file_uploader.rb

@@ -9,11 +9,11 @@ class ::FileUploader < Shrine
     end
     original = (io.respond_to?(:[]) && io[:original]) ? io[:original] : io
     result = result.merge(original: original) unless result.keys.include?(:original)
+    Rails.logger.info "FileUploader, versions: [#{result.keys.join(", ")}]"
     result
   end
 
   def generate_location(io, context)
-    Rails.logger.info "FileUploader#generate_location"
     year  = Time.now.strftime("%Y")
     month = Time.now.strftime("%m")
     original_filename = context[:metadata]["filename"]

data/app/views/cas/activities/index.html.erb

@@ -0,0 +1,56 @@
+<div class="grid">
+  <div class="col-1-1">
+    <h1>Atividades</h1>
+  </div>
+</div>
+
+<br />
+
+<table>
+  <thead>
+    <tr>
+      <th>
+      </th>
+      <th>
+      </th>
+      <th>Data</th>
+    </tr>
+  </thead>
+
+  <tbody>
+  <% @activities.each do |activity| %>
+    <tr>
+      <td>
+        <%= activity.site.name %>
+      </td>
+      <td>
+        <% if activity.user.present? %>
+          <strong><%= activity.user.name %></strong>
+        <% else %>
+          <strong><%= activity.user_description %></strong>
+        <% end %>
+        <% if activity.event_name == 'create' %>
+          criou
+        <% elsif activity.event_name == 'update'%>
+          editou
+        <% end %>
+        <% if activity.subject.present? %>
+          <strong>
+            <%= link_to activity.subject.title,
+              edit_site_section_content_path(@site, activity.subject.section, activity.subject)
+            %>
+          </strong>
+        <% else %>
+          <%= activity.subject_description %>
+        <% end %>
+      </td>
+      <td>
+        <%= l(activity.created_at, format: :short) %>
+      </td>
+    </tr>
+  <% end %>
+  </tbody>
+</table>
+<br>
+
+<%= paginate @activities %>

data/app/views/cas/sites/sections/contents/index.html.erb

@@ -12,7 +12,6 @@
 <%= link_to 'Novo conteúdo',
   new_site_section_content_path(@site, @section),
   id: 'new-content' %>
-
 <br />
 <br />
 

data/app/views/layouts/cas/application.html.erb

@@ -26,7 +26,7 @@
 
   <%= csrf_meta_tags %>
 </head>
-<body class="<%= "site-#{@site.id}" if @current_user.present? %>">
+<body class="<%= "site-#{@site.id}" if @current_user.present? && @site.present? %>">
 
   <header>
     <div class="grid top">
@@ -43,7 +43,7 @@
           <% else %>
             <select id="select-site">
               <% @user_sites.each do |site| %>
-                <% selected = site.id == @site.id %>
+                <% selected = site.id == @site&.id %>
                 <option
                   value="<%= site_sections_path(site) %>"
                   <%= 'selected="selected"' if selected %>
@@ -70,6 +70,7 @@
       <ul>
         <% if user_signed_in? %>
           <li><%= link_to "Conteúdo", cas.site_sections_path(@site) %></li>
+          <li><%= link_to "Atividades", cas.activities_path, id: "go-to-activities" %></li>
         <% end %>
         <% if user_signed_in? && current_user.admin? %>
           <li><%= link_to "Pessoas", cas.site_users_path(@site), id: "list-people" %></li>

data/config/initializers/acts_as_taggable.rb

@@ -1 +1 @@
-ActsAsTaggableOn.delimiter = [',', ' ']
+ActsAsTaggableOn.delimiter = [',']

data/config/initializers/shrine.rb

@@ -1,3 +1,6 @@
+# On why we use Shrine over Active Storage:
+# https://github.com/shrinerb/shrine/blob/d9aba64bd5515584645f8885c76d56fa1a842bac/doc/advantages.md
+
 require 'shrine'
 
 Shrine.plugin :activerecord
@@ -19,24 +22,25 @@ if Rails.env.test?
   }
 else
   if ENV["S3_ACCESS_KEY_ID"].blank?
-    msg = "You need to configure S3 credentials. See the README.md for more details."
-    puts msg
+    msg = "You need to configure S3 credentials. See the README.md for more details. File uploads will be broken until you fix it."
     Rails.logger.error msg
-  end
+    puts msg
 
-  s3_options = {
-    access_key_id:     ENV.fetch("S3_ACCESS_KEY_ID"),
-    secret_access_key: ENV.fetch("S3_SECRET_ACCESS_KEY"),
-    region:            ENV.fetch("S3_REGION"),
-    bucket:            ENV.fetch("S3_BUCKET"),
-  }
+  else
+    s3_options = {
+      access_key_id:     ENV.fetch("S3_ACCESS_KEY_ID"),
+      secret_access_key: ENV.fetch("S3_SECRET_ACCESS_KEY"),
+      region:            ENV.fetch("S3_REGION"),
+      bucket:            ENV.fetch("S3_BUCKET"),
+    }
 
-  require "shrine/storage/s3"
-  config = Cas::Config.new.uploads
-  Shrine.storages = {
-    cache: Shrine::Storage::S3.new(prefix: config[:cache_directory_prefix], **s3_options),
-    store: Shrine::Storage::S3.new(prefix: config[:store_directory_prefix], **s3_options),
-  }
+    require "shrine/storage/s3"
+    config = Cas::Config.new.uploads
+    Shrine.storages = {
+      cache: Shrine::Storage::S3.new(prefix: config[:cache_directory_prefix], **s3_options),
+      store: Shrine::Storage::S3.new(prefix: config[:store_directory_prefix], **s3_options),
+    }
+  end
 end
 
 Shrine::Attacher.promote do |data|

data/config/routes.rb

@@ -1,8 +1,11 @@
 require 'sidekiq/web'
-Sidekiq::Web.set :session_secret, Rails.application.secrets[:secret_key_base]
+# TODO - need to migrate Sidekiq
+#Sidekiq::Web.set :session_secret, Rails.application.secrets[:secret_key_base]
 
 Cas::Engine.routes.draw do
   mount Shrine.presign_endpoint(:cache) => "/files/cache/presign"
+  # TODO - fix
+  # mount Shrine.upload_endpoint(:cache) => "/files/upload"
 
   authenticate :user, ->(u){ u.roles.include?('admin') } do
     mount Sidekiq::Web => '/sidekiq'
@@ -14,6 +17,7 @@ Cas::Engine.routes.draw do
     controllers: { sessions: "cas/devise/sessions" },
     skip: :registrations
 
+  resources :activities, only: [:index]
   resources :sites, only: [:index] do
     resources :users, controller: 'sites/users'
 

data/db/migrate/20180114124600_create_cas_activities.rb

@@ -0,0 +1,16 @@
+class CreateCasActivities < ActiveRecord::Migration[5.0]
+  def change
+    create_table :cas_activities, id: :uuid do |t|
+      t.uuid :site_id
+      t.uuid :user_id
+      t.string :event_name
+      t.uuid :subject_id
+      t.string :subject_type
+
+      t.timestamps
+    end
+    add_index :cas_activities, :site_id
+    add_index :cas_activities, :user_id
+    add_index :cas_activities, [:subject_id, :subject_type]
+  end
+end

data/db/migrate/20230220165900_add_subject_title_to_activities.rb

@@ -0,0 +1,6 @@
+class AddSubjectTitleToActivities < ActiveRecord::Migration[5.0]
+  def change
+    add_column :cas_activities, :user_description, :string
+    add_column :cas_activities, :subject_description, :string
+  end
+end

data/lib/cas/config.rb

@@ -10,6 +10,7 @@ module Cas
     def uploads
       uploads = config["uploads"] || {}
 
+      # TODO - clarify what this is and how to configure
       {
         cache_directory_prefix: uploads["cache_directory_prefix"] || "cache",
         store_directory_prefix: uploads["store_directory_prefix"] || "store"
@@ -19,13 +20,17 @@ module Cas
     private
 
     def read_file
-      @file ||= YAML.load_file(filename)
+      begin
+        @file ||= YAML.safe_load_file(filename, aliases: true)
+      rescue NoMethodError, ArgumentError
+        @file ||= YAML.load_file(filename)
+      end
     end
 
     def filename
       @filename ||= begin
-                      if File.exists?("cas.yml")
-                        "cas.yml"
+                      if File.exists?(Cas::CONFIG_PATH)
+                        Cas::CONFIG_PATH
                       elsif ENV['RAILS_ENV'] == 'test'
                         "spec/fixtures/cas.yml"
                       else

data/lib/cas/engine.rb

@@ -16,7 +16,11 @@ module Cas
       end
     end
 
-    config.assets.precompile += ["cas/fileupload_manifest.js"]
+    config.assets.precompile += [
+      "cas/application.css",
+      "cas/application.js",
+      "cas/fileupload_manifest.js"
+    ]
 
     config.active_record.primary_key = :uuid
     config.generators do |g|

data/lib/cas/exceptions.rb

@@ -0,0 +1,7 @@
+module Cas
+  module Exceptions
+    class Error < StandardError; end
+    class IncompleteSetup < Error; end
+    class UndefinedSite < Cas::Exceptions::Error; end
+  end
+end

data/lib/cas/form_field.rb

@@ -15,13 +15,17 @@ module Cas
       if Rails.env.test?
         "spec/fixtures/cas.yml"
       else
-        "cas.yml"
+        Cas::CONFIG_PATH
       end
     end
 
     def load_field
       @config ||= begin
-        config_file = YAML.load_file(filename)
+        begin
+          config_file = YAML.safe_load_file(filename, aliases: true)
+        rescue NoMethodError, ArgumentError
+          config_file = YAML.load_file(filename)
+        end
         sites = config_file["sites"]
         site = sites[@section.site.slug]
         section = site["sections"]

data/lib/cas/installation.rb

@@ -0,0 +1,103 @@
+module Cas
+  class Installation
+    def initialize(filename: nil, logger: Rails.logger)
+      @logger = logger
+      @filename = filename
+      @filename ||= begin
+        if Rails.env.test?
+          "spec/fixtures/cas.yml"
+        else
+          Cas::CONFIG_PATH
+        end
+      end
+
+      # Ruby 3.0 comes with Psych 3, while Ruby 3.1 comes with Psych 4, which
+      # has a major breaking change (diff 3.3.2 → 4.0.0).
+      #
+      # The new YAML loading methods (Psych 4) do not load aliases unless
+      # they get the aliases: true argument.  The old YAML loading methods
+      # (Psych 3) do not support the :aliases keyword.
+      begin
+        @config = YAML.safe_load_file(@filename, aliases: true)
+      rescue NoMethodError, ArgumentError
+        @config = YAML.load_file(@filename)
+      end
+    end
+
+    def generate_sites
+      @logger.info "Creating data..."
+      ActiveRecord::Base.transaction do
+        @logger.info "  - admins"
+        create_initial_admins
+        @logger.info "  - sites"
+        create_sites
+        @logger.info "  - setting superadmins"
+        set_superadmins
+      end
+      @logger.info "Done."
+    end
+
+    private
+
+    def create_sites
+      @config["sites"].each do |site_slug, site_config|
+        site = ::Cas::Site.where(slug: site_slug).first_or_create!
+        site.update!(
+          domains: site_config["domains"],
+          name: site_config["name"]
+        )
+
+        site_config["sections"].each do |key, section|
+          model = ::Cas::Section.where(
+            slug: key,
+            site_id: site.id
+          ).first_or_create!(
+            name: section["name"],
+            section_type: section["type"],
+          )
+
+          model.update!(
+            name: section["name"],
+            section_type: section["type"],
+          )
+        end
+      end
+    end
+
+    def create_initial_admins
+      return if @config["config"]["initial_admins"].blank?
+
+      @config["config"]["initial_admins"].each do |item|
+        ::Cas::User.where(email: item).first_or_create!(
+          password: "12345678",
+          name: "User",
+          roles: ["admin"]
+        )
+      end
+    end
+
+    def set_superadmins
+      return if @config["config"]["superadmins"].blank?
+
+      updated_users = []
+      @config["config"]["superadmins"].each do |email_or_login|
+        user = ::Cas::User.where(
+          'cas_users.email = :value OR cas_users.login = :value',
+          value: email_or_login
+        ).first
+
+        if user.blank?
+          @logger.info "Cannot set user '#{email_or_login}' as superadmin because it doesn't exist"
+          next
+        end
+
+        next if updated_users.include?(user.id)
+
+        user.sites = ::Cas::Site.all
+        user.save!
+
+        updated_users << user.id
+      end
+    end
+  end
+end

data/lib/cas/section_config.rb

@@ -5,26 +5,12 @@ module Cas
     end
 
     def list_order_by
-      config = YAML.load_file(filename)
-      sites = config["sites"]
-      site = sites[@section.site.slug]
-      section = site["sections"]
-
-      order_field = section.find { |key, value|
-        key == @section.slug
-      }[1]['list_order_by']
-
+      order_field = load_section_config[1]['list_order_by']
       order_field || ['created_at']
     end
 
     def list_fields
-      config = YAML.load_file(filename)
-      sites = config["sites"]
-      site = sites[@section.site.slug]
-      section = site["sections"]
-      fields = section.find { |key, value|
-        key == @section.slug
-      }[1]["list_fields"]
+      fields = load_section_config[1]["list_fields"]
       fields || ['title', 'created_at']
     end
 
@@ -40,13 +26,7 @@ module Cas
     end
 
     def form_has_field?(field)
-      config = YAML.load_file(filename)
-      sites = config["sites"]
-      site = sites[@section.site.slug]
-      section = site["sections"]
-      section_fields = section.find { |key, value|
-        key == @section.slug
-      }[1]["fields"]
+      section_fields = load_section_config[1]["fields"]
 
       Array.wrap(section_fields).any? do |section_field|
         if section_field.is_a?(Hash)
@@ -63,22 +43,36 @@ module Cas
       if Rails.env.test?
         "spec/fixtures/cas.yml"
       else
-        "cas.yml"
+        Cas::CONFIG_PATH
       end
     end
 
     def load_field
       @config ||= begin
-        config_file = YAML.load_file(filename)
-        sites = config_file["sites"]
-        site = sites[@section.site.slug]
-        section = site["sections"]
-        field = section.find { |key, value|
-          key == @section.slug
-        }
+        field = load_section_config
         (field && field[1]) || {}
       end
     end
+
+    def load_section_config
+      begin
+        config = YAML.safe_load_file(filename, aliases: true)
+      rescue NoMethodError, ArgumentError
+        config = YAML.load_file(filename)
+      end
+
+      sites = config["sites"]
+      site = sites[@section.site.slug]
+
+      if site.blank?
+        raise(
+          Cas::Exceptions::UndefinedSite,
+          "Site #{@section.site.slug} is undefined in the #{filename} file."
+        )
+      end
+
+      site["sections"].find { |key, value| key == @section.slug }
+    end
   end
 end
 

data/lib/cas/version.rb

@@ -1,3 +1,3 @@
 module Cas
-  VERSION = '0.1.3'
+  VERSION = '1.0.0.alpha1'
 end

data/lib/cas.rb

@@ -1,7 +1,8 @@
 require "cas/engine"
+require "cas/exceptions"
 require "cas/config"
 require "cas/remote_callbacks"
-require "cas/setup"
+require "cas/installation"
 require "cas/section_config"
 require "cas/form_field"
 
@@ -19,4 +20,5 @@ require 'sidekiq'
 require 'pg_search'
 
 module Cas
+  CONFIG_PATH = "config/cas.config.yml"
 end

data/lib/generators/cas/USAGE

@@ -0,0 +1,14 @@
+Description:
+    Generates new cas.yml and configures database for it.
+
+Example:
+    bin/rails generate cas:install
+
+    This will:
+      - run Cas migrations
+      - add an `/admin` route for Cas
+      - create a configuration file in config/cas.config.yml. After you edit
+        this file, run
+
+          bin/rails cas:apply_config
+

data/lib/generators/cas/install_generator.rb

@@ -0,0 +1,14 @@
+module Cas
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    def copy_initializer_file
+      rake("db:migrate")
+      copy_file "cas.config.yml", Cas::CONFIG_PATH
+      route 'mount Cas::Engine, at: "/admin"'
+
+      puts ""
+      puts "Config generated. Now edit `#{Cas::CONFIG_PATH}` and run `bin/rails cas:apply_config`"
+    end
+  end
+end

data/lib/generators/cas/templates/cas.config.yml

@@ -0,0 +1,82 @@
+# CAS CONFIG
+#
+# This file is used to generate the data for the sites you want to manage.
+
+# Config: global configuration across all sites
+config:
+
+  # TODO - clarify what is the initial password
+  initial_admins:
+    - admin@example.com
+
+  # Superadmins can create other admins and users. Define which emails or logins
+  # you want set as superadmin.
+  superadmins:
+    - admin@example.com
+    - superadmin-login
+
+  # DEPRECATED
+  uploads:
+    cache_directory_prefix: 'cache'
+    store_directory_prefix: 'uploads'
+
+# Sites: define the ones you want to manage. If you have multiple, you will be
+# able to switch between them inside Cas dashboard.
+#
+# Each site has Sections, and each Section has their own Categories.
+sites:
+  mysite:
+    name: mysite.net
+
+    # Depending on this, Cas will automatically switch the site it is managing.
+    domains:
+      - mysite.net
+
+    # These are entire sections, like 'articles', 'pages', 'ads' etc
+    sections:
+      news:
+        name: news
+        type: content
+        list_fields:
+          - title
+          - category
+        fields:
+          - category
+          - tags
+          - title
+          - summary
+          - text
+          - images
+          - files
+          - tags
+          - date
+      biography:
+        name: Biography
+        type: content
+        fields:
+          - title
+          - text
+          - image
+      agenda:
+        name: Agenda
+        type: content
+        accessible_roles:
+          - admin
+        list_fields:
+          - title
+          - date_time
+        list_order_by:
+          - order_field
+        fields:
+          - title
+          - location
+          - date:
+              language: pt-br
+              format:
+                - day
+                - month
+                - year
+          - text
+      survey:
+        name: Survey
+        type: survey

data/lib/tasks/cas_tasks.rake

@@ -1,4 +1,6 @@
-# desc "Explaining what the task does"
-# task :cas do
-#   # Task goes here
-# end
+desc "Generate sites based on the YAML config file"
+namespace :cas do
+  task apply_config: :environment do
+    Cas::Installation.new(logger: Logger.new(STDOUT)).generate_sites
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cas-cms
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.0.alpha1
 platform: ruby
 authors:
 - Alexandre de Oliveira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-05 00:00:00.000000000 Z
+date: 2023-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.1
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.1
+        version: 7.0.0
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -179,7 +179,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: tinymce-rails
+  name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -193,7 +193,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: tinymce-rails-langs
+  name: sprockets-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -207,7 +207,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sidekiq
+  name: tinymce-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tinymce-rails-langs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -226,14 +240,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: 2.19.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: 2.19.1
 - !ruby/object:Gem::Dependency
   name: roda
   requirement: !ruby/object:Gem::Requirement
@@ -402,6 +416,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Description of Cas.
 email:
 - chavedomundo@gmail.com
@@ -439,8 +467,9 @@ files:
 - app/assets/stylesheets/cas/plugins/image_gallery.sass
 - app/assets/stylesheets/cas/tables.sass
 - app/assets/stylesheets/cas/typography.sass
-- app/assets/stylesheets/cas/vendors/selectize.default.css
+- app/assets/stylesheets/cas/vendors/selectize.css
 - app/assets/stylesheets/cas/vendors/simplegrid.css
+- app/controllers/cas/activities_controller.rb
 - app/controllers/cas/api/files_controller.rb
 - app/controllers/cas/application_controller.rb
 - app/controllers/cas/devise/sessions_controller.rb
@@ -457,6 +486,7 @@ files:
 - app/jobs/cas/images/delete_job.rb
 - app/jobs/cas/images/promote_job.rb
 - app/jobs/cas/increment_pageviews_job.rb
+- app/models/cas/activity.rb
 - app/models/cas/application_record.rb
 - app/models/cas/category.rb
 - app/models/cas/content.rb
@@ -466,6 +496,7 @@ files:
 - app/models/cas/sites_user.rb
 - app/models/cas/user.rb
 - app/uploaders/file_uploader.rb
+- app/views/cas/activities/index.html.erb
 - app/views/cas/devise/sessions/new.html.erb
 - app/views/cas/shared/_error_messages.html.erb
 - app/views/cas/sites/sections/categories/_form.html.erb
@@ -526,16 +557,22 @@ files:
 - db/migrate/20171201191059_add_domains_to_cas_site.rb
 - db/migrate/20171223134308_connects_users_to_sites.rb
 - db/migrate/20171223143551_make_site_unique.rb
+- db/migrate/20180114124600_create_cas_activities.rb
+- db/migrate/20230220165900_add_subject_title_to_activities.rb
 - lib/cas.rb
 - lib/cas/cms.rb
 - lib/cas/config.rb
 - lib/cas/engine.rb
+- lib/cas/exceptions.rb
 - lib/cas/form_field.rb
+- lib/cas/installation.rb
 - lib/cas/remote_callbacks.rb
 - lib/cas/section_config.rb
-- lib/cas/setup.rb
 - lib/cas/version.rb
 - lib/devise/custom_failure.rb
+- lib/generators/cas/USAGE
+- lib/generators/cas/install_generator.rb
+- lib/generators/cas/templates/cas.config.yml
 - lib/tasks/cas_tasks.rake
 - lib/templates/erb/scaffold/_form.html.erb
 homepage: ''
@@ -553,12 +590,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Summary of Cas.

data/lib/cas/setup.rb

@@ -1,60 +0,0 @@
-module Cas
-  class Setup
-    def install
-      ActiveRecord::Base.transaction do
-        config = YAML.load_file(filename)
-
-        config["sites"].each do |site_slug, site_config|
-          site = ::Cas::Site.where(slug: site_slug).first_or_create
-          site.update!(
-            domains: site_config["domains"],
-            name: site_config["name"]
-          )
-
-          site_config["sections"].each do |key, section|
-            model = ::Cas::Section.where(
-              slug: key,
-              site_id: site.id
-            ).first_or_create!(
-              name: section["name"],
-              section_type: section["type"],
-            )
-
-            model.update!(
-              name: section["name"],
-              section_type: section["type"],
-            )
-          end
-        end
-
-        if superadmins_emails_or_logins = config["config"]["superadmins"]
-          updated_users = []
-          superadmins_emails_or_logins.each do |email_or_login|
-            user = ::Cas::User.where(
-              'cas_users.email = :value OR cas_users.login = :value',
-              value: email_or_login
-            ).first
-
-            if user.present?
-              unless updated_users.include?(user.id)
-                user.update!(sites: ::Cas::Site.all)
-              end
-              updated_users << user.id
-            end
-          end
-        end
-      end
-    end
-
-    private
-
-    def filename
-      if Rails.env.test?
-        "spec/fixtures/cas.yml"
-      else
-        "cas.yml"
-      end
-    end
-  end
-end
-