locomotivecms_mounter_pull_19 1.5.4

data/lib/locomotive/mounter/writer/file_system/content_assets_writer.rb

@@ -0,0 +1,38 @@
+module Locomotive
+  module Mounter
+    module Writer
+      module FileSystem
+
+        class ContentAssetsWriter < Base
+
+          # It creates the content assets folder
+          def prepare
+            super
+            self.create_folder 'public'
+          end
+
+          # It writes all the content assets into files
+          def write
+            self.mounting_point.content_assets.each do |_, asset|
+              self.output_resource_op asset
+
+              self.open_file(self.target_asset_path(asset), 'wb') do |file|
+                file.write(asset.content)
+              end
+
+              self.output_resource_op_status asset
+            end
+          end
+
+          protected
+
+          def target_asset_path(asset)
+            File.join('public', asset.folder, asset.filename)
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/locomotive/mounter/writer/file_system/content_entries_writer.rb

@@ -0,0 +1,33 @@
+module Locomotive
+  module Mounter
+    module Writer
+      module FileSystem
+
+        class ContentEntriesWriter < Base
+
+          # It creates the data folder
+          def prepare
+            super
+            self.create_folder 'data'
+          end
+
+          # It writes all the content types into files
+          def write
+            self.mounting_point.content_types.each do |filename, content_type|
+              self.output_resource_op content_type
+
+              entries = (content_type.entries || []).map(&:to_hash)
+
+              self.open_file("data/#{filename}.yml") do |file|
+                file.write(entries.to_yaml)
+              end
+
+              self.output_resource_op_status content_type
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/locomotive/mounter/writer/file_system/content_types_writer.rb

@@ -0,0 +1,32 @@
+module Locomotive
+  module Mounter
+    module Writer
+      module FileSystem
+
+        class ContentTypesWriter < Base
+
+          # It creates the content types folder
+          def prepare
+            super
+            self.create_folder 'app/content_types'
+          end
+
+          # It writes all the content types into files
+          def write
+            self.mounting_point.content_types.each do |filename, content_type|
+              self.output_resource_op content_type
+
+              self.open_file("app/content_types/#{filename}.yml") do |file|
+                file.write(content_type.to_yaml)
+              end
+
+              self.output_resource_op_status content_type
+            end
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/locomotive/mounter/writer/file_system/pages_writer.rb

