watarase 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b6816958a8af5231d8b1b44cbace43f565a71a0f
+  data.tar.gz: a6924e9932f269f1fb02a732e49c72304eed0437
+SHA512:
+  metadata.gz: dd29a838bc048ebb4d2203c101a4b6949298d6755e76ad938ce801940e0daebbfa28deca48d5198381bc86c0f5b091ae2e926386647e19a271fc483557657dd2
+  data.tar.gz: 747086dbb5ce17339ce21ee3599e947a256a1d5abcd860a72359176be7dd30ca6c0c1971a748a7e49aacb84ad9a1f3254e6be3c9ec4722bf65b306715a66ee37

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Toshinobu KOBAYASHI
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,156 @@
+= Watarase
+
+Watarase is a rails plugin for Image Upload.
+
+Images are stored into the database as binary data.
+This plugin is inteded to be handled as a small image of the icon.
+
+
+== Installation
+
+Add to Gemfile following
+
+  gem 'watarase'
+  gem 'rmagick'
+
+Now, watarase plugin setting following
+
+  gem 'watarase', :git => 'git://github.com/kobayashi-tbn/watarase.git'
+
+
+== Getting Started
+
+Any model of the target is present is expected.
+
+example
+
+  rails generate scaffold user username:string email:string
+
+That model is the image handler.
+
+Generate image holder. This is a model that is made separately.
+
+  rails generate watarase:uploader user
+
+The generator made UserImageHolder the model class and the migration file.
+
+Example of migration file is following.
+
+    class CreateUserImageHolders < ActiveRecord::Migration
+      def change
+        create_table :user_image_holders do |t|
+          t.string :user_username
+          t.string :filename
+          t.string :content_type
+          t.binary :image_data
+          t.binary :image_thumb
+
+          t.timestamps
+        end
+      end
+    end
+
+In this case, the foreign key 'user_username' is type :string.
+It was named {model name}_{pk} automatically.
+
+== Active Record
+
+Define 'acts_as_image_hander' into Image handler model (ex. User).
+
+  class User
+    self.primary_key :username # if this model's PK was 'username'.
+    acts_as_image_handler # define image hander
+  end
+
+== Routing
+
+Add 'load_image' action in 'config/routes.rb'
+
+  resources :users do
+    member do
+      get 'load_image'
+    end
+  end
+
+== Controller
+
+Define 'image_loadable <image_handler>' definition in controllers.
+
+    class UsersController < ApplicationController
+      image_loadable :user
+           :
+
+Set image holder to image handler by method 'set_iamge_holder'.
+
+      def create
+        @user = User.new(user_params)
+        set_image_holder @user
+           :
+
+      def update
+        set_image_holder @user
+           :
+
+== View
+
+Examples _form.html.erb for User
+
+    <%= form_for(@user) do |f| %>
+      <% if @user.errors.any? %>
+        <div id="error_explanation">
+          <h2><%= pluralize(@user.errors.count, "error") %> prohibited this user from being saved:</h2>
+
+          <ul>
+          <% @user.errors.full_messages.each do |msg| %>
+            <li><%= msg %></li>
+          <% end %>
+          </ul>
+        </div>
+      <% end %>
+
+      <div class="field">
+        <%= f.label :username %><br />
+        <%= f.text_field :username %>
+      </div>
+      <div class="field">
+        <%= f.label :email %><br />
+        <%= f.text_field :email %>
+      </div>
+      <div class="field">
+        <%= f.label :image_file %><br />
+        <%= f.file_field :image_file %>
+      </div>
+      <% unless @user.new_record? %>
+            <div class="field">
+              <%= f.check_box :remove_image %>
+              <%= f.label :remove_image %><br />
+            </div>
+      <% end %>
+      <div class="actions">
+        <%= f.submit %>
+      </div>
+    <% end %>
+
+Add file_field form, and check box for remove the image.
+Parameter name is fixed, :image_file and :remove_image.
+
+Examples image load in index.html.erb
+
+    <% @users.each do |user| %>
+    <tr>
+      <td><%= image_tag image_thumb_path user if user.user_image_holder %></td>
+      <td><%= user.username %></td>
+      <td><%= link_to 'Show', user %></td>
+      <td><%= link_to 'Edit', edit_user_path(user) %></td>
+      <td><%= link_to 'Destroy', user, method: :delete, data: { confirm: 'Are you sure?' } %></td>
+    </tr>
+    <% end %>
+
+
+== TODO
+
+  * Configuring parameters for plugin settings.
+  * Secure upload by file extentions.
+
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Watarase'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/tasks/watarase_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :watarase do
+#   # Task goes here
+# end

data/lib/watarase.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'RMagick'
+#require 'rmagick'
+require 'rails/generators'
+
+module Watarase
+
+  @@suffix = "image_holder"
+
+  def self.suffix
+    @@suffix
+  end
+
+  def self.suffix=(_suffix)
+    @@suffix = _suffix
+  end
+end
+
+module Watarase
+  module Generators
+    class Base < Rails::Generators::NamedBase
+      #source_root File.expand_path(File.join(File.dirname(__FILE__), "watarase", "generator", "uploader", "template"))
+    end
+  end
+end
+require 'watarase/model'
+require 'watarase/controller'
+require 'watarase/generators/uploader/uploader_generator'

data/lib/watarase/controller.rb

