watarase 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19cc687771bed168df86daaa39b529f495639269
-  data.tar.gz: 6b749b3459d7e36bebf6cc45d0697b491496f35c
+  metadata.gz: bb3e733879e4f9adcb7a2b98f5d1107bbcff7ab0
+  data.tar.gz: 72549fe8bd2bcd9c2330a2cde3e0d154132885b1
 SHA512:
-  metadata.gz: c25b2bf0066a483130765bc1dd051a63a8a496fe8f8ce81248640298225a9c2e21c458137a51084fcb9a9e03f9a49b66c44d6c31b961ce119d235f14cad2aa54
-  data.tar.gz: 2d52636c2edbd7393afb71f2dbe6e2b679429ff524b6621bd66141e1b836d32e5766e3de3b362612729567cdc42d59b927a73774bf4c6debebcb2aff6d3f3d4d
+  metadata.gz: 2ce6cb1186198b64b23ff4fb8c43e89a0115e372f9570fce72887d8bbbe6e4f949140a80defa43542bfacc91a4d6f1e8e2712fccdb34962b4f2f74a5be654b30
+  data.tar.gz: ee19faa4daa8f5a294fe89c98ddc5a59b099ba31c99af6d5ba265ef01139fb0bd60a36820e013bacda125763ae8b2dd9047a5d9b4b50a9c48bb36e58c69759d4

data/README.rdoc

@@ -76,27 +76,25 @@ Add 'load_image' action in 'config/routes.rb'
 
 Define 'image_loadable <image_handler>' definition in controllers.
 
-    class UsersController < ApplicationController
-      image_loadable :user
-           :
+If you need image caching then, use options caches: and expire_actions:.
 
-Set image holder to image handler by method 'set_image_holder'.
+    class UsersController < ApplicationController
+      image_loadable :user, caches: true, expire_actions: [:update], save_actions: [:create, :update]
 
-      def create
-        @user = User.new(user_params)
-        set_image_holder @user
-           :
+In this case, action caching enabled, and clearing the cache in update action.
+The option save_actions is associate image_handler(ex. user) with image_holder(ex. user_image_holder).
 
-      def update
-        set_image_holder @user
-           :
+=== Tips
 
-If you need image caching then, use options caches: and expire_actions:.
-
-    image_loadable :user, caches: true, expire_actions: [:update]
+    def index
+      @users = User.all
+    end
 
-In this case, action caching enabled, and clearing the cache in update action.
+It is a good idea to make the following changes:
 
+    def index
+      @users = User.all.merge(includes: [:user_image_holder])
+    end
 
 == View
 

data/lib/watarase.rb

@@ -1,6 +1,4 @@
 require 'rubygems'
-#require 'RMagick'
-#require 'rmagick'
 require 'rails/generators'
 
 module Watarase
@@ -23,6 +21,8 @@ module Watarase
     end
   end
 end
-require 'watarase/model'
+require 'watarase/image_handler'
 require 'watarase/controller'
-require 'watarase/generators/uploader/uploader_generator'
+require 'watarase/generators/uploader/uploader_generator'
+require 'watarase/extension_whitelist'
+require 'watarase/image_holder'

data/lib/watarase/controller.rb

@@ -3,57 +3,60 @@ require 'action_controller/action_caching'
 module Watarase
   module Controller
     def self.included(controller)
-      controller.extend Watarase::ImageLoader
+      controller.extend Watarase::Controller::ImageLoader
     end
-  end
 
-  module ImageLoader
-    def image_loadable(_image_handler, options = {})
-      ih = _image_handler.to_s.camelize.constantize
-      self.class_variable_set(:@@image_handler, ih)
-      self.send(:include, Watarase::InstanceMethods)
-      self.send(:caches_action, :load_image) if options[:caches]
-      self.send(:before_action, :expire_caches, only: options[:expire_actions]) if options[:expire_actions]
-      self.send(:helper_method, :image_thumb_path)
-      self.send(:helper_method, :image_data_path)
+    module ImageLoader
+      def image_loadable(_image_handler, options = {})
+        ih = _image_handler.to_s.camelize.constantize
+        self.class_variable_set(:@@image_handler, ih)
+        self.send(:include, Watarase::Controller::InstanceMethods)
+        self.send(:caches_action, :load_image) if options[:caches]
+        self.send(:before_action, :expire_caches, only: options[:expire_actions]) if options[:expire_actions]
+        self.send(:before_action, :image_params, only: options[:save_actions]) if options[:save_actions]
+        self.send(:helper_method, :image_thumb_path)
+        self.send(:helper_method, :image_data_path)
+      end
     end
-  end
 
