dddr 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4880615ef28be24c9e1b6db5209b712d81fa8175d969671ef36446f0605fcda8
+  data.tar.gz: 77f137fe4546db4d6ed5b71966479703c0ccccf494c83fbe880d337b4c8a9cfa
+SHA512:
+  metadata.gz: 802f1e1627a22419f510b9d9bd6f7d030a4de5e904bed64eb4ce6d65212f69e51ead4a600285f72902589185ea1439ced3bcbe873570bc81704e23e0832f141c
+  data.tar.gz: c204fe1368f4df604f285519d61f7fe3b79514cbb2f60fc8db475084a67b23f7f05210ffcd292a7d5eae760b3932b7d678e3c42726365041a2e00455cb6cff40

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-10-29
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at delaney@vidtreone.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Delaney Burke
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,96 @@
+![Alt text](hero.png)
+
+# DDDr: Domain Driven Design Repository
+
+## Overview
+
+"DDDr" is a Ruby gem designed to simplify the implementation of data repositories in a Domain-Driven Design (DDD) architecture. It provides a clean, easy-to-use interface for abstracting data access, so you can focus on domain logic rather than database operations.
+
+## Features
+
+* Easy-to-use Entity and Repository classes
+* Built-in UUID generation for entities
+* In-memory storage using SDBM
+* Date and time tracking for entities
+* CRUD operation support
+* Extensible query and association methods
+
+## Installation
+
+To install, add the gem to your application's @Gemfile@:
+
+<pre>
+gem 'dddr'
+</pre>
+
+Then run:
+
+<pre>
+bundle install
+</pre>
+
+Alternatively, you can install the gem manually:
+
+<pre>
+gem install dddr
+</pre>
+
+## Usage
+
+### Creating an Entity
+
+Include the @Dddr::Entity@ module in your class:
+
+<pre>
+class MyEntity
+  include Dddr::Entity
+  attr_accessor :name, :email
+end
+</pre>
+
+### Using the Repository
+
+<pre>
+repository = MyEntity::Repository.new
+entity = MyEntity.new
+entity.name = "John Doe"
+entity.email = "john.doe@example.com"
+
+# Adding the entity
+uid = repository.add(entity)
+
+# Updating the entity
+entity.name = "Jane Doe"
+updated_entity = repository.update(entity)
+
+# Deleting the entity
+repository.delete(entity)
+
+# Fetching an entity by UID
+fetched_entity = repository.get(uid)
+</pre>
+
+### Custom Queries
+
+Define custom queries using the @queries@ method within your entity class.
+
+<pre>
+class MyEntity
+  include Dddr::Entity
+  attr_accessor :name, :email
+
+  queries do
+    def find_by_email(email)
+      # Custom query logic here
+    end
+  end
+end
+</pre>
+
+You can then execute the custom query like this:
+
+<pre>
+repository = MyEntity::Repository.new
+repository.find_by_email("john.doe@example.com")
+</pre>
+

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/dddr/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Dddr
+  VERSION = "1.0.0"
+end

data/lib/dddr.rb

