paperclip_database_myplaceonline 3.1.1

data/features/step_definitions/web_steps.rb

@@ -0,0 +1,115 @@
+# 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 (not )?see "([^"]*)"$/ do |negate, text|
+  if negate
+    expect(page).not_to have_content(text)
+  else
+    expect(page).to have_content(text)
+  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,62 @@
+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 framework_major_version
+    framework_version.split(".").first.to_i
+  end
+
+  def new_application_command(app_name)
+    "rails new #{app_name} --skip-sprockets --skip-javascript --skip-bundle"
+  end
+
+  def generator_command
+    "rails generate"
+  end
+
+  def runner_command
+    "rails runner"
+  end
+end
+
+module PaperclipGemHelpers
+  def paperclip_version?(version_string)
+    paperclip_version =~ /^#{version_string}/
+  end
+
+  def paperclip_version
+    @paperclip_version = Gem::Specification.find_by_name('paperclip').version.to_s
+  end
+end
+
+World(RailsCommandHelpers)
+World(PaperclipGemHelpers)

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/rails42_paperclip4x.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 4.2.0"
+gem "paperclip", "~> 4.0"
+gem "capybara"
+gem "rspec"
+gem "sqlite3", "~> 1.3.0"
+
+gemspec path: "../"

data/gemfiles/rails42_paperclip5x.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 4.2.0"
+gem "paperclip", "~> 5.0"
+gem "capybara"
+gem "rspec"
+gem "sqlite3", "~> 1.3.0"
+
+gemspec path: "../"

data/gemfiles/rails42_paperclip6x.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 4.2.0"
+gem "paperclip", "~> 6.0"
+gem "capybara"
+gem "rspec"
+gem "sqlite3", "~> 1.3.0"
+
+gemspec path: "../"

data/gemfiles/rails50_paperclip4x.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 5.0.0"
+gem "paperclip", "~> 4.0"
+gem "capybara"
+gem "rspec"
+gem "sqlite3", "~> 1.3.0"
+
+gemspec path: "../"

data/gemfiles/rails50_paperclip5x.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 5.0.0"
+gem "paperclip", "~> 5.0"
+gem "capybara"
+gem "rspec"
+gem "sqlite3", "~> 1.3.0"
+
+gemspec path: "../"

data/gemfiles/rails50_paperclip6x.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 5.0.0"
+gem "paperclip", "~> 6.0"
+gem "capybara"
+gem "rspec"
+gem "sqlite3", "~> 1.3.0"
+gem "bootsnap", "~> 1.0", require: false
+
+gemspec path: "../"

data/gemfiles/rails51_paperclip6x.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 5.1.0"
+gem "paperclip", "~> 6.0"
+gem "capybara"
+gem "rspec"
+gem "sqlite3", "~> 1.3.0"
+gem "bootsnap", "~> 1.0", require: false
+
+gemspec path: "../"

data/gemfiles/rails52_paperclip6x.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 5.2.0"
+gem "paperclip", "~> 6.0"
+gem "capybara"
+gem "rspec"
+gem "sqlite3", "~> 1.3.0"
+gem "bootsnap", "~> 1.0", require: false
+
+gemspec path: "../"

data/lib/generators/paperclip_database/migration/USAGE

@@ -0,0 +1,8 @@
+Description:
+    The generator generates a database migration for the paperclip database storage
+
+Example:
+    rails generate paperclip_database_migration User attachment
+
+    This will create:
+        db/migrations/YYYYMMDDHHmmss_create_user_attachments.rb

data/lib/generators/paperclip_database/migration/migration_generator.rb

@@ -0,0 +1,44 @@
+require 'rails/generators/active_record'
+
+module PaperclipDatabase
+  module Generators
+    class MigrationGenerator < 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 "migration.rb.erb", "db/migrate/#{migration_file_name}", migration_version: migration_version
+      end
+
+      def migration_name
+        "create_#{name.underscore.tr('/', '_')}_#{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
+
+      def migration_version
+        if Rails.version.to_i >= 5
+          "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
+  def self.up
+<%
+  module_names = class_name.underscore.split('/')[0...-1]
+-%>
+<% attachment_names.each do |attachment| -%>
+    create_table :<%= (module_names +[attachment.pluralize]).join("_") %> do |t|
+      t.integer    :<%= class_name.underscore.tr('/', '_') %>_id
+      t.string     :style
+      t.binary     :file_contents
+    end
+<% end -%>
+  end
+
+  def self.down
+<% attachment_names.each do |attachment| -%>
+    drop_table :<%= (module_names +[attachment.pluralize]).join("_") %>
+<% end -%>
+  end
+end

data/lib/paperclip/storage/database.rb