-  module InstanceMethods
-    def load_image
-      image = image_holder.find(params[:id])
-      column_name = :"#{(params[:image_column] || 'image_data')}"
-      send_data image.send(column_name), type: image.content_type, disposition: 'inline'
-    end
+    module InstanceMethods
+      def load_image
+        image = image_holder.find(params[:id])
+        column_name = :"#{(params[:image_column] || 'image_data')}"
+        send_data image.send(column_name), type: image.content_type, disposition: 'inline'
+      end
 
-    def expire_caches
-      expire_action action: :load_image
-    end
+      def expire_caches
+        expire_action action: :load_image
+      end
 
-    def image_params
-      params.require(image_handler.name.underscore.to_sym).permit(:image_file, :remove_image)
-    end
+      def image_params
+        ip = params.require(image_handler.name.underscore.to_sym).permit(:image_file, :remove_image)
+        puts "**** image_params **** #{ip} ****"
+        Thread.current[:image_params] = ip
+      end
 
-    def image_handler
-      self.class.class_variable_get(:@@image_handler)
-    end
+      def image_handler
+        self.class.class_variable_get(:@@image_handler)
+      end
 
-    def image_holder
-      "#{image_handler.name.underscore}_#{Watarase.suffix}".camelize.constantize
-    end
+      def image_holder
+        "#{image_handler.name.underscore}_#{Watarase.suffix}".camelize.constantize
+      end
 
-    def image_thumb_path(model)
-      url_for(controller: image_handler.name.downcase!.pluralize, action: 'load_image', id: model.send(:"#{image_holder.name.underscore}").id, image_column: :image_thumb)
-    end
+      def image_thumb_path(model)
+        url_for(controller: image_handler.name.downcase!.pluralize, action: 'load_image', id: model.send(:"#{image_holder.name.underscore}").id, image_column: :image_thumb)
+      end
 
-    def image_data_path(model)
-      url_for(controller: image_handler.name.downcase!.pluralize, action: 'load_image', id: model.send(:"#{image_holder.name.underscore}").id, image_column: :image_data)
-    end
+      def image_data_path(model)
+        url_for(controller: image_handler.name.downcase!.pluralize, action: 'load_image', id: model.send(:"#{image_holder.name.underscore}").id, image_column: :image_data)
+      end
 
-    # Call before create, update
-    def set_image_holder(_image_handler)
-      _image_handler.send(:"#{image_holder.name.underscore}=", image_holder.new) unless _image_handler.send(:"#{image_holder.name.underscore}")
-      _image_handler.send(:"#{image_holder.name.underscore}").uploaded_image = image_params
+      # Call before create, update
+      #def set_image_holder(_image_handler)
+      #  _image_handler.send(:"#{image_holder.name.underscore}=", image_holder.new) unless _image_handler.send(:"#{image_holder.name.underscore}")
+      #  _image_handler.send(:"#{image_holder.name.underscore}").uploaded_image = image_params
+      #end
     end
   end
 end

data/lib/watarase/extension_whitelist.rb

@@ -0,0 +1,21 @@
+module Watarase
+  module ImageHolder
+    module ExtensionWhitelist
+
+      def self.included(model)
+        model.send(:before_save, :check_extension)
+      end
+
+      def check_extension
+        puts "**** check_extension ****"
+        if filename && extension_white_list && !extension_white_list.include?(File.extname(filename).sub(/\./, ''))
+          raise StandardError, "Unsupported file " + filename
+        end
+      end
+
+      def extension_white_list
+        %w(jpg jpeg gif png)
+      end
+    end
+  end
+end

data/lib/watarase/generators/uploader/uploader_generator.rb

@@ -9,26 +9,10 @@ module Watarase
 
         str_code = <<-"CODE"
 
-  include Magick unless self.include? Magick
-  belongs_to :#{file_name}, primary_key: :#{fk}, foreign_key: :#{file_name}_#{fk}
+  acts_as_image_holder
 
-  def uploaded_image= (image_params)
-    if image_params[:remove_image] && image_params[:remove_image] == "1"
-      self.destroy
-    elsif image_params[:image_file] && !image_params[:image_file].blank?
-      self.filename = image_params[:image_file].original_filename
-      self.content_type = image_params[:image_file].content_type
-      data = image_params[:image_file].tempfile.read
-      self.image_data = Image.from_blob(data).first.resize_to_fit(100, 100).to_blob
-      self.image_thumb = Image.from_blob(data).first.thumbnail(35, 35).to_blob
-    elsif self.new_record?
-      self.destroy
-    end
-  end
+  belongs_to :#{file_name}, primary_key: :#{fk}, foreign_key: :#{file_name}_#{fk}
 
