populate-me 0.12.0

data/test/test_attachment.rb

@@ -0,0 +1,167 @@
+require 'helper'
+require 'populate_me/attachment'
+require 'populate_me/document'
+
+describe PopulateMe::Attachment do
+
+  parallelize_me!
+
+  class NiceAttachment < PopulateMe::Attachment
+    set :url_prefix, '/under'
+  end
+
+  class NiceIllustration < PopulateMe::Document
+    set :default_attachment_class, NiceAttachment
+    field :name
+    field :image, type: :attachment, variations: [
+      PopulateMe::Variation.new_image_magick_job(:negated, :jpg, '-negate'),
+      PopulateMe::Variation.new_image_magick_job(:negated_gif, :gif, '-negate')
+    ]
+    field :pdf, type: :attachment
+  end
+
+  subject { NiceAttachment.new(document, field) }
+  let(:described_class) { NiceAttachment }
+  let(:document) { NiceIllustration.new(name: 'Painting', image: 'myimage.jpg') }
+  let(:field) { :image }
+
+  describe "Kept attributes" do
+    it "Keeps document and field as attributes" do
+      assert_equal document, subject.document
+      assert_equal field, subject.field
+    end
+  end
+
+  it "Delegates settings to its class" do
+    assert_equal '/under', described_class.settings.url_prefix
+    assert_equal '/under', subject.settings.url_prefix
+  end
+
+  describe "#field_value" do
+    it "Gets the field value of its document" do
+      assert_equal 'myimage.jpg', subject.field_value
+    end
+  end
+
+  describe "#field_options" do
+    it "Get options of the field" do
+      assert_equal :attachment, subject.field_options[:type]
+    end
+  end
+
+  describe "#variations" do
+    it "Gets variations for the field" do
+      variations = subject.variations
+      assert_equal 2, variations.size
+      assert_equal :negated, variations[0].name
+    end
+    it "Returns an empty array when there is none (as opposed to nil)" do
+      variations = NiceAttachment.new(document, :pdf).variations
+      assert_instance_of Array, variations
+      assert_equal 0, variations.size
+    end
+  end
+
+  describe "#attachee_prefix" do
+    it "Returns the dasherized version of its document class" do
+      assert_equal 'nice-illustration', subject.attachee_prefix
+    end
+  end
+
+  describe "#location_root" do
+    it "It concatenates the root, url_prefix and class name dasherized" do
+      assert_equal "#{subject.settings.root}/under/nice-illustration", subject.location_root
+    end
+  end
+
+  describe "#location" do
+    it "Combines location root and the field value" do
+      assert_equal "#{subject.location_root}/myimage.jpg", subject.location
+    end
+  end
+
+  describe "#deletable?" do
+    let(:fake) { File.expand_path(__FILE__) }
+    def setup_stubs
+      subject.stub(:field_value, path) do
+        subject.stub(:location, loc) do
+          yield
+        end
+      end
+    end
+    let(:path) { fake }
+    let(:loc) { fake }
+    describe "When there is something to delete" do
+      it "is true" do
+        setup_stubs do
+          assert subject.deletable?
+        end
+      end
+    end
+    describe "When field is blank" do
+      let(:path) { '' }
+      it "is false" do
+        setup_stubs do
+          refute subject.deletable?
+        end
+      end
+    end
+    describe "When the file does not exist" do
+      let(:loc) { 'non-existing.path' }
+      it "is false" do
+        setup_stubs do
+          refute subject.deletable?
+        end
+      end
+    end
+  end
+
+  describe "#delete" do
+    it "Performs if deletable" do
+      subject.stub(:deletable?, true) do
+        assert_receive(subject, :perform_delete, nil, [:negated]) do
+          subject.delete(:negated)
+        end
+      end
+    end
+    it "Does not perform if not deletable" do
+      subject.stub(:deletable?, false) do
+        refute_receive(subject, :perform_delete) do
+          subject.delete(:thumb)
+        end
+      end
+    end
+    it "Can delete all variations in one go" do
+      # Most used
+      subject.stub(:deletable?, true) do
+        mocked_meth = Minitest::Mock.new
+        mocked_meth.expect(:call, nil, [:original])
+        mocked_meth.expect(:call, nil, [:negated])
+        mocked_meth.expect(:call, nil, [:negated_gif])
+        subject.stub :perform_delete, mocked_meth do
+          subject.delete_all
+        end
+        assert mocked_meth.verify, "Expected #{subject.inspect} to call :perform_delete for all variations."
+      end
+    end
+  end
+
+  describe "#perform_delete" do
+    let(:fake_path) { "/path/to/file" }
+    it "Deletes the file at self.location" do
+      subject.stub(:location, fake_path) do
+        assert_receive(FileUtils, :rm, nil, [fake_path]) do
+          subject.perform_delete
+        end
+      end
+    end
+  end
+
+  describe "#create" do
+    it "Calls delete before performing" do
+
+    end
+  end
+
+end
+

