gaco_cms 0.1.0

data/config/routes.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+Rails.application.routes.draw do
+  namespace :gaco_cms, path: GacoCms::Config.url_path do
+    namespace :admin do
+      get '/', to: 'base#index'
+      post 'upload_file', controller: 'base'
+      resources :page_types do
+        resources :pages
+      end
+      resources :field_groups_manager, only: %i[index update] do
+        get :group_tpl, on: :collection
+        get :field_tpl, on: :collection
+      end
+      resources :field_groups_renderer, only: :index do
+        get :render_group, on: :collection
+        get :render_field, on: :collection
+      end
+      resources :themes
+    end
+
+    # frontend
+    get '/', to: 'front#index'
+    get 'page/:page_id', as: 'page', to: 'front#page'
+  end
+end

data/db/migrate/20230202133738_create_cms_pages.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class CreateCmsPages < ActiveRecord::Migration[7.0]
+  def change
+    create_table GacoCms::Page.table_name do |t|
+      GacoCms.translated_column(t, :key)
+      GacoCms.translated_column(t, :title)
+      GacoCms.translated_column(t, :summary)
+      GacoCms.translated_column(t, :content)
+      t.text :template
+      t.text :photo_url
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20230202134840_create_cms_field_groups.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class CreateCmsFieldGroups < ActiveRecord::Migration[7.0]
+  def change
+    create_table GacoCms::FieldGroup.table_name do |t|
+      t.string :key
+      GacoCms.translated_column(t, :title)
+      GacoCms.translated_column(t, :description)
+      t.references :record, polymorphic: true
+      t.boolean :repeat, default: false
+      t.integer :position, default: 0
+      t.text :template, default: ''
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20230202135314_create_cms_fields.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class CreateCmsFields < ActiveRecord::Migration[7.0]
+  def change
+    create_table GacoCms::Field.table_name do |t|
+      t.string :key
+      GacoCms.translated_column(t, :title)
+      GacoCms.translated_column(t, :description)
+      t.belongs_to :field_group, null: false, foreign_key: { to_table: GacoCms::FieldGroup.table_name }
+      t.boolean :repeat, default: false
+      t.string :kind, default: 'text_field'
+      GacoCms.translated_column(t, :def_value)
+      t.boolean :required, default: false
+      t.boolean :translatable, default: false
+      t.integer :position, default: 0
+      GacoCms.translated_column(t, :data)
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20230202135739_create_cms_field_values.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class CreateCmsFieldValues < ActiveRecord::Migration[7.0]
+  def change
+    create_table GacoCms::FieldValue.table_name do |t|
+      t.belongs_to :field, null: false, foreign_key: { to_table: GacoCms::Field.table_name }
+      t.string :field_key
+      GacoCms.translated_column(t, :value)
+      t.integer :group_no, default: 0
+      t.integer :position, default: 0
+      t.references :record, polymorphic: true
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20230202181744_create_cms_media_files.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class CreateCmsMediaFiles < ActiveRecord::Migration[7.0]
+  def change
+    create_table GacoCms::MediaFile.table_name do |t|
+      t.string :name
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20230206231547_create_cms_page_types.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class CreateCmsPageTypes < ActiveRecord::Migration[7.0]
+  def change
+    create_table GacoCms::PageType.table_name do |t|
+      t.string :key, index: true, unique: true
+      GacoCms.translated_column(t, :title)
+      t.text :template, default: ''
+
+      t.timestamps
+    end
+
+    change_table GacoCms::Page.table_name do |t|
+      t.belongs_to :page_type, null: false, foreign_key: { to_table: GacoCms::PageType.table_name }
+    end
+
+    reversible do |dir|
+      dir.up do
+        GacoCms::PageType.create!(title: 'Pages', key: 'pages')
+      end
+    end
+  end
+end

data/db/migrate/20230209090008_create_cms_themes.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class CreateCmsThemes < ActiveRecord::Migration[7.0]
+  def change
+    create_table GacoCms::Theme.table_name do |t|
+      t.string :title, null: false
+      t.string :key, null: false, unique: true
+      t.boolean :active, default: false
+
+      t.timestamps
+    end
+
+    reversible do |dir|
+      dir.up do
+        GacoCms::Theme.create!(title: 'Default Theme', key: 'default', active: true)
+      end
+    end
+  end
+end

