fb2rb 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 677f97c36f32659a61a02047c4b1a06e6a6bd54ac3b8088b04519268468c5acd
-  data.tar.gz: e5d0ad29e58cd0a453ae50123d498eee49a02ad92adbccc39b2e914c9851bcab
+  metadata.gz: fc31542e10b2b534c4a4ffd960f6155eebee2c06a8fe5d5527739a653a7be68d
+  data.tar.gz: 9863b69c7c307de46f4e5c15389c2b9934818c2a0b2bf4f3ee9126e015277b94
 SHA512:
-  metadata.gz: 3703897e4512796eeb79533a6103abf3fc2627580845bc145f3f73b6b35d5d5736a769e6f87af53c9881245942077f947c4a8d72fb64d149b3dab38154b9e377
-  data.tar.gz: fd4b8cdd88fcfb81e2ced29fd06a90878384695040bd3217bb738a078929d6eb1359c968221a273c777827d472c27ee4e3492c6c1471624d825244b06b390462
+  metadata.gz: 1366e3268dc0711bc00eeb7936fba94dfd9f6ad29f497eaed56e9ddf4aff188bd5270e1c552ebfe80fefa2053ab5f39f186d1499e19c3b29edfd181ef3f7edba
+  data.tar.gz: 7edd5ad64f31355bd5f014855a8e49d2c5264495ef42e144f978ce4e8fc962e7de04b838ead0688a0ef81a64d9b7229f74ade2887b4f758ed78a29ff93b66f01

data/CHANGELOG.adoc

@@ -7,6 +7,10 @@
 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.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`

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/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]
@@ -29,40 +29,65 @@ module FB2rb
       @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
       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.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)
+          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
@@ -91,8 +116,8 @@ module FB2rb
       end
     end
 
-    # Writes FB2 to file or IO object. If file exists, it will be overwritten.
-    def write(filename_or_io = StringIO.new)
+    # 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)
@@ -104,6 +129,22 @@ 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)
@@ -115,7 +156,7 @@ module FB2rb
       # TODO: entry name
       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_to_stream(zos)
+      write_uncompressed(zos)
     end
 
     def add_binary_io(name, io, content_type = nil)
@@ -124,15 +165,6 @@ module FB2rb
       @binaries << Binary.new(name, content, 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)
-    end
   end
 
   # Holds <description> data

data/lib/fb2rb/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fb2rb
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Marat Radchenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-24 00:00:00.000000000 Z
+date: 2020-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri