fb2rb 0.1.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1f9023970c90759eb32f56a5bbef46864bb5b6bbe74801b63d74b215bc20741
-  data.tar.gz: a44854f8a96a67c36a3bc7e3f66a24209de49d211508f267ccf6fe7f1fcf1651
+  metadata.gz: 3232aa66bba2be36e9f72b67c198a6b2e1b8e13d2cb51746264b44daaab9c60e
+  data.tar.gz: 00c679822965363b7ffade747f1898f9d5a687c408cab6240afa8ac150108593
 SHA512:
-  metadata.gz: '062709548a3e5d5fd83ec9b85709f5beb5018d5d5b490dcc6f81af71c09d7e9a7d0c5bcd7b14fb1cff55491cda656987b55518f11c299f222918eba58d406ec4'
-  data.tar.gz: 45c0b3159351d8636695df9ec95a55b62ba7810af3b8320ed1210ea0895fd53a6cf35433bb803878133597f4f839c242efa9731004521c953475d0d56c1a8b13
+  metadata.gz: 7684b0249c15f2ca45fd209df32b6dae4f52192d0aa2cf17fff9c63c83666bbec7c1c7aafc5c4055e87a13f2967113056a81d94c5bc490448897a61f73695255
+  data.tar.gz: 9e93f45e0567bac65cdf97b9c18d2912b869d5a605d228e1bf667e58739a915a092d5623b6b385fe844817e337457444bca74580ebdb9bcd5720dcaef6af304a

data/.github/dependabot.yml

@@ -6,3 +6,8 @@ updates:
     directory: "/"
     schedule:
       interval: "daily"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/release.yml

@@ -13,12 +13,6 @@ jobs:
       with:
         ruby-version: 2.7
     - name: Publish to RubyGems.org
-      run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:rubygems_api_key: ${RUBYGEMS_API_KEY}\n" > $HOME/.gem/credentials
-        gem build *.gemspec
-        gem push *.gem
-      env:
-        RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
+      uses: dawidd6/action-publish-gem@v1
+      with:
+        api_key: ${{ secrets.RUBYGEMS_API_KEY }}

data/CHANGELOG.adoc

@@ -7,9 +7,32 @@
 This document provides a high-level view of the changes to the {project-name} by release.
 For a detailed view of what has changed, refer to the {uri-project}/commits/master[commit history] on GitHub.
 
+== 0.5.0 (2020-12-07) - @slonopotamus
+
+* return `nil` from `FB2rb::Book.read_compressed` for empty ZIP files
+* **breaking change**: switch to named parameters instead of optional
+
+== 0.4.0 (2020-11-24) - @slonopotamus
+
+* add `Book::add_stylesheet` method
+
+== 0.3.0 (2020-07-27) - @slonopotamus
+
+* Support reading/writing uncompressed FB2. https://github.com/slonopotamus/fb2rb/issues/5[#5]
+
+== 0.2.1 (2020-07-24) - @slonopotamus
+
+* Fix field annotation on `FB2rb::TitleInfo::date`
+
+== 0.2.0 (2020-07-24) - @slonopotamus
+
+* Add support for reproducible builds
+* Remove broken `FB2rb::Book.to_ios`.
+Use `FB2rb::Book.write` instead.
+
 == 0.1.1 (2020-07-23) - @slonopotamus
 
-* Annonate field types
+* Annotate field types
 * Fix serialization of `<publisher>` in `<document-info>`
 
 == 0.1.0 (2020-07-23) - @slonopotamus

data/README.adoc

@@ -37,6 +37,8 @@ $ gem install fb2rb
 
 == Usage
 
+You can create FB2 book in memory and write it to file:
+
 [source,ruby]
 ----
 require 'fb2rb'
@@ -47,7 +49,23 @@ book.description.title_info.book_title = 'Book title'
 body = FB2rb::Body.new(nil, '<p>Book text</p>')
 book.bodies << body
 
