attachable 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in attachable.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+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

@@ -0,0 +1,39 @@
+Attachable
+==========
+
+A really simple file attachment plugin for Rails 3.  Designed to work with any generic files, i.e not specific to images.
+It will not do any magical processing for you, it just stores the data in the database.  Write your own magic.
+
+
+Usage
+=======
+
+Add the following fields to your table:
+
+add_column :medias, :file_name, :string
+add_column :medias, :file_type, :string
+add_column :medias, :file_size, :integer
+add_column :medias, :file_data, :binary, :limit => 2.megabytes
+
+In your model:
+class Media < ActiveRecord::Base  
+  attachable
+end
+
+In a controller that should be able to view the result:
+class MediasController < ApplicationController
+  def show
+    @media = Media(params[:id])
+    send_data @media.file_contents, :filename => @media.file_name, :type => @media.file_type, :disposition => 'inline'
+  end
+end
+
+To upload, just set the form field to :file AND remember the multipart => true bit like shown:
+<% form_for(@media, :html => { :multipart => true }) do |f| %>
+  <%= f.file_field :file %>
+  ....more stuff....
+
+
+In theory you can change the prefix from "file" to anything by setting the file_prefix option in the model, but I haven't tested it.
+
+Copyright (c) 2010 Brian Michalski, released under the MIT license

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/attachable.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "attachable/version"
+
+Gem::Specification.new do |s|
+  s.name        = "attachable"
+  s.version     = Attachable::VERSION
+  s.authors     = ["Brian Michalski"]
+  s.email       = ["bmichalski@gmail.com"]
+  s.homepage    = "https://github.com/bamnet/attachable"
+  s.summary     = %q{A simple set of extensions to support files in a model}
+  s.description = %q{Add methods to automatically manage a file as part of a Rails model}
+
+  s.rubyforge_project = "attachable"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/init.rb

@@ -0,0 +1,3 @@
+ActiveRecord::Base.class_eval do
+  extend Attachable::ClassMethods
+end

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/attachable.rb

@@ -0,0 +1,65 @@
+# Attachable
+require 'attachable/version'
+require 'active_record'
+require 'action_controller'
+
+# Attachable provides simple file upload handlers for Rails 3 models.
+module Attachable
+
+  module ClassMethods
+
+    # Loads the attachable methods, scope, and config into the model.
+    def attachable(options = {})
+      # Store the default prefix for file data
+      # Defaults to "file"
+      cattr_accessor :attachment_file_prefix
+      self.attachment_file_prefix = (options[:file_prefix] || :file).to_s
+      
+      # Setup the default scope so the file data isn't included by default
+      send :default_scope, attachable_scope
+      
+      # Include all the important stuff
+      send :include, InstanceMethods
+    end
+    
+    # Generate the default scope, which includes every column except for the data column.
+    # We use this so queries, by default, don't include the file data which could be quite large.
+    def attachable_scope
+      select(column_names.reject { |n| n == "#{attachment_file_prefix}_data" }.collect {|n| "#{table_name}.#{n}" }.join(','))
+    end
+  end
+  
+  module InstanceMethods
+  
+    # Read the file data back from where ever it is stored.  Uses a cached copy if it exists.
+    # If the cached attribute doens't exist, it reloads the model to get it 
+    def file_contents
+      #Try to hit the cache, reload if it fails
+      if !attribute_present?("#{attachment_file_prefix}_data")
+        reload :select => "#{attachment_file_prefix}_data"
+      end
+      send("#{attachment_file_prefix}_data")
+    end
+  
+    # Take in a UploadFile and copy it's properties to four fields,
+    # data, size, original filename.  An UploadFile wraps a Tempfile,
+    # but includes some extra data (like the original filename and 
+    # content type).  We can't garuntee this file to be at the beginning,
+    # so we always rewind it.
+    def file=(tempfile)
+      tempfile.rewind #This may not be super efficient, but it's the necessary fix for Rails 3.1
+      self["#{attachment_file_prefix}_data"] = tempfile.read
+      self["#{attachment_file_prefix}_size"] = tempfile.size
+      self["#{attachment_file_prefix}_name"] = tempfile.original_filename
+      self["#{attachment_file_prefix}_type"] = tempfile.content_type
+    end
+  end
+  
+end
+
+# Rails 3 compatability?
+if defined? Rails
+  ActiveRecord::Base.class_eval do
+    extend Attachable::ClassMethods
+  end
+end

data/lib/attachable/version.rb

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

data/test/attachable_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class AttachableTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: attachable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brian Michalski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-22 00:00:00.000000000 -08:00
+default_executable: 
+dependencies: []
+description: Add methods to automatically manage a file as part of a Rails model
+email:
+- bmichalski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README
+- Rakefile
+- attachable.gemspec
+- init.rb
+- install.rb
+- lib/attachable.rb
+- lib/attachable/version.rb
+- test/attachable_test.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: https://github.com/bamnet/attachable
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: attachable
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A simple set of extensions to support files in a model
+test_files:
+- test/attachable_test.rb
+- test/test_helper.rb