large_text_field 0.3.0.pre.1

data/test/dummy/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require File.expand_path('../../config/boot', __FILE__)
+require 'rails/commands'

data/test/dummy/test/fixtures/text_field_owners.yml

@@ -0,0 +1,11 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/Fixtures.html
+
+# This model initially had no columns defined.  If you add columns to the
+# model remove the '{}' from the fixture names and add the columns immediately
+# below each fixture, per the syntax in the comments below
+#
+one: {}
+# column: value
+#
+two: {}
+#  column: value

data/test/fixtures/large_text_field/named_text_values.yml

@@ -0,0 +1,11 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/Fixtures.html
+
+# This model initially had no columns defined.  If you add columns to the
+# model remove the '{}' from the fixture names and add the columns immediately
+# below each fixture, per the syntax in the comments below
+#
+one: {}
+# column: value
+#
+two: {}
+#  column: value

data/test/large_text_field_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class LargeTextFieldTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, LargeTextField
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,37 @@
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../dummy/config/environment.rb", __FILE__)
+require "rails/test_help"
+require "invoca/utils"
+require "rr"
+require "shoulda"
+require "minitest/unit"
+require "pry"
+
+def large_description
+  <<-EOF
+      The Royal Library of Alexandria or Ancient Library of Alexandria in Alexandria, Egypt, was one of the
+      largest and most significant libraries of the ancient world. It was dedicated to the Muses, the nine
+      goddesses of the arts.[1] It flourished under the patronage of the Ptolemaic dynasty and functioned
+      as a major center of scholarship from its construction in the 3rd century BCE until the Roman conquest
+      of Egypt in 30 BCE, with collections of works, lecture halls, meeting rooms, and gardens. The library
+      was part of a larger research institution called the Musaeum of Alexandria, where many of the most
+      famous thinkers of the ancient world studied.
+
+      The library was created by Ptolemy I Soter, who was a Macedonian general and the successor of Alexander
+      the Great.[2] Most of the books were kept as papyrus scrolls. It is unknown how many such scrolls were
+      housed at any given time.
+
+      The library is famous for having been burned down, resulting in the loss of many scrolls and books; its
+      destruction has become a symbol for the loss of cultural knowledge. A few sources differ on who is
+      responsible for the destruction and when it occurred. There is mythology regarding this main burning
+      but the library may in truth have suffered several fires or other acts of destruction over many years.
+      Possible occasions for the partial or complete destruction of the Library of Alexandria include a fire
+      set by Julius Caesar in 48 BCE and an attack by Aurelian in the CE 270s.
+
+      After the main library was fully destroyed, ancient scholars used a "daughter library" in a temple known
+      as the Serapeum, located in another part of the city. According to Socrates of Constantinople, Coptic Pope
+      Theophilus destroyed the Serapeum in AD 391, although it's not certain that it still contained an offshoot
+      of the library then.
+  EOF
+end

data/test/unit/dummy/library_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+module LargeTextField
+  class LibraryTest < ActiveSupport::TestCase
+    should "be able to construct a library" do
+      l = Library.new(name: "Alexandria Public Library")
+      l.save!
+
+      l.description = large_description
+      l.save!
+
+      assert_equal large_description, l.description
+
+      l = Library.find(l.id)
+      assert_equal large_description, l.description
+    end
+
+    should "be able to dup a class that has no current large text field" do
+      l = Library.new(name: "Alexandria Public Library")
+      l.dup
+    end
+  end
+end

data/test/unit/large_text_field/name_text_value_test.rb

@@ -0,0 +1,47 @@
+module LargeTextField
+  class NamedTextValueTest < ActiveSupport::TestCase
+    should belong_to(:owner)
+
+    should "use large_text_fields as the table name" do
+      assert_equal "large_text_fields", LargeTextField::NamedTextValue.table_name
+    end
+
+    should "have field name and value attributes" do
+      library = Library.create!(name: "Smithsonian")
+      ntv = LargeTextField::NamedTextValue.new(field_name: "puppy", value: "Millie", owner: library)
+      assert_equal "puppy", ntv.field_name
+      assert_equal "Millie", ntv.value
+      assert_equal "Smithsonian", ntv.owner.name
+      ntv.save!
+
+      # Attributes survive persistance
+      ntv = LargeTextField::NamedTextValue.find(ntv.id)
+      assert_equal "puppy", ntv.field_name
+      assert_equal "Millie", ntv.value
+      assert_equal "Smithsonian", ntv.owner.name
+    end
+
+    context "unique index" do
+      should "raise a unique constraint failure on the same owner, and field name" do
+        library = Library.create!(name: "Smithsonian")
+        LargeTextField::NamedTextValue.create!(field_name: "puppy", value: "Millie", owner: library)
+
+        assert_raise(ActiveRecord::RecordNotUnique) do
+          LargeTextField::NamedTextValue.create!(field_name: "puppy", value: "Wiki", owner: library)
+        end
+      end
+
+      should "allow different owners and field names" do
+        library = Library.create!(name: "Smithsonian")
+        library2 = Library.create!(name: "Alexandria")
+        LargeTextField::NamedTextValue.create!(field_name: "puppy", value: "Millie", owner: library)
+
+        # Different field name
+        LargeTextField::NamedTextValue.create!(field_name: "dog", value: "Wiki", owner: library)
+
+        # Different owner instance
+        LargeTextField::NamedTextValue.create!(field_name: "puppy", value: "Millie", owner: library2)
+      end
+    end
+  end
+end

