file_blobs_rails 0.1.0

data/test/fixtures/003_create_gem_test_blobs.rb

@@ -0,0 +1,8 @@
+class CreateGemTestBlobs < ActiveRecord::Migration[5.0]
+  def change
+    create_file_blobs_table :gem_test_blobs, blob_limit: 64.kilobytes do |t|
+      # Test that the block is invoked with the correct argument.
+      t.timestamps
+    end
+  end
+end

data/test/fixtures/004_create_gem_test_messages.rb

@@ -0,0 +1,15 @@
+class CreateGemTestMessages < ActiveRecord::Migration[5.0]
+  def change
+    create_file_blobs_table :gem_test_messages, blob_limit: 64.kilobytes do |t|
+      # Test the options.
+      t.file_blob :attachment, null: true, mime_type_limit: 16,
+          original_name_limit: 64
+
+      t.file_blob :signature, null: true
+
+      # Test that the block is invoked with the correct argument.
+      t.string :subject, null: false, limit: 64
+      t.timestamps
+    end
+  end
+end

data/test/fixtures/files/invoice.pdf

@@ -0,0 +1,137 @@
+%PDF-1.4
+%����
+5 0 obj
+<<
+/Type /Font
+/Subtype /TrueType
+/BaseFont /Arial
+/Encoding /WinAnsiEncoding
+>>
+endobj
+7 0 obj
+<<
+/Type /FontDescriptor
+/FontName /BookAntiqua,Bold
+/Flags 16418
+/FontBBox [-250 -260 1236 930]
+/MissingWidth 750
+/StemV 146
+/StemH 146
+/ItalicAngle 0
+/CapHeight 930
+/XHeight 651
+/Ascent 930
+/Descent 260
+/Leading 210
+/MaxWidth 1030
+/AvgWidth 460
+>>
+endobj
+6 0 obj
+<<
+/Type /Font
+/Subtype /TrueType
+/BaseFont /BookAntiqua,Bold
+/FirstChar 31
+/LastChar 255
+/Widths [750 250 278 402 606 500 889 833 227 333 333 444 606 250 333 250 296 500 500 500 500 500 500 500 500 500 500 250 250 606 606 606 444 747 778 667 722 833 611 556 833 833 389 389 778 611 1000 833 833 611 833 722 611 667 778 778 1000 667 667 667 333 606 333 606 500 333 500 611 444 611 500 389 556 611 333 333 611 333 889 611 556 611 611 389 444 333 611 556 833 500 556 500 310 606 310 606 750 500 750 333 500 500 1000 500 500 333 1000 611 389 1000 750 750 750 750 278 278 500 500 606 500 1000 333 998 444 389 833 750 750 667 250 278 500 500 606 500 606 500 333 747 438 500 606 333 747 500 400 549 361 361 333 576 641 250 333 361 488 500 889 890 889 444 778 778 778 778 778 778 1000 722 611 611 611 611 389 389 389 389 833 833 833 833 833 833 833 606 833 778 778 778 778 667 611 611 500 500 500 500 500 500 778 444 500 500 500 500 333 333 333 333 556 611 556 556 556 556 556 549 556 611 611 611 611 556 611 556]
+/Encoding /WinAnsiEncoding
+/FontDescriptor 7 0 R
+>>
+endobj
+8 0 obj
+[/PDF /Text]
+endobj
+10 0 obj
+246
+endobj
+9 0 obj
+<<
+/Length 246
+/Filter /FlateDecode
+>>
+stream
+H�͐�J�0�� ��{��f�$M��n�-���[&je���ۤ�~�$���}�Ʌ�Ij���s����~�X�-],��$Y���)�'N�u�1!���V�?��?
+�b1Rbb�҉�H�[��TD:#�&ح��X���i�$qnf�����]������a��{��أ���q|J�Ls]�Q�I��j�%��9��`�঺��U�ite�z�$����OeB�Ēү�R��@zܗ���g���<���
+endstream
+endobj
+4 0 obj
+<<
+/Type /Page
+/MediaBox [0 0 612 792]
+/Resources <<
+/Font <<
+/F0 5 0 R
+/F1 6 0 R
+>>
+/ProcSet 8 0 R
+>>
+/Contents 9 0 R
+/Parent 2 0 R
+>>
+endobj
+11 0 obj
+[/CalGray <<
+/WhitePoint [0.9505 1 1.0891]
+/Gamma 0.2468
+>>]
+endobj
+12 0 obj
+[/CalRGB <<
+/WhitePoint [0.9505 1 1.0891]
+/Gamma [0.2468 0.2468 0.2468]
+/Matrix [0.4361 0.2225 0.0139 0.3851 0.7169 0.0971 0.1431 0.0606 0.7141]
+>>]
+endobj
+2 0 obj
+<<
+/Type /Pages
+/Kids [4 0 R]
+/Count 1
+>>
+endobj
+1 0 obj
+<<
+/Type /Catalog
+/Pages 2 0 R
+/DefaultGray 11 0 R
+/DefaultRGB 12 0 R
+>>
+endobj
+3 0 obj
+<<
+/Creator (1725.fm)
+/CreationDate (1-Jan-3 18:15PM)
+/Title (1725.PDF)
+/Author (Unknown)
+/Keywords <>
+/Subject <>
+/ModDate (D:20131124155828Z)
+/Producer (3-Heights\(TM\) PDF Producer 4.2.26.0 \(http://www.pdf-tools.com\))
+>>
+endobj
+xref
+0 13
+0000000000 65535 f
+0000002266 00000 n
+0000002209 00000 n
+0000002354 00000 n
+0000001816 00000 n
+0000000015 00000 n
+0000000376 00000 n
+0000000111 00000 n
+0000001450 00000 n
+0000001498 00000 n
+0000001478 00000 n
+0000001967 00000 n
+0000002044 00000 n
+trailer
+<<
+/Size 13
+/Root 1 0 R
+/Info 3 0 R
+/ID [<F2B22CD0880D25E8E743A676B47199CD> <5B1A04D8F6660EB95B25A6F7A746258B>]
+>>
+startxref
+2595
+%%EOF

data/test/fixtures/gem_test_blob.rb

@@ -0,0 +1,5 @@
+class GemTestBlob < ActiveRecord::Base
+  include FileBlobs::BlobModel
+
+  blob_owner_class_names! 'GemTestMessage'
+end

data/test/fixtures/gem_test_message.rb

@@ -0,0 +1,5 @@
+class GemTestMessage < ActiveRecord::Base
+  has_file_blob :attachment, blob_model: 'GemTestBlob', allow_nil: true
+
+  has_file_blob :signature, blob_model: 'GemTestBlob', allow_nil: true
+end

data/test/garbage_collection_test.rb

@@ -0,0 +1,84 @@
+require_relative 'test_helper'
+
+class BlobModelTest < ActiveSupport::TestCase
+  test 'new blob with no reference gets garbage-collected' do
+    BlobOwner.destroy_all
+    FileBlob.destroy_all
+
+    blob = FileBlob.create! data: 'hello world',
+                            id: FileBlob.id_for('hello world')
+
+    assert_equal true,
+        BlobOwner.file_blob_eligible_for_garbage_collection?(blob)
+
+    assert_equal true, blob.eligible_for_garbage_collection?
+
+    assert_difference -> { FileBlob.count }, -1 do
+      assert_equal true, blob.maybe_garbage_collect
+    end
+    assert_equal nil, FileBlob.where(id: blob.id).first
+  end
+
+  test 'blob with a reference does not get garbage-collected' do
+    blob = file_blobs(:ruby_png)
+
+    assert_equal false,
+        BlobOwner.file_blob_eligible_for_garbage_collection?(blob)
+    assert_equal false, blob.eligible_for_garbage_collection?
+    assert_no_difference -> { FileBlob.count } do
+      assert_equal false, blob.maybe_garbage_collect
+    end
+  end
+
+  test 'blob with one owner gets collected when owner gets destroyed' do
+    owner = blob_owners(:ruby)
+    blob = file_blobs(:ruby_png)
+
+    assert_difference -> { FileBlob.count }, -1 do
+      owner.destroy
+    end
+
+    assert_equal nil, FileBlob.where(id: blob.id).first
+  end
+
+  test 'blob with two owners is not collected when an owner gets destroyed' do
+    owner = blob_owners(:ruby)
+    new_owner = BlobOwner.create! file: owner.file
+    assert_equal owner.file_blob, new_owner.file_blob, 'Incorrect test setup'
+
+    blob = file_blobs(:ruby_png)
+
+    assert_no_difference -> { FileBlob.count } do
+      owner.destroy
+    end
+
+    assert_equal blob, FileBlob.where(id: blob.id).first
+  end
+
+  test 'blob with a reference gets garbage-collected when reference changes' do
+    owner = blob_owners(:ruby)
+    dead_blob = file_blobs(:ruby_png)
+    live_blob = file_blobs(:invoice_pdf)
+
+    owner.file_blob = live_blob
+
+    # First check that the blob doesn't get garbage-collected until the owner
+    # gets saved.
+    assert_equal false,
+        BlobOwner.file_blob_eligible_for_garbage_collection?(dead_blob)
+    assert_equal false, dead_blob.eligible_for_garbage_collection?
+    assert_no_difference -> { FileBlob.count } do
+      assert_equal false, dead_blob.maybe_garbage_collect
+    end
+
+    # Now check that the blob gets garbage-collected when the reference change
+    # is committed.
+
+    assert_difference -> { FileBlob.count }, -1 do
+      owner.save!
+    end
+
+    assert_equal nil, FileBlob.where(id: dead_blob.id).first
+    assert_equal live_blob, FileBlob.where(id: live_blob.id).first
+  end
+end

data/test/helpers/action_controller.rb

@@ -0,0 +1,5 @@
+# Raise exceptions so we can test require / permit on params.
+ActionController::Parameters.action_on_unpermitted_parameters = :raise
+
+# By default, CSRF protection is turned off in tests.
+ActionController::Base.allow_forgery_protection = false

data/test/helpers/db_setup.rb

@@ -0,0 +1,22 @@
+ar_config = { adapter: 'sqlite3', database: ':memory:'}
+
+case ENV['DB']
+when /mysql/i
+  create_sql = 'CREATE DATABASE plugin_dev DEFAULT CHARACTER SET utf8;'
+  if /:(.*)$/ =~ ENV['DB']
+    create_sql.sub! ';', " DEFAULT COLLATE #{$1};"
+  end
+
+  `mysql -u root -e "DROP DATABASE IF EXISTS plugin_dev; #{create_sql}"`
+   ar_config = { adapter: 'mysql2', database: 'plugin_dev',
+                 username: 'root', password: '' }
+when /pg/i
+  pg_user = ENV['DB_USER'] || ENV['USER']
+  `psql -U #{pg_user} -d postgres -c "DROP DATABASE IF EXISTS plugin_dev;"`
+  `psql -U #{pg_user} -d postgres -c "CREATE DATABASE plugin_dev;"`
+  ar_config = { adapter: 'postgresql', database: 'plugin_dev',
+                username: pg_user, password: '' }
+end
+
+ActiveRecord::Base.configurations = { 'test' => ar_config }
+ActiveRecord::Base.establish_connection :test

data/test/helpers/fixtures.rb

@@ -0,0 +1,41 @@
+require 'fileutils'
+
+# Simulate generating the fixtures.
+
+FileUtils.mkdir_p File.expand_path('../../../tmp/files', __FILE__)
+
+template_path = File.expand_path(
+    '../../../lib/file_blobs_rails/generators/templates/file_blobs.yml.erb',
+    __FILE__)
+output = Erubis::Eruby.new(File.read(template_path)).result(
+    file_name: 'file_blob')
+File.write File.expand_path('../../../tmp/file_blobs.yml', __FILE__), output
+
+template_path = File.expand_path(
+    '../../../lib/file_blobs_rails/generators/templates/blob_owners.yml.erb',
+    __FILE__)
+output = Erubis::Eruby.new(File.read(template_path)).result(
+    file_name: 'blob_owner', options: { allow_nil: false, attr_name: 'file',
+    blob_model: 'FileBlob' })
+File.write File.expand_path('../../../tmp/blob_owners.yml', __FILE__), output
+
+FileUtils.cp File.expand_path(
+    '../../../lib/file_blobs_rails/generators/templates/files/invoice.pdf',
+    __FILE__), File.expand_path('../../../tmp/files', __FILE__)
+FileUtils.cp File.expand_path(
+    '../../../lib/file_blobs_rails/generators/templates/files/ruby.png',
+    __FILE__), File.expand_path('../../../tmp/files', __FILE__)
+
+
+# This needs to happen after the fixture files are created.
+
+class ActiveSupport::TestCase
+  include ActiveRecord::TestFixtures
+
+  self.fixture_path = File.expand_path('../../../tmp', __FILE__)
+
+  self.use_transactional_tests = true
+  self.use_instantiated_fixtures = false
+  self.pre_loaded_fixtures = false
+  fixtures :all
+end

data/test/helpers/i18n.rb

@@ -0,0 +1 @@
+I18n.config.enforce_available_locales = true

data/test/helpers/migrations.rb

@@ -0,0 +1,41 @@
+ActiveRecord::Migration.verbose = false
+
+# Simulate Rails' db:migrate.
+
+template = File.read File.expand_path(
+    '../../../lib/file_blobs_rails/generators/templates/001_create_file_blobs.rb.erb',
+    __FILE__)
+eval Erubis::Eruby.new(template).result(file_name: 'file_blob')
+CreateFileBlobs.migrate :up
+
+template = File.read File.expand_path(
+    '../../../lib/file_blobs_rails/generators/templates/002_create_blob_owners.rb.erb',
+    __FILE__)
+eval Erubis::Eruby.new(template).result(file_name: 'blob_owner',
+    options: { allow_nil: false, attr_name: 'file', blob_model: 'FileBlob' })
+CreateBlobOwners.migrate :up
+
+require_relative(
+    '../fixtures/003_create_gem_test_blobs.rb')
+CreateGemTestBlobs.migrate :up
+require_relative(
+    '../fixtures/004_create_gem_test_messages.rb')
+CreateGemTestMessages.migrate :up
+
+# Simulate Rails' autoloading.
+
+template_path = File.expand_path(
+    '../../../lib/file_blobs_rails/generators/templates/file_blob.rb.erb',
+    __FILE__)
+eval Erubis::Eruby.new(File.read(template_path)).result(
+    file_name: 'file_blob'), nil, template_path
+
+template_path = File.expand_path(
+    '../../../lib/file_blobs_rails/generators/templates/blob_owner.rb.erb',
+    __FILE__)
+eval Erubis::Eruby.new(File.read(template_path)).result(
+    file_name: 'blob_owner', options: { allow_nil: false, attr_name: 'file',
+    blob_model: 'FileBlob' }), nil, template_path
+
+require_relative '../fixtures/gem_test_blob.rb'
+require_relative '../fixtures/gem_test_message.rb'

data/test/helpers/rails.rb

@@ -0,0 +1,9 @@
+# Mock Rails.root.
+module Rails
+  class <<self
+    remove_method :root if Rails.respond_to? :root
+    def root
+      Pathname.new File.expand_path('../..', File.dirname(__FILE__))
+    end
+  end
+end

data/test/helpers/routes.rb

@@ -0,0 +1,18 @@
+def setup_file_blobs_routes
+  # The routes used in all the tests.
+  routes = ActionDispatch::Routing::RouteSet.new
+  routes.draw do
+    get '/file_blob_gem_test/:id' => 'file_blob_gem_test#show'
+    post '/file_blob_gem_test' => 'file_blob_gem_test#create'
+  end
+
+  # NOTE: ActionController tests expect @routes to be set to the drawn routes.
+  #       We use the block form of define_method to capture the routes local
+  #       variable.
+  ActionController::TestCase.send :define_method, :setup_file_blobs_routes do
+    @routes = routes
+  end
+  ActionController::TestCase.setup :setup_file_blobs_routes
+end
+
+setup_file_blobs_routes

data/test/helpers/test_order.rb

@@ -0,0 +1 @@
+ActiveSupport.test_order = :sorted

data/test/test_extensions_test.rb

@@ -0,0 +1,21 @@
+require_relative 'test_helper'
+
+class TestExtensionsTest < ActiveSupport::TestCase
+  setup do
+    @ruby_path = File.expand_path '../fixtures/files/ruby.png', __FILE__
+    @invoice_path = File.expand_path '../fixtures/files/invoice.pdf', __FILE__
+  end
+
+  test 'file_blob_data' do
+    assert_equal File.binread(@ruby_path), file_blob_data('files/ruby.png')
+    assert_equal File.binread(@invoice_path),
+                  file_blob_data('files/invoice.pdf')
+  end
+
+  test 'file_blob_id' do
+    assert_equal 'udXLga6YgZX7TR__OGt6NGw2u4ulhODFWndwUlwPoXU=',
+                 file_blob_id('files/ruby.png')
+    assert_equal '30aM5cShJnhiJJCLahmhdWjk31Cq9d7hKoIHiEf2VbM=',
+                 file_blob_id('files/invoice.pdf')
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,36 @@
+require 'rubygems'
+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 'minitest'
+
+require 'action_controller'
+require 'active_record'
+require 'active_support/core_ext'
+require 'rails'
+
+require 'mocha/setup'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'file_blobs_rails'
+
+require 'helpers/action_controller.rb'
+require 'helpers/db_setup.rb'
+require 'helpers/fixtures.rb'
+require 'helpers/i18n.rb'
+require 'helpers/migrations.rb'
+require 'helpers/rails.rb'
+require 'helpers/routes.rb'
+require 'helpers/test_order.rb'
+
+class MiniTest::Test
+end
+
+require 'minitest/autorun'