epuber 0.7.4 → 0.8.0

data/lib/epuber/dsl/object.rb

@@ -49,11 +49,10 @@ module Epuber
 
           next unless attr.required? && value.nil?
 
-          if attr.singularize?
-            raise ValidationError, "missing required attribute `#{key.to_s.singularize}|#{key}`"
-          else
-            raise ValidationError, "missing required attribute `#{key}`"
-          end
+          raise ValidationError, "missing required attribute `#{key.to_s.singularize}|#{key}`" if attr.singularize?
+
+
+          raise ValidationError, "missing required attribute `#{key}`"
         end
       end
 
@@ -74,21 +73,16 @@ module Epuber
       # @return [Self]
       #
       def self.from_string(string, file_path = nil)
-        # rubocop:disable Lint/Eval
         obj = if file_path
-                eval(string, nil, file_path)
+                eval(string, nil, file_path) # rubocop:disable Security/Eval
               else
-                eval(string)
+                eval(string) # rubocop:disable Security/Eval
               end
-        # rubocop:enable Lint/Eval
 
         unless obj.is_a?(self)
           msg = "Invalid object #{obj.class}, expected object of class #{self}"
 
-          if file_path
-            msg += ", loaded from file #{file_path}"
-
-          end
+          msg += ", loaded from file #{file_path}" if file_path
 
           raise StandardError, msg
         end
@@ -121,6 +115,10 @@ module Epuber
       #
       attr_accessor :attributes_values
 
+      def respond_to_missing?(name, include_private = false)
+        @attributes_values.key?(name) || super
+      end
+
       # Raise exception when there is used some unknown method or attribute
       #
       # This is just for creating better message in raised exception
@@ -129,9 +127,13 @@ module Epuber
       #
       def method_missing(name, *args)
         if /([^=]+)=?/ =~ name
-          attr_name = $1
+          attr_name = ::Regexp.last_match(1)
           location = caller_locations.first
-          raise NameError, "Unknown attribute or method `#{attr_name}` for class `#{self.class}` in file `#{location.path}:#{location.lineno}`"
+          message = <<~MSG
+            Unknown attribute or method `#{attr_name}` for class `#{self.class}` in file `#{location.path}:#{location.lineno}`
+          MSG
+
+          raise NameError, message
         else
           super
         end

data/lib/epuber/dsl/tree_object.rb

@@ -10,7 +10,7 @@ module Epuber
       def initialize(parent = nil)
         super()
 
-        @parent      = parent
+        @parent = parent
         @sub_items = []
 
         parent.sub_items << self unless parent.nil?
@@ -94,8 +94,7 @@ module Epuber
 
       protected
 
-      attr_writer :parent
-      attr_writer :sub_items
+      attr_writer :parent, :sub_items
     end
   end
 end

data/lib/epuber/epubcheck.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Epuber
+  class Epubcheck
+    class << self
+      # @param [String] path path to file
+      #
+      def check(path)
+        res = system('epubcheck', path)
+
+        UI.error!('Epubcheck failed') unless res
+      end
+    end
+  end
+end

data/lib/epuber/helper.rb

@@ -2,7 +2,6 @@
 
 module Epuber
   module Helper
-
     # @param [Book::TocItem] toc_item
     # @param [Compiler::FileResolver] file_resolver
     # @param [String] context_path

data/lib/epuber/lockfile.rb

@@ -18,18 +18,16 @@ module Epuber
     # @return [self]
     #
     def self.from_file(file_path)
-      if File.exist?(file_path)
-        hash = YAML.safe_load(File.read(file_path))
-      else
-        hash = {}
-      end
+      hash = if File.exist?(file_path)
+               YAML.safe_load(File.read(file_path))
+             else
+               {}
+             end
 
       # backward compatibility for version 0.5 and older
-      if hash.include?('version')
-        hash['epuber_version'] = hash.delete('version')
-      end
+      hash['epuber_version'] = hash.delete('version') if hash.include?('version')
 
-      inst = self.new(hash)
+      inst = new(hash)
       inst.defined_from_file = file_path
       yield inst if hash.empty? && block_given?
       inst

data/lib/epuber/plugin.rb

@@ -18,7 +18,7 @@ module Epuber
         super(file_path)
         @instances = []
 
-        eval(::File.read(file_path), binding, file_path)
+        eval(::File.read(file_path), binding, file_path) # rubocop:disable Security/Eval
       end
 
       # @param [Symbol] name  name of the plugin function
@@ -97,7 +97,6 @@ module Epuber
       end.flatten
     end
 
-
     # @return [Array<Checker>]
     #
     def checkers

data/lib/epuber/ruby_extensions/match_data.rb