-book.write('/path/to/book.fb2.zip')
+book.write_compressed('/path/to/book.fb2.zip')
+# or
+book.write_uncompressed('/path/to/book.fb2')
+----
+
+Also, you can read existing FB2 file:
+
+[source,ruby]
+----
+require 'fb2rb'
+
+book = FB2rb::Book.read_compressed('/path/to/book.fb2.zip')
+# or
+book = FB2rb::Book.read_uncompressed('/path/to/book.fb2')
+
+puts book.description.title_info.book_title
+puts book.bodies[0].content
 ----
 
 == Development

data/fb2rb.gemspec

@@ -22,7 +22,8 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'rubyzip', '~> 2.3.0'
 
   s.add_development_dependency 'rake', '~> 13.0.0'
-  s.add_development_dependency 'rspec', '~> 3.9.0'
-  s.add_development_dependency 'rubocop', '~> 0.88.0'
-  s.add_development_dependency 'rubocop-rspec', '~> 1.42.0'
+  s.add_development_dependency 'rspec', '~> 3.10.0'
+  s.add_development_dependency 'rubocop', '~> 1.5.0'
+  s.add_development_dependency 'rubocop-rake', '~> 0.5.0'
+  s.add_development_dependency 'rubocop-rspec', '~> 2.0.0'
 end

data/lib/fb2rb.rb

@@ -12,7 +12,7 @@ module FB2rb
   XLINK_NAMESPACE = 'http://www.w3.org/1999/xlink'
 
   # Holds data of a single FB2 file
-  class Book
+  class Book # rubocop:disable Metrics/ClassLength
     # @return [Array<FB2rb::Stylesheet>]
     attr_accessor(:stylesheets)
     # @return [FB2rb::Description]
@@ -22,47 +22,73 @@ module FB2rb
     # @return [Array<FB2fb::Binary>]
     attr_accessor(:binaries)
 
-    def initialize(description = Description.new, bodies = [], binaries = [], stylesheets = [])
+    def initialize(description: Description.new, bodies: [], binaries: [], stylesheets: [])
       @binaries = binaries
       @bodies = bodies
       @description = description
       @stylesheets = stylesheets
     end
 
-    # Reads existing FB2 file from an IO object, and creates new Book object.
-    # @return [FB2rb::Book]
-    def self.read(filename_or_io)
-      Zip::InputStream.open(filename_or_io) do |zis|
-        while (entry = zis.get_next_entry)
-          next if entry.directory?
+    class << self
+      # Reads existing compressed FB2 file from an IO object, and creates new Book object.
+      # @return [FB2rb::Book, nil]
+      def read_compressed(filename_or_io)
+        Zip::InputStream.open(filename_or_io) do |zis|
+          while (entry = zis.get_next_entry)
+            next if entry.directory?
 
-          xml = Nokogiri::XML::Document.parse(zis)
-          fb2_prefix = ns_prefix(FB2rb::FB2_NAMESPACE, xml.namespaces)
-          xlink_prefix = ns_prefix(FB2rb::XLINK_NAMESPACE, xml.namespaces)
-          return parse(xml, fb2_prefix, xlink_prefix)
+            xml = Nokogiri::XML::Document.parse(zis)
+            fb2_prefix = ns_prefix(FB2rb::FB2_NAMESPACE, xml.namespaces)
+            xlink_prefix = ns_prefix(FB2rb::XLINK_NAMESPACE, xml.namespaces)
+            return parse(xml, fb2_prefix, xlink_prefix)
+          end
         end
+        nil
       end
-    end
 
-    def self.ns_prefix(namespace, namespaces)
-      prefix = namespaces.key(namespace)
-      prefix.nil? ? nil : prefix.sub(/^xmlns:/, '')
-    end
+      # Reads existing uncompressed FB2 file from an IO object, and creates new Book object.
+      # @return [FB2rb::Book]
+      def read_uncompressed(filename_or_io)
+        xml = read_xml(filename_or_io)
+        fb2_prefix = ns_prefix(FB2rb::FB2_NAMESPACE, xml.namespaces)
+        xlink_prefix = ns_prefix(FB2rb::XLINK_NAMESPACE, xml.namespaces)
+        parse(xml, fb2_prefix, xlink_prefix)
+      end
 
