paperclip_database 0.0.1

data/features/step_definitions/web_steps.rb

@@ -0,0 +1,209 @@
+# TL;DR: YOU SHOULD DELETE THIS FILE
+#
+# This file was generated by Cucumber-Rails and is only here to get you a head start
+# These step definitions are thin wrappers around the Capybara/Webrat API that lets you
+# visit pages, interact with widgets and make assertions about page content.
+#
+# If you use these step definitions as basis for your features you will quickly end up
+# with features that are:
+#
+# * Hard to maintain
+# * Verbose to read
+#
+# A much better approach is to write your own higher level step definitions, following
+# the advice in the following blog posts:
+#
+# * http://benmabey.com/2008/05/19/imperative-vs-declarative-scenarios-in-user-stories.html
+# * http://dannorth.net/2011/01/31/whose-domain-is-it-anyway/
+# * http://elabs.se/blog/15-you-re-cuking-it-wrong
+#
+
+
+require 'uri'
+require 'cgi'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "paths"))
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "selectors"))
+
+module WithinHelpers
+  def with_scope(locator)
+    locator ? within(*selector_for(locator)) { yield } : yield
+  end
+end
+World(WithinHelpers)
+
+# Single-line step scoper
+When /^(.*) within (.*[^:])$/ do |step, parent|
+  with_scope(parent) { When step }
+end
+
+# Multi-line step scoper
+When /^(.*) within (.*[^:]):$/ do |step, parent, table_or_string|
+  with_scope(parent) { When "#{step}:", table_or_string }
+end
+
+Given /^(?:|I )am on (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^(?:|I )go to (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^(?:|I )press "([^"]*)"$/ do |button|
+  click_button(button)
+end
+
+When /^(?:|I )follow "([^"]*)"$/ do |link|
+  click_link(link)
+end
+
+When /^(?:|I )fill in "([^"]*)" with "([^"]*)"$/ do |field, value|
+  fill_in(field, :with => value)
+end
+
+When /^(?:|I )fill in "([^"]*)" for "([^"]*)"$/ do |value, field|
+  fill_in(field, :with => value)
+end
+
+# Use this to fill in an entire form with data from a table. Example:
+#
+#   When I fill in the following:
+#     | Account Number | 5002       |
+#     | Expiry date    | 2009-11-01 |
+#     | Note           | Nice guy   |
+#     | Wants Email?   |            |
+#
+# TODO: Add support for checkbox, select og option
+# based on naming conventions.
+#
+When /^(?:|I )fill in the following:$/ do |fields|
+  fields.rows_hash.each do |name, value|
+    When %{I fill in "#{name}" with "#{value}"}
+  end
+end
+
+When /^(?:|I )select "([^"]*)" from "([^"]*)"$/ do |value, field|
+  select(value, :from => field)
+end
+
+When /^(?:|I )check "([^"]*)"$/ do |field|
+  check(field)
+end
+
+When /^(?:|I )uncheck "([^"]*)"$/ do |field|
+  uncheck(field)
+end
+
+When /^(?:|I )choose "([^"]*)"$/ do |field|
+  choose(field)
+end
+
+When /^(?:|I )attach the file "([^"]*)" to "([^"]*)"$/ do |path, field|
+  attach_file(field, File.expand_path(path))
+end
+
+Then /^(?:|I )should see "([^"]*)"$/ do |text|
+  if page.respond_to? :should
+    page.should have_content(text)
+  else
+    assert page.has_content?(text)
+  end
+end
+
+Then /^(?:|I )should see \/([^\/]*)\/$/ do |regexp|
+  regexp = Regexp.new(regexp)
+
+  if page.respond_to? :should
+    page.should have_xpath('//*', :text => regexp)
+  else
+    assert page.has_xpath?('//*', :text => regexp)
+  end
+end
+
+Then /^(?:|I )should not see "([^"]*)"$/ do |text|
+  if page.respond_to? :should
+    page.should have_no_content(text)
+  else
+    assert page.has_no_content?(text)
+  end
+end
+
+Then /^(?:|I )should not see \/([^\/]*)\/$/ do |regexp|
+  regexp = Regexp.new(regexp)
+
+  if page.respond_to? :should
+    page.should have_no_xpath('//*', :text => regexp)
+  else
+    assert page.has_no_xpath?('//*', :text => regexp)
+  end
+end
+
+Then /^the "([^"]*)" field(?: within (.*))? should contain "([^"]*)"$/ do |field, parent, value|
+  with_scope(parent) do
+    field = find_field(field)
+    if field.value.respond_to? :should
+      field.value.should =~ /#{value}/
+    else
+      assert_match(/#{value}/, field.value)
+    end
+  end
+end
+
+Then /^the "([^"]*)" field(?: within (.*))? should not contain "([^"]*)"$/ do |field, parent, value|
+  with_scope(parent) do
+    field = find_field(field)
+    if field.value.respond_to? :should_not
+      field.value.should_not =~ /#{value}/
+    else
+      assert_no_match(/#{value}/, field.value)
+    end
+  end
+end
+
+Then /^the "([^"]*)" checkbox(?: within (.*))? should be checked$/ do |label, parent|
+  with_scope(parent) do
+    field_checked = find_field(label)['checked']
+    if field_checked.respond_to? :should
+      field_checked.should be_true
+    else
+      assert field_checked
+    end
+  end
+end
+
+Then /^the "([^"]*)" checkbox(?: within (.*))? should not be checked$/ do |label, parent|
+  with_scope(parent) do
+    field_checked = find_field(label)['checked']
+    if field_checked.respond_to? :should
+      field_checked.should be_false
+    else
+      assert !field_checked
+    end
+  end
+end
+ 
+Then /^(?:|I )should be on (.+)$/ do |page_name|
+  current_path = URI.parse(current_url).path
+  if current_path.respond_to? :should
+    current_path.should == path_to(page_name)
+  else
+    assert_equal path_to(page_name), current_path
+  end
+end
+
+Then /^(?:|I )should have the following query string:$/ do |expected_pairs|
+  query = URI.parse(current_url).query
+  actual_params = query ? CGI.parse(query) : {}
+  expected_params = {}
+  expected_pairs.rows_hash.each_pair{|k,v| expected_params[k] = v.split(',')} 
+  
+  if actual_params.respond_to? :should
+    actual_params.should == expected_params
+  else
+    assert_equal expected_params, actual_params
+  end
+end
+
+Then /^show me the page$/ do
+  save_and_open_page
+end