@@ -0,0 +1,261 @@
+# frozen_string_literal: true
+
+require "sdbm"
+require "securerandom"
+require "date"
+require "ostruct"
+
+require_relative "dddr/version"
+
+module Dddr
+  
+  def self.configuration
+    @configuration ||= OpenStruct.new
+  end
+
+  def self.configure
+    configuration.env = ENV['DDDR_ENV'] || 'development'
+    yield(configuration)
+  end
+
+  class Error < StandardError; end
+
+  module Entity
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    attr_accessor :uid, :created_at, :last_updated_at, :deleted,:deleted_at
+
+    module ClassMethods
+      def queries(&block)
+        const_set(:Queries, Module.new(&block))
+        self::Repository.include(const_get(:Queries)) if const_defined?(:Repository)
+      end
+
+      def associations(repository, &block)
+        const_set(:AssociationMethod, Module.new(&block))
+        repository.include(const_get(:AssociationMethod))
+      end
+
+      def const_missing(name)
+        @@context = self
+
+        if defined?(self::Queries)
+          @@queries = self::Queries
+        end
+
+        if name == :Repository
+          
+          repository_class = Class.new do
+                        
+            def initialize(entity_class = @@context)
+              @entity_class = entity_class
+              env = Dddr.configuration.env
+              `mkdir -p ./.data/#{env}`
+              @name = "./.data/#{env}/#{entity_class.name}"
+              @cache = nil
+              load_cache if @cache.nil?
+            end
+
+            def add(entity)
+              uid = SecureRandom.uuid
+              
+              entity.created_at.nil? ? DateTime.now.to_s : entity.created_at
+              entity.last_updated_at.nil? ? entity.created_at : entity.last_updated_at
+
+              @cache << entity
+
+              SDBM.open(@name) do |db|
+                db[uid] = Marshal.dump(entity.to_hash)
+              end
+              uid
+            end
+
+            alias_method :create, :add
+            alias_method :insert, :add
+            alias_method :put, :add
+            alias_method :append, :add
+            alias_method :store, :add
+
+            def update(entity)
+              entity.last_updated_at = DateTime.now.to_s
+
+              @cache.map! { |e| e.uid == entity.uid ? entity : e }
+
+              SDBM.open(@name) do |db|
+                db[entity.uid] = Marshal.dump(entity.to_hash)
+              end
+              entity
+            end
+
+            alias_method :modify, :update
+            alias_method :change, :update
+            alias_method :edit, :update
+            alias_method :revise, :update
+            alias_method :alter, :update
+
+            def delete(entity)
+              SDBM.open(@name) do |db|
+                entity.deleted = true
+                entity.deleted_at = DateTime.now
+                update(entity)                
+              end
+
+              @cache.reject! { |e| e.uid == entity.uid }
+
+            end
+            
+            def undelete(uid)
+              e = bin.find{|e| e.uid == uid}
+              e.deleted = false
+              e.deleted_at = nil
+              update(e)
+            end
+            # Aliases for 'undelete' method
+            alias restore undelete
+            alias recover undelete
+            
+
+            def undelete_all
+              bin.each do |e|
+                restore(e.uid)
+              end
+            end
+
+            alias restore_all undelete_all
+            alias recover_all  undelete_all
+            
+
+            alias_method :remove, :delete
+            alias_method :erase, :delete
+            alias_method :discard, :delete
+            alias_method :destroy, :delete
+            alias_method :wipe, :delete
+
+            def get(uid)
+              all.find { |e| e.uid == uid }
+            end
+
+            alias_method :fetch, :get
+            alias_method :retrieve, :get
+            alias_method :find, :get
+            alias_method :acquire, :get
+            alias_method :obtain, :get
+
+            def reset!
+              if Dddr.configuration.env == "test"
+                all.map { |e| delete(e) }
+                return                
+              end
+              puts "Warning: This will delete all records. Are you sure? (y/n)"
+              confirmation = gets.chomp
+
+              if confirmation.downcase == "y"
+                puts "Type 'reset' to confirm."
+                final_confirmation = gets.chomp
+
+                if final_confirmation.downcase == "reset"
+                  all.map { |e| delete(e) }
+                  puts "All records have been deleted."
+                else
+                  puts "Reset cancelled."
+                end
+              else
+                puts "Reset cancelled."
+              end
+            end
+
+            def count
+              all.count
+            end
+
+            def all
+              load_cache if @cache.nil?
+              @cache
+            end
+
+            def clear_cache
+              @cache = nil
+            end
+          
+            def refresh_cache
+              load_cache
+            end
+          
+
+            def load_cache
+              result = []
+              SDBM.open(@name) do |db|
+                db.each do |key, value|
+                  data = Marshal.load(value)
+                  entity = @entity_class.new
+                  entity.from_hash(key, data)
+                  next if entity.deleted
+                  result << entity
+                end
+              end
+              @cache = result
+            end
+
+            def bin 
+              result = []
+              SDBM.open(@name) do |db|
+                db.each do |key, value|
+                  data = Marshal.load(value)
+                  entity = @entity_class.new
+                  entity.from_hash(key, data)
+                  next unless entity.deleted
+                  result << entity
+                end
+              end
+              result
+            end
+
+            def empty_bin
+              SDBM.open(@name) do |db|
+                bin.each do |e|
+                  db.delete(e.uid)
+                end
+              end              
+            end
+          end
+
+          if defined?(@@queries)
+            repository_class.include @@queries
+          end
+
+          const_set(name, repository_class)
+        else
+          super
+        end
+      end
+    end
+
+    def to_hash
+      result = {}
+      instance_variables.each do |var_name|
+        attribute_name = var_name.to_s[1..].to_sym
+        result[attribute_name] = instance_variable_get(var_name)
+      end
+      result
+    end
+
+    def new?
+      return true if created_at.nil?
+      false
+    end
+
+    def from_hash(uid, data_hash)
+      self.uid = uid
+      data_hash.each do |attribute, value|
+        attribute = attribute.to_sym
+        if respond_to?("#{attribute}=")
+          send("#{attribute}=", value)
+        end
+      end
+    end
+  end
+
+  # Your code goes here...
+end

data/sig/dddr.rbs

@@ -0,0 +1,4 @@
+module Dddr
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: dddr
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Delaney Burke
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sdbm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: |
+  DDDr stands for Domain Driven Design Data Repository. It's a Ruby gem that simplifies the implementation of data repositories in a Domain-Driven Design (DDD) architecture.
+  It offers a clean interface for abstracting data access, allowing you to focus on your domain logic rather than database operations.
+  With DDDr, you can easily swap out data sources without affecting your core business logic.
+email:
+- delaney@vidtreone.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- hero.png
+- lib/dddr.rb
+- lib/dddr/version.rb
+- sig/dddr.rbs
+homepage: http://zero2one.ee/gems/dddr
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://zero2one.ee/gems/dddr
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.21
+signing_key:
+specification_version: 4
+summary: Domain Driven Design Data Repository
+test_files: []