@@ -0,0 +1,49 @@
+module Watarase
+  module Controller
+    def self.included(controller)
+      controller.extend Watarase::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(:helper_method, :image_thumb_path)
+    end
+  end
+
+  module InstanceMethods
+    def load_image
+      #image = "#{image_handler}_image".camelize.constantize.find(params[:id])
+      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 image_params
+      params.require(image_handler.name.underscore.to_sym).permit(:image_file, :remove_image)
+    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_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
+
+    # 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
+
+ActionController::Base.send :include, Watarase::Controller unless ActionController::Base.include? Watarase::Controller

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

@@ -0,0 +1,45 @@
+module Watarase
+  module Generators
+    class UploaderGenerator < Base
+      def create_image_holder
+        image_handler = file_name.camelcase.constantize
+        fk = image_handler.primary_key
+        fk_type = ((image_handler.respond_to? :columns) ? image_handler.columns.select{|column| column.name == fk}.first.type : :integer)
+        model_name = "#{file_name}_#{Watarase.suffix}"
+
+        # RMagick
+        str_include = "  include Magick unless self.include? Magick\n"
+
+        # Associations
+        str_belongs_to = "  belongs_to :#{file_name}, primary_key: :#{fk}, foreign_key: :#{file_name}_#{fk}\n"
+
+        # Instance Methods
+        str_methods = <<-CODE
+
+  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
+
+  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"
+        inject_into_class "app/models/#{model_name}.rb", model_name.camelcase.constantize do
+          str_include << str_belongs_to << str_methods
+        end
+      end
+    end
+  end
+end

data/lib/watarase/model.rb

@@ -0,0 +1,20 @@
+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
+

data/lib/watarase/version.rb

@@ -0,0 +1,3 @@
+module Watarase
+  VERSION = "0.0.2"
+end

data/test/dummy/Gemfile

@@ -0,0 +1,40 @@
+source 'https://rubygems.org'
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '4.0.0.beta1'
+
+gem 'pg'
+
+# Gems used only for assets and not required
+# in production environments by default.
+group :assets do
+  gem 'sass-rails',   '~> 4.0.0.beta1'
+  gem 'coffee-rails', '~> 4.0.0.beta1'
+
+  # See https://github.com/sstephenson/execjs#readme for more supported runtimes
+  # gem 'therubyracer', platforms: :ruby
+
+  gem 'uglifier', '>= 1.0.3'
+end
+
+gem 'jquery-rails'
+
+# Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
+gem 'turbolinks'
+
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 1.0.1'
+
+# To use ActiveModel has_secure_password
+# gem 'bcrypt-ruby', '~> 3.0.0'
+
+# Use unicorn as the app server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano', group: :development
+
+# To use debugger
+# gem 'debugger'
+
+gem 'rmagick'

data/test/dummy/Gemfile.lock

@@ -0,0 +1,120 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.0.0.beta1)
+      actionpack (= 4.0.0.beta1)
+      mail (~> 2.5.3)
+    actionpack (4.0.0.beta1)
+      activesupport (= 4.0.0.beta1)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.0.beta1)
+      activesupport (= 4.0.0.beta1)
+      builder (~> 3.1.0)
+    activerecord (4.0.0.beta1)
+      activemodel (= 4.0.0.beta1)
+      activerecord-deprecated_finders (~> 0.0.3)
+      activesupport (= 4.0.0.beta1)
+      arel (~> 4.0.0.beta1)
+    activerecord-deprecated_finders (0.0.3)
+    activesupport (4.0.0.beta1)
+      i18n (~> 0.6.2)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.33)
+    arel (4.0.0.beta1)
+    atomic (1.0.1)
+    builder (3.1.4)
+    coffee-rails (4.0.0.beta1)
+      coffee-script (>= 2.2.0)
+      railties (>= 4.0.0.beta, < 5.0)
+    coffee-script (2.2.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.5.0)
+    erubis (2.7.0)
+    execjs (1.4.0)
+      multi_json (~> 1.0)
+    hike (1.2.1)
+    i18n (0.6.4)
+    jbuilder (1.0.2)
+      activesupport (>= 3.0.0)
+    jquery-rails (2.2.1)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    json (1.7.7)
+    mail (2.5.3)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.21)
+    minitest (4.6.2)
+    multi_json (1.6.1)
+    pg (0.14.1)
+    polyglot (0.3.3)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.0.0.beta1)
+      actionmailer (= 4.0.0.beta1)
+      actionpack (= 4.0.0.beta1)
+      activerecord (= 4.0.0.beta1)
+      activesupport (= 4.0.0.beta1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.0.beta1)
+      sprockets-rails (~> 2.0.0.rc3)
+    railties (4.0.0.beta1)
+      actionpack (= 4.0.0.beta1)
+      activesupport (= 4.0.0.beta1)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.17.0, < 2.0)
+    rake (10.0.3)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rmagick (2.13.2)
+    sass (3.2.6)
+    sass-rails (4.0.0.beta1)
+      railties (>= 4.0.0.beta, < 5.0)
+      sass (>= 3.1.10)
+      sprockets-rails (~> 2.0.0.rc0)
+      tilt (~> 1.3)
+    sprockets (2.9.0)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.0.0.rc3)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    thor (0.17.0)
+    thread_safe (0.1.0)
+      atomic
+    tilt (1.3.4)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    turbolinks (1.0.0)
+      coffee-rails
+    tzinfo (0.3.36)
+    uglifier (1.3.0)
+      execjs (>= 0.3.0)
+      multi_json (~> 1.0, >= 1.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coffee-rails (~> 4.0.0.beta1)
+  jbuilder (~> 1.0.1)
+  jquery-rails
+  pg
+  rails (= 4.0.0.beta1)
+  rmagick
+  sass-rails (~> 4.0.0.beta1)
+  turbolinks
+  uglifier (>= 1.0.3)