-  def extension_white_list
-    %w(jpg jpeg gif png)
-  end
         CODE
 
         generate "model", "#{model_name} #{file_name}_#{fk}:#{fk_type} filename:string content_type:string image_data:binary image_thumb:binary"

data/lib/watarase/image_handler.rb

@@ -0,0 +1,37 @@
+require 'active_record/base'
+
+module Watarase
+  module ImageHandler
+    def self.included(model)
+      model.extend Watarase::ImageHandler::Macro
+    end
+  end
+end
+
+module Watarase
+  module ImageHandler
+    module Macro
+      def acts_as_image_handler
+        image_holder = (self.name.underscore << '_' << Watarase.suffix).to_sym
+        self.send(:include, Watarase::ImageHandler::Associate)
+        self.send(:has_one, image_holder, primary_key: self.primary_key, foreign_key: "#{self.name.underscore}_#{self.primary_key}", autosave: true, dependent: :destroy)
+        self.send(:attr_accessor, :remove_image)
+        self.send(:before_save, :update_image_holder)
+      end
+    end
+
+    module Associate
+      def update_image_holder
+        puts "**** update image holder **** #{Thread.current[:image_params]} ****"
+        image_holder = (self.class.name.underscore << '_' << Watarase.suffix)
+        return if (!self.send(image_holder.to_sym) and (!Thread.current[:image_params] or !Thread.current[:image_params][:image_file]))
+
+        self.send((image_holder + '=').to_sym, image_holder.camelcase.constantize.new) unless self.send(image_holder.to_sym)
+        self.send(image_holder.to_sym).send(:uploaded_image=, (Thread.current[:image_params] || {}))
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, Watarase::ImageHandler unless ActiveRecord::Base.include? Watarase::ImageHandler
+

data/lib/watarase/image_holder.rb

@@ -0,0 +1,47 @@
+#require 'RMagick'
+require 'rmagick'
+
+module Watarase
+  module ImageHolder
+    def self.included(model)
+      model.extend Watarase::ImageHolder::Macro
+    end
+  end
+end
+
+module Watarase
+  module ImageHolder
+    module Macro
+      def acts_as_image_holder
+        self.send(:include, Watarase::ImageHolder::ExtensionWhitelist)
+        self.send(:include, Watarase::ImageHolder::Store)
+        self.send(:before_save, :prepare_image)
+      end
+    end
+
+    module Store
+      def uploaded_image= (image_params)
+        puts "**** uploaded_image ****"
+        if image_params[:remove_image] && image_params[:remove_image] == "1"
+          self.destroy
+        elsif image_params[:image_file] && !image_params[:image_file].blank?
+          self.filename = image_params[:image_file].original_filename
+          @image_filename = self.filename
+          self.content_type = image_params[:image_file].content_type
+          @data = image_params[:image_file].tempfile.read
+        elsif self.new_record?
+          self.destroy
+        end
+      end
+
+      def prepare_image
+        puts "**** prepare_image ****"
+        return unless @data
+        self.image_data = Magick::Image.from_blob(@data).first.resize_to_fit(100, 100).to_blob
+        self.image_thumb = Magick::Image.from_blob(@data).first.thumbnail(35, 35).to_blob
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, Watarase::ImageHolder unless ActiveRecord::Base.include? Watarase::ImageHolder

data/lib/watarase/version.rb

@@ -1,3 +1,3 @@
 module Watarase
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/test/dummy/app/controllers/users_controller.rb

@@ -1,12 +1,12 @@
 class UsersController < ApplicationController
-  image_loadable :user, caches: true, expire_actions: [:update]
+  image_loadable :user, caches: true, expire_actions: [:update], save_actions: [:create, :update]
 
   before_action :set_user, only: [:show, :edit, :update, :destroy]
 
   # GET /users
   # GET /users.json
   def index
-    @users = User.all
+    @users = User.all.merge(includes: [:user_image_holder])
   end
 
   # GET /users/1
@@ -27,7 +27,7 @@ class UsersController < ApplicationController
   # POST /users.json
   def create
     @user = User.new(user_params)
-    set_image_holder @user
+    #set_image_holder @user
 
     respond_to do |format|
       if @user.save
@@ -44,7 +44,7 @@ class UsersController < ApplicationController
   # PATCH/PUT /users/1.json
   def update
 
-    set_image_holder @user
+    #set_image_holder @user
 
     respond_to do |format|
       if @user.update(user_params)

data/test/dummy/app/models/user.rb

@@ -1,4 +1,5 @@
 class User < ActiveRecord::Base
   self.primary_key = :username
   acts_as_image_handler
+  validates_presence_of :username
 end

