json-orm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 461557a2ba968f8defd11ef7b9d883a90b1266c2a1d6efb25efb90557934c43e
+  data.tar.gz: fe002f32aa2023c804739b45e339cf460806bf5346861cc07e9b5b14d674f05b
+SHA512:
+  metadata.gz: 815c89c584fbd99e2ffeafd23e2c06ca0929652b21d437cd74a50cc775ad1df6a2927191d7fb43fd958e740fac18e45c76ac67735f0d605b910c22208a0b861a
+  data.tar.gz: d382da205f87b4374f434533c70dfc4a12facb2f9b59eeb34bdacb7c702ac9b3c5f147e5d106acd878c7a4fa932635f1993a5b99b2784bcd63db84789d4fe430

data/.gitignore

@@ -0,0 +1,37 @@
+
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+orm.log
+orm.test.log
+test_data.json.backup
+
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+
+# Ignore system files
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Glowing-Pixels-UG
+
+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,80 @@
+# JSON ORM 🚀
+
+`json-orm` is a Ruby gem providing a lightweight, JSON-based Object-Relational Mapping (ORM) system, primarily designed for simple data analytical applications 📊. It includes CRUD operations, transaction support, custom validations, and query chaining, ideal for small-scale projects.
+
+🚧 **Important Development Notice** 🚧
+
+While designed for simplicity and ease of use, `json-orm` hasn't been optimized for file size or fully vetted for reliability as a database storage solution. It's best used in contexts where these factors are not critical.
+
+## Features ✨
+
+- CRUD operations on JSON files
+- Transaction support with commit and rollback
+- Custom attribute validation
+- Query chaining for advanced data filtering
+- Basic logging for debugging
+- Thread-safe operations
+
+## Future Plans
+
+- [ ] Refactor logging
+- [ ] Add tests to DB class
+- [ ] Clean up better after test
+- [ ] Improve test to validate reliability
+- [ ] Add Validations class
+
+## Installation 🔧
+
+Clone the repository and include it in your Ruby project:
+
+```bash
+git clone https://github.com/your-username/jsonorm.git
+```
+
+## Usage 📘
+
+### Basic Operations
+
+```ruby
+db = JSONORM::JSONDB.new('your_data.json')
+orm = JSONORM::ORM.new(db)
+
+orm.create({name: "John Doe", email: "john@example.com"})
+found_record = orm.find(1)
+orm.update(1, {name: "Jane Doe"})
+orm.delete(1)
+```
+
+### Transactions
+
+```ruby
+orm.begin_transaction
+# Operations...
+orm.commit_transaction
+```
+
+### Custom Validations
+
+```ruby
+JSONORM.register_validator(:email) do |value|
+  # Validation logic...
+end
+```
+
+### Query Chaining
+
+```ruby
+results = orm.where(age: 30).where(city: "Wonderland").execute
+```
+
+## Testing with MiniTest 🧪
+
+Tests are located in the `test` directory. Run them using MiniTest to ensure reliability.
+
+## Contributing 🤝
+
+Contributions are welcome. Please ensure to follow Ruby coding style and best practices, and write tests for new functionalities.
+
+## License
+
+Distributed under the MIT License.

