photish 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ff58bf1d669264455034b1ea27a798ea979d2f0
-  data.tar.gz: 6f6bb07a9b0ecd54643b9090c27336b13c0ecb09
+  metadata.gz: 31149e215cc2087c36f281ad5a1984ad2ce5f45b
+  data.tar.gz: 64ee1e2e49df780d17533a63bf3d17e8346fa7ea
 SHA512:
-  metadata.gz: ea5d2478db86db55aca53b8fec1abe53c65d6714e6fa12bd6d3c8cd85b5f4d145183e184b4e9a10bf1a8b9cd0fd4650426ae4416f2862b7c54bae49953881663
-  data.tar.gz: b86aa902da22f12807bdef9d26b46f7df180472268e56affc1ea9b63a7ee0c2f45fd15056a64c3a049bcb9a8acf05c6c99f54e7a3c185ce801f725f7bd72dfb6
+  metadata.gz: 6f9e9849870e9dcaaf562a5e5b13e6d931bddea503f00e2351958c8bbe763cbe7191c1322a0173a87cc2a02fbacb3fbf1ca6ddfe7cfc20d9e1be72f60625fe47
+  data.tar.gz: e937262b5fa4c831585831ff2161412bb6f50a10ca729b83513159f2bbaf28148e95a3fd58f9b21a0009b4be1782b888b55cbff71bbfc1e772df1c70bf964e6e

data/README.md