-    # @return [FB2rb::Book]
-    def self.parse(xml, fb2_prefix, xlink_prefix) # rubocop:disable Metrics/MethodLength
-      Book.new(
-        Description.parse(xml.xpath("/#{fb2_prefix}:FictionBook/#{fb2_prefix}:description"), fb2_prefix, xlink_prefix),
-        xml.xpath("/#{fb2_prefix}:FictionBook/#{fb2_prefix}:body").map do |node|
-          Body.parse(node)
-        end,
-        xml.xpath("#{fb2_prefix}:FictionBook/#{fb2_prefix}:binary").map do |node|
-          Binary.parse(node)
-        end,
-        xml.xpath("/#{fb2_prefix}:FictionBook/#{fb2_prefix}:stylesheet").map do |node|
-          Stylesheet.parse(node)
+      def ns_prefix(namespace, namespaces)
+        prefix = namespaces.key(namespace)
+        prefix.nil? ? nil : prefix.sub(/^xmlns:/, '')
+      end
+
+      private
+
+      # @return [FB2rb::Book]
+      def parse(xml, fb2_prefix, xlink_prefix) # rubocop:disable Metrics/MethodLength
+        Book.new(
+          description: Description.parse(
+            xml.xpath("/#{fb2_prefix}:FictionBook/#{fb2_prefix}:description"), fb2_prefix, xlink_prefix
+          ),
+          bodies: xml.xpath("/#{fb2_prefix}:FictionBook/#{fb2_prefix}:body").map do |node|
+            Body.parse(node)
+          end,
+          binaries: xml.xpath("#{fb2_prefix}:FictionBook/#{fb2_prefix}:binary").map do |node|
+            Binary.parse(node)
+          end,
+          stylesheets: xml.xpath("/#{fb2_prefix}:FictionBook/#{fb2_prefix}:stylesheet").map do |node|
+            Stylesheet.parse(node)
+          end
+        )
+      end
+
+      def read_xml(filename_or_io)
+        if filename_or_io.respond_to? :read
+          Nokogiri::XML::Document.parse(filename_or_io)
+        else
+          File.open(filename_or_io, 'rb') do |io|
+            return Nokogiri::XML::Document.parse(io)
+          end
         end
-      )
+      end
     end
 
     def to_xml(xml) # rubocop:disable Metrics/MethodLength
@@ -81,26 +107,28 @@ module FB2rb
       end
     end
 
-    def add_binary(name, filename_or_io, content_type = nil)
+    def add_binary(id, filename_or_io, content_type = nil)
       if filename_or_io.respond_to?(:read)
-        add_binary_io name, filename_or_io, content_type
+        add_binary_io id, filename_or_io, content_type
       else
         File.open(filename_or_io, 'r') do |io|
-          add_binary_io name, io, content_type
+          add_binary_io id, io, content_type
         end
       end
     end
 
-    # Serializes and returns FB2 as StringIO.
-    # @return [StringIO]
-    def to_ios
-      Zip::OutputStream.write_buffer do |io|
-        write_to_stream(io)
+    def add_stylesheet(content_type, filename_or_io)
+      if filename_or_io.respond_to?(:read)
+        add_stylesheet_io(content_type, filename_or_io)
+      else
+        File.open(filename_or_io, 'r') do |io|
+          add_stylesheet_io(content_type, io)
+        end
       end
     end
 
-    # Writes FB2 to file or IO object. If file exists, it will be overwritten.
-    def write(filename_or_io)
+    # Writes compressed FB2 to file or IO object. If file exists, it will be overwritten.
+    def write_compressed(filename_or_io = StringIO.new)
       if filename_or_io.respond_to?(:write)
         Zip::OutputStream.write_buffer(filename_or_io) do |zos|
           write_to_zip(zos)