@@ -17,7 +17,7 @@ class MatchData
   #
   def line_number
     n = pre_match_lines.length
-    n += 1 if n == 0 # it can't be zero, this happens only when the match is at the beginning of file or string
+    n += 1 if n.zero? # it can't be zero, this happens only when the match is at the beginning of file or string
     n
   end
 

data/lib/epuber/ruby_extensions/thread.rb

@@ -6,6 +6,7 @@ class Thread
       def hash
         to_s.hash
       end
+
       def ==(other)
         to_s == other.to_s
       end

data/lib/epuber/server/base.styl

@@ -1,3 +1,2 @@
 
-main_font_family = AvenirNext
 text_color = #B87B4A

data/lib/epuber/server/basic.styl

@@ -9,7 +9,7 @@ body, div, html, p
 
 
 body
-  font-family main_font_family
+  font-family system-ui, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
   font-weight normal
   font-size 20px
 
@@ -184,32 +184,3 @@ p.file
   span.arrow
     font-family monospace
     color text_color
-
-
-
-
-
-
-@font-face
-  font-family AvenirNext
-  font-style normal
-  font-weight bold
-  src url(fonts/AvenirNext/AvenirNext-Bold.ttf)
-
-@font-face
-  font-family AvenirNext
-  font-style italic
-  font-weight bold
-  src url(fonts/AvenirNext/AvenirNext-BoldItalic.ttf)
-
-@font-face
-  font-family AvenirNext
-  font-style italic
-  font-weight normal
-  src url(fonts/AvenirNext/AvenirNext-Italic.ttf)
-
-@font-face
-  font-family AvenirNext
-  font-style normal
-  font-weight normal
-  src url(fonts/AvenirNext/AvenirNext-Regular.ttf)

data/lib/epuber/server/handlers.rb

@@ -49,7 +49,7 @@ module Epuber
     #
     def handle_bade(file_path)
       [200, self.class.render_bade(file_path)]
-    rescue => e
+    rescue StandardError => e
       env['sinatra.error'] = e
       ShowExceptions.new(self).call(env)
     end

data/lib/epuber/server.rb

@@ -23,9 +23,9 @@ require_relative 'third_party/bower'
 
 
 module Epuber
-
   # API:
-  # [LATER]   /file/<path-or-pattern> -- displays pretty file (image, text file) (for example: /file/text/s01.xhtml or /file/text/s01.bade)
+  # [LATER]   /file/<path-or-pattern> -- displays pretty file (image, text file) (for example: /file/text/s01.xhtml or
+  #                                      /file/text/s01.bade)
   #
   class Server < Sinatra::Base
     require_relative 'server/handlers'
@@ -42,11 +42,9 @@ module Epuber
           body = pretty(env, e)
         end
 
-        unless body.is_a?(Array)
-          body = [body]
-        end
+        body = [body] unless body.is_a?(Array)
 
