epuber 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f0fcab4dfe82bc1ae829738a62f4915f02e79bbc105ab9eafd6d2c0a664dc60
-  data.tar.gz: 4fcaf730a6caf5d560a1525b5a2a000d29efec2819c82e7c1fdd1bc4cd470228
+  metadata.gz: 603ed8123e624a5756c2e66ef8e2561f76f60b7c2ba386040e62cc1bace24c52
+  data.tar.gz: bc9fd362419d5fd05444398221f8d0e9bbfa4675273635b893c3a160a3330048
 SHA512:
-  metadata.gz: 4fd75c5cda4801241fa762d728308c3c1ebe9d668cc8cf4f9c7be3b3df48ca4715ec2498a2a4914a0c138c21adf49ecdcc66f49e47a33d0487107dd4b05a4d1b
-  data.tar.gz: 14e7bb639a81535df13bde1f5f92ecb29cf2892d5692d93ee1b97b1045cd650c4480cccfc7262280e2ad135a31796cb04932993d6e0dac21f0cbfaa226544045
+  metadata.gz: 5f04920782210213a3c5fb8e424d8b22e3a316d83187dae331057759d4bda04b61b81c163215086fa4cad4abd736de37db43c428b56b51472f8d93c9bbadb5e3
+  data.tar.gz: a683e1930bf8c58b8b9f64529ac55c50dbe0895af5acbb4d4820cf1f5d0559349e87cd3f02c0bf7a90c77b04d4a9a07acee849cb867f8f81a658484e74514e35

data/Gemfile

@@ -5,6 +5,15 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in Epuber.gemspec
 gemspec
 
+# dev
+gem 'fakefs', '>= 1.3', '< 3.0' # 2.0.0 is not compatible with Ruby 2.5
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.2'
+gem 'rubocop', '~> 1.14'
+
+# VSCode plugins
+gem 'ruby-lsp', require: false
+
 group :dev, optional: true do
   gem 'rubocop-rspec', require: false
 end

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Roman Kříž
+Copyright (c) 2015-2023 Roman Kříž
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -104,9 +104,9 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/epuber-io/epuber. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/epuber-io/epuber. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org/) code of conduct.
 
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](./LICENSE.txt).

data/epuber.gemspec

@@ -11,10 +11,10 @@ Gem::Specification.new do |spec|
   spec.homepage = Epuber::HOME_URL
   spec.license  = 'MIT'
   spec.required_ruby_version = '>= 2.5'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   spec.files         = Dir['bin/**/*'] + Dir['lib/**/*'] + %w[epuber.gemspec Gemfile LICENSE.txt README.md]
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'activesupport', '>= 6.0', '< 8.0'
@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'mime-types', '~> 3.0'
   spec.add_runtime_dependency 'nokogiri', '~> 1.8', '>= 1.8.2'
   spec.add_runtime_dependency 'os', '~> 1.0'
+  spec.add_runtime_dependency 'uuidtools', '~> 2.1'
 
   spec.add_runtime_dependency 'sinatra', '>= 2.0', '< 4.0'
   spec.add_runtime_dependency 'sinatra-contrib', '>= 2.0', '< 4.0'
@@ -37,10 +38,6 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'bade', '~> 0.3', '>= 0.3.1'
   spec.add_runtime_dependency 'coffee-script', '~> 2.4'
+  spec.add_runtime_dependency 'css_parser', '>= 0.8', '< 2.0'
   spec.add_runtime_dependency 'epuber-stylus', '~> 1.1', '>= 1.1.1'
-
-  spec.add_development_dependency 'fakefs', '>= 1.3', '< 3.0' # 2.0.0 is not compatible with Ruby 2.5
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.2'
-  spec.add_development_dependency 'rubocop', '~> 1.14'
 end

data/lib/epuber/book/contributor.rb

@@ -31,22 +31,26 @@ module Epuber
 
       # Creates new instance of Contributor dependent on obj content
       #
-      # @param obj [Hash<Symbol, String>, Array<Hash<Symbol,String>, String, Array<String>] input object
-      # @param role [String] role of contributor
+      # @param [Hash<Symbol, String>, Array<Hash<Symbol,String>, String, Array<String>] obj input object
+      # @param [String] role role of contributor
       #
       # @return [Contributor]
       #
-      def self.from_obj(obj, role)
+      def self.from_obj(obj, role = 'aut')
         if obj.is_a?(String)