@@ -112,28 +140,48 @@ module FB2rb
       end
     end
 
+    # Writes FB2 (uncompressed) to file or IO object specified by the argument.
+    def write_uncompressed(filename_or_io = StringIO.new) # rubocop:disable Metrics/MethodLength
+      data = (Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+        to_xml(xml)
+      end).to_xml
+
+      if filename_or_io.respond_to?(:write)
+        filename_or_io.write(data)
+      else
+        File.open(filename_or_io, 'wb') do |io|
+          io.write(data)
+        end
+      end
+      filename_or_io
+    end
+
     private
 
     def write_to_zip(zos)
+      mod_time = Zip::DOSTime.now
+      unless (tm = description.document_info.date.value).nil?
+        mod_time = Zip::DOSTime.gm(tm.year, tm.month, tm.day)
+      end
+
       # TODO: entry name
-      zos.put_next_entry('book.fb2')
-      write_to_stream(zos)
+      mimetype_entry = Zip::Entry.new(nil, 'book.fb2', nil, nil, nil, nil, nil, nil, mod_time)
+      zos.put_next_entry(mimetype_entry, nil, nil, Zip::Entry::DEFLATED)
+      write_uncompressed(zos)
     end
 
-    def add_binary_io(name, io, content_type = nil)
+    def add_binary_io(id, io, content_type = nil)
       io.binmode
       content = io.read
-      @binaries << Binary.new(name, content, content_type)
+      @binaries << Binary.new(id: id, content: content, content_type: content_type)
       self
     end
 
-    # Writes FB2 (uncompressed) to stream specified by the argument.
-    def write_to_stream(io)
-      builder = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
-        to_xml(xml)
-      end
-      xml = builder.to_xml
-      io.write(xml)
+    def add_stylesheet_io(content_type, io)
+      io.binmode
+      content = io.read
+      @stylesheets << Stylesheet.new(content_type: content_type, content: content)
+      self
     end
   end
 
@@ -149,13 +197,14 @@ module FB2rb
     attr_accessor(:publish_info)
     # @return [Array<FB2rb::CustomInfo>]
     attr_accessor(:custom_infos)
+
     # TODO: <output>
 
-    def initialize(title_info = TitleInfo.new,
-                   document_info = DocumentInfo.new,
-                   publish_info = nil,
-                   src_title_info = nil,
-                   custom_infos = [])
+    def initialize(title_info: TitleInfo.new,
+                   document_info: DocumentInfo.new,
+                   publish_info: nil,
+                   src_title_info: nil,
+                   custom_infos: [])
       @title_info = title_info
       @document_info = document_info
       @publish_info = publish_info
@@ -168,11 +217,11 @@ module FB2rb
       publish_info_xml = xml.at("./#{fb2_prefix}:publish-info")
       src_title_info_xml = xml.at("./#{fb2_prefix}:src-title-info")
       Description.new(
-        TitleInfo.parse(xml.at("./#{fb2_prefix}:title-info"), fb2_prefix, xlink_prefix),
-        DocumentInfo.parse(xml.at("./#{fb2_prefix}:document-info"), fb2_prefix),
-        publish_info_xml.nil? ? nil : PublishInfo.parse(publish_info_xml, fb2_prefix),
-        src_title_info_xml.nil? ? nil : TitleInfo.parse(src_title_info_xml, fb2_prefix, xlink_prefix),
-        xml.xpath("./#{fb2_prefix}:custom-info").map do |node|
+        title_info: TitleInfo.parse(xml.at("./#{fb2_prefix}:title-info"), fb2_prefix, xlink_prefix),
+        document_info: DocumentInfo.parse(xml.at("./#{fb2_prefix}:document-info"), fb2_prefix),
+        publish_info: publish_info_xml.nil? ? nil : PublishInfo.parse(publish_info_xml, fb2_prefix),
+        src_title_info: src_title_info_xml.nil? ? nil : TitleInfo.parse(src_title_info_xml, fb2_prefix, xlink_prefix),
+        custom_infos: xml.xpath("./#{fb2_prefix}:custom-info").map do |node|
           CustomInfo.parse(node)
         end
       )
