epuber 0.3.5

data/lib/epuber/book/file_request.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+
+module Epuber
+  class Book
+    class FileRequest
+      # @return [String]
+      #
+      attr_accessor :source_pattern
+
+      # @return [Symbol]
+      #
+      attr_accessor :group
+
+      # When looking for file, the resulted list should contain only one file
+      #
+      # Default: true
+      #
+      # @return [Bool]
+      #
+      attr_accessor :only_one
+
+      # @return [Set<String>]
+      #
+      attr_accessor :properties
+
+
+      # @param [String] source_pattern pattern describing path to file
+      # @param [Bool] only_one find only one file, otherwise look for all files matching pattern in project
+      # @param [Symbol] group group of file, see Epuber::Compiler::FileFinder::GROUP_EXTENSIONS
+      # @param [Array<Symbol>, Set<Symbol>] properties list of properties
+      #
+      def initialize(source_pattern, only_one = true, group: nil, properties: [])
+        @source_pattern = source_pattern
+        @only_one       = only_one
+        @group          = group
+        @properties     = properties.to_set
+      end
+
+      # @return [Bool]
+      #
+      def eql?(other)
+        self == other
+      end
+
+      # @return [Numeric]
+      #
+      def hash
+        @source_pattern.hash ^ @group.hash ^ @only_one.hash
+      end
+
+      # @param other [String, self]
+      #
+      def ==(other)
+        if other.is_a?(String)
+          @source_pattern == other
+        else
+          @source_pattern == other.source_pattern && @group == other.group && @only_one == other.only_one
+        end
+      end
+
+      # @return [String]
+      #
+      def to_s
+        "#<#{self.class} pattern:`#{@source_pattern}` group:`#{@group}` only_one:`#{@only_one}`>"
+      end
+    end
+  end
+end

data/lib/epuber/book/target.rb

