dm-types 1.1.0 → 1.2.0.rc1

data/Gemfile

@@ -5,32 +5,33 @@ source 'http://rubygems.org'
 SOURCE         = ENV.fetch('SOURCE', :git).to_sym
 REPO_POSTFIX   = SOURCE == :path ? ''                                : '.git'
 DATAMAPPER     = SOURCE == :path ? Pathname(__FILE__).dirname.parent : 'http://github.com/datamapper'
-DM_VERSION     = '~> 1.1.0'
-DO_VERSION     = '~> 0.10.2'
+DM_VERSION     = '~> 1.2.0.rc1'
+DO_VERSION     = '~> 0.10.6'
 DM_DO_ADAPTERS = %w[ sqlite postgres mysql oracle sqlserver ]
 
-gem 'bcrypt-ruby', '~> 2.1.4'
+gem 'bcrypt-ruby', '~> 3.0.0'
 gem 'dm-core',     DM_VERSION, SOURCE => "#{DATAMAPPER}/dm-core#{REPO_POSTFIX}"
 gem 'fastercsv',   '~> 1.5.4'
-gem 'json',        '~> 1.4.6'
-gem 'stringex',    '~> 1.2.0'
+gem 'multi_json',  '~> 1.0.3'
+gem 'json',        '~> 1.5.4', :platforms => [ :ruby_18 ]
+gem 'stringex',    '~> 1.3.0'
 gem 'uuidtools',   '~> 2.1.2'
 
 group :development do
 
   gem 'dm-validations', DM_VERSION, SOURCE => "#{DATAMAPPER}/dm-validations#{REPO_POSTFIX}"
-  gem 'jeweler',        '~> 1.5.2'
-  gem 'rake',           '~> 0.8.7'
-  gem 'rspec',          '~> 1.3.1'
+  gem 'jeweler',        '~> 1.6.4'
+  gem 'rake',           '~> 0.9.2'
+  gem 'rspec',          '~> 1.3.2'
 
 end
 
 platforms :mri_18 do
   group :quality do
 
-    gem 'rcov',      '~> 0.9.9'
-    gem 'yard',      '~> 0.6'
-    gem 'yardstick', '~> 0.2'
+    gem 'rcov',      '~> 0.9.10'
+    gem 'yard',      '~> 0.7.2'
+    gem 'yardstick', '~> 0.4'
 
   end
 end

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 
 begin
-  gem 'jeweler', '~> 1.5.2'
+  gem 'jeweler', '~> 1.6.4'
   require 'jeweler'
 
   Jeweler::Tasks.new do |gem|
@@ -21,5 +21,5 @@ begin
 
   FileList['tasks/**/*.rake'].each { |task| import task }
 rescue LoadError
-  puts 'Jeweler (or a dependency) not available. Install it with: gem install jeweler -v 1.5.2'
+  puts 'Jeweler (or a dependency) not available. Install it with: gem install jeweler -v 1.6.4'
 end

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0.rc1