data/lib/gaco_cms/config.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module GacoCms
+  class Config
+    cattr_accessor(:url_path) { '/gaco_cms' }
+    cattr_accessor(:parent_front_controller) { 'ActionController::Base' }
+    cattr_accessor(:parent_backend_controller) { 'ActionController::Base' }
+    cattr_accessor(:front_layout) { ->(_controller) { theme_path_for('layouts/application') } }
+    cattr_accessor(:backend_editor_css) { ->(_view) { asset_path('application') } }
+    cattr_accessor(:table_prefix) { 'simple_cms_' } # TODO: rename into gaco_cms_
+    cattr_accessor(:locales) { %i[en de es] }
+    cattr_accessor(:extra_fields) { {} }
+
+    # @param settings [Hash<:tpl, :translatable, :label, :default_value_tpl?>]
+    def self.add_extra_field(key, settings)
+      extra_fields[key] = settings
+    end
+  end
+end

data/lib/gaco_cms/engine.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module GacoCms
+  class Engine < ::Rails::Engine
+    # isolate_namespace GacoCms # when enabled routes are not sharable
+
+    engine_dir = File.expand_path('../../', __dir__)
+    initializer 'gaco_cms.assets.precompile' do |app|
+      builds_path = File.join(engine_dir, 'app/assets/builds/')
+      if app.config.try(:assets)
+        app.config.assets.precompile += [
+          File.join(builds_path, 'gaco_cms.js'),
+          File.join(builds_path, 'gaco_cms.css'),
+          File.join(builds_path, 'gaco_cms_front.js'),
+          File.join(builds_path, 'gaco_cms_front.css')
+        ]
+      end
+
+      static_assets = File.join(engine_dir, 'vendor/static')
+      target_path = Rails.root.join('public/assets/gaco_cms')
+      unless Dir.exist?(target_path)
+        Rails.logger.info '********gaco_cms: copying static assets....'
+        FileUtils.mkpath(target_path) unless Dir.exist?(target_path)
+        FileUtils.cp_r(File.join(static_assets, '.'), target_path)
+
+        # puts '*********gaco_cms: copying compiled gaco_cms assets for importmaps'
+        FileUtils.cp_r(File.join(builds_path, '.'), app.root.join('public/assets/'))
+      end
+    end
+  end
+end

data/lib/gaco_cms/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GacoCms
+  VERSION = '0.1.0'
+end

data/lib/gaco_cms.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'gaco_cms/version'
+require 'gaco_cms/config'
+require 'gaco_cms/engine'
+require 'buddy_translatable'
+
+module GacoCms
+  def self.table_name_prefix
+    Config.table_prefix
+  end
+
+  def self.translated_column(t_migration, column, **args)
+    text_args = {}.merge(args)
+    json_args = { default: {} }.merge(args)
+    t_migration.respond_to?(:jsonb) ? (t_migration.jsonb column, **json_args) : (t_migration.text column, **text_args)
+  end
+end

data/lib/generators/gaco_cms/install_generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+module GacoCms
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../install_template', __FILE__)
+      desc 'This generator copies all basic settings for GacoCMS'
+
+      def create_initializer_file
+        copy_file 'gaco_cms.rb', 'config/initializers/gaco_cms.rb'
+        directory('themes', 'app/views/themes')
+      end
+    end
+  end
+end

data/lib/generators/gaco_cms/install_template/gaco_cms.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Gaco CMS settings
+GacoCms::Config.url_path = '/gaco_cms'
+GacoCms::Config.parent_front_controller = 'ActionController::Base'
+GacoCms::Config.parent_backend_controller = 'ActionController::Base'
+GacoCms::Config.front_layout = ->(_controller) { theme_path_for('layouts/application') }
+GacoCms::Config.backend_editor_css = ->(_view) { asset_path('application') }
+GacoCms::Config.table_prefix = 'gaco_cms_'
+GacoCms::Config.locales = [:en, :de, :es]
+# GacoCms::Config.add_extra_field(:my_field, { tpl: '..', label: 'My field', translatable: true })

