hanami-shrine 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a4b2d769b9c4ae74aa70fb0123ec6c946d99c9a
-  data.tar.gz: 7697d45f9ece1f8c340135b90499448646427d99
+  metadata.gz: e247ae2c7d1155f30389af1800709dd2eca26692
+  data.tar.gz: b9cce6169be65754c1e79f3b2b14557c7eebbae1
 SHA512:
-  metadata.gz: ce937ea318c92b34618915753a11d39f6244838675bb931f0f14b45df641c3a571d39b23ee56556495fde30e1dff0ddb7c30030144527292e191f9638338ed8a
-  data.tar.gz: 0cd4719b771e3810eb7c651244ff77560077477ce12aeae2781da312701c1e51f44add62a54c8801d9c1f5800dbdfbebda8e5d668a995810b908ca32d48633f4
+  metadata.gz: 79e3315c7a4cb0a14898b17eb67eaf995419971472fdb0b3f447158dc46b758d3c03ed5d7d01bed6730249ceefa1181a8e061cd3803184499d1dd23358168f13
+  data.tar.gz: fbf4bb823e49230e23ea3dee488b691e05ffe3ff86342406e8da955d6ae428d7c02e2483c8a8777b10e674c13e7ad63b729840442074e535517a7a2f4956cdfc

data/.travis.yml

@@ -1,4 +1,4 @@
 language: ruby
 rvm:
-  - 2.2.3
+  - 2.3.3
 before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -2,3 +2,6 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in hanami-shrine.gemspec
 gemspec
+gem 'shrine', '>= 2.0.0'
+gem 'sqlite3'
+gem 'pry'

data/README.md