data/dm-types.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{dm-types}
-  s.version = "1.1.0"
+  s.name = "dm-types"
+  s.version = "1.2.0.rc1"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dan Kubb"]
-  s.date = %q{2011-03-16}
-  s.description = %q{DataMapper plugin providing extra data types}
-  s.email = %q{dan.kubb [a] gmail [d] com}
+  s.date = "2011-09-09"
+  s.description = "DataMapper plugin providing extra data types"
+  s.email = "dan.kubb [a] gmail [d] com"
   s.extra_rdoc_files = [
     "LICENSE",
     "README.rdoc"
@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
     "VERSION",
     "dm-types.gemspec",
     "lib/dm-types.rb",
+    "lib/dm-types/api_key.rb",
     "lib/dm-types/bcrypt_hash.rb",
     "lib/dm-types/comma_separated_list.rb",
     "lib/dm-types/csv.rb",
@@ -38,10 +39,12 @@ Gem::Specification.new do |s|
     "lib/dm-types/paranoid_datetime.rb",
     "lib/dm-types/regexp.rb",
     "lib/dm-types/slug.rb",
+    "lib/dm-types/support/dirty_minder.rb",
     "lib/dm-types/support/flags.rb",
     "lib/dm-types/uri.rb",
     "lib/dm-types/uuid.rb",
     "lib/dm-types/yaml.rb",
+    "spec/fixtures/api_user.rb",
     "spec/fixtures/article.rb",
     "spec/fixtures/bookmark.rb",
     "spec/fixtures/invention.rb",
@@ -50,9 +53,12 @@ Gem::Specification.new do |s|
     "spec/fixtures/software_package.rb",
     "spec/fixtures/ticket.rb",
     "spec/fixtures/tshirt.rb",
+    "spec/integration/api_key_spec.rb",
     "spec/integration/bcrypt_hash_spec.rb",
     "spec/integration/comma_separated_list_spec.rb",
+    "spec/integration/dirty_minder_spec.rb",
     "spec/integration/enum_spec.rb",
+    "spec/integration/epoch_time_spec.rb",
     "spec/integration/file_path_spec.rb",
     "spec/integration/flag_spec.rb",
     "spec/integration/ip_address_spec.rb",
@@ -84,87 +90,52 @@ Gem::Specification.new do |s|
     "tasks/yard.rake",
     "tasks/yardstick.rake"
   ]
-  s.homepage = %q{http://github.com/datamapper/dm-types}
+  s.homepage = "http://github.com/datamapper/dm-types"
   s.require_paths = ["lib"]
-  s.rubyforge_project = %q{datamapper}
-  s.rubygems_version = %q{1.6.2}
-  s.summary = %q{DataMapper plugin providing extra data types}
-  s.test_files = [
-    "spec/fixtures/article.rb",
-    "spec/fixtures/bookmark.rb",
-    "spec/fixtures/invention.rb",
-    "spec/fixtures/network_node.rb",
-    "spec/fixtures/person.rb",
-    "spec/fixtures/software_package.rb",
-    "spec/fixtures/ticket.rb",
-    "spec/fixtures/tshirt.rb",
-    "spec/integration/bcrypt_hash_spec.rb",
-    "spec/integration/comma_separated_list_spec.rb",
-    "spec/integration/enum_spec.rb",
-    "spec/integration/file_path_spec.rb",
-    "spec/integration/flag_spec.rb",
-    "spec/integration/ip_address_spec.rb",
-    "spec/integration/json_spec.rb",
-    "spec/integration/slug_spec.rb",
-    "spec/integration/uri_spec.rb",
-    "spec/integration/uuid_spec.rb",
-    "spec/integration/yaml_spec.rb",
-    "spec/shared/flags_shared_spec.rb",
-    "spec/shared/identity_function_group.rb",
-    "spec/spec_helper.rb",
-    "spec/unit/bcrypt_hash_spec.rb",
-    "spec/unit/csv_spec.rb",
-    "spec/unit/enum_spec.rb",
-    "spec/unit/epoch_time_spec.rb",
-    "spec/unit/file_path_spec.rb",
-    "spec/unit/flag_spec.rb",
-    "spec/unit/ip_address_spec.rb",
-    "spec/unit/json_spec.rb",
-    "spec/unit/paranoid_boolean_spec.rb",
-    "spec/unit/paranoid_datetime_spec.rb",
-    "spec/unit/regexp_spec.rb",
-    "spec/unit/uri_spec.rb",
-    "spec/unit/uuid_spec.rb",
-    "spec/unit/yaml_spec.rb"
-  ]
+  s.rubyforge_project = "datamapper"
+  s.rubygems_version = "1.8.10"
+  s.summary = "DataMapper plugin providing extra data types"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<bcrypt-ruby>, ["~> 2.1.4"])
-      s.add_runtime_dependency(%q<dm-core>, ["~> 1.1.0"])
+      s.add_runtime_dependency(%q<bcrypt-ruby>, ["~> 3.0.0"])
+      s.add_runtime_dependency(%q<dm-core>, ["~> 1.2.0.rc1"])
       s.add_runtime_dependency(%q<fastercsv>, ["~> 1.5.4"])