data/lib/generators/gaco_cms/install_template/themes/default/index.html.haml

@@ -0,0 +1,2 @@
+%h1 Welcome to GacoCms
+= raw GacoCms::Page.by_key(:home).the_content

data/lib/generators/gaco_cms/install_template/themes/default/layouts/application.html.haml

@@ -0,0 +1,34 @@
+!!!
+%html
+  %head
+    = display_meta_tags site: 'Gaco CMS'
+    %meta{:content => "text/html; charset=UTF-8", "http-equiv" => "Content-Type"}/
+    %meta{:content => "width=device-width,initial-scale=1", :name => "viewport"}/
+    = csrf_meta_tags
+    = csp_meta_tag
+    = stylesheet_link_tag 'gaco_cms_front'
+    = javascript_include_tag 'gaco_cms_front'
+
+  %body#body
+    %nav.navbar.navbar-expand-lg.shadow.text-white
+      .container
+        %a.navbar-brand.logo.p-0.d-flex{href: gaco_cms_path, style: 'font-size: 32px;'}
+          %span.text-black Gaco
+          %span.text-primary CMS
+        %button.navbar-toggler{"aria-controls" => "navbarSupportedContent", "aria-expanded" => "false", "aria-label" => "Toggle navigation", "data-bs-target" => "#main_nav_bar", "data-bs-toggle" => "collapse", :type => "button"}
+          %span.fa.fa-bars
+
+        #main_nav_bar.collapse.navbar-collapse.justify-content-end.text-white-50
+          %ul.navbar-nav
+            - GacoCms::PageType.find_by(key: :pages).pages.each do |page|
+              %li.nav-item
+                %a.nav-link{href: page_url_for(page.key)}= page.title
+            %li.nav-item
+              .dropdown
+                %a.btn.dropdown-toggle{"data-bs-toggle" => "dropdown", role: "button"}= I18n.locale.to_s.upcase
+                %ul.dropdown-menu
+                  - GacoCms::Config.locales.each do |locale|
+                    %li= link_to locale.upcase, url_for(locale: locale, params: request.query_parameters.except(:locale)), class: 'dropdown-item'
+
+    #container.container.pt-3
+      = yield

data/lib/generators/gaco_cms/install_template/themes/default/page.html.haml

@@ -0,0 +1,2 @@
+%h1= @page.title
+= raw @page.the_content

data/lib/tasks/auto_annotate_models.rake

@@ -0,0 +1,59 @@
+# NOTE: only doing this in development as some production environments (Heroku)
+# NOTE: are sensitive to local FS writes, and besides -- it's just not proper
+# NOTE: to have a dev-mode tool do its thing in production.
+if Rails.env.test?
+  require 'annotate'
+  task :set_annotation_options do
+    # You can override any of these by setting an environment variable of the
+    # same name.
+    Annotate.set_defaults(
+      'active_admin'                => 'false',
+      'additional_file_patterns'    => [],
+      'routes'                      => 'false',
+      'models'                      => 'true',
+      'position_in_routes'          => 'before',
+      'position_in_class'           => 'before',
+      'position_in_test'            => 'before',
+      'position_in_fixture'         => 'before',
+      'position_in_factory'         => 'before',
+      'position_in_serializer'      => 'before',
+      'show_foreign_keys'           => 'true',
+      'show_complete_foreign_keys'  => 'false',
+      'show_indexes'                => 'true',
+      'simple_indexes'              => 'false',
+      'model_dir'                   => 'app/models',
+      'root_dir'                    => '',
+      'include_version'             => 'false',
+      'require'                     => '',
+      'exclude_tests'               => 'true',
+      'exclude_fixtures'            => 'true',
+      'exclude_factories'           => 'true',
+      'exclude_serializers'         => 'true',
+      'exclude_scaffolds'           => 'true',
+      'exclude_controllers'         => 'true',
+      'exclude_helpers'             => 'true',
+      'exclude_sti_subclasses'      => 'false',
+      'ignore_model_sub_dir'        => 'false',
+      'ignore_columns'              => nil,
+      'ignore_routes'               => nil,
+      'ignore_unknown_models'       => 'false',
+      'hide_limit_column_types'     => 'integer,bigint,boolean',
+      'hide_default_column_types'   => 'json,jsonb,hstore',
+      'skip_on_db_migrate'          => 'false',
+      'format_bare'                 => 'true',
+      'format_rdoc'                 => 'false',
+      'format_yard'                 => 'false',
+      'format_markdown'             => 'false',
+      'sort'                        => 'false',
+      'force'                       => 'false',
+      'frozen'                      => 'false',
+      'classified_sort'             => 'true',
+      'trace'                       => 'false',
+      'wrapper_open'                => nil,
+      'wrapper_close'               => nil,
+      'with_comment'                => 'true'
+    )
+  end
+
+  Annotate.load_tasks
+end

