rindle 0.1.1 → 0.2.0

data/.rspec

@@ -1,2 +1,2 @@
---format nested
 --color
+--format progress

data/lib/rindle/collection.rb

@@ -101,8 +101,8 @@ class Rindle
     # Adds an index or a document to the collection.
     def add index
       index = index.index if index.is_a?(Document)
-      unless indices.include?(index)
-        indices << obj.index
+      unless @indices.include?(index)
+        @indices << index
         @documents = nil
       end
     end
@@ -110,8 +110,8 @@ class Rindle
     # Removes an entry from this collection.
     def remove index
       index = index.index if index.is_a?(Document)
-      if indices.include?(index)
-        indices.delete index
+      if @indices.include?(index)
+        @indices.delete index
         @documents = nil
       end
     end
@@ -130,11 +130,11 @@ class Rindle
 
     # Sets the array of `Document` objects.
     def documents= documents
-      indices = documents.map(&:index)
+      self.indices = documents.map(&:index)
       @documents = documents
     end
 
-    # Returns true if the collection includes the given indec,
+    # Returns true if the collection includes the given index,
     # `Document` or `Array`.
     def include? obj
       if obj.is_a?(Array)

data/lib/rindle/document.rb

@@ -69,27 +69,22 @@ class Rindle
       def find_by_index index
         Rindle.index[index]
       end
+
+      # Generates the index for the current path
+      def generate_index path
+        if path =~ /([\w\s]+)-asin_([A-Z0-9]+)-type_([A-Z]+)-v_[0-9]+.azw/
+          "##{$2}^#{$3}"
+        else
+          "*#{Digest::SHA1.hexdigest(File.join('/mnt/us', path))}"
+        end
+      end
     end
 
     attr_reader :index, :path
 
     def initialize path
-      self.path = path
-    end
-
-    # Sets the path variable and updates the index
-    def path= path
       @path  = path
-      @index = generate_index
-    end
-
-    # Generates the index for the current path
-    def generate_index
-      if path =~ /([\w\s]+)-asin_([A-Z0-9]+)-type_([A-Z]+)-v_[0-9]+.azw/
-        "##{$2}^#{$3}"
-      else
-        "*#{Digest::SHA1.hexdigest(File.join('/mnt/us', path))}"
-      end
+      @index = Rindle::Document.generate_index(path)
     end
 
     # Two documents are the same if the indices are equal.
@@ -116,14 +111,24 @@ class Rindle
     # and the Index-hash is updated.
     def rename! new_name
       Rindle.index.delete(@index)
-      self.path = @path.gsub filename, new_name
-      # TODO: update references in Rindle.collections
+
+      old_index = @index
+      @path.gsub!(filename, new_name)
+      @index = Rindle::Document.generate_index(@path)
+
+      Rindle.collections.values.each do |col|
+        if col.include?(old_index)
+          col.remove old_index
+          col.add @index
+        end
+      end
+
       Rindle.index[@index] = self
     end
 
     # Returns an array of all the collections, this document is in.
     def collections
-      Rindle.collections.select do |col|
+      Rindle.collections.values.select do |col|
         col.include? self.index
       end
     end

data/lib/rindle/version.rb

@@ -1,3 +1,3 @@
 class Rindle
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/spec/rindle/collection_spec.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 require "spec_helper"
 
 describe Rindle::Collection do
@@ -5,8 +6,7 @@ describe Rindle::Collection do
     Rindle.load(kindle_root)
   end
 
-
-  context '#exists?' do
+  describe '.exists?' do
     it 'returns true if the collection exists' do
       Rindle::Collection.exists?(:named => 'collection1').should == true
     end
@@ -16,24 +16,54 @@ describe Rindle::Collection do
     end
   end
 
-  context '#all' do
+  describe '.all' do
     it 'invokes Collection.find with parameter :all' do
       Rindle::Collection.find(:all).map(&:name).should == Rindle::Collection.all.map(&:name)
     end
   end
 
-  context '#first' do
+  describe '.first' do
     it 'invokes Collection.find with parameter :first' do
       Rindle::Collection.find(:first).should == Rindle::Collection.first
     end
   end
 
