lifer 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ce126108ec46665db3ad8337c07db1e11806bbb9792f5a86e5eed169925fe5d
-  data.tar.gz: 90a6531804b57953fbd5da4d5b0488d6b9e98659111d4b5891aabc9907242ff3
+  metadata.gz: '008dbf536d2aa375839023322316ccc00216ea3d4c8eef88792e755f1f95d2ff'
+  data.tar.gz: 7fae8aee316e75f8f58b817041d94afead61361a110feaa8e15c1841ea97f26d
 SHA512:
-  metadata.gz: 5d403fab16070747ccf5f5e756d135d0a30ebd955f3115f0cb75a549a61cb6affa8558fe17147a731f7ddee92dcc9484d529246353d0def6979ae7ebf004dd09
-  data.tar.gz: cdbffa546204eea258e2488b765e393490103677d25754d8111b3de52429bf5e0a955f1d76e3034854319deb423befb8031120b8881d7acf9b65db1fd6ec855c
+  metadata.gz: 9b40732cb604bc0661bee53c3edf621d79c22822bb1fc7b8314e580eca9e2eafb09c04b842441812bc387942952f39c4adaf0068e66688a894f060b88a8ba8e8
+  data.tar.gz: f5dbd68e3d6b6267a8dc5c887220a37e71d851f40926b85a762b3c9bfe532f6cf9f9f7e6ac5f3389889be0ae9bc3cdc1b70b5efa4182d1cbc647d1a786779ede

data/CHANGELOG.md

@@ -1,4 +1,9 @@
 ## Next
+## v0.5.0
+
+This release refactors all of our builders to use parallelization, meaning that
+`lifer build` process should be faster. It should be much faster for larger
+projects. I'm using the `parallel` gem for parallelization at this time.
 
 ## v0.4.1
 

data/Gemfile

@@ -9,6 +9,7 @@ gem "bump"
 gem "capybara"
 
 gem "debug", ">= 1.0.0"
+gem "nokogiri"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 gem "parallel_tests"

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    lifer (0.4.1)
+    lifer (0.5.0)
       i18n (< 2)
       kramdown (~> 2.4)
       liquid (~> 5.6, < 6)
       listen (< 4)
+      parallel (~> 1.26, < 2)
       puma (< 7)
       rack (< 4)
       rss
@@ -83,7 +84,7 @@ GEM
     regexp_parser (2.9.2)
     reline (0.5.10)
       io-console (~> 0.5)
-    rexml (3.4.0)
+    rexml (3.4.1)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)

data/README.md

@@ -87,6 +87,21 @@ suite can run on your machine:
     $ bundle install
     $ bundle exec rspec
 
+### Releases
+
+We use the Bump gem to manage releases. Before releasing a version of Lifer:
+
+1. Ensure unreleased changes have entries in the CHANGELOG file.
+2. Ensure all tests pass locally.
+
+Then use Bump to perform release chores and create a version tag:
+
+    $ bundle exec bump <minor|patch> --tag --changelog --edit-changelog
+    $ git push origin <new_version>
+
+(Where `new_version` is the version you intend to release. For example:
+`v1.2.3`.)
+
 ## Contributing
 
 I'm not currently accepting unsolicited contributions to Lifer. I'm still

data/lib/lifer/builder/html.rb

@@ -54,12 +54,8 @@ class Lifer::Builder::HTML < Lifer::Builder
   # @return [void]
   def execute
     Lifer.collections(without_selections: true).each do |collection|
-      collection.entries.each do |entry|
-        next unless entry.class.output_extension == :html
-
-        generate_output_directories_for entry
-        generate_output_file_for entry
-      end
+      generate_output_directories_for collection
+      generate_output_entries_for collection
     end
   end
 
@@ -75,24 +71,39 @@ class Lifer::Builder::HTML < Lifer::Builder
   end
 
   # @private
-  # For the given entry, ensure all of the paths to the file exist so the file
-  # can be safely written to.
+  # For the given collection, ensure all required directories and
+  # subdirectories exist so the entry output can be safely written to.
   #
-  # @param entry [Lifer::Entry] An entry.
-  # @return [Array<String>] An array containing the directories that were just
-  #   created (or already existed).
-  def generate_output_directories_for(entry)
-    dirname = Pathname File.dirname(output_file entry)
-    FileUtils.mkdir_p dirname unless Dir.exist?(dirname)
+  # @param entry [Lifer::Collection] A collection.
+  # @return [void]
+  def generate_output_directories_for(collection)
+    directories = collection.entries
+      .map { |entry| File.dirname(output_file entry) }
+      .uniq
+
+    Lifer::Utilities.parallelized(directories) do |directory|
+      FileUtils.mkdir_p directory unless Dir.exist?(directory)
+    end
+  end
+
+  def generate_output_entries_for(collection)
+    Lifer::Utilities.parallelized(collection.entries) do |entry|
+      generate_output_file_for entry
+    end
   end
 
   # @private
   # For the given entry, generate the production entry.
   #
   # @param entry [Lifer::Entry] An entry.
