prelands_rails 0.1.0 → 0.1.4

data/Makefile

@@ -1,4 +1,15 @@
+.PHONY: test all
+
 DIR = $(shell pwd)
 
 setup_local_gem:
 	bundle config local.prelands_rails $(DIR)
+
+all:
+	@docker-compose -f docker-compose.local.yml build
+
+test:
+	@docker-compose -f docker-compose.local.yml run runner rspec
+
+build_and_push_docker:
+	./build_and_push.sh

data/README.md

@@ -2,3 +2,9 @@
 
 Код, занимающийся валидацией и публикацией прелендов V4.
 
+# How to publish gem
+
+1. Bump version inside `prelands_rails.gemspec`.
+2. Make commit & push to `master` branch.
+3. Then checkout `tags` branch and `git rebase master` (accept theirs if there are any conflicts).
+4. Then `git push` - and Gitlab CI publish the new version of the gem.

data/build_and_push.sh

@@ -0,0 +1,4 @@
+#!/bin/sh
+
+docker build -t registry.gitlab.com/c80609a/prelands_rails .
+docker push registry.gitlab.com/c80609a/prelands_rails

data/docker-compose.local.yml

@@ -0,0 +1,9 @@
+version: '3.4'
+
+services:
+  runner:
+    image: prelands_rails:runner
+    build:
+      context: .
+      dockerfile: Dockerfile
+      target: runner

data/lib/prelands_rails/concerns/base.rb

@@ -5,8 +5,11 @@ module PrelandsRails
 
     private
 
-    RX_HTML_FILE = /\.html/
-    NAME_RX      = /index_(\w{2})\.html/
+    RX_HTML_FILE           = /\.html/
+    RX_CSS_FILE            = /\.css/.freeze
+    NAME_RX                = /index_(\w{2})\.html/
+    # DIST_FOLDER            = 'dist'
+    # KNOWN_FILES_EXTENSIONS = /\.(gif|jpe?g|tiff?|png|webp|bmp|mov|avi|wmv|flv|3gp|mp4|mpg|css|js|ico|icon)/.freeze
 
     # извлекаем входящие html файлы из контекста
     def incoming_html_files
@@ -18,8 +21,13 @@ module PrelandsRails
       context.compiled_htmls.select { |key| key =~ RX_HTML_FILE }
     end
 
+    # извлекаем входящие css файлы из контекста
+    def incoming_css_files
+      context.files_content.select { |key| key =~ RX_CSS_FILE }
+    end
+
     def make_tmp_path
-      'tmp/cache/%s' % SecureRandom.uuid
+      '/tmp/%s' % SecureRandom.uuid
     end
   end
 end

data/lib/prelands_rails/create_simple_source/check_zip_files/extract_files.rb

@@ -12,14 +12,14 @@ module PrelandsRails
               next unless expected_files.find_index { |efile| efile.name == entry.name }.present?
 
               # Extract
-              tmp_path = Rails.root.join make_tmp_path
+              tmp_path = make_tmp_path
               entry.extract tmp_path
 
               # Read into memory
               content = entry.get_input_stream.read
 
               # Remove tmp file
-              File.delete(tmp_path) if File.exist?(tmp_path)
+              # File.delete(tmp_path) if File.exist?(tmp_path)
 
               [entry.name, content]
             end.compact.to_h

data/lib/prelands_rails/create_simple_source/check_zip_files.rb

@@ -27,6 +27,7 @@ module PrelandsRails
 
       assures do
         required(:files_content).value(type?: Hash)                             # js,html,css: { file_name => file_content, ... }
+        required(:incoming_files).value(type?: Array)                         # список всех файлов архива { ftype, name }
       end
 
       before do
@@ -56,6 +57,9 @@ module PrelandsRails
         rx1   = /\.(css|js|html)/
         files = @expected_files.select { |file| file.ftype == :file && file.name =~ rx1 }
         context.files_content, context.tmp_paths = read_into_memory files, context.archive.tempfile
+
+        # фиксируем список всех файлов из архива
+        context.incoming_files = incoming_files
       end
 
       def incoming_files

data/lib/prelands_rails/create_simple_source/upload.rb

