poros 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3c1887d3665a8d34d90f44b16382afdd2863180aa1bbfdb3f065c2f417ad55e7
+  data.tar.gz: b80355221534570d2a2f78c98d4cb26397176c04967e618cd496a95e967c77fd
+SHA512:
+  metadata.gz: b8293c3a1e811aeef5df450149e4d8e2f7735b6f222ae0aa9e29efc5f136421adb42697c2b41d975abb563dc25e21ce9ce7a53bea319f703f1799207fe8c263c
+  data.tar.gz: d48e5df3094177dc7ca4bf4e0fde76bd7ed860da99acb4f9d19b5081cebed97d478ce4a8fd0a6959d886dfcceb03c4c4872a96565dd8ffb7bb3d01e3418534b8

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+/tmp/

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.10
+  - 2.2.9
+  - 2.3.6
+  - 2.4.3
+  - 2.5.1
+before_install: gem install bundler

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in poros.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Sean Ross Earle
+
+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,91 @@
+# Poros ![TravisCI](https://travis-ci.org/HellRok/Poros.svg?branch=master)
+
+This is a little gem written for persistence and active-record like querying of
+objects with a simple YAML based backend.
+
+The name stands for Plain Old Ruby Object Storage.
+
+## Installation
+
+This gem requires at least Ruby 2.1 because it uses `.to_h` on an Array and
+named arguments for initialize.
+
+Add this line to your application's Gemfile:
+
+```gem 'poros' ```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install poros
+
+## Usage
+
+A basic usage would look like this:
+
+```ruby
+class Widget
+  include Poros
+
+  poro_attr :name, :order, :active
+  poro_index :active
+
+  def initialize(name: '', order: 0, active: false)
+    @name = name
+    @order = order
+    @active = active
+  end
+end
+
+widget = Widget.new(name: 'Cube', order: 0, active: true)
+widget.save
+
+other_widget = Widget.find('uuid')
+
+many_widgets = Widget.where(order: 1, name: /regex/)
+```
+
+`#initialize` must use keyword arguments and contain at least all the
+attributes defined in `poro_attr`. In the future I may define this function for
+you but for right now I'm not sure I want to go that direction.
+
+`poro_attrs :blah` will define a getter and setter for `:blah` and also be persisted when you run `#save`
+
+`poro_indexes :blah` will create indexes on these columns, this will greatly
+speed up searching but if your index gets really big the initial load of a
+model will take quite a long time.
+
+`self.data_directory` you can re-define this method if you don't want it to
+save to the default of `./db/#{self}`. If you do re-define it you _must_
+seperate each model into it's own folder or it will have _lots_ of issues.
+
+`.where` acts a bit like ActiveRecord but it's not currently chainable (I plan
+to do that in the future though) and currently can only take exact matches or
+regex, I plan to add array in the near future.
+
+`.find` takes the `#uuid` which is generated by Poros and returns the single record.
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/HellRok/Poros
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/lib/poros.rb