data/test/test_document.rb

@@ -0,0 +1,128 @@
+require 'helper'
+require 'populate_me/document'
+
+module Car
+  class RearviewMirror < PopulateMe::Document
+    attr_accessor :my_label_field
+  end
+end
+
+describe PopulateMe::Document do
+  
+  parallelize_me!
+
+  let(:subject_class) { Car::RearviewMirror }
+  subject { subject_class.new }
+
+  describe '#inspect' do
+    it 'Returns a classic ruby inspect to object with an underlying Hash' do
+      test_hash = { a: 1 }
+      subject.stub(:to_h, test_hash) do
+        assert_equal "#<#{subject_class.name}:#{test_hash.inspect}>", subject.inspect
+      end
+    end
+  end
+
+  describe '#to_s' do
+    it 'Defaults to class name and ID' do
+      obj = subject_class.new id: '42'
+      assert_equal "#{subject_class} 42", obj.to_s
+    end
+    describe "Has a label field" do
+      describe "And the field is not blank" do
+        it "Delegates to the label_field" do
+          subject_class.stub :label_field, :my_label_field do
+            subject.stub :my_label_field, 'my label' do
+              assert_equal 'my label', subject.to_s
+            end
+          end
+        end
+        it 'Does not pass a reference that can be modified' do
+          subject_class.stub :label_field, :my_label_field do
+            subject.stub :my_label_field, 'my label' do
+              assert_equal 'my label', subject.to_s
+              var = subject.to_s
+              var << 'BOOM'
+              assert_equal 'my label', subject.to_s
+            end
+          end
+        end
+      end
+      describe "And the field is blank" do
+        it 'Defaults to class name and ID' do
+          subject_class.stub :label_field, :my_label_field do
+            obj = subject_class.new id: '42'
+            subject.stub :my_label_field, '' do
+              assert_equal "#{subject_class} 42", obj.to_s
+            end
+            subject.stub :my_label_field, nil do
+              assert_equal "#{subject_class} 42", obj.to_s
+            end
+          end
+        end
+      end
+    end
+  end
+
+  describe 'Class' do
+
+    describe '::to_s' do
+      it 'Returns a human friendly classname including parent modules' do
+        assert_equal 'Car Rearview Mirror', subject_class.to_s
+      end
+    end
+
+    describe '::to_s_short' do
+      it 'Returns a human friendly classname' do
+        assert_equal 'Rearview Mirror', subject_class.to_s_short
+      end
+    end
+
+    describe '::cast' do
+      let(:docs) do
+        [{my_label_field: 'A'},{my_label_field: 'B'}]
+      end
+      it 'Can return a single object from the block' do
+        subject_class.stub :documents, docs do 
+          out = subject_class.cast{ |c| c.documents[0] }
+          assert_equal subject_class, out.class
+        end
+      end
+      it 'Can return a list of objects from the block' do
+        subject_class.stub :documents, docs do 
+          out = subject_class.cast{ |c| c.documents }
+          assert_equal subject_class, out[0].class
+          assert_equal subject_class, out[1].class
+        end
+      end
+      describe 'The block returns nil' do
+        it 'Returns nil as well' do
+          subject_class.stub :documents, docs do 
+            assert_nil subject_class.cast{|c|nil}
+          end
+        end
+      end
+      describe 'The block does not return the right thing' do
+        it 'Raises type error' do
+          subject_class.stub :documents, docs do 
+            assert_raises(TypeError) do
+              subject_class.cast{|c|3}
+            end
+          end
+        end
+      end
+      describe 'No argument is given to the block' do
+        it 'Calls the block in the class context' do
+          subject_class.stub :documents, docs do 
+            out = subject_class.cast{ documents }
+            assert_equal subject_class, out[0].class
+            assert_equal subject_class, out[1].class
+          end
+        end
+      end
+    end
+
+  end
+
+end
+