@@ -64,7 +64,7 @@ module PrelandsRails
           zipfile.map do |entry|
             next if entry.name.index(IMAGES) != 0
 
-            tmp_path = Rails.root.join make_tmp_path
+            tmp_path = make_tmp_path
             entry.extract tmp_path
             @tmp_paths << tmp_path
 

data/lib/prelands_rails/create_simple_source/validate_zip_content/validate_css/css.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class CreateSimpleSource
+    class ValidateZipContent
+      class ValidateCss
+        #
+        # Принимает строку с css и валидирует её.
+        # Правила, обязательные для всех css файлов.
+        #
+        class Css
+          attr_reader :errors
+
+          CUSTOM_FONTS       = /\.(eot|woff|woff2|ttf)/.freeze
+          SVG_LINKS_DETECTED = /\.svg/.freeze
+          IMAGES_BAD_PATH    = /\/images/.freeze
+
+          # @param [String] string Содержимое css файла.
+          def initialize(string)
+            @errors = []
+            @string = string
+          end
+
+          def valid?
+            @errors = [
+              check_svg_links,
+              check_images_relative_paths,
+              check_custom_fonts_absence
+            ].compact
+
+            @errors.none?
+          end
+
+          private
+
+          # @return [nil]     Если всё ОК
+          # @return [String]  Иначе - вернёт сообщение об ошибке
+
+          def check_svg_links
+            return unless @string =~ SVG_LINKS_DETECTED
+
+            'Links to svg detected inside css file. Please, use inline variant of svg.'
+          end
+
+          def check_images_relative_paths
+            return unless @string =~ IMAGES_BAD_PATH
+
+            'Images urls in css files must be relative.'
+          end
+
+          def check_custom_fonts_absence
+            return unless @string =~ CUSTOM_FONTS
+
+            'Custom fonts detected in css files. Please, use Google fonts.'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/prelands_rails/create_simple_source/validate_zip_content/validate_css.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class CreateSimpleSource
+    class ValidateZipContent
+      #
+      # Валидирует все css файлы.
+      #
+      class ValidateCss
+        include ::PrelandsRails::AbstractInteractor
+        include ::Interactor
+        include ::Interactor::Contracts
+        include ::PrelandsRails::Base
+
+        expects do
+          required(:files_content).value(type?: Hash) # { file_name => file_content, ... }
+        end
+
+        assures do
+
+        end
+
+        def act
+          errors =
+            incoming_css_files.map do |key, content|
+              content = Css.new(content)
+              next if content.valid?
+              [key, content.errors]
+            end.compact.to_h
+          fail! errors: errors if errors.any?
+        end
+      end
+    end
+  end
+end

data/lib/prelands_rails/create_simple_source/validate_zip_content/validate_html/html.rb

@@ -86,7 +86,7 @@ module PrelandsRails
             title_rx = /<title>[^<]+<\/title>/
             return if @string[title_rx]
 
-            'Tag <title> not found.'
+            'Tag `title` not found.'
           end
 
           def check_a_hrefs
@@ -97,10 +97,10 @@ module PrelandsRails
           end
 
           def check_favicon
-            favicon_rx = '<link rel="shortcut icon" href="icon.ico">'
+            favicon_rx = /<link.+href="icon.ico">/
             return if @string[favicon_rx]
 
-            '<link rel="shortcut icon" href="icon.ico"> not found.'
+            '`link href="icon.ico"` not found.'
           end
 
           protected

