hash_db 0.0.1

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,3 @@
+guard "rspec" do
+  watch(/^(lib|spec)/) { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Utkarsh Kukreti
+
+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,117 @@
+# HashDB
+
+HashDB is a minimal, in-memory, ActiveRecord like database library,
+backed by a Ruby Hash.
+
+## Installation
+
+Gem releases are not done frequently as of now. I recommend installing through
+the git repository.
+
+Add this line to your application's Gemfile:
+
+    gem 'hash_db', git: "https://github.com/utkarshkukreti/hash_db.git"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ git clone https://github.com/utkarshkukreti/hash_db.git
+    $ cd hash_db
+    $ bundle install
+    $ rake install
+
+## Usage
+
+First, require HashDB.
+
+    require 'hash_db'
+
+To make your class a HashDB model, just include `HashDB::Model` module in
+your class.
+
+    class Post
+      include HashDB::Model
+    end
+
+Defining attributes is as easy as calling `keys`, with the key names you want.
+
+      keys :title, :content
+
+HashDB will automatically create getters and setters for these keys, so you can
+now assign `title` and `content` to objects of the Post class.
+
+    post = Post.new
+    post.title = "Introducing HashDB"
+    post.content = "..."
+
+Just as with ActiveRecord, you can also pass a Hash with key/value pairs to .new
+
+    # Same as above
+    post = Post.new title: "Introducing HashDB", content: "..."
+
+To be able to query the model, objects must be saved, using `.save`.
+
+    post.save
+
+This saves the object into Class.all Hash, with auto generated `id` key as the
+key, and object as the value.
+
+    Post.all == { 1 => post } #= true
+
+Like ActiveRecord, `.new` and `.save` can be combined into just a `.create` call
+on the class.
+
+    Post.create title: "Second Post"
+    Post.all.count == 2 #= true
+
+## Querying
+
+HashDB currently has just 2 query methods, `.where`, which can filter objects
+using key(s) = value(s), and also using custom method call, like `:<` and `:>`.
+
+Let's [HN](http://news.ycombinator.com) as an example. :)
+
+    class Item
+      include HashDB::Model
+      keys :url, :title, :points, :comment_count
+    end
+
+    Item.create url: "http://blog.heroku.com/archives/2011/7/12/matz_joins_heroku/",
+                title: "Matz (creator of Ruby) joins Heroku",
+                points: 569,
+                comment_count: 79
+    Item.create url: "http://www.rubymotion.com/",
+                title: "RubyMotion - Ruby for iOS",
+                points: 466,
+                comment_count: 248
+    Item.create url: "http://repl.it/",
+                title: "Try Python, Ruby, Lua, Scheme, QBasic, Forth...",
+                points: 379,
+                comment_count: 80
+
+You can query by key = value
+
+    Item.where(points: 569).count #= 1
+
+by key = value pairs
+
+    Item.where(points: 569, comment_count: 79).count #= 1
+
+by custom method call
+
+    Item.where(:points, :>, 400).count #= 2
+
+and by custom method call pairs
+
+    Item.where([:points, :>, 400], [:title, :=~, /ios/i]).count #= 1
+
+## Associations
+
+TODO: Add Documentation
+
+## License
+
+MIT License. (c) 2013 Utkarsh Kukreti.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/hash_db.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hash_db/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "hash_db"
+  gem.version       = HashDB::VERSION
+  gem.authors       = ["Utkarsh Kukreti"]
+  gem.email         = ["utkarshkukreti@gmail.com"]
+  gem.description   = "A minimal, in-memory, ActiveRecord like database, " +
+                      "backed by a Ruby Hash."
+  gem.summary       = gem.description
+  gem.homepage      = ""
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  %w{rake rspec guard-rspec}.each do |name|
+    gem.add_development_dependency name
+  end
+end

data/lib/hash_db/model/association.rb

@@ -0,0 +1,51 @@
+module HashDB
+  module Model
+    module ClassMethods
+      def has_many(name, args = {})
+        klass = args[:class]
+        foreign_key = args[:foreign_key]
+
+        klass.keys foreign_key
+
+        define_method "#{name}" do
+          base_id = id
+          @attributes[name] ||= begin
+            [].tap do |array|
+              array.define_singleton_method :<< do |object|
+                object.send("#{foreign_key}=", base_id)
+                super object
+              end
+
+              array.define_singleton_method :create do |*args|
+                klass.create(*args).tap do |object|
+                  array << object
+                end
+              end
+            end
+          end
+        end
+      end
+
+      def belongs_to(name, args = {})
+        klass = args[:class]
+        key = args[:key]
+
+        define_method "#{name}" do
+          @attributes[name]
+        end
+
+        define_method "#{name}=" do |object|
+          @attributes[name] = object
+        end
+
+        define_method "#{key}" do
+          @attributes[name] && @attributes[name].id
+        end
+
+        define_method "#{key}=" do |id|
+          @attributes[name] = klass.find_by(id: id)
+        end
+      end
+    end
+  end
+end

data/lib/hash_db/model/core.rb

@@ -0,0 +1,59 @@
+module HashDB
+  module Model
+    attr_accessor :attributes
+
+    def self.included(klass)
+      klass.extend ClassMethods
+      klass.all = {}
+      klass.keys :id
+    end
+
+    def initialize(args = {})
+      @attributes = {}
+      args.each do |key, value|
+        if respond_to?("#{key}=")
+          send("#{key}=", value)
+        else
+          raise InvalidKeyError.new "Invalid key #{key}."
+        end
+      end
+    end
+
+    def save
+      if id.nil?
+        self.id = if self.class.all.any?
+                self.class.all.keys.last + 1
+              else
+                1
+              end
+      end
+      self.class.all[id] = self
+    end
+
+    def destroy
+      self.class.all.delete id
+    end
+
+    module ClassMethods
+      attr_accessor :all
+
+      def keys(*keys)
+        keys.each do |key|
+          define_method "#{key}" do
+            @attributes[key]
+          end
+
+          define_method "#{key}=" do |value|
+            @attributes[key] = value
+          end
+        end
+      end
+
+      def create(args = {})
+        new(args).tap do |object|
+          object.save
+        end
+      end
+    end
+  end
+end

data/lib/hash_db/model/query.rb

@@ -0,0 +1,29 @@
+module HashDB
+  module Model
+    module ClassMethods
+      def where(*args)
+        # Doesn't really take all cases into account.
+        # Good enough for now. :)
+        if args.size == 1 && Hash === args.first
+          args = args.first.map do |key, value|
+            [key, :==, value]
+          end
+        elsif !(Array === args.first)
+          args = [args]
+        end
+
+        @all.values.select do |object|
+          args.all? do |key, method, value|
+            # TODO: Should access through the getter?
+            object.attributes[key].send(method, value)
+          end
+        end
+      end
+
+      def find_by(*args)
+        # Not efficient, and I know it.
+        where(*args).first
+      end
+    end
+  end
+end

data/lib/hash_db/version.rb

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

data/lib/hash_db.rb

@@ -0,0 +1,9 @@
+require "hash_db/model/core"
+require "hash_db/model/query"
+require "hash_db/model/association"
+
+require "hash_db/version"
+
+module HashDB
+  InvalidKeyError = Class.new ArgumentError
+end

data/spec/hash_db/model/association_spec.rb

@@ -0,0 +1,51 @@
+require "spec_helper"
+
+describe HashDB::Model do
+  context ".has_many" do
+    it "should allow assigning and retrieving objects" do
+      post = Class.new do
+        include HashDB::Model
+      end
+
+      user = Class.new do
+        include HashDB::Model
+        has_many :posts, foreign_key: :user_id, class: post
+      end
+
+      u1 = user.create
+      u2 = user.create
+      p1 = post.create
+      p2 = post.create
+
+      u1.posts << p1
+      p1.user_id.should eq u1.id
+      u2.posts << p1
+      p1.user_id.should eq u2.id
+    end
+  end
+
+  context ".belongs_to" do
+    it "should allow assigning and retrieving objects" do
+      user = Class.new do
+        include HashDB::Model
+      end
+
+      post = Class.new do
+        include HashDB::Model
+        belongs_to :user, key: :user_id, class: user
+      end
+
+      u1 = user.create
+      u2 = user.create
+      p1 = post.create
+      p2 = post.create
+
+      p1.user = u1
+      p1.user_id.should eq u1.id
+      p1.user = u2
+      p1.user_id.should eq u2.id
+      p1.user_id = u1.id
+      p1.user.should eq u1
+    end
+  end
+end

data/spec/hash_db/model/core_spec.rb

@@ -0,0 +1,80 @@
+require "spec_helper"
+
+describe HashDB::Model do
+  let(:model) { Class.new { include HashDB::Model } }
+
+  context "include" do
+    it "should be includable" do
+      model.ancestors.should include HashDB::Model
+    end
+  end
+
+  context ".keys" do
+    it "should allow assigning and retrieving attributes" do
+      model.keys :integer, :string, :float, :object
+
+      m1 = model.new
+
+      m1.integer = 2
+      m1.string = "Hello"
+      m1.float = 4.2
+      m1.object = m1
+
+      m1.integer.should eq 2
+      m1.string.should eq "Hello"
+      m1.float.should eq 4.2
+      m1.object.should eq m1
+    end
+  end
+
+  context ".new" do
+    it "should assign passed args into keys" do
+      model.keys :integer, :string
+      m1 = model.new integer: 1, string: "test"
+      m1.integer.should eq 1
+      m1.string.should eq "test"
+    end
+
+    it "should raise ArgumentError if an invalid key is passed" do
+      expect { model.new invalid: 1 }.to raise_exception HashDB::InvalidKeyError
+    end
+  end
+
+  context ".create" do
+    it "should instantiate and save object" do
+      model.keys :integer
+      m1 = model.create
+      m2 = model.create integer: 10
+      model.all.should eq({1 => m1, 2 => m2})
+      m2.integer.should eq 10
+    end
+  end
+
+  context "#save" do
+    it "should assign id to models after they are saved" do
+      m1 = model.new.save
+      m1.id.should eq 1
+      m2 = model.new
+      m3 = model.new.save
+      m3.id.should eq 2
+    end
+
+    it "should save model into Class.all" do
+      m1 = model.new
+      m2 = model.new.save
+      m3 = model.new.save
+      model.all.should eq({ 1 => m2, 2 => m3 })
+    end
+  end
+
+  context "#destroy" do
+    it "should remove object from model.all" do
+      m1 = model.create
+      m2 = model.create
+      m1.destroy
+      model.all.should eq({ 2 => m2 })
+      m2.destroy
+      model.all.should be_empty
+    end
+  end
+end

data/spec/hash_db/model/query_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+
+describe HashDB::Model do
+  let :model do
+    Class.new do
+      include HashDB::Model
+      keys :integer, :string
+    end
+  end
+
+  context ".where" do
+    context "with hash" do
+      it "should filter by key(s) = value(s)" do
+        m1 = model.create integer: 4, string: "a"
+        m2 = model.create integer: 4, string: "b"
+        m3 = model.create string: "c"
+        m4 = model.create string: "b"
+
+        model.where(integer: 4).should eq [m1, m2]
+        model.where(string: "b").should eq [m2, m4]
+        model.where(string: "d").should eq []
+        model.where(integer: 4, string: "b").should eq [m2]
+      end
+    end
+
+    context "with array" do
+      it "should filter by [key, method, value](s)" do
+        m1 = model.create integer: 1
+        m2 = model.create integer: 2
+        m3 = model.create integer: 3
+        m4 = model.create integer: 4
+        model.where(:integer, :<, 2).should eq [m1]
+        model.where(:integer, :>, 2).should eq [m3, m4]
+        model.where([:integer, :>, 0], [:integer, :<, 3]).should eq [m1, m2]
+      end
+    end
+  end
+
+  context ".find_by" do
+    it "should delegate to .where.first" do
+      model.should_receive(:where).with(:integer, :<, 10).and_return([])
+      model.find_by(:integer, :<, 10).should eq nil
+    end
+  end
+end
+

data/spec/hash_db_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe HashDB do
+  it "should have a VERSION" do
+    HashDB::VERSION.should be_a String
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require "bundler"
+Bundler.require
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: hash_db
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Utkarsh Kukreti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A minimal, in-memory, ActiveRecord like database, backed by a Ruby Hash.
+email:
+- utkarshkukreti@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hash_db.gemspec
+- lib/hash_db.rb
+- lib/hash_db/model/association.rb
+- lib/hash_db/model/core.rb
+- lib/hash_db/model/query.rb
+- lib/hash_db/version.rb
+- spec/hash_db/model/association_spec.rb
+- spec/hash_db/model/core_spec.rb
+- spec/hash_db/model/query_spec.rb
+- spec/hash_db_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4016006914544296771
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4016006914544296771
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A minimal, in-memory, ActiveRecord like database, backed by a Ruby Hash.
+test_files:
+- spec/hash_db/model/association_spec.rb
+- spec/hash_db/model/core_spec.rb
+- spec/hash_db/model/query_spec.rb
+- spec/hash_db_spec.rb
+- spec/spec_helper.rb