@@ -194,47 +243,47 @@ module FB2rb
   # Holds <stylesheet> data
   class Stylesheet
     # @return [String]
-    attr_accessor(:type)
+    attr_accessor(:content_type)
     # @return [String, nil]
     attr_accessor(:content)
 
-    def initialize(type = '', content = nil)
-      @type = type
+    def initialize(content_type: '', content: nil)
+      @content_type = content_type
       @content = content
     end
 
     def self.parse(xml)
-      Stylesheet.new(xml['type'], xml.text)
+      Stylesheet.new(content_type: xml['type'], content: xml.text)
     end
 
     def to_xml(xml)
       return if @content.nil?
 
-      xml.send('stylesheet', @content, 'type' => @type)
+      xml.send('stylesheet', @content, 'type' => @content_type)
     end
   end
 
   # Holds <custom-info> data
   class CustomInfo
     # @return [String]
-    attr_accessor(:info_type)
+    attr_accessor(:type)
     # @return [String, nil]
     attr_accessor(:content)
 
-    def initialize(info_type = '', content = nil)
-      @info_type = info_type
+    def initialize(type: '', content: nil)
+      @type = type
       @content = content
     end
 
     # @return [FB2rb::CustomInfo]
     def self.parse(xml)
-      CustomInfo.new(xml['info-type'], xml.text)
+      CustomInfo.new(type: xml['info-type'], content: xml.text)
     end
 
     def to_xml(xml)
       return if @content.nil?
 
-      xml.send('custom-info', @content, 'info-type' => @info_type)
+      xml.send('custom-info', @content, 'info-type' => @type)
     end
   end
 
@@ -253,12 +302,12 @@ module FB2rb
     # @return [Array<FB2RB::Sequence>]
     attr_accessor(:sequences)
 
-    def initialize(book_name = nil, # rubocop:disable Metrics/ParameterLists
-                   publisher = nil,
-                   city = nil,
-                   year = nil,
-                   isbn = nil,
-                   sequences = [])
+    def initialize(book_name: nil, # rubocop:disable Metrics/ParameterLists
+                   publisher: nil,
+                   city: nil,
+                   year: nil,
+                   isbn: nil,
+                   sequences: [])
       @book_name = book_name
       @publisher = publisher
       @city = city
@@ -270,12 +319,12 @@ module FB2rb
     # @return [FB2RB::PublishInfo]
     def self.parse(xml, fb2_prefix)
       PublishInfo.new(
-        xml.at("./#{fb2_prefix}:book-name/text()")&.text,
-        xml.at("./#{fb2_prefix}:publisher/text()")&.text,
-        xml.at("./#{fb2_prefix}:city/text()")&.text,
-        xml.at("./#{fb2_prefix}:year/text()")&.text,
-        xml.at("./#{fb2_prefix}:isbn/text()")&.text,
-        xml.xpath("./#{fb2_prefix}:sequence").map do |node|
+        book_name: xml.at("./#{fb2_prefix}:book-name/text()")&.text,
+        publisher: xml.at("./#{fb2_prefix}:publisher/text()")&.text,
+        city: xml.at("./#{fb2_prefix}:city/text()")&.text,
+        year: xml.at("./#{fb2_prefix}:year/text()")&.text,
+        isbn: xml.at("./#{fb2_prefix}:isbn/text()")&.text,
+        sequences: xml.xpath("./#{fb2_prefix}:sequence").map do |node|
           Sequence.parse(node)
         end
       )
@@ -316,15 +365,15 @@ module FB2rb
     # @return [Array<String>]
     attr_accessor(:publishers)
 
