active_redis 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Mzc0OWM3NzZhZmM1ZTViNWU1NmJlNDI3MzAyM2QyMDEzZDA1MmUzZg==
+  data.tar.gz: !binary |-
+    OWM3MjQwNTU2NDFjZDBmMzg5NWY5NjRjZGYyYmEwMGQzMDhlZTJhMA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZmQzNzNlZjQzZTMxMDA0MmI2YjA3MWQzNWUzNDdjY2UwZDA5MWFkNzQ3MzI3
+    MzUwYTMyZjEyMmY5YTU2YzJjN2NiZjM4ZGRhODc0NTY2MWY3MTcyMDViYjI2
+    YzhmZmZhMGRmZjU0NDBlZWFiYmE3ZjVmOWQyZDZhMmI3OTI0MDI=
+  data.tar.gz: !binary |-
+    ZmIyNTYzNjE0OTY0ZmIzZTkwOGY1OGU3MTcyYmIyNTk5NjY0M2UxNjM0YmQ4
+    OTU3OWUwNDQwYTEyNTk5OTg0ODhjOWY5YzlkYjJmMDk4OTdmZWQ2ZDgwZWVl
+    M2E5ODUxMzExYzEwMzViZTFmMmY5YjIwMDNkODU0ODllMThkMjY=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_redis.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 sergio1990
+
+MIT License
+
+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,97 @@
+# ActiveRedis
+
+Small childly ORM for Redis
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'active_redis'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_redis
+
+## Usage
+
+### Basic usage
+
+```ruby
+class Article < ActiveRedis::Base
+  attributes :title, :link
+end
+```
+
+By class method __attributes__ you must define own attributes.
+
+### Attribute accessing
+
+By using accessible methods
+
+```ruby
+article = Article.new
+article.title = "Some title"
+article.link = "http://someblog.com/1"
+
+p article.title # => Some title
+p article.link # => http://someblog.com/1
+```
+
+Or by __attributes__ method
+
+```ruby
+article = Article.new
+article.attributes = {title: "Some title", link: "http://someblog.com/1"}
+
+p article.attributes # => {title: "Some title", link: "http://someblog.com/1"}
+p article.title # => Some title
+p article.link # => http://someblog.com/1
+```
+
+### Persistence
+
+ActiveRedis::Base inherited model respond to all CRUD method such as create, update, destroy and save
+
+```ruby
+article = Article.new(title: "Some title", link: "http://someblog.com/1")
+article.save # => true
+
+another_article = Article.create(title: "Another title", link: "http://someblog.com/2") # => true
+
+article.update(title: "New article title") # => true
+
+p article.title # => New article title
+
+another_article.destroy
+```
+
+### Finders and Calculations
+
+Now you may find 'row' by it's id
+
+```ruby
+Article.find(1) # => [#<Article:0x007fec2526f4f8 @updated_at="1382608780", @link="http://someblog.com/1", @id="1", @title="Some title", @created_at="1382608780">]
+```
+
+Now gem add support for some aggregation functions like __sum__, __min__, __max__, __pluck__.
+
+### Future work
+
+At an early time I want to implement such features:
+
+1. Add finders like ActiveRecord's where
+2. Add _all_ class method
+3. Add associations
+4. Setting/getting attributes with it's types
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+require 'rake/notes/rake_task'

data/active_redis.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_redis/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_redis"
+  spec.version       = ActiveRedis::VERSION
+  spec.authors       = ["Sergey Gernyak"]
+  spec.email         = ["sergeg1990@gmail.com"]
+  spec.description   = %q{Small childly ORM for Redis}
+  spec.summary       = spec.description
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "redis"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake-notes"
+end

data/lib/active_redis.rb

@@ -0,0 +1,24 @@
+require "active_redis/version"
+require "active_redis/errors"
+require "active_redis/railtie" if defined?(Rails)
+
+module ActiveRedis
+  autoload :Constants,   'active_redis/constants'
+  autoload :Config,      'active_redis/config'
+  autoload :Base,        'active_redis/base'
+  autoload :Connection,  'active_redis/connection'
+
+  def self.config(&block)
+    @config ||= ::ActiveRedis::Config.new
+    block_given? ? yield(@config) : @config
+  end
+
+  def self.connection
+    raise ActiveRedis::NoConnectionError, "Connection not provided!" unless @connection
+    @connection
+  end
+
+  def self.connection=(value)
+    @connection = value
+  end
+end