-          components = obj.split(' ')
+          components = obj.split
           if components.length >= 2
             NormalContributor.new(components.first(components.length - 1).join(' '), components.last, role)
+          else
+            Contributor.new(obj, obj, role)
           end
         elsif obj.is_a?(Hash)
           if obj.key?(:first_name)
-            NormalContributor.new(obj[:first_name], obj[:last_name], role)
+            NormalContributor.new(obj[:first_name], obj[:last_name], obj[:role] || role)
           elsif obj.key?(:file_as)
-            Contributor.new(obj[:pretty_name], obj[:file_as], role)
+            Contributor.new(obj[:pretty_name], obj[:file_as], obj[:role] || role)
+          elsif obj.key?(:name)
+            Contributor.from_obj(obj[:name], obj[:role] || role)
           end
         end
       end

data/lib/epuber/book/file_request.rb

@@ -45,10 +45,10 @@ module Epuber
       # @return [Numeric]
       #
       def hash
-        @source_pattern.hash ^ @group.hash ^ @only_one.hash
+        [@source_pattern, @group, @only_one].hash
       end
 
-      # @param other [String, self]
+      # @param [String, self] other
       #
       def ==(other)
         if other.is_a?(String)

data/lib/epuber/book/target.rb

@@ -215,8 +215,8 @@ module Epuber
                 inherited: false
 
 
-      # @param file_path [String | Epuber::Book::File]
-      # @param group [Symbol]
+      # @param [String | Epuber::Book::File] file_path
+      # @param [Symbol] group
       #
       # @return [Epuber::Book::File] created file
       #
@@ -238,7 +238,7 @@ module Epuber
         end
       end
 
-      # @param file_paths [Array<String>]
+      # @param [Array<String>] file_paths
       #
       # @return [void]
       #
@@ -249,8 +249,8 @@ module Epuber
         end
       end
 
-      # @param key [String]
-      # @param value [String]
+      # @param [String] key
+      # @param [String] value
       #
       # @return [void]
       #
@@ -262,7 +262,7 @@ module Epuber
         end
       end
 
-      # @param file_paths [Array<String>]
+      # @param [Array<String>] file_paths
       #
       # @return [void]
       #
@@ -278,7 +278,7 @@ module Epuber
       # Add default styles to default target, default styles will be automatically added to xhtml document
       #
       # Only difference with #add_default_style is it adds multiple files with one pattern
-      # @param file_paths [Array<String>]
+      # @param [Array<String>] file_paths
       #
       # @return [void]
       #
@@ -291,7 +291,7 @@ module Epuber
         end
       end
 
-      # @param file_paths [Array<String>]
+      # @param [Array<String>] file_paths
       #
       # @return [void]
       #
@@ -307,7 +307,7 @@ module Epuber
       # Add default scripts to target, default scripts will be automatically added to xhtml document
       #
       # Only difference with #add_default_script is it adds multiple files with one pattern
-      # @param file_paths [Array<String>]
+      # @param [Array<String>] file_paths
       #
       # @return [void]
       #
@@ -330,7 +330,7 @@ module Epuber
         yield(@root_toc, self) if block_given?
       end
 
-      # @param path [String] use some file/module/package
+      # @param [String] path use some file/module/package
       #
       # @return [nil]
       #

data/lib/epuber/book.rb

@@ -160,7 +160,7 @@ module Epuber
               container: Array,
               required: true,
               singularize: true,
-              auto_convert: { [String, Hash] => ->(value) { Contributor.from_obj(value, 'aut') } }
+              auto_convert: { [String, Hash] => ->(value) { Contributor.from_obj(value) } }
 
 
     # @return [String] publisher name
@@ -294,7 +294,7 @@ module Epuber
 
     # Finds target with name or nil when not found
     #
-    # @param target_name [Symbol, String, Epuber::Book::Target]
+    # @param [Symbol, String, Epuber::Book::Target] target_name
     #
     # @return [Epuber::Book::Target, nil]
     #

data/lib/epuber/checker/text_checker.rb

@@ -10,9 +10,9 @@ module Epuber
   class Checker
     class TextChecker < Checker
       class MatchProblem < Compiler::Problem
-        # @param message [String]
-        # @param file_path [String]
-        # @param match [MatchData]
+        # @param [String] message
+        # @param [String] file_path
+        # @param [MatchData] match
         #
         def initialize(match, message, file_path)
           whole_text = match.pre_match + match.matched_string + match.post_match
@@ -36,8 +36,8 @@ module Epuber
 
 
 
