rffdb 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ac408fa55b4135737e2c26d4d1ebdb208951278
-  data.tar.gz: 362c818f4cd7435d248f9ccbe5ce85c602f494de
+  metadata.gz: b46b42ee1876f919030207416134f7cf94b4250a
+  data.tar.gz: 9c232c54e21b2939b651bfb8c758dff486fbe107
 SHA512:
-  metadata.gz: c0fe51088853821a6a109b91386fc68f3ebae4e596304b14151179293d1976ebb5949d8f7d9e649d67784d327325c5d7d42f95e05e93b891afb0136d05fc06bf
-  data.tar.gz: b8412b293f6b541c728f1ce6bdf479a32a1482e15a154d5d40d09a489cade1340bd81150d702a7d7c2509e36e0c26686ecf75b5f3394c620a60af72d618d7e8a
+  metadata.gz: bbef6842d8e3b86a1317dca7e5a0a5f2ff4453a45abd382210511780ae2d349c1870045f1fae38c31779303572ab4cd7bb8f9e41488bbc567807e4a5fc02389c
+  data.tar.gz: 6d326d41d2daade93ffe1da82d043fb18385bda30ac80e4605edf0c1377f970ef685fc0522d3ac690eead523e17f92bb8464fb34204242c2fff7c4fcfd548b8f

data/lib/rffdb/document.rb

@@ -36,7 +36,9 @@ module RubyFFDB
     def commit
       @read_lock.synchronize do
         @write_lock.synchronize do
-          storage.store(self.class, @id, @data.dup) unless @saved
+          unless @saved
+            storage.store(self.class, @id, @data.dup)
+          end
           @saved = true
         end
       end
@@ -115,6 +117,8 @@ module RubyFFDB
         options.key?(:validate) ? [*options[:validate]] : []
       @structure[name.to_sym][:unique] =
         options.key?(:unique) == true ? true : false
+      @structure[name.to_sym][:index] =
+        options.key?(:index) == true ? true : false
     end
 
     # This DSL method is used to setup the backend {StorageEngine} class and
@@ -199,7 +203,14 @@ module RubyFFDB
     # Query for Documents based on an attribute
     # @see DocumentCollection#where
     def self.where(attribute, value, comparison_method = '==')
-      all.where(attribute, value, comparison_method)
+      if comparison_method.to_s == '==' && indexed_column?(attribute)
+        DocumentCollection.new(
+          storage.index(self, attribute).get(value).collect { |did| load(did) },
+          self
+        )
+      else
+        all.where(attribute, value, comparison_method)
+      end
     end
 
     # Compare two documents
@@ -207,6 +218,17 @@ module RubyFFDB
       id <=> other.id
     end
 
+    # Should this column be indexed?
+    # @return [Boolean]
+    def self.indexed_column?(column)
+      csym = column.to_sym
+      structure.key?(csym) && structure[csym][:index] == true
+    end
+
+    def indexed_column?(column)
+      self.class.send('indexed_column?'.to_sym, column)
+    end
+
     # Uses the defined schema to setup getter and setter methods. Runs
     # validations, format checking, and type checking on setting methods.
     # @todo refactor and comment better
@@ -237,9 +259,14 @@ module RubyFFDB
                      @read_lock.synchronize { committed? }
           @read_lock.synchronize do
             @write_lock.synchronize do
-              @data[key.to_s] = args.last if valid
+              if valid
+                storage.index(self.class, key).delete(@data[key.to_s], id) if indexed_column?(key)
+                @data[key.to_s] = args.last
+                storage.index(self.class, key).put(args.last, id) if indexed_column?(key)
+              end
             end
           end
+          commit if indexed_column?(key) # indexed columns always cause commits
         else
           fail Exceptions::InvalidInput
         end
@@ -282,5 +309,6 @@ module RubyFFDB
         end
       end
     end
+
   end
 end

data/lib/rffdb/index.rb

@@ -0,0 +1,53 @@
+module RubyFFDB
+  class Index
+    def initialize(type, column)
+      @type = type
+      @column = column
+      FileUtils.mkdir_p(File.dirname(file_path))
+      GDBM.open(file_path, 0664, GDBM::WRCREAT) do
+        # Index initialized
+      end
+    end
+
+    def file_path
+      File.join(
+        DB_DATA,
+        @type.to_s.gsub('::', '__'),
+        'indexes',
+        @column.to_s + '.index'
+      )
+    end
+
+    def get(key)
+      GDBM.open(file_path, 0664, GDBM::READER) do |index|
+        Marshal.load index.fetch(key.to_s, Marshal.dump([]))
+      end
+    end
+
+    def put(key, value)
+      previous = get(key)
+      GDBM.open(file_path, 0664, GDBM::WRCREAT) do |index|
+        index[key.to_s] = Marshal.dump((previous + [value]).uniq)
+      end
+    end
+
+    def delete(key, value)
+      previous = get(key)
+      GDBM.open(file_path, 0664, GDBM::WRCREAT) do |index|
+        index[key.to_s] = Marshal.dump((previous - [value]).uniq)
+      end
+    end
+
+    def truncate(key)
+      GDBM.open(file_path, 0664, GDBM::WRCREAT) do |index|
+        index.delete(key.to_s)
+      end
+    end
+
+    def keys
+      GDBM.open(file_path, 0664, GDBM::READER) do |index|
+        index.keys
+      end
+    end
+  end
+end

data/lib/rffdb/storage_engine.rb

@@ -130,5 +130,14 @@ module RubyFFDB
       @caches ||= {}
       @caches[type] ||= CacheProviders::LRUCache.new
     end
+
+    # Allows direct access to an index for a Document type and column
+    # @param type [Document] the document type
+    # @param column [String,Symbol] the column / attribute for the index
+    def self.index(type, column)
+      @indexes ||= {}
+      @indexes[type] ||= {}
+      @indexes[type][column.to_sym] ||= Index.new(type, column.to_sym)
+    end
   end
 end

data/lib/rffdb/version.rb

@@ -1,3 +1,3 @@
 module RubyFFDB
-  VERSION = [0, 0, 8].join('.')
+  VERSION = [0, 1, 0].join('.')
 end

data/lib/rffdb.rb

@@ -1,4 +1,5 @@
 require 'ostruct'
+require 'gdbm'
 require 'rffdb/version'
 require 'rffdb/constants'
 require 'rffdb/exception'
@@ -6,6 +7,7 @@ require 'rffdb/exceptions/cache_exceptions'
 require 'rffdb/exceptions/document_exceptions'
 require 'rffdb/cache_provider'
 require 'rffdb/cache_providers/lru_cache'
+require 'rffdb/index'
 require 'rffdb/storage_engine'
 require 'rffdb/storage_engines/yaml_engine'
 require 'rffdb/document'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rffdb
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors:
 - Jonathan Gnagy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-30 00:00:00.000000000 Z
+date: 2015-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -42,6 +42,7 @@ files:
 - lib/rffdb/exception.rb
 - lib/rffdb/exceptions/cache_exceptions.rb
 - lib/rffdb/exceptions/document_exceptions.rb
+- lib/rffdb/index.rb
 - lib/rffdb/storage_engine.rb
 - lib/rffdb/storage_engines/json_engine.rb
 - lib/rffdb/storage_engines/yaml_engine.rb