lc_alchemy_cms 3.2.0

data/lib/rails/generators/alchemy/install/install_generator.rb

@@ -0,0 +1,69 @@
+require 'rails'
+
+module Alchemy
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+
+      desc "Installs Alchemy into your App."
+
+      class_option :skip_demo_files,
+        type: :boolean,
+        default: false,
+        desc: "Skip creation of demo element, page and application layout."
+
+      source_root File.expand_path('files', File.dirname(__FILE__))
+
+      def create_view_dirs
+        %w(elements page_layouts).each do |dir|
+          empty_directory Rails.root.join("app/views/alchemy/#{dir}")
+        end
+      end
+
+      def copy_config
+        copy_file "#{config_path}/config.yml",
+          Rails.root.join("config/alchemy/config.yml")
+      end
+
+      def copy_yml_files
+        %w(elements page_layouts).each do |file|
+          template "#{current_path}/templates/#{file}.yml.tt",
+            Rails.root.join("config/alchemy/#{file}.yml")
+        end
+      end
+
+      def copy_demo_views
+        return if @options[:skip_demo_files]
+
+        copy_file "application.html.erb",
+          Rails.root.join("app/views/layouts/application.html.erb")
+        copy_file "alchemy.elements.css.scss",
+          Rails.root.join("app/assets/stylesheets/alchemy.elements.css.scss")
+
+        [
+          "_article_editor.html.erb",
+          "_article_view.html.erb"
+        ].each do |file|
+          copy_file file, Rails.root.join("app/views/alchemy/elements/#{file}")
+        end
+
+        copy_file "_standard.html.erb",
+          Rails.root.join("app/views/alchemy/page_layouts/_standard.html.erb")
+
+        %w(de en es).each do |locale|
+          copy_file "alchemy.#{locale}.yml",
+            Rails.root.join("config/locales/alchemy.#{locale}.yml")
+        end
+      end
+
+      private
+
+      def config_path
+        @_config_path ||= File.expand_path('../../../../../config/alchemy', current_path)
+      end
+
+      def current_path
+        @_current_path ||= File.dirname(__FILE__)
+      end
+    end
+  end
+end

data/lib/rails/generators/alchemy/install/templates/elements.yml.tt

@@ -0,0 +1,21 @@
+# == In this configuration you setup Alchemy´s element layouts.
+#
+# For further informations please see http://guides.alchemy-cms.com/create_elements.html
+
+<%- unless @options[:skip_demo_files] -%>
+- name: article
+  hint: true
+  unique: true
+  contents:
+  - name: headline
+    type: EssenceText
+    default: :article_headline
+    hint: true
+  - name: picture
+    type: EssencePicture
+    hint: true
+  - name: text
+    type: EssenceRichtext
+    default: :article_text
+    hint: true
+<%- end -%>

data/lib/rails/generators/alchemy/install/templates/page_layouts.yml.tt

@@ -0,0 +1,10 @@
+# == This file defines the page layouts for new pages.
+#
+# For further informations please see http://guides.alchemy-cms.com/create_page_layouts.html
+
+<%- unless @options[:skip_demo_files] -%>
+- name: <%= Alchemy::Config.get(:default_language)['page_layout'] %>
+  unique: true
+  elements: [article]
+  autogenerate: [article]
+<%- end -%>

data/lib/rails/generators/alchemy/module/module_generator.rb

@@ -0,0 +1,30 @@
+require 'rails'
+
+module Alchemy
+  module Generators
+    class ModuleGenerator < ::Rails::Generators::Base
+      desc "This generator generates an Alchemy module for you."
+      argument :module_name, :banner => "your_module_name"
+      source_root File.expand_path('templates', File.dirname(__FILE__))
+
+      def init
+        @module_name = module_name.downcase
+        @class_name = @module_name.singularize.classify
+        @controller_name = @module_name.tableize
+        @controller_class = @controller_name.classify.pluralize
+      end
+
+      def make_route
+        route "namespace :admin do\n    resources :#{@controller_name}\n  end"
+      end
+
+      def copy_templates
+        empty_directory Rails.root.join("app/controllers/admin")
+
+        template "controller.rb.tt", Rails.root.join("app/controllers/admin/#{@controller_name}_controller.rb")
+        template "ability.rb.tt", Rails.root.join('app/models', "alchemy_#{@module_name}_ability.rb")
+        template "module_config.rb.tt", Rails.root.join("config/initializers/alchemy_#{@module_name}.rb")
+      end
+    end
+  end
+end

data/lib/rails/generators/alchemy/module/templates/ability.rb.tt

@@ -0,0 +1,11 @@
+class <%= @class_name %>Ability
+  include CanCan::Ability
+
+  def initialize(user)
+    if user.present? && user.is_admin?
+      can :manage, <%= @class_name %>
+      can :manage, :admin_<%= @controller_name %>
+    end
+  end
+
+end