data/lib/active_redis/adapters/basic_adapter.rb

@@ -0,0 +1,19 @@
+require 'delegate'
+require 'redis'
+
+module ActiveRedis
+  module Adapters
+
+    class BasicAdapter < SimpleDelegator
+
+      alias_method :adapter, :__getobj__
+
+      def initialize(options)
+        redis = Redis.new(options)
+        super(redis)
+      end
+
+    end
+
+  end
+end

data/lib/active_redis/associations.rb

@@ -0,0 +1,27 @@
+module ActiveRedis
+  module Associations
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      # TODO: add has_one functionality
+      def has_one
+
+      end
+
+      # TODO: add has_many functionality
+      def has_many
+
+      end
+
+      # TODO: add belongs_to functionality
+      def belongs_to
+
+      end
+
+    end
+  end
+end

data/lib/active_redis/attributes.rb

@@ -0,0 +1,41 @@
+module ActiveRedis
+  module Attributes
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    def attributes=(value)
+      raise ActiveRedis::InvalidArgumentError, "Value must be a Hash" unless value.is_a? Hash
+      value.each { |attribute, value| self.send("#{attribute}=", value) }
+    end
+
+    def attributes
+      self.class.defined_attributes.inject({}) do |hash, attribute|
+        hash[attribute.to_sym] = self.send(attribute.to_s)
+        hash
+      end
+    end
+
+    module ClassMethods
+
+      def attributes(*attrs)
+        attrs = attrs.concat(ActiveRedis::Constants::DEFAULT_ATTRIBUTES)
+        attrs.each do |attribute|
+          define_method "#{attribute}=" do |value|
+            instance_variable_set("@#{attribute}", value)
+          end
+          define_method attribute do
+            instance_variable_get("@#{attribute}")
+          end
+        end
+        class << self
+          attr_accessor :defined_attributes
+        end
+        self.defined_attributes = attrs
+      end
+
+    end
+
+  end
+end

data/lib/active_redis/base.rb

@@ -0,0 +1,21 @@
+require 'active_redis/attributes'
+require 'active_redis/associations'
+require 'active_redis/persistence'
+require 'active_redis/naming'
+require 'active_redis/calculations'
+require 'active_redis/finders'
+
+# TODO: Add Expiring module
+
+module ActiveRedis
+  class Base
+    extend Naming
+    extend Calculations
+    extend Finders
+
+    include Attributes
+    include Associations
+    include Persistence
+
+  end
+end

data/lib/active_redis/calculations.rb

@@ -0,0 +1,17 @@
+module ActiveRedis
+  module Calculations
+
+    def self.extended(base)
+      ActiveRedis::Constants::CALCULATION_METHODS.each do |method|
+        base.instance_eval <<-EVAL
+          def #{method}(attribute = "")
+            ActiveRedis.connection.calculate_#{method} self, attribute
+          end
+        EVAL
+      end
+    end
+
+    # TODO: add average method
+
+  end
+end

data/lib/active_redis/config.rb

@@ -0,0 +1,14 @@
+class ActiveRedis::Config
+	# Specify connection string to Redis. To check all available options please see redis-rb library.
+	#
+	# Some samples:
+	#   ActiveRedis.config.connection_options = {host: 10.10.1.1, port: 6380}
+	# or
+	#   ActiveRedis.config.connection_options = {path: '/tmp/redis.sock'}
+	attr_accessor :connection_options
+
+	# Specify adapter for connection to DB
+	# By default it's ActiveRedis::Adapters::BasicAdapter
+	attr_accessor :adapter
+
+end

data/lib/active_redis/connection.rb

@@ -0,0 +1,22 @@
+require 'active_redis/helpers/lua_scripts'
+Dir[File.dirname(__FILE__) + '/connection_ext/*.rb'].each {|file| require file }
+
+include ActiveRedis::Helpers::LuaScripts
+
+module ActiveRedis
+  class Connection
+    extend ActiveRedis::ConnectionExt::CalculationsLayer
+
+    include ActiveRedis::ConnectionExt::FindersLayer
+    include ActiveRedis::ConnectionExt::PersistenceLayer
+
+    calculations ActiveRedis::Constants::CALCULATION_METHODS
+
+    def initialize(options, adapter)
+      @adapter = adapter.new(options)
+    end
+
+    attr_accessor :adapter
+
+  end
+end

