familia 1.0.0.pre.rc1 → 1.0.0.pre.rc3

data/lib/familia/refinements.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'logger'
+
+# Controls whether tracing is enabled via an environment variable
+FAMILIA_TRACE = ENV.fetch('FAMILIA_TRACE', 'false').downcase
+
+# FlexibleHashAccess
+#
+# This module provides a refinement for the Hash class to allow flexible access
+# to hash keys using either strings or symbols interchangeably for reading values.
+#
+# Note: This refinement only affects reading from the hash. Writing to the hash
+# maintains the original key type.
+#
+# @example Using the refinement
+#   using FlexibleHashAccess
+#
+#   h = { name: "Alice", "age" => 30 }
+#   h[:name]   # => "Alice"
+#   h["name"]  # => "Alice"
+#   h[:age]    # => 30
+#   h["age"]   # => 30
+#
+#   h["job"] = "Developer"
+#   h[:job]    # => "Developer"
+#   h["job"]   # => "Developer"
+#
+#   h[:salary] = 75000
+#   h[:salary] # => 75000
+#   h["salary"] # => nil (original key type is preserved)
+#
+module FlexibleHashAccess
+  refine Hash do
+    ##
+    # Retrieves a value from the hash using either a string or symbol key.
+    #
+    # @param key [String, Symbol] The key to look up
+    # @return [Object, nil] The value associated with the key, or nil if not found
+    def [](key)
+      super(key.to_s) || super(key.to_sym)
+    end
+  end
+end
+
+# LoggerTraceRefinement
+#
+# This module adds a 'trace' log level to the Ruby Logger class.
+# It is enabled when the FAMILIA_TRACE environment variable is set to
+# '1', 'true', or 'yes' (case-insensitive).
+#
+# @example Enabling trace logging
+#   # Set environment variable
+#   ENV['FAMILIA_TRACE'] = 'true'
+#
+#   # In your Ruby code
+#   require 'logger'
+#   using LoggerTraceRefinement
+#
+#   logger = Logger.new(STDOUT)
+#   logger.trace("This is a trace message")
+#
+module LoggerTraceRefinement
+  # Indicates whether trace logging is enabled
+  ENABLED = %w[1 true yes].include?(FAMILIA_TRACE)
+
+  # The numeric level for trace logging (same as DEBUG)
+  TRACE = 0 unless defined?(TRACE)
+
+  refine Logger do
+    ##
+    # Logs a message at the TRACE level.
+    #
+    # @param progname [String] The program name to include in the log message
+    # @yield A block that evaluates to the message to log
+    # @return [true] Always returns true
+    #
+    # @example Logging a trace message
+    #   logger.trace("MyApp") { "Detailed trace information" }
+    def trace(progname = nil, &block)
+      Thread.current[:severity_letter] = 'T'
+      add(LoggerTraceRefinement::TRACE, nil, progname, &block)
+    ensure
+      Thread.current[:severity_letter] = nil
+    end
+  end
+end

data/lib/familia/types/hashkey.rb

@@ -53,19 +53,19 @@ module Familia
       multi_from_redis(*el)
     end
 
-    def all
+    def hgetall
       # TODO: Use from_redis. Also name `all` is confusing with
       # Onetime::Customer.all which returns all customers.
       redis.hgetall rediskey
     end
-    alias to_hash all
-    alias clone all
+    alias all hgetall
 
-    def has_key?(field)
+    def key?(field)
       redis.hexists rediskey, field
     end
-    alias include? has_key?
-    alias member? has_key?
+    alias has_key? key?
+    alias include? key?
+    alias member? key?
 
     def delete(field)
       redis.hdel rediskey, field

data/lib/familia/types/list.rb

@@ -18,6 +18,7 @@ module Familia
       update_expiration
       self
     end
+    alias append push
 
     def <<(val)
       push val
@@ -31,6 +32,7 @@ module Familia
       update_expiration
       self
     end
+    alias prepend unshift
 
     def pop
       from_redis redis.rpop(rediskey)

data/lib/familia/utils.rb

@@ -64,8 +64,8 @@ module Familia
       Time.at(rounded).utc.strftime(pattern)
     end
 
-    def generate_sha_hash(elements)
-      concatenated_string = Familia.join(elements)
+    def generate_sha_hash(*elements)
+      concatenated_string = Familia.join(*elements)
       DIGEST_CLASS.hexdigest(concatenated_string)
     end
 