data/lib/rails/generators/alchemy/module/templates/controller.rb.tt

@@ -0,0 +1,2 @@
+class Admin::<%= @controller_class %>Controller < Alchemy::Admin::ResourcesController
+end

data/lib/rails/generators/alchemy/module/templates/module_config.rb.tt

@@ -0,0 +1,17 @@
+Alchemy::Modules.register_module({
+  name: '<%= @module_name %>',
+  order: 1,
+  navigation: {
+    name: 'modules.<%= @module_name %>',
+    controller: '/admin/<%= @module_name %>',
+    action: 'index',
+    image: 'alchemy/<%= @module_name %>_module.png',
+    sub_navigation: [{
+      name: 'modules.<%= @module_name %>',
+      controller: '/admin/<%= @module_name %>',
+      action: 'index'
+    }]
+  }
+})
+
+Alchemy.register_ability(<%= @class_name %>Ability)

data/lib/rails/generators/alchemy/page_layouts/page_layouts_generator.rb

@@ -0,0 +1,24 @@
+require File.join(__FILE__, '../../base')
+
+module Alchemy
+  module Generators
+    class PageLayoutsGenerator < Base
+      desc "This generator generates your page_layouts view partials."
+      source_root File.expand_path('templates', File.dirname(__FILE__))
+
+      def create_directory
+        @page_layouts_dir = "#{Rails.root}/app/views/alchemy/page_layouts"
+        empty_directory @page_layouts_dir
+      end
+
+      def create_partials
+        @page_layouts = load_alchemy_yaml('page_layouts.yml')
+        @page_layouts.each do |page_layout|
+          next if page_layout['redirects_to_external']
+          @page_layout_name = page_layout["name"].underscore
+          conditional_template "layout.html.#{template_engine}", "#{@page_layouts_dir}/_#{@page_layout_name}.html.#{template_engine}"
+        end if @page_layouts
+      end
+    end
+  end
+end

data/lib/rails/generators/alchemy/page_layouts/templates/layout.html.erb

@@ -0,0 +1 @@
+<%%= render_elements %>

data/lib/rails/generators/alchemy/page_layouts/templates/layout.html.haml

@@ -0,0 +1 @@
+= render_elements

data/lib/rails/generators/alchemy/page_layouts/templates/layout.html.slim

@@ -0,0 +1 @@
+= render_elements

data/lib/rails/generators/alchemy/site_layouts/site_layouts_generator.rb

@@ -0,0 +1,23 @@
+require File.join(__FILE__, '../../base')
+
+module Alchemy
+  module Generators
+    class SiteLayoutsGenerator < Base
+      desc "This generator generates your site layouts view partials."
+      source_root File.expand_path('templates', File.dirname(__FILE__))
+
+      def create_directory
+        @site_layouts_dir = "#{Rails.root}/app/views/alchemy/site_layouts"
+        empty_directory @site_layouts_dir
+      end
+
+      def create_partials
+        @sites = Alchemy::Site.all
+        @sites.each do |site|
+          @site_name = site.name.parameterize.underscore
+          conditional_template "layout.html.#{template_engine}", "#{@site_layouts_dir}/_#{@site_name}.html.#{template_engine}"
+        end if @sites
+      end
+    end
+  end
+end

data/lib/rails/generators/alchemy/site_layouts/templates/layout.html.erb

@@ -0,0 +1 @@
+<%%= yield %>

data/lib/rails/generators/alchemy/site_layouts/templates/layout.html.haml

@@ -0,0 +1 @@
+= yield

data/lib/rails/generators/alchemy/site_layouts/templates/layout.html.slim

@@ -0,0 +1 @@
+= yield

data/lib/rails/generators/alchemy/views/views_generator.rb

@@ -0,0 +1,41 @@
+require 'rails'
+
+module Alchemy
+  module Generators
+    class ViewsGenerator < ::Rails::Generators::Base
+      ALCHEMY_VIEWS = %w(breadcrumb language_links messages navigation)
+
+      desc "Generates Alchemy views for #{ALCHEMY_VIEWS.to_sentence}."
+
+      class_option :only,
+        type: :array,
+        default: nil,
+        desc: "List of views to copy. Available views are #{ALCHEMY_VIEWS.to_sentence}."
+
+      class_option :except,
+        type: :array,
+        default: nil,
+        desc: "List of views not to copy. Available views are #{ALCHEMY_VIEWS.to_sentence}."
+
+      source_root File.expand_path("../../../../../app/views/alchemy", File.dirname(__FILE__))
+
+      def copy_alchemy_views
+        views_to_copy.each do |dir|
+          directory dir, Rails.root.join('app/views/alchemy', dir)
+        end
+      end
+
+      private
+
+      def views_to_copy
+        if @options['except']
+          ALCHEMY_VIEWS - @options['except']
+        elsif @options['only']
+          ALCHEMY_VIEWS.select { |v| @options['only'].include?(v) }
+        else
+          ALCHEMY_VIEWS
+        end
+      end
+    end
+  end
+end