-    def initialize(authors = [], # rubocop:disable Metrics/ParameterLists
-                   program_used = nil,
-                   date = FB2Date.new,
-                   src_urls = [],
-                   src_ocr = nil,
-                   id = '',
-                   version = '',
-                   history = nil,
-                   publishers = [])
+    def initialize(authors: [], # rubocop:disable Metrics/ParameterLists
+                   program_used: nil,
+                   date: FB2Date.new,
+                   src_urls: [],
+                   src_ocr: nil,
+                   id: '',
+                   version: '',
+                   history: nil,
+                   publishers: [])
       @authors = authors
       @program_used = program_used
       @date = date
@@ -337,20 +386,20 @@ module FB2rb
     end
 
     # @return [FB2rb::DocumentInfo]
-    def self.parse(xml, fb2_prefix) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+    def self.parse(xml, fb2_prefix) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
       date = xml.at("./#{fb2_prefix}:date")
       DocumentInfo.new(
-        xml.xpath("./#{fb2_prefix}:author").map do |node|
+        authors: xml.xpath("./#{fb2_prefix}:author").map do |node|
           Author.parse(node, fb2_prefix)
         end,
-        xml.at("./#{fb2_prefix}:program-used")&.text,
-        date.nil? ? FB2Date.new : FB2Date.parse(date),
-        xml.xpath("./#{fb2_prefix}:src-url").map(&:text),
-        xml.at("./#{fb2_prefix}:src-ocr")&.text,
-        xml.at("./#{fb2_prefix}:id").text,
-        xml.at("./#{fb2_prefix}:version")&.text,
-        xml.at("./#{fb2_prefix}:history")&.children&.to_s&.strip,
-        xml.xpath("./#{fb2_prefix}:publisher").map(&:text)
+        program_used: xml.at("./#{fb2_prefix}:program-used")&.text,
+        date: date.nil? ? FB2Date.new : FB2Date.parse(date),
+        src_urls: xml.xpath("./#{fb2_prefix}:src-url").map(&:text),
+        src_ocr: xml.at("./#{fb2_prefix}:src-ocr")&.text,
+        id: xml.at("./#{fb2_prefix}:id").text,
+        version: xml.at("./#{fb2_prefix}:version")&.text,
+        history: xml.at("./#{fb2_prefix}:history")&.children&.to_s&.strip,
+        publishers: xml.xpath("./#{fb2_prefix}:publisher").map(&:text)
       )
     end
 
@@ -391,7 +440,7 @@ module FB2rb
     attr_accessor(:annotation)
     # @return [Array<String>]
     attr_accessor(:keywords)
-    # @return [String, nil]
+    # @return [FB2rb::Date, nil]
     attr_accessor(:date)
     # @return [FB2rb::Coverpage, nil]
     attr_accessor(:coverpage)
@@ -404,17 +453,17 @@ module FB2rb
     # @return [Array<FB2rb::Sequence>]
     attr_accessor(:sequences)
 
-    def initialize(genres = [], # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists
-                   authors = [],
-                   book_title = '',
-                   annotation = nil,
-                   keywords = [],
-                   date = nil,
-                   coverpage = nil,
-                   lang = 'en',
-                   src_lang = nil,
-                   translators = [],
-                   sequences = [])
+    def initialize(genres: [], # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists
+                   authors: [],
+                   book_title: '',
+                   annotation: nil,
+                   keywords: [],
+                   date: nil,
+                   coverpage: nil,
+                   lang: 'en',
+                   src_lang: nil,
+                   translators: [],
+                   sequences: [])
       @genres = genres
       @authors = authors
       @book_title = book_title
@@ -429,31 +478,31 @@ module FB2rb
     end
 
     # @return [FB2rb::TitleInfo]
