riak-model 0.0.1.pre

data/.gitignore

@@ -0,0 +1,12 @@
+*~
+.*.swp
+.#*
+
+.DS_Store
+.cache
+.yardoc
+
+/*.gem
+script/*
+gems/*
+!gems/cache

data/CHANGELOG

@@ -0,0 +1,2 @@
+= Version 0.0.1
+  * Initial import

data/Gemfile

@@ -0,0 +1,10 @@
+# gems
+gem "nake"
+gem "rspec"
+gem "code-cleaner"
+
+gem "riak", "0.0.1.pre"
+
+# settings
+bin_path "script"
+bundle_path "gems"

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jakub Stastny aka Botanicus
+
+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.textile

@@ -0,0 +1,19 @@
+h1. About
+
+Simple ODM for Riak. It provides simple validations, but don't expect anything fancy, point of this ODM is to be light-weight and fast. If you need something more robust, use "do_riak":http://github.com/botanicus/do_riak.
+
+h1. Installation
+
+* Prerelease: @gem install riak-model --prerelease@
+* Stable version: @gem install riak-model@
+
+h1. Usage
+
+# TODO: write how to use your library
+
+h1. Links
+
+* "Source Code":http://github.com/botanicus/riak-model
+* "Wiki":http://wiki.github.com/botanicus/riak-model
+* "API Docs":http://rdoc.info/projects/botanicus/riak-model
+* "Bug reporting":http://github.com/botanicus/riak-model/issues

data/TODO.txt

@@ -0,0 +1,2 @@
+- simple validations probably not via validatable (there is do_riak for this)
+- state tracking (dirty?)

data/deps.rip

@@ -0,0 +1,5 @@
+#!/usr/bin/env rip install
+
+# Syntax:
+# repository [tag or commit to install]
+git://github.com/botanicus/riak.git

data/lib/riak/link.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+module Riak
+  class Link
+    attr_reader :object
+    def initialize(object)
+      @object = object
+    end
+
+    def to_a
+      [object.bucket, object.key, object.key] # NOTE: the last one is probably name
+    end
+
+    def to_json
+      JSON.generate(self.to_a)
+    end
+  end
+end

data/lib/riak/model.rb

@@ -0,0 +1,175 @@
+# encoding: utf-8
+
+require "riak/interfaces/jiak"
+
+module Riak
+  class Model
+    # Riak::Model.not_found = Rango::Exceptions::NotFound
+    # # and then you can use
+    # def show(id)
+    #   render "post.html", post: Post.get!(id)
+    # end
+    # # rather than
+    # def show(id)
+    #   post = Post.get(id)
+    #   raise NotFound if post.nil?
+    #   render "post.html", post: post
+    # end
+    def self.not_found
+      @@not_found ||= Class.new(StandardError)
+    end
+
+    def self.not_found=(klass)
+      @@not_found = klass
+    end
+
+    def self.config
+      @@config ||= ["127.0.0.1", 8098]
+    end
+
+    def self.client
+      @@client ||= Client.new(*config)
+    end
+
+    attr_writer :read_mask
+    def self.read_mask
+      @read_mask ||= "*"
+    end
+
+    attr_writer :write_mask
+    def self.write_mask
+      @write_mask ||= "*"
+    end
+
+    def self.set_bucket_schema
+      options = {allowed_fields: allowed_fields, read_mask: read_mask, write_mask: write_mask}
+      client.set_bucket_schema(bucket, options)
+    end
+
+    def self.required_fields
+      self.properties.reduce(Array.new) do |array, pair|
+        array.push(pair.first) if pair.last.required?
+        array
+      end
+    end
+
+    def self.allowed_fields
+      self.properties.keys
+    end
+
+    def self.properties
+      @@properties ||= Hash.new
+    end
+
+    def self.property(name, type, options = Hash.new)
+      attr_accessor name
+      self.properties[name] = Property.new(type, options)
+    end
+
+    def self.schema(&block)
+      block.call
+      self.set_bucket_schema
+    end
+
+    def self.list_bucket
+      symbolize_keys = lambda do |hash|
+        hash.reduce(Hash.new) do |hash, pair|
+          if pair.last.is_a?(Hash)
+            hash.merge(pair.first.to_sym => symbolize_keys.call(pair.last))
+          else
+            hash.merge(pair.first.to_sym => pair.last)
+          end
+        end
+      end
+
+      symbolize_keys.call(client.list_bucket(bucket))
+    end
+
+    def self.bucket
+      self.name.split("::").last.downcase # TODO: snake_case
+    end
+
+    def self.create(properties = Hash.new)
+      self.new(properties).save
+    end
+
+    def self.delete(key, rw = nil)
+      client.delete(bucket, key, rw)
+    end
+
+    # Post.get(id) # blocking
+    # Post.get(id) { |post| render "post.html", post: post }
+    def self.get(key, &block)
+      unless block.nil? # async
+        raise NotImplementedError
+      else
+        properties = client.get(self.bucket, key)
+        self.new(properties[:object])
+      end
+    rescue # TODO: specify a class!
+    end
+
+    def self.get!(key)
+      self.get(key) || raise(NotFound, "Object with key #{key} doesn't exist!")
+    end
+
+    def self.all
+      data = client.bucket(bucket)
+      data[:keys].map { |key| self.get(key) }
+    end
+
+    def initialize(properties = Hash.new)
+      properties.each do |key, value|
+        setter = "#{key}="
+        if self.respond_to?(setter)
+          self.send(setter, value)
+        end
+      end
+    end
+
+    def to_riak
+      {bucket: self.class.bucket, key: key, object: properties, links: links}
+    end
+
+    def properties
+      self.class.properties.keys.inject(Hash.new) do |hash, property|
+        hash.merge(property => self.send(property))
+      end
+    end
+
+    def links
+      @links ||= begin
+        links = Array.new
+        def links.<<(object)
+          self.insert(self.length, Link.new(object))
+        end
+
+        def links.push(object)
+          self.insert(self.length, Link.new(object))
+        end
+
+        def links.unshift(object)
+          self.insert(0, Link.new(object))
+        end
+
+        links
+      end
+    end
+
+    def save
+      self.class.client.store(self.to_riak)
+    end
+
+    def delete(rw = nil)
+      self.class.delete(self.key, rw)
+    end
+
+    # If the key is nil Riak will set the ID for you.
+    # Nevertheless you can rewrite it:
+    # def key
+    #   @key ||= self.to_slug
+    # end
+    def key
+    end
+  end
+end

data/lib/riak/model/version.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+module Riak
+  module Model
+    VERSION = "0.0.1"
+  end
+end

data/lib/riak/property.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+module Riak
+  class Property
+    attr_reader :type, :options
+    def initialize(type, options)
+      @type, @options = type, options
+    end
+    
+    def value
+    end
+    
+    def original_value
+    end
+    
+    def dirty?
+    end
+
+    def required?
+      options[:nullable] == false
+    end
+  end
+end

data/riak-model.gemspec

@@ -0,0 +1,39 @@
+#!/usr/bin/env gem build
+# encoding: utf-8
+
+# Run ./riak-model.gemspec or gem build riak-model.gemspec
+# NOTE: we can't use require_relative because when we run gem build, it use eval for executing this file
+require File.join(File.dirname(__FILE__), "lib/riak/model/version")
+
+Gem::Specification.new do |s|
+  s.name = "riak-model"
+  s.version = Riak::Model::VERSION
+  s.authors = ["Jakub Stastny aka Botanicus"]
+  s.homepage = "http://github.com/botanicus/riak-model"
+  s.summary = "Simple ODM for Riak."
+  s.description = "" # TODO: long description
+  s.cert_chain = nil
+  s.email = "knava.bestvinensis@gmail.com"
+  s.has_rdoc = true
+
+  # files
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+
+  # Ruby version
+  s.required_ruby_version = ::Gem::Requirement.new(">= 1.9")
+
+  # runtime dependencies
+  s.add_dependency "riak"
+
+  begin
+    require "changelog"
+  rescue LoadError
+    warn "You have to have changelog gem installed for post install message"
+  else
+    s.post_install_message = CHANGELOG.new.version_changes
+  end
+
+  # RubyForge
+  s.rubyforge_project = "riak-model"
+end

data/riak-model.pre.gemspec

@@ -0,0 +1,8 @@
+#!/usr/bin/env gem build
+# encoding: utf-8
+
+# You might think this is a terrible mess and guess what, you're
+# right mate! However say thanks to authors of RubyGems, not me.
+eval(File.read("riak-model.gemspec")).tap do |specification|
+  specification.version = "#{specification.version}.pre"
+end

data/spec/riak/model_spec.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+require_relative "spec_helper"
+
+describe Riak::Model do
+  it "should have VERSION constant" do
+    Riak::Model::VERSION.should be_kind_of(String)
+    Riak::Model::VERSION.should match(/^\d+\.\d+\.\d+$/)
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,5 @@
+--colour
+--format
+progress
+--loadby
+mtime

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+# constants
+SPEC_ROOT = File.dirname(__FILE__)
+ROOT      = File.expand_path(File.join(SPEC_ROOT, ".."))
+LIBDIR    = File.join(ROOT, "lib")
+
+# load paths
+$:.unshift(LIBDIR)
+
+require "spec" # so you can run ruby spec/riak-model/whatever_spec.rb

data/tasks.rb

@@ -0,0 +1,37 @@
+#!./script/nake
+# encoding: utf-8
+
+begin
+  require_relative "gems/environment.rb"
+rescue LoadError
+  abort "You have to install bundler and run gem bundle first!"
+end
+
+ENV["PATH"] = "script:#{ENV["PATH"]}"
+
+require "nake/tasks/gem"
+require "nake/tasks/spec"
+require "nake/tasks/release"
+
+require_relative "lib/riak/model/version"
+
+begin
+  load "code-cleaner.nake"
+  Nake::Task["hooks:whitespace:install"].tap do |task|
+    task.config[:path] = "script"
+    task.config[:encoding] = "utf-8"
+    task.config[:whitelist] = '(bin/[^/]+|.+\.(rb|rake|nake|thor|task))$'
+  end
+rescue LoadError
+  warn "If you want to contribute to Riak::Model, please install code-cleaner and then run ./tasks.rb hooks:whitespace:install to get Git pre-commit hook for removing trailing whitespace."
+end
+
+# Setup encoding, so all the operations
+# with strings from another files will work
+Encoding.default_internal = "utf-8"
+Encoding.default_external = "utf-8"
+
+Task[:build].config[:gemspec] = "riak-model.gemspec"
+Task[:prerelease].config[:gemspec] = "riak-model.pre.gemspec"
+Task[:release].config[:name] = "riak-model"
+Task[:release].config[:version] = Riak::Model::VERSION

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: riak-model
+version: !ruby/object:Gem::Version 
+  version: 0.0.1.pre
+platform: ruby
+authors: 
+- Jakub Stastny aka Botanicus
+autorequire: 
+bindir: bin
+cert_chain: 
+date: 2010-01-12 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: riak
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: ""
+email: knava.bestvinensis@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CHANGELOG
+- Gemfile
+- LICENSE
+- README.textile
+- TODO.txt
+- deps.rip
+- examples/model.rb
+- gems/cache/code-cleaner-0.8.1.gem
+- gems/cache/nake-0.0.8.gem
+- gems/cache/rack-1.1.0.gem
+- gems/cache/riak-0.0.1.pre.gem
+- gems/cache/rspec-1.3.0.gem
+- gems/cache/term-ansicolor-1.0.4.gem
+- gems/cache/typhoeus-0.1.13.gem
+- lib/riak/link.rb
+- lib/riak/model.rb
+- lib/riak/model/version.rb
+- lib/riak/property.rb
+- riak-model.gemspec
+- riak-model.pre.gemspec
+- spec/riak/model_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks.rb
+has_rdoc: true
+homepage: http://github.com/botanicus/riak-model
+licenses: []
+
+post_install_message: "[\e[32mVersion 0.0.1\e[0m] Initial import\n"
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.9"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 1.3.1
+  version: 
+requirements: []
+
+rubyforge_project: riak-model
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Simple ODM for Riak.
+test_files: []
+