-  context '#find' do
+  describe '.find_by_name' do
+    it 'should return the collection by name' do
+      Rindle::Collection.find_by_name('collection1').
+        name.should == 'collection1'
+    end
+
+    it 'should return nil if not found' do
+      Rindle::Collection.find_by_name('collection3').
+        should == nil
+    end
+  end
+
+  describe '.create' do
+    before :all do
+      @col = Rindle::Collection.create 'some_collection'
+    end
+
+    after :all do
+      Rindle.collections.delete 'some_collection'
+    end
+
+    it 'should create a new collection object' do
+      @col.should_not == nil
+    end
+
+    it 'should add the collection to collections hash' do
+      Rindle.collections['some_collection'] == @col
+    end
+  end
+
+  describe '.find' do
     it 'returns an array of Kindle::Collection objects' do
       Rindle::Collection.find
     end
 
-    context 'finds all filtered' do
+    describe 'finds all filtered' do
       it 'by name with string' do
         name = "collection"
         collections = Rindle::Collection.find(:all, :named => name)
@@ -62,7 +92,7 @@ describe Rindle::Collection do
       end
     end
 
-    context 'finds first filtered' do
+    describe 'finds first filtered' do
       it 'by name' do
         collection = Rindle::Collection.find(:first, :named => 'collection1')
         collection.name.should == 'collection1'
@@ -80,21 +110,195 @@ describe Rindle::Collection do
     end
   end
 
-  context '#documents' do
-    it 'returns an array of Rindle::Document objects' do
-      collection = Rindle::Collection.find(:first, :named => 'collection1')
-      collection.documents.each do |document|
-        document.should be_a(Rindle::Document)
+  describe 'Instance' do
+    before :all do
+      @col = Rindle::Collection.create 'test collection'
+      @col.add "*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b7"
+      @col.add '#B001UQ5HVA^EBSP'
+    end
+
+    after :all do
+      Rindle.collections.delete 'test collection'
+    end
+
+    describe '#documents' do
+      it 'returns an array of Rindle::Document objects' do
+        @col.documents.each do |document|
+          document.should be_a(Rindle::Document)
+        end
+      end
+    end
+
+    describe '#documents=' do
+      it 'should set the documents indices to be the new indices array' do
+        docs = [ "*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b7", '#B001UQ5HVA^EBSP' ].map do |index|
+          Rindle::Document.find_by_index index
+        end
+        @col.documents = docs
+        @col.indices.should == [ "*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b7", '#B001UQ5HVA^EBSP' ]
+      end
+    end
+
+    describe '#include?' do
+      context 'given an Array' do
+        it 'should return true if all indices are included' do
+          @col.include?([ "*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b7", '#B001UQ5HVA^EBSP' ]).should == true
+        end
+        it 'should return false if one is not included' do
+          @col.include?([ "*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b7", '#B001UQ5HVB^EBSP' ]).should == false
+        end
+        it 'should return false if none is included' do
+          @col.include?([ "*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b6", '#B001UQ5HVB^EBSP' ]).should == false
+        end
+      end
+
+      context 'given a document' do
+        it 'should return true if the documents index is included' do
+          doc = Rindle::Document.find_by_name 'A test aswell.mobi'
+          @col.include?(doc).should == true
+        end
+        it 'should return false if the documents index isn´t included' do
+          doc = Rindle::Document.find_by_name 'Definitely a Test.pdf'
+          @col.include?(doc).should == false
+        end
+      end
+
+      context 'given an index' do
+        it 'should return true if index is included' do
+          @col.include?("*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b7").should == true
+        end
+
+        it 'should return false if index isn´t included' do
+          @col.include?("*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b6").should == false
+        end
+      end
+    end
+
+    describe '#indices=' do
+      before :all do
+        @col.indices = [ "*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b7" ]
+      end
+
+      after :all do
+        @col.indices = [ "*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b7", "#B001UQ5HVB^EBSP" ]
+      end
+
+      it 'should set the indices array' do
+        @col.indices.should == [ "*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b7" ]
+      end
+      it 'should clear the memoized documents array' do
+        @col.documents.should == [ Rindle::Document.find_by_index("*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b7") ]
+      end
+    end
+
+    describe '#rename!' do
+      before :all do
+        @col.rename! 'renamed test collection'
+      end
+
+      after :all do
+        @col.rename! 'test collection'
+      end
+
+      it 'should remove the old collections entry' do
+        Rindle.collections.should_not have_key 'test collection'
+      end
+
+      it 'should add the new collections entry' do
+        Rindle.collections.should have_key 'renamed test collection'
+      end
+
+      it 'should change the collections name' do
+        @col.name.should == 'renamed test collection'
+      end
+    end
+
+    describe '#destroy!' do
+      before :all do
+        @col.destroy!
+      end
+
+      after :all do
+        @col = Rindle::Collection.create 'test collection'
+        @col.add "*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b7"
+        @col.add "#B001UQ5HVA^EBSP"
+      end
+
+      it 'should remove the collections entry' do
+        Rindle.collections.should_not have_key 'test collection'
       end
     end