@@ -0,0 +1,198 @@
+require 'yaml'
+require 'securerandom'
+
+module Poros
+  attr_accessor :uuid
+  def self.included(base)
+    base.class_eval do
+      extend ClassMethods
+    end
+  end
+
+  def uuid
+    @uuid ||= SecureRandom.uuid
+  end
+
+  def poros
+    @poros ||= PorosInfo.new(self)
+  end
+
+  def destroy
+    File.delete(poros.file_path)
+    self.class.remove_from_index(self)
+    self
+  end
+
+  def save
+    File.write(poros.file_path, poros.to_h.to_yaml)
+    self.class.data_changed = true
+    self.class.update_index(self)
+    self
+  end
+
+  class PorosInfo
+    def initialize(object)
+      @object = object
+    end
+
+    def file_path
+      @object.class.file_path(@object.uuid)
+    end
+
+    def to_h
+      @object.class.poro_attrs.map { |column|
+        [column, @object.send(column.to_s)]
+      }.to_h
+    end
+  end
+
+  module ClassMethods
+    attr_accessor :in_transaction, :data_changed
+
+    def poro_attr(*attrs)
+      @poro_attrs = [:uuid] | attrs
+      attrs.each { |column|
+        class_eval "attr_accessor :#{column}"
+      }
+    end
+
+    def poro_attrs
+      @poro_attrs ||= []
+    end
+
+    def poro_index(*attrs)
+      @poro_indexes ||= []
+      @poro_indexes += attrs
+    end
+
+    def poro_indexes
+      @poro_indexes ||= []
+    end
+
+    def find(uuid)
+      attrs = YAML.load(File.read(file_path(uuid)))
+      attrs.delete(:uuid)
+
+      object = new(attrs)
+      object.uuid = uuid
+      object
+    end
+
+    def file_path(uuid)
+      FileUtils.mkdir_p(data_directory) unless File.exist?(data_directory)
+      File.join(data_directory, file_name(uuid))
+    end
+
+    def data_directory
+      "./db/#{self}/"
+    end
+
+    def file_name(uuid)
+      "#{uuid}.yml"
+    end
+
+    def index_file
+      File.join(data_directory, "indexes.yml")
+    end
+
+    def all
+      Dir.glob(File.join(data_directory, '*.yml')).map { |file|
+        next if file == index_file
+        data = YAML.load(File.read(file))
+        find(data[:uuid])
+      }.compact
+    end
+
+    def where(query)
+      indexed, table_scan = query.partition { |index, key| poro_indexes.include?(index) }
+
+      indexed_results = indexed.map { |key, value|
+        case value
+        when Regexp
+          index_data[key].keys.flat_map { |value_name|
+            index_data[key][value_name] if value =~ value_name
+          }.compact
+        else
+          index_data[key].has_key?(value) ?
+            index_data[key][value] : []
+        end
+      }.inject(:&)
+
+      if table_scan.size > 0
+        scanned_results = Dir.glob(File.join(data_directory, '*.yml')).map { |file|
+          data = YAML.load(File.read(file))
+          data[:uuid] if table_scan.all? { |key, value|
+            case value
+            when Regexp
+              value =~ data[key]
+            else
+              data[key] == value
+            end
+          }
+        }.compact
+      end
+
+      if indexed.size > 0 && table_scan.size > 0
+        results = indexed_results & scanned_results
+      elsif indexed.size > 0
+        results = indexed_results
+      else
+        results = scanned_results
+      end
+
+      results.map { |uuid| find(uuid) }
+    end
+
+    def index_data
+      return @index_data if @index_data
+
+      data = File.exist?(index_file) ? YAML.load(File.read(index_file)) : {}
+      # Make sure we always have every index as a key
+      poro_indexes.each do |index|
+        data[index] = {} unless data.has_key?(index)
+      end
+
+      @index_data = data
+    end
+
+    def write_index_data
+      File.write(index_file, @index_data.to_yaml)
+    end
+
+    def update_index(object)
+      remove_from_index(object, false)
+
+      index_data
+
+      poro_indexes.each do |index|
+        @index_data[index] = {} unless @index_data.has_key?(index)
+        value = object.send(index)
+        @index_data[index][value] ||= []
+        @index_data[index][value] = @index_data[index][value] | [object.uuid]
+      end
+
+      write_index_data unless @in_transaction
+    end
+
+    def remove_from_index(object, perist = true)
+      index_data
+
+      poro_indexes.each do |index|
+        @index_data[index] = {} unless @index_data.has_key?(index)
+        @index_data[index].keys.each do |value|
+          @index_data[index][value] ||= []
+          @index_data[index][value] -= [object.uuid]
+        end
+      end
+      write_index_data if !@in_transaction && perist
+    end
+
+    def transaction(&block)
+      @in_transaction = true
+      @data_changed = false
+      block.call
+      @in_transaction = false
+      write_index_data if @data_changed
+    end
+  end
+end

data/lib/poros/version.rb

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

data/poros.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "poros/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = 'poros'
+  spec.version       = Poros::VERSION
+  spec.date          = '2018-04-22'
+  spec.summary       = 'Persist and query your objects'
+  spec.description   = 'Persist your objects and query them in an active record like way'
+  spec.authors       = ["Sean Ross Earle"]
+  spec.email         = ["sean.earle@oeQuacki.com"]
+  spec.homepage      = "https://github.com/HellRok/YAMLCache"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: poros
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sean Ross Earle
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: Persist your objects and query them in an active record like way
+email:
+- sean.earle@oeQuacki.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/poros.rb
+- lib/poros/version.rb
+- poros.gemspec
+homepage: https://github.com/HellRok/YAMLCache
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Persist and query your objects
+test_files: []