data/lib/rails/templates/alchemy.rb

@@ -0,0 +1,7 @@
+# This rails template installs Alchemy and all depending gems.
+require File.expand_path("../../../alchemy/version", __FILE__)
+
+gem "alchemy_cms",    github: "AlchemyCMS/alchemy_cms",    branch: "3.2-stable"
+gem "alchemy-devise", github: "AlchemyCMS/alchemy-devise", branch: "3.2-stable"
+
+gem "capistrano-alchemy", github: "AlchemyCMS/capistrano-alchemy", branch: "master", group: "development"

data/lib/tasks/alchemy/convert.rake

@@ -0,0 +1,39 @@
+namespace :alchemy do
+  namespace :convert do
+
+    namespace :urlnames do
+
+      desc "Converts the urlname of all pages to nested url paths."
+      task :to_nested => [:environment] do
+        unless Alchemy::Config.get(:url_nesting)
+          raise "\nURL nesting is disabled! Please enable url_nesting in `config/alchemy/config.yml` first.\n\n"
+        end
+        puts "Converting..."
+        pages = Alchemy::Page.contentpages
+        count = pages.count
+        pages.each_with_index do |page, n|
+          puts "Updating page #{n+1} of #{count}"
+          page.update_urlname!
+        end
+        puts "Done."
+      end
+
+      desc "Converts the urlname of all pages to contain the slug only."
+      task :to_slug => [:environment] do
+        if Alchemy::Config.get(:url_nesting)
+          raise "\nURL nesting is enabled! Please disable url_nesting in `config/alchemy/config.yml` first.\n\n"
+        end
+        puts "Converting..."
+        pages = Alchemy::Page.contentpages
+        count = pages.count
+        pages.each_with_index do |page, n|
+          puts "Updating page #{n+1} of #{count}"
+          page.update_attribute :urlname, page.slug
+        end
+        puts "Done."
+      end
+
+    end
+
+  end
+end

data/lib/tasks/alchemy/db.rake

@@ -0,0 +1,22 @@
+require 'shellwords'
+require 'alchemy/tasks/helpers'
+include Alchemy::Tasks::Helpers
+
+namespace :alchemy do
+  namespace :db do
+
+    desc "Dumps the database to STDOUT (Pass DUMP_FILENAME to store the dump into a file)."
+    task :dump => :environment do
+      dump_store = ENV['DUMP_FILENAME'] ? " > #{ENV['DUMP_FILENAME']}" : ""
+      dump_cmd = database_dump_command(database_config['adapter'])
+      system "#{dump_cmd}#{dump_store}"
+    end
+
+    desc "Imports the database from STDIN (Pass DUMP_FILENAME to read the dump from file)."
+    task :import => :environment do
+      dump_store = ENV['DUMP_FILENAME'] ? "cat #{ENV['DUMP_FILENAME']}" : "echo #{Shellwords.escape(STDIN.read)}"
+      import_cmd = database_import_command(database_config['adapter'])
+      system "#{dump_store} | #{import_cmd}"
+    end
+  end
+end

data/lib/tasks/alchemy/install.rake

