simple-file-db 0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 92b1837a51f599b3a94500c9c3d8c2f2ff3240e9c2d0d8ba80cb92a72fee8336
+  data.tar.gz: 59978523a27ac4a810b69c2b8a0c0e31a2d785c00308215c2c852e21aef64953
+SHA512:
+  metadata.gz: 76a7e8a5c0cc54df4e3039df4d90bc237f075c67621097fe87f309dff79c0cff9a442f525a007c7087aa876c2fbc5551acdd1984bb131f018ef9673845e0dce3
+  data.tar.gz: 53d2d7abd6890f4f80c827a3c7787e1b2a4f1311ac3cd0c2e8bd6f84383fc136491af1b2d4f9772860361f7a370c87bce1c67b11897d35eff34b66b0b69acc03

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+Gemfile.lock
+*.gem

data/README.md

@@ -0,0 +1 @@
+FIXME

data/Rakefile

@@ -0,0 +1 @@
+require 'simple-rake-tasks'

data/TODO.txt

@@ -0,0 +1,18 @@
+- rename to FileDB or SlowDB
+
+- make work *only* with files
+  - no in-memory database
+  - no caching (or optional)
+  - #[] reads JSON file, #[]= writes, #delete deletes
+  - #keys reads directories/IDs
+  - #values parses JSON files
+  - #update(item) rewrites item
+
+- make include'able, rather than inheritable
+  - include Simple::FileDB, include Simple::FileDB::Item
+
+- make simpler to-json/from-json converters
+  - hash with keys of attributes, values as hash of procs:
+    - initialize
+    - reader
+    - writer (defaults to #to_s unless basic types)

data/lib/simple-file-db/item.rb

@@ -0,0 +1,55 @@
+module Simple
+
+  class FileDB
+  
+    class Item
+
+      attr_accessor :json_file
+      attr_accessor :id
+      attr_accessor :db
+
+      include SetParams
+
+      def dir
+        @json_file.dirname
+      end
+
+      def files
+        dir.glob('*') - [json_file]
+      end
+
+      def to_h
+        {
+          id: id,
+        }
+      end
+
+      def to_json(*options)
+        as_json(*options).to_json(*options)
+      end
+
+      def as_json(*options)
+        to_h.compact
+      end
+
+      def to_pretty_json
+        JSON.pretty_generate(self)
+      end
+
+      def fields(keys)
+        keys.map { |k| send(k) }
+      end
+
+      def <=>(other)
+        id <=> other.id
+      end
+
+      def save
+        @db.save_item(self)
+      end
+
+    end
+
+  end
+
+end

data/lib/simple-file-db.rb

@@ -0,0 +1,163 @@
+require 'csv'
+require 'json'
+require 'path'
+require 'set_params'
+
+require_relative 'simple-file-db/item'
+
+module Simple
+
+  class FileDB
+
+    class Error < Exception; end
+
+    attr_accessor :root
+
+    InfoFileName = 'info.json'
+
+    def self.item_class
+      Item
+    end
+
+    def self.search_fields
+      []
+    end
+
+    def self.convert_id(id)
+      id
+    end
+
+    def initialize(root:)
+      @root = Path.new(root).expand_path
+      @items = {}
+      if @root.exist?
+        @root.glob("*/#{InfoFileName}").each do |info_file|
+          raise Error, "Info file does not exist: #{info_file}" unless info_file.exist?
+          make_item(**JSON.load(info_file.read))
+        end
+        # ;;warn "* loaded #{@items.length} items from #{@root}"
+      end
+    end
+
+    def items
+      @items.values
+    end
+
+    def as_json(...)
+      items
+    end
+
+    def to_json(...)
+      as_json(...).to_json(...)
+    end
+
+    def to_csv
+      csv = []
+      items.each_with_index do |item, i|
+        hash = item.to_h
+        csv << CSV.generate_line(hash.keys) if i == 0
+        csv << CSV.generate_line(hash.values)
+      end
+      csv.join
+    end
+
+    def convert_id(id)
+      self.class.convert_id(id)
+    end
+
+    def [](id)
+      @items[convert_id(id)]
+    end
+
+    def []=(id, value)
+      @items[convert_id(id)] = value
+    end
+
+    def <<(item)
+      item.db = self
+      self[item.id] = item
+    end
+
+    def make_item(**params)
+      item = self.class.item_class.new(**params)
+      item.db = self
+      item.json_file = json_file_for_id(item.id)
+      @items[item.id] = item
+      item
+    end
+
+    def find(*selectors)
+      selectors = [selectors].compact.flatten
+      # warn "searching #{self.class} for: #{selectors.empty? ? 'ALL' : selectors.join(', ')}"
+      if selectors.empty?
+        @items.values
+      else
+        selected = Set.new
+        selectors.each do |selector|
+          if selector.to_i != 0
+            selected << convert_id(selector)
+          else
+            selected += search(selector)
+          end
+        end
+        selected.map { |id| self[id] }.compact.sort
+      end
+    end
+
+    def search(query)
+      words = [query].flatten.join(' ').tokenize.sort.uniq - ['-']
+      words.map do |word|
+        regexp = Regexp.new(Regexp.quote(word), true)
+        @items.values.select do |item|
+          self.class.search_fields.find do |field|
+            case (value = item.send(field))
+            when Array
+              value.find { |v| v.to_s =~ regexp }
+            else
+              value.to_s =~ regexp
+            end
+          end
+        end
+      end.flatten.compact.sort.map(&:id)
+    end
+
+    def json_file_for_id(id)
+      @root / id / InfoFileName
+    end
+
+    def save_item(item)
+      raise Error, "Item does not have ID" unless item.id
+      item.json_file = json_file_for_id(item.id)
+      # ;;warn "* saving item to #{item.json_file}"
+      item.json_file.dirname.mkpath unless item.json_file.dirname.exist?
+      item.json_file.write(item.to_pretty_json)
+      self[item.id] ||= item
+    end
+
+    def save_hash(hash)
+      raise Error, "Hash does not have ID" unless hash[:id]
+      json_file = json_file_for_id(hash[:id])
+      # ;;warn "* saving item to #{json_file}"
+      json = JSON.pretty_generate(hash)
+      json_file.dirname.mkpath unless json_file.dirname.exist?
+      json_file.write(json)
+    end
+
+    def has_item?(id)
+      @items.has_key?(convert_id(id))
+    end
+
+    def destroy!
+      @items = {}
+      @root.rmtree if @root.exist?
+    end
+
+    def destroy_item!(item)
+      @items.delete(item.id)
+      dir = json_file_for_id(item.id).dirname
+      dir.rmtree if dir.exist?
+    end
+
+  end
+
+end

data/simple-file-db.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |s|
+  s.name          = 'simple-file-db'
+  s.version       = '0.7'
+  s.summary       = 'A database built upon JSON files'
+  s.author        = 'John Labovitz'
+  s.email         = 'johnl@johnlabovitz.com'
+  s.description   = %q{
+    Simple::FileDB is a database built upon JSON files.
+  }.strip
+  s.license       = 'MIT'
+  s.homepage      = 'http://github.com/jslabovitz/simple-file-db'
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_path  = 'lib'
+
+  s.add_dependency 'csv', '~> 3.3'
+  s.add_dependency 'json', '~> 2.15'
+  s.add_dependency 'path', '~> 2.1'
+  s.add_dependency 'set_params', '~> 0.3'
+
+  s.add_development_dependency 'bundler', '~> 2.7'
+  s.add_development_dependency 'minitest', '~> 5.26'
+  s.add_development_dependency 'minitest-power_assert', '~> 0.3'
+  s.add_development_dependency 'rake', '~> 13.3'
+  s.add_development_dependency 'simple-rake-tasks', '~> 0.1'
+
+
+end

data/test/main_test.rb

@@ -0,0 +1,14 @@
+require 'minitest/autorun'
+require 'minitest/power_assert'
+
+require 'simple-file-db'
+
+class Test < Minitest::Test
+
+  def setup
+  end
+
+  def test_simple
+  end
+
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: simple-file-db
+version: !ruby/object:Gem::Version
+  version: '0.7'
+platform: ruby
+authors:
+- John Labovitz
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+- !ruby/object:Gem::Dependency
+  name: path
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: set_params
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.26'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.26'
+- !ruby/object:Gem::Dependency
+  name: minitest-power_assert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.3'
+- !ruby/object:Gem::Dependency
+  name: simple-rake-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Simple::FileDB is a database built upon JSON files.
+email: johnl@johnlabovitz.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- README.md
+- Rakefile
+- TODO.txt
+- lib/simple-file-db.rb
+- lib/simple-file-db/item.rb
+- simple-file-db.gemspec
+- test/main_test.rb
+homepage: http://github.com/jslabovitz/simple-file-db
+licenses:
+- MIT
+metadata: {}
+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.7.2
+specification_version: 4
+summary: A database built upon JSON files
+test_files:
+- test/main_test.rb