data/lib/prelands_rails/create_simple_source/validate_zip_content/validate_incoming_files/zip_archive.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class CreateSimpleSource
+    class ValidateZipContent
+      class ValidateIncomingFiles
+        class ZipArchive
+          attr_reader :errors
+
+          # @param [Array<{ftype, name}>] incoming_files
+          def initialize(incoming_files)
+            @errors         = []
+            @incoming_files = incoming_files
+          end
+
+          def valid?
+            @errors = [
+              check_app_js,
+              check_app_css,
+              check_favicon,
+              check_svg_absence
+            ].compact
+
+            @errors.none?
+          end
+
+          private
+
+          # @return [nil]     Если `index.js` находится в корне zip-архива.
+          # @return [String]  Иначе - вернёт сообщение об ошибке
+          def check_app_js
+            check 'index.js', 'index.js',
+                  'The «index.js» JAVASCRIPT file is not found in the zip-archive',
+                  'The «index.js» JAVASCRIPT file is not in root of the zip-archive: expected «index.js», got «%s»'
+          end
+
+          def check_app_css
+            check 'index.css', 'index.css',
+                  'The «index.css» STYLES file is not found in the zip-archive',
+                  'The «index.css» STYLES file is not in root of the zip-archive: expected «index.css», got «%s»'
+          end
+
+          def check_favicon
+            check 'icon.ico', /icon\.ico/,
+                  'favicon file is not found in the zip-archive',
+                  'favicon file is not in root of the zip-archive: got «%s»'
+          end
+
+          def check_svg_absence
+            checka /\.svg/, 'svg files detected, move inside css'
+          end
+
+          protected
+
+          def check(pattern, name, absent_error, wrong_place_error)
+            error = absent_error
+
+            @incoming_files.each do |file|
+              if file.name[pattern]
+                error = nil
+                unless file.name.index(name)&.zero?
+                  error = wrong_place_error % file.name
+                end
+                break
+              end
+            end
+
+            error
+          end
+
+          # check absence
+          def checka(pattern, present_error)
+            error = nil
+
+            @incoming_files.each do |file|
+              if file.name[pattern]
+                error = present_error
+                break
+              end
+            end
+
+            error
+          end
+        end
+      end
+    end
+  end
+end

data/lib/prelands_rails/create_simple_source/validate_zip_content/validate_incoming_files.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class CreateSimpleSource
+    class ValidateZipContent
+      #
+      # Проверит наличие файлов в zip-архиве и их требуемую вложенность.
+      #
+      class ValidateIncomingFiles
+        include ::PrelandsRails::AbstractInteractor
+        include ::Interactor
+        include ::Interactor::Contracts
+        include ::PrelandsRails::Base
+
+        expects do
+          required(:incoming_files).value(type?: Array)                       # список всех файлов архива { ftype, name }
+        end
+
+        assures do
+        end
+
+        def act
+          zip_archive = ZipArchive.new context.incoming_files
+          unless zip_archive.valid?
+            fail! errors: zip_archive.errors.join('; ')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/prelands_rails/create_simple_source/validate_zip_content/validate_js.rb

@@ -16,13 +16,17 @@ module PrelandsRails
         end
 
         assures do
+          optional(:warnings).maybe(type?: Array)
+        end
 
+        before do
+          context.warnings ||= []
         end
 
         def act
           content = context[:files_content]['index.js']
           content = Js.new(content)
-          fail! errors: {'index.js' => content.errors} unless content.valid?
+          context.warnings += content.errors unless content.valid?
         end
 
         on_breach { |breaches| bad_expects breaches }

data/lib/prelands_rails/create_simple_source/validate_zip_content.rb

@@ -15,10 +15,10 @@ module PrelandsRails
       end
 
       assures do
-
+        optional(:warnings).maybe(type?: Array)
       end
 
-      organize ValidateHtml, ValidateJs#, ValidateCss
+      organize ValidateIncomingFiles, ValidateHtml, ValidateJs, ValidateCss
 
       on_breach { |breaches| bad_expects breaches }
     end

data/lib/prelands_rails/create_simple_source.rb

@@ -34,6 +34,7 @@ module PrelandsRails
       required(:files_content).value(type?: Hash)                               # распакованные файлы из архива { file_name[String] => file_content[String], ... }
       required(:compiled_htmls).value(type?: Hash)                              # скомпилированные исходники    { file_name[String] => compiled_content[String], ... }
       required(:preland_simple_source).filled
+      optional(:warnings).maybe(type?: Array)
     end
 
     organize DetectIncomingLocales,