@@ -113,10 +113,6 @@ module Familia
           Familia.trace :TOREDIS_DISTINGUISHER, redis, "isabase", caller(1..1) if Familia.debug?
           value_to_distinguish.identifier
 
-        elsif dump_method && value_to_distinguish.respond_to?(dump_method)
-          Familia.trace :TOREDIS_DISTINGUISHER, redis, "#{value_to_distinguish.class}##{dump_method}", caller(1..1) if Familia.debug?
-          value_to_distinguish.send(dump_method)
-
         else
           Familia.trace :TOREDIS_DISTINGUISHER, redis, "else2 #{strict_values}", caller(1..1) if Familia.debug?
           raise Familia::HighRiskFactor, value_to_distinguish if strict_values

data/lib/familia.rb

@@ -5,6 +5,7 @@ require 'redis'
 require 'uri/redis'
 
 require_relative 'familia/core_ext'
+require_relative 'familia/refinements'
 require_relative 'familia/errors'
 require_relative 'familia/version'
 

data/try/27_redis_horreum_try.rb

@@ -38,3 +38,56 @@ Familia.debug = true
 ## Remove the key
 @hashkey.clear
 #=> 1
+
+## Horreum objects can update and save their fields (1 of 2)
+@customer.name = 'John Doe'
+#=> "John Doe"
+
+## Horreum objects can update and save their fields (2 of 2)
+@customer.save
+#=> true
+
+## Horreum object fields have a fast writer method (1 of 2)
+Familia.trace :LOAD, @customer.redis, @customer.redisuri, caller if Familia.debug?
+@customer.name! 'Jane Doe'
+#=> 0
+
+## Horreum object fields have a fast writer method (2 of 2)
+@customer.refresh!
+@customer.name
+#=> "Jane Doe"
+
+## Unsaved changes are lost when an object reloads
+@customer.name = 'John Doe'
+@customer.refresh!
+@customer.name
+#=> "Jane Doe"
+
+## Horreum objects can be destroyed
+@customer.destroy!
+#=> true
+
+## All horrerum objects have a key field
+@customer.key
+#=> @identifier
+
+## Even ones that didn't define it
+@cd = CustomDomain.new "www.example.com", "@identifier"
+@cd.key
+#=> nil
+
+## We can call #identifier directly if we want to "lasy load" the unique identifier
+@cd.identifier
+#=> "7565befd"
+
+## The #key field will still be nil
+@cd.key
+#=> nil
+
+## But once we save
+@cd.save
+#=> true
+
+## The key will be set
+@cd.key
+#=> "7565befd"

data/try/test_helpers.rb

@@ -70,6 +70,7 @@ class Customer < Familia::Horreum
   field :email
   field :role
   field :key
+  field :name
   field :passphrase_encryption
   field :passphrase
   field :verified
@@ -154,6 +155,7 @@ class CustomDomain < Familia::Horreum
   field :trd
   field :tld
   field :sld
+  # No :key field (so we can test hte behaviour in Horreum#initialize)
   field :txt_validation_host
   field :txt_validation_value
   field :status
@@ -167,7 +169,11 @@ class CustomDomain < Familia::Horreum
   # the customer ID. This is used to ensure that the same domain can't be
   # added twice by the same customer while avoiding collisions between customers.
   def derive_id
-    Familia.generate_sha_hash(:display_domain, :custid).slice(0, 8)
+    elements = [
+      display_domain,
+      custid
+    ]
+    Familia.generate_sha_hash(*elements).slice(0, 8)
   end
 end
 @d = CustomDomain.new
@@ -178,6 +184,8 @@ class Limiter < Familia::Horreum
 
   identifier :name
   field :name
+  # No :key field (so we can test hte behaviour in Horreum#initialize)
+
   string :counter, :ttl => 1.hour, :quantize => [10.minutes, '%H:%M', 1302468980]
 
   def identifier

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: familia
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.rc1
+  version: 1.0.0.pre.rc3
 platform: ruby
 authors:
 - Delano Mandelbaum
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-15 00:00:00.000000000 Z
+date: 2024-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -97,6 +97,7 @@ files:
 - lib/familia/redistype.rb
 - lib/familia/redistype/commands.rb
 - lib/familia/redistype/serialization.rb
+- lib/familia/refinements.rb
 - lib/familia/settings.rb
 - lib/familia/types/hashkey.rb
 - lib/familia/types/list.rb
@@ -141,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
+rubygems_version: 3.5.15
 signing_key:
 specification_version: 4
 summary: An ORM for Redis in Ruby.