tiny_db 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ca7805aeadd098311d11d331a7b6426569887f611ef75ca50b64757da82c8d34
+  data.tar.gz: bc0b7661a4b6c1aebb50207be7936df5845cdf37d7232ccf68e90e60f21252be
+SHA512:
+  metadata.gz: 453bf618971940e1939462f633b0ccc458102cd29a56f42c649f09348a8067f52c6963a4bb3d771cb568e6a5c3b03abe05af2aa1afb5a73826a12de90ba54f0f
+  data.tar.gz: dadd128780c94ddb50613c367c6a390b4bad5f9bd0e7e0b0f5dd4dacb81686c8e8f8f54fb446bda1921ef30d82dfca7c6a58057d9eb6bf083a222da9a8ca2877

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+tiny_db.json
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in tiny_db.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    tiny_db (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  tiny_db!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 timothyjb
+
+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,82 @@
+# TinyDb
+
+The purpose of this gem is provide a very simple solution for storing records locally in a text file as json and providing a basic ActivateRecord like interface to access those records.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tiny_db'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install tiny_db
+
+## Usage
+
+### Initialize:
+```ruby
+TinyDb.configure do |config|
+  config.db_file_path = "your_file_name.json"
+end
+```
+
+### Create file:
+Create a file that matches the `db_file_path` provided above.
+`your_file_name.json`
+```
+{}
+```
+
+###
+Example usage:
+```ruby
+class MyModel < TinyDb::FileModel
+  TABLE_NAME = "my_model"
+  ATTRIBUTES = [:id, :name]
+  attr_accessor *ATTRIBUTES
+end
+
+```
+
+
+This snippet:
+```ruby
+record = MyModel.new
+record.name = "Timbo"
+record.save
+```
+
+Would result in the json file being updated to:
+```
+{
+    "my_model": [
+        {
+            "id": 1,
+            "name": "Timbo"
+        }
+    ]
+}
+```
+
+### Methods provided:
+- `.new`
+- `.create(key: value)`
+- `.update(key: value)`
+- `.find_by(key: value)`
+- `.destroy`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Timothyjb/tiny_db.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tiny_db"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/tiny_db/configuration.rb

@@ -0,0 +1,11 @@
+module TinyDb
+  class Configuration
+    attr_accessor :db_file_path
+
+    def initialize
+      @db_file_path = nil
+    end
+
+  end
+end
+

data/lib/tiny_db/db_interface.rb

@@ -0,0 +1,40 @@
+module TinyDb
+  class DbInterface
+    class << self
+
+      def write(file)
+        check_setup_completion
+        File.write("#{db_file_path}", file.to_json)
+      end
+
+      def read
+        check_setup_completion
+        JSON.load File.open("#{db_file_path}", "r")
+      end
+
+      private
+
+      def db_file_path
+        @db_file_path ||= TinyDb.configuration.db_file_path
+      end
+
+      def check_setup_completion
+        raise_missing_config_error if db_file_path.nil?
+        raise_missing_file_error unless file_exists?
+      end
+
+      def raise_missing_config_error
+        raise ConfigError.new("required config 'db_file_path' is missing")
+      end
+
+      def file_exists?
+        File.file?("#{db_file_path}")
+      end
+
+      def raise_missing_file_error
+        raise ConfigError.new("the db file '#{db_file_path}' is missing")
+      end
+
+    end
+  end
+end

data/lib/tiny_db/file_model.rb

@@ -0,0 +1,101 @@
+require 'json'
+require './lib/tiny_db/db_interface.rb'
+module TinyDb
+  class FileModel
+
+    def save
+      id.nil? ? create_record : update_record
+
+      self.class.write_to_file
+    end
+
+    def update(hash)
+      self.class::ATTRIBUTES.each do |attr|
+        self.instance_variable_set("@#{attr.to_s}", hash[attr]) if hash.keys.include?(attr)
+      end
+
+      self.save
+    end
+
+    def destroy
+      self.class.table.delete_if { |x| x[:id] == id }
+
+      self.class.write_to_file
+    end
+
+    private
+
+    def create_record
+      @id = self.class.last_index + 1
+      data = {"id": @id, "name": @name}
+
+      self.class.table << data
+    end
+
+    def update_record
+      data = self.class.table.select{|x| x[:id] == id}.first
+      data[:name] = name
+    end
+
+    class << self
+      def all
+        file[table_name]
+      end
+
+      def find_by(arg)
+        klass = self.new
+
+        key = arg.keys.first
+        value = arg.values.first
+
+        data = table.select{|x| x[key] == value}.first
+
+        self::ATTRIBUTES.each do |attr|
+          klass.instance_variable_set("@#{attr.to_s}", data[attr])
+        end
+
+        klass
+      end
+
+      def create(params)
+        klass = self.new
+
+        self::ATTRIBUTES.each do |attr|
+          klass.instance_variable_set("@#{attr.to_s}", params[attr])
+        end
+
+        klass.save
+      end
+
+      def file
+        @file ||= load_file
+      end
+
+      def table_name
+        self::TABLE_NAME
+      end
+
+      def table
+        file[table_name] = [] if file[table_name].nil?
+
+        file[table_name]
+      end
+
+      def last_index
+        latest_record = table.sort_by{|x| x[:id]}.last
+
+        latest_record.nil? ? 0 : latest_record[:id]
+      end
+
+      def write_to_file
+        TinyDb::DbInterface.write(file)
+      end
+
+      def load_file
+        TinyDb::DbInterface.read
+      end
+
+    end
+
+  end
+end

data/lib/tiny_db/version.rb

@@ -0,0 +1,3 @@
+module TinyDb
+  VERSION = "0.0.0"
+end

data/lib/tiny_db.rb

@@ -0,0 +1,25 @@
+require "tiny_db/version"
+require "tiny_db/file_model"
+require 'tiny_db/configuration'
+
+module TinyDb
+  class ConfigError < StandardError; end
+
+  class << self
+    attr_accessor :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def reset
+      @configuration = Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+  end
+
+end

data/tiny_db.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/tiny_db/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tiny_db"
+  spec.version       = TinyDb::VERSION
+  spec.authors       = ["timothyjb"]
+  spec.email         = ["timothyjbarkley@gmail.com"]
+
+  spec.summary       = "Save and access records in json file"
+  spec.description   = "The purpose of this gem is provide a very simple solution for storing records locally in a text file as json and providing a basic ActivateRecord like interface to access those records"
+  spec.homepage      = "https://rubygems.org/gems/tiny_db"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Timothyjb/tiny_db"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: tiny_db
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- timothyjb
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-01-02 00:00:00.000000000 Z
+dependencies: []
+description: The purpose of this gem is provide a very simple solution for storing
+  records locally in a text file as json and providing a basic ActivateRecord like
+  interface to access those records
+email:
+- timothyjbarkley@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tiny_db.rb
+- lib/tiny_db/configuration.rb
+- lib/tiny_db/db_interface.rb
+- lib/tiny_db/db_setup.rb
+- lib/tiny_db/file_model.rb
+- lib/tiny_db/version.rb
+- tiny_db.gemspec
+homepage: https://rubygems.org/gems/tiny_db
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/tiny_db
+  source_code_uri: https://github.com/Timothyjb/tiny_db
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Save and access records in json file
+test_files: []