data/lib/prelands_rails/recompile_simple_source/download_zip.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class RecompileSimpleSource
+    #
+    # Скачает и разместит в cache-директории zip-архив с исходником лендинга.
+    #
+    class DownloadZip
+      include ::PrelandsRails::AbstractInteractor
+      include ::Interactor
+      include ::Interactor::Contracts
+      include ::PrelandsRails::Base
+
+      expects do
+        required(:prelanding).filled #.value(type?: ::Preland)
+      end
+
+      assures do
+        required(:archive).filled                                               # Rack::Test::UploadedFile | ActionDispatch::Http::UploadedFile
+        required(:tmp_dest).value(type?: String)                                # путь к временному файлу
+      end
+
+      def act
+        archive_url = prelanding.preland_simple_source.archive.url
+        destination = make_tmp_path
+
+        IO.copy_stream(Kernel.open(archive_url), destination)
+
+        context.archive  = ActionDispatch::Http::UploadedFile.new(tempfile: destination)
+        context.tmp_dest = destination
+      end
+
+      on_breach { |breaches| bad_expects breaches }
+
+      delegate :prelanding,
+               :to => :context
+    end
+  end
+end

data/lib/prelands_rails/recompile_simple_source/upload.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class RecompileSimpleSource
+    #
+    # Сначала удалить файлы преленда из директории +aws_prefix+, затем загрузить.
+    #
+    class Upload
+      include ::PrelandsRails::AbstractInteractor
+      include ::Interactor
+      include ::Interactor::Contracts
+      include ::PrelandsRails::UpdateSimpleSource::Upload::DeleteCompiledFiles
+
+      expects do
+        required(:archive).filled                                               # Входящий архив с исходниками от фрилансера. Rack::Test::UploadedFile | ActionDispatch::Http::UploadedFile
+        required(:compiled_htmls).value(type?: Hash)                            # скомпилированные исходники    { file_name[String] => compiled_content[String], ... }
+        required(:s3_credentials).schema do
+          required(:access_key).filled(:str?)
+          required(:secret_key).filled(:str?)
+          required(:region).filled(:str?)
+        end
+        required(:bucket_names).value(type?: Array)
+        required(:aws_prefix).value(type?: String)
+        required(:files_content).value(type?: Hash)                             # { file_name => file_content, ... }
+      end
+
+      assures do
+      end
+
+      def act
+        delete_compiled_files
+        result = ::PrelandsRails::CreateSimpleSource::Upload.call context
+        fail! errors: result.errors unless result.success?
+      end
+
+      on_breach { |breaches| bad_expects breaches }
+    end
+  end
+end

data/lib/prelands_rails/recompile_simple_source.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  #
+  # Перекомпилировать преленд на основе уже загруженного в aws архива.
+  #
+  class RecompileSimpleSource
+    include ::PrelandsRails::AbstractInteractor
+    include ::Interactor::Organizer
+    include ::Interactor::Contracts
+
+    expects do
+      required(:prelanding).filled#.value(type?: ::Preland)
+      required(:static_js_path).value(type?: String)
+      required(:s3_credentials).schema do
+        required(:access_key).filled(:str?)
+        required(:secret_key).filled(:str?)
+        required(:region).filled(:str?)
+      end
+      required(:bucket_names).value(type?: Array)
+    end
+
+    before do
+      context.expected_locales = context.prelanding.locales.map(&:short_name)
+      context.aws_prefix       = context.prelanding.preland_simple_source.aws_prefix
+    end
+
+    assures do
+      required(:expected_locales).filled(type?: Array)
+      required(:aws_prefix).value(type?: String)
+      required(:archive).filled
+      required(:tmp_dest).value(type?: String)
+      required(:incoming_locales).filled(type?: Array)
+      required(:files_content).value(type?: Hash)
+      required(:compiled_htmls).value(type?: Hash)
+    end
+
+    after do
+      clear_tmp_dest
+      context.prelanding.preland_simple_source.update_columns updated_at: Time.now
+    end
+
+    organize DownloadZip,
+             ::PrelandsRails::CreateSimpleSource::DetectIncomingLocales,
+             ::PrelandsRails::CreateSimpleSource::CheckZipFiles,
+             ::PrelandsRails::CreateSimpleSource::Compile,
+             Upload
+
+    on_breach { |breaches| bad_expects breaches }
+
+    private
+
+    def clear_tmp_dest
+      td = context.tmp_dest
+      File.delete(td) if File.exist?(td)
+    end
+  end
+end

