redijson_models 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3ac69b8eba7f8d906969f5fe6853091b56b272631d024e0e5d3d7356ad6306d4
+  data.tar.gz: bd4a54d09a8309c955d2886926a86f4c0409954fdd9674a441f60166bdf641d2
+SHA512:
+  metadata.gz: f3ce08234eb353464d9a0b41ca76c7927ad49dd2717ca0dcf64d1d49cd6c4c83259c14df5135907572d85a2f8663e75cbf8809899ffecdbcbb4208b109112eb4
+  data.tar.gz: 121ed8f4e9ff55ddad04307be04cff3d66c03a8e5fd1e24ca4a61f1779ce35963098eeb5479e3ff8a7d51e3b73202d8f1cf888df488ffca0401fc6ec2340d4cf

data/Rakefile

@@ -0,0 +1,6 @@
+desc "Spec"
+task :spec do
+  sh "bundle exec rspec"
+end
+
+task default: :spec

data/Readme.md

@@ -0,0 +1,114 @@
+# RediJsonModels
+
+Document-like ORM based on Redis key value store - uses Redis Re-JSON for full json manipulation
+
+### Install
+
+Add to your gemfile:
+
+```rb
+gem 'redijson_models', '~> 0.8.1'
+```
+
+Or without bundler, run in your shell:
+
+    gem i redijson_models
+
+
+### Requirements
+
+- Redis (v4+)
+- Re-JSON module installed
+
+### DB API
+
+```ruby
+Model.get 1 #=> returns an object instance (gets it from redis)
+
+Model.all #=> returns an array of Model object instances
+
+Model.create({}) #=> creates an entry in redis
+
+Model.update(1, {}) #=> updates a record in redis
+```
+
+### Model Definition and Instance API by Virtus
+
+#### Definition:
+
+```ruby
+class Document
+  extend  RediJsonModelLib
+  include RediJsonModelMixin
+  include Virtus.model
+
+  attribute :id,        Integer
+  attribute :name,      String
+  attribute :contents,  String
+
+  def antani
+    # "..."
+  end
+end
+```
+
+### Instance API:
+
+```ruby
+doc = Document.new name: "Foo", contents: "Bar123"
+puts doc.name      #=> "foo"
+puts doc.antani    #=> "..."
+doc.save # saves the record, gives an auto increment id (example: 1)
+
+doc = Document.get doc.id
+puts doc.name      #=> "foo"
+puts doc.antani    #=> "..."
+```
+
+### Run local Redis (+ Re-JSON module) locally via Docker:
+
+in this repo run:
+
+```
+docker-compose up
+```
+
+Which use the docker-compose.yml to start your redis.
+
+
+### Set up your Redis and RJSON
+
+```rb
+# sample environment setup
+require 'bundler'
+Bundler.require :default
+
+# setup redis
+R = Redis.new 
+
+# load and configure redis with rejson models
+include RediJsonModels
+RJ.configure redis: R
+
+class Document
+  # ...
+end
+```
+
+
+### Run specs
+
+(you need to run a local redis + rejson service - explained above)
+
+Run:
+
+```
+rake spec
+```
+
+
+---
+
+Enjoy!
+
+@makevoid

data/lib/env.rb

@@ -0,0 +1,15 @@
+# require 'bundler/setup'
+# Bundler.require :default
+require 'redis'
+require 'virtus'
+require 'dry-inflector'
+require 'rejson'
+# require 'redis_rejson' # a little bit faster but has less features than the above
+
+module RediJsonModels
+  REDIS_DB = ENV["REDIS_DB"]
+
+  R = Redis.new db: REDIS_DB || 0
+
+  class NilValue; end
+end

data/lib/redijson_models.rb

@@ -0,0 +1,112 @@
+require_relative 'env'
+
+module RediJsonModels
+
+  # low level API
+  class RJ
+    def self.configure(redis:)
+      @@redis = redis
+    end
+
+    def self.redis
+      @@redis
+    end
+
+    def self.[](key)
+      # redis.json_get key
+      redis.json_get key, Rejson::Path.root_path
+    end
+
+    def self.[]=(key, val)
+      # redis.json_set key, val
+      redis.json_set key, Rejson::Path.root_path, val
+    end
+  end
+
+  module RediJsonModelLib
+    INFLECTOR = Dry::Inflector.new
+
+    def all
+      1.upto(count).map do |entry_id|
+        get entry_id
+      end
+    end
+
+    def count
+      ( RJ["#{resource}:count"] || 0 ).to_i
+    end
+
+    def get(id)
+      data = RJ["#{resource}:#{id}"]
+      return unless data
+      new data
+    end
+
+    def get_attr(id, attr)
+      key = "#{resource}:#{id}"
+      data = RJ.redis.json_get key, ".name"
+      return NilValue.new unless data
+      data
+    end
+
+    def create(attrs)
+      id = incr
+      attrs.merge! id: id
+      obj  = new attrs
+      RJ["#{resource}:#{id}"] = obj.attributes
+      obj
+    end
+
+    def update(id, attrs)
+      resource = get id
+      resource.update attrs
+    end
+
+    def resource
+      INFLECTOR.pluralize model_name
+    end
+
+    private
+
+    # TODO: use incr
+    def incr
+      RJ["#{resource}:count"] = count + 1
+    end
+
+    def model_name
+      self.name.downcase
+    end
+
+  end
+
+  module RediJsonModelMixin
+
+    def update(attrs_new)
+      raise "Can't update a resource without an `id`" unless id
+      klass = self.class
+      model = klass.get id
+      attrs = model.attributes
+      attrs.merge! attrs_new
+      obj   = klass.new attrs
+      RJ["#{self.class.resource}:#{id}"] = obj.attributes
+      obj
+    end
+
+    def save
+      klass = self.class
+      attrs = attributes
+      id = attrs[:id]
+      unless id
+        entry_id = klass.send :incr
+        attrs.merge! "id" => entry_id
+        id = entry_id
+      end
+
+      RJ["#{self.class.resource}:#{id}"] = attrs
+      self.id = id
+      self
+    end
+
+  end
+
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module RediJsonModels
+  VERSION = "0.9.0"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: redijson_models
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- makevoid
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: dry-inflector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rejson-rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Document-like ORM based on Redis key value store - uses Redis Re-JSON
+  for full json manipulation
+email:
+- makevoid@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- Readme.md
+- lib/env.rb
+- lib/redijson_models.rb
+- lib/version.rb
+homepage: http://makevoid.com
+licenses:
+- Unlicense
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Document-like ORM based on Redis key value store
+test_files: []