-      # @param file_path [String]
-      # @param text [String]
+      # @param [String] file_path
+      # @param [String] text
       # @param [CompilationContext] compilation_context
       #
       # @return nil
@@ -52,7 +52,7 @@ module Epuber
         @file_path = nil
       end
 
-      # @param regexp [Regexp]
+      # @param [Regexp] regexp
       # @param [String] message  message to display, when the regexp found something
       #
       def should_not_contain(regexp, message)
@@ -65,6 +65,14 @@ module Epuber
                                                        Config.instance.pretty_path_from_project(file_path))
         end
       end
+
+      def error(message, location: nil)
+        super(message, location: location || Config.instance.pretty_path_from_project(file_path))
+      end
+
+      def warning(message, location: nil)
+        super(message, location: location || Config.instance.pretty_path_from_project(file_path))
+      end
     end
   end
 end

data/lib/epuber/checker_transformer_base.rb

@@ -55,7 +55,7 @@ module Epuber
       {}
     end
 
-    # @param type [Symbol]
+    # @param [Symbol] type
     #
     # @return [Class]
     #

data/lib/epuber/command/build.rb

@@ -26,7 +26,12 @@ module Epuber
         ].concat(super)
       end
 
-      # @param argv [CLAide::ARGV]
+      # To resolve problem with `compile` treating as subcommand
+      def self.subcommands
+        []
+      end
+
+      # @param [CLAide::ARGV] argv
       #
       def initialize(argv)
         @targets_names = argv.arguments!

data/lib/epuber/command/from_file.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+require_relative '../from_file/from_file_executor'
+
+module Epuber
+  class Command
+    class FromFile < Command
+      self.summary = 'Initialize current folder to use it as Epuber project from existing EPUB file'
+      self.arguments = [
+        CLAide::Argument.new('EPUB_FILE', true),
+      ]
+
+      # @param [CLAide::ARGV] argv
+      #
+      def initialize(argv)
+        @filepath = argv.arguments!.first
+
+        super(argv)
+      end
+
+      def validate!
+        super
+
+        help! 'You must specify path to existing EPUB file' if @filepath.nil?
+        help! "File #{@filepath} doesn't exists" unless File.exist?(@filepath)
+
+        existing = Dir.glob('*.bookspec')
+        help! "Can't reinit this folder, #{existing.first} already exists." unless existing.empty?
+      end
+
+      def run
+        super
+
+        FromFileExecutor.new(@filepath).run
+      end
+    end
+  end
+end

data/lib/epuber/command/init.rb

@@ -11,10 +11,10 @@ module Epuber
     class Init < Command
       self.summary = 'Initialize current folder to use it as Epuber project'
       self.arguments = [
-        CLAide::Argument.new('PROJECT_NAME', false, true),
+        CLAide::Argument.new('PROJECT_NAME', false),
       ]
 
-      # @param argv [CLAide::ARGV]
+      # @param [CLAide::ARGV] argv
       #
       def initialize(argv)
         @book_name = argv.arguments!.first
@@ -23,6 +23,8 @@ module Epuber
       end
 
       def validate!
+        super
+
         help! 'You must specify identifier-like name of the book as first argument' if @book_name.nil?
 
         existing = Dir.glob('*.bookspec')
@@ -57,7 +59,7 @@ module Epuber
 
       # Creates <book-id>.bookspec file from template
       #
-      # @param book_id [String]
+      # @param [String] book_id
       #
       # @return [void]
       #
@@ -71,7 +73,7 @@ module Epuber
 
       # Creates <book-id>.sublime-project
       #
-      # @param book_id [String]
+      # @param [String] book_id
       #
       # @return [void]
       #
@@ -115,8 +117,8 @@ module Epuber
         STYLUS
       end
 
-      # @param string [String] text to file
-      # @param file_path [String] path to file
+      # @param [String] string text to file
+      # @param [String] file_path path to file
       #
       # @return [void]
       #
@@ -125,8 +127,8 @@ module Epuber
         UI.puts "   #{'create'.ansi.green}  #{file_path}"
       end
 
-      # @param string [String] text to file
-      # @param file_path [String] path to file
+      # @param [String] string text to file
+      # @param [String] file_path path to file
       #
       # @return [void]
       #
@@ -158,7 +160,7 @@ module Epuber
         UI.puts "   #{'create'.ansi.green}  #{dir_path}/"
       end
 
-      # @param text [String]
+      # @param [String] text
       #
       # @return [String] returned text without new line
       #