data/json-orm.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |spec|
+  spec.name          = "json-orm"
+  spec.version = File.read(File.join(File.dirname(__FILE__), 'lib', 'json-orm', 'version.rb')).match(/VERSION = ['"](.*)['"]/)[1]
+  spec.authors       = ["Damir Mukimov"]
+  spec.email         = ["mukimov.d@gmail.com"]
+
+  spec.summary       = %q{A lightweight, JSON-based ORM for Ruby}
+  spec.description   = %q{Provides basic ORM functionalities like CRUD operations, transaction support, and custom validations.}
+  spec.homepage      = "https://www.glowing-pixels.com/json-orm"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/json-orm/chainable-query.rb

@@ -0,0 +1,17 @@
+module JSONORM
+  class ChainableQuery
+    def initialize(orm, data)
+      @orm = orm
+      @data = data
+    end
+
+    def where(attribute, value)
+      @data = @data.select { |record| record[attribute].to_s == value.to_s }
+      self
+    end
+
+    def execute
+      @data
+    end
+  end
+end

data/lib/json-orm/db.rb

@@ -0,0 +1,69 @@
+require 'json'
+require 'fileutils'
+require 'logger'
+module JSONORM
+  class DB
+    attr_reader :file_path, :backup_path, :logger
+
+    def initialize(file_path, log_file)
+      @file_path = file_path
+      @backup_path = "#{file_path}.backup"
+      @logger = Logger.new(log_file)
+      initialize_file unless File.exist?(file_path)
+    end
+
+    def read
+      with_lock do
+        JSON.parse(File.read(file_path), symbolize_names: true)
+      rescue JSON::ParserError
+        raise "Error parsing JSON data in #{file_path}"
+      end
+    end
+
+  def write(data)
+    with_lock do
+      create_backup
+      File.open(file_path, 'w') { |f| f.write(JSON.pretty_generate(data)) }
+      logger.info("Data written successfully")
+    rescue IOError => e
+      restore_backup
+      logger.error("Error writing to file: #{e.message}")
+      raise "Error writing to file: #{e.message}"
+    end
+  end
+
+
+    private
+
+    def initialize_file
+      with_lock { File.open(file_path, 'w') { |f| f.write('[]') } }
+    end
+
+    def create_backup
+      logger.info("Creating backup")
+      FileUtils.cp(file_path, backup_path)
+    rescue => e
+      logger.error("Failed to create backup: #{e.message}")
+      raise "Failed to create backup: #{e.message}"
+    end
+
+    def restore_backup
+      logger.info("Restoring from backup")
+      FileUtils.cp(backup_path, file_path)
+    rescue => e
+      logger.error("Failed to restore backup: #{e.message}")
+      raise "Failed to restore backup: #{e.message}"
+    end
+
+
+    def with_lock
+      File.open("#{file_path}.lock", 'w') do |f|
+        f.flock(File::LOCK_EX)
+        yield
+      ensure
+        f.flock(File::LOCK_UN)
+      end
+    end
+  end
+end
+

data/lib/json-orm/orm.rb

@@ -0,0 +1,114 @@
+module JSONORM
+  class ORM
+    attr_reader :database, :transaction_data, :logger
+
+    def initialize(database, log_file = 'orm.log')
+      @database = database
+      @transaction_data = nil
+      @attributes = {}
+      @logger = Logger.new(log_file)
+    end
+
+    # # Define a custom validator
+    # ORM.register_validator('email') do |value|
+    #   raise "Invalid email format" unless value.match?(/\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i)
+    # end
+
+    # # Define another custom validator, for example, for 'age'
+    # ORM.register_validator('age') do |value|
+    #   raise "Invalid age" unless value.is_a?(Integer) && value >= 0
+    # end
+
+    def self.register_validator(attribute, &block)
+      @custom_validators ||= {}
+      @custom_validators[attribute] = block
+    end
+
+    def self.custom_validators
+      @custom_validators || {}
+    end
+
+    def all
+      read_data
+    end
+
+    def find(id)
+      read_data.detect { |record| record[:id] == id }
+    end
+
+    def where(attribute, value)
+      ChainableQuery.new(self, read_data).where(attribute, value)
+    end
+
+    def create(attributes)
+      attributes[:id] = next_id unless attributes.key?(:id)
+      validate_attributes!(attributes)
+      transaction_data.push(attributes)
+      attributes
+    end
+
+    def update(id, new_attributes)
+      validate_attributes!(new_attributes, false)
+      transaction_data.map! do |record|
+        if record[:id] == id
+          updated_record = record.merge(new_attributes)
+          validate_attributes!(updated_record, false) # Validate after merge
+          updated_record
+        else
+          record
+        end
+      end
+    end
+
+    def delete(id)
+      transaction_data.reject! { |record| record[:id] == id }
+    end
+
+    def begin_transaction
+      @transaction_data = read_data.dup
+    end
+
+    def commit_transaction
+      logger.info("Starting transaction commit")
+      database.write(transaction_data)
+      logger.info("Transaction committed successfully")
+    rescue => e
+      logger.error("Failed to commit transaction: #{e.message}")
+      raise "Failed to commit transaction: #{e.message}"
+    ensure
+      @transaction_data = nil
+    end
+
+    def rollback_transaction
+      @transaction_data = nil
+    end
+
+    private
+
+    def read_data
+      transaction_data || database.read
+    end
+
+    def next_id
+      max_id = read_data.map { |record| record[:id] }.max || 0
+      max_id + 1
+    end
+
+    def validate_attributes!(attributes, check_id = true)
+      raise "Record must have an id" if check_id && !attributes[:id]
+
+      attributes.each do |key, value|
+        validate_attribute(key, value)
+      end
+    end
+
+    # Update the validation method
+    def validate_attribute(key, value)
+      if self.class.custom_validators[key]
+        self.class.custom_validators[key].call(value)
+      else
+        # Default validations (if any)
+      end
+    end
+  end
+end

data/lib/json-orm/version.rb

@@ -0,0 +1,3 @@
+module JSONORM
+  VERSION = "0.1.0"
+end

data/lib/json-orm.rb

@@ -0,0 +1,9 @@
+require 'logger'
+require_relative 'json-orm/version'
+require_relative 'json-orm/db'
+require_relative 'json-orm/orm'
+require_relative 'json-orm/chainable-query'
+
+module JSONORM
+  # Your gem's core logic or namespace setup
+end

data/test_jsorm.rb

@@ -0,0 +1,109 @@
+require 'minitest/autorun'
+require_relative 'lib/json-orm'
+
+class JSONORMTest < Minitest::Test
+  def setup
+    @db = JSONORM::DB.new('test_data.json', 'orm.test.log')
+    @orm = JSONORM::ORM.new(@db, 'orm.test.log')
+    @orm.begin_transaction
+  end
+
+  def after_tests
+    File.delete('test_data.json.backup') if File.exist?('test_data.backup')
+  end
+
+  def teardown
+    @orm.rollback_transaction
+    File.delete('test_data.json') if File.exist?('test_data.json')
+    File.delete('test_data.json.lock') if File.exist?('test_data.json.lock')
+    File.delete('test_data.json.backup') if File.exist?('test_data.backup')
+  end
+
+  def test_create
+    record = @orm.create({"name": "John Doe", "email": "john@example.com"})
+    assert_equal "John Doe", record[:name]
+    assert_equal "john@example.com", record[:email]
+  end
+
+  def test_read
+    record = @orm.create({"name": "Jane Doe", "email": "jane@example.com"})
+    found = @orm.find(record[:id])
+    assert_equal "Jane Doe", found[:name]
+    assert_equal "jane@example.com", found[:email]
+  end
+
+  def test_update
+    record = @orm.create({"name": "Jim Doe", "email": "jim@example.com"})
+    @orm.update(record[:id], {name: "James Doe"})
+    updated = @orm.find(record[:id])
+
+    assert_equal "James Doe", updated[:name]
+    assert_equal "jim@example.com", updated[:email]
+  end
+
+  def test_delete
+    record = @orm.create({"name": "Jack Doe", "email": "jack@example.com"})
+    @orm.delete(record[:id])
+
+    assert_nil @orm.find(record[:id])
+  end
+
+  def test_transaction_commit
+    @orm.begin_transaction
+    record = @orm.create({"name": "Jill Doe", "email": "jill@example.com"})
+    @orm.commit_transaction
+    assert_equal "Jill Doe", @orm.find(record[:id])[:name]
+  end
+
+  def test_transaction_rollback
+    record = @orm.create({"name": "Joe Doe", "email": "joe@example.com"})
+    @orm.rollback_transaction
+    assert_nil @orm.find(record[:id])
+  end
+
+  def test_valid_email
+    JSONORM::ORM.register_validator(:email) do |value|
+      raise "Invalid email format" unless value.match?(/\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i)
+    end
+
+    assert_raises("Invalid email format") do
+      @orm.create({"name": "Invalid Email", "email": "invalid"})
+    end
+  end
+
+  def test_valid_age
+    JSONORM::ORM.register_validator(:age) do |value|
+      raise "Invalid age" unless value.is_a?(Integer) && value >= 0
+    end
+
+    assert_raises(RuntimeError) do
+      @orm.create({"name": "Invalid Age", "age": -5})
+    end
+  end
+
+  def test_query_chaining
+    @orm.create({"name": "Alice", "age": 30, "city": "Wonderland"})
+    @orm.create({"name": "Bob", "age": 30, "city": "Gotham"})
+    @orm.create({"name": "Charlie", "age": 40, "city": "Wonderland"})
+
+    results = @orm.where(:age, 30).where(:city, "Wonderland").execute
+    assert_equal 1, results.size
+    assert_equal "Alice", results.first[:name]
+  end
+
+
+  def test_error_handling_on_write
+    # Simulate an error during write operation, e.g., invalid data format
+    @orm.create({"name": "Test", "email": "test@example.com"})
+    @orm.database.stub :write, ->(_data) { raise IOError, "Write error" } do
+      assert_raises(RuntimeError) { @orm.commit_transaction }
+    end
+  end
+
+  def test_file_locking
+    # Test to ensure file locking is working (may require mocking)
+    # Mock file locking and simulate concurrent access
+  end
+
+  # Additional tests for other features or edge cases
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: json-orm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Damir Mukimov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Provides basic ORM functionalities like CRUD operations, transaction
+  support, and custom validations.
+email:
+- mukimov.d@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- json-orm.gemspec
+- lib/json-orm.rb
+- lib/json-orm/chainable-query.rb
+- lib/json-orm/db.rb
+- lib/json-orm/orm.rb
+- lib/json-orm/version.rb
+- test_jsorm.rb
+homepage: https://www.glowing-pixels.com/json-orm
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: A lightweight, JSON-based ORM for Ruby
+test_files: []