data/test/unit/large_text_field/owner_test.rb

@@ -0,0 +1,315 @@
+require 'test_helper'
+
+module LargeTextField
+  class OwnerTest < ActiveSupport::TestCase
+    context "updating in large_text_field_save hook" do
+      { 'empty string' => '', 'non empty string' => 'this is some text' }.each do |name, value|
+        should "be able to assign #{name}" do
+          begin
+            Library.default_notes = value
+            @library = Library.create!(name: "Smithsonian")
+            assert_equal value, @library.notes
+            assert_equal value, @library.reload.notes
+          ensure
+            Library.default_notes = "none_set"
+          end
+        end
+      end
+
+      should "raise error on saving nil value" do
+        begin
+          Library.default_notes = :nil
+          assert_raises RuntimeError do
+            @library = Library.create!(name: "Smithsonian")
+          end
+        ensure
+          Library.default_notes = "none_set"
+        end
+      end
+    end
+
+    context "a large text field" do
+      setup do
+        @library = Library.create!(name: "Smithsonian")
+        assert_equal "", @library.description
+      end
+
+      should "declare the association when it is first described and other meta data when it is first defined" do
+        assert_equal :has_many, Library.reflections['large_text_fields'].macro
+
+        assert_equal({ maximum: nil, singularize_errors: true }, Library.large_text_field_options['description'])
+      end
+
+      should "read from a file" do
+        @library = Library.create!(name: "Smithsonian")
+        tmp_file = nil
+        begin
+          tmp_file = Tempfile.new('large_text_field_test')
+          tmp_file.write("this is a string from the file")
+          tmp_file.close
+
+          test_file = File.open(tmp_file.path)
+
+          @library.description = test_file
+          assert_equal 'this is a string from the file', @library.description
+
+          @library.save!
+          assert_equal 'this is a string from the file', @library.reload.description
+        ensure
+          tmp_file.unlink
+        end
+      end
+
+      should "allow get and set with saves and deletes" do
+        @library.description = "badger " * 200
+        assert_equal "badger " * 200, @library.description
+
+        @library.save!
+        @library.reload
+        assert_equal "badger " * 200, @library.description
+
+        @library.description = "mushroom " * 200
+        assert_equal "mushroom " * 200, @library.description
+
+        @library.save!
+        @library.reload
+        assert_equal "mushroom " * 200, @library.description
+
+        @library.description = ''
+        assert_equal '', @library.description
+
+        @library.save!
+        @library.reload
+        assert_equal '', @library.description
+      end
+
+      should "allow for concurrent sets and deletes" do
+        @library.description = "first"
+        @library.catalog = "second"
+
+        assert_equal "first",  @library.description
+        assert_equal "second", @library.catalog
+
+        @library.save!
+        @library.reload
+
+        assert_equal "first",  @library.description
+        assert_equal "second", @library.catalog
+
+        @library.description = "third"
+        @library.catalog = ''
+
+        assert_equal "third",  @library.description
+        assert_equal '',       @library.catalog
+
+        @library.save!
+
+        assert_equal "third",  @library.description
+        assert_equal '',       @library.catalog
+      end
+
+      should "forget about changes if they are not saved" do
+        @library.description = "first"
+        @library.reload
+        assert_equal '', @library.description
+
+        @library.description = "first"
+        @library.save!
+        @library.reload
+
+        @library.description = ''
+        @library.reload
+        assert_equal "first",  @library.description
+      end
+
+      should "validate the maximum length" do
+        @library.notes = "a" * (LargeTextField::MAX_LENGTH + 1)
+        assert !@library.valid?
+        assert_equal(["Notes are too long (maximum is 5,000,000 characters)"], @library.errors.full_messages)
+      end
+
+      should "singularize the errors if requested" do
+        @library.description = "a" * (LargeTextField::MAX_LENGTH + 1)
+        assert !@library.valid?
+        assert_equal(["Description is too long (maximum is 5,000,000 characters)"], @library.errors.full_messages)
+      end
+
+      should "allow a custom maximum length to be provided" do
+        @library.catalog = "1" * 501
+        assert_equal false, @library.valid?
+        assert_equal ["Catalog is too long (maximum is 500 characters)"], @library.errors.full_messages
+      end
+
+      should "prevent a non-Integer to be provided for a custom maximum" do
+        assert_raise(ArgumentError) do
+          Library.large_text_field :not_number_maximum, maximum: "i am not a number"
+        end
+      end
+
+      should "prevent a custom maximum length to be provided that is not in the allowable range" do
+        assert_raise ArgumentError do
+          Library.large_text_field :bigger_than_allowed, maximum: LargeTextField::MAX_LENGTH + 1
+        end
+
+        assert_raise ArgumentError do
+          Library.large_text_field :smaller_than_allowed, maximum: -1
+        end
+      end
+
+      should "not save fields that are set to blank" do
+        @library = Library.new(name: 'Millie')
+        assert_equal 0, @library.large_text_fields.count
+
+        @library.description = "first"
+        @library.notes = ""
+
+        @library.save!
+        @library.reload
+
+        assert_equal "first", @library.description
+        assert_equal "", @library.notes
+
+        assert_equal 1, @library.large_text_fields.count
+      end
+
+      should "delete fields when they are set to blank" do
+        assert_equal 0, @library.large_text_fields.count
+
+        @library.description = "first"
+
+        @library.save!
+        @library.reload
+
+        assert_equal "first", @library.description
+
+        assert_equal 1, @library.large_text_fields.count
+
+        @library.description = ""
+        @library.save!
+        @library.reload
+
+        assert_equal "", @library.description
+
+        assert_equal 0, @library.large_text_fields.count
+      end
+
+      should "be able to update deleted fields" do
+        assert_equal 0, @library.large_text_fields.count
+
+        @library.description = "first"
+
+        @library.save!
+
+        assert_equal "first", @library.description
+
+        assert_equal 1, @library.large_text_fields.count
+
+        @library.description = ""
+        @library.save!
+
+        assert_equal "", @library.description
+
+        assert_equal 0, @library.large_text_fields.count
+        @library.description = "first"
+
+        @library.save!
+
+        assert_equal "first",  @library.description
+      end
+
+      should "be cloned with the rest of the record" do
+        @library.description = "first"
+        @library.catalog = "second"
+        @library.save!
+
+        @clone = @library.dup
+        assert_equal "first",  @clone.description
+        assert_equal "second", @clone.catalog
+        @clone.save!
+
+        assert_equal "first",  @clone.description
+        assert_equal "second", @clone.catalog
+
+        # Should not have stolen from the owner...
+        @library.save!
+        @library.reload
+
+        assert_equal "first",  @library.description
+        assert_equal "second", @library.catalog
+
+        # should be destroyed when destroyed
+        text_field_ids = @clone.large_text_fields.*.id
+        @clone.destroy
+        text_field_ids.each { |id| assert !LargeTextField::NamedTextValue.find_by_id(id) }
+      end
+
+      should "be able to be eager loaded" do
+        @library.description = "first"
+        @library.catalog = "second"
+        @library.save!
+
+        new_value = Library.includes(:large_text_fields).find(@library.id)
+
+        dont_allow(Library.connection).select
+        assert_equal "first",  new_value.description
+        assert_equal "second", new_value.catalog
+      end
+
+      should "support strings or symbols for get/set methods" do
+        @library.set_text_field(:description, "first")
+        assert_equal "first",  @library.description
+        assert_equal "first",  @library.get_text_field(:description)
+        assert_equal "first",  @library.get_text_field('description')
+
+        @library.set_text_field('description', "second")
+        assert_equal "second",  @library.description
+        assert_equal "second",  @library.get_text_field(:description)
+        assert_equal "second",  @library.get_text_field('description')
+      end
+
+      should "detect changes when @text_field_hash hash is/not empty" do
+        @library = Library.new(name: "Smithsonian")
+
+        assert !@library.instance_variable_defined?("@text_field_hash")
+        assert !@library.description_changed?
+        @library.description = "a new note"
+        assert @library.description_changed?
+        @library.save!
+        @library.reload
+
+        assert !@library.description_changed?
+        @library.description = "a new note"
+        assert !@library.description_changed?
+        @library.description = "now with more chicken taste"
+        assert @library.description_changed?
+      end
+
+      should "only validate_large_text_fields if loaded" do
+        @library = Library.new
+        assert !@library.instance_variable_defined?("@text_field_hash")
+        assert @library.valid?
+        assert !@library.instance_variable_defined?("@text_field_hash")
+      end
+
+      should "reload changes when they come from a different model" do
+        @library = Library.create!(name: "Cambridge University Library", description: "in england")
+        @second_version = Library.find(@library.id)
+
+        @second_version.update_attributes!(description: "The main research library of the University of Cambridge in England")
+
+        assert_equal "The main research library of the University of Cambridge in England", @library.reload.description
+      end
+
+      should "delete large text fields when the owner is destroyed"do
+        assert_equal 0, LargeTextField::NamedTextValue.count
+
+        @library = Library.create!(name: "Cambridge University Library", description: "in england")
+        assert_equal 1, LargeTextField::NamedTextValue.count
+
+        @library.destroy
+        assert_equal 0, LargeTextField::NamedTextValue.count
+      end
+    end
+
+  end
+end