data/test/dummy/app/models/user_image_holder.rb

@@ -1,18 +1,7 @@
 class UserImageHolder < ActiveRecord::Base
-  include Magick unless self.include? Magick
+
+  image_holdable
+
   belongs_to :user, primary_key: :username, foreign_key: :user_username
 
-  def uploaded_image= (image_params)
-    if image_params[:remove_image] && image_params[:remove_image] == "1"
-      self.destroy
-    elsif image_params[:image_file] && !image_params[:image_file].blank?
-      self.filename = image_params[:image_file].original_filename
-      self.content_type = image_params[:image_file].content_type
-      data = image_params[:image_file].tempfile.read
-      self.image_data = Image.from_blob(data).first.resize_to_fit(100, 100).to_blob
-      self.image_thumb = Image.from_blob(data).first.thumbnail(35, 35).to_blob
-    elsif self.new_record?
-      self.destroy
-    end
-  end
 end

data/test/dummy/test/fixtures/user_image_holders.yml

@@ -1,22 +1,15 @@
 # Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/Fixtures.html
-<%
-  def image_data
-    File.open(Rails.root.join('test/fixtures/images', 'default.png'), 'rb') do |f|
-      "!!binary \"#{Base64.strict_encode64(f.read)}\""
-    end
-  end
-%>
 
 one:
   user_username: MyString1
-  filename: file_one
-  content_type: 'image/png'
-  image_data: <%= image_data %>
-  image_thumb: <%= image_data %>
+  filename: MyString.png
+  content_type: MyString
+  image_data: 
+  image_thumb: 
 
 two:
   user_username: MyString2
-  filename: file_two
-  content_type: 'image/png'
-  image_data: <%= image_data %>
-  image_thumb: <%= image_data %>
+  filename: MyString.jpg
+  content_type: MyString
+  image_data: 
+  image_thumb: 

data/test/dummy/test/models/user_image_holder_test.rb

@@ -4,11 +4,4 @@ class UserImageHolderTest < ActiveSupport::TestCase
   # test "the truth" do
   #   assert true
   # end
-  def setup
-    @user_image_holder = UserImageHolder.first
-  end
-
-  test "image holder has image handler" do
-    assert_respond_to(@user_image_holder, :user)
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: watarase
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - kobayashi-tbn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-02 00:00:00.000000000 Z
+date: 2013-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -75,8 +75,10 @@ extra_rdoc_files: []
 files:
 - lib/tasks/watarase_tasks.rake
 - lib/watarase/controller.rb
+- lib/watarase/extension_whitelist.rb
 - lib/watarase/generators/uploader/uploader_generator.rb
-- lib/watarase/model.rb
+- lib/watarase/image_handler.rb
+- lib/watarase/image_holder.rb
 - lib/watarase/version.rb
 - lib/watarase.rb
 - MIT-LICENSE
@@ -124,8 +126,8 @@ files:
 - test/dummy/config/routes.rb
 - test/dummy/config.ru
 - test/dummy/db/migrate/20130316163018_create_users.rb
-- test/dummy/db/migrate/20130318134905_create_user_image_holders.rb
 - test/dummy/db/migrate/20130324161507_create_posts.rb
+- test/dummy/db/migrate/20130412174428_create_user_image_holders.rb
 - test/dummy/db/schema.rb
 - test/dummy/db/seeds.rb
 - test/dummy/Gemfile
@@ -219,8 +221,8 @@ test_files:
 - test/dummy/config/routes.rb
 - test/dummy/config.ru
 - test/dummy/db/migrate/20130316163018_create_users.rb
-- test/dummy/db/migrate/20130318134905_create_user_image_holders.rb
 - test/dummy/db/migrate/20130324161507_create_posts.rb
+- test/dummy/db/migrate/20130412174428_create_user_image_holders.rb
 - test/dummy/db/schema.rb
 - test/dummy/db/seeds.rb
 - test/dummy/Gemfile

data/lib/watarase/model.rb

@@ -1,20 +0,0 @@
-require 'active_record/base'
-
-module Watarase
-  module Model
-    def self.included(model)
-      model.extend Watarase::ActsAsImageHandler
-    end
-  end
-
-  module ActsAsImageHandler
-    def acts_as_image_handler
-      image_holder = (self.name.underscore << '_' << Watarase.suffix).to_sym
-      self.send(:has_one, image_holder, primary_key: self.primary_key, foreign_key: "#{self.name.underscore}_#{self.primary_key}", autosave: true)
-      self.send(:attr_accessor, :remove_image)
-    end
-  end
-end
-
-ActiveRecord::Base.send :include, Watarase::Model unless ActiveRecord::Base.include? Watarase::Model
-