paperdragon 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00a917cff82896af01efe02f6217157cea6eb144
-  data.tar.gz: cd5588ff1dcb1dc713086d57b37b2ce5a12ffe8b
+  metadata.gz: c572a392762a6e502908b2669acf14b0584f3865
+  data.tar.gz: 134a7784f0170d5c9aea5343a4217a85458aff1b
 SHA512:
-  metadata.gz: e2944453772c81e767aa30ead6e175ca76beb8febf43c985d6446a1ab5ae4672d1647a0e1dde5c6c020fd7857b2dccbb0a1d2ceae9bef02177726937d7a30596
-  data.tar.gz: a5b2009a183835567b9d5e9217416287d9659ad86f02912a5592b0b073bd53c651ef09a993236fa5d6f85d9294d93152eaa7faa85046957bdfc749921d2d774f
+  metadata.gz: c1a60a4f77ad4a151d44f0c36fb578f3b620242e3681874d51ab2e83c787d416b6e659c341c23159e849f048807dd462738f21e99cbbe02102a287400f121331
+  data.tar.gz: e099ad54ab6ca8657d61695a25793431b669930caaf324baf2d96c13eeebc7793598910a780c6046c6aa39edec1a0e2341d96a814496ac106c94701a7a6ad7b6

data/README.md

@@ -319,6 +319,43 @@ Documentation how to use Sidekiq and paperdragon in Traiblazer will be added sho
 
 ## Validations
 