data/lib/epuber/command/server.rb

@@ -17,7 +17,7 @@ module Epuber
         ].concat(super)
       end
 
-      # @param args [CLAide::ARGV]
+      # @param [CLAide::ARGV] args
       #
       def initialize(args)
         super

data/lib/epuber/command.rb

@@ -16,6 +16,7 @@ module Epuber
     require_relative 'command/compile'
     require_relative 'command/init'
     require_relative 'command/server'
+    require_relative 'command/from_file'
 
     self.abstract_command = true
     self.command = 'epuber'

data/lib/epuber/compiler/file_database.rb

@@ -65,7 +65,7 @@ module Epuber
       end
 
       def update_all_metadata
-        @all_files.each do |file_path, _|
+        @all_files.each_key do |file_path|
           update_metadata(file_path)
         end
       end
@@ -98,7 +98,7 @@ module Epuber
         to_remove = @all_files.keys - file_paths
         to_remove.each { |key| @all_files.delete(key) }
 
-        @all_files.each do |_, stat|
+        @all_files.each_value do |stat|
           _cleanup_stat_dependency_list(file_paths, stat)
         end
       end

data/lib/epuber/compiler/file_finders/abstract.rb

@@ -194,7 +194,7 @@ module Epuber
             end.flatten
 
             paths.select do |file_path|
-              valid_extensions.include?(::File.extname(file_path))
+              valid_extensions.include?(::File.extname(file_path).downcase)
             end
           end
         end
@@ -247,8 +247,8 @@ module Epuber
         # @return [Array<String>] list of founded files
         #
         def __core_find_files(pattern, groups, context_path, orig_context_path = context_path)
-          context_path = __core_file?(context_path) ? File.dirname(context_path) : context_path
-          orig_context_path = __core_file?(orig_context_path) ? File.dirname(orig_context_path) : orig_context_path
+          context_path = File.dirname(context_path) if __core_file?(context_path)
+          orig_context_path = File.dirname(orig_context_path) if __core_file?(orig_context_path)
 
           full_pattern = File.expand_path(pattern, context_path)
           file_paths = __core_find_files_from_pattern(full_pattern).map(&:unicode_normalize)

data/lib/epuber/compiler/file_resolver.rb

@@ -20,7 +20,7 @@ module Epuber
     require_relative 'file_types/container_xml_file'
     require_relative 'file_types/ibooks_display_options_file'
     require_relative 'file_types/coffee_script_file'
-
+    require_relative 'file_types/css_file'
 
     class FileResolver
       class ResolveError < StandardError; end
