RubyGems - cas-cms - Versions diffs - 0.1.3 → 1.0.0.alpha2 - Mend

cas-cms 0.1.3 → 1.0.0.alpha2

Files changed (49) hide show

checksums.yaml +5 -5
data/README.md +30 -18
data/app/assets/config/cas_manifest.js +2 -0
data/app/assets/javascripts/cas/application.js +4 -2
data/app/assets/javascripts/cas/fileupload_manifest.js +14 -18
data/app/assets/stylesheets/cas/application.sass +4 -4
data/app/assets/stylesheets/cas/form.sass +2 -0
data/app/assets/stylesheets/cas/layout.sass +2 -0
data/app/assets/stylesheets/cas/tables.sass +3 -0
data/app/assets/stylesheets/cas/typography.sass +2 -0
data/app/controllers/cas/activities_controller.rb +9 -0
data/app/controllers/cas/api/files_controller.rb +21 -13
data/app/controllers/cas/application_controller.rb +13 -0
data/app/controllers/cas/file_uploads_controller.rb +1 -1
data/app/controllers/cas/sites/application_controller.rb +0 -13
data/app/controllers/cas/sites/sections/contents_controller.rb +13 -1
data/app/controllers/cas/sites/users_controller.rb +1 -1
data/app/jobs/cas/images/delete_job.rb +5 -2
data/app/jobs/cas/images/promote_job.rb +12 -3
data/app/models/cas/activity.rb +30 -0
data/app/models/cas/content.rb +14 -5
data/app/models/cas/media_file.rb +33 -9
data/app/models/cas/sites_user.rb +1 -1
data/app/models/cas/user.rb +3 -2
data/app/uploaders/file_uploader.rb +7 -8
data/app/views/cas/activities/index.html.erb +56 -0
data/app/views/cas/sites/sections/contents/index.html.erb +0 -1
data/app/views/layouts/cas/application.html.erb +3 -2
data/config/initializers/acts_as_taggable.rb +1 -1
data/config/initializers/shrine.rb +38 -27
data/config/routes.rb +11 -2
data/db/migrate/20180114124600_create_cas_activities.rb +16 -0
data/db/migrate/20230220165900_add_subject_title_to_activities.rb +6 -0
data/lib/cas/config.rb +8 -3
data/lib/cas/engine.rb +5 -1
data/lib/cas/exceptions.rb +7 -0
data/lib/cas/form_field.rb +6 -2
data/lib/cas/installation.rb +103 -0
data/lib/cas/remote_callbacks.rb +3 -3
data/lib/cas/section_config.rb +25 -31
data/lib/cas/version.rb +1 -1
data/lib/cas.rb +3 -1
data/lib/generators/cas/USAGE +14 -0
data/lib/generators/cas/install_generator.rb +14 -0
data/lib/generators/cas/templates/cas.config.yml +82 -0
data/lib/tasks/cas_tasks.rake +6 -4
metadata +62 -26
data/lib/cas/setup.rb +0 -60
/data/app/assets/stylesheets/cas/vendors/{selectize.default.css → selectize.css} +0 -0

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

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

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

data/config/initializers/shrine.rb CHANGED Viewed

@@ -1,16 +1,18 @@
+# On why we use Shrine over Active Storage:
+# https://github.com/shrinerb/shrine/blob/d9aba64bd5515584645f8885c76d56fa1a842bac/doc/advantages.md
 require 'shrine'
 Shrine.plugin :activerecord
-Shrine.plugin :presign_endpoint
 Shrine.plugin :backgrounding
+Shrine.plugin(
+  :derivatives,
+  create_on_promote:      true, # automatically create derivatives on promotion
+  versions_compatibility: true  # handle versions column format
+)
 if Rails.env.test?
-  s3_options = {
-    access_key_id:     'access_key_id',
-    secret_access_key: 'secret_access_key',
-    region:            'us-east-1',
-    bucket:            'com.bucket'
-  }
   require "shrine/storage/file_system"
   Shrine.storages = {
@@ -19,32 +21,41 @@ 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
+    Shrine.plugin :presign_endpoint
+    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|
-  Rails.logger.info "Shrine promoting file scheduled"
-  ::Cas::Images::PromoteJob.perform_async(data)
+Shrine::Attacher.promote_block do
+  Rails.logger.info "Shrine promoting #{record.class.name} file scheduled"
+  ::Cas::Images::PromoteJob.perform_async(
+    self.class.name,
+    record.class.name,
+    record.id,
+    name.to_s,
+    file_data
+  )
 end
-Shrine::Attacher.delete do |data|
+Shrine::Attacher.destroy_block do
   Rails.logger.info "Shrine deleting file scheduled"
-  ::Cas::Images::DeleteJob.perform_async(data)
+  ::Cas::Images::DeleteJob.perform_async(self.class.name, data)
 end

data/config/routes.rb CHANGED Viewed

@@ -1,8 +1,16 @@
 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"
+  if Shrine.respond_to?(:presign_endpoint)
+    mount Shrine.presign_endpoint(:cache) => "/files/cache/presign"
+  else
+    Rails.logger.info "Shrine's presign endpoint is disabled"
+  end
+  # TODO - fix
+  # mount Shrine.upload_endpoint(:cache) => "/files/upload"
   authenticate :user, ->(u){ u.roles.include?('admin') } do
     mount Sidekiq::Web => '/sidekiq'
@@ -14,6 +22,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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 ADDED Viewed

@@ -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 CHANGED Viewed

@@ -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 ADDED Viewed

@@ -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/remote_callbacks.rb CHANGED Viewed

@@ -9,9 +9,9 @@ module Cas
       #     big:    big_image
       #   }
       #
-      # `original` should always be present. If it is not, we will merge it
-      # afterwards automatically.
-      uploaded_image_versions: ->(io, context) {
+      # `original` should not be present after Shrine 3.0. If it is not, we will
+      # merge it afterwards automatically.
+      uploaded_image_versions: ->(original) {
         {}
       },

data/lib/cas/section_config.rb CHANGED Viewed

@@ -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 CHANGED Viewed

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

data/lib/cas.rb CHANGED Viewed

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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 CHANGED Viewed

@@ -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