paperweight 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9e3211e8bbf5de4d55271d89815de2fb413b8a9702e7ff280771ef2e4dfe944
-  data.tar.gz: f643f81049c0b4accef26b1ba8fd7c26af8030c8315e5656f6039946e52c240b
+  metadata.gz: f08760e0f79a70c76350131c65de6fcca3ed7a3366eeb3893d1f64b817ede4ee
+  data.tar.gz: 42df1435f059aab276345f12fac1c35fdce71b9bf237bd73163fa4ef3d87c5df
 SHA512:
-  metadata.gz: e4099be28ad137adc0307b4e507e25a20d0edfd83c86d13fb2d2b62d50882e0c390e797bc50fa878a9803cc7117c3f4614d01a2d4807d36bdd4a2c848839682c
-  data.tar.gz: ca6ed11cd8f2bd2ad78baec34a7a4aca11d7797dde33dac29dbfb11b88e3b713ed48b715d1579c712fed713e895ec885d6974a9d68cd5314550a538ec5356afa
+  metadata.gz: 54348c7ce20c685556a8ad1aad6e8c62abee2916091f5120cdfa4c266c5a3790ecd0a0234ec3e18a7218fb2c402aaef20b0b4484d3363dbee7ae12acdf1aec76
+  data.tar.gz: 1176e2de7cab6b5d0f8eea6e76fbfad435cc2d06fcacb633286db19c56e3937cfbf0dcdde2d19b5ab43dadbd447c461d009a3cad0e8be13796a05917d0a48692

data/CHANGELOG.md

@@ -6,9 +6,14 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [1.0.0] - 2018-08-15
+### Changed
+- Changed the expected column type of `#*_processing` from a boolean to string. This allows us to use it to store the URL from the `#*_url=` method so that it can be used in the meantime before the job finishes processing.
+
 ## [0.2.0] - 2018-08-15
 ### Added
 - The ability to configure the `max_size` value (the maximum download size) using the `Paperweight.configure` method.
 
 [Unreleased]: https://github.com/CultureHQ/client/compare/v0.2.0...HEAD
+[v1.0.0]: https://github.com/CultureHQ/client/compare/v0.2.0...v1.0.0
 [v0.2.0]: https://github.com/CultureHQ/client/compare/v0.1.2...v0.2.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    paperweight (0.2.0)
+    paperweight (1.0.0)
       paperclip (>= 5)
       rails (>= 5)
 
@@ -71,11 +71,11 @@ GEM
     marcel (0.3.2)
       mimemagic (~> 0.3.2)
     method_source (0.9.0)
-    mime-types (3.1)
+    mime-types (3.2.2)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2016.0521)
+    mime-types-data (3.2018.0812)
     mimemagic (0.3.2)
-    mini_mime (1.0.0)
+    mini_mime (1.0.1)
     mini_portile2 (2.3.0)
     minitest (5.11.3)
     nio4r (2.3.1)

data/README.md

@@ -22,16 +22,18 @@ Or install it yourself as:
 
 ## Usage
 
-Configure `Paperclip` as you normally would, according to their docs. Then, add an additional `*_processing` boolean field to the model for which you want to process attachments in the background, where `*` is the name of the attachment that you specified in your model's call to `has_attached_file`.
+Configure `Paperclip` as you normally would, according to their docs. Then, add an additional `*_processing` string field to the model for which you want to process attachments in the background, where `*` is the name of the attachment that you specified in your model's call to `has_attached_file`.
 
 ```ruby
 class AddImageProcessingToPosts < ActiveRecord::Migration[5.2]
   def change
-    add_column :posts, :image_processing, :boolean
+    add_column :posts, :image_processing, :string
   end
 end
 ```
 