data/test/test_document_admin_adapter.rb

@@ -0,0 +1,221 @@
+require 'helper'
+require 'populate_me/document'
+require 'populate_me/attachment'
+
+describe PopulateMe::Document, 'AdminAdapter' do
+
+  parallelize_me!
+
+  describe '::admin_image_field' do
+    describe 'When there is no image' do
+      class AdaptedNoImage < PopulateMe::Document
+        field :name
+      end
+      it 'Returns nil' do
+        assert_nil AdaptedNoImage.admin_image_field
+      end
+    end
+    describe 'When there is an image but not with the right variation' do
+      class AdaptedImageNoVar < PopulateMe::Document
+        field :name
+        field :thumbnail1, type: :attachment, class_name: PopulateMe::Attachment
+        field :thumbnail2, type: :attachment, variations:[
+          PopulateMe::Variation.new_image_magick_job(:small,:jpg,'-negate')
+        ], class_name: PopulateMe::Attachment
+      end
+      it 'Returns nil' do
+        assert_nil AdaptedImageNoVar.admin_image_field
+      end
+    end
+    describe 'When there is an image and the right variation' do
+      class AdaptedImageVar < PopulateMe::Document
+        field :name
+        field :thumbnail1, type: :attachment, class_name: PopulateMe::Attachment
+        field :thumbnail2, type: :attachment, variations:[
+          PopulateMe::Variation.new_image_magick_job(:populate_me_thumb,:jpg,'-negate')
+        ], class_name: PopulateMe::Attachment
+      end
+      it 'Returns the field' do
+        assert_equal :thumbnail2, AdaptedImageVar.admin_image_field
+      end
+    end
+  end
+
+  describe '::to_admin_list' do
+    class PolyAdapted < PopulateMe::Document
+      polymorphic values: ['Shape 1', 'Shape 2']
+    end
+    class NotPolyAdapted < PopulateMe::Document
+    end
+    it 'Contains polymorphic_type values and predicate if polymorphic' do
+      assert PolyAdapted.to_admin_list[:is_polymorphic]
+      assert_equal ['Shape 1', 'Shape 2'], PolyAdapted.to_admin_list[:polymorphic_type_values]
+      refute NotPolyAdapted.to_admin_list[:is_polymorphic]
+      assert_nil NotPolyAdapted.to_admin_list[:polymorphic_type_values]
+    end
+  end
+
+  describe '#to_admin_list_item' do
+    class ContentTitle < PopulateMe::Document
+      field :content
+    end
+    class PolyListItem < PopulateMe::Document
+      field :name
+      relationship :images, only_for: 'Slider'
+      relationship :paragraphs, only_for: 'Chapter'
+    end
+    it 'Sets ID as a string version' do
+      doc = ContentTitle.new id: 3
+      assert_equal '3', doc.to_admin_list_item[:id]
+    end
+    describe 'When title is long' do
+      it 'Is truncated' do
+        doc = ContentTitle.new
+        doc.content = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
+        title = doc.to_admin_list_item[:title]
+        refute_equal doc.content, title
+        assert_match title.sub(/\.\.\.$/, ''), doc.content 
+        assert_operator title.length, :<=, doc.content.length 
+      end
+    end
+    describe 'When title is short enough' do
+      it 'Does not truncate' do
+        doc = ContentTitle.new
+        doc.content = 'Hello'
+        title = doc.to_admin_list_item[:title]
+        assert_equal doc.content, title
+      end
+    end
+    describe 'Polymorphism' do
+      it 'Only keeps in the local menu applicable relationships' do
+        doc = PolyListItem.new(polymorphic_type: 'Slider')
+        list_item = doc.to_admin_list_item request: Struct.new(:script_name).new('/admin')
+        assert_equal 1, list_item[:local_menu].size
+        assert_equal 'Images', list_item[:local_menu][0][:title]
+      end
+    end
+  end
+
+  describe '::admin_find ::admin_find_first' do
+    
+    class FindablePerson < PopulateMe::Document
+      field :first_name
+      field :last_name
+    end
+    
+    before do
+      FindablePerson.documents = []
+      FindablePerson.new(first_name: 'Bobby', last_name: 'Peru').save
+      FindablePerson.new(first_name: 'John', last_name: 'Doe').save
+      FindablePerson.new(first_name: 'John', last_name: 'Turturo').save
+    end
+
+    it 'Finds everything' do
+      people = FindablePerson.admin_find
+      assert_equal Array, people.class
+      assert_equal 3, people.size
+      assert_equal FindablePerson.documents, people
+    end
+
+    it 'Finds with query' do
+      people = FindablePerson.admin_find query: {first_name: 'John'}
+      assert_equal Array, people.class
+      assert_equal 2, people.size
+      assert_equal 'Doe', people[0].last_name
+    end
+
+    it 'Finds first' do
+      person = FindablePerson.admin_find_first
+      assert_equal 'Bobby', person.first_name
+    end
+
+    it 'Finds first with query' do
+      person = FindablePerson.admin_find_first query: {first_name: 'John'}
+      assert_equal 'Doe', person.last_name
+    end
+
+  end
+
+  describe '::admin_distinct' do
+
+    class Distinction < PopulateMe::Document
+      attr_accessor :title, :age
+    end
+
+    before do
+      Distinction.documents = []
+    end
+
+    it 'Can list all distinct values' do
+      Distinction.new(title: 'Lord').save
+      Distinction.new(title: 'Lord').save
+      Distinction.new.save
+      Distinction.new(title: 'Chevalier').save
+      Distinction.new(title: 'Baron').save
+      Distinction.new(title: 'Baron').save
+      result = Distinction.admin_distinct :title
+      assert_instance_of Array, result
+      assert_equal 3, result.size
+      assert_includes result, 'Lord'
+      assert_includes result, 'Chevalier'
+      assert_includes result, 'Baron'
+    end
+
+    it 'Can list all distinct values for a specific selector' do
+      Distinction.new(title: 'Chevalier', age: 33).save
+      Distinction.new(title: 'Chevalier', age: 34).save
+      Distinction.new(title: 'Baron', age: 35).save
+      Distinction.new(title: 'Baron', age: 36).save
+      result = Distinction.admin_distinct :age, query: {title: 'Baron'}
+      assert_instance_of Array, result
+      assert_equal 2, result.size
+      assert_includes result, 35
+      assert_includes result, 36
+    end
+
+  end
+
+  describe '#to_admin_form' do
+    class PolyForm < PopulateMe::Document
+      field :name
+      field :image, only_for: 'Image'
+      field :title, only_for: 'Article'
+      field :content, only_for: 'Article'
+      field :position
+    end
+    class NotPolyForm < PopulateMe::Document
+      field :name
+    end
+    it 'Sets page_title according to label_field or class name when new' do
+      obj = NotPolyForm.new
+      form = obj.to_admin_form
+      assert_equal 'New Not Poly Form', form[:page_title]
+      obj = NotPolyForm.new name: "No Poly"
+      obj._is_new = false
+      form = obj.to_admin_form
+      assert_equal 'No Poly', form[:page_title]
+    end
+    it 'Only has fields for the current polymorphic type' do
+      obj = PolyForm.new polymorphic_type: 'Article'
+      form = obj.to_admin_form
+      assert_nil form[:fields].find{|f| f[:field_name]==:image}
+      refute_nil form[:fields].find{|f| f[:field_name]==:title}
+      refute_nil form[:fields].find{|f| f[:field_name]==:content}
+    end
+    it 'Works when not polymorphic' do
+      obj = NotPolyForm.new
+      form = obj.to_admin_form
+      refute_nil form[:fields].find{|f| f[:field_name]==:name}
+    end
+    it 'Includes the polymorphic_type at top level' do
+      obj = PolyForm.new polymorphic_type: 'Article'
+      form = obj.to_admin_form
+      assert_equal 'Article', form[:polymorphic_type]
+      obj = PolyForm.new
+      form = obj.to_admin_form
+      assert_nil form[:polymorphic_type]
+    end
+  end
+
+end
+