-  end
 
-  context '#to_hash' do
-    it 'returns a hash that could be found in collections.json' do
-      now = Time.now.to_i
-      collection = Rindle::Collection.new("test", :indices => ['a','b','c'],
-                                                  :last_access => now)
-      collection.to_hash.should == { "test@en-US" => { "items" => ['a', 'b', 'c'], "lastAccess" => now } }
+    describe '#add' do
+      context 'given a document' do
+        before :all do
+          @col.add Rindle::Document.find_by_name 'Definitely a Test.pdf'
+        end
+
+        after :all do
+          @col.remove "*0849dd9b85fc341d10104f56985e423b3848e1f3"
+        end
+
+        it 'should add the documents index' do
+          @col.indices.should =~ ["*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b7",
+                                  "#B001UQ5HVB^EBSP",
+                                  "*0849dd9b85fc341d10104f56985e423b3848e1f3"]
+        end
+      end
+
+      context 'given an index' do
+        before :all do
+          @col.add "*0849dd9b85fc341d10104f56985e423b3848e1f3"
+        end
+
+        after :all do
+          @col.remove "*0849dd9b85fc341d10104f56985e423b3848e1f3"
+        end
+
+        it 'should add the index' do
+          @col.indices.should include "*0849dd9b85fc341d10104f56985e423b3848e1f3"
+        end
+      end
+    end
+
+    describe '#remove' do
+      context 'given a document' do
+        before :all do
+          @col.remove Rindle::Document.find_by_name 'A test aswell.mobi'
+        end
+
+        after :all do
+          @col.add "*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b7"
+        end
+
+        it 'should remove the documents index' do
+          @col.indices.should_not include '*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b7'
+        end
+      end
+
+      context 'given an index' do
+        before :all do
+          @col.remove "*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b7"
+        end
+
+        after :all do
+          @col.add "*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b7"
+        end
+
+        it 'should remove the index' do
+          @col.indices.should_not include '*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b7'
+        end
+      end
+    end
+
+    describe '#to_hash' do
+      it 'returns a hash that could be found in collections.json' do
+        now = Time.now.to_i
+        collection = Rindle::Collection.new("test",
+                                            :indices => ['a','b','c'],
+                                            :last_access => now)
+        collection.to_hash.should == { "test@en-US" => { "items" => ['a', 'b', 'c'], "lastAccess" => now } }
+      end
     end
   end
 end

data/spec/rindle/document_spec.rb

@@ -9,7 +9,7 @@ describe Rindle::Document do
     Rindle.reset
   end
 
-  it 'equals another if the index is the same' do
+  it 'equals another document if the index is the same' do
     doc1 = Rindle::Document.new('documents/ABC-asin_B001UQ5HVA-type_EBSP-v1.azw')
     doc2 = Rindle::Document.new('documents/ABC-asin_B001UQ5HVA-type_EBSP-v1.azw')
     doc1.should == doc2
@@ -39,10 +39,12 @@ describe Rindle::Document do
         doc = Rindle::Document.find(:first, :named => 'A test aswell.mobi')
         doc.filename.should == 'A test aswell.mobi'
       end