@@ -4,6 +4,13 @@ This gem aims at providing support for [Shrine](https://github.com/janko-m/shrin
 
 [![Build Status](https://travis-ci.org/katafrakt/hanami-shrine.svg)](https://travis-ci.org/katafrakt/hanami-shrine)
 [![Gem Version](https://badge.fury.io/rb/hanami-shrine.svg)](https://badge.fury.io/rb/hanami-shrine)
+[![Code Climate](https://codeclimate.com/github/katafrakt/hanami-shrine/badges/gpa.svg)](https://codeclimate.com/github/katafrakt/hanami-shrine)
+
+### Current compatibility status
+
+* working with Hanami version 0.7.x
+* working with Hanami version 0.8.x without validations (which have been extracted to separate gem)
+* does not work work with Hanami 0.9.x (work in progress, see [#1](https://github.com/katafrakt/hanami-shrine/issues/1))
 
 ## Installation
 
@@ -30,7 +37,7 @@ end
 Then, in your repository add (assuming your attachment is `avatar`):
 
 ```ruby
-extend ImageAttachment.repository(:avatar)
+prepend ImageAttachment.repository(:avatar)
 ```
 
 And in your entity:
@@ -39,32 +46,14 @@ And in your entity:
 include ImageAttachment[:avatar]
 ```
 
-To use validations, enable them during setup of the plugin:
-
-```ruby
-class ImageAttachment < Shrine
-  plugin :hanami, validations: true
-end
-```
-
-And you can write some validation code. For example:
-
-```ruby
-class ImageAttachment < Shrine
-  plugin :validation_helpers
-  plugin :determine_mime_type
-  plugin :hanami, validations: true
-
-  Attacher.validate do
-    validate_max_size 180_000, message: "is too large (max is 2 MB)"
-    validate_mime_type_inclusion ["image/jpg", "image/jpeg"]
-  end
-end
-```
+For inspiration read a [blog post](http://katafrakt.me/2016/02/04/shrine-hanami-uploads/), look at [the specs](https://github.com/katafrakt/hanami-shrine/tree/master/spec/hanami) or [example repo](https://github.com/katafrakt/hanami-shrine-example).
 
-Remember that you have to call `valid?` or `validate` yourself. There is not as much magic in Hanami as it is in Rails :wink:
+## Important changes since 0.1 version
 
-For inspiration look at [the specs](https://github.com/katafrakt/hanami-shrine/tree/master/spec/hanami) or [example repo](https://github.com/katafrakt/hanami-shrine-example).
+As Hanami has been upgraded to 0.9, it started to use new engine for the entities in `hanami-model`. It required heavy changes in `hanami-shrine` to accomodate to new paradigm. Unfortunately, some of them are breaking. Here's a summary list:
+* Validations are gone (for now, hopefully)
+* You need to use `prepend` instead of `extend` in your repository
+* Entities are now read-only. You need to initialize them with the attachment, not add it later: `MyEntity.new(avatar: File.open('my_avatar.png')`. This is a Hanami change, but it's worth mentioning here as well.
 
 ## Development
 

data/hanami-shrine.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'shrine'
-  spec.add_dependency 'hanami-model'
+  spec.add_dependency 'hanami-model', '>= 0.7'
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/hanami/shrine/version.rb

@@ -1,5 +1,5 @@
 module Hanami
   module Shrine
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/shrine/plugins/hanami.rb

@@ -3,65 +3,114 @@ require 'shrine'
 class Shrine
   module Plugins
     module Hanami
-      def self.configure(uploader, validations: nil)
-        uploader.opts[:hanami_validations] = validations
-      end
-
       module AttachmentMethods
         def initialize(name)
           super
 
-          if shrine_class.opts[:hanami_validations]
-            module_eval <<-RUBY, __FILE__, __LINE__ + 1
-              def validate
-                super
-                #{name}_attacher.errors.each do |message|
-                  errors.add(:#{name}, message)
-                end
+          module_eval <<-RUBY, __FILE__, __LINE__ + 1
+            module EntitySupport
+              attr_reader :attributes
+              def initialize(attributes)
+                attachment = attributes[:#{name}]
+                @_#{name} = attachment
+                self.#{name}_attacher
+                super(attributes)
               end
-            RUBY
-          end
+
+              def #{name}_data=(data)
+                @#{name}_data = data
+              end
+
+              def #{name}_data
+                super || @#{name}_data
+              end
+
+              def #{name}
+                @_#{name} || super
+              end
+
+              def attributes
+                @_#{name} ? super.merge(#{name}: @_#{name}) : super
+              end
+            end
+
+            prepend EntitySupport
+          RUBY
         end
       end
 
       module ClassMethods
         def repository(name)
-          RepositoryMethods.new(name)
+          RepositoryMethods.new(name, self)
         end
       end
 
       class RepositoryMethods < Module
-        def initialize(name)
+        def initialize(name, attacher_class)
           module_eval <<-RUBY, __FILE__, __LINE__ + 1
             def create(entity)
-              save_#{name}_attachment(entity) { super }
+              save_#{name}_attachment(entity) { |new_entity| super(new_entity) }
             end
-            def update(entity)
-              save_#{name}_attachment(entity) { super }
+            def update(id, entity)
+              save_#{name}_attachment(entity) { |new_entity| super(id, new_entity) }
             end
             def persist(entity)
-              save_#{name}_attachment(entity) { super }
+              save_#{name}_attachment(entity) { |new_entity| super(new_entity) }
             end
-            def delete(entity)
-              delete_#{name}_attachment(entity) { super }
+            def delete(id)
+              delete_#{name}_attachment(id) { super(id) }
             end
 
             private
-            def save_#{name}_attachment(entity)
-              entity.#{name}_attacher.save
+            def save_#{name}_attachment(original_entity)
+              attacher_proxy = Entity.attacher(:#{name}, #{attacher_class})
 
-              entity.#{name}_attacher.replace
-              entity.#{name}_attacher._promote
-              yield
+              if original_entity.#{name}
+                attacher_proxy.#{name} = original_entity.#{name}
+                attacher_proxy.#{name}_attacher.save
+
+                attacher_proxy.#{name}_attacher.replace
+                attacher_proxy.#{name}_attacher._promote
+
+                original_entity_attributes = original_entity.attributes
+                original_entity_attributes.delete(:#{name})
+
+                entity = original_entity.class.new(original_entity_attributes.merge(#{name}_data: attacher_proxy.#{name}_data))
+              else
+                entity = original_entity
+              end
+
+              yield(entity)
             end
 
-            def delete_#{name}_attachment(entity)
+            def delete_#{name}_attachment(id)
+              entity = find(id)
               yield
               entity.#{name}_attacher.destroy
             end
           RUBY
         end
       end
+
+      module Entity
+        def self.attacher(name, attacher)
+          attachment_proxy ||= Class.new
+          attachment_proxy.send(:include, attacher[name])
+          attachment_proxy.class_eval do
+            define_method :initialize do |attributes|
+            end
+
+            define_method :"#{name}_data" do
+              @attachment_data
+            end
+
+            define_method :"#{name}_data=" do |data|
+              @attachment_data = data
+            end
+          end
+          attachment_proxy.new({})
+        end
+      end
     end
 
     register_plugin(:hanami, Hanami)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-shrine
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Paweł Świątkowski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-25 00:00:00.000000000 Z
+date: 2016-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shrine
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -148,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Support for Shrine gem in Hanami framework