-    def self.parse(xml, fb2_prefix, xlink_prefix) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+    def self.parse(xml, fb2_prefix, xlink_prefix) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
       date = xml.at("./#{fb2_prefix}:date")
       coverpage = xml.at("./#{fb2_prefix}:coverpage")
       TitleInfo.new(
-        xml.xpath("./#{fb2_prefix}:genre/text()").map(&:text),
-        xml.xpath("./#{fb2_prefix}:author").map do |node|
+        genres: xml.xpath("./#{fb2_prefix}:genre/text()").map(&:text),
+        authors: xml.xpath("./#{fb2_prefix}:author").map do |node|
           Author.parse(node, fb2_prefix)
         end,
-        xml.at("./#{fb2_prefix}:book-title/text()")&.text,
-        xml.at("./#{fb2_prefix}:annotation")&.children.to_s.strip,
-        xml.at("./#{fb2_prefix}:keywords/text()")&.text&.split(', ') || [],
-        date.nil? ? nil : FB2Date.parse(date),
-        coverpage.nil? ? nil : Coverpage.parse(coverpage, fb2_prefix, xlink_prefix),
-        xml.at("./#{fb2_prefix}:lang/text()").text,
-        xml.at("./#{fb2_prefix}:src-lang/text()")&.text,
-        xml.xpath("./#{fb2_prefix}:translator").map do |node|
+        book_title: xml.at("./#{fb2_prefix}:book-title/text()")&.text,
+        annotation: xml.at("./#{fb2_prefix}:annotation")&.children.to_s.strip,
+        keywords: xml.at("./#{fb2_prefix}:keywords/text()")&.text&.split(', ') || [],
+        date: date.nil? ? nil : FB2Date.parse(date),
+        coverpage: coverpage.nil? ? nil : Coverpage.parse(coverpage, fb2_prefix, xlink_prefix),
+        lang: xml.at("./#{fb2_prefix}:lang/text()").text,
+        src_lang: xml.at("./#{fb2_prefix}:src-lang/text()")&.text,
+        translators: xml.xpath("./#{fb2_prefix}:translator").map do |node|
           Author.parse(node, fb2_prefix)
         end,
-        xml.xpath("./#{fb2_prefix}:sequence").map do |node|
+        sequences: xml.xpath("./#{fb2_prefix}:sequence").map do |node|
           Sequence.parse(node)
         end
       )
     end
 
-    def to_xml(xml, tag) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+    def to_xml(xml, tag) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
       xml.send(tag) do
         genres.each do |genre|
           xml.genre(genre)
@@ -487,13 +536,13 @@ module FB2rb
     # @return [Array<String>]
     attr_accessor(:images)
 
-    def initialize(images = [])
+    def initialize(images: [])
       @images = images
     end
 
     def self.parse(xml, fb2_prefix, xlink_prefix)
       Coverpage.new(
-        xml.xpath("./#{fb2_prefix}:image/@#{xlink_prefix}:href").map(&:to_s)
+        images: xml.xpath("./#{fb2_prefix}:image/@#{xlink_prefix}:href").map(&:to_s)
       )
     end
 
@@ -513,7 +562,7 @@ module FB2rb
     # @return [Date, nil]
     attr_accessor(:value)
 
-    def initialize(display_value = '', value = nil)
+    def initialize(display_value: '', value: nil)
       @display_value = display_value
       @value = value
     end
@@ -521,8 +570,8 @@ module FB2rb
     def self.parse(xml)
       value = xml['value']
       FB2Date.new(
-        xml.at('./text()')&.text || '',
-        value.nil? ? nil : Date.parse(value)
+        display_value: xml.at('./text()')&.text || '',
+        value: value.nil? ? nil : Date.parse(value)
       )
     end
 
@@ -540,14 +589,14 @@ module FB2rb
     # @return [Integer, nil]
     attr_accessor(:number)
 
-    def initialize(name = '', number = nil)
+    def initialize(name: '', number: nil)
       @name = name
       @number = number
     end
 
     # @return [FB2rb::Sequence]
     def self.parse(xml)
-      Sequence.new(xml['name'], xml['number']&.to_i)
+      Sequence.new(name: xml['name'], number: xml['number']&.to_i)
     end
 
     def to_xml(xml)