@@ -0,0 +1,61 @@
+require 'thor'
+
+class Alchemy::InstallTask < Thor
+  include Thor::Actions
+
+  no_tasks do
+    def inject_routes
+      mountpoint = ask "\nAt which path do you want to mount Alchemy CMS at? (DEFAULT: At root path '/')"
+      mountpoint = "/" if mountpoint.empty?
+      sentinel = /\.routes\.draw do(?:\s*\|map\|)?\s*$/
+      inject_into_file "./config/routes.rb", "\n  mount Alchemy::Engine => '#{mountpoint}'\n", { after: sentinel, verbose: true }
+    end
+
+    def set_primary_language
+      code = ask "\nWhat's the language code of your site's primary language? (DEFAULT: en)"
+      code = "en" if code.empty?
+      name = ask "What's the name of your site's primary language? (DEFAULT: English)"
+      name = "English" if name.empty?
+      gsub_file "./config/alchemy/config.yml", /default_language:\n\s\scode:\sen\n\s\sname:\sEnglish/m do |match|
+        match = "default_language:\n  code: #{code}\n  name: #{name}"
+      end
+    end
+
+    def inject_seeder
+      append_file "./db/seeds.rb", "Alchemy::Seeder.seed!\n"
+    end
+  end
+end
+
+namespace :alchemy do
+
+  desc "Installs Alchemy CMS into your app."
+  task :install do
+    install_helper = Alchemy::InstallTask.new
+
+    unless ENV['from_binary']
+      puts "\nAlchemy Installer"
+      puts "-----------------"
+    end
+    Rake::Task["alchemy:mount"].invoke
+    system("rails g alchemy:install#{ ENV['from_binary'] ? ' --force' : '' }") || exit!(1)
+    install_helper.set_primary_language
+    Rake::Task["db:create"].invoke
+    # We can't invoke this rake task, because Rails will use wrong engine names otherwise
+    `bundle exec rake railties:install:migrations`
+    Rake::Task["db:migrate"].invoke
+    install_helper.inject_seeder
+    Rake::Task["db:seed"].invoke
+    unless ENV['from_binary']
+      puts "\nAlchemy successfully installed."
+      puts "\nNow start the server with:"
+      puts "\n$ bin/rails server"
+      puts "\nand point your browser to http://localhost:3000/admin and follow the onscreen instructions to finalize the installation."
+    end
+  end
+
+  desc "Mounts Alchemy into your routes."
+  task :mount do
+    Alchemy::InstallTask.new.inject_routes
+  end
+end

data/lib/tasks/alchemy/tidy.rake

@@ -0,0 +1,102 @@
+require 'alchemy/shell'
+
+namespace :alchemy do
+  namespace :tidy do
+
+    desc "Tidy up Alchemy database."
+    task :up do
+      Rake::Task['alchemy:tidy:cells'].invoke
+      Rake::Task['alchemy:tidy:element_positions'].invoke
+      Rake::Task['alchemy:tidy:content_positions'].invoke
+    end
+
+    desc "Creates missing cells for pages."
+    task :cells => :environment do
+      if !File.exist? Rails.root.join('config/alchemy/cells.yml')
+        puts "No page cell definitions found."
+      else
+        cells = Alchemy::Cell.definitions
+        page_layouts = Alchemy::PageLayout.all
+        if cells && page_layouts
+          Alchemy::Tidy.create_missing_cells(page_layouts, cells)
+        else
+          puts "No page layouts or cell definitions found."
+        end
+      end
+    end
+
+    desc "Fixes element positions."
+    task :element_positions => [:environment] do
+      Alchemy::Tidy.update_element_positions
+    end
+
+    desc "Fixes content positions."
+    task :content_positions => [:environment] do
+      Alchemy::Tidy.update_content_positions
+    end
+  end
+end
+
+module Alchemy
+  class Tidy
+    extend Shell
+
+    def self.create_missing_cells(page_layouts, cells)
+      page_layouts.each do |layout|
+        next if layout['cells'].blank?
+        cells_for_layout = cells.select { |cell| layout['cells'].include? cell['name'] }
+        Alchemy::Page.where(page_layout: layout['name']).each do |page|
+          cells_for_layout.each do |cell_for_layout|
+            cell = Alchemy::Cell.find_or_initialize_by(name: cell_for_layout['name'], page_id: page.id)
+            cell.elements << page.elements.select { |element| cell_for_layout['elements'].include?(element.name) }
+            if cell.new_record?
+              cell.save
+              log "Creating cell #{cell.name} for page #{page.name}"
+            else
+              log "Cell #{cell.name} for page #{page.name} already present", :skip
+            end
+          end
+        end
+      end
+    end
+
+    def self.update_element_positions
+      Alchemy::Page.all.each do |page|
+        if page.elements.any?
+          puts "\n## Updating element positions of page `#{page.name}`"
+        end
+        page.elements.group_by(&:cell_id).each do |cell_id, elements|
+          elements.each_with_index do |element, idx|
+            position = idx + 1
+            if element.position != position
+              log "Updating position for element ##{element.id} to #{position}"
+              element.update_column(:position, position)
+            else
+              log "Position for element ##{element.id} is already correct (#{position})", :skip
+            end
+          end
+        end
+      end
+    end
+
+    def self.update_content_positions
+      Alchemy::Element.all.each do |element|
+        if element.contents.any?
+          puts "\n## Updating content positions of element `#{element.name}`"
+        end
+        element.contents.group_by(&:essence_type).each do |essence_type, contents|
+          puts "-> Contents of type `#{essence_type}`"
+          contents.each_with_index do |content, idx|
+            position = idx + 1
+            if content.position != position
+              log "Updating position for content ##{content.id} to #{position}"
+              content.update_column(:position, position)
+            else
+              log "Position for content ##{content.id} is already correct (#{position})", :skip
+            end
+          end
+        end
+      end
+    end
+  end
+end