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

@@ -1,11 +1,21 @@
	1	+# frozen_string_literal: true
	2	+
1	3	module Docs
2	4	class Entry
	5	+ class Invalid < StandardError; end
	6	+
3	7	attr_accessor :name, :type, :path
4	8
5	9	def initialize(name = nil, path = nil, type = nil)
6	10	self.name = name
7	11	self.path = path
8	12	self.type = type
	13	+
	14	+ unless root?
	15	+ raise Invalid, 'missing name' if !name \|\| name.empty?
	16	+ raise Invalid, 'missing path' if !path \|\| path.empty?
	17	+ raise Invalid, 'missing type' if !type \|\| type.empty?
	18	+ end
9	19	end
10	20
11	21	def ==(other)

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

@@ -14,7 +14,7 @@ class DocsDocTest < MiniTest::Spec · 13 unmodified lines
14	14	end
15	15
16	16	let :entry do
17		− Docs::Entry.new
	17	+ Docs::Entry.new 'name', 'path', 'type'
18	18	end
19	19
20	20	let :store do
@@ -262,7 +262,7 @@ class DocsDocTest < MiniTest::Spec · 241 unmodified lines
262	262	mock(store).write('index.json', anything) do \|path, json\|
263	263	json = JSON.parse(json)
264	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	266	end
267	267	doc.store_pages(store)
268	268	end

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

@@ -5,20 +5,35 @@ class DocsEntryTest < MiniTest::Spec · 4 unmodified lines
5	5	Entry = Docs::Entry
6	6
7	7	let :entry do
8		− Entry.new
	8	+ Entry.new('name', 'path', 'type')
	9	+ end
	10	+
	11	+ def build_entry(name = 'name', path = 'path', type = 'type')
	12	+ Entry.new(name, path, type)
9	13	end
10	14
11	15	describe ".new" do
12		− it "stores a name" do
13		− assert_equal 'name', Entry.new('name').name
	16	+ it "stores #name, #path and #type" do
	17	+ entry = Entry.new('name', 'path', 'type')
	18	+ assert_equal 'name', entry.name
	19	+ assert_equal 'path', entry.path
	20	+ assert_equal 'type', entry.type
14	21	end
15	22
16		− it "stores a path" do
17		− assert_equal 'path', Entry.new(nil, 'path').path
	23	+ it "raises an error when #name, #path or #type is nil or empty" do
	24	+ assert_raises(Docs::Entry::Invalid) { Entry.new(nil, 'path', 'type') }
	25	+ assert_raises(Docs::Entry::Invalid) { Entry.new('', 'path', 'type') }
	26	+ assert_raises(Docs::Entry::Invalid) { Entry.new('name', nil, 'type') }
	27	+ assert_raises(Docs::Entry::Invalid) { Entry.new('name', '', 'type') }
	28	+ assert_raises(Docs::Entry::Invalid) { Entry.new('name', 'path', nil) }
	29	+ assert_raises(Docs::Entry::Invalid) { Entry.new('name', 'path', '') }
18	30	end
19	31
20		− it "stores a type" do
21		− assert_equal 'type', Entry.new(nil, nil, 'type').type
	32	+ it "don't raise an error when #path is 'index' and #name or #type is nil or empty" do
	33	+ Entry.new(nil, 'index', 'type')
	34	+ Entry.new('', 'index', 'type')
	35	+ Entry.new('name', 'index', nil)
	36	+ Entry.new('name', 'index', '')
22	37	end
23	38	end
24	39
@@ -48,40 +63,40 @@ class DocsEntryTest < MiniTest::Spec · 23 unmodified lines
48	63
49	64	describe "#==" do
50	65	it "returns true when the other has the same name, path and type" do
51		− assert_equal Entry.new, Entry.new
	66	+ assert_equal build_entry, build_entry
52	67	end
53	68
54	69	it "returns false when the other has a different name" do
55		− entry.name = 'name'
56		− refute_equal Entry.new, entry
	70	+ entry.name = 'other_name'
	71	+ refute_equal build_entry, entry
57	72	end
58	73
59	74	it "returns false when the other has a different path" do
60		− entry.path = 'path'
61		− refute_equal Entry.new, entry
	75	+ entry.path = 'other_path'
	76	+ refute_equal build_entry, entry
62	77	end
63	78
64	79	it "returns false when the other has a different type" do
65		− entry.type = 'type'
66		− refute_equal Entry.new, entry
	80	+ entry.type = 'other_type'
	81	+ refute_equal build_entry, entry
67	82	end
68	83	end
69	84
70	85	describe "#<=>" do
71	86	it "returns 1 when the other's name is less" do
72		− assert_equal 1, Entry.new('b') <=> Entry.new('a')
	87	+ assert_equal 1, build_entry('b') <=> build_entry('a')
73	88	end
74	89
75	90	it "returns -1 when the other's name is greater" do
76		− assert_equal -1, Entry.new('a') <=> Entry.new('b')
	91	+ assert_equal -1, build_entry('a') <=> build_entry('b')
77	92	end
78	93
79	94	it "returns 0 when the other's name is equal" do
80		− assert_equal 0, Entry.new('a') <=> Entry.new('a')
	95	+ assert_equal 0, build_entry('a') <=> build_entry('a')
81	96	end
82	97
83	98	it "is case-insensitive" do
84		− assert_equal 0, Entry.new('a') <=> Entry.new('A')
	99	+ assert_equal 0, build_entry('a') <=> build_entry('A')
85	100	end
86	101	end
87	102