data/features/support/env.rb

@@ -0,0 +1,15 @@
+#require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'aruba/cucumber'
+require 'capybara/cucumber'
+
+Before do
+  @aruba_timeout_seconds = 120
+end

data/features/support/fakeweb.rb

@@ -0,0 +1,3 @@
+require 'fake_web'
+
+FakeWeb.allow_net_connect = false

data/features/support/paths.rb

@@ -0,0 +1,28 @@
+module NavigationHelpers
+  # Maps a name to a path. Used by the
+  #
+  #   When /^I go to (.+)$/ do |page_name|
+  #
+  # step definition in web_steps.rb
+  #
+  def path_to(page_name)
+    case page_name
+
+    when /the home\s?page/
+      '/'
+    when /the new user page/
+      '/users/new'
+    else
+      begin
+        page_name =~ /the (.*) page/
+        path_components = $1.split(/\s+/)
+        self.send(path_components.push('path').join('_').to_sym)
+      rescue Object => e
+        raise "Can't find mapping from \"#{page_name}\" to a path.\n" +
+          "Now, go and add a mapping in #{__FILE__}"
+      end
+    end
+  end
+end
+
+World(NavigationHelpers)

data/features/support/rails.rb

@@ -0,0 +1,46 @@
+PROJECT_ROOT     = File.expand_path(File.join(File.dirname(__FILE__), '..', '..')).freeze
+APP_NAME         = 'testapp'.freeze
+BUNDLE_ENV_VARS = %w(RUBYOPT BUNDLE_PATH BUNDLE_BIN_PATH BUNDLE_GEMFILE)
+ORIGINAL_BUNDLE_VARS = Hash[ENV.select{ |key,value| BUNDLE_ENV_VARS.include?(key) }]
+
+ENV['RAILS_ENV'] = 'test'
+
+Before do
+  ENV['BUNDLE_GEMFILE'] = File.join(Dir.pwd, ENV['BUNDLE_GEMFILE']) unless ENV['BUNDLE_GEMFILE'].start_with?(Dir.pwd)
+  @framework_version = nil
+end
+
+After do
+  ORIGINAL_BUNDLE_VARS.each_pair do |key, value|
+    ENV[key] = value
+  end
+end
+
+When /^I reset Bundler environment variable$/ do
+  BUNDLE_ENV_VARS.each do |key|
+    ENV[key] = nil
+  end
+end
+
+module RailsCommandHelpers
+  def framework_version?(version_string)
+    framework_version =~ /^#{version_string}/
+  end
+
+  def framework_version
+    @framework_version ||= `rails -v`[/^Rails (.+)$/, 1]
+  end
+
+  def new_application_command
+    framework_version?("3") ? "rails new" : "rails"
+  end
+
+  def generator_command
+    framework_version?("3") ? "script/rails generate" : "script/generate"
+  end
+
+  def runner_command
+    framework_version?("3") ? "script/rails runner" : "script/runner"
+  end
+end
+World(RailsCommandHelpers)

