undrive_google 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6309df259e4c0ec3a6853a2e2362a01a1ae21c92f9cf02254727318c084b3f47
-  data.tar.gz: ff5130695837c720b1ead438f3cfbcebc903ea8da2f78e3e9007295055984bdb
+  metadata.gz: 34e0ef0495f11487f7c44caea53d6995a5b7a1a7166a0348c3c35fa3d7612f24
+  data.tar.gz: 631433cd7bb255aba19f769c1298254795bffa9102a29215bcc0c67916cf11d0
 SHA512:
-  metadata.gz: df150a3aa25129d41bf43889b635627c03a33ce68884653de461e039595a0c7fa7592d0f96edd63287e4a5a834412c42b333d5e0ac1ec6dbb44858434493616a
-  data.tar.gz: 1e850de4f83df8be4b09cea304fde2448af115106767afd4241b049f8cf9347dcd1dc1e6936d15dc83fa789573bd7fe8855923945967d2c78f4c89b4152a7313
+  metadata.gz: 31e36fd65a3c14b6cf39bd6e8eac32a056adae91402d3106b67d57feff3874c7b4e27418534ac3582f5cc1c7f8ae04a908594f9b2083ff332463690f19e305cc
+  data.tar.gz: bd3b2f07174026896b8ff3d70e3f0ec6eda20574017caf77e3098940a0d8fa6dcf2a85cf4e843dc0492d3756b9e76f14407f2c78ac831f98bfd350e700f073aa

data/CHANGELOG.md

@@ -10,5 +10,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Removed
 
-## 1.0.0 - 2022-10-24
+## 1.0.1 - 2022-10-26
+### Added
+- Support for lang
+- Support for title
+- Support for unzipping zip
+- Support for deleting zip
+- Support for Renaming HTML
+
+## 1.0.0 - 2022-10-25
 - Initial release

data/README.md