@@ -0,0 +1,284 @@
+# encoding: utf-8
+
+require_relative '../vendor/version'
+require_relative '../vendor/size'
+require_relative '../dsl/tree_object'
+
+
+module Epuber
+  class Book
+    require_relative 'file_request'
+
+    class Target < DSL::TreeObject
+      # @param [Target] parent  reference to parent target
+      # @param [String] name  name of this target
+      #
+      def initialize(parent = nil, name)
+        super(parent)
+
+        @name      = name
+        @is_ibooks = nil
+        @book      = nil
+        @files     = []
+        @constants = {}
+        @root_toc  = TocItem.new
+
+        @default_styles = []
+        @plugins = []
+      end
+
+      def freeze
+        super
+        @files.freeze
+        @files.each(&:freeze)
+
+        @default_styles.freeze
+        @default_styles.each(&:freeze)
+
+        @plugins.freeze
+        @plugins.each(&:freeze)
+
+        @root_toc.freeze
+        @constants.freeze
+      end
+
+      # @return [String, Symbol] target name
+      #
+      attr_reader :name
+
+      # @return [Array<self>] list of sub targets
+      #
+      alias_method :sub_targets, :sub_items
+
+      # @return [Epuber::Book::TocItem]
+      #
+      attr_reader :root_toc
+
+      # @return [Epuber::Book] reference to book
+      #
+      attr_accessor :book
+
+      # @return [Epuber::Book] reference to book
+      #
+      def book
+        @book || (parent && parent.book)
+      end
+
+
+      # Create new sub_target with name
+      #
+      # @param [String] name
+      #
+      # @return [Target] new created sub target
+      #
+      def sub_target(name)
+        child = create_child_item(name)
+
+        yield child if block_given?
+
+        child
+      end
+
+      #------------- other methods ---------------------------------
+
+      # @return [Bool]
+      #
+      def ibooks?
+        if is_ibooks.nil?
+          name.to_s.include?('ibooks')
+        else
+          is_ibooks
+        end
+      end
+
+      # Returns all files
+      # @return [Array<Epuber::Book::FileRequest>]
+      #
+      def files
+        # parent files plus our files
+        all_files = ((parent && parent.files) || []) + @files + @default_styles
+
+        unless @attributes_values[:cover_image].nil?
+          all_files << @attributes_values[:cover_image]
+        end
+
+        all_files
+      end
+
+      # Returns all constants
+      # @return [Hash<String, Object>]
+      #
+      def constants
+        ((parent && parent.constants) || {}).merge(@constants)
+      end
+
+      # @return [Array<Epuber::Book::FileRequest>]
+      #
+      def default_styles
+        ((parent && parent.default_styles) || []) + @default_styles
+      end
+
+      # @return [Array<String>]
+      #
+      def plugins
+        ((parent && parent.plugins) || []) + @plugins
+      end
+
+      #----------------------- DSL items ---------------------------
+
+
+
+      # @return [String] version of result epub
+      #
+      attribute :epub_version,
+                required:     true,
+                inherited:    true,
+                types:        [Version],
+                auto_convert: { [String, Fixnum, Float] => Version },
+                default_value: 3.0
+
+      # @return [String] isbn of epub
+      #
+      attribute :isbn,
+                inherited: true
+
+      # @return [String] book identifier used in OPF file
+      #
+      attribute :identifier,
+                inherited: true
+
+      # @return [String] target will use custom font (for iBooks only)
+      #
+      attribute :custom_fonts,
+                types:     [TrueClass, FalseClass],
+                inherited: true
+
+      # @return [Bool] hint for compiler to add some iBooks related stuff
+      #
+      attribute :is_ibooks,
+                types:     [TrueClass, FalseClass],
+                inherited: true
+
+      # @return [Bool] whether the target uses fixed layout
+      #
+      attribute :fixed_layout,
+                types:     [TrueClass, FalseClass],
+                inherited: true
+
+      # @return [FileRequest] file request to cover image
+      #
+      attribute :cover_image,
+                types:        [FileRequest],
+                inherited:    true,
+                auto_convert: { [String] => ->(value) { FileRequest.new(value, group: :image, properties: [:cover_image]) } }
+
+      # @return [Size] size of view port, mainly this is used for fixed layout
+      #
+      attribute :default_viewport,
+                types:     [Size],
+                inherited: true
+
+      # @return [Bool] whether the target should create mobi
+      #
+      attribute :create_mobi,
+                types:     [TrueClass, FalseClass],
+                inherited: true
+
+
+      # @param file_path [String | Epuber::Book::File]
+      # @param group [Symbol]
+      #
+      # @return [Epuber::Book::File] created file
+      #
+      def add_file(file_path, group: nil)
+        file = if file_path.is_a?(FileRequest)
+                 file_path
+               else
+                 FileRequest.new(file_path, group: group)
+               end
+
+
+        old_file = @files.find { |f| f == file }
+
+        if old_file.nil?
+          @files << file
+          file
+        else
+          old_file
+        end
+      end
+
+      # @param file_paths [Array<String>]
+      #
+      # @return [void]
+      #
+      def add_files(*file_paths)
+        file_paths.each do |file_path|
+          file_obj          = add_file(file_path)
+          file_obj.only_one = false
+        end
+      end
+
+      # @param key [String]
+      # @param value [String]
+      #
+      # @return [void]
+      #
+      def add_const(key, value = nil)
+        if key.is_a?(Hash) && value.nil?
+          @constants.merge!(key)
+        else
+          @constants[key] = value
+        end
+      end
+
+
+      # @param file_paths [Array<String>]
+      #
+      # @return [void]
+      #
+      def add_default_style(*file_paths)
+        file_paths.map do |file_path|
+          file_obj          = add_file(file_path, group: :style)
+          file_obj.only_one = true
+
+          @default_styles << file_obj unless @default_styles.include?(file_obj)
+        end
+      end
+
+      # 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>]
+      #
+      # @return [void]
+      #
+      def add_default_styles(*file_paths)
+        file_paths.map do |file_path|
+          file_obj          = add_file(file_path, group: :style)
+          file_obj.only_one = false
+
+          @default_styles << file_obj unless @default_styles.include?(file_obj)
+        end
+      end
+
+      # @yield [toc_item, target]
+      # @yieldparam toc_item [TocItem] root toc item
+      # @yieldparam target [self] current target
+      #
+      # @return nil
+      #
+      def toc
+        yield(@root_toc, self) if block_given?
+      end
+
+      # @param path [String] use some file/module/package
+      #
+      # @return [nil]
+      #
+      def use(path)
+        @plugins << path
+      end
+    end
+  end
+end

