epuber 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2899b08ccdd624b08c96377e111df6872f4c6b0871ee689e28d1264d42bf5294
-  data.tar.gz: 6391e4b90172bc5d06d7c3f903aafa52efab3917ee0daaaf406723f3ee2d381f
+  metadata.gz: 6560c1375c0b773b66e5938c09a94767ad7a9e8dae29b670e469028828e88db9
+  data.tar.gz: e6c72d1f60af9ea5b2f60b7bd9ee044d8896abe0d3e0a8ebead44965a1971876
 SHA512:
-  metadata.gz: 7a2df3f599de46ca5c5e976154d32752981fa9d2a76e0a46754b91f5583c3e671c3ab77c777bc8511dbda09f23ea0a8534d16656a1dfce4748b762fa7d7c3947
-  data.tar.gz: b5d8d5556ce730d2215a6239405a56505f87e649fa1b06078cb2145f524c2d59e82d2789b21d0873c573079daa807ff9cc3d22b16bf26d85f4e223ac20ead502
+  metadata.gz: 40f4c800bb62695192e7934402dae40c34540b0eebc175cc951bce8d669e4e9d61c855864281b134945d9e5b51f41467fb329a1a66ca47b326af2383151b2956
+  data.tar.gz: aa8ad6eeba9f8f0223dc3a4a62aef8477a0a6c7444441f871eb3a4d7138f60f3891e27227c49f96076669b9842a87c9e10e271822cb78a03f80712b237bf74cb

data/Gemfile

@@ -1,9 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in Epuber.gemspec
 gemspec
 
-gem 'ruby-debug-ide'
-gem 'debase'
+group :dev, optional: true do
+  gem 'debase', require: false
+  gem 'ruby-debug-ide', require: false
+end

data/README.md

