friendly_postgres 0.4.3 → 0.4.5

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Changelog
 =========
 
+### (0.4.4)
+
+  * (jamesgolick) Make it possible to query with order, but no conditions.
+  * (jamesgolick) Add change tracking. This is mostly to facilitate arbitrary caches.
+
 ### 0.4.2
 
   * (nullstyle) convert UUID to SQL::Blob so that Sequel can properly escape it in databases that don't treat binary strings like regular strings.

data/VERSION

@@ -1 +1 @@
-0.4.3
+0.4.5

data/friendly.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{friendly}
-  s.version = "0.4.3"
+  s.version = "0.4.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["James Golick"]
-  s.date = %q{2009-12-24}
+  s.date = %q{2010-01-16}
   s.description = %q{}
   s.email = %q{jamesgolick@gmail.com}
   s.extra_rdoc_files = [
@@ -37,13 +37,17 @@ Gem::Specification.new do |s|
      "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/associations.rb",
+     "lib/friendly/document/attributes.rb",
+     "lib/friendly/document/convenience.rb",
+     "lib/friendly/document/mixin.rb",
+     "lib/friendly/document/scoping.rb",
+     "lib/friendly/document/storage.rb",
      "lib/friendly/document_table.rb",
      "lib/friendly/index.rb",
      "lib/friendly/memcached.rb",
-     "lib/friendly/named_scope.rb",
      "lib/friendly/newrelic.rb",
      "lib/friendly/query.rb",
      "lib/friendly/scope.rb",
@@ -71,6 +75,7 @@ Gem::Specification.new do |s|
      "spec/integration/convenience_api_spec.rb",
      "spec/integration/count_spec.rb",
      "spec/integration/default_value_spec.rb",
+     "spec/integration/dirty_tracking_spec.rb",
      "spec/integration/find_via_cache_spec.rb",
      "spec/integration/finder_spec.rb",
      "spec/integration/has_many_spec.rb",
@@ -87,14 +92,13 @@ Gem::Specification.new do |s|
      "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/attributes_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/named_scope_spec.rb",
      "spec/unit/query_spec.rb",
      "spec/unit/scope_proxy_spec.rb",
      "spec/unit/scope_spec.rb",
@@ -164,6 +168,7 @@ Gem::Specification.new do |s|
      "spec/integration/convenience_api_spec.rb",
      "spec/integration/count_spec.rb",
      "spec/integration/default_value_spec.rb",
+     "spec/integration/dirty_tracking_spec.rb",
      "spec/integration/find_via_cache_spec.rb",
      "spec/integration/finder_spec.rb",
      "spec/integration/has_many_spec.rb",
@@ -179,14 +184,13 @@ Gem::Specification.new do |s|
      "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/attributes_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/named_scope_spec.rb",
      "spec/unit/query_spec.rb",
      "spec/unit/scope_proxy_spec.rb",
      "spec/unit/scope_spec.rb",

data/friendly_postgres.gemspec

@@ -0,0 +1,237 @@
+# 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_postgres}
+  s.version = "0.4.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["James Golick"]
+  s.date = %q{2010-01-24}
+  s.description = %q{}
+  s.email = %q{jamesgolick@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "APACHE-LICENSE",
+     "CHANGELOG.md",
+     "CONTRIBUTORS.md",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "TODO.md",
+     "VERSION",
+     "examples/friendly.yml",
+     "friendly.gemspec",
+     "friendly_postgres.gemspec",
+     "lib/friendly.rb",
+     "lib/friendly/associations.rb",
+     "lib/friendly/associations/association.rb",
+     "lib/friendly/associations/set.rb",
+     "lib/friendly/attribute.rb",
+     "lib/friendly/boolean.rb",
+     "lib/friendly/cache.rb",
+     "lib/friendly/cache/by_id.rb",
+     "lib/friendly/data_store.rb",
+     "lib/friendly/document.rb",
+     "lib/friendly/document/associations.rb",
+     "lib/friendly/document/attributes.rb",
+     "lib/friendly/document/convenience.rb",
+     "lib/friendly/document/mixin.rb",
+     "lib/friendly/document/scoping.rb",
+     "lib/friendly/document/storage.rb",
+     "lib/friendly/document_table.rb",
+     "lib/friendly/index.rb",
+     "lib/friendly/memcached.rb",
+     "lib/friendly/newrelic.rb",
+     "lib/friendly/query.rb",
+     "lib/friendly/scope.rb",
+     "lib/friendly/scope_proxy.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/config.yml.example",
+     "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/ad_hoc_scopes_spec.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/dirty_tracking_spec.rb",
+     "spec/integration/find_via_cache_spec.rb",
+     "spec/integration/finder_spec.rb",
+     "spec/integration/has_many_spec.rb",
+     "spec/integration/index_spec.rb",
+     "spec/integration/named_scope_spec.rb",
+     "spec/integration/pagination_spec.rb",
+     "spec/integration/scope_chaining_spec.rb",
+     "spec/integration/table_creator_spec.rb",
+     "spec/integration/write_through_cache_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/unit/associations/association_spec.rb",
+     "spec/unit/associations/set_spec.rb",
+     "spec/unit/attribute_spec.rb",
+     "spec/unit/cache_by_id_spec.rb",
+     "spec/unit/cache_spec.rb",
+     "spec/unit/data_store_spec.rb",
+     "spec/unit/document/attributes_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/scope_proxy_spec.rb",
+     "spec/unit/scope_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://friendlyorm.com}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{NoSQL with MySQL in Ruby}
+  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/ad_hoc_scopes_spec.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/dirty_tracking_spec.rb",
+     "spec/integration/find_via_cache_spec.rb",
+     "spec/integration/finder_spec.rb",
+     "spec/integration/has_many_spec.rb",
+     "spec/integration/index_spec.rb",
+     "spec/integration/named_scope_spec.rb",
+     "spec/integration/pagination_spec.rb",
+     "spec/integration/scope_chaining_spec.rb",
+     "spec/integration/table_creator_spec.rb",
+     "spec/integration/write_through_cache_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/unit/associations/association_spec.rb",
+     "spec/unit/associations/set_spec.rb",
+     "spec/unit/attribute_spec.rb",
+     "spec/unit/cache_by_id_spec.rb",
+     "spec/unit/cache_spec.rb",
+     "spec/unit/data_store_spec.rb",
+     "spec/unit/document/attributes_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/scope_proxy_spec.rb",
+     "spec/unit/scope_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_development_dependency(%q<memcached>, [">= 0"])
+      s.add_runtime_dependency(%q<sequel>, [">= 3.7.0"])
+      s.add_runtime_dependency(%q<json_pure>, [">= 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<memcached>, [">= 0"])
+      s.add_dependency(%q<sequel>, [">= 3.7.0"])
+      s.add_dependency(%q<json_pure>, [">= 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<memcached>, [">= 0"])
+    s.add_dependency(%q<sequel>, [">= 3.7.0"])
+    s.add_dependency(%q<json_pure>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<will_paginate>, [">= 0"])
+  end
+end
+

data/lib/friendly/attribute.rb

@@ -59,18 +59,25 @@ module Friendly
         nil
       end
     end
+
+    def assign_default_value(document)
+      document.send(:"#{name}=", default)
+    end
       
     protected
       def build_accessors
         n = name
         klass.class_eval do
+          attr_reader n, :"#{n}_was"
+
           eval <<-__END__
             def #{n}=(value)
+              will_change(:#{n})
               @#{n} = self.class.attributes[:#{n}].typecast(value)
             end
 
-            def #{n}
-              @#{n} ||= self.class.attributes[:#{n}].default
+            def #{n}_changed?
+              attribute_changed?(:#{n})
             end
           __END__
         end

data/lib/friendly/data_store.rb

@@ -12,7 +12,8 @@ module Friendly
     end
 
     def all(persistable, query)
-      filtered = dataset(persistable).where(query.conditions)
+      filtered = dataset(persistable)
+      filtered = filtered.where(query.conditions) unless query.conditions.empty?
       if query.limit || query.offset
         filtered = filtered.limit(query.limit, query.offset)
       end

data/lib/friendly/document/associations.rb

@@ -0,0 +1,50 @@
+require 'friendly/associations'
+require 'friendly/document/mixin'
+
+module Friendly
+  module Document
+    module Associations
+      extend Mixin
+
+      module ClassMethods
+        attr_writer :association_set
+
+        def association_set
+          @association_set ||= Friendly::Associations::Set.new(self)
+        end
+
+        # Add a has_many association.
+        #
+        # e.g.
+        #
+        #     class Post
+        #       attribute :user_id, Friendly::UUID
+        #       indexes   :user_id
+        #     end
+        #      
+        #     class User
+        #       has_many :posts
+        #     end
+        #     
+        #     @user = User.create
+        #     @post = @user.posts.create
+        #     @user.posts.all == [@post] # => true
+        #
+        # _Note: Make sure that the target model is indexed on the foreign key. If it isn't, querying the association will raise Friendly::MissingIndex._
+        #
+        # Friendly defaults the foreign key to class_name_id just like ActiveRecord.
+        # It also converts the name of the association to the name of the target class just like ActiveRecord does.
+        #
+        # The biggest difference in semantics between Friendly's has_many and active_record's is that Friendly's just returns a Friendly::Scope object. If you want all the associated objects, you have to call #all to get them. You can also use any other Friendly::Scope method.
+        #
+        # @param [Symbol] name The name of the association and plural name of the target class.
+        # @option options [String] :class_name The name of the target class of this association if it is different than the name would imply.
+        # @option options [Symbol] :foreign_key Override the foreign key.
+        # 
+        def has_many(name, options = {})
+          association_set.add(name, options)
+        end
+      end
+    end
+  end
+end

data/lib/friendly/document/attributes.rb

@@ -0,0 +1,114 @@
+require 'friendly/document/mixin'
+require 'set'
+
+module Friendly
+  module Document
+    module Attributes
+      extend Mixin
+
+      module ClassMethods
+        def attribute(name, type = nil, options = {})
+          attributes[name] = Attribute.new(self, name, type, options)
+        end
+
+        def attributes
+          @attributes ||= {}
+        end
+
+        def new_without_change_tracking(attributes)
+          doc = new(attributes)
+          doc.reset_changes
+          doc
+        end
+      end
+
+      def initialize(opts = {})
+        assign_default_values
+        self.attributes = opts
+      end
+
+      def attributes=(attrs)
+        assert_no_duplicate_keys(attrs)
+        attrs.each { |name, value| assign(name, value) }
+      end
+
+      def to_hash
+        Hash[*self.class.attributes.keys.map { |n| [n, send(n)] }.flatten]
+      end
+
+      def assign_default_values
+        self.class.attributes.values.each { |a| a.assign_default_value(self) }
+      end
+
+      def assign(name, value)
+        send(:"#{name}=", value)
+      end
+
+      # Notify the object that an attribute is about to change.
+      #
+      # @param [Symbol] attribute The name of the attribute about to change.
+      #
+      def will_change(attribute)
+        changed << attribute
+        instance_variable_set(:"@#{attribute}_was", send(attribute))
+      end
+
+      # Get the original value of an attribute that has changed.
+      #
+      # @param [Symbol] attribute The name of the attribute.
+      #
+      def attribute_was(attribute)
+        instance_variable_get(:"@#{attribute}_was")
+      end
+
+      # Has this attribute changed?
+      #
+      # @param [Symbol] attribute The name of the attribute.
+      #
+      def attribute_changed?(attribute)
+        changed.include?(attribute)
+      end
+
+      # Have any of the attributes that are being tracked changed since last reset?
+      #
+      def changed?
+        !changed.empty?
+      end
+
+      # Which attributes that are being tracked have changed since last reset?
+      #
+      def changed
+        @changed ||= Set.new
+      end
+
+      # Reset all the changes to this object.
+      #
+      def reset_changes
+        changed.each { |c| not_changed(c) }.clear
+      end
+
+      # Reset the changed-ness of one attribute.
+      #
+      def not_changed(attribute)
+        instance_variable_set(:"@#{attribute}_was", nil)
+        changed.delete(attribute)
+      end
+
+      # Override #save to reset changes afterwards
+      #
+      # @override
+      #
+      def save
+        super
+        reset_changes
+      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
+end

data/lib/friendly/document/convenience.rb

@@ -0,0 +1,41 @@
+require 'friendly/document/mixin'
+
+module Friendly
+  module Document
+    module Convenience
+      extend Mixin
+
+      module ClassMethods
+        attr_writer :collection_klass
+        
+        def collection_klass
+          @collection_klass ||= WillPaginate::Collection
+        end
+
+        def find(id)
+          doc = first(:id => id)
+          raise RecordNotFound, "Couldn't find #{name}/#{id}" if doc.nil?
+          doc
+        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
+      end
+
+      def update_attributes(attributes)
+        self.attributes = attributes
+        save
+      end
+    end
+  end
+end

data/lib/friendly/document/mixin.rb

@@ -0,0 +1,15 @@
+module Friendly
+  module Document
+    module Mixin
+      # FIXME: I'm not in love with this. But, I also don't think it's the
+      # end of the world.
+      def included(klass)
+        if klass.const_defined?(:ClassMethods)
+          klass.const_get(:ClassMethods).send(:include, const_get(:ClassMethods))
+        else
+          klass.send(:extend, const_get(:ClassMethods))
+        end
+      end
+    end
+  end
+end

data/lib/friendly/document/scoping.rb

@@ -0,0 +1,66 @@
+require 'friendly/document/mixin'
+
+module Friendly
+  module Document
+    module Scoping
+      extend Mixin
+
+      module ClassMethods
+        attr_writer :scope_proxy
+        
+        def scope_proxy
+          @scope_proxy ||= ScopeProxy.new(self)
+        end
+
+        # Add a named scope to this Document.
+        #
+        # e.g.
+        #     
+        #     class Post
+        #       indexes     :created_at
+        #       named_scope :recent, :order! => :created_at.desc
+        #     end
+        #
+        # Then, you can access the recent posts with:
+        #
+        #     Post.recent.all
+        # ...or...
+        #     Post.recent.first
+        #
+        # Both #all and #first also take additional parameters:
+        #
+        #     Post.recent.all(:author_id => @author.id)
+        #
+        # Scopes are also chainable. See the README or Friendly::Scope docs for details.
+        #
+        # @param [Symbol] name the name of the scope.
+        # @param [Hash] parameters the query that this named scope will perform.
+        #
+        def named_scope(name, parameters)
+          scope_proxy.add_named(name, parameters)
+        end
+
+        # Returns boolean based on whether the Document has a scope by a particular name.
+        #
+        # @param [Symbol] name The name of the scope in question.
+        #
+        def has_named_scope?(name)
+          scope_proxy.has_named_scope?(name)
+        end
+
+        # Create an ad hoc scope on this Document.
+        #
+        # e.g.
+        #     
+        #     scope = Post.scope(:order! => :created_at)
+        #     scope.all # => [#<Post>, #<Post>]
+        #
+        # @param [Hash] parameters the query parameters to create the scope with.
+        #
+        def scope(parameters)
+          scope_proxy.ad_hoc(parameters)
+        end
+      end
+    end
+  end
+end