active_cabinet 0.1.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 774c19d270fc5767611ad0b42eaa06f7b98c3bae2bdfa2e4f8f0e382629daf59
-  data.tar.gz: 4d48778ba0cd2294b047d0292c87e963c4c16823a1effe6f93a207afeb182713
+  metadata.gz: c0e758ab665623b4914ee47333fc31eed359da51fe9b1739c221fec4ed76a5c7
+  data.tar.gz: 4c41f042136643bc66014e4c55b7276c8cdeb1ecffebbe021ab34b9ea70e8d61
 SHA512:
-  metadata.gz: 9e9e84e8ae733967cee88489b45020c68609ef67172d5a0c8b9e3540d946d8a0a9d32e139362f95a3d0aa3f545c1a612c1993f3a4327f67559506d98c3ab8620
-  data.tar.gz: 3a9a02b9f0c0df27479db9ba4f6ae8c6e17cd3f10caad24fe00e669c7402f19b3dddc4461553d25e9b7cf61588b4bf668cf9b194bbf3cce27a319de7c2bb297f
+  metadata.gz: e294347a1f3dfa3148c93220734eaacb8d800a42a53f0c1cf15e6e5c41628cb643d087672c7a29944a1364bdd5aaec6bed7b9f1e612f70ffd93322643672600a
+  data.tar.gz: '0492f1da68709b7c72a8f329b049fa53a24a2ae44639d34594cc72471ae9df478a3713574a0980bcbfc4b8672a765cdcb5714b1b65c1b18c44aa2375a3f4ae4a'

data/README.md

@@ -1,14 +1,20 @@
 ActiveCabinet
 ==================================================
 
+[![Gem Version](https://badge.fury.io/rb/active_cabinet.svg)](https://badge.fury.io/rb/active_cabinet)
+[![Build Status](https://github.com/DannyBen/active_cabinet/workflows/Test/badge.svg)](https://github.com/DannyBen/active_cabinet/actions?query=workflow%3ATest)
+[![Maintainability](https://api.codeclimate.com/v1/badges/a4302349baf2d20e2af8/maintainability)](https://codeclimate.com/github/DannyBen/active_cabinet/maintainability)
+
 ---
 
-ActiveCabinet is an ActiveRecord-inspired interface for HashCabinet, the
-file-basd key-object store.
+An ActiveRecord-inspired interface for [HashCabinet], the
+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].
 
+ActiveCabinet is a tiny library, with only [HashCabinet] as a dependency.
+
 ---
 
 Installation
@@ -61,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
@@ -83,7 +89,7 @@ song.valid?   # => true
 
 You can also restrict the allowed optional attributes
 
-```
+```ruby
 class Song < ActiveCabinet
   required_attributes :title
   optional_attributes :artist
@@ -108,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
@@ -125,12 +147,18 @@ class Song < ActiveCabinet
 end
 ```
 
-For the full documentation, see the [Documentation on RubyDoc][docs]
+## Documentation
 
+[Documentation on RubyDoc][docs]
 
-[SDBM]: https://ruby-doc.org/stdlib-2.6.3/libdoc/sdbm/rdoc/SDBM.html
-[docs]: https://rubydoc.info/gems/active_cabinet
+## Contributing / Support
+
+If you experience any issue, have a question or a suggestion, or if you wish
+to contribute, feel free to [open an issue][issues].
 
 ---
 
-[SDBM]: https://ruby-doc.org/stdlib-2.7.1/libdoc/sdbm/rdoc/SDBM.html
+[SDBM]: https://ruby-doc.org/stdlib-2.7.1/libdoc/sdbm/rdoc/SDBM.html
+[docs]: https://rubydoc.info/gems/active_cabinet
+[issues]: https://github.com/DannyBen/active_cabinet/issues
+[HashCabinet]: https://github.com/DannyBen/hash_cabinet

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.
@@ -101,11 +159,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 +198,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.0"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_cabinet
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-08 00:00:00.000000000 Z
+date: 2020-12-30 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
@@ -39,7 +45,10 @@ files:
 homepage: https://github.com/dannyben/active_cabinet
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/DannyBen/active_cabinet/issues
+  documentation_uri: https://rubydoc.info/gems/active_cabinet
+  source_code_uri: https://github.com/dannyben/active_cabinet
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -55,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