@@ -67,7 +67,7 @@ Except for paths to plugins `book.use`, every path could be only name of the fil
 
 First of all Epuber uses [RMagick](https://github.com/rmagick/rmagick) which has several external dependencies, so you have to install that first:
 
-- ImageMagick (only v6 for now)
+- ImageMagick
 - pkg-config
 
 On OS X make sure you Xcode Command Line Tools installed:
@@ -76,13 +76,11 @@ On OS X make sure you Xcode Command Line Tools installed:
 
 And the easiest way to install prerequisites on macOS is to use [brew](http://brew.sh):
 
-    brew install imagemagick@6 node@12 pkg-config
-    brew link --force imagemagick@6
-    brew link --force --overwrite node@12
+    brew install imagemagick node pkg-config
 
 On Ubuntu, you can run:
 
-    sudo apt-get install libmagickwand-dev
+    sudo apt install libmagickwand-dev
 
 
 ### Finish
@@ -108,12 +106,6 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 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.
 
 
-## TODO
-
-- [ ] move all cards from Trello to GitHub
-- [ ] create documentation 
-- [ ] create several examples of book specification
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/bin/epuber

@@ -1,10 +1,9 @@
 #!/usr/bin/env ruby -Ku
-# encoding: utf-8
+# frozen_string_literal: true
 
-lib = File.expand_path('../lib', File.dirname(__FILE__))
+lib = File.expand_path('../lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'epuber'
 
-
 Epuber::Command.run(ARGV)

data/epuber.gemspec

@@ -1,6 +1,4 @@
-# encoding: utf-8
-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'epuber/version'
@@ -21,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'activesupport', '~> 6.0'
+  spec.add_runtime_dependency 'activesupport', '>= 6.0', '< 8.0'
   spec.add_runtime_dependency 'addressable', '~> 2.7'
   spec.add_runtime_dependency 'nokogiri', '~> 1.8', '>= 1.8.2'
   spec.add_runtime_dependency 'mime-types', '~> 3.0'
@@ -41,9 +39,8 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'epuber-stylus', '~> 1.1', '>= 1.1.1'
   spec.add_runtime_dependency 'coffee-script', '~> 2.4'
-  spec.add_runtime_dependency 'bade', '~> 0.2.4'
+  spec.add_runtime_dependency 'bade', '~> 0.3', '>= 0.3.1'
 
-  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rspec', '~> 3.2'
   spec.add_development_dependency 'rubocop', '~> 1.14'
   spec.add_development_dependency 'rake', '~> 13.0'

data/lib/epuber/book/contributor.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Epuber
   class Book

data/lib/epuber/book/file_request.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Epuber
   class Book

data/lib/epuber/book/target.rb

@@ -1,10 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative '../vendor/version'
 require_relative '../vendor/size'
 require_relative '../dsl/tree_object'
 
-
 module Epuber
   class Book
     require_relative 'file_request'

data/lib/epuber/book/toc_item.rb

@@ -1,8 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative '../dsl/tree_object'
 
-
 module Epuber
   class Book
     require_relative 'file_request'

data/lib/epuber/book.rb

@@ -1,8 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative 'dsl/object'
 
-
 module Epuber
   class Book < DSL::Object
     require_relative 'book/contributor'

data/lib/epuber/checker/text_checker.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'active_support/core_ext/string/access'
 

data/lib/epuber/checker.rb

@@ -1,8 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative 'checker_transformer_base'
 
-
 module Epuber
   class Checker < CheckerTransformerBase
     require_relative 'checker/text_checker'

data/lib/epuber/checker_transformer_base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module Epuber
   class CheckerTransformerBase

data/lib/epuber/command/build.rb

@@ -1,11 +1,10 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'fileutils'
 require 'os'
 
 require_relative '../command'
 
-
 module Epuber
   class Command
     class Build < Command

data/lib/epuber/command/compile.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative 'build'
 

data/lib/epuber/command/init.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'fileutils'
 
@@ -6,7 +6,6 @@ require_relative '../templates'
 require_relative '../command'
 require_relative '../vendor/ruby_templater'
 
-
 module Epuber
   class Command
     class Init < Command

data/lib/epuber/command/server.rb

@@ -1,9 +1,8 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative '../command'
 require 'os'
 
-
 module Epuber
   class Command
     class Server < Command

data/lib/epuber/command.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'claide'
 

data/lib/epuber/compiler/compilation_context.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 
 module Epuber

data/lib/epuber/compiler/file_database.rb

@@ -1,8 +1,6 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
-require 'yaml'
-
+require 'psych'
 
 module Epuber
   class Compiler
@@ -22,8 +20,8 @@ module Epuber
       #
       def initialize(path)
         @store_file_path = path
-        @all_files = YAML.load_file(path) || {}
-      rescue
+        @all_files = Psych.load_file(path, permitted_classes: [Epuber::Compiler::FileStat, Time]) || {}
+      rescue StandardError
         @all_files = {}
       end
 

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

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Epuber
   class Compiler

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

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Epuber
   class Compiler
@@ -169,4 +169,3 @@ module Epuber
     end
   end
 end
-

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

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Epuber
   class Compiler

data/lib/epuber/compiler/file_resolver.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'active_support/core_ext/object/try'
 

data/lib/epuber/compiler/file_stat.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module Epuber

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

@@ -1,5 +1,4 @@
-# encoding: utf-8
-
+# frozen_string_literal: true
 
 module Epuber
   class Compiler

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

@@ -1,8 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'bade'
 
-
 module Epuber
   class Compiler
     module FileTypes

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

@@ -1,8 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'coffee-script'
 
-
 module Epuber
   class Compiler
     module FileTypes

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

@@ -1,5 +1,4 @@
-# encoding: utf-8
-
+# frozen_string_literal: true
 
 module Epuber
   class Compiler

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

@@ -1,5 +1,4 @@
-# encoding: utf-8
-
+# frozen_string_literal: true
 
 module Epuber
   class Compiler

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

@@ -1,5 +1,4 @@
-# encoding: utf-8
-
+# frozen_string_literal: true
 
 module Epuber
   class Compiler
@@ -24,8 +23,3 @@ module Epuber
     end
   end
 end
-
-
-
-
-

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

@@ -1,8 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'rmagick'
 
-
 module Epuber
   class Compiler
     module FileTypes

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

@@ -1,5 +1,4 @@
-# encoding: utf-8
-
+# frozen_string_literal: true
 
 module Epuber
   class Compiler

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

@@ -1,5 +1,4 @@
-# encoding: utf-8
-
+# frozen_string_literal: true
 
 module Epuber
   class Compiler

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

@@ -1,5 +1,4 @@
-# encoding: utf-8
-
+# frozen_string_literal: true
 
 module Epuber
   class Compiler

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

@@ -1,5 +1,4 @@
-# encoding: utf-8
-
+# frozen_string_literal: true
 
 module Epuber
   class Compiler

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

@@ -1,5 +1,4 @@
-# encoding: utf-8
-
+# frozen_string_literal: true
 
 module Epuber
   class Compiler

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

@@ -1,8 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'epuber-stylus'
 
-
 module Epuber
   class Compiler
     module FileTypes

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

@@ -1,5 +1,4 @@
-# encoding: utf-8
-
+# frozen_string_literal: true
 
 module Epuber
   class Compiler
@@ -9,7 +8,6 @@ module Epuber
       require_relative 'source_file'
 
       class XHTMLFile < SourceFile
-
         # @return [Epuber::Book::TocItem]
         #
         attr_accessor :toc_item
@@ -52,7 +50,7 @@ module Epuber
           compilation_context.perform_plugin_things(Transformer, :source_text_file) do |transformer|
             xhtml_content = transformer.call(abs_source_path, xhtml_content, compilation_context)
           end
-          
+
           # perform custom validation
           if compilation_context.should_check
             compilation_context.perform_plugin_things(Checker, :source_text_file) do |checker|

data/lib/epuber/compiler/generator.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'nokogiri'
 

data/lib/epuber/compiler/meta_inf_generator.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'mime-types'
 

data/lib/epuber/compiler/nav_generator.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative '../book/toc_item'
 

data/lib/epuber/compiler/opf_generator.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'time'
 

data/lib/epuber/compiler/problem.rb

@@ -1,5 +1,4 @@
-# encoding: utf-8
-
+# frozen_string_literal: true
 
 module Epuber
   class Compiler

data/lib/epuber/compiler/xhtml_processor.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'nokogiri'
 require 'addressable'
@@ -20,6 +20,8 @@ module Epuber
       # @return [Nokogiri::XML::Document] parsed document
       #
       def self.xml_doc_from_str_with_errors(text, file_path = nil)
+        text = text.dup
+
         if /\A[\n\r ]+(<\?xml)/ =~ text
           UI.warning('XML header must be at the beginning of document', location: UI::Location.new(file_path, 1))
 

data/lib/epuber/compiler.rb

@@ -1,18 +1,13 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'English'
-
 require 'pathname'
 require 'fileutils'
-
 require 'zip'
 
 require_relative 'vendor/nokogiri_extensions'
-require_relative 'vendor/globals_context'
-
 require_relative 'plugin'
 
-
 module Epuber
   class Compiler
     require_relative 'compiler/compilation_context'
@@ -29,10 +24,11 @@ module Epuber
 
     EPUB_CONTENT_FOLDER = 'OEBPS'
 
-    # @return [Epuber::GlobalsContext]
+    # @return [Bade::Runtime::GlobalsTracker]
     #
-    def self.globals_catcher
-      @globals_catcher ||= Epuber::GlobalsContext.new
+    def self.globals_tracker
+      @globals_tracker ||=
+        Bade::Runtime::GlobalsTracker.new(constants_location_prefixes: [Config.instance.project_path])
     end
 
     # @return [Epuber::Compiler::FileResolver]
@@ -70,7 +66,7 @@ module Epuber
       compilation_context.verbose = verbose
       compilation_context.use_cache = use_cache
 
-      self.class.globals_catcher.catch do
+      self.class.globals_tracker.catch do
         @build_folder = build_folder
 
         FileUtils.mkdir_p(build_folder)
@@ -100,7 +96,7 @@ module Epuber
         compilation_context.target_file_database.save_to_file
       end
     ensure
-      self.class.globals_catcher.clear_all
+      self.class.globals_tracker.clear_all
     end
 
     # Archives current target files to epub

data/lib/epuber/config.rb

@@ -1,10 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'pathname'
 require 'bade'
 require_relative 'lockfile'
 
-
 module Epuber
   class Config
     WORKING_PATH = '.epuber'

data/lib/epuber/dsl/attribute.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'date'
 

data/lib/epuber/dsl/attribute_support.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 
 module Epuber
@@ -18,7 +18,7 @@ module Epuber
       # @return nil
       #
       def attribute(name, options = {})
-        attr = Attribute.new(name, options)
+        attr = Attribute.new(name, **options)
 
         dsl_attributes[name] = attr
 

data/lib/epuber/dsl/object.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative 'attribute'
 require_relative 'attribute_support'

data/lib/epuber/dsl/tree_object.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative 'object'
 

data/lib/epuber/helper.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Epuber
   module Helper

data/lib/epuber/lockfile.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'yaml'
 require_relative 'vendor/version'

data/lib/epuber/plugin.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative 'checker'
 require_relative 'transformer'

data/lib/epuber/ruby_extensions/match_data.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 class MatchData
   # @return [Array<String>]

data/lib/epuber/ruby_extensions/thread.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 class Thread
   class Backtrace

data/lib/epuber/server/handlers.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'nokogiri'