prelands_rails 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35eeb90eac95fb5e2cb25e86a7eefc1b43455b1c78c6f95d4b251003702a33fb
-  data.tar.gz: 30005a1d620ffb670be9e5ca1e049a237e300a8a98167a98242f63fb9c53353d
+  metadata.gz: bb269383807073d60b3d1bbbc793a0537fe1c5b1871a61e8767af3013a8a2742
+  data.tar.gz: add40d4bae32d158efa85befd0a18189e2ae1297679734c6963097cf64dc3ae5
 SHA512:
-  metadata.gz: 9afd4182ba0f4a58c7ceeeff466d723c6e6faa5c95cc79389ae2698191433b49490f811630e86ac90de5f9fda8409120270d533b532e348955509dbc38d29081
-  data.tar.gz: f251623901cfa8ddfc899b7851554115713bab937936f5797380dddc5444bc3e55f03b6037804972767058557946778fc6a81158941cdacbb367489f79c17cb0
+  metadata.gz: 24ebaa868025398394259598cc51af5f1be747ddb20cd4686119656144cc4b24fff0f3b8fef108091d2faaf918266f9b552804298e1d4064ead74d99e786f4ac
+  data.tar.gz: 53c7459c4e48e4e30f78e4375f2825ad8e0e9ca4088a076ef20be4fb6d84c27b1685cf5d66ee4a000b8af192cdb554fb5a3563b5bbfbe5b2ae775a93d133141a

data/.ci/dver.rb

@@ -0,0 +1,5 @@
+file = 
+  Dir[File.expand_path('./*.gem')].map do |file|
+    file.split('-').last[/\d+\.\d+.\d+/]
+  end
+puts file

data/.dockerignore