data/features/support/selectors.rb

@@ -0,0 +1,19 @@
+module HtmlSelectorsHelpers
+  # Maps a name to a selector. Used primarily by the
+  #
+  #   When /^(.+) within (.+)$/ do |step, scope|
+  #
+  # step definitions in web_steps.rb
+  #
+  def selector_for(locator)
+    case locator
+    when "the page"
+      "html > body"
+    else
+      raise "Can't find mapping from \"#{locator}\" to a selector.\n" +
+        "Now, go and add a mapping in #{__FILE__}"
+    end
+  end
+end
+
+World(HtmlSelectorsHelpers)

data/gemfiles/rails2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 2.3.14"
+gem "paperclip_database", :path=>"../"
+
+gemspec :path=>"../"

data/gemfiles/rails3.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 3.0.10"
+gem "paperclip_database", :path=>"../"
+
+gemspec :path=>"../"

data/gemfiles/rails3_1.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 3.1.0"
+gem "paperclip_database", :path=>"../"
+
+gemspec :path=>"../"

data/generators/paperclip_database/USAGE

@@ -0,0 +1,5 @@
+Usage:
+
+  script/generate paperclip_database model attachment
+
+This will create a migration that will add the proper table for the attachments.

data/generators/paperclip_database/paperclip_database_generator.rb

@@ -0,0 +1,28 @@
+class PaperclipDatabaseGenerator < Rails::Generator::NamedBase
+  attr_accessor :attachments, :migration_name
+
+  def initialize(args, options = {})
+    super
+    @class_name, @attachments = args[0], args[1..-1]
+  end
+
+  def manifest
+    file_name = generate_file_name
+    @migration_name = file_name.camelize
+    record do |m|
+      m.migration_template "paperclip_database_migration.rb.erb",
+                           File.join('db', 'migrate'),
+                           :migration_file_name => file_name
+    end
+  end
+
+  private
+
+  def generate_file_name
+    debugger
+    names = attachments.map{|a| "#{class_name.underscore}_#{a.pluralize}" }
+    names = names[0..-2] + ["and", names[-1]] if names.length > 1
+    "create_#{names.join('_')}"
+  end
+
+end

data/generators/paperclip_database/templates/paperclip_database_migration.rb.erb

@@ -0,0 +1,17 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+<% attachments.each do |attachment| -%>
+    create_table :<%= class_name.underscore %>_<%= attachment.pluralize %> do |t|
+      t.integer    :<%= class_name.underscore %>_id
+      t.string     :style
+      t.binary     :file_contents
+    end
+<% end -%>
+  end
+
+  def self.down
+<% attachments.each do |attachment| -%>
+    drop_table :<%= class_name.underscore %>_<%= attachment.pluralize %>
+<% end -%>
+  end
+end

data/generators/templates/paperclip_database_migration.rb.erb

@@ -0,0 +1,17 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+<% attachments.each do |attachment| -%>
+    create_table :<%= name.underscore.camelize.tableize %>_<%= attachment.pluralize %> do |t|
+      t.integer    :<%= name.underscore.camelize.tableize %>_id
+      t.string     :style
+      t.binary     :file_contents
+    end
+  end
+<% end -%>
+
+  def self.down
+<% attachments.each do |attachment| -%>
+    drop_table :<%= name.underscore.camelize.tableize %>_<%= attachment.pluralize %>
+<% end -%>
+  end
+end

data/lib/generators/paperclip_database/USAGE

@@ -0,0 +1,8 @@
+Description:
+    The generator generates a database migration for the paperclip database storage
+
+Example:
+    rails generate paperclip_database Class attachments
+
+    This will create:
+        what/will/it/create

data/lib/generators/paperclip_database/paperclip_database_generator.rb

