Store docs' metadata in meta.json files

To avoid relying on the filesystem for modified times.

Thibaut Courouble committed 8 years ago

Commit 0725a691 parent ed12d864 files · +48 −60Browse files

Unified · Split

4 files

lib/docs/core/doc.rb +14 −0
lib/docs/core/manifest.rb +3 −21
test/lib/docs/core/doc_test.rb +21 −0
test/lib/docs/core/manifest_test.rb +10 −39

   class Doc
     INDEX_FILENAME = 'index.json'
     DB_FILENAME = 'db.json'
+    META_FILENAME = 'meta.json'
     class << self
       include Instrumentable
         File.join path, DB_FILENAME
       end
+      def meta_path
+        File.join path, META_FILENAME
+      end
       def as_json
         json = { name: name, slug: slug, type: type }
         json[:links] = links if links.present?
           if index.present?
             store_index(store, INDEX_FILENAME, index)
             store_index(store, DB_FILENAME, pages)
+            store_meta(store)
             true
           else
             false
         instrument "#{filename.remove('.json')}.doc", before: old_json, after: new_json
         store.write(filename, new_json)
       end
+      def store_meta(store)
+        json = as_json
+        json[:mtime] = Time.now.to_i
+        json[:db_size] = store.size(DB_FILENAME)
+        store.write(META_FILENAME, json.to_json)
+      end
     end
     def initialize
       raise NotImplementedError, "#{self.class} is an abstract class and cannot be instantiated." if self.class.abstract
     end

lib/docs/core/manifest.rb+3−21

@@ -14,32 +14,14 @@ module Docs · 13 unmodified lines
14	end	14	end
15		15
16	def as_json	16	def as_json
17	indexed_docs.map do \|doc\|	17	@docs.each_with_object [] do \|doc, result\|
18	json = doc.as_json	18	next unless @store.exist?(doc.meta_path)
19	json[:mtime] = doc_mtime(doc)	19	result << JSON.parse(@store.read(doc.meta_path))
20	json[:db_size] = doc_db_size(doc)
21	json
22	end	20	end
23	end	21	end
24		22
25	def to_json	23	def to_json
26	JSON.generate(as_json)	24	JSON.generate(as_json)
27	end	25	end
28
29	private
30
31	def indexed_docs
32	@docs.select do \|doc\|
33	@store.exist?(doc.index_path) && @store.exist?(doc.db_path)
34	end
35	end
36
37	def doc_mtime(doc)
38	[@store.mtime(doc.index_path).to_i, @store.mtime(doc.db_path).to_i].max
39	end
40
41	def doc_db_size(doc)
42	@store.size(doc.db_path)
43	end
44	end	26	end
45	end	27	end

test/lib/docs/core/doc_test.rb+21−0

     end
   end
+  describe ".meta_path" do
+    it "returns .path + ::META_FILENAME" do
+      stub(doc).path { 'path' }
+      assert_equal File.join('path', Docs::Doc::META_FILENAME), doc.meta_path
+    end
+  end
   describe ".new" do
     it "raises an error when .abstract is true" do
       doc.abstract = true
           mock(store).write(page[:store_path], page[:output])
           mock(store).write('index.json', anything)
           mock(store).write('db.json', anything)
+          mock(store).write('meta.json', anything)
           doc.store_pages(store)
         end
         it "stores an index that contains all the pages' entries" do
           stub(store).write(page[:store_path], page[:output])
           stub(store).write('db.json', anything)
+          stub(store).write('meta.json', anything)
           mock(store).write('index.json', anything) do |path, json|
             json = JSON.parse(json)
             assert_equal pages.length, json['entries'].length
         it "stores a db that contains all the pages, indexed by path" do
           stub(store).write(page[:store_path], page[:output])
           stub(store).write('index.json', anything)
+          stub(store).write('meta.json', anything)
           mock(store).write('db.json', anything) do |path, json|
             json = JSON.parse(json)
             assert_equal page[:output], json[page[:path]]
           doc.store_pages(store)
         end
+        it "stores a meta file that contains the doc's metadata" do
+          stub(store).write(page[:store_path], page[:output])
+          stub(store).write('index.json', anything)
+          stub(store).write('db.json', anything)
+          mock(store).write('meta.json', anything) do |path, json|
+            json = JSON.parse(json)
+            assert_equal %w(name slug type mtime db_size).sort, json.keys.sort
+          end
+          doc.store_pages(store)
+        end
         it "replaces the .path directory before storing the files" do
           stub(doc).path { 'path' }
           stub(store).write { assert false }

test/lib/docs/core/manifest_test.rb+10−39

   end
   describe "#as_json" do
-    let :index_path do
+    let :meta_path do
-      'index_path'
+      'meta_path'
-    end
-    let :db_path do
-      'db_path'
     end
     before do
-      stub(doc).index_path { index_path }
+      stub(doc).meta_path { meta_path }
-      stub(doc).db_path { db_path }
     end
     it "returns an array" do
       assert_instance_of Array, manifest.as_json
     end
-    context "when the doc has an index and a db" do
+    context "when the doc has a meta file" do
       before do
-        stub(store).exist?(index_path) { true }
+        stub(store).exist?(meta_path) { true }
-        stub(store).exist?(db_path) { true }
+        stub(store).read(meta_path) { '{"name":"Test"}' }
       end
-      it "includes the doc's JSON representation" do
+      it "includes the doc's meta representation" do
         json = manifest.as_json
         assert_equal 1, json.length
-        assert_empty doc.as_json.keys - json.first.keys
+        assert_equal 'Test', json[0]['name']
-      end
-      it "adds an :mtime attribute with the greatest of the index and db files' mtime" do
-        mtime_index = Time.now - 1
-        mtime_db = Time.now - 2
-        stub(store).mtime(index_path) { mtime_index }
-        stub(store).mtime(db_path) { mtime_db }
-        assert_equal mtime_index.to_i, manifest.as_json.first[:mtime]
-        mtime_index, mtime_db = mtime_db, mtime_index
-        assert_equal mtime_db.to_i, manifest.as_json.first[:mtime]
-      end
-      it "adds a :db_size attribute" do
-        stub(store).size(db_path) { 42 }
-        assert_equal 42, manifest.as_json.first[:db_size]
-      end
-    end
-    context "when the doc doesn't have an index" do
-      it "doesn't include the doc" do
-        stub(store).exist?(db_path) { true }
-        stub(store).exist?(index_path) { false }
-        assert_empty manifest.as_json
       end
     end
-    context "when the doc doesn't have a db" do
+    context "when the doc doesn't have a meta file" do
       it "doesn't include the doc" do
-        stub(store).exist?(index_path) { true }
+        stub(store).exist?(meta_path) { false }
-        stub(store).exist?(db_path) { false }
         assert_empty manifest.as_json
       end
     end