@@ -574,13 +623,13 @@ module FB2rb
     # @return [String, nil]
     attr_accessor(:id)
 
-    def initialize(first_name = nil, # rubocop:disable Metrics/ParameterLists
-                   middle_name = nil,
-                   last_name = nil,
-                   nickname = nil,
-                   home_pages = [],
-                   emails = [],
-                   id = nil)
+    def initialize(first_name: nil, # rubocop:disable Metrics/ParameterLists
+                   middle_name: nil,
+                   last_name: nil,
+                   nickname: nil,
+                   home_pages: [],
+                   emails: [],
+                   id: nil)
       @first_name = first_name
       @middle_name = middle_name
       @last_name = last_name
@@ -593,17 +642,17 @@ module FB2rb
     # @return [FB2rb::Author]
     def self.parse(xml, fb2_prefix) # rubocop:disable Metrics/CyclomaticComplexity
       Author.new(
-        xml.at("./#{fb2_prefix}:first-name/text()")&.text,
-        xml.at("./#{fb2_prefix}:middle-name/text()")&.text,
-        xml.at("./#{fb2_prefix}:last-name/text()")&.text,
-        xml.at("./#{fb2_prefix}:nickname/text()")&.text,
-        xml.xpath("./#{fb2_prefix}:home-page/text()").map(&:text),
-        xml.xpath("./#{fb2_prefix}:email/text()").map(&:text),
-        xml.at("./#{fb2_prefix}:id/text()")&.text
+        first_name: xml.at("./#{fb2_prefix}:first-name/text()")&.text,
+        middle_name: xml.at("./#{fb2_prefix}:middle-name/text()")&.text,
+        last_name: xml.at("./#{fb2_prefix}:last-name/text()")&.text,
+        nickname: xml.at("./#{fb2_prefix}:nickname/text()")&.text,
+        home_pages: xml.xpath("./#{fb2_prefix}:home-page/text()").map(&:text),
+        emails: xml.xpath("./#{fb2_prefix}:email/text()").map(&:text),
+        id: xml.at("./#{fb2_prefix}:id/text()")&.text
       )
     end
 
-    def to_xml(xml, tag) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+    def to_xml(xml, tag) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
       xml.send(tag) do
         xml.send('first-name', @first_name) unless @first_name.nil?
         xml.send('middle-name', @middle_name) unless @middle_name.nil?
@@ -627,7 +676,7 @@ module FB2rb
     # @return [String]
     attr_accessor(:content)
 
-    def initialize(name = nil, content = '')
+    def initialize(name: nil, content: '')
       @name = name
       @content = content
     end
@@ -635,8 +684,8 @@ module FB2rb
     # @return [FB2rb::Body]
     def self.parse(xml)
       Body.new(
-        xml['name'],
-        xml.children.to_s.strip
+        name: xml['name'],
+        content: xml.children.to_s.strip
       )
     end
 
@@ -659,7 +708,7 @@ module FB2rb
     # @return [String, nil]
     attr_accessor(:content_type)
 
-    def initialize(id, content, content_type = nil)
+    def initialize(id: nil, content: ''.b, content_type: nil)
       @id = id
       @content = content
       @content_type = content_type
@@ -667,7 +716,7 @@ module FB2rb
 
     def self.parse(xml)
       decoded = Base64.decode64(xml.text)
-      Binary.new(xml['id'], decoded, xml['content-type'])
+      Binary.new(id: xml['id'], content: decoded, content_type: xml['content-type'])
     end
 
     def to_xml(xml)

data/lib/fb2rb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FB2rb
-  VERSION = '0.1.1'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fb2rb
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Marat Radchenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-23 00:00:00.000000000 Z
+date: 2020-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -58,42 +58,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.88.0
+        version: 1.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.88.0
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.42.0
+        version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.42.0
+        version: 2.0.0
 description: 
 email:
 - marat@slonopotamus.org
@@ -139,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Fiction Book 2 parser/generator library