tori 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 63eb309ef18d6c682fec8fe879cba915aaa7080c
+  data.tar.gz: 4481a5b9462416c24e7da0cf766df0c8ba081a20
+SHA512:
+  metadata.gz: cf11628e41240b07be7c7e4cdd7b4fe591eb0d939981fa713c59a5d1f688736657c144e037b3f94a433e249e5a98e6a4554a488b5b0293f2daf91d28379d6b93
+  data.tar.gz: aee79da9edd01954b4ab876fc18a7f8658f975db978f15881217ad0799249ee3c7bb8a0cbab9e48eeebe6c26b86080d926e7d9034d5a0d36fbfa7d93c71e0c5d

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 ksss
+
+MIT License
+
+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.md

@@ -0,0 +1,90 @@
+Tori
+===
+
+Tori is a very very simple file uploader.
+
+Tori dose nothing.
+
+Only file upload to backend store.
+
+You can upload file without alter database.
+
+# Quick start on Rails
+
+Gemfile
+
+```
+gem 'tori', require: 'tori/rails'
+```
+
+app/models/photo.rb
+
+```ruby
+class Photo < ActiveRecord::Base
+  tori :image
+end
+```
+
+app/controllers/photos_controller.rb
+
+```ruby
+class PhotosController < ApplicationController
+  def new
+    @photo = Photo.new
+  end
+
+  def create
+    Photo.create(photo_params)
+    redirect_to root_path
+  end
+
+  private
+
+    def photo_params
+      params.require(:photo).permit(:image)
+    end
+end
+```
+
+app/views/photos/new.html.slim
+
+```ruby
+= form_for @photo, multipart: true |f|
+  = f.file_field 'image'
+  = f.button 'Upload'
+```
+
+# default configure
+
+```
+# Tori using hash function for decide filename.
+# Filename dependent on class name and `id` setting with `tori` method in class.
+Tori.config.hash_method = Digest::MD5.method(:hexdigest)
+
+# Rails
+Tori.config.backend = Tori::Backend::FileSystem.new(Rails.root.join('tmp', 'tori'))
+
+# Other
+Tori.config.backend = Tori::Backend::FileSystem.new(Pathname("tmp/tori"))
+```
+
+You can change configure any time.
+
+# Options
+
+Change hash resource data.
+
+```
+class Photo < ActiveRecord::Base
+  tori :image, id: :filename
+  def filename
+    "abc"
+  end
+end
+```
+
+This class never upload two file.
+
+# future TODO
+
+- support background S3 Storage

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+task :default => [:test]
+Rake::TestTask.new {|t| t.libs << 'test'}

data/lib/tori.rb

@@ -0,0 +1,18 @@
+require 'tori/backend/filesystem'
+require 'tori/config'
+require 'tori/define'
+require 'tori/version'
+require 'pathname'
+require 'digest/md5'
+require "fileutils"
+
+module Tori
+  class << self
+    def config
+      @config ||= Config.new.tap do |config|
+        config.backend = Tori::Backend::FileSystem.new(Pathname("tmp/tori"))
+        config.hash_method = Digest::MD5.method(:hexdigest)
+      end
+    end
+  end
+end

data/lib/tori/backend/filesystem.rb

@@ -0,0 +1,18 @@
+module Tori
+  module Backend
+    class FileSystem
+      def initialize(root)
+        @root = root
+        FileUtils.mkdir_p(@root.to_s)
+      end
+
+      def copy(uploader, filename)
+        IO.copy_stream(uploader, @root.join(filename))
+      end
+
+      def delete(filename)
+        File.unlink @root.join(filename)
+      end
+    end
+  end
+end

data/lib/tori/config.rb

@@ -0,0 +1,9 @@
+module Tori
+  class Config
+    attr_accessor :backend, :hash_method
+    def initialize
+      @backend = nil
+      @hash_method = nil
+    end
+  end
+end

data/lib/tori/define.rb

@@ -0,0 +1,21 @@
+module Tori
+  module Define
+    def tori(name, id: :id)
+      name_hash_get = "#{name}_hash".to_sym
+      name_ivar = "@#{name}".to_sym
+      name_hash_ivar = "@#{name}_hash".to_sym
+
+      define_method(name) do
+        instance_variable_get name_ivar
+      end
+
+      define_method("#{name}=") do |uploader|
+        instance_variable_set name_ivar, uploader
+      end
+
+      define_method(name_hash_get) do
+        Tori.config.hash_method.call "#{self.class.name}/#{__send__(id.to_sym)}"
+      end
+    end
+  end
+end