@@ -0,0 +1,33 @@
+require 'rails/generators/active_record'
+
+class PaperclipDatabaseGenerator < ActiveRecord::Generators::Base
+  desc "Create a migration to add database storage for the paperclip database storage." +
+       "The NAME argument is the name of your model, and the following " +
+       "arguments are the name of the attachments"
+
+  argument :attachment_names, :required => true, :type => :array, :desc => "The names of the attachment(s) to add.",
+           :banner => "attachment_one attachment_two attachment_three ..."
+
+  def self.source_root
+    @source_root ||= File.expand_path('../templates', __FILE__)
+  end
+
+  def generate_migration
+    migration_template "paperclip_database_migration.rb.erb", "db/migrate/#{migration_file_name}"
+  end
+
+  protected
+
+  def migration_name
+    "create_#{name.underscore}_#{attachment_names.map{|n| n.pluralize}.join('_and_')}"
+  end
+
+  def migration_file_name
+    "#{migration_name}.rb"
+  end
+
+  def migration_class_name
+    migration_name.camelize
+  end
+
+end

data/lib/generators/paperclip_database/templates/paperclip_database_migration.rb.erb

@@ -0,0 +1,17 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+<% attachment_names.each do |attachment| -%>
+    create_table :<%= class_name.underscore %>_<%= attachment.pluralize %> do |t|
+      t.integer    :<%= class_name.underscore %>_id
+      t.string     :style
+      t.binary     :file_contents
+    end
+<% end -%>
+  end
+
+  def self.down
+<% attachment_names.each do |attachment| -%>
+    drop_table :<%= class_name.underscore %>_<%= attachment.pluralize %>
+<% end -%>
+  end
+end

data/lib/paperclip/storage/database.rb