+Validating uploads are discussed in the _Callbacks_ chapter of the [Trailblazer
+book](https://leanpub.com/trailblazer). We use [file_validators](https://github.com/musaffa/file_validations).
+
+## Model: Reader and Writer
+
+If you don't like `Paperdragon::Model#image`'s fuzzy API you can use `Reader` and `Writer`.
+
+The `Writer` will usually be mixed into a form.
+
+```ruby
+class AlbumForm < Reform::Form
+  extend Paperdragon::Model::Writer
+  processable_writer :image
+```
+
+This provides the `image!` writer for processing a file.
+
+```ruby
+form.image!(file) { |v| v.thumb!("64x64") }
+```
+
+Likewise, `Reader` will usually be used in cells or decorators.
+
+```ruby
+class AlbumCell < Cell::ViewModel
+  extend Paperdragon::Model::Reader
+  processable_reader :image
+  property :image_meta_data
+```
+
+You can now access the `Attachment` via `image`.
+
+```ruby
+cell.image[:thumb].url
+```
+
+
 ## Paperclip compatibility
 
 I wrote paperdragon as an explicit alternative to paperclip. In the process of doing so, I step-wise replaced upload code, but left the rendering code unchanged. Paperclip has a slightly different API for rendering.

data/lib/paperdragon/CHANGES.md

@@ -1,3 +1,7 @@
+# 0.0.8
+
+* Introduce `Model::Writer` and `Model::Reader` in case you don't like `Model#image`'s fuzzy API.
+
 # 0.0.7
 
 * `Task#process!` (and the delegated `File#process!`) now delete the original version of an attachment if `process!` is used to replace the latter.

data/lib/paperdragon/model.rb

@@ -1,4 +1,5 @@
 module Paperdragon
+  # Fuzzy API: gives you #image that can do both upload and rendering.
   module Model
     def self.included(base)
       base.extend ClassMethods
@@ -14,7 +15,7 @@ module Paperdragon
       def attachment_accessor_for(name, attachment_class)
         mod = Module.new do # TODO: abstract that into Uber, we use it everywhere.
           define_method name do |file=nil, options={}, &block|
-            attachment = attachment_class.new(self.image_meta_data, options.merge({:model => self}))
+            attachment = attachment_class.new(image_meta_data, options.merge(model: self))
 
             return attachment unless file or block
 
@@ -24,5 +25,39 @@ module Paperdragon
         end
       end
     end
+
+
+    #   class Album
+    #     extend Paperdragon::Model::Writer
+    #     processable_writer :image
+    #
+    # Provides Album#image!(file) { |v| v.thumb!("64x64") }
+    module Writer
+      def processable_writer(name, attachment_class=Attachment)
+        mod = Module.new do # TODO: abstract that into Uber, we use it everywhere.
+          define_method "#{name}!" do |file=nil, options={}, &block|
+            attachment = attachment_class.new(image_meta_data, options.merge(model: self))
+
+            # run the task block and save the returned new metadata in the model.
+            self.image_meta_data = attachment.task(*[file], &block)
+          end
+        end
+        include mod
+      end
+    end # Writer.
+
+
+    #   class Album
+    #     extend Paperdragon::Model::Reader
+    #     processable_reader :image
+    #
+    # Provides Album#image #=> Attachment.
+    module Reader
+      def processable_reader(name, attachment_class=Attachment)
+        define_method name do
+          attachment_class.new(image_meta_data, model: self)
+        end
+      end
+    end
   end
 end

data/lib/paperdragon/version.rb

@@ -1,3 +1,3 @@
 module Paperdragon
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/test/model_test.rb

@@ -18,7 +18,10 @@ class PaperdragonModelTest < MiniTest::Spec
     end
   end
 
+  # model has image_meta_data hash.
   it { Avatar.new.image[:thumb].url.must_equal "/paperdragon/Avatar-thumb" }
+  # model doesn't have upload, yet. returns empty attachment.
+  it { Image.new.image.metadata.must_equal({}) }
 
 
   # minimum setup
@@ -51,7 +54,6 @@ class PaperdragonModelTest < MiniTest::Spec
     model.image_meta_data.must_equal({:original=>{:width=>216, :height=>63, :uid=>"original-apotomo.png"}, :thumb=>{:width=>8, :height=>2, :uid=>"thumb-apotomo-1.png"}})
   end
 
-
   # passing options from image(file, {..}) to the Attachment.
   class ImageWithAttachment < OpenStruct
     include Paperdragon::Model
@@ -84,4 +86,44 @@ class PaperdragonModelTest < MiniTest::Spec
 
     model.image_meta_data.must_equal({:original=>{:width=>8, :height=>2, :uid=>"{:new=>true, :model=>#<PaperdragonModelTest::ImageWithAttachment image_meta_data={:original=>{:width=>216, :height=>63, :uid=>\"{:path=>\\\"/\\\", :model=>_<PaperdragonModelTest::ImageWithAttachment>}\"}}>}"}})
   end
+end
+
+
+class ModelWriterTest < MiniTest::Spec
+  class Image < OpenStruct
+    extend Paperdragon::Model::Writer
+    processable_writer :image
+  end
+
+  # process with #image{}
+  let (:logo) { Pathname("test/fixtures/apotomo.png") }
+
+  it do
+    model = Image.new
+    model.image!(logo) do |v|
+      v.process!(:original)
+      v.process!(:thumb) { |j| j.thumb!("16x16") }
+    end
+
+    model.image_meta_data.must_equal({:original=>{:width=>216, :height=>63, :uid=>"original-apotomo.png"}, :thumb=>{:width=>16, :height=>5, :uid=>"thumb-apotomo.png"}})
+
+
+    model.image! do |v|
+      v.reprocess!(:thumb, "1") { |j| j.thumb!("8x8") }
+    end
+
+    model.image_meta_data.class.must_equal Hash
+    model.image_meta_data.must_equal({:original=>{:width=>216, :height=>63, :uid=>"original-apotomo.png"}, :thumb=>{:width=>8, :height=>2, :uid=>"thumb-apotomo-1.png"}})
+  end
+
+end
+
+
+class ModelReaderTest < MiniTest::Spec
+  class Image < OpenStruct
+    extend Paperdragon::Model::Reader
+    processable_reader :image
+  end
+
+  it { Image.new(:image_meta_data => {:thumb => {:uid => "Avatar-thumb"}}).image[:thumb].url.must_equal "/paperdragon/Avatar-thumb" }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paperdragon
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-09 00:00:00.000000000 Z
+date: 2015-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dragonfly