-  # @return [Integer] The length of the written file. We should not care about
-  #   this return value.
+  # @raise [StandardError] If the file already exists, we kill the program. The
+  #   end user needs to ensure there are no entry conflicts.
+  # @return [Integer, NilClass] The length of the written file, or nil if the
+  #   entry cannot be output to HTML.  We should not care about this return
+  #   value.
   def generate_output_file_for(entry)
+    return unless entry.class.output_extension == :html
+
     relative_path = output_file entry
     absolute_path = File.join(Lifer.output_directory, relative_path)
 
@@ -117,12 +128,11 @@ class Lifer::Builder::HTML < Lifer::Builder
     when /.*\.liquid$/ then FromLiquid
     else
       file = entry.collection.setting(:layout_file)
-      puts I18n.t(
+      raise I18n.t(
         "builder.html.no_builder_error",
         file:,
         type: File.extname(file)
       )
-      exit
     end
   end
 

data/lib/lifer/builder/rss.rb

@@ -27,7 +27,7 @@ class Lifer::Builder::RSS < Lifer::Builder
   #
   # @return [void]
   def execute
-    collections_with_feeds.each do |collection|
+    Lifer::Utilities.parallelized collections_with_feeds do |collection|
       next unless (filename = output_filename(collection))
 
       FileUtils.mkdir_p File.dirname(filename)

data/lib/lifer/builder/txt.rb

@@ -26,20 +26,8 @@ class Lifer::Builder::TXT < Lifer::Builder
   # @return [void]
   def execute
     Lifer.collections(without_selections: true).each do |collection|
-      collection.entries.each do |entry|
-        next unless entry.class.output_extension == :txt
-
-        relative_path = output_file entry
-        absolute_path = File.join(Lifer.output_directory, relative_path)
-
-        FileUtils.mkdir_p File.dirname(relative_path)
-
-        if File.exist?(absolute_path)
-          raise I18n.t("builder.file_conflict_error", path: absolute_path)
-        end
-
-        File.open(relative_path, "w") { |file| file.write entry.full_text }
-      end
+      generate_output_directories_for collection
+      generate_output_entries_for collection
     end
   end
 
@@ -51,6 +39,37 @@ class Lifer::Builder::TXT < Lifer::Builder
     @root = root
   end
 
+  def generate_output_directories_for(collection)
+    directories = collection.entries
+      .map { |entry| File.dirname(output_file entry) }
+      .uniq
+
+    Lifer::Utilities.parallelized(directories) do |directory|
+      FileUtils.mkdir_p directory unless Dir.exist?(directory)
+    end
+  end
+
+  def generate_output_entries_for(collection)
+    Lifer::Utilities.parallelized(collection.entries) do |entry|
+      generate_output_file_for entry
+    end
+  end
+
+  def generate_output_file_for(entry)
+    return unless entry.class.output_extension == :txt
+
+    relative_path = output_file entry
+    absolute_path = File.join(Lifer.output_directory, relative_path)
+
+    FileUtils.mkdir_p File.dirname(relative_path)
+
+    if File.exist?(absolute_path)
+      raise I18n.t("builder.file_conflict_error", path: absolute_path)
+    end
+
+    File.open(relative_path, "w") { |file| file.write entry.full_text }
+  end
+
   def output_file(entry)
     Lifer::URIStrategy
       .find(entry.collection.setting :uri_strategy)

data/lib/lifer/utilities.rb

@@ -1,3 +1,5 @@
+require "parallel"
+
 # A module namespace for any weird utilities that are used pseudo-globally.
 # Ensure that these are actually useful globally, though. :-)
 #
@@ -66,6 +68,29 @@ module Lifer::Utilities
     # @return [String] The kabab-cased output.
     def handleize(string) = parameterize(string, separator: "-")
 
+    # Parallelize and fan out a collection of work in child processes. If any of
+    # the child processes results in an error, we raise it and halt the program.
+    #
+    # @param collection [Array] A collection to operate on.
+    # @yield [Object] A function to transform each collection item (in
+    #   parallel).
+    # @raise [Exception] Any exception thrown by a child process.
+    # @return [Array] The mapped results of the operation.
+    def parallelized(collection, &block)
+      results = Parallel.map(collection) do |collection_item|
+        begin
+          yield collection_item
+        rescue => error
+          error
+        end
+      end
+
+      first_error = results.detect { _1.is_a? Exception }
+      raise first_error if first_error
+
+      results
+    end
+
     # Given a hash, take all of its keys (and sub-keys) and convert them into
     # strings.
     #

data/lib/lifer/version.rb

@@ -1,3 +1,3 @@
 module Lifer
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

data/lifer.gemspec

@@ -37,10 +37,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "kramdown", "~> 2.4"
   spec.add_dependency "liquid", ["~> 5.6", "< 6"]
   spec.add_dependency "listen", "< 4"
+  spec.add_dependency "parallel", ["~> 1.26", "< 2"]
   spec.add_dependency "puma", "< 7"
   spec.add_dependency "rack", "< 4"
   spec.add_dependency "rss"
-
-  spec.add_development_dependency "debug"
-  spec.add_development_dependency "nokogiri"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lifer
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - benjamin wil
@@ -73,69 +73,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4'
 - !ruby/object:Gem::Dependency
-  name: puma
+  name: parallel
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.26'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.26'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '7'
 - !ruby/object:Gem::Dependency
-  name: rss
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: debug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: rss
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements: