imap-backup 2.1.0 → 2.1.1

data/spec/unit/imap/backup/serializer/mbox_store_spec.rb

@@ -14,10 +14,11 @@ describe Imap::Backup::Serializer::MboxStore do
   let(:imap_content) do
     {
       version: Imap::Backup::Serializer::MboxStore::CURRENT_VERSION,
-      uid_validity: 123,
-      uids: uids.sort
+      uid_validity: uid_validity,
+      uids: uids
     }.to_json
   end
+  let(:uid_validity) { 123 }
 
   before do
     allow(File).to receive(:exist?).and_call_original
@@ -40,9 +41,30 @@ describe Imap::Backup::Serializer::MboxStore do
     allow(FileUtils).to receive(:chmod)
   end
 
-  context "#uids" do
-    it "returns the backed-up uids as sorted integers" do
-      expect(subject.uids).to eq(uids.map(&:to_i).sort)
+  describe "#uid_validity=" do
+    let(:new_uid_validity) { "13" }
+    let(:updated_imap_content) do
+      {
+        version: Imap::Backup::Serializer::MboxStore::CURRENT_VERSION,
+        uid_validity: new_uid_validity,
+        uids: uids
+      }.to_json
+    end
+
+    before { subject.uid_validity = new_uid_validity }
+
+    it "sets uid_validity" do
+      expect(subject.uid_validity).to eq(new_uid_validity)
+    end
+
+    it "writes the imap file" do
+      expect(imap_file).to have_received(:write).with(updated_imap_content)
+    end
+  end
+
+  describe "#uids" do
+    it "returns the backed-up uids as integers" do
+      expect(subject.uids).to eq(uids.map(&:to_i))
     end
 
     context "when the imap file does not exist" do
@@ -53,6 +75,30 @@ describe Imap::Backup::Serializer::MboxStore do
       end
     end
 
+    context "when the imap file is malformed" do
+      before do
+        allow(JSON).to receive(:parse).and_raise(JSON::ParserError)
+      end
+
+      let!(:result) { subject.uids }
+
+      it "returns an empty Array" do
+        expect(result).to eq([])
+      end
+
+      it "deletes the imap file" do
+        expect(File).to have_received(:unlink).with(imap_pathname)
+      end
+
+      it "deletes the mbox file" do
+        expect(File).to have_received(:unlink).with(mbox_pathname)
+      end
+
+      it "writes a blank mbox file" do
+        expect(mbox_file).to have_received(:write).with("")
+      end
+    end
+
     context "when the mbox does not exist" do
       let(:mbox_exists) { false }
 
@@ -62,7 +108,7 @@ describe Imap::Backup::Serializer::MboxStore do
     end
   end
 
-  context "#add" do
+  describe "#add" do
     let(:mbox_formatted_message) { "message in mbox format" }
     let(:message_uid) { "999" }
     let(:message) do
@@ -74,15 +120,14 @@ describe Imap::Backup::Serializer::MboxStore do
     let(:updated_imap_content) do
       {
         version: Imap::Backup::Serializer::MboxStore::CURRENT_VERSION,
-        uid_validity: 123,
-        uids: (uids + [999]).sort
+        uid_validity: uid_validity,
+        uids: uids + [999]
       }.to_json
     end
 
     before do
       allow(Email::Mboxrd::Message).to receive(:new).and_return(message)
       allow(File).to receive(:open).with(mbox_pathname, "ab") { mbox_file }
-      subject.uid_validity = 123
     end
 
     it "saves the message to the mbox" do
@@ -97,6 +142,15 @@ describe Imap::Backup::Serializer::MboxStore do
       expect(imap_file).to have_received(:write).with(updated_imap_content)
     end
 
+    context "when the message is already downloaded" do
+      let(:uids) { [999] }
+
+      it "skips the message" do
+        subject.add(message_uid, "The\nemail\n")
+        expect(mbox_file).to_not have_received(:write)
+      end
+    end
+
     context "when the message causes parsing errors" do
       before do
         allow(message).to receive(:to_serialized).and_raise(ArgumentError)
@@ -114,4 +168,103 @@ describe Imap::Backup::Serializer::MboxStore do
       end
     end
   end