@@ -0,0 +1,243 @@
+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 and whether or not deletion is done by cascading or not as follows:
+    #   has_attached_file :avatar, :storage => :database, :database_table => 'avatar_files', :cascade_deletion => true
+    #
+    # 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_attachment_class
+          setup_paperclip_file_model
+          setup_paperclip_files_association
+          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_association
+        @paperclip_files_association_name = @paperclip_file_model.name.demodulize.tableize
+        @database_table = @paperclip_file_model.table_name
+        #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_association_name.to_sym,
+                                :class_name => @paperclip_file_model.name,
+                                :foreign_key => instance.class.table_name.classify.underscore + '_id'
+                                )
+      end
+      private :setup_paperclip_files_association
+
+      def setup_paperclip_file_model
+        class_name = "#{instance.class.table_name.singularize}_#{name.to_s}_paperclip_file".classify
+        if @attachment_class.const_defined?(class_name, false)
+          @paperclip_file_model = @attachment_class.const_get(class_name, false)
+        else
+          @paperclip_file_model = @attachment_class.const_set(class_name, Class.new(::ActiveRecord::Base))
+          @paperclip_file_model.table_name = @options[:database_table] || name.to_s.pluralize
+          @paperclip_file_model.validates_uniqueness_of :style, :scope => instance.class.table_name.classify.underscore + '_id'
+          case ActiveModel::VERSION::MAJOR
+          when 3, 4
+            @paperclip_file_model.scope :file_for, lambda {|style| @paperclip_file_model.where('style = ?', style) }
+          when 5,6,7,8
+            @paperclip_file_model.scope :file_for, lambda {|style| where('style = ?', style) }
+          else
+            raise "ActiveModel version #{ActiveModel::VERSION::STRING} is not supported (yet)"
+          end
+        end
+      end
+      private :setup_paperclip_file_model
+
+      def setup_attachment_class
+        instance.class.ancestors.each do |ancestor|
+          # Pick the top-most definition like
+          # Paperclip::AttachmentRegistry#definitions_for
+          names_for_ancestor = ancestor.attachment_definitions.keys rescue []
+          if names_for_ancestor.member?(name)
+            @attachment_class = ancestor
+          end
+        end
+      end
+      private :setup_attachment_class
+
+      def copy_to_local_file(style, dest_path)
+        File.open(dest_path, 'wb+'){|df| to_file(style).tap{|sf| File.copy_stream(sf, df); sf.close;sf.unlink} }
+      end
+
+      def override_default_options(base)
+        if @options[:url] == base.class.default_options[:url]
+          @options[:url] = ":relative_root/:class/:attachment/:id?style=:style"
+        end
+        @options[: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
+          instance.send("#{@paperclip_files_association_name}").where(:style => style).exists?
+        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.binmode
+          tempfile.write file_contents(style)
+          tempfile.flush
+          tempfile.rewind
+          tempfile
+        else
+          nil
+        end
+
+      end
+      alias_method :to_io, :to_file
+
+      def files
+        instance.send("#{@paperclip_files_association_name}")
+      end
+
+      def file_for(style)
+        db_result = instance.send("#{@paperclip_files_association_name}").send(:file_for, style.to_s)
+        raise RuntimeError, "More than one result for #{style}" if db_result.size > 1
+        db_result.first
+      end
+
+      def file_contents(style = default_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|
+            case ActiveModel::VERSION::MAJOR
+            when 3
+              paperclip_file = instance.send(@paperclip_files_association_name).send(:find_or_create_by_style, style.to_s)
+            when 4,5,6,7,8
+              paperclip_file = instance.send(@paperclip_files_association_name).send(:find_or_create_by, style: style.to_s)
+            else
+              raise "ActiveModel version #{ActiveModel::VERSION::STRING} is not supported (yet)"
+            end
+          paperclip_file.file_contents = file.read
+          paperclip_file.save!
+          instance.reload
+        end
+        @queued_for_write = {}
+      end
+
+      def flush_deletes #:nodoc:
+        ActiveRecord::Base.logger.info("[paperclip] Deleting files for #{name}")
+        @queued_for_delete.uniq! ##This is apparently necessary for paperclip v 3.x
+        @queued_for_delete.each do |path|
+          /id=([0-9]+)/.match(path)
+          if @options[:cascade_deletion] && !instance.class.exists?(instance.id)
+            raise RuntimeError, "Deletion has not been done by through cascading." if @paperclip_file_model.exists?($1)
+          else
+            @paperclip_file_model.destroy $1
+          end
+        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
+            #FIXME: Handling Namespaces
+            model_record = Object.const_get(model.to_s.camelize.to_sym, false).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

data/lib/paperclip_database/version.rb

@@ -0,0 +1,3 @@
+module PaperclipDatabase
+  VERSION = "3.1.1" unless defined? PaperclipDatabase::VERSION
+end

data/lib/paperclip_database.rb

@@ -0,0 +1,3 @@
+require 'paperclip'
+require 'paperclip/storage/database'
+require 'paperclip_database/version'