active_cabinet 0.1.1 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9adb36f6d291c160a960599e7de79f3f9d08afb3f1536364dfc57c103d81254f
-  data.tar.gz: 5a4bfd4907203cb963f1b7102b14701dcfbcefe44fb8dc2e7f0d4ab87af2f03b
+  metadata.gz: 8dd6fedc3ca5771467baee667ae128cf77f2042394e28169057c3707205391fc
+  data.tar.gz: c89be55b4d4d6d4bbebe6a6044fd24145027454716c4118da2b8c57e75acca9e
 SHA512:
-  metadata.gz: b4df4f37043c8285d3333e21161d4a681f375a8a80e63a57f1c0f797bbd6669617e95d4ccdee653aac9ed7bd488dfe4f10ebe00477c147f0c47c4185415e7a42
-  data.tar.gz: f76c0f806f6aa0d14c392243cea42585ef108daf8a059659344893a21eee7044d0420bc39045eb39c20effe6ebccdfde9d59b664a5393209598837fa08c7eb45
+  metadata.gz: 5cdcf93a07fc0ff445812239c21f5602eb10ce014a242359351bc1d5bb5109964ebaf6a9975891ea090a5efa639c516d14c078ea24c44920664d444308be1f2b
+  data.tar.gz: 2bc8d3fcac688ea0b0625ea28787b3f7d39222e943ae5f0aa1e4887e40fa8899b079fe743536280488313fcdf5c19d961c05ebb8bd6bf0d163ae643174cebc58

data/README.md

@@ -8,7 +8,7 @@ ActiveCabinet
 ---
 
 An ActiveRecord-inspired interface for [HashCabinet], the
-file-basd key-object store.
+file-based key-object store.
 
 It allows you to create models that are stored in a file-based key-value
 store, backed by Ruby's built in [SDBM].
@@ -67,8 +67,8 @@ song.update! year: 1988, artist: 'Metallica'  # this variant also saves
 
 ### Restricting / allowing certain attributes
 
-You may specify required arguments. Records without these attributes will
-not be saved. Note that `id` is always required
+You may specify required attributes. Records without these attributes will
+not be saved. Note that `id` is always required.
 
 ```ruby
 class Song < ActiveCabinet
@@ -114,15 +114,31 @@ song.valid?  # => false
 song.error   # => "invalid attributes: [:artist]"
 ```
 
+### Declaring default attribute values
+
+You may specify default values for some attributes. These attrributes will
+be merged into newly created record instances.
+
+```ruby
+class Song < ActiveCabinet
+  required_attributes :title
+  default_attributes format: :mp3
+end
+
+song = Song.new title: "Moonchild"
+song.format   # => :mp3
+```
+
+
 ### Configuring storage path
 
 By default, `ActiveCabinet` stores all its files (two files per model) in the
 `./db` directory. The file name is determined by the name of the class.
 