+
+  describe "#load" do
+    let(:uid) { "1" }
+    let(:result) { subject.load(uid) }
+    let(:enumerator) do
+      instance_double(Imap::Backup::Serializer::MboxEnumerator)
+    end
+    let(:enumeration) { instance_double(Enumerator) }
+
+    before do
+      allow(Imap::Backup::Serializer::MboxEnumerator).
+        to receive(:new) { enumerator }
+      allow(enumerator).to receive(:each) { enumeration }
+      allow(enumeration).
+        to receive(:with_index).
+        and_yield("", 0).
+        and_yield("", 1).
+        and_yield("ciao", 2)
+    end
+
+    it "returns the message" do
+      expect(result.supplied_body).to eq("ciao")
+    end
+
+    context "when the UID is unknown" do
+      let(:uid) { "99" }
+
+      it "returns nil" do
+        expect(result).to be_nil
+      end
+    end
+  end
+
+  describe "#update_uid" do
+    let(:old_uid) { "2" }
+    let(:updated_imap_content) do
+      {
+        version: Imap::Backup::Serializer::MboxStore::CURRENT_VERSION,
+        uid_validity: uid_validity,
+        uids: [3, 999, 1]
+      }.to_json
+    end
+
+    before { subject.update_uid(old_uid, "999") }
+
+    it "updates the stored UID" do
+      expect(imap_file).to have_received(:write).with(updated_imap_content)
+    end
+
+    context "when the UID is unknown" do
+      let(:old_uid) { "42" }
+
+      it "does nothing" do
+        expect(imap_file).to_not have_received(:write)
+      end
+    end
+  end
+
+  describe "#reset" do
+    before { subject.reset }
+
+    it "deletes the imap file" do
+      expect(File).to have_received(:unlink).with(imap_pathname)
+    end
+
+    it "deletes the mbox file" do
+      expect(File).to have_received(:unlink).with(mbox_pathname)
+    end
+
+    it "writes a blank mbox file" do
+      expect(mbox_file).to have_received(:write).with("")
+    end
+  end
+
+  describe "#rename" do
+    let(:new_name) { "new_name" }
+    let(:new_folder_path) { File.join(base_path, new_name) }
+    let(:new_imap_name) { new_folder_path + ".imap" }
+    let(:new_mbox_name) { new_folder_path + ".mbox" }
+
+    before do
+      allow(File).to receive(:rename).and_call_original
+      allow(File).to receive(:rename).with(imap_pathname, new_imap_name)
+      allow(File).to receive(:rename).with(mbox_pathname, new_mbox_name)
+      subject.rename(new_name)
+    end
+
+    it "renames the imap file" do
+      expect(File).to have_received(:rename).with(imap_pathname, new_imap_name)
+    end
+
+    it "renames the mbox file" do
+      expect(File).to have_received(:rename).with(mbox_pathname, new_mbox_name)
+    end
+
+    it "updates the folder name" do
+      expect(subject.folder).to eq(new_name)
+    end
+  end
 end

data/spec/unit/imap/backup/utils_spec.rb

@@ -9,7 +9,7 @@ describe Imap::Backup::Utils do
     allow(File).to receive(:exist?).with(filename).and_return(exists)
   end
 
-  context ".check_permissions" do
+  describe ".check_permissions" do
     let(:requested) { 0o345 }
 
     context "with existing files" do
@@ -47,7 +47,7 @@ describe Imap::Backup::Utils do
     end
   end
 
-  context ".mode" do
+  describe ".mode" do
     context "with existing files" do
       let(:mode) { 0o2345 }
 
@@ -65,7 +65,7 @@ describe Imap::Backup::Utils do
     end
   end
 
-  context ".make_folder" do
+  describe ".make_folder" do
     before do
       allow(FileUtils).to receive(:mkdir_p)
       allow(FileUtils).to receive(:chmod)

data/spec/unit/imap/backup_spec.rb

@@ -0,0 +1,28 @@
+require "ostruct"
+require "imap/backup"
+
+describe Imap::Backup do
+  describe ".setup_logging" do
+    let!(:previous) { described_class.logger.level }
+
+    before { described_class.setup_logging(config) }
+
+    after { described_class.logger.level = previous }
+
+    context "when config.debug?" do
+      let(:config) { OpenStruct.new(debug?: true) }
+
+      it "sets logger level to debug" do
+        expect(described_class.logger.level).to eq(::Logger::Severity::DEBUG)
+      end
+    end
+
+    context "when not config.debug?" do
+      let(:config) { OpenStruct.new(debug?: false) }
+
+      it "sets logger level to debug" do
+        expect(described_class.logger.level).to eq(::Logger::Severity::ERROR)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Joe Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-22 00:00:00.000000000 Z
+date: 2019-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -134,6 +134,7 @@ files:
 - ".rspec"
 - ".rspec-all"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE
@@ -158,6 +159,7 @@ files:
 - lib/imap/backup/downloader.rb
 - lib/imap/backup/serializer.rb
 - lib/imap/backup/serializer/mbox.rb
+- lib/imap/backup/serializer/mbox_enumerator.rb
 - lib/imap/backup/serializer/mbox_store.rb
 - lib/imap/backup/uploader.rb
 - lib/imap/backup/utils.rb
@@ -188,10 +190,12 @@ files:
 - spec/unit/imap/backup/configuration/setup_spec.rb
 - spec/unit/imap/backup/configuration/store_spec.rb
 - spec/unit/imap/backup/downloader_spec.rb
+- spec/unit/imap/backup/serializer/mbox_enumerator_spec.rb
 - spec/unit/imap/backup/serializer/mbox_spec.rb
 - spec/unit/imap/backup/serializer/mbox_store_spec.rb
 - spec/unit/imap/backup/uploader_spec.rb
 - spec/unit/imap/backup/utils_spec.rb
+- spec/unit/imap/backup_spec.rb
 - tmp/.gitkeep
 homepage: https://github.com/joeyates/imap-backup
 licenses: []
@@ -246,7 +250,9 @@ test_files:
 - spec/unit/imap/backup/configuration/setup_spec.rb
 - spec/unit/imap/backup/configuration/store_spec.rb
 - spec/unit/imap/backup/downloader_spec.rb
+- spec/unit/imap/backup/serializer/mbox_enumerator_spec.rb
 - spec/unit/imap/backup/serializer/mbox_spec.rb
 - spec/unit/imap/backup/serializer/mbox_store_spec.rb
 - spec/unit/imap/backup/uploader_spec.rb
 - spec/unit/imap/backup/utils_spec.rb
+- spec/unit/imap/backup_spec.rb