data/lib/epuber/book/toc_item.rb

@@ -0,0 +1,130 @@
+# encoding: utf-8
+
+require_relative '../dsl/tree_object'
+
+
+module Epuber
+  class Book
+    require_relative 'file_request'
+
+    class TocItem < DSL::TreeObject
+      # @return [Epuber::Book::FileRequest]
+      #
+      attribute :file_request,
+                types:        [FileRequest],
+                auto_convert: { String => FileRequest },
+                inherited:    true
+
+      # @return [String]
+      #
+      attribute :title
+
+      # @return [Array<Symbol | Hash<Symbol, Object>>]
+      #
+      attribute :options,
+                default_value: []
+
+      # @return [String]
+      #
+      attr_accessor :file_fragment
+
+
+      # --------------
+
+      # @return [Array<Symbol>]
+      #
+      def landmarks
+        options.select do |item|
+          item.is_a?(Symbol) && item.to_s.start_with?('landmark')
+        end
+      end
+
+      # @return [Bool]
+      #
+      def linear?
+        first = options.select do |item|
+          item.is_a?(Hash) && (item.include?(:linear) || item.include?('linear'))
+        end.first
+
+        if first.nil?
+          true
+        else
+          first.values.first
+        end
+      end
+
+      # @return [String]
+      #
+      def full_source_pattern
+        [file_request.source_pattern, file_fragment].compact.join('#')
+      end
+
+      # @return [String]
+      #
+      def local_source_pattern
+        file_request = attributes_values[:file_request]
+
+        return "##{file_fragment}" if file_request.nil?
+
+        [file_request.source_pattern, file_fragment].compact.join('#')
+      end
+
+
+      # -------------- creating sub items -----------------
+
+      # Creating sub item from file
+      #
+      # @example
+      #      toc.file 'ch01', 'Chapter 1', :landmark_start_page
+      #      toc.file 'ch02', :landmark_copyright
+      #      toc.file 'ch03', :linear => false
+      #      toc.file 'ch04', linear: false
+      #
+      # @param [String] file_path pattern describing path to file
+      # @param [String] title title of this item
+      #
+      def file(file_path, title = nil, *opts)
+        create_child_item do |item|
+          unless file_path.nil?
+            file_pattern, file_fragment = file_path.split('#')
+
+            unless file_pattern.nil? || file_pattern.empty?
+              file_obj = FileRequest.new(file_pattern, group: :text)
+              item.file_request = file_obj
+            end
+
+            unless file_fragment.nil? || file_fragment.empty?
+              item.file_fragment = file_fragment
+            end
+          end
+
+          if title.is_a?(String)
+            item.title = title
+          else
+            opts.unshift(title)
+          end
+
+          item.options = opts.map do |i|
+            if i.is_a?(Hash)
+              i.map do |j_key, j_value|
+                { j_key => j_value }
+              end
+            else
+              i
+            end
+          end.flatten
+
+          yield item if block_given?
+        end
+      end
+
+      # Creating sub item without reference to file
+      #
+      # @param [String] title
+      #
+      def item(title, *opts)
+        file(nil, title, *opts)
+      end
+    end
+  end
+end