@@ -14,15 +14,30 @@ If yes, DO NOT use this gem. Instead follow [these instructions](https://support
 OTOH, if you want to "own", host, track, etc your 'own' files
 (e.g. your resume), DO use this gem.
 
-## NOTE: Export epub
+## NOTE: Export epub & Unzip html
 
 There is a bug (missing feature) in `google_drive` gem preventing export of epub.  You can use this patched branch:
 
+Create a Gemfile:
 ```ruby
+source "https://rubygems.org"
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 gem "google_drive", github: "pboling/google-drive-ruby", branch: "pboling-epub-mimetype"
 ```
 
-And you can upvote this PR [#427](https://github.com/gimite/google-drive-ruby/pull/427).
+Please upvote this PR [#427](https://github.com/gimite/google-drive-ruby/pull/427)!
+
+Separately, the `rubyzip` maintainers are now working on v3, and this gem utilizes that syntax.  But it hasn't been released yet.
+Therefore, if you need to unzip to HTML add another line to the `Gemfile` from above:
+```ruby
+gem "rubyzip", github: "rubyzip/rubyzip", branch: "master"
+```
+
+When liberating your files, ensure the script will use the Gemfile:
+```shell
+BUNDLE_GEMFILE=path/to/Gemfile bundle update
+BUNDLE_GEMFILE=path/to/Gemfile undrive_google -c path/to/config
+```
 
 ## Story Time
 
@@ -35,7 +50,7 @@ Tell me if you've heard this one already.
 1. Give 🐭 your 🍪 for "safe-keeping"
 2. Recognizing this SPoF, you ask 🐭 to give back a 🍪 copy
 3. "I'll run it through my 🍪 🖨", says 🐭
-4. 🖨 replicates various 🍪 extensions: `pdf`, `odt`, `docx`, `txt`, `rtf` and `epub`
+4. 🖨 replicates various 🍪 extensions: `pdf`, `odt`, `docx`, `txt`, `rtf`, `zip`, and `epub`
 5. Rename 🍪 for web (e.g. replace ` ` with `_`)
 6. Extract replicated `.zip` format to `.html`
 7. Rename extracted HTML file for self-hosting
@@ -47,12 +62,9 @@ Tell me if you've heard this one already.
 13. Bake a new 🍪
 14. GOTO 1
 
-This gem solves the classic 🐭-🍪 problem by automating steps 3-8.
+This gem solves the classic 🐭-🍪 problem by automating steps 3-9.
 Will save at least 15 minutes each loop.
 
-TODO:
-Configuration supports step 9, but it hasn't been implemented yet.
-
 Note that it doesn't have to be a resume.
 There are likely other use cases that apply.
 
@@ -131,7 +143,8 @@ keep_zip: true
 
 # Rename downloaded files following a pattern?
 # Only applies to files not explicitly specified with rename-<type>
-# Value will be splatted to gsub
+# Will never apply to the html file unzipped from the .zip
+# Used as: file_name.gsub(rename_pattern[0], rename_pattern[1])
 rename_pattern:
   - "_"
   - " "
@@ -141,13 +154,10 @@ dir: '' # defaults to current working directory
 
 verbose: true # or false
 
-#
-# TODO: implementation for title and lang
-#
-# [String] HTML title element inner text.
+# [String] Set inner text of missing title element, if unzipping `.zip` to `.html`.
 title: '' # When empty, defaults to the title of the file.
 
-# [String] If unzipping `.zip`, adds lang attribute to html tag,
+# [String] Adds lang attribute to html tag, If unzipping `.zip` to `.html`,
 #            value is like `fr`, `es`, etc.
 lang: 'en'
 ```

data/exe/undrive_google

@@ -1,12 +1,14 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+DEBUG = ENV["UNDRIVE_DEBUG"] == "true"
+
 # Std-lib
 require "optparse"
 
 # Gems
 require "bundler/setup"
-require "byebug"
+require "byebug" if DEBUG
 
 # This library
 require "undrive_google"

data/lib/undrive_google/actions/liberate.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module UndriveGoogle
+  module Actions
+    # Liberate a file, and transform it
+    class Liberate
+      extend Forwardable
+
+      attr_accessor :extension, :tr, :dir, :file, :file_path
+
+      def_delegator :@tr, :download
+      def_delegator :@tr, :unzip
+      def_delegator :@tr, :rename_html
+      def_delegator :@tr, :fix_html
+      def_delegator :@tr, :delete_zip
+      def_delegator :@tr, :liberate!
+
+      def initialize(extension)
+        @extension = extension.to_s
+        @file = Session.instance.file
+        @dir = Options.instance.dir
+        @file_path = "#{@dir}/#{name}"
+        @tr = Transformation.new(download: Transformations::Download.new(@file_path, @extension))
+        return unless zip?
+
+        if Options.instance.unzip
+          @tr.unzip = Transformations::Unzip.new(@file_path)
+          @tr.fix_html = Transformations::FixHtml.new(@tr.unzip)
+          @tr.rename_html = Transformations::RenameHtml.new(@tr.unzip) if Options.instance.rename[:html]
+        end
+
+        @tr.delete_zip = Transformations::DeleteZip.new(@file_path) unless Options.instance.keep_zip
+      end
+
+      private
+
+      def name
+        "#{rename}.#{extension}"
+      end
+
+      def rename
+        exact_name = Options.instance.rename[extension]
+        return exact_name if exact_name
+
+        Options.instance.rename_proc.call(file.title)
+      end
+
+      # The zip is an HTML file packaged in a .zip archive
+      def zip?
+        extension == "zip"
+      end
+    end
+  end
+end

data/lib/undrive_google/captive_file.rb

@@ -10,9 +10,9 @@ module UndriveGoogle
     def liberate!
       @exports = []
       extensions.each do |format|
-        download = Actions::Download.new(format)
-        exports << download
-        download.download!
+        liberate = Actions::Liberate.new(format)
+        exports << liberate.file_path
+        liberate.liberate!
       end
 
       nil

data/lib/undrive_google/cli.rb

@@ -25,8 +25,14 @@ module UndriveGoogle
     end
 
     def liberate!
-      session.file
+      Options.instance.title = session.file.title if missing_title?
       CaptiveFile.instance.liberate!
     end
+
+    private
+
+    def missing_title?
+      Options.instance.title.nil? || Options.instance.title.empty?
+    end
   end
 end

data/lib/undrive_google/options.rb

@@ -10,18 +10,7 @@ module UndriveGoogle
                   :dir, :verbose
 
     def initialize
-      self.config_yaml = CONFIG_YAML_PATH
-      self.key_file = KEY_FILE_PATH
-      self.file_id = nil
-      self.file_by = :key
-      self.extensions = FILE_TYPES # On the command line, "all" expands to FILE_TYPES
-      self.unzip, self.keep_zip = true
-      self.rename = {}
-      self.rename_proc = RENAME_PROC
-      self.title, self.dir = nil
-      self.lang = "en"
-      self.verbose = false
-      load_yaml
+      load_yaml(true)
     end
 
     def define_options(parser)
@@ -125,13 +114,13 @@ module UndriveGoogle
     end
 
     def lang_option(parser)
-      parser.on("-l", "--lang LANG", String, '[NOOP] TODO: Add lang="LANG" attribute to HTML') do |lang|
+      parser.on("-l", "--lang LANG", String, 'Add lang="LANG" attribute to <html> tag of unzipped HTML') do |lang|
         self.lang = lang
       end
     end
 
     def title_option(parser)
-      parser.on("-t", "--title TITLE", String, "[NOOP] TODO: Add <title>TITLE</title> element to HTML") do |title|
+      parser.on("-t", "--title TITLE", String, "Add <title>TITLE</title> element to unzipped HTML") do |title|
         self.title = title
       end
     end
@@ -143,8 +132,22 @@ module UndriveGoogle
       end
     end
 
-    def load_yaml
-      return unless config_yaml
+    def load_yaml(reset = false)
+      if reset
+        self.config_yaml = CONFIG_YAML_PATH
+        self.key_file = KEY_FILE_PATH
+        self.file_id = nil
+        self.file_by = :key
+        self.extensions = FILE_TYPES # On the command line, "all" expands to FILE_TYPES
+        self.unzip = true
+        self.keep_zip = true
+        self.rename = {}
+        self.rename_proc = RENAME_PROC
+        self.title = nil
+        self.dir = nil
+        self.lang = "en"
+        self.verbose = false
+      end
 
       cf = ConfigFile.new(config_yaml)
       return unless cf.any?

data/lib/undrive_google/transformation.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module UndriveGoogle
+  class Transformation < Struct.new(:download,
+                                    :unzip,
+                                    :fix_html,
+                                    :rename_html,
+                                    :delete_zip,
+                                    keyword_init: true)
+    def liberate!
+      each(&:process)
+    end
+
+    def each
+      yield download unless download.nil?
+      yield unzip unless unzip.nil?
+      yield fix_html unless fix_html.nil?
+      # Rename after fix to prevent confusion about the current path of the file
+      yield rename_html unless rename_html.nil?
+      yield delete_zip unless delete_zip.nil?
+    end
+  end
+end

data/lib/undrive_google/transformations/delete_zip.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module UndriveGoogle
+  module Transformations
+    # Delete the downloaded zip file.
+    class DeleteZip
+      attr_accessor :file_path
+
+      def initialize(file_path)
+        @file_path = file_path
+      end
+
+      # @return nil
+      def process
+        puts "Deleting #{file_path}" if Options.instance.verbose
+        File.delete(file_path)
+
+        nil
+      end
+    end
+  end
+end

data/lib/undrive_google/transformations/download.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module UndriveGoogle
+  module Transformations
+    # Download a particular version of the file.
+    class Download
+      attr_accessor :file, :extension, :file_path
+
+      def initialize(file_path, extension)
+        @extension = extension
+        @file = Session.instance.file
+        @file_path = file_path
+      end
+
+      # @return nil
+      def process
+        puts "Downloading #{file.title} as: #{extension} to: #{file_path}" if Options.instance.verbose
+        file.export_as_file(file_path, extension)
+
+        nil
+      end
+    end
+  end
+end

data/lib/undrive_google/transformations/fix_html.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module UndriveGoogle
+  module Transformations
+    #  In Google Doc generated HTML, optionally replace:
+    #
+    #     <html><head>
+    #
+    # with
+    #
+    #     <html lang="en"><head><title>Peter Boling's Bounce to the Ounce</title>
+    #
+    class FixHtml
+      extend Forwardable
+
+      attr_accessor :unzip, :lang, :title
+
+      def_delegator :@unzip, :html_path
+
+      def initialize(unzip)
+        @unzip = unzip
+        @lang = Options.instance.lang
+        @title = Options.instance.title
+      end
+
+      # @return nil
+      def process
+        return unless lang || title
+
+        puts "Checking html in #{html_path}" if Options.instance.verbose
+        file = File.open(html_path)
+        html = file.read
+        return unless html
+
+        puts "Fixing html in #{html_path}" if Options.instance.verbose
+        html.sub!("<html>", "<html lang=\"#{lang}\">") if lang
+        html.sub!("<head>", "<head><title>#{title}</title>") if title
+        File.write(html_path, html)
+
+        nil
+      end
+    end
+  end
+end

data/lib/undrive_google/transformations/rename_html.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module UndriveGoogle
+  module Transformations
+    # Rename the unzipped HTML file.
+    class RenameHtml
+      extend Forwardable
+
+      attr_accessor :unzip
+
+      def_delegator :@unzip, :html_path
+
+      def initialize(unzip)
+        @unzip = unzip
+      end
+
+      # @return nil
+      def process
+        puts "Renaming html file at #{html_path} to #{rename_path}" if Options.instance.verbose
+        File.rename(html_path, rename_path)
+
+        nil
+      end
+
+      private
+
+      def rename_path
+        "#{File.dirname(html_path)}/#{Options.instance.rename[:html]}"
+      end
+    end
+  end
+end

data/lib/undrive_google/transformations/unzip.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module UndriveGoogle
+  module Transformations
+    # Download a particular version of the file.
+    class Unzip
+      attr_accessor :file_path, :html_path
+
+      def initialize(file_path)
+        @file_path = file_path
+      end
+
+      # @return nil
+      def process
+        return unless Options.instance.unzip
+
+        puts "Unzipping #{file_path}" if Options.instance.verbose
+        extract_zip(file_path, destination)
+        puts "Unzipped #{file_path} to #{html_path}" if Options.instance.verbose
+
+        nil
+      end
+
+      private
+
+      def destination
+        File.dirname(file_path)
+      end
+
+      def extract_zip(file, destination)
+        FileUtils.mkdir_p(destination)
+
+        Zip::File.open(file) do |zip_file|
+          zip_file.each do |f|
+            @html_path = File.join(destination, f.name)
+            zip_file.extract(f, @html_path) unless File.exist?(@html_path)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/undrive_google/version.rb

@@ -2,6 +2,6 @@
 
 module UndriveGoogle
   module Version
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

data/lib/undrive_google.rb

@@ -2,21 +2,35 @@
 
 # Std-lib
 require "psych" # The Ruby YAML library
+require "forwardable" # The Ruby Delegation library
 require "singleton" # The Ruby Singleton library
 
 # third party gems
+begin
+  require "zip"
+rescue LoadError
+  warn "[WARN] Failed to load gem rubyzip, so unzip (and thus html) options will not work."
+end
 require "version_gem"
 require "google_drive"
+gd_fixed = GoogleDrive::Util::EXT_TO_CONTENT_TYPE.key?('.epub')
+warn "[WARN] Your version of google_drive does not support .epub. If you need .epub support see: https://sr.ht/~galtzo/undrive_google/#note-export-epub" unless gd_fixed
 
 require_relative "undrive_google/version"
 
-require_relative "undrive_google/actions/download"
 require_relative "undrive_google/helpers/parse"
+require_relative "undrive_google/actions/liberate"
+require_relative "undrive_google/transformations/delete_zip"
+require_relative "undrive_google/transformations/download"
+require_relative "undrive_google/transformations/fix_html"
+require_relative "undrive_google/transformations/rename_html"
+require_relative "undrive_google/transformations/unzip"
 require_relative "undrive_google/captive_file"
 require_relative "undrive_google/cli"
 require_relative "undrive_google/config_file"
 require_relative "undrive_google/options"
 require_relative "undrive_google/session"
+require_relative "undrive_google/transformation"
 
 module UndriveGoogle
   class Error < StandardError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: undrive_google
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Peter Boling
@@ -36,7 +36,7 @@ cert_chain:
   gwGrEXGQGDZ0NIgBcmvMOqlXjkGQwQvugKycJ024z89+fz2332vdZIKTrSxJrXGk
   4/bR9A==
   -----END CERTIFICATE-----
-date: 2022-10-25 00:00:00.000000000 Z
+date: 2022-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google_drive
@@ -116,13 +116,19 @@ files:
 - SECURITY.md
 - exe/undrive_google
 - lib/undrive_google.rb
-- lib/undrive_google/actions/download.rb
+- lib/undrive_google/actions/liberate.rb
 - lib/undrive_google/captive_file.rb
 - lib/undrive_google/cli.rb
 - lib/undrive_google/config_file.rb
 - lib/undrive_google/helpers/parse.rb
 - lib/undrive_google/options.rb
 - lib/undrive_google/session.rb
+- lib/undrive_google/transformation.rb
+- lib/undrive_google/transformations/delete_zip.rb
+- lib/undrive_google/transformations/download.rb
+- lib/undrive_google/transformations/fix_html.rb
+- lib/undrive_google/transformations/rename_html.rb
+- lib/undrive_google/transformations/unzip.rb
 - lib/undrive_google/version.rb
 homepage: https://sr.ht/~galtzo/undrive_google/
 licenses:
@@ -132,7 +138,7 @@ metadata:
   source_code_uri: https://git.sr.ht/~galtzo/undrive_google
   changelog_uri: https://git.sr.ht/~galtzo/undrive_google
   bug_tracker_uri: https://todo.sr.ht/~galtzo/undrive_google
-  documentation_uri: https://www.rubydoc.info/gems/undrive_google/1.0.0
+  documentation_uri: https://www.rubydoc.info/gems/undrive_google/1.0.1
   wiki_uri: https://man.sr.ht/~galtzo/undrive_google/
   funding_uri: https://liberapay.com/pboling
   mailing_list_uri: https://lists.sr.ht/~galtzo/undrive_google-devel

data/lib/undrive_google/actions/download.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module UndriveGoogle
-  module Actions
-    # Download a particular version of the file.
-    class Download
-      attr_accessor :file, :extension, :dir
-
-      def initialize(extension)
-        @file = Session.instance.file
-        @extension = extension.to_s
-        @dir = Options.instance.dir
-      end
-
-      def download!
-        puts "Downloading #{file.title} as: #{extension} to: #{dir}/#{name}" if Options.instance.verbose
-        file.export_as_file("#{dir}/#{name}", extension)
-      end
-
-      private
-
-      def name
-        "#{rename}.#{extension}"
-      end
-
-      def rename
-        exact_name = Options.instance.rename[extension]
-        return exact_name if exact_name
-
-        Options.instance.rename_proc.call(file.title)
-      end
-    end
-  end
-end