@@ -0,0 +1,93 @@
+module Locomotive
+  module Mounter
+    module Writer
+      module FileSystem
+
+        class PagesWriter < Base
+
+          # It creates the pages folder
+          def prepare
+            super
+            self.create_folder 'app/views/pages'
+          end
+
+          # It writes all the pages into files
+          def write
+            self.write_page(self.mounting_point.pages['index'])
+
+            self.write_page(self.mounting_point.pages['404'])
+          end
+
+          protected
+
+          # Write the information about a page into the filesystem.
+          # Called itself recursively. Called at first by the write method
+          #
+          # @param [ Object ] page The page
+          # @param [ String ] path The parent path
+          #
+          def write_page(page, path = '')
+            self.output_resource_op page
+
+            # Note: we assume the current locale is the default one
+            page.translated_in.each do |locale|
+              default_locale = locale.to_sym == self.mounting_point.default_locale.to_sym
+
+              # we do not need the localized version of the filepath
+              filepath = page.fullpath.dasherize
+
+              Locomotive::Mounter.with_locale(locale) do
+                # we assume the filepath is already localized
+                self.write_page_to_fs(page, filepath, default_locale ? nil : locale)
+              end
+            end
+
+            self.output_resource_op_status page
+
+            # also write the nested pages
+            (page.children || []).each do |child|
+              self.write_page(child, page.depth == 0 ? '' : page.slug)
+            end
+          end
+
+          # Write into the filesystem the file about the page which will store
+          # information about this page + template.
+          # The file is localized meaning a same page could generate a file for each translation.
+          #
+          # @param [ Object ] page The page
+          # @param [ String ] filepath The path to the file describing the page (not localized)
+          # @param [ Locale ] locale The locale, nil if default locale
+          #
+          #
+          def write_page_to_fs(page, filepath, locale)
+            # puts filepath.inspect
+            _filepath = "#{filepath}.liquid"
+            _filepath.gsub!(/.liquid$/, ".#{locale}.liquid") if locale
+
+            _filepath = File.join('app', 'views', 'pages', _filepath)
+
+            self.replace_content_asset_urls(page.source)
+
+            self.open_file(_filepath) do |file|
+              file.write(page.to_yaml)
+            end
+          end
+
+          # The content assets on the remote engine follows the format: /sites/<id>/assets/<type>/<file>
+          # This method replaces these urls by their local representation. <type>/<file>
+          #
+          # @param [ String ] content The text where the assets will be replaced.
+          #
+          def replace_content_asset_urls(content)
+            return if content.blank?
+            content.force_encoding('utf-8').gsub!(/[("']\/sites\/[0-9a-f]{24}\/assets\/(([^;.]+)\/)*([a-zA-Z_\-0-9]+)\.[a-z]{2,3}[)"']/) do |path|
+              "/#{$3}"
+            end
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/locomotive/mounter/writer/file_system/site_writer.rb

@@ -0,0 +1,30 @@
+module Locomotive
+  module Mounter
+    module Writer
+      module FileSystem
+
+        class SiteWriter < Base
+
+          # It creates the config folder
+          def prepare
+            super
+            self.create_folder 'config'
+          end
+
+          # It fills the config/site.yml file
+          def write
+            self.open_file('config/site.yml') do |file|
+              self.output_resource_op self.mounting_point.site
+
+              file.write(self.mounting_point.site.to_yaml)
+
+              self.output_resource_op_status self.mounting_point.site
+            end
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/locomotive/mounter/writer/file_system/snippets_writer.rb

@@ -0,0 +1,59 @@
+module Locomotive
+  module Mounter
+    module Writer
+      module FileSystem
+
+        class SnippetsWriter < Base
+
+          # It creates the snippets folder
+          def prepare
+            super
+            self.create_folder 'app/views/snippets'
+          end
+
+          # It writes all the snippets into files
+          def write
+            self.mounting_point.snippets.each do |filepath, snippet|
+              self.output_resource_op snippet
+
+              # Note: we assume the current locale is the default one
+              snippet.translated_in.each do |locale|
+                default_locale = locale.to_sym == self.mounting_point.default_locale.to_sym
+
+                Locomotive::Mounter.with_locale(locale) do
+                  self.write_snippet_to_fs(snippet, filepath, default_locale ? nil : locale)
+                end
+              end
+
+              self.output_resource_op_status snippet
+            end
+          end
+
+          protected
+
+          # Write into the filesystem the file which stores the snippet template
+          # The file is localized meaning a same snippet could generate a file for each translation.
+          #
+          # @param [ Object ] snippet The snippet
+          # @param [ String ] filepath The path to the file
+          # @param [ Locale ] locale The locale, nil if default locale
+          #
+          def write_snippet_to_fs(snippet, filepath, locale)
+            _filepath = "#{filepath}.liquid"
+            _filepath.gsub!(/.liquid$/, ".#{locale}.liquid") if locale
+
+            unless snippet.template.blank?
+              _filepath = File.join('app', 'views', 'snippets', _filepath)
+
+              self.open_file(_filepath) do |file|
+                file.write(snippet.source)
+              end
+            end
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/locomotive/mounter/writer/file_system/theme_assets_writer.rb

@@ -0,0 +1,72 @@
+module Locomotive
+  module Mounter
+    module Writer
+      module FileSystem
+
+        class ThemeAssetsWriter < Base
+
+          # Create the theme assets folders
+          #
+          def prepare
+            super
+            self.create_folder 'public'
+          end
+
+          # Write all the snippets into files
+          #
+          def write
+            self.theme_assets_by_priority.each do |asset|
+              self.output_resource_op asset
+
+              self.open_file(self.target_asset_path(asset), 'wb') do |file|
+                content = asset.content
+
+                if asset.stylesheet_or_javascript?
+                  self.replace_asset_urls(content)
+                end
+
+                file.write(content)
+              end
+
+              self.output_resource_op_status asset
+            end
+          end
+
+          protected
+
+          # The urls stored on the remote engine follows the format: /sites/<id>/theme/<type>/<file>
+          # This method replaces these urls by their local representation. <type>/<file>
+          #
+          # @param [ String ] content
+          #
+          def replace_asset_urls(content)
+            return if content.blank?
+            content.force_encoding('utf-8').gsub!(/[("']([^)"';]*)\/sites\/[0-9a-f]{24}\/theme\/(([^;.]+)\/)*([a-zA-Z_\-0-9]+\.[a-z]{2,3})[)"']/) do |path|
+              "#{path.first}/#{$2 + $4}#{path.last}"
+            end
+          end
+
+          # Return the path where will be copied the asset
+          #
+          # @param [ String ] asset The asset
+          #
+          # @return [ String ] The relative path of the asset locally
+          #
+          def target_asset_path(asset)
+            File.join('public', asset.folder, asset.filename)
+          end
+
+          # List of theme assets sorted by their priority.
+          #
+          # @return [ Array ] Sorted list of the theme assets
+          #
+          def theme_assets_by_priority
+            self.mounting_point.theme_assets.sort { |a, b| a.priority <=> b.priority }
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/locomotive/mounter/writer/file_system/translations_writer.rb

@@ -0,0 +1,29 @@
+module Locomotive
+  module Mounter
+    module Writer
+      module FileSystem
+
+        class TranslationsWriter < Base
+
+          def prepare
+            super
+            self.create_folder 'config'
+          end
+
+          def write
+            content = self.mounting_point.translations.each_with_object({}) do |(key,translation), hash|
+              hash[key] = translation.values
+            end
+
+            content = content.empty? ? '' : content.to_yaml
+
+            self.open_file('config/translations.yml') do |file|
+              file.write content
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/locomotive/mounter/writer/runner.rb

@@ -0,0 +1,73 @@
+module Locomotive
+  module Mounter
+    module Writer
+
+      class Runner
+
+        attr_accessor :kind, :parameters, :mounting_point
+
+        def initialize(kind)
+          self.kind = kind
+
+          # avoid to load all the ruby files at the startup, only when we need it
+          base_dir = File.join(File.dirname(__FILE__), kind.to_s)
+          require File.join(base_dir, 'base.rb')
+          Dir[File.join(base_dir, '*.rb')].each { |lib| require lib }
+        end
+
+        # Write the data of a mounting point instance to a target folder
+        #
+        # @param [ Hash ] parameters The parameters. It should contain the mounting_point and target_path keys.
+        #
+        def run!(parameters = {})
+          self.parameters = parameters.symbolize_keys
+
+          self.mounting_point = self.parameters.delete(:mounting_point)
+
+          self.prepare
+
+          self.write_all
+        end
+
+        # Before starting to write anything
+        # Can be defined by writer runners
+        def prepare
+        end
+
+        # List of all the writers
+        #
+        # @return [ Array ] List of the writer classes
+        #
+        def writers
+          raise Locomotive::Mounter::ImplementationIsMissingException.new("[#{self.kind}] Writers are missing")
+        end
+
+        # Execute all the writers
+        def write_all
+          only = parameters[:only].try(:map) do |name|
+            "#{name}_writer".camelize
+          end.try(:insert, 0, 'SiteWriter')
+
+          self.writers.each do |klass|
+            next if only && !only.include?(klass.name.demodulize)
+            writer = klass.new(self.mounting_point, self)
+            writer.prepare
+            writer.write
+          end
+        end
+
+        # By setting the force option to true, some resources (site, content assets, ...etc)
+        # may overide the content of the remote engine during the push operation.
+        # By default, its value is false.
+        #
+        # @return [ Boolean ] True if the force option has been set to true
+        #
+        def force?
+          self.parameters[:force] || false
+        end
+
+      end
+
+    end
+  end
+end