data/lib/active_redis/connection_ext/calculations_layer.rb

@@ -0,0 +1,24 @@
+module ActiveRedis::ConnectionExt
+  module CalculationsLayer
+
+    def self.extended(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      def calculations(methods)
+        eval_string = ""
+        methods.each do |method|
+          eval_string += <<-EVAL
+            def calculate_#{method}(model, attributes = "")
+              adapter.eval send("#{method}_script"), keys: [model.key_name], argv: [attributes]
+            end
+          EVAL
+        end
+        class_eval(eval_string)
+      end
+    end
+
+  end
+end

data/lib/active_redis/connection_ext/finders_layer.rb

@@ -0,0 +1,14 @@
+module ActiveRedis::ConnectionExt
+  module FindersLayer
+
+    def fetch_row(model, id)
+      raise ActiveRedis::NotSpecifiedIdError, "Must specified ID for finding record!" unless id
+      adapter.hgetall model.table_name(id)
+    end
+
+    def fetch_keys(model)
+      adapter.keys model.key_name
+    end
+
+  end
+end

data/lib/active_redis/connection_ext/persistence_layer.rb

@@ -0,0 +1,35 @@
+module ActiveRedis::ConnectionExt
+  module PersistenceLayer
+
+    def save_table(model, attributes)
+      raise ActiveRedis::NotSpecifiedIdError, "Must specified ID for saving record!" if !attributes || !attributes[:id]
+      adapter.hmset(model.table_name(attributes[:id]), attributes.flatten) == ActiveRedis::Constants::SAVE_SUCCESS_ANSWER
+    end
+
+    def next_id(model)
+      table = model.info_table_name
+      create_info_table(model) unless @adapter.exists(table)
+      adapter.hincrby table, "next_id", 1
+      adapter.hget table, "next_id"
+    end
+
+    def create_info_table(model)
+      adapter.hmset model.info_table_name, "next_id", 0
+    end
+
+    def destroy(model, id)
+      raise ActiveRedis::NotSpecifiedIdError, "Must specified ID for destroy record!" unless id
+      destroy_by_keys model.table_name(id)
+    end
+
+    def destroy_all(model)
+      destroy_by_keys fetch_keys(model)
+    end
+
+    private
+    def destroy_by_keys(keys)
+      adapter.del keys
+    end
+
+  end
+end

data/lib/active_redis/constants.rb

@@ -0,0 +1,11 @@
+module ActiveRedis
+  module Constants
+
+    CALCULATION_METHODS = %w{count min max sum pluck}
+
+    SAVE_SUCCESS_ANSWER = "OK"
+
+    DEFAULT_ATTRIBUTES = [:id, :created_at, :updated_at]
+
+  end
+end

data/lib/active_redis/errors.rb

@@ -0,0 +1,12 @@
+module ActiveRedis
+
+  class NoConnectionError < ::StandardError
+  end
+
+  class NotSpecifiedIdError < ::StandardError
+  end
+
+  class InvalidArgumentError < ::StandardError
+  end
+
+end

data/lib/active_redis/finders.rb

@@ -0,0 +1,11 @@
+module ActiveRedis
+  module Finders
+
+    def find(*ids)
+      ids.map { |id| self.new(ActiveRedis.connection.fetch_row(self, id)) }
+    end
+
+    # TODO: Add finders methods like where
+
+  end
+end

data/lib/active_redis/helpers/lua_scripts.rb

@@ -0,0 +1,24 @@
+module ActiveRedis
+  module Helpers
+    module LuaScripts
+
+      ActiveRedis::Constants::CALCULATION_METHODS.each do |method|
+        define_method "#{method}_script" do
+          <<-LUA
+            #{LuaLoader.get_main}
+            return calculate_#{method}(KEYS[1]#{method == "count" ? "" : ", ARGV[1]"})
+          LUA
+        end
+      end
+
+      class LuaLoader
+
+        def self.get_main
+          @content ||= File.read(File.dirname(__FILE__) + '/../lua_scripts/main.lua')
+        end
+
+      end
+
+    end
+  end
+end

data/lib/active_redis/lua_scripts/main.lua

@@ -0,0 +1,50 @@
+local keys = function (k)
+  return redis.call("KEYS", k)
+end
+
+local cond_tonum = function (value, tonum)
+  if tonum == true then
+    return tonumber(value)
+  else
+    return value
+  end
+end
+
+local getHashValues = function (k, attr, tonum)
+  local result = {}
+  local ks = keys(k)
+  for index, key in pairs(ks) do
+    local cell = redis.call("HGET", key, attr)
+    table.insert(result, cond_tonum(cell, tonum))
+  end
+  return result
+end
+
+local calculate_count = function (key)
+  return #keys(key)
+end
+
+local calculate_pluck = function (key, attr)
+  return getHashValues(key, attr, false)
+end
+
+local calculate_max = function (key, attr)
+  local res = getHashValues(key, attr, true)
+  table.sort(res)
+  return res[#res]
+end
+
+local calculate_min = function (key, attr)
+  local res = getHashValues(key, attr, true)
+  table.sort(res)
+  return res[1]
+end
+
+local calculate_sum = function (key, attr)
+  local res = getHashValues(key, attr, true)
+  local sum = 0
+  for index, s in pairs(res) do
+    sum = sum + s
+  end
+  return sum
+end

data/lib/active_redis/naming.rb

@@ -0,0 +1,19 @@
+module ActiveRedis
+
+  module Naming
+
+    def table_name(id = "")
+      "#{self.name.downcase.pluralize}:item:#{id}"
+    end
+
+    def key_name
+      "#{table_name}*"
+    end
+
+    def info_table_name
+      "#{self.name.downcase.pluralize}:info"
+    end
+
+  end
+
+end

data/lib/active_redis/persistence.rb

@@ -0,0 +1,55 @@
+module ActiveRedis
+  module Persistence
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    def initialize(attrs = {})
+      self.attributes = attrs
+    end
+
+    def save
+      ActiveRedis.connection.save_table self.class, prepare_hash
+    end
+
+    def destroy
+      ActiveRedis.connection.destroy self.class, self.id
+    end
+
+    def update(attrs = {})
+      self.attributes = attrs
+      self.save
+    end
+
+    private
+
+      def fill_attributes
+        self.id ||= ActiveRedis.connection.next_id(self.class)
+        self.created_at ||= Time.now.to_i
+        self.updated_at = Time.now.to_i
+      end
+
+      def prepare_hash
+        fill_attributes
+        self.class.defined_attributes.inject({}) do |hash, attribute|
+          hash[attribute] = self.send("#{attribute}"); hash
+        end
+      end
+
+    module ClassMethods
+
+      def create(attrs = {})
+        self.new(attrs).tap do |model|
+          model.save
+        end
+      end
+
+      def destroy_all
+        ActiveRedis.connection.destroy_all self
+      end
+
+    end
+
+  end
+end

data/lib/active_redis/railtie.rb

@@ -0,0 +1,12 @@
+require 'active_redis/adapters/basic_adapter'
+
+module ActiveRedis
+  class Railtie < Rails::Railtie
+    config.after_initialize do
+      ActiveRedis.connection = ActiveRedis::Connection.new(
+      	ActiveRedis.config.connection_options || {},
+      	ActiveRedis.config.adapter || ActiveRedis::Adapters::BasicAdapter
+      )
+    end
+  end
+end

data/lib/active_redis/version.rb

@@ -0,0 +1,3 @@
+module ActiveRedis
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: active_redis
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sergey Gernyak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  name: redis
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  name: rake-notes
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Small childly ORM for Redis
+email:
+- sergeg1990@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_redis.gemspec
+- lib/active_redis.rb
+- lib/active_redis/adapters/basic_adapter.rb
+- lib/active_redis/associations.rb
+- lib/active_redis/attributes.rb
+- lib/active_redis/base.rb
+- lib/active_redis/calculations.rb
+- lib/active_redis/config.rb
+- lib/active_redis/connection.rb
+- lib/active_redis/connection_ext/calculations_layer.rb
+- lib/active_redis/connection_ext/finders_layer.rb
+- lib/active_redis/connection_ext/persistence_layer.rb
+- lib/active_redis/constants.rb
+- lib/active_redis/errors.rb
+- lib/active_redis/finders.rb
+- lib/active_redis/helpers/lua_scripts.rb
+- lib/active_redis/lua_scripts/main.lua
+- lib/active_redis/naming.rb
+- lib/active_redis/persistence.rb
+- lib/active_redis/railtie.rb
+- lib/active_redis/version.rb
+homepage: ''
+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.0.6
+signing_key: 
+specification_version: 4
+summary: Small childly ORM for Redis
+test_files: []