-      s.add_runtime_dependency(%q<json>, ["~> 1.4.6"])
-      s.add_runtime_dependency(%q<stringex>, ["~> 1.2.0"])
+      s.add_runtime_dependency(%q<multi_json>, ["~> 1.0.3"])
+      s.add_runtime_dependency(%q<json>, ["~> 1.5.4"])
+      s.add_runtime_dependency(%q<stringex>, ["~> 1.3.0"])
       s.add_runtime_dependency(%q<uuidtools>, ["~> 2.1.2"])
-      s.add_development_dependency(%q<dm-validations>, ["~> 1.1.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_development_dependency(%q<rake>, ["~> 0.8.7"])
-      s.add_development_dependency(%q<rspec>, ["~> 1.3.1"])
+      s.add_development_dependency(%q<dm-validations>, ["~> 1.2.0.rc1"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rake>, ["~> 0.9.2"])
+      s.add_development_dependency(%q<rspec>, ["~> 1.3.2"])
     else
-      s.add_dependency(%q<bcrypt-ruby>, ["~> 2.1.4"])
-      s.add_dependency(%q<dm-core>, ["~> 1.1.0"])
+      s.add_dependency(%q<bcrypt-ruby>, ["~> 3.0.0"])
+      s.add_dependency(%q<dm-core>, ["~> 1.2.0.rc1"])
       s.add_dependency(%q<fastercsv>, ["~> 1.5.4"])
-      s.add_dependency(%q<json>, ["~> 1.4.6"])
-      s.add_dependency(%q<stringex>, ["~> 1.2.0"])
+      s.add_dependency(%q<multi_json>, ["~> 1.0.3"])
+      s.add_dependency(%q<json>, ["~> 1.5.4"])
+      s.add_dependency(%q<stringex>, ["~> 1.3.0"])
       s.add_dependency(%q<uuidtools>, ["~> 2.1.2"])
-      s.add_dependency(%q<dm-validations>, ["~> 1.1.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_dependency(%q<rake>, ["~> 0.8.7"])
-      s.add_dependency(%q<rspec>, ["~> 1.3.1"])
+      s.add_dependency(%q<dm-validations>, ["~> 1.2.0.rc1"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rake>, ["~> 0.9.2"])
+      s.add_dependency(%q<rspec>, ["~> 1.3.2"])
     end
   else
-    s.add_dependency(%q<bcrypt-ruby>, ["~> 2.1.4"])
-    s.add_dependency(%q<dm-core>, ["~> 1.1.0"])
+    s.add_dependency(%q<bcrypt-ruby>, ["~> 3.0.0"])
+    s.add_dependency(%q<dm-core>, ["~> 1.2.0.rc1"])
     s.add_dependency(%q<fastercsv>, ["~> 1.5.4"])
-    s.add_dependency(%q<json>, ["~> 1.4.6"])
-    s.add_dependency(%q<stringex>, ["~> 1.2.0"])
+    s.add_dependency(%q<multi_json>, ["~> 1.0.3"])
+    s.add_dependency(%q<json>, ["~> 1.5.4"])
+    s.add_dependency(%q<stringex>, ["~> 1.3.0"])
     s.add_dependency(%q<uuidtools>, ["~> 2.1.2"])
-    s.add_dependency(%q<dm-validations>, ["~> 1.1.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-    s.add_dependency(%q<rake>, ["~> 0.8.7"])
-    s.add_dependency(%q<rspec>, ["~> 1.3.1"])
+    s.add_dependency(%q<dm-validations>, ["~> 1.2.0.rc1"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rake>, ["~> 0.9.2"])
+    s.add_dependency(%q<rspec>, ["~> 1.3.2"])
   end
 end
 

data/lib/dm-types.rb

@@ -18,5 +18,6 @@ module DataMapper
     autoload :UUID,               'dm-types/uuid'
     autoload :URI,                'dm-types/uri'
     autoload :Yaml,               'dm-types/yaml'
+    autoload :APIKey,             'dm-types/api_key'
   end
 end

data/lib/dm-types/api_key.rb

@@ -0,0 +1,30 @@
+require 'dm-core'
+
+require 'digest/sha1'
+
+module DataMapper
+  class Property
+    class APIKey < String
+
+      # The amount of random seed data to use to generate tha API Key
+      PADDING = 256
+
+      length 40
+      unique true
+      default proc { APIKey.generate }
+
+      #
+      # Generates a new API Key.
+      #
+      # @return [String]
+      #   The new API Key.
+      #
+      def self.generate
+        sha1 = Digest::SHA1.new
+
+        PADDING.times { sha1 << rand(256).chr }
+        return sha1.hexdigest
+      end
+    end
+  end
+end

data/lib/dm-types/csv.rb

@@ -1,4 +1,5 @@
 require 'dm-core'
+require 'dm-types/support/dirty_minder'
 
 if RUBY_VERSION >= '1.9.0'
   require 'csv'
@@ -30,6 +31,8 @@ module DataMapper
         end
       end
 
+      include ::DataMapper::Property::DirtyMinder
+
     end # class Csv
   end # class Property
 end # module DataMapper

data/lib/dm-types/enum.rb

@@ -8,8 +8,6 @@ module DataMapper
       include Flags
 
       def initialize(model, name, options = {})
-        super
-
         @flag_map = {}
 
         flags = options.fetch(:flags, self.class.flags)
@@ -17,14 +15,11 @@ module DataMapper
           @flag_map[i + 1] = flag
         end
 
-        if defined?(::DataMapper::Validations)
-          unless model.skip_auto_validation_for?(self)
-            if self.class.ancestors.include?(Property::Enum)
-              allowed = flag_map.values_at(*flag_map.keys.sort)
-              model.validates_within name, model.options_with_message({ :set => allowed }, self, :within)
-            end
-          end
+        if self.class.accepted_options.include?(:set) && !options.include?(:set)
+          options[:set] = @flag_map.values_at(*@flag_map.keys.sort)
         end
+
+        super
       end
 
       def load(value)

data/lib/dm-types/epoch_time.rb

@@ -13,9 +13,19 @@ module DataMapper
       end
 
       def dump(value)
+        value.to_i if value
+      end
+
+      def custom?
+        true
+      end
+
+      def typecast(value)
         case value
-          when ::Numeric, ::Time then value.to_i
-          when ::DateTime        then datetime_to_time(value).to_i
+          when ::Time               then value
+          when ::Numeric, /\A\d+\z/ then ::Time.at(value.to_i)
+          when ::DateTime           then datetime_to_time(value)
+          when ::String             then ::Time.parse(value)
         end
       end
 

data/lib/dm-types/json.rb

@@ -1,5 +1,6 @@
 require 'dm-core'
-require 'json' unless defined? JSON
+require 'dm-types/support/dirty_minder'
+require 'multi_json'
 
 module DataMapper
   class Property
@@ -21,7 +22,7 @@ module DataMapper
         if value.nil?
           nil
         elsif value.is_a?(::String)
-          ::JSON.load(value)
+          typecast_to_primitive(value)
         else
           raise ArgumentError.new("+value+ of a property of JSON type must be nil or a String")
         end
@@ -31,14 +32,16 @@ module DataMapper
         if value.nil? || value.is_a?(::String)
           value
         else
-          ::JSON.dump(value)
+          MultiJson.encode(value)
         end
       end
 
       def typecast_to_primitive(value)
-        ::JSON.load(value.to_s)
+        MultiJson.decode(value.to_s)
       end
 
+      include ::DataMapper::Property::DirtyMinder
+
     end # class Json
 
     JSON = Json

data/lib/dm-types/paranoid/base.rb

@@ -2,30 +2,21 @@ module DataMapper
   module Types
     module Paranoid
       module Base
-        extend Chainable
-
         def self.included(model)
           model.extend ClassMethods
           model.instance_variable_set(:@paranoid_properties, {})
         end
 
-        chainable do
-          def inherited(model)
-            model.instance_variable_set(:@paranoid_properties, @paranoid_properties.dup)
-            super
-          end
-        end
-
         def paranoid_destroy
           model.paranoid_properties.each do |name, block|
             attribute_set(name, block.call(self))
           end
           save_self
-          self.persisted_state = Resource::State::Immutable.new(self)
+          self.persistence_state = Resource::PersistenceState::Immutable.new(self)
           true
         end
 
-        private
+      private
 
         # @api private
         def _destroy(execute_hooks = true)
@@ -39,6 +30,12 @@ module DataMapper
       end # module Base
 
       module ClassMethods
+        def inherited(model)
+          model.instance_variable_set(:@paranoid_properties, @paranoid_properties.dup)
+          super
+        end
+
+        # @api public
         def with_deleted
           with_exclusive_scope({}) { block_given? ? yield : all }
         end

data/lib/dm-types/support/dirty_minder.rb

@@ -0,0 +1,166 @@
+# Approach
+#
+# We need to detect whether or not the underlying Hash or Array changed and
+# update the dirty-ness of the encapsulating Resource accordingly (so that it
+# will actually save).
+#
+# DM's state-tracking code only triggers dirty-ness by comparing the new value
+# against the instance's Property's current value.  WRT mutation, we have to
+# choose one of the following approaches:
+#
+#   (1) mutate a copy ("after"), then invoke the Resource assignment and State
+#       tracking
+#
+#   (2) create a copy ("before"), mutate self ("after"), then invoke the
+#       Resource assignment and State tracking
+#
+# (1) seemed simpler at first, but it required additional steps to alias the
+# original (pre-hooked) methods before overriding them (so they could be invoked
+# externally, ala self.clone.send("orig_...")), and more importantly it resulted
+# in any external references keeping their old value (instead of getting the
+# new), like so:
+#
+#   copy = instance.json
+#   copy[:some] = :value
+#   instance.json[:some] == :value
+#    => true
+#   copy[:some] == :value
+#    => false  # fk!
+#
+# In order to do (2) and still have State tracking trigger normally, we need to
+# ensure the Property has a different value other than self when the State
+# tracking does the comparison.  This equates to setting the Property directly
+# to the "before" value (a clone and thus a different object/value) before
+# invoking the Resource Property/attribute assignment.
+#
+# The cloning of any value might sound expensive, but it's identical in cost to
+# what you already had to do: assign a cloned copy in order to trigger
+# dirty-ness (e.g. ::DataMapper::Property::Json):
+#
+#     model.json = model.json.merge({:some=>:value})
+#
+# Hooking Core Classes
+#
+# We want to hook certain methods on Hash and Array to trigger dirty-ness in the
+# resource.  However, because these are core classes, they are individually
+# mapped to C primitives and thus cannot be hooked through #send/#__send__.  We
+# have to override each method, but we don't want to write a lot of code.
+#
+# Minimally Invasive
+#
+# We also want to extend behaviour of existing class instances instead of
+# impersonating/delegating from a proxy class of our own, or overriding a global
+# class behaviour.  This is the most flexible approach and least prone to error,
+# since it leaves open the option for consumers to proxy or override global
+# classes, and is less likely to interfere with method_missing/etc shenanigans.
+#
+# Nested Object Mutations
+#
+# Since we use {Array,Hash}#hash to compare before & after, and #hash accounts
+# for/traverses nested structures, no "deep" inspection logic is technically
+# necessary.  However, Resource#dirty? only queries a cache of dirtied
+# attributes, whose own population strategy is to hook assignment (instead of
+# interrogating properties on demand).  So the approach is still limited to
+# top-level mutators.
+#
+# Maybe consider optional "advisory" Property#dirty? method for Resource#dirty?
+# that custom properties could use for this purpose.
+#
+# TODO: add support for detecting mutations in nested objects, but we can't
+#       catch the assignment from here (yet?).
+# TODO: ensure we covered all indirectly-mutable classes that DM uses underneath
+#       a property type
+# TODO: figure out how to hook core class methods on RBX (which do use #send)
+
+module DataMapper
+  class Property
+    module DirtyMinder
+
+      module Hooker
+        MUTATION_METHODS = {
+          ::Array => %w{
+            []= push << shift pop insert unshift delete
+            delete_at replace fill clear
+            slice! reverse! rotate! compact! flatten! uniq!
+            collect! map! sort! sort_by! reject! delete_if!
+            select! shuffle!
+          }.select { |meth| ::Array.instance_methods.any? { |m| m.to_s == meth } },
+
+          ::Hash => %w{
+            []= store delete delete_if replace update
+            delete rehash shift clear
+            merge! reject! select!
+          }.select { |meth| ::Hash.instance_methods.any? { |m| m.to_s == meth } },
+        }
+
+        def self.extended(instance)
+          # FIXME: DirtyMinder is currently unsupported on RBX, because unlike
+          # the other supported Rubies, RBX core class (e.g. Array, Hash)
+          # methods use #send().  In other words, the other Rubies don't use
+          # #send() (they map directly to their C functions).
+          #
+          # The current methodology takes advantage of this by using #send() to
+          # forward method invocations we've hooked.  Supporting RBX will
+          # require finding another way, possibly for all Rubies.  In the
+          # meantime, something is better than nothing.
+          return if defined?(RUBY_ENGINE) and RUBY_ENGINE == 'rbx'
+
+          return unless type = MUTATION_METHODS.keys.find { |k| instance.kind_of?(k) }
+          instance.extend const_get("#{type}Hooks")
+        end
+
+        MUTATION_METHODS.each do |klass, methods|
+          methods.each do |meth|
+            class_eval <<-RUBY, __FILE__, __LINE__ + 1
+              module #{klass}Hooks
+                def #{meth}(*)
+                  before = self.clone
+                  ret    = super
+                  after  = self
+
+                  # If the hashes aren't equivalent then we know the Resource
+                  # should be dirty.  However because we mutated self, normal
+                  # State tracking will never trigger, because it will compare the
+                  # new value - self - to the Resource's existing property value -
+                  # which is also self.
+                  #
+                  # The solution is to drop 1 level beneath Resource State
+                  # tracking and set the value of the property directly to the
+                  # previous value (a different object now, because it's a clone).
+                  # Then trigger the State tracking like normal.
+                  if before.hash != after.hash
+                    @property.set(@resource, before)
+                    @resource.attribute_set(@property.name, after)
+                  end
+
+                  ret
+                end
+              end
+            RUBY
+          end
+        end
+
+        def track(resource, property)
+          @resource, @property = resource, property
+        end
+
+      end # Hooker
+
+      # Catch any direct assignment (#set), and any Resource#reload (set!).
+      def set!(resource, value)
+        hook_value(resource, value) unless value.kind_of? Hooker
+        super
+      end
+
+      private
+
+      def hook_value(resource, value)
+        return if value.kind_of? Hooker
+
+        value.extend Hooker
+        value.track(resource, self)
+      end
+
+    end # DirtyMinder
+  end # Property
+end # DataMapper