-        [500, { 'Content-Type'   => content_type,
+        [500, { 'Content-Type' => content_type,
                 'Content-Length' => Rack::Utils.bytesize(body.join).to_s },
          body]
       end
@@ -118,7 +116,7 @@ module Epuber
 
       super() do |server|
         $stderr = old_stderr
-        puts "Started development server on #{server.host}:#{server.port}"
+        UI.puts "Started development server on #{server.host}:#{server.port}"
 
         host = if server.host == '0.0.0.0'
                  'localhost'
@@ -134,11 +132,11 @@ module Epuber
       @verbose = verbose
       @default_thin_logger ||= Thin::Logging.logger
 
-      unless verbose
+      if verbose
+        Thin::Logging.logger = @default_thin_logger
+      else
         Thin::Logging.logger = Logger.new(nil)
         Thin::Logging.logger.level = :fatal
-      else
-        Thin::Logging.logger = @default_thin_logger
       end
 
       set :logging, verbose
@@ -152,20 +150,18 @@ module Epuber
     end
 
     def self.start_listening_if_needed
-      return unless self.listener.nil?
+      return unless listener.nil?
 
       self.listener = Listen.to(Config.instance.project_path, debug: true) do |modified, added, removed|
-        begin
-          changes_detected(modified, added, removed)
-        rescue => e
-          # print error, do not send error further, listener will die otherwise
-          $stderr.puts e
-          $stderr.puts e.backtrace
-        end
+        changes_detected(modified, added, removed)
+      rescue StandardError => e
+        # print error, do not send error further, listener will die otherwise
+        warn e
+        warn e.backtrace
       end
 
-      listener.ignore(%r{\.idea})
-      listener.ignore(%r{#{Config.instance.working_path}})
+      listener.ignore(/\.idea/)
+      listener.ignore(/#{Config.instance.working_path}/)
       listener.ignore(%r{#{Config::WORKING_PATH}/})
 
       listener.start
@@ -183,7 +179,6 @@ module Epuber
       self.class.build_path
     end
 
-
     # @param level [Symbol]
     # @param message [String]
     #
@@ -192,13 +187,13 @@ module Epuber
     def self._log(level, message)
       case level
       when :ui
-        puts message
+        UI.puts message
       when :info
-        puts "INFO: #{message}" if verbose
+        UI.puts "INFO: #{message}" if verbose
       when :get
-        puts " GET: #{message}" if verbose
+        UI.puts " GET: #{message}" if verbose
       when :ws
-        puts "  WS: #{message}" if verbose
+        UI.puts "  WS: #{message}" if verbose
       else
         raise "Unknown log level #{level}"
       end
@@ -226,9 +221,9 @@ module Epuber
     # @return [Epuber::Book::File, nil]
     #
     def spine_file_at(index)
-      if !file_resolver.nil? && index >= 0 && index < file_resolver.spine_files.count
-        file_resolver.spine_files[index]
-      end
+      return unless !file_resolver.nil? && index >= 0 && index < file_resolver.spine_files.count
+
+      file_resolver.spine_files[index]
     end
 
     # @param [String] path
@@ -238,15 +233,14 @@ module Epuber
     def self.relative_path_to_book_file(path)
       file = file_resolver.file_with_source_path(path)
       return if file.nil?
+
       file.pkg_destination_path
     end
 
     def add_script_file_to_head(html_doc, file_name, *args)
       source = File.read(File.expand_path("server/#{file_name}", File.dirname(__FILE__)))
 
-      if File.extname(file_name) == '.coffee'
-        source = CoffeeScript.compile(source)
-      end
+      source = CoffeeScript.compile(source) if File.extname(file_name) == '.coffee'
 
       args.each do |hash|
         hash.each do |key, value|
@@ -302,14 +296,16 @@ module Epuber
       head = html_doc.at_css('head')
       node = case type
              when :style
-               html_doc.create_element('link',  href: "/server/raw/#{file_path}" ,rel: 'stylesheet', type: 'text/css')
+               html_doc.create_element('link', href: "/server/raw/#{file_path}", rel: 'stylesheet', type: 'text/css')
              when :js
                html_doc.create_element('script', src: "/server/raw/#{file_path}", type: 'text/javascript')
              else
                raise "Unknown file type `#{type}`"
              end
 
-      return if head.css('script, link').any? { |n| (!n['href'].nil? && n['href'] == node['href']) || (!n['src'].nil? && n['src'] == node['src']) }
+      return if head.css('script, link').any? do |n|
+                  (!n['href'].nil? && n['href'] == node['href']) || (!n['src'].nil? && n['src'] == node['src'])
+                end
 
       head.add_child(node)
     end
@@ -338,24 +334,22 @@ module Epuber
         self.target = new_target
       else
         self.target = book.targets.first
-        _log :ui, "[!] Not found previous target after reloading bookspec file, jumping to first #{self.target.name}"
+        _log :ui, "[!] Not found previous target after reloading bookspec file, jumping to first #{target.name}"
       end
     end
 
     def self._compile_book
-      begin
-        compiler = Epuber::Compiler.new(book, target)
-        compiler.compile(build_path)
-        self.file_resolver = compiler.file_resolver
+      compiler = Epuber::Compiler.new(book, target)
+      compiler.compile(build_path)
+      self.file_resolver = compiler.file_resolver
 
-        true
-      rescue => e
-        self.file_resolver = compiler.file_resolver
+      true
+    rescue StandardError => e
+      self.file_resolver = compiler.file_resolver
 
-        Epuber::UI.error("Compile error: #{e}", location: e)
+      Epuber::UI.error("Compile error: #{e}", location: e)
 
-        false
-      end
+      false
     end
 
     def self.compile_book(&completion)
@@ -366,12 +360,12 @@ module Epuber
 
       @compilation_thread = Thread.new do
         result = _compile_book
-        completion.call(result) unless completion.nil?
+        completion&.call(result)
       end
 
-      if completion.nil?
-        @compilation_thread.join
-      end
+      return unless completion.nil?
+
+      @compilation_thread.join
     end
 
     # @param message [String]
@@ -387,7 +381,8 @@ module Epuber
     # @param type [Symbol]
     def self.notify_clients(type, data = nil)
       _log :info, "Notifying clients with type #{type.inspect}"
-      raise "Not known type `#{type}`" unless [:styles, :reload, :compile_start, :compile_end].include?(type)
+      raise "Not known type `#{type}`" unless %i[styles reload compile_start compile_end].include?(type)
+
       message = {
         name: type,
       }
@@ -406,17 +401,17 @@ module Epuber
       files_paths.select { |file| file_resolver.file_with_source_path(file) || book.file_path == file }
     end
 
-    # @param _modified [Array<String>]
-    # @param _added [Array<String>]
-    # @param _removed [Array<String>]
+    # @param modified [Array<String>]
+    # @param added [Array<String>]
+    # @param removed [Array<String>]
     #
-    def self.changes_detected(_modified, _added, _removed)
-      all_changed = (_modified + _added + _removed).uniq.map { |path| path.unicode_normalize }
+    def self.changes_detected(modified, added, removed)
+      all_changed = (modified + added + removed).uniq.map(&:unicode_normalize)
 
       reload_bookspec if all_changed.any? { |file| file == book.file_path }
 
       changed = filter_not_project_files(all_changed) || []
-      return if changed.count == 0
+      return if changed.count.zero?
 
       notify_clients(:compile_start)
 
@@ -440,11 +435,15 @@ module Epuber
         # remove nil paths (for example bookspec can't be found so the relative path is nil)
         changed.compact!
 
-        # if changed.size > 0 && changed.all? { |file| file.end_with?(*Epuber::Compiler::FileFinders::GROUP_EXTENSIONS[:style]) }
-          # notify_clients(:styles, changed)
-        # else
+        changed_only_styles = changed.all? do |file|
+          file.end_with?(*Epuber::Compiler::FileFinders::GROUP_EXTENSIONS[:style])
+        end
+
+        if changed.size.positive? && changed_only_styles
+          notify_clients(:styles, changed)
+        else
           notify_clients(:reload, changed)
-        # end
+        end
       end
     end
 
@@ -460,12 +459,12 @@ module Epuber
         ws.onopen do
           sockets << ws
 
-          ws.send({name: :hello}.to_json)
+          ws.send({ name: :hello }.to_json)
 
           thread = Thread.new do
             loop do
               sleep(10)
-              ws.send({name: :heartbeat}.to_json)
+              ws.send({ name: :heartbeat }.to_json)
             end
           end
         end
@@ -490,6 +489,7 @@ module Epuber
       mtime = File.mtime(file_path)
       last_modified(mtime)
       etag(mtime.to_s)
+      cache_control :public, :must_revalidate
 
       case File.extname(file_path)
       when '.styl'
@@ -571,11 +571,11 @@ module Epuber
         full_path = File.expand_path(path, build_path)
 
         case File.extname(full_path)
-          when '.xhtml'
-            content_type :xhtml
-            handle_xhtml_file(full_path)
-          else
-            handle_file(full_path)
+        when '.xhtml'
+          content_type :xhtml
+          handle_xhtml_file(full_path)
+        else
+          handle_file(full_path)
         end
       end
     end
@@ -621,6 +621,7 @@ module Epuber
     get '/raw/*' do
       path = find_file
       next not_found if path.nil?
+
       handle_file(File.expand_path(path, build_path))
     end
 

data/lib/epuber/third_party/bower.rb

@@ -5,12 +5,12 @@ module Epuber
     class Bower
       class << self
         JS_COMPONENTS = {
-          jquery:    'jquery/dist/',
-          cookies:   'cookies-js/dist/',
-          uri:       'uri.js/src/',
-          spin:      'spin.js/',
+          jquery: 'jquery/dist/',
+          cookies: 'cookies-js/dist/',
+          uri: 'uri.js/src/',
+          spin: 'spin.js/',
           keymaster: 'keymaster/',
-        }
+        }.freeze
 
         def path_to_js(component)
           path = JS_COMPONENTS[component]

data/lib/epuber/transformer/text_transformer.rb

@@ -5,7 +5,6 @@ require_relative '../transformer'
 module Epuber
   class Transformer
     class TextTransformer < Transformer
-
       # @return [String]
       #
       attr_accessor :text
@@ -51,7 +50,10 @@ module Epuber
                    @text.gsub!(pattern, replacement, &block)
                  end
 
-        result = replace_all(pattern, replacement, multiple_times: multiple_times, &block) if multiple_times && !result.nil?
+        if multiple_times && !result.nil?
+          result = replace_all(pattern, replacement, multiple_times: multiple_times,
+                               &block)
+        end
         result
       end
     end

data/lib/epuber/transformer.rb

@@ -10,8 +10,8 @@ module Epuber
     #
     def self.map_source_type__class
       {
-        :result_text_xhtml_string => TextTransformer,
-        :source_text_file         => TextTransformer,
+        result_text_xhtml_string: TextTransformer,
+        source_text_file: TextTransformer,
       }.merge(super)
     end
   end