@@ -0,0 +1,198 @@
+module Paperclip
+  module Storage
+    # Store files in a database.
+    # 
+    # Usage is identical to the file system storage version, except:
+    # 
+    # 1. In your model specify the "database" storage option; for example:
+    #   has_attached_file :avatar, :storage => :database
+    # 
+    # The files will be stored in a new database table named with the plural attachment name
+    # by default, "avatars" in this example.
+    # 
+    # 2. You need to create this new storage table with at least these columns:
+    #   - file_contents
+    #   - style
+    #   - the primary key for the parent model (e.g. user_id)
+    # 
+    # Note the "binary" migration will not work for the LONGBLOG type in MySQL for the
+    # file_cotents column. You may need to craft a SQL statement for your migration,
+    # depending on which database server you are using. Here's an example migration for MySQL:
+    # 
+    # create_table :avatars do |t|
+    #   t.string :style
+    #   t.integer :user_id
+    #   t.timestamps
+    # end
+    # execute 'ALTER TABLE avatars ADD COLUMN file_contents LONGBLOB'
+    # 
+    # You can optionally specify any storage table name you want as follows:
+    #   has_attached_file :avatar, :storage => :database, :database_table => 'avatar_files'
+    # 
+    # 3. By default, URLs will be set to this pattern:
+    #   /:relative_root/:class/:attachment/:id?style=:style
+    # 
+    # Example:
+    #   /app-root-url/users/avatars/23?style=original
+    # 
+    # The idea here is that to retrieve a file from the database storage, you will need some
+    # controller's code to be executed.
+    #     
+    # Once you pick a controller to use for downloading, you can add this line
+    # to generate the download action for the default URL/action (the plural attachment name),
+    # "avatars" in this example:
+    #   downloads_files_for :user, :avatar
+    # 
+    # Or you can write a download method manually if there are security, logging or other
+    # requirements.
+    # 
+    # If you prefer a different URL for downloading files you can specify that in the model; e.g.:
+    #   has_attached_file :avatar, :storage => :database, :url => '/users/show_avatar/:id/:style'
+    # 
+    # 4. Add a route for the download to the controller which will handle downloads, if necessary.
+    # 
+    # The default URL, /:relative_root/:class/:attachment/:id?style=:style, will be matched by
+    # the default route: :controller/:action/:id
+    # 
+    module Database
+ 
+      def self.extended(base)
+        base.instance_eval do
+          setup_paperclip_files_model
+          override_default_options base
+        end
+        Paperclip.interpolates(:database_path) do |attachment, style|
+          attachment.database_path(style)
+        end
+        Paperclip.interpolates(:relative_root) do |attachment, style|
+          begin
+            if ActionController::AbstractRequest.respond_to?(:relative_url_root)
+              relative_url_root = ActionController::AbstractRequest.relative_url_root
+            end
+          rescue NameError
+          end
+          if !relative_url_root && ActionController::Base.respond_to?(:relative_url_root)
+            ActionController::Base.relative_url_root
+          end
+        end
+        
+        ActiveRecord::Base.logger.info("[paperclip] Database Storage Initalized.")
+      end
+ 
+      def setup_paperclip_files_model
+        #TODO: This fails when your model is in a namespace.
+        @paperclip_files = "#{instance.class.name.underscore}_#{name.to_s}_paperclip_files"
+        if !Object.const_defined?(@paperclip_files.classify)
+          @paperclip_file = Object.const_set(@paperclip_files.classify, Class.new(::ActiveRecord::Base))
+        else
+          @paperclip_file = Object.const_get(@paperclip_files.classify)
+        end
+        @database_table = @options[:database_table] || name.to_s.pluralize
+        @paperclip_file.set_table_name @database_table
+        case Rails::VERSION::STRING
+        when /^2/
+          @paperclip_file.named_scope :file_for, lambda {|style| { :conditions => ['style = ?', style] }}
+        else # 3.x
+          @paperclip_file.scope :file_for, lambda {|style| { :conditions => ['style = ?', style] }}
+        end
+        #FIXME: This fails when using  set_table_name "<myname>" in your model
+        #FIXME: This should be fixed in ActiveRecord...
+        instance.class.has_many @paperclip_files, :foreign_key => instance.class.table_name.classify.underscore + '_id'
+
+      end
+      private :setup_paperclip_files_model
+        
+      def override_default_options(base)
+        if @url == base.class.default_options[:url]
+          @url = ":relative_root/:class/:attachment/:id?style=:style"
+        end
+        @path = ":database_path"
+      end
+      private :override_default_options
+        
+      def database_table
+        @database_table
+      end
+      
+      def database_path(style)
+        paperclip_file = file_for(style)
+        if paperclip_file
+          "#{database_table}(id=#{paperclip_file.id},style=#{style.to_s})"
+        else
+          "#{database_table}(id=new,style=#{style.to_s})"
+        end
+      end
+      
+      def exists?(style = default_style)
+        if original_filename
+          !file_for(style).nil?
+        else
+          false
+        end
+      end
+          
+      # Returns representation of the data of the file assigned to the given
+      # style, in the format most representative of the current storage.
+      def to_file style = default_style
+        if @queued_for_write[style]
+          @queued_for_write[style]
+        elsif exists?(style)
+          tempfile = Tempfile.new instance_read(:file_name)
+          tempfile.write file_contents(style)
+          tempfile.flush
+          tempfile.rewind
+          tempfile
+        else
+          nil
+        end
+ 
+      end
+      alias_method :to_io, :to_file
+ 
+      def file_for(style)
+        db_result = instance.send("#{@paperclip_files}").send(:file_for, style.to_s).to_ary
+        raise RuntimeError, "More than one result for #{style}" if db_result.size > 1
+        db_result.first
+      end
+        
+      def file_contents(style)
+        file_for(style).file_contents
+      end
+ 
+      def flush_writes
+        ActiveRecord::Base.logger.info("[paperclip] Writing files for #{name}")
+        @queued_for_write.each do |style, file|
+          paperclip_file = @paperclip_file.new
+          paperclip_file.file_contents = file.read
+          paperclip_file.style = style.to_s;
+          instance.send(@paperclip_files) << paperclip_file
+        end        
+        @queued_for_write = {}
+      end
+ 
+      def flush_deletes #:nodoc:
+        ActiveRecord::Base.logger.info("[paperclip] Deleting files for #{name}")
+        @queued_for_delete.each do |path|
+          /id=([0-9]+)/.match(path)
+          @paperclip_file.destroy $1
+        end
+        @queued_for_delete = []
+      end
+ 
+      module ControllerClassMethods
+        def self.included(base)
+          base.extend(self)
+        end
+        def downloads_files_for(model, attachment, options = {})
+          define_method("#{attachment.to_s.pluralize}") do
+            model_record = Object.const_get(model.to_s.camelize.to_sym).find(params[:id])
+            style = params[:style] ? params[:style] : 'original'
+            send_data model_record.send(attachment).file_contents(style),
+                      :filename => model_record.send("#{attachment}_file_name".to_sym),
+                      :type => model_record.send("#{attachment}_content_type".to_sym)
+          end
+        end
+      end
+    end
+  end
+end