familia 0.10.2 → 1.0.0.pre.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8dbe9434bda5d5e9c9e95b094a29bfce543067013cb12b629a85f46c06a7a15
-  data.tar.gz: b683e7b892a3d20d3d8174541bae36f1ad730928093177403f3240b307a202c8
+  metadata.gz: b4f3c02cad65603669b086ec26f31512004e939da510fec97fcc3803f132e5f5
+  data.tar.gz: cdd710ea75ff3c6ce3ccb88caef97226ee9fb549435fce605433621a8583f06d
 SHA512:
-  metadata.gz: 5980af9f8c2c677871bdf68823501eb6fdbfb416c723a20c7a4efe38783a1299740254f4bb85ccf50be27378c1acca10dda6a100d0b478d8a2e80e633b41b4d1
-  data.tar.gz: 79845a5aa30366128606f784ea1187b64653cceb6466b0a459988e0ca46aa31cb8892640ed2ba332511ebcd9af5cd48d24bb48eddcbd3670ab559d2718786ee8
+  metadata.gz: '058e49695798298238523d571a4d21b47234874b47af018fdb085d22a430fa8db2ca725cb3103e0c8eee309b000eea7598cc4e9aed00373191d393af8d4ab27d'
+  data.tar.gz: 9ff11c6c341d540e69ddb9d0518b67c9463b2248899b6f74a94a92b609140ed064e303e3559a455847727d5f7581aa41fccce5fdaac5effb5d74a30202e75721

data/.gitignore

@@ -1,6 +1,7 @@
 .DS_Store
 .bundle
 .byebug*
+.prompts
 .history
 .devcontainer
 .vscode

data/.pre-commit-config.yaml

@@ -4,7 +4,7 @@
 # Initial setup:
 #
 #   0. Install the pre-commit framework (if it isn't already on your system):
-
+#
 #         $ pip install pre-commit
 #
 #   1. Install the git hook:

data/.rubocop.yml

@@ -0,0 +1,75 @@
+
+##
+# This is the RuboCop configuration file.
+# It contains the rules and settings for the RuboCop linter.
+#
+# Enable/disable the cops individually. For more information,
+# refer to the RuboCop documentation:
+# https://docs.rubocop.org/rubocop/cops.html
+#
+# Running `rubocop --regenerate-todo` will update the todo file
+# with the latest state of the onion (using the same options
+# as those documented at the top of the todo file). This is
+# useful for a gradual migration of the codebase.
+#
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-performance
+  - rubocop-thread_safety
+
+AllCops:
+  NewCops: enable
+  UseCache: true
+  MaxFilesInCache: 100
+  TargetRubyVersion: 3.0
+  Exclude:
+    - 'migrate/**/*.rb'
+    - 'migrate/*.rb'
+    - 'try/**/*'
+    - 'try/*.rb'
+    - 'vendor/**/*'
+
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: true
+
+Gemspec/DevelopmentDependencies:
+  Enabled: true
+
+Layout/HashAlignment:
+  Enabled: false
+
+Lint/Void:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+  Max: 20
+
+Metrics/ClassLength:
+  Enabled: true
+  Max: 200
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: true
+  Max: 40
+  CountAsOne: ['method_call']
+
+Metrics/ModuleLength:
+  Enabled: true
+  Max: 250
+  CountAsOne: ['method_call']
+
+Performance/Size:
+  Enabled: true
+  Exclude:
+  #   - lib/example.rb
+
+Style/NegatedIfElseCondition:
+  Enabled: true
+
+Naming/AsciiIdentifiers:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,63 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-08-12 20:49:29 UTC using RuboCop version 1.65.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, AllowedGems, Include.
+# SupportedStyles: Gemfile, gems.rb, gemspec
+# Include: **/*.gemspec, **/Gemfile, **/gems.rb
+Gemspec/DevelopmentDependencies:
+  Exclude:
+    - 'familia.gemspec'
+
+# Offense count: 1
+# Configuration parameters: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'familia.gemspec'
+
+# Offense count: 5
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to
+Naming/MethodParameterName:
+  Exclude:
+    - 'lib/familia/core_ext.rb'
+    - 'lib/familia/types/list.rb'
+    - 'lib/familia/types/sorted_set.rb'
+    - 'lib/familia/types/unsorted_set.rb'
+
+# Offense count: 1
+# Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros.
+# NamePrefix: is_, has_, have_
+# ForbiddenPrefixes: is_, has_, have_
+# AllowedMethods: is_a?
+# MethodDefinitionMacros: define_method, define_singleton_method
+Naming/PredicateName:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/familia/types/hashkey.rb'
+
+# Offense count: 6
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/familia/errors.rb'
+    - 'lib/familia/types/hashkey.rb'
+    - 'lib/familia/types/list.rb'
+    - 'lib/familia/types/sorted_set.rb'
+    - 'lib/familia/types/string.rb'
+    - 'lib/familia/types/unsorted_set.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: MaxUnannotatedPlaceholdersAllowed, AllowedMethods, AllowedPatterns.
+# SupportedStyles: annotated, template, unannotated
+Style/FormatStringToken:
+  EnforcedStyle: unannotated