data/lib/tasks/gaco_cms_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :gaco_cms do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: gaco_cms
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Owen Peredo Diaz
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: buddy_translatable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A lightweight Ruby on Rails cms suitable for any Rails application
+email:
+- owenperedo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/assets/builds/gaco_cms.css
+- app/assets/builds/gaco_cms.js
+- app/assets/builds/gaco_cms.js.map
+- app/assets/builds/gaco_cms_front.css
+- app/assets/builds/gaco_cms_front.js
+- app/assets/builds/gaco_cms_front.js.map
+- app/assets/javascripts/gaco_cms.js
+- app/assets/javascripts/gaco_cms/base.js
+- app/assets/javascripts/gaco_cms/controllers/confirm_controller.ts
+- app/assets/javascripts/gaco_cms/controllers/deletable_row_controller.ts
+- app/assets/javascripts/gaco_cms/controllers/editor_controller.ts
+- app/assets/javascripts/gaco_cms/controllers/file_input_controller.ts
+- app/assets/javascripts/gaco_cms/controllers/modal_controller.ts
+- app/assets/javascripts/gaco_cms/controllers/remote_content_controller.ts
+- app/assets/javascripts/gaco_cms/controllers/repeatable_field_controller.ts
+- app/assets/javascripts/gaco_cms/controllers/sortable_controller.ts
+- app/assets/javascripts/gaco_cms/controllers/toggle_field_controller.ts
+- app/assets/javascripts/gaco_cms/controllers/translatable_controller.ts
+- app/assets/javascripts/gaco_cms/lib/progress_bar.ts
+- app/assets/javascripts/gaco_cms/lib/request.ts
+- app/assets/javascripts/gaco_cms/lib/turbo_request.ts
+- app/assets/javascripts/gaco_cms/stimulus.ts
+- app/assets/javascripts/gaco_cms_front.js
+- app/assets/stylesheets/gaco_cms.css.scss
+- app/assets/stylesheets/gaco_cms/bootstrap_custom.scss
+- app/assets/stylesheets/gaco_cms/shared.scss
+- app/assets/stylesheets/gaco_cms_front.css.scss
+- app/controllers/concerns/gaco_cms/turbo_concern.rb
+- app/controllers/gaco_cms/admin/base_controller.rb
+- app/controllers/gaco_cms/admin/field_groups_controller.rb
+- app/controllers/gaco_cms/admin/field_groups_manager_controller.rb
+- app/controllers/gaco_cms/admin/field_groups_renderer_controller.rb
+- app/controllers/gaco_cms/admin/fields_controller.rb
+- app/controllers/gaco_cms/admin/page_types_controller.rb
+- app/controllers/gaco_cms/admin/pages_controller.rb
+- app/controllers/gaco_cms/admin/themes_controller.rb
+- app/controllers/gaco_cms/admin_controller.rb
+- app/controllers/gaco_cms/front_controller.rb
+- app/helpers/gaco_cms/application_helper.rb
+- app/jobs/gaco_cms/application_job.rb
+- app/mailers/gaco_cms/application_mailer.rb
+- app/models/concerns/gaco_cms/fields_assignable.rb
+- app/models/concerns/gaco_cms/union_scope.rb
+- app/models/gaco_cms/application_record.rb
+- app/models/gaco_cms/draft_record.rb
+- app/models/gaco_cms/field.rb
+- app/models/gaco_cms/field_group.rb
+- app/models/gaco_cms/field_value.rb
+- app/models/gaco_cms/media_file.rb
+- app/models/gaco_cms/page.rb
+- app/models/gaco_cms/page_type.rb
+- app/models/gaco_cms/theme.rb
+- app/services/gaco_cms/application_service.rb
+- app/services/gaco_cms/shortcode_parser.rb
+- app/services/gaco_cms/theme_content_generator.rb
+- app/views/gaco_cms/admin/base/index.html.haml
+- app/views/gaco_cms/admin/field_groups_manager/_field.html.haml
+- app/views/gaco_cms/admin/field_groups_manager/_group.html.haml
+- app/views/gaco_cms/admin/field_groups_manager/index.html.haml
+- app/views/gaco_cms/admin/field_groups_renderer/_field.html.haml
+- app/views/gaco_cms/admin/field_groups_renderer/_fields_frame.html.haml
+- app/views/gaco_cms/admin/field_groups_renderer/_group.html.haml
+- app/views/gaco_cms/admin/field_groups_renderer/default_value/_page.html.haml
+- app/views/gaco_cms/admin/field_groups_renderer/fields/_editor.html.haml
+- app/views/gaco_cms/admin/field_groups_renderer/fields/_file.html.haml
+- app/views/gaco_cms/admin/field_groups_renderer/fields/_page.html.haml
+- app/views/gaco_cms/admin/field_groups_renderer/fields/_text_area.html.haml
+- app/views/gaco_cms/admin/field_groups_renderer/fields/_text_field.html.haml
+- app/views/gaco_cms/admin/field_groups_renderer/index.html.haml
+- app/views/gaco_cms/admin/page_types/form.html.haml
+- app/views/gaco_cms/admin/page_types/index.html.haml
+- app/views/gaco_cms/admin/pages/edit.html.haml
+- app/views/gaco_cms/admin/pages/index.html.haml
+- app/views/gaco_cms/admin/pages/new.html.haml
+- app/views/gaco_cms/admin/themes/edit.html.haml
+- app/views/gaco_cms/admin/themes/index.html.haml
+- app/views/gaco_cms/admin/themes/new.html.haml
+- app/views/layouts/gaco_cms/_breadcrumb.html.haml
+- app/views/layouts/gaco_cms/_flash_messages.html.haml
+- app/views/layouts/gaco_cms/admin.haml
+- config/routes.rb
+- db/migrate/20230202133738_create_cms_pages.rb
+- db/migrate/20230202134840_create_cms_field_groups.rb
+- db/migrate/20230202135314_create_cms_fields.rb
+- db/migrate/20230202135739_create_cms_field_values.rb
+- db/migrate/20230202181744_create_cms_media_files.rb
+- db/migrate/20230206231547_create_cms_page_types.rb
+- db/migrate/20230209090008_create_cms_themes.rb
+- lib/gaco_cms.rb
+- lib/gaco_cms/config.rb
+- lib/gaco_cms/engine.rb
+- lib/gaco_cms/version.rb
+- lib/generators/gaco_cms/install_generator.rb
+- lib/generators/gaco_cms/install_template/gaco_cms.rb
+- lib/generators/gaco_cms/install_template/themes/default/index.html.haml
+- lib/generators/gaco_cms/install_template/themes/default/layouts/application.html.haml
+- lib/generators/gaco_cms/install_template/themes/default/page.html.haml
+- lib/tasks/auto_annotate_models.rake
+- lib/tasks/gaco_cms_tasks.rake
+homepage: https://github.com/owen2345/gaco_cms
+licenses: []
+metadata:
+  homepage_uri: https://github.com/owen2345/gaco_cms
+  source_code_uri: https://github.com/owen2345/gaco_cms
+  changelog_uri: https://github.com/owen2345/gaco_cms/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: A lightweight Ruby on Rails cms suitable for any Rails application
+test_files: []