@@ -64,6 +64,8 @@ and running:
     - [Execution Order](#execution-order)
     - [Workers and Threads](#workers-and-threads)
     - [Caching](#caching)
+      - [Automatic Rengeneration](#automatic-regeneration)
+      - [Forced Regeneration](#forced-regeneration)
   - [Host](#host)
   - [Rake Task](#rake-task)
   - [Plugins](#plugins)
@@ -294,6 +296,7 @@ url:
   base: 'subdirectory'
 workers: 4
 threads: 2
+force: false
 ```
 
 The meanings and purpose of each field is defined below:
@@ -318,6 +321,7 @@ Field                  | Purpose
 `url/base`             | if your website will be hosted in a sub folder and will not be accessible at the root of the host, you can specify the sub folder(s) here, this will also mean your website will be hosted in a sub folder when ran using `photish host`
 `workers`              | the number of workers to create, for computers with multiple processors, photish is configured by default to spawn a worker for each process, a worker is responsible for image generation and html generation, load balancing is done randomly via a simple round robin allocation
 `threads`              | the number of threads each worker should create to handle image magick transcoding
+`force`                | this should always be false, if true, all content will be regenerated and nothing cached
 
 #### Customizing Templates
 
@@ -473,11 +477,11 @@ The Generate command does the following:
 
 #### Workers and Threads
 
-In order to achieve maximum utilization of all processors on a CPU during
+In order to achieve maximum utilization of all processors on a computer during
 generation, Photish has the ability to create multiple workers and threads.
 
 A worker is a spawned sub process created by the Generate command. The worker
-sub process is responsible for generating the HTML and Images for a sub set of
+sub process is responsible for generating the HTML and Images for a subset of
 the collection.
 
 Within each worker, threads are created when calling out to the Image Magick
@@ -486,11 +490,11 @@ utilization so rather then block the whole worker, it can be more performant to
 spawn multiple Image Magick processes at once.
 
 For collections with a large number of images and HTML pages, multiple workers
-and threads can be used to rapidly speed up generation. However if the
-collection is quite small and the images are of a small size, workers and
-threads will increase the generation time as loading a new ruby runtime and
-creating multiple threads may have a higher setup time then just generating in
-a single ruby process.
+and threads can be used to rapidly speed up generation. However, if the
+collection has a small number of photos and pages, workers and threads will
+increase the generation time as loading a new ruby process and creating
+multiple threads may have a higher setup time then just generating everything
+in a single ruby process.
 
 The number of workers and threads is configurable in the [config
 file](#config-file-options) with the `workers` and `threads` options. By
@@ -510,16 +514,25 @@ a local version of Photish with the Host command.
 
 The cache file is stored in the `output_dir` and is named `.changes.yml`.
 
-To do a full regeneration, simple run the Generate command with the `force`
-flag:
-
-    $ photish generate --force
+##### Automatic Regeneration
 
 Images are regenerated when they are modified, renamed or moved.
 
 Changing the `qualities` option in the config file will also trigger a full
 regeneration of all images.
 
+##### Forced Regeneration
+
+To do a full regeneration, run the Generate command with the `--force`
+flag:
+
+    $ photish generate --force
+
+The host command also supports the `--force` flag, to do a full regeneration
+on every change:
+
+    $ photish host --force
+
 ### Host
 
 To test and view your changes locally, the host command can be used to run a

data/lib/photish/cache/manifest_db_file.rb

@@ -10,6 +10,10 @@ module Photish
         File.open(db_file(output_dir), 'w') { |f| f.write(changes.to_yaml) }
       end
 
+      def clear(output_dir)
+        FileUtils.rm_rf(db_file(output_dir))
+      end
+
       def db_file(output_dir)
         FileUtils.mkdir_p(output_dir)
         File.join(output_dir, '.changes.yml')
@@ -22,7 +26,8 @@ module Photish
 
       module_function :concat_db_files,
                       :db_file,
-                      :worker_db_file
+                      :worker_db_file,
+                      :clear
     end
   end
 end

data/lib/photish/cli/interface.rb

@@ -4,7 +4,7 @@ module Photish
       package_name "Photish"
 
       desc "generate", "Generates the gallery static site"
-      option :worker_index, type: :numeric
+      option :force, type: :boolean
       def generate
         Photish::Command::Generate.new(options).execute
       end
@@ -16,6 +16,7 @@ module Photish
       end
 
       desc "host", "Serves the HTML on a HTTP server"
+      option :force, type: :boolean
       def host
         Photish::Command::Host.new(options).execute
       end

data/lib/photish/command/generate.rb

@@ -4,6 +4,7 @@ module Photish
       def run
         log.info "Starting generation with #{workers} workers"
 
+        clear_cache if force_regeneration?
         spawn_all_workers
         load_all_plugins
         wait_for_workers_to_complete
@@ -22,8 +23,17 @@ module Photish
                :qualities,
                :photish_executable,
                :workers,
+               :force,
                to: :config
 
+      def force_regeneration?
+        force == true
+      end
+
+      def clear_cache
+        Cache::ManifestDbFile.clear(output_dir)
+      end
+
       def load_all_plugins
         Plugin::Repository.reload(log, site_dir)
       end

data/lib/photish/config/default_config.rb

@@ -10,6 +10,7 @@ module Photish
           workers: workers,
           threads: threads,
           worker_index: 0,
+          force: false,
           photish_executable: photish_executable,
           qualities: [
             { name: 'Original',

data/lib/photish/render/image_conversion.rb

@@ -12,7 +12,7 @@ module Photish
       def render(images)
         log.info "Rendering #{images.count} images across #{threads} threads"
 
-        change_manifest.preload
+        cache.preload
         threads = spawn_thread_instances(to_queue(images))
         threads.map(&:join)
         flush_to_disk
@@ -30,7 +30,7 @@ module Photish
                :changed?,
                :flush_to_disk,
                :preload,
-               to: :change_manifest
+               to: :cache
 
       def spawn_thread_instances(image_queue)
         (0...threads).map do
@@ -74,10 +74,10 @@ module Photish
         FileUtils.mkdir_p(File.join(output_dir, image.base_url_parts))
       end
 
-      def change_manifest
-        @change_manifest ||= Cache::Manifest.new(output_dir,
-                                                 worker_index,
-                                                 version_hash)
+      def cache
+        @cache ||= Cache::Manifest.new(output_dir,
+                                       worker_index,
+                                       version_hash)
       end
     end
   end

data/lib/photish/version.rb

@@ -1,3 +1,3 @@
 module Photish
-  VERSION = "0.3.4"
+  VERSION = "0.3.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: photish
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Henry Lawson