+
       it 'by name with regular expression' do
         doc = Rindle::Document.find(:first, :named => /t([es]+)t/)
         doc.filename.should == 'A test aswell.mobi'
       end
+
       it 'by index' do
         doc = Rindle::Document.find(:first, :indexed => '*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b7')
         doc.filename.should == 'A test aswell.mobi'
@@ -56,4 +58,91 @@ describe Rindle::Document do
       docs.map(&:filename).should == [ 'This is a test document.rtf' ]
     end
   end
+
+  describe '.find_by_name' do
+    it 'should return the document with given path' do
+      Rindle::Document.find_by_name('A test aswell.mobi').index.should == '*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b7'
+    end
+
+    it 'should return nil if not found' do
+      Rindle::Document.find_by_name('Non-existent.pdf').should be_nil
+    end
+  end
+
+  describe '.find_by_index' do
+    it 'should return the document with given index' do
+      Rindle::Document.find_by_index('*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b7').filename.should == 'A test aswell.mobi'
+    end
+
+    it 'should return nil if not found' do
+      Rindle::Document.find_by_index('*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b6').should be_nil
+    end
+  end
+
+  describe '#generate_index' do
+    it 'should generate an amazon index' do
+      Rindle::Document.generate_index('documents/A test aswell.mobi').should == '*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b7'
+    end
+
+    it 'should generate a non-amazon index' do
+      Rindle::Document.
+        generate_index('documents/Salvia Divinorum Shamanic Plant-asin_B001UQ5HVA-type_EBSP-v_0.azw').
+        should == '#B001UQ5HVA^EBSP'
+    end
+  end
+
+  describe '#filename' do
+    it 'should return the basename of the path' do
+      doc = Rindle::Document.find_by_name('A test aswell.mobi')
+      doc.filename.should == 'A test aswell.mobi'
+    end
+  end
+
+  describe '#amazon?' do
+    it 'should return true if the filename is an amazon-like name' do
+      doc = Rindle::Document.find_by_name('Salvia Divinorum Shamanic Plant-asin_B001UQ5HVA-type_EBSP-v_0.azw')
+      doc.amazon?.should == true
+    end
+
+    it 'should return false if the filename is not an amazon-like name' do
+      doc = Rindle::Document.find_by_name('A test aswell.mobi')
+      doc.amazon?.should == false
+    end
+  end
+
+  describe '#rename!' do
+    before :all do
+      @doc = Rindle::Document.find_by_name('A test aswell.mobi')
+      @doc.rename! 'Indeed a test.mobi'
+    end
+
+    after :all do
+      @doc.rename! 'A test aswell.mobi'
+    end
+
+    it 'should remove the old index' do
+      Rindle.index['*18be6fcd5d5df39c1a96cd22596bbe7fe01db9b7'].should == nil
+    end
+
+    it 'should add the new index' do
+      Rindle.index['*c0dc3fee060e3f49c6fd789fa366d99a9334e835'].should == @doc
+    end
+
+    it 'should update all references in the collections' do
+      col = Rindle::Collection.find_by_name('collection1')
+      col.indices.should include(@doc.index)
+    end
+
+    it 'should set the new path' do
+      @doc.path.should == '/documents/Indeed a test.mobi'
+    end
+  end
+
+  describe '#collections' do
+    it 'should return the associated collections' do
+      @doc = Rindle::Document.find_by_name('A test aswell.mobi')
+      @doc.collections.map(&:name).should =~ [ 'collection1' ]
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rindle
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-17 00:00:00.000000000 Z
+date: 2012-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &25561500 !ruby/object:Gem::Requirement
+  requirement: &18209800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *25561500
+  version_requirements: *18209800
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &25560820 !ruby/object:Gem::Requirement
+  requirement: &18209380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *25560820
+  version_requirements: *18209380
 description: The Rindle gem provides an object-oriented way to manage kindle collection
   data.
 email:
@@ -87,7 +87,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4501087522031064736
+      hash: -2614478778351994306
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -96,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4501087522031064736
+      hash: -2614478778351994306
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.17