+This column will be used to hold the temporary URL of the image that needs to be processed. It will override all calls to the `#url` method on `Paperclip` attachments until the processing is done so that there's no break in the visibility of the image.
+
 Then, add the ability to update the `*_url` attribute from the controller.
 
 ```ruby

data/lib/paperweight/hooks.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Paperweight
+  # Overrides that hook into `paperclip` to add functionality.
+  module Hooks
+    # Overrides the `has_attached_file` method from `paperclip` so that
+    # `paperweight` can add extras when the macro is called.
+    module RecordHook
+      # Converts a parent name to its respective component child names.
+      class AttachmentName
+        attr_reader :name
+
+        def initialize(name)
+          @name = name
+        end
+
+        def processing
+          :"#{name}_processing"
+        end
+
+        def url
+          :"#{name}_url"
+        end
+
+        def url_eq
+          :"#{name}_url="
+        end
+
+        def url_attr
+          :"@#{name}_url"
+        end
+      end
+
+      def has_attached_file(name, *) # rubocop:disable Naming/PredicateName
+        super
+
+        name = AttachmentName.new(name)
+        attr_reader name.url
+
+        define_paperweight_setter_for(name)
+        define_paperweight_after_commit_for(name)
+      end
+
+      private
+
+      def define_paperweight_setter_for(name)
+        define_method(name.url_eq) do |value|
+          instance_variable_set(name.url_attr, value)
+          self[name.processing] = value
+          self.updated_at = Time.now if value
+        end
+      end
+
+      def define_paperweight_after_commit_for(name)
+        after_commit if: name.url do
+          attachment_url = public_send(name.url)
+          PostProcessJob.perform_later(self, name.name.to_s, attachment_url)
+        end
+      end
+    end
+
+    # Overrides the `url` method from `paperclip` so that `paperweight` can
+    # check the `image_processing` field and use that if it's still processing.
+    module AttachmentHook
+      def url(*)
+        instance.public_send(:"#{name}_processing") || super
+      end
+    end
+  end
+end

data/lib/paperweight/post_process_job.rb

@@ -8,10 +8,8 @@ module Paperweight
     discard_on ActiveJob::DeserializationError
 
     def perform(model, name, url)
-      model.update!(
-        name => Download.new.download(url),
-        :"#{name}_processing" => false
-      )
+      tempfile = Download.new.download(url)
+      model.update!(name => tempfile, :"#{name}_processing" => nil)
     end
   end
 end

data/lib/paperweight/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Paperweight
-  VERSION = '0.2.0'
+  VERSION = '1.0.0'
 end

data/lib/paperweight.rb

@@ -9,8 +9,9 @@ require 'active_job'
 
 require 'paperweight/configuration'
 require 'paperweight/download'
-require 'paperweight/hook'
+require 'paperweight/hooks'
 require 'paperweight/post_process_job'
 require 'paperweight/version'
 
-Paperclip::ClassMethods.prepend(Paperweight::Hook)
+Paperclip::ClassMethods.prepend(Paperweight::Hooks::RecordHook)
+Paperclip::Attachment.prepend(Paperweight::Hooks::AttachmentHook)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paperweight
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Kevin Deisz
@@ -143,7 +143,7 @@ files:
 - lib/paperweight.rb
 - lib/paperweight/configuration.rb
 - lib/paperweight/download.rb
-- lib/paperweight/hook.rb
+- lib/paperweight/hooks.rb
 - lib/paperweight/post_process_job.rb
 - lib/paperweight/version.rb
 - paperweight.gemspec

data/lib/paperweight/hook.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-module Paperweight
-  # Overrides the `has_attached_file` method from `paperclip` so that
-  # `paperweight` can add extras when the macro is called.
-  module Hook
-    # Converts a parent name to its respective component child names.
-    class AttachmentName
-      attr_reader :name
-
-      def initialize(name)
-        @name = name
-      end
-
-      def processing
-        :"#{name}_processing"
-      end
-
-      def url
-        :"#{name}_url"
-      end
-
-      def url_eq
-        :"#{name}_url="
-      end
-
-      def url_attr
-        :"@#{name}_url"
-      end
-    end
-
-    def has_attached_file(name, *) # rubocop:disable Naming/PredicateName
-      super
-
-      name = AttachmentName.new(name)
-      attr_reader name.url
-
-      define_paperweight_setter_for(name)
-      define_paperweight_after_commit_for(name)
-    end
-
-    private
-
-    def define_paperweight_setter_for(name)
-      define_method(name.url_eq) do |value|
-        instance_variable_set(name.url_attr, value)
-        self[name.processing] = value ? true : false
-        self.updated_at = Time.now if value
-      end
-    end
-
-    def define_paperweight_after_commit_for(name)
-      after_commit if: name.url do
-        attachment_url = public_send(name.url)
-        PostProcessJob.perform_later(self, name.name.to_s, attachment_url)
-      end
-    end
-  end
-end