Require all entries to have a name, path and type

Thibaut Courouble committed 10 years ago

Commit 5bb96f81 parent 18199103 files · +45 −20Browse files

Unified · Split

3 files

lib/docs/core/models/entry.rb +10 −0
test/lib/docs/core/doc_test.rb +2 −2
test/lib/docs/core/models/entry_test.rb +33 −18

+# frozen_string_literal: true
 module Docs
   class Entry
+    class Invalid < StandardError; end
     attr_accessor :name, :type, :path
     def initialize(name = nil, path = nil, type = nil)
       self.name = name
       self.path = path
       self.type = type
+      unless root?
+        raise Invalid, 'missing name' if !name || name.empty?
+        raise Invalid, 'missing path' if !path || path.empty?
+        raise Invalid, 'missing type' if !type || type.empty?
+      end
     end
     def ==(other)

test/lib/docs/core/doc_test.rb+2−2

@@ -14,7 +14,7 @@ class DocsDocTest < MiniTest::Spec · 13 unmodified lines
14	end	14	end
15		15
16	let :entry do	16	let :entry do
17	Docs::Entry.new	17	Docs::Entry.new 'name', 'path', 'type'
18	end	18	end
19		19
20	let :store do	20	let :store do
@@ -262,7 +262,7 @@ class DocsDocTest < MiniTest::Spec · 241 unmodified lines
262	mock(store).write('index.json', anything) do \|path, json\|	262	mock(store).write('index.json', anything) do \|path, json\|
263	json = JSON.parse(json)	263	json = JSON.parse(json)
264	assert_equal pages.length, json['entries'].length	264	assert_equal pages.length, json['entries'].length
265	assert_includes json['entries'], Docs::Entry.new('one').as_json.stringify_keys	265	assert_includes json['entries'], Docs::Entry.new('one', 'path', 'type').as_json.stringify_keys
266	end	266	end
267	doc.store_pages(store)	267	doc.store_pages(store)
268	end	268	end

test/lib/docs/core/models/entry_test.rb+33−18

   Entry = Docs::Entry
   let :entry do
-    Entry.new
+    Entry.new('name', 'path', 'type')
+  end
+  def build_entry(name = 'name', path = 'path', type = 'type')
+    Entry.new(name, path, type)
   end
   describe ".new" do
-    it "stores a name" do
+    it "stores #name, #path and #type" do
-      assert_equal 'name', Entry.new('name').name
+      entry = Entry.new('name', 'path', 'type')
+      assert_equal 'name', entry.name
+      assert_equal 'path', entry.path
+      assert_equal 'type', entry.type
     end
-    it "stores a path" do
+    it "raises an error when #name, #path or #type is nil or empty" do
-      assert_equal 'path', Entry.new(nil, 'path').path
+      assert_raises(Docs::Entry::Invalid) { Entry.new(nil, 'path', 'type') }
+      assert_raises(Docs::Entry::Invalid) { Entry.new('', 'path', 'type') }
+      assert_raises(Docs::Entry::Invalid) { Entry.new('name', nil, 'type') }
+      assert_raises(Docs::Entry::Invalid) { Entry.new('name', '', 'type') }
+      assert_raises(Docs::Entry::Invalid) { Entry.new('name', 'path', nil) }
+      assert_raises(Docs::Entry::Invalid) { Entry.new('name', 'path', '') }
     end
-    it "stores a type" do
+    it "don't raise an error when #path is 'index' and #name or #type is nil or empty" do
-      assert_equal 'type', Entry.new(nil, nil, 'type').type
+      Entry.new(nil, 'index', 'type')
+      Entry.new('', 'index', 'type')
+      Entry.new('name', 'index', nil)
+      Entry.new('name', 'index', '')
     end
   end
   describe "#==" do
     it "returns true when the other has the same name, path and type" do
-      assert_equal Entry.new, Entry.new
+      assert_equal build_entry, build_entry
     end
     it "returns false when the other has a different name" do
-      entry.name = 'name'
+      entry.name = 'other_name'
-      refute_equal Entry.new, entry
+      refute_equal build_entry, entry
     end
     it "returns false when the other has a different path" do
-      entry.path = 'path'
+      entry.path = 'other_path'
-      refute_equal Entry.new, entry
+      refute_equal build_entry, entry
     end
     it "returns false when the other has a different type" do
-      entry.type = 'type'
+      entry.type = 'other_type'
-      refute_equal Entry.new, entry
+      refute_equal build_entry, entry
     end
   end
   describe "#<=>" do
     it "returns 1 when the other's name is less" do
-      assert_equal 1, Entry.new('b') <=> Entry.new('a')
+      assert_equal 1, build_entry('b') <=> build_entry('a')
     end
     it "returns -1 when the other's name is greater" do
-      assert_equal -1, Entry.new('a') <=> Entry.new('b')
+      assert_equal -1, build_entry('a') <=> build_entry('b')
     end
     it "returns 0 when the other's name is equal" do
-      assert_equal 0, Entry.new('a') <=> Entry.new('a')
+      assert_equal 0, build_entry('a') <=> build_entry('a')
     end
     it "is case-insensitive" do
-      assert_equal 0, Entry.new('a') <=> Entry.new('A')
+      assert_equal 0, build_entry('a') <=> build_entry('A')
     end
   end