data/Gemfile

@@ -1,8 +1,13 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
 
 group :development, :test do
   gem 'pry-byebug', '~> 3.10.1', require: false
-  gem 'tryouts', '~> 2.3', require: false
+  gem 'rubocop', require: false
+  gem 'rubocop-performance', require: false
+  gem 'rubocop-thread_safety', require: false
+  gem 'tryouts', '~> 2.4', require: false
 end

data/Gemfile.lock

@@ -1,39 +1,67 @@
 PATH
   remote: .
   specs:
-    familia (0.10.2)
-      gibbler (~> 1.0.0)
-      multi_json (~> 1.15)
+    familia (1.0.0.pre.rc2)
       redis (>= 4.8.1, < 6.0)
-      storable (~> 0.10.0)
-      uri-redis (>= 1.3.0)
+      uri-redis (~> 1.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    attic (1.0.1)
-      rake (~> 13.0.6)
+    ast (2.4.2)
     byebug (11.1.3)
     coderay (1.1.3)
     connection_pool (2.4.1)
-    gibbler (1.0.0)
-      attic (~> 1.0)
-      rake (~> 13.0)
+    drydock (0.6.9)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
     method_source (1.1.0)
-    multi_json (1.15.0)
+    parallel (1.25.1)
+    parser (3.3.4.0)
+      ast (~> 2.4.1)
+      racc
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
     pry-byebug (3.10.1)
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
-    rake (13.0.6)
+    racc (1.8.0)
+    rainbow (3.1.1)
     redis (5.2.0)
       redis-client (>= 0.22.0)
     redis-client (0.22.2)
       connection_pool
+    regexp_parser (2.9.2)
+    rexml (3.3.2)
+      strscan
+    rubocop (1.65.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.21.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-thread_safety (0.5.1)
+      rubocop (>= 0.90.0)
+    ruby-progressbar (1.13.0)
     storable (0.10.0)
-    tryouts (2.3.1)
+    strscan (3.1.0)
+    sysinfo (0.10.0)
+      drydock (< 1.0)
+      storable (~> 0.10)
+    tryouts (2.4.1)
+      sysinfo (~> 0.10)
+    unicode-display_width (2.5.0)
     uri-redis (1.3.0)
 
 PLATFORMS
@@ -42,9 +70,13 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  byebug (~> 11.0)
   familia!
   pry-byebug (~> 3.10.1)
-  tryouts (~> 2.3)
+  rubocop
+  rubocop-performance
+  rubocop-thread_safety
+  tryouts (~> 2.4)
 
 BUNDLED WITH
-   2.5.14
+   2.5.13

data/README.md

@@ -1,32 +1,84 @@
-# Familia - 0.10.2
+# Familia - 1.0.0-rc2 (August 2024)
 
 **Organize and store ruby objects in Redis. A Ruby ORM for Redis.**
 
+Familia provides a powerful and flexible way to interact with Redis using Ruby objects. It's designed to make working with Redis as natural as working with Ruby classes.
+
 ## Installation
 
 Get it in one of the following ways:
 
-* In your Gemfile: `gem 'familia', '>= 0.10.2'`
+* In your Gemfile: `gem 'familia', '>= 1.0.0-rc2'`
 * Install it by hand: `gem install familia`
 * Or for development: `git clone git@github.com:delano/familia.git`
 
 ## Basic Example
 
 ```ruby
-    class Flower < Storable
-      include Familia
-      index [:token, :name]
-      field  :token
-      field  :name
-      list   :owners
-      set    :tags
-      zset   :metrics
-      hash   :props
-      string :value, :default => "GREAT!"
-    end
+class Flower < Familia::Horreum
+  identifier :generate_id
+  field   :token
+  field   :name
+  list    :owners
+  set     :tags
+  zset    :metrics
+  hashkey :props
+  string  :counter
+end
+```
+
+## What Familia::Horreum Can Do
+
+Familia::Horreum provides a powerful abstraction layer over Redis, allowing you to:
+
+1. **Define Redis-backed Ruby Classes**: As shown in the example, you can easily define classes that map to Redis structures.
+
+2. **Use Various Redis Data Types**: Familia supports multiple Redis data types:
+   - `field`: For simple key-value pairs
+   - `list`: For Redis lists
+   - `set`: For Redis sets
+   - `zset`: For Redis sorted sets
+   - `hashkey`: For Redis hashes
+   - `string`: For Redis strings
+
+3. **Custom Identifiers**: Use the `identifier` method to specify how objects are uniquely identified in Redis.
+
+4. **Automatic Serialization**: Familia handles the serialization and deserialization of your objects to and from Redis.
+
+5. **Redis Commands as Ruby Methods**: Interact with Redis using familiar Ruby syntax instead of raw Redis commands.
+
+6. **TTL Support**: Set expiration times for your objects in Redis.
+
+7. **Flexible Configuration**: Configure Redis connection details, serialization methods, and more.
+
+## Advanced Features
+
+- **API Versioning**: Familia supports API versioning to help manage changes in your data model over time.
+- **Custom Serialization**: You can specify custom serialization methods for your objects.
+- **Redis URI Support**: Easily connect to Redis using URI strings.
+- **Debugging Tools**: Built-in debugging capabilities to help troubleshoot Redis interactions.
+
+## Usage Example
+
+```ruby
+# Create a new Flower
+rose = Flower.new
+rose.name = "Red Rose"
+rose.tags << "romantic" << "red"
+rose.owners.push("Alice", "Bob")
+rose.save
+
+# Retrieve a Flower
+retrieved_rose = Flower.get(rose.identifier)
+puts retrieved_rose.name  # => "Red Rose"
+puts retrieved_rose.tags.members  # => ["romantic", "red"]
 ```
 
 ## More Information
 
 * [Github](https://github.com/delano/familia)
 * [Rubygems](https://rubygems.org/gems/familia)
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.

data/VERSION.yml

@@ -1,4 +1,5 @@
 ---
-:MAJOR: 0
-:MINOR: 10
-:PATCH: 2
+:MAJOR: 1
+:MINOR: 0
+:PATCH: 0
+:PRE: rc2

data/familia.gemspec

@@ -1,23 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'lib/familia/version'
+
 Gem::Specification.new do |spec|
-  spec.name        = "familia"
-  spec.version     = "0.10.2"
-  spec.summary     = "An ORM for Redis in Ruby."
+  spec.name        = 'familia'
+  spec.version     = Familia::VERSION.to_s
+  spec.summary     = 'An ORM for Redis in Ruby.'
   spec.description = "Familia: #{spec.summary}. Organize and store ruby objects in Redis"
-  spec.authors     = ["Delano Mandelbaum"]
-  spec.email       = "gems@solutious.com"
-  spec.homepage    = "https://github.com/delano/familia"
-  spec.license     = "MIT"
+  spec.authors     = ['Delano Mandelbaum']
+  spec.email       = 'gems@solutious.com'
+  spec.homepage    = 'https://github.com/delano/familia'
+  spec.license     = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.8")
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.8')
 
   spec.add_dependency 'redis', '>= 4.8.1', '< 6.0'
   spec.add_dependency 'uri-redis', '~> 1.3'
-  spec.add_dependency 'gibbler', '~> 1.0.0'
-  spec.add_dependency 'storable', '~> 0.10.0'
-  spec.add_dependency 'multi_json', '~> 1.15'
+
+  # byebug only works with MRI
+  spec.add_development_dependency 'byebug', '~> 11.0' if RUBY_ENGINE == 'ruby'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/familia/base.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+#
+module Familia
+  # A common module for Familia::RedisType and Familia::Horreum to include.
+  #
+  # This allows us to use a single comparison to check if a class is a
+  # Familia class. e.g.
+  #
+  #     klass.include?(Familia::Base) # => true
+  #     klass.ancestors.member?(Familia::Base) # => true
+  #
+  # @see Familia::Horreum
+  # @see Familia::RedisType
+  #
+  module Base
+    @features = nil
+    @dump_method = :to_json
+    @load_method = :from_json
+
+    class << self
+      attr_reader :features
+      attr_accessor :dump_method, :load_method
+
+      def add_feature(klass, methname)
+        @features ||= {}
+        Familia.ld "[#{self}] Adding feature #{klass} as #{methname}"
+
+        features[methname] = klass
+      end
+    end
+  end
+end

data/lib/familia/connection.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require_relative '../../lib/redis_middleware'
+
+#
+module Familia
+  @uri = URI.parse 'redis://127.0.0.1'
+  @redis_clients = {}
+
+  # The Connection module provides Redis connection management for Familia.
+  # It allows easy setup and access to Redis clients across different URIs.
+  module Connection
+    # @return [Hash] A hash of Redis clients, keyed by server ID
+    attr_reader :redis_clients
+
+    # @return [URI] The default URI for Redis connections
+    attr_reader :uri
+
+    # @return [Boolean] Whether Redis command logging is enabled
+    attr_accessor :enable_redis_logging
+
+    # @return [Boolean] Whether Redis command counter is enabled
+    attr_accessor :enable_redis_counter
+
+    # Establishes a connection to a Redis server.
+    #
+    # @param uri [String, URI, nil] The URI of the Redis server to connect to.
+    #   If nil, uses the default URI.
+    # @return [Redis] The connected Redis client
+    # @example
+    #   Familia.connect('redis://localhost:6379')
+    def connect(uri = nil)
+      uri = URI.parse(uri) if uri.is_a?(String)
+      uri ||= Familia.uri
+
+      raise ArgumentError, 'No URI specified' unless uri
+
+      conf = uri.conf
+
+      if Familia.enable_redis_logging
+        RedisLogger.logger = Familia.logger
+        RedisClient.register(RedisLogger)
+      end
+
+      if Familia.enable_redis_counter
+        # NOTE: This middleware stays thread-safe with a mutex so it will
+        # be a bottleneck when enabled in multi-threaded environments.
+        RedisClient.register(RedisCommandCounter)
+      end
+
+      redis = Redis.new(conf)
+      @redis_clients[uri.serverid] = redis
+    end
+
+    # Retrieves or creates a Redis client for the given URI.
+    #
+    # @param uri [String, URI, nil] The URI of the Redis server.
+    #   If nil, uses the default URI.
+    # @return [Redis] The Redis client for the specified URI
+    # @example
+    #   Familia.redis('redis://localhost:6379')
+    def redis(uri = nil)
+      if uri.is_a?(Integer)
+        tmp = Familia.uri
+        tmp.db = uri
+        uri = tmp
+      elsif uri.is_a?(String)
+        uri &&= URI.parse uri
+      end
+      uri ||= Familia.uri
+      connect(uri) unless @redis_clients[uri.serverid]
+      @redis_clients[uri.serverid]
+    end
+
+    # Sets the default URI for Redis connections.
+    #
+    # @param v [String, URI] The new default URI
+    # @example
+    #   Familia.uri = 'redis://localhost:6379'
+    def uri=(val)
+      @uri = val.is_a?(URI) ? v : URI.parse(val)
+    end
+
+    alias url uri
+    alias url= uri=
+  end
+end