data/lib/tori/rails.rb

@@ -0,0 +1,49 @@
+require 'tori'
+
+module Tori
+  class Engine < Rails::Engine
+    initializer "tori.setup", before: :load_environment_config do
+      # Default backend config
+      # You can change setting any time.
+      # Recommend to create config/initializer/tori.rb for setting.
+
+      # Configure for file store backend instance.
+      Tori.config.backend = Tori::Backend::FileSystem.new(Rails.root.join('tmp', 'tori'))
+
+      # Filename hashing method
+      #   It's call when decide filename hash.
+      #   `hash_method` must be have `call` method.
+      #   default: `Digest::MD5.method(:hexdigest)``
+      # Tori.config.hash_method = Digest::MD5.method(:hexdigest)
+    end
+  end
+
+  module ActiveRecord
+    include Define
+
+    # Filename hash usgin `id` attribute by default.
+    # And you can change this attribute, But it's should be record unique.
+    #
+    # @example:
+    # class Photo < ActiveRecord::Base
+    #   tori :image, id: :id
+    # end
+    def tori(name, id: :id)
+      super
+
+      name_hash_get = "#{name}_hash".to_sym
+
+      after_save do
+        uploader = __send__ name
+        filename = __send__ name_hash_get
+        Tori.config.backend.copy(uploader.path, filename) if uploader && filename
+      end
+
+      after_destroy do
+        filename = __send__ name_hash_get
+        Tori.config.backend.delete(filename) if filename
+      end
+    end
+  end
+end
+::ActiveRecord::Base.extend(Tori::ActiveRecord)

data/lib/tori/version.rb

@@ -0,0 +1,3 @@
+module Tori
+  VERSION = "0.0.1"
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require 'tori'

data/test/test_tori.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+
+class TestTori < Test::Unit::TestCase
+  test "config instance of" do
+    assert_instance_of Tori::Config, Tori.config
+  end
+
+  test "config default" do
+    assert_instance_of Tori::Backend::FileSystem, Tori.config.backend
+    assert { Digest::MD5.method(:hexdigest) == Tori.config.hash_method }
+  end
+end

data/test/test_tori_backend_filesystem.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+class TestToriBackendFileSystem < Test::Unit::TestCase
+  class Uploader
+    def path
+      "/tmp/tori/test"
+    end
+  end
+
+  test "#initialize" do
+    path = Pathname("tmp/tori/test")
+    i = Tori::Backend::FileSystem.new(path)
+
+    assert_instance_of Tori::Backend::FileSystem, i
+    assert_raise(ArgumentError){ Tori::Backend::FileSystem.new }
+  end
+end

data/test/test_tori_config.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+
+class TestToriConfig < Test::Unit::TestCase
+  test "#initialize" do
+    i = Tori::Config.new
+    assert_instance_of Tori::Config, i
+    assert_respond_to i, :backend
+    assert_respond_to i, :backend=
+    assert_respond_to i, :hash_method
+    assert_respond_to i, :hash_method=
+  end
+end

data/test/test_tori_method_definition.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+class TestToriDefine < Test::Unit::TestCase
+  class Dammy
+    extend Tori::Define
+    tori :test_image
+    def id
+      "dammy"
+    end
+  end
+
+  test "#tori" do
+    assert_respond_to Dammy.new, :test_image
+    assert_respond_to Dammy.new, :test_image=
+    assert_respond_to Dammy.new, :test_image_hash
+  end
+end

data/tori.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "tori/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "tori"
+  spec.version       = Tori::VERSION
+  spec.authors       = ["ksss"]
+  spec.email         = ["co000ri@gmail.com"]
+  spec.summary       = %q{Simple file uploader}
+  spec.description   = %q{Simple file uploader}
+  spec.homepage      = "https://github.com/ksss/tori"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'test-unit'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: tori
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- ksss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple file uploader
+email:
+- co000ri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tori.rb
+- lib/tori/backend/filesystem.rb
+- lib/tori/config.rb
+- lib/tori/define.rb
+- lib/tori/rails.rb
+- lib/tori/version.rb
+- test/test_helper.rb
+- test/test_tori.rb
+- test/test_tori_backend_filesystem.rb
+- test/test_tori_config.rb
+- test/test_tori_method_definition.rb
+- tori.gemspec
+homepage: https://github.com/ksss/tori
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Simple file uploader
+test_files:
+- test/test_helper.rb
+- test/test_tori.rb
+- test/test_tori_backend_filesystem.rb
+- test/test_tori_config.rb
+- test/test_tori_method_definition.rb