-You can override both of these values
+You can override both of these values:
 
 ```ruby
-# Set the based directory for all cabinets
+# Set the base directory for all cabinets
 ActiveCabinet::Config.dir = "cabinets"
 
 # Set the filename of your model

data/lib/active_cabinet.rb

@@ -14,7 +14,7 @@ class ActiveCabinet
   #
   # @param [Hash] attributes record attributes
   def initialize(attributes = {})
-    @attributes = attributes.transform_keys(&:to_sym)
+    @attributes = default_attributes.merge attributes.transform_keys(&:to_sym)
   end
 
   # @!group Attribute Management
@@ -42,6 +42,10 @@ class ActiveCabinet
     self.class.optional_attributes
   end
 
+  def default_attributes
+    self.class.default_attributes
+  end
+
   # Returns +true+ if the object is valid.
   # 
   # @return [Boolean] +true+ if the record is valid.
@@ -63,6 +67,23 @@ class ActiveCabinet
     true
   end
 
+  # @!group Attribute Accessors
+
+  # Returns the attribute value for the given key.
+  #
+  # @return [Object] the attribute value.
+  def [](key)
+    attributes[key]
+  end
+
+  # Sets the attribute value for the given key.
+  #
+  # @param [Symbol] key the attribute key.
+  # @param [Object] value the attribute value.
+  def []=(key, value)
+    attributes[key] = value
+  end
+
   # @!group Dynamic Attribute Accessors
 
   # Provides read/write access to {attributes}
@@ -138,7 +159,7 @@ class ActiveCabinet
   #
   # @param [Hash] new_attributes record attributes
   def update(new_attributes)
-    @attributes = attributes.merge new_attributes
+    @attributes = attributes.merge(new_attributes.transform_keys &:to_sym)
   end
 
   # Update the record with new or modified attributes, and save.

data/lib/active_cabinet/metaclass.rb

@@ -69,24 +69,82 @@ class ActiveCabinet
     end
 
     # Returns an array of records for which the block returns true.
+    # When +query+ is provided, it should be a Hash with a single key and
+    # value. The result will be records that have a matching attribute.
+    #
+    # @example Search using a Hash query
+    #   Song.where artist: "Iron Maiden"
+    #
+    # @example Search using a block
+    #   Song.where { |record| record[:artist] == "Iron Maiden" }
     #
     # @yieldparam [Object] record all record instances.
-    def where
-      all.select { |record| yield record }
+    # @return [Array<Object>] record all record instances.
+    def where(query = nil)
+      if query
+        key, value = query.first
+        all.select { |record| record[key] == value }
+      else
+        all.select { |record| yield record }
+      end
     end
 
     # Returns the record matching the +id+.
+    # When providing a Hash with a single key-value pair, it will return the
+    # first matching object from the respective {where} query.
+    #
+    # @example Retrieve a record by ID
+    #   Song.find 1
+    #   Song[1]
+    #
+    # @example Retrieve a different attributes
+    #   Song.find artist: "Iron Maiden"
+    #   Song[artist: "Iron Maiden"]
     #
     # @return [Object, nil] the object if found, or +nil+.
     def find(id)
-      attributes = cabinet[id]
-      attributes ? new(attributes) : nil
+      if id.is_a? Hash
+        where(id).first
+      else
+        attributes = cabinet[id]
+        attributes ? new(attributes) : nil
+      end
     end
     alias [] find
 
+    # Yields each record to the given block.
+    #
+    # @yieldparam [Object] record all record instances.
+    def each
+      cabinet.each_value do |attributes|
+        yield new(attributes)
+      end
+    end
+
+    # Returns the first record.
+    #
+    # @return [Object] the record.
+    def first
+      find keys.first
+    end
+
+    # Returns the last record.
+    #
+    # @return [Object] the record.
+    def last
+      find keys.last
+    end
+
+    # Returns a random racord.
+    #
+    # @return [Object] the record.
+    def random
+      find keys.sample
+    end
+
     # @!group Deleting Records
 
-    # Deletes a record matching the +id+
+    # Deletes a record matching the +id+.
     #
     # @param [String] id the record ID.
     # @return [Boolean] +true+ on success, +false+ otherwise.
@@ -94,6 +152,14 @@ class ActiveCabinet
       !!cabinet.delete(id)
     end
 
+    # Deletes a record for which the block returns true.
+    #
+    # @example Delete records using a block
+    #   Song.delete_if { |record| record[:artist] == "Iron Maiden" }
+    def delete_if
+      cabinet.delete_if { |key, _value| yield self[key] }
+    end
+
     # Deletes all records.
     def drop
       cabinet.clear
@@ -101,11 +167,13 @@ class ActiveCabinet
 
     # @!group Attribute Management
 
-    # Returns an array containing {required_attributes} and {optional_attributes}.
+    # Returns an array containing the keys of all allowed attributes as
+    # defined by {required_attributes}, {optional_attributes} and 
+    # {default_attributes}.
     #
     # @return [Array<Symbol>] array of required attribute keys.
     def allowed_attributes
-      (optional_attributes || []) + required_attributes
+      (optional_attributes || []) + required_attributes + default_attributes.keys
     end
 
     # Sets the required record attribute names.
@@ -138,6 +206,18 @@ class ActiveCabinet
       end
     end
 
+    # Sets the default record attribute values.
+    #
+    # @param [Hash<Symbol, Object>] **attributes one or more attribute names and values.
+    # @return [Hash<Symbol, Object>] the hash of the default attributes.
+    def default_attributes(args = nil)
+      if args
+        @default_attributes = args
+      else
+        @default_attributes ||= {}
+      end
+    end
+
     # @!group Utilities
 
     # Returns all records as a hash, with record IDs as the keys.

data/lib/active_cabinet/version.rb

@@ -1,3 +1,3 @@
 class ActiveCabinet
-  VERSION = "0.1.1"
+  VERSION = "0.2.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_cabinet
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.4
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-08 00:00:00.000000000 Z
+date: 2021-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hash_cabinet
@@ -17,6 +17,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
 description: ActiveRecord-inspired interface for HashCabinet, the file-basd key-object
   store.
 email: db@dannyben.com
@@ -58,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Database-like interface for HashCabinet