friendly 0.3.3

data/friendly.gemspec

@@ -0,0 +1,201 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{friendly}
+  s.version = "0.3.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["James Golick"]
+  s.date = %q{2009-12-17}
+  s.description = %q{}
+  s.email = %q{james@giraffesoft.ca}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "APACHE-LICENSE",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "examples/friendly.yml",
+     "friendly.gemspec",
+     "lib/friendly.rb",
+     "lib/friendly/attribute.rb",
+     "lib/friendly/boolean.rb",
+     "lib/friendly/cache.rb",
+     "lib/friendly/cache/by_id.rb",
+     "lib/friendly/config.rb",
+     "lib/friendly/data_store.rb",
+     "lib/friendly/document.rb",
+     "lib/friendly/document_table.rb",
+     "lib/friendly/index.rb",
+     "lib/friendly/memcached.rb",
+     "lib/friendly/newrelic.rb",
+     "lib/friendly/query.rb",
+     "lib/friendly/sequel_monkey_patches.rb",
+     "lib/friendly/storage.rb",
+     "lib/friendly/storage_factory.rb",
+     "lib/friendly/storage_proxy.rb",
+     "lib/friendly/table.rb",
+     "lib/friendly/table_creator.rb",
+     "lib/friendly/time.rb",
+     "lib/friendly/translator.rb",
+     "lib/friendly/uuid.rb",
+     "rails/init.rb",
+     "spec/fakes/data_store_fake.rb",
+     "spec/fakes/database_fake.rb",
+     "spec/fakes/dataset_fake.rb",
+     "spec/fakes/document.rb",
+     "spec/fakes/serializer_fake.rb",
+     "spec/fakes/time_fake.rb",
+     "spec/integration/basic_object_lifecycle_spec.rb",
+     "spec/integration/batch_insertion_spec.rb",
+     "spec/integration/convenience_api_spec.rb",
+     "spec/integration/count_spec.rb",
+     "spec/integration/default_value_spec.rb",
+     "spec/integration/find_via_cache_spec.rb",
+     "spec/integration/finder_spec.rb",
+     "spec/integration/index_spec.rb",
+     "spec/integration/pagination_spec.rb",
+     "spec/integration/table_creator_spec.rb",
+     "spec/integration/write_through_cache_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/unit/attribute_spec.rb",
+     "spec/unit/cache_by_id_spec.rb",
+     "spec/unit/cache_spec.rb",
+     "spec/unit/config_spec.rb",
+     "spec/unit/data_store_spec.rb",
+     "spec/unit/document_spec.rb",
+     "spec/unit/document_table_spec.rb",
+     "spec/unit/friendly_spec.rb",
+     "spec/unit/index_spec.rb",
+     "spec/unit/memcached_spec.rb",
+     "spec/unit/query_spec.rb",
+     "spec/unit/storage_factory_spec.rb",
+     "spec/unit/storage_proxy_spec.rb",
+     "spec/unit/translator_spec.rb",
+     "website/index.html",
+     "website/scripts/clipboard.swf",
+     "website/scripts/shBrushAS3.js",
+     "website/scripts/shBrushBash.js",
+     "website/scripts/shBrushCSharp.js",
+     "website/scripts/shBrushColdFusion.js",
+     "website/scripts/shBrushCpp.js",
+     "website/scripts/shBrushCss.js",
+     "website/scripts/shBrushDelphi.js",
+     "website/scripts/shBrushDiff.js",
+     "website/scripts/shBrushErlang.js",
+     "website/scripts/shBrushGroovy.js",
+     "website/scripts/shBrushJScript.js",
+     "website/scripts/shBrushJava.js",
+     "website/scripts/shBrushJavaFX.js",
+     "website/scripts/shBrushPerl.js",
+     "website/scripts/shBrushPhp.js",
+     "website/scripts/shBrushPlain.js",
+     "website/scripts/shBrushPowerShell.js",
+     "website/scripts/shBrushPython.js",
+     "website/scripts/shBrushRuby.js",
+     "website/scripts/shBrushScala.js",
+     "website/scripts/shBrushSql.js",
+     "website/scripts/shBrushVb.js",
+     "website/scripts/shBrushXml.js",
+     "website/scripts/shCore.js",
+     "website/scripts/shLegacy.js",
+     "website/styles/friendly.css",
+     "website/styles/help.png",
+     "website/styles/ie.css",
+     "website/styles/magnifier.png",
+     "website/styles/page_white_code.png",
+     "website/styles/page_white_copy.png",
+     "website/styles/print.css",
+     "website/styles/printer.png",
+     "website/styles/screen.css",
+     "website/styles/shCore.css",
+     "website/styles/shThemeDefault.css",
+     "website/styles/shThemeDjango.css",
+     "website/styles/shThemeEclipse.css",
+     "website/styles/shThemeEmacs.css",
+     "website/styles/shThemeFadeToGrey.css",
+     "website/styles/shThemeMidnight.css",
+     "website/styles/shThemeRDark.css"
+  ]
+  s.homepage = %q{http://github.com/giraffesoft/friendly}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{}
+  s.test_files = [
+    "spec/fakes/data_store_fake.rb",
+     "spec/fakes/database_fake.rb",
+     "spec/fakes/dataset_fake.rb",
+     "spec/fakes/document.rb",
+     "spec/fakes/serializer_fake.rb",
+     "spec/fakes/time_fake.rb",
+     "spec/integration/basic_object_lifecycle_spec.rb",
+     "spec/integration/batch_insertion_spec.rb",
+     "spec/integration/convenience_api_spec.rb",
+     "spec/integration/count_spec.rb",
+     "spec/integration/default_value_spec.rb",
+     "spec/integration/find_via_cache_spec.rb",
+     "spec/integration/finder_spec.rb",
+     "spec/integration/index_spec.rb",
+     "spec/integration/pagination_spec.rb",
+     "spec/integration/table_creator_spec.rb",
+     "spec/integration/write_through_cache_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/unit/attribute_spec.rb",
+     "spec/unit/cache_by_id_spec.rb",
+     "spec/unit/cache_spec.rb",
+     "spec/unit/config_spec.rb",
+     "spec/unit/data_store_spec.rb",
+     "spec/unit/document_spec.rb",
+     "spec/unit/document_table_spec.rb",
+     "spec/unit/friendly_spec.rb",
+     "spec/unit/index_spec.rb",
+     "spec/unit/memcached_spec.rb",
+     "spec/unit/query_spec.rb",
+     "spec/unit/storage_factory_spec.rb",
+     "spec/unit/storage_proxy_spec.rb",
+     "spec/unit/translator_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
+      s.add_development_dependency(%q<jferris-mocha>, [">= 0"])
+      s.add_runtime_dependency(%q<sequel>, [">= 3.7.0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_runtime_dependency(%q<will_paginate>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<cucumber>, [">= 0"])
+      s.add_dependency(%q<jferris-mocha>, [">= 0"])
+      s.add_dependency(%q<sequel>, [">= 3.7.0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<will_paginate>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<cucumber>, [">= 0"])
+    s.add_dependency(%q<jferris-mocha>, [">= 0"])
+    s.add_dependency(%q<sequel>, [">= 3.7.0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<will_paginate>, [">= 0"])
+  end
+end
+

data/lib/friendly/attribute.rb

@@ -0,0 +1,65 @@
+require 'friendly/boolean'
+require 'friendly/uuid'
+
+module Friendly
+  class Attribute
+    CONVERTERS = {}
+    CONVERTERS[UUID]    = lambda { |s| UUID.new(s) }
+    CONVERTERS[Integer] = lambda { |s| s.to_i }
+    CONVERTERS[String]  = lambda { |s| s.to_s }
+    CONVERTERS[Boolean] = lambda { |s| s }
+
+    attr_reader :klass, :name, :type, :default_value
+
+    def initialize(klass, name, type, options = {})
+      @klass         = klass
+      @name          = name
+      @type          = type
+      @default_value = options[:default]
+      build_accessors
+    end
+
+    def typecast(value)
+      !type || value.is_a?(type) ? value : convert(value)
+    end
+
+    def convert(value)
+      assert_converter_exists(value)
+      CONVERTERS[type].call(value)
+    end
+
+    def default
+      if !default_value.nil?
+        default_value
+      elsif type.respond_to?(:new)
+        type.new
+      else
+        nil
+      end
+    end
+
+    protected
+      def build_accessors
+        n = name
+        klass.class_eval do
+          eval <<-__END__
+            def #{n}=(value)
+              @#{n} = self.class.attributes[:#{n}].typecast(value)
+            end
+
+            def #{n}
+              @#{n} ||= self.class.attributes[:#{n}].default
+            end
+          __END__
+        end
+      end
+
+      def assert_converter_exists(value)
+        unless CONVERTERS.has_key?(type)
+          msg = "Can't convert #{value} to #{type}. 
+                 Add a custom converter to Friendly::Attribute::CONVERTERS."
+          raise NoConverterExists, msg
+        end
+      end
+  end
+end

data/lib/friendly/boolean.rb

@@ -0,0 +1,6 @@
+module Friendly
+  module Boolean
+    # placeholder that represents a boolean
+    # since ruby has no boolean superclass
+  end
+end

data/lib/friendly/cache/by_id.rb

@@ -0,0 +1,33 @@
+module Friendly
+  class Cache
+    class ByID < Cache
+      def store(document)
+        cache.set(cache_key(document.id), document)
+      end
+      alias_method :create, :store
+      alias_method :update, :store
+
+      def destroy(document)
+        cache.delete(cache_key(document.id))
+      end
+
+      def first(query, &block)
+        cache.get(cache_key(query.conditions[:id]), &block)
+      end
+
+      def all(query, &block)
+        keys = query.conditions[:id].map { |k| cache_key(k) }
+        cache.multiget(keys, &block).values
+      end
+
+      def satisfies?(query)
+        query.conditions.keys == [:id]
+      end
+
+      protected
+        def cache_key(id)
+          [klass.name, version, id.to_guid].join("/")
+        end
+    end
+  end
+end

data/lib/friendly/cache.rb

@@ -0,0 +1,24 @@
+require 'friendly/storage'
+
+module Friendly
+  class Cache < Storage
+    class << self
+      def cache_for(klass, fields, options)
+        unless fields == [:id]
+          raise NotSupported, "Caching is only possible by id at the moment."
+        end
+
+        ByID.new(klass, fields, options)
+      end
+    end
+
+    attr_reader :klass, :fields, :cache, :version
+
+    def initialize(klass, fields, options = {}, cache = Friendly.cache)
+      @klass   = klass
+      @fields  = fields
+      @cache   = cache
+      @version = options[:version] || 0
+    end
+  end
+end

data/lib/friendly/config.rb

@@ -0,0 +1,5 @@
+module Friendly
+  class Config < Struct.new(:repository)
+  end
+end
+

data/lib/friendly/data_store.rb

@@ -0,0 +1,72 @@
+module Friendly
+  class DataStore
+    attr_reader :database
+
+    def initialize(database)
+      @database = database
+    end
+
+    def insert(persistable, attributes)
+      batch? ? batch_insert(persistable, attributes) :
+        immediate_insert(persistable, attributes)
+    end
+
+    def all(persistable, query)
+      filtered = dataset(persistable).where(query.conditions)
+      if query.limit || query.offset
+        filtered = filtered.limit(query.limit, query.offset)
+      end
+      filtered = filtered.order(query.order) if query.order
+      filtered.map
+    end
+
+    def first(persistable, query)
+      dataset(persistable).first(query.conditions)
+    end
+
+    def update(persistable, id, attributes)
+      dataset(persistable).where(:id => id).update(attributes)
+    end
+
+    def delete(persistable, id)
+      dataset(persistable).where(:id => id).delete
+    end
+
+    def count(persistable, query)
+      dataset(persistable).where(query.conditions).count
+    end
+
+    def start_batch
+      Thread.current[:friendly_batch] = Hash.new { |h, k| h[k] = [] }
+    end
+
+    def reset_batch
+      Thread.current[:friendly_batch] = nil
+    end
+
+    def flush_batch
+      batch = Thread.current[:friendly_batch]
+      batch.keys.each do |k|
+        database.from(k).multi_insert(batch[k], :commit_every => 1000)
+      end
+      reset_batch
+    end
+
+    protected
+      def dataset(persistable)
+        database.from(persistable.table_name)
+      end
+
+      def immediate_insert(persistable, attributes)
+        dataset(persistable).insert(attributes)
+      end
+
+      def batch_insert(persistable, attributes)
+        Thread.current[:friendly_batch][persistable.table_name] << attributes
+      end
+
+      def batch?
+        Thread.current[:friendly_batch]
+      end
+  end
+end

data/lib/friendly/document.rb

@@ -0,0 +1,165 @@
+require 'active_support/inflector'
+
+module Friendly
+  module Document
+    class << self
+      attr_writer :documents
+
+      def included(klass)
+        documents << klass
+        klass.class_eval do
+          extend ClassMethods
+          attribute :id,         UUID
+          attribute :created_at, Time
+          attribute :updated_at, Time
+        end
+      end
+
+      def documents
+        @documents ||= []
+      end
+
+      def create_tables!
+        documents.each { |d| d.create_tables! }
+      end
+    end
+
+    module ClassMethods
+      attr_writer :storage_proxy, :query_klass, :table_name, :collection_klass
+
+      def create_tables!
+        storage_proxy.create_tables!
+      end
+
+      def attribute(name, type = nil, options = {})
+        attributes[name] = Attribute.new(self, name, type, options)
+      end
+
+      def storage_proxy
+        @storage_proxy ||= StorageProxy.new(self)
+      end
+
+      def query_klass
+        @query_klass ||= Query
+      end
+
+      def collection_klass
+        @collection_klass ||= WillPaginate::Collection
+      end
+
+      def indexes(*args)
+        storage_proxy.add(args)
+      end
+
+      def caches_by(*fields)
+        options = fields.last.is_a?(Hash) ? fields.pop : {}
+        storage_proxy.cache(fields, options)
+      end
+
+      def attributes
+        @attributes ||= {}
+      end
+
+      def first(query)
+        storage_proxy.first(query(query))
+      end
+
+      def all(query)
+        storage_proxy.all(query(query))
+      end
+
+      def find(id)
+        doc = first(:id => id)
+        raise RecordNotFound, "Couldn't find #{name}/#{id}" if doc.nil?
+        doc
+      end
+
+      def count(conditions)
+        storage_proxy.count(query(conditions))
+      end
+
+      def paginate(conditions)
+        query      = query(conditions)
+        count      = count(query)
+        collection = collection_klass.new(query.page, query.per_page, count)
+        collection.replace(all(query))
+      end
+
+      def create(attributes = {})
+        doc = new(attributes)
+        doc.save
+        doc
+      end
+
+      def table_name
+        @table_name ||= name.pluralize.underscore
+      end
+
+      protected
+        def query(conditions)
+          conditions.is_a?(Query) ? conditions : query_klass.new(conditions)
+        end
+    end
+
+    def initialize(opts = {})
+      self.attributes = opts
+    end
+
+    def attributes=(attrs)
+      assert_no_duplicate_keys(attrs)
+      attrs.each { |name, value| send("#{name}=", value) }
+    end
+
+    def save
+      new_record? ? storage_proxy.create(self) : storage_proxy.update(self)
+    end
+
+    def update_attributes(attributes)
+      self.attributes = attributes
+      save
+    end
+
+    def destroy
+      storage_proxy.destroy(self)
+    end
+
+    def to_hash
+      Hash[*self.class.attributes.keys.map { |n| [n, send(n)] }.flatten]
+    end
+
+    def table_name
+      self.class.table_name
+    end
+
+    def new_record?
+      new_record
+    end
+
+    def new_record
+      @new_record = true if @new_record.nil?
+      @new_record
+    end
+
+    def new_record=(value)
+      @new_record = value
+    end
+
+    def storage_proxy
+      self.class.storage_proxy
+    end
+
+    def ==(comparison_object)
+      comparison_object.equal?(self) ||
+        (comparison_object.is_a?(self.class) &&
+          !comparison_object.new_record? && 
+            comparison_object.id == id)
+    end
+
+    protected
+      def assert_no_duplicate_keys(hash)
+        if hash.keys.map { |k| k.to_s }.uniq.length < hash.keys.length
+          raise ArgumentError, "Duplicate keys: #{hash.inspect}"
+        end
+      end
+  end
+end

data/lib/friendly/document_table.rb

@@ -0,0 +1,56 @@
+require 'friendly/table'
+
+module Friendly
+  class DocumentTable < Table
+    attr_reader :klass, :translator
+
+    def initialize(klass, datastore=Friendly.datastore, translator=Translator.new)
+      super(datastore)
+      @klass      = klass
+      @translator = translator
+    end
+
+    def table_name
+      klass.table_name
+    end
+
+    def satisfies?(query)
+      query.conditions.keys == [:id] && !query.order
+    end
+
+    def create(document)
+      record = translator.to_record(document)
+      datastore.insert(document, record)
+      update_document(document, record)
+    end
+
+    def update(document)
+      record = translator.to_record(document)
+      datastore.update(document, document.id, record)
+      update_document(document, record)
+    end
+
+    def destroy(document)
+      datastore.delete(document, document.id)
+    end
+
+    def first(query)
+      record = datastore.first(klass, query)
+      record && to_object(record)
+    end
+
+    def all(query)
+      datastore.all(klass, query).map { |r| to_object(r) }
+    end
+
+    protected
+      def update_document(document, record)
+        attrs = record.reject { |k,v| k == :attributes }.merge(:new_record => false)
+        document.attributes = attrs
+      end
+
+      def to_object(record)
+        translator.to_object(klass, record)
+      end
+  end
+end