@@ -0,0 +1,17 @@
+.*history
+.bundle
+.dockerignore
+.gemrc
+.git
+.gitignore
+.rubocop*
+.ruby-version
+.rspec_status
+*.md
+*.sh
+docker-compose.*
+Dockerfile*
+log/*
+Makefile
+tmp/*
+vendor/bundle

data/.gitlab-ci.yml

@@ -0,0 +1,30 @@
+stages:
+  - test
+  - gem_build
+  - gem_push
+
+default:
+  image: registry.gitlab.com/c80609a/prelands_rails:latest
+
+publish:gem:
+  stage: gem_push
+  image: ruby:2.7
+  before_script:
+  - mkdir -p ~/.gem
+  - wget "${CREDS}" -O ~/.gem/credentials
+  - chmod 0600 ~/.gem/credentials
+  - cat ~/.gem/credentials
+  script:
+  - gem build *.gemspec
+  - export YVER=$(ruby .ci/dver.rb)
+  - echo $YVER
+  - gem yank prelands_rails -v $YVER
+  - gem push *.gem
+  only:
+  - tags
+
+rspec:
+  stage: test
+  script:
+    - rspec
+

data/.rspec

@@ -1,3 +1,2 @@
---format documentation
 --color
 --require spec_helper

data/Dockerfile

@@ -0,0 +1,27 @@
+# Stage: ruby ##########################################################################################################
+FROM ruby:2.7.3-alpine3.13 as ruby
+LABEL description="Base ruby image used by other stages"
+
+# Stage runner #########################################################################################################
+FROM ruby as runner
+LABEL description="Builds an image ready to be run"
+
+# Install build deps and gems from all environments under vendor/bundle path
+RUN apk add --update --no-cache \
+   build-base git zip sqlite-dev shared-mime-info
+
+RUN addgroup -g 1000 -S app \
+ && adduser -u 1000 -S app -G app \
+ && mkdir -p /home/app/tmp \
+ && chown -R app:app /home/app
+
+USER app
+WORKDIR /home/app
+
+# Copy source files according to .dockerignore policy
+# Make sure your .dockerignore file is properly configure to ensure proper layer caching
+COPY --chown=app:app . /home/app
+
+RUN bundle install --jobs 8 --retry 3
+
+ENTRYPOINT ["bundle", "exec"]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    prelands_rails (0.1.0)
+    prelands_rails (0.1.1)
       aws-sdk
       interactor (~> 3.0)
       interactor-contracts
@@ -1399,6 +1399,10 @@ GEM
       rake (>= 0.8.7)
       thor (>= 0.20.3, < 2.0)
     rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
     rspec-core (3.10.1)
       rspec-support (~> 3.10.0)
     rspec-expectations (3.10.1)
@@ -1429,6 +1433,8 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.9)
       thread_safe (~> 0.1)
+    tzinfo-data (1.2021.5)
+      tzinfo (>= 1.0.0)
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
@@ -1449,8 +1455,10 @@ DEPENDENCIES
   rails (= 6.0.2.1)
   rails-controller-testing
   rake (~> 12.0)
+  rspec
   rspec-rails (~> 4.0)
   sqlite3
+  tzinfo-data
 
 BUNDLED WITH
    2.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/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_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.rb

@@ -18,7 +18,7 @@ module PrelandsRails
 
       end
 
-      organize ValidateHtml, ValidateJs#, ValidateCss
+      organize ValidateIncomingFiles, ValidateHtml, ValidateJs, ValidateCss
 
       on_breach { |breaches| bad_expects breaches }
     end

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'

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.2"
   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prelands_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - C80609A
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-18 00:00:00.000000000 Z
+date: 2021-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: interactor
@@ -80,6 +80,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: mimemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -151,19 +193,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -207,21 +249,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 5.0.0
 - !ruby/object:Gem::Dependency
-  name: mimemagic
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: tzinfo-data
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -241,11 +269,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".ci/dver.rb"
+- ".dockerignore"
 - ".gitignore"
+- ".gitlab-ci.yml"
 - ".rspec"
 - ".ruby-version"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -254,6 +285,8 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- build_and_push.sh
+- docker-compose.local.yml
 - lib/prelands_rails.rb
 - lib/prelands_rails/concerns/abstract_interactor.rb
 - lib/prelands_rails/concerns/base.rb
@@ -271,8 +304,12 @@ files:
 - lib/prelands_rails/create_simple_source/upload.rb
 - lib/prelands_rails/create_simple_source/upload/uploader.rb
 - lib/prelands_rails/create_simple_source/validate_zip_content.rb
+- lib/prelands_rails/create_simple_source/validate_zip_content/validate_css.rb
+- lib/prelands_rails/create_simple_source/validate_zip_content/validate_css/css.rb
 - lib/prelands_rails/create_simple_source/validate_zip_content/validate_html.rb
 - lib/prelands_rails/create_simple_source/validate_zip_content/validate_html/html.rb
+- lib/prelands_rails/create_simple_source/validate_zip_content/validate_incoming_files.rb
+- lib/prelands_rails/create_simple_source/validate_zip_content/validate_incoming_files/zip_archive.rb
 - lib/prelands_rails/create_simple_source/validate_zip_content/validate_js.rb
 - lib/prelands_rails/create_simple_source/validate_zip_content/validate_js/js.rb
 - lib/prelands_rails/update_simple_source.rb
@@ -283,7 +320,6 @@ files:
 - lib/prelands_rails/update_simple_source/upload/delete_compiled_files.rb
 - lib/prelands_rails/update_simple_source/validate_zip_content.rb
 - lib/prelands_rails/validate_simple_source.rb
-- lib/prelands_rails/version.rb
 - prelands_rails.gemspec
 homepage: https://gitlab.com/c80609a/prelands_rails
 licenses:
@@ -307,7 +343,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Код, занимающийся валидацией и публикацией прелендов V4.

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.2
-before_install: gem install bundler -v 2.1.4

data/lib/prelands_rails/version.rb

@@ -1,3 +0,0 @@
-module PrelandsRails
-  VERSION = "0.1.0"
-end