@@ -247,6 +247,7 @@ module Epuber
         def file_class_for(extname)
           mapping = {
             '.styl' => FileTypes::StylusFile,
+            '.css' => FileTypes::CSSFile,
 
             '.coffee' => FileTypes::CoffeeScriptFile,
 
@@ -279,7 +280,7 @@ module Epuber
 
       private
 
-      # @param file [Epuber::Compiler::AbstractFile]
+      # @param [Epuber::Compiler::AbstractFile] file
       #
       # @return [nil]
       #

data/lib/epuber/compiler/file_types/abstract_file.rb

@@ -87,9 +87,7 @@ module Epuber
         def self.write_to_file!(content, to_path)
           FileUtils.mkdir_p(File.dirname(to_path))
 
-          File.open(to_path, 'w') do |file_handle|
-            file_handle.write(content)
-          end
+          File.write(to_path, content)
         end
       end
     end

data/lib/epuber/compiler/file_types/bade_file.rb

@@ -45,15 +45,7 @@ module Epuber
                           end
                         end
 
-          if !precompiled.nil?
-            xhtml_content = UI.print_step_processing_time('rendering precompiled Bade') do
-              renderer = Bade::Renderer.from_precompiled(precompiled)
-                                       .with_locals(variables)
-              renderer.file_path = source_path
-
-              renderer.render(new_line: '', indent: '')
-            end
-          else
+          if precompiled.nil?
             if compilation_context.incremental_build?
               UI.print_processing_debug_info('Parsing new version of source file')
             end
@@ -70,6 +62,14 @@ module Epuber
               FileUtils.mkdir_p(File.dirname(precompiled_path))
               renderer.precompiled.write_yaml_to_file(precompiled_path)
 
+              renderer.render(new_line: '', indent: '')
+            end
+          else
+            xhtml_content = UI.print_step_processing_time('rendering precompiled Bade') do
+              renderer = Bade::Renderer.from_precompiled(precompiled)
+                                       .with_locals(variables)
+              renderer.file_path = source_path
+
               renderer.render(new_line: '', indent: '')
             end
           end

data/lib/epuber/compiler/file_types/css_file.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require 'css_parser'
+
+module Epuber
+  class Compiler
+    module FileTypes
+      require_relative 'source_file'
+
+      class CSSFile < SourceFile
+        DECLARATION_TO_FILE_GROUP_MAP = {
+          'background' => :image,
+          'background-image' => :image,
+          'list-style' => :image,
+          'list-style-image' => :image,
+          'content' => :image,
+          'cursor' => :image,
+          'border-image' => :image,
+          'border-image-source' => :image,
+          'mask-image' => :image,
+          'mask-box-image' => :image,
+          'src' => :font,
+        }.freeze
+
+        URL_REGEXP = /url\((.+)\)/.freeze
+
+        # @param [Compiler::CompilationContext] compilation_context
+        #
+        def process(compilation_context)
+          return if destination_file_up_to_date?
+
+          write_processed(process_css(File.read(abs_source_path), compilation_context))
+        end
+
+        # Processes CSS file, resolves all linked files and adds them to file resolver
+        #
+        # @param [String] content
+        # @param [Compiler::CompilationContext] compilation_context
+        #
+        # @return [String]
+        #
+        def process_css(content, compilation_context)
+          file_resolver = compilation_context.file_resolver
+
+          parser = UI.print_step_processing_time('css parsing') do
+            parser = CssParser::Parser.new
+            parser.load_string!(content)
+            parser
+          end
+
+          # resolve links to files, add other linked resources and compute correct path
+          UI.print_step_processing_time('resolving url()') do
+            parser.each_rule_set do |rule_set, _media_types|
+              declarations = rule_set.instance_eval { @declarations }
+              declarations.each do |property, decl_value|
+                value = decl_value.to_s
+                next unless value =~ URL_REGEXP
+
+                path = Regexp.last_match(1)
+                if path.start_with?('"') && path.end_with?('"')
+                  path = path[1..-2]
+                  quote = '"'
+                end
+                if path.start_with?("'") && path.end_with?("'")
+                  path = path[1..-2]
+                  quote = "'"
+                end
+
+                next if path.start_with?('data:') || path.start_with?('http://') || path.start_with?('https://')
+
+                resource_group = DECLARATION_TO_FILE_GROUP_MAP[property]
+                dirname = File.dirname(destination_path)
+
+                begin
+                  new_path = file_resolver.dest_finder.find_file(path, groups: resource_group, context_path: dirname)
+                rescue FileFinders::FileNotFoundError, FileFinders::MultipleFilesFoundError
+                  new_path = XHTMLProcessor.resolved_link_to_file(path,
+                                                                  resource_group,
+                                                                  dirname,
+                                                                  file_resolver.source_finder).to_s
+                  pkg_abs_path = File.expand_path(new_path, dirname).unicode_normalize
+                  pkg_new_path = Pathname.new(pkg_abs_path)
+                                         .relative_path_from(Pathname.new(file_resolver.source_path))
+                                         .to_s
+
+                  file_class = FileResolver.file_class_for(File.extname(new_path))
+                  file = file_class.new(pkg_new_path)
+                  file.path_type = :manifest
+                  file_resolver.add_file(file)
+                end
+
+                new_url = FileResolver.renamed_file_with_path(new_path)
+                content = content.gsub(value, "url(#{quote}#{new_url}#{quote})")
+              end
+            end
+          end
+
+          content
+        end
+      end
+    end
+  end
+end

data/lib/epuber/compiler/file_types/stylus_file.rb

@@ -5,9 +5,9 @@ require 'epuber-stylus'
 module Epuber
   class Compiler
     module FileTypes
-      require_relative 'source_file'
+      require_relative 'css_file'
 
-      class StylusFile < SourceFile
+      class StylusFile < CSSFile
         # @param [Compiler::CompilationContext] compilation_context
         #
         def process(compilation_context)
@@ -19,7 +19,8 @@ module Epuber
           Stylus.define('__book_title', compilation_context.book.title)
           Stylus.define('__const', compilation_context.target.constants)
 
-          write_compiled(Stylus.compile(File.new(abs_source_path)))
+          css = Stylus.compile(File.new(abs_source_path))
+          write_compiled(process_css(css, compilation_context))
 
           update_metadata!
         end