data/lib/prelands_rails/update_simple_source/validate_zip_content.rb

@@ -13,17 +13,15 @@ module PrelandsRails
       end
 
       assures do
-
-      end
-
-      before do
-
+        optional(:warnings).maybe(type?: Array)
       end
 
       def act
         if context.files_content
           result = ::PrelandsRails::CreateSimpleSource::ValidateZipContent.call context
-          unless result.success?
+          if result.success?
+            context.warnings = result.warnings
+          else
             fail!(errors: result.errors)
           end
         end

data/lib/prelands_rails/update_simple_source.rb

@@ -34,6 +34,7 @@ module PrelandsRails
       optional(:files_content).maybe(type?: Hash)                               # распакованные файлы из архива { file_name[String] => file_content[String], ... }
       optional(:compiled_htmls).value(type?: Hash)                              # скомпилированные исходники    { file_name[String] => compiled_content[String], ... }
       required(:preland_simple_source).filled
+      optional(:warnings).maybe(type?: Array)
     end
 
     organize ::PrelandsRails::CreateSimpleSource::DetectIncomingLocales,

data/lib/prelands_rails/validate_simple_source.rb

@@ -15,6 +15,7 @@ module PrelandsRails
     end
 
     assures do
+      optional(:warnings).maybe(type?: Array)
     end
 
     organize ::PrelandsRails::CreateSimpleSource::DetectIncomingLocales,

data/lib/prelands_rails.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'prelands_rails/version'
-
 require 'zip'
 require 'interactor'
 require 'interactor/contracts'
@@ -18,7 +16,11 @@ require 'prelands_rails/create_simple_source/check_zip_files'
 require 'prelands_rails/create_simple_source/validate_zip_content/validate_html/html'
 require 'prelands_rails/create_simple_source/validate_zip_content/validate_html'
 require 'prelands_rails/create_simple_source/validate_zip_content/validate_js/js'
+require 'prelands_rails/create_simple_source/validate_zip_content/validate_css/css'
+require 'prelands_rails/create_simple_source/validate_zip_content/validate_incoming_files/zip_archive'
 require 'prelands_rails/create_simple_source/validate_zip_content/validate_js'
+require 'prelands_rails/create_simple_source/validate_zip_content/validate_css'
+require 'prelands_rails/create_simple_source/validate_zip_content/validate_incoming_files'
 require 'prelands_rails/create_simple_source/validate_zip_content'
 require 'prelands_rails/create_simple_source/compile/html_compiler'
 require 'prelands_rails/create_simple_source/compile'
@@ -37,5 +39,9 @@ require 'prelands_rails/update_simple_source'
 
 require 'prelands_rails/validate_simple_source'
 
+require 'prelands_rails/recompile_simple_source/upload'
+require 'prelands_rails/recompile_simple_source/download_zip'
+require 'prelands_rails/recompile_simple_source'
+
 module PrelandsRails
 end

data/prelands_rails.gemspec

@@ -1,10 +1,11 @@
-lib = File.expand_path("lib", __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require_relative 'lib/prelands_rails/version'
+if File.exist?('lib/prelands_rails/version')
+  lib = File.expand_path("lib", __dir__)
+  $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+end
 
 Gem::Specification.new do |spec|
   spec.name          = "prelands_rails"
-  spec.version       = PrelandsRails::VERSION
+  spec.version       = "0.1.4"
   spec.authors       = ["C80609A"]
   spec.email         = ["c080609a@gmail.com"]
 
@@ -34,15 +35,17 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'aws-sdk'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'mimemagic'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rails', '6.0.2.1'
   spec.add_development_dependency 'byebug'
   spec.add_development_dependency 'awesome_print'
   spec.add_development_dependency 'factory_bot_rails'
   spec.add_development_dependency 'database_cleaner'
-  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rspec-rails', '~> 4.0'
   spec.add_development_dependency 'rails-controller-testing'
   spec.add_development_dependency 'paperclip', '5.0.0'
-  spec.add_development_dependency 'mimemagic'
-  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'tzinfo-data'
 end