has_metadata 1.0.0 → 1.1.0

data/Gemfile

@@ -1,14 +1,11 @@
 source :rubygems
 
-# DEPENDENCIES
 gem 'rails', '>= 3.0'
 
-# DEVELOPMENT
-gem 'jeweler'
-gem 'yard'
-gem 'RedCloth', require: 'redcloth'
-gem 'sqlite3'
-
-# TEST
-gem 'rspec'
-
+group :development do
+  gem 'jeweler'
+  gem 'yard'
+  gem 'RedCloth', require: 'redcloth'
+  gem 'sqlite3'
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -3,49 +3,46 @@ GEM
   specs:
     RedCloth (4.2.3)
     abstract (1.0.0)
-    actionmailer (3.0.1)
-      actionpack (= 3.0.1)
-      mail (~> 2.2.5)
-    actionpack (3.0.1)
-      activemodel (= 3.0.1)
-      activesupport (= 3.0.1)
+    actionmailer (3.0.3)
+      actionpack (= 3.0.3)
+      mail (~> 2.2.9)
+    actionpack (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
       builder (~> 2.1.2)
       erubis (~> 2.6.6)
-      i18n (~> 0.4.1)
+      i18n (~> 0.4)
       rack (~> 1.2.1)
-      rack-mount (~> 0.6.12)
-      rack-test (~> 0.5.4)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
       tzinfo (~> 0.3.23)
-    activemodel (3.0.1)
-      activesupport (= 3.0.1)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
       builder (~> 2.1.2)
-      i18n (~> 0.4.1)
-    activerecord (3.0.1)
-      activemodel (= 3.0.1)
-      activesupport (= 3.0.1)
-      arel (~> 1.0.0)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
       tzinfo (~> 0.3.23)
-    activeresource (3.0.1)
-      activemodel (= 3.0.1)
-      activesupport (= 3.0.1)
-    activesupport (3.0.1)
-    arel (1.0.1)
-      activesupport (~> 3.0.0)
+    activeresource (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+    activesupport (3.0.3)
+    arel (2.0.3)
     builder (2.1.2)
     diff-lcs (1.1.2)
     erubis (2.6.6)
       abstract (>= 1.0.0)
     ffi (0.6.3)
       rake (>= 0.8.7)
-    gemcutter (0.6.1)
     git (1.2.5)
     i18n (0.4.2)
-    jeweler (1.4.0)
-      gemcutter (>= 0.1.0)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
       git (>= 1.2.5)
-      rubyforge (>= 2.0.0)
-    json_pure (1.4.6)
-    mail (2.2.9)
+      rake
+    mail (2.2.10)
       activesupport (>= 2.3.6)
       i18n (~> 0.4.1)
       mime-types (~> 1.16)
@@ -57,39 +54,35 @@ GEM
       rack (>= 1.0.0)
     rack-test (0.5.6)
       rack (>= 1.0)
-    rails (3.0.1)
-      actionmailer (= 3.0.1)
-      actionpack (= 3.0.1)
-      activerecord (= 3.0.1)
-      activeresource (= 3.0.1)
-      activesupport (= 3.0.1)
-      bundler (~> 1.0.0)
-      railties (= 3.0.1)
-    railties (3.0.1)
-      actionpack (= 3.0.1)
-      activesupport (= 3.0.1)
-      rake (>= 0.8.4)
-      thor (~> 0.14.0)
+    rails (3.0.3)
+      actionmailer (= 3.0.3)
+      actionpack (= 3.0.3)
+      activerecord (= 3.0.3)
+      activeresource (= 3.0.3)
+      activesupport (= 3.0.3)
+      bundler (~> 1.0)
+      railties (= 3.0.3)
+    railties (3.0.3)
+      actionpack (= 3.0.3)
+      activesupport (= 3.0.3)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
     rake (0.8.7)
-    rspec (2.0.1)
-      rspec-core (~> 2.0.1)
-      rspec-expectations (~> 2.0.1)
-      rspec-mocks (~> 2.0.1)
-    rspec-core (2.0.1)
-    rspec-expectations (2.0.1)
-      diff-lcs (>= 1.1.2)
-    rspec-mocks (2.0.1)
-      rspec-core (~> 2.0.1)
-      rspec-expectations (~> 2.0.1)
-    rubyforge (2.0.4)
-      json_pure (>= 1.1.7)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
     sqlite3 (0.1.1)
       ffi (>= 0.6.3)
-    thor (0.14.3)
-    treetop (1.4.8)
+    thor (0.14.4)
+    treetop (1.4.9)
       polyglot (>= 0.3.1)
     tzinfo (0.3.23)
-    yard (0.6.1)
+    yard (0.6.2)
 
 PLATFORMS
   ruby
@@ -101,3 +94,6 @@ DEPENDENCIES
   rspec
   sqlite3
   yard
+
+METADATA
+  version: 1.0.6

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Tim Morgan
+Copyright (c) 2010 Tim Morgan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.textile

@@ -1,9 +1,30 @@
 h1. has_metadata -- Keep your tables narrow
 
 | *Author* | Tim Morgan |
-| *Version* | 1.0 (Oct 29, 2010) |
+| *Version* | 1.1 (Nov 16, 2010) |
 | *License* | Released under the MIT License. |
 
+h2. Important note for those upgrading from 1.0 to 1.1
+
+You must re-run the @rails generate metadata@ task to update your @Metadata@
+model. When finished, your @app/models/metadata.rb@ file should look like:
+
+<pre><code>
+# Stores information about a model that doesn't need to be in that model's
+# table. Each row in the @metadata@ table stores a schemaless, serialized hash
+# of data associated with a model instance. Any model can have an associated row
+# in the @metadata@ table by using the {HasMetadata} module.
+#
+# h2. Properties
+#
+# | @data@ | A hash of this metadata's contents (YAML serialized in the database). |
+
+class Metadata &lt; HasMetadata::Model
+end
+</code></pre>
+
+Note that this is significantly emptier than the previous model.
+
 h2. About
 
 Wide tables are a problem for big databases. If your @ActiveRecord@ models have
@@ -66,7 +87,7 @@ t.belongs_to :metadata
 
 Next, include the @HasMetadata@ module in your model, and call the
 @has_metadata@ method to define the schema of your metadata. You can get more
-information in the @has_metadata@ documentation, but for starters, here's a
+information in the {HasMetadata::ClassMethods#has_metadata} documentation, but for starters, here's a
 basic example:
 
 <pre><code>

data/Rakefile

@@ -1,13 +1,15 @@
-require 'rake'
+require 'rubygems'
+require 'bundler'
 begin
-  require 'bundler'
-rescue LoadError
-  puts "Bundler is not installed; install with `gem install bundler`."
-  exit 1
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
 end
+require 'rake'
 
-Bundler.require :default
-
+require 'jeweler'
 Jeweler::Tasks.new do |gem|
   gem.name = "has_metadata"
   gem.summary = %Q{Reduce your table width by moving non-indexed columns to a separate metadata table}
@@ -16,13 +18,13 @@ Jeweler::Tasks.new do |gem|
   gem.homepage = "http://github.com/riscfuture/has_metadata"
   gem.authors = [ "Tim Morgan" ]
   gem.required_ruby_version = '>= 1.9'
-  gem.add_dependency "rails", ">= 3.0"
 end
-Jeweler::GemcutterTasks.new
+Jeweler::RubygemsDotOrgTasks.new
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new
 
+require 'yard'
 YARD::Rake::YardocTask.new('doc') do |doc|
   doc.options << "-m" << "textile"
   doc.options << "--protected"

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/has_metadata.gemspec

@@ -1,50 +1,49 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{has_metadata}
-  s.version = "1.0.0"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tim Morgan"]
-  s.date = %q{2010-10-30}
+  s.date = %q{2010-11-17}
   s.description = %q{has_metadata lets you move non-indexed and weighty columns off of your big tables by creating a separate metadata table to store all this extra information. Works with Ruby 1.9. and Rails 3.0.}
   s.email = %q{git@timothymorgan.info}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.textile"
+    "README.textile"
   ]
   s.files = [
     ".document",
-     ".gitignore",
-     ".rspec",
-     "Gemfile",
-     "Gemfile.lock",
-     "LICENSE",
-     "README.textile",
-     "Rakefile",
-     "VERSION",
-     "has_metadata.gemspec",
-     "lib/has_metadata.rb",
-     "lib/metadata_generator.rb",
-     "spec/has_metadata_spec.rb",
-     "spec/metadata_spec.rb",
-     "spec/spec_helper.rb",
-     "templates/create_metadata.rb",
-     "templates/metadata.rb"
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.textile",
+    "Rakefile",
+    "VERSION",
+    "has_metadata.gemspec",
+    "lib/has_metadata.rb",
+    "lib/has_metadata/metadata_generator.rb",
+    "lib/has_metadata/model.rb",
+    "spec/has_metadata_spec.rb",
+    "spec/metadata_spec.rb",
+    "spec/spec_helper.rb",
+    "templates/create_metadata.rb",
+    "templates/metadata.rb"
   ]
   s.homepage = %q{http://github.com/riscfuture/has_metadata}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.required_ruby_version = Gem::Requirement.new(">= 1.9")
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Reduce your table width by moving non-indexed columns to a separate metadata table}
   s.test_files = [
     "spec/has_metadata_spec.rb",
-     "spec/metadata_spec.rb",
-     "spec/spec_helper.rb"
+    "spec/metadata_spec.rb",
+    "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -53,11 +52,26 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rails>, [">= 3.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<RedCloth>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
     else
       s.add_dependency(%q<rails>, [">= 3.0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<RedCloth>, [">= 0"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
     end
   else
     s.add_dependency(%q<rails>, [">= 3.0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<RedCloth>, [">= 0"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
   end
 end
 

data/lib/{metadata_generator.rb → has_metadata/metadata_generator.rb}

@@ -6,7 +6,7 @@ require 'rails/generators/migration'
 class MetadataGenerator < Rails::Generators::Base
   include Rails::Generators::Migration
   
-  source_root "#{File.dirname __FILE__}/../templates"
+  source_root "#{File.dirname __FILE__}/../../templates"
   
   def self.next_migration_number(dirname)
     if ActiveRecord::Base.timestamped_migrations then

data/lib/has_metadata/model.rb

@@ -0,0 +1,40 @@
+module HasMetadata
+  
+  # Base class of the {Metadata} model. Functionality is moved to this class to
+  # make changes to the model easier. See the @Metadata@ method for more
+  # information.
+  
+  class Model < ActiveRecord::Base
+    set_table_name 'metadata'
+    serialize :data, Hash
+
+    after_initialize :initialize_data
+    before_save :nullify_empty_fields
+
+    validates :data,
+              presence: true
+
+    # @private
+    def set_fields(fields)
+      return self if @fields_set
+      @fields_set = true
+
+      fields.each do |name, _|
+        singleton_class.send(:define_method, name) { |default=nil| data.include?(name) ? data[name] : default }
+        singleton_class.send(:define_method, :"#{name}=") { |value| data[name] = value }
+      end
+
+      self
+    end
+
+    private
+
+    def initialize_data
+      self.data ||= Hash.new
+    end
+
+    def nullify_empty_fields
+      data.each { |key, value| data[key] = nil if data[key].blank? }
+    end
+  end
+end

data/lib/has_metadata.rb

@@ -1,4 +1,5 @@
-require 'metadata_generator'
+require 'has_metadata/metadata_generator'
+require 'has_metadata/model'
 
 # @private
 class Object
@@ -6,7 +7,7 @@ class Object
   # Creates a deep copy of this object.
   #
   # @raise [TypeError] If the object cannot be deep-copied. All objects that can
-  # be marshalled can be deep-copied.
+  #   be marshalled can be deep-copied.
 
   def deep_clone
     Marshal.load Marshal.dump(self)
@@ -30,9 +31,12 @@ module HasMetadata
     # key value.
     #
     # In addition to the normal @validates@ keys, you can also include a @:type@
-    # key to restrict values to certain classes.
+    # key to restrict values to certain classes, or a @:default@ key to specify
+    # a value to return for the getter should none be set (normal default is
+    # @nil@).
     #
-    # @param [Hash<Symbol, Hash>] fields A mapping of field names to their validation options (and/or the @:type@ key).
+    # @param [Hash<Symbol, Hash>] fields A mapping of field names to their
+    #   validation options (and/or the @:type@ key).
     #
     # @example Three metadata fields, one basic, one validated, and one type-checked.
     #   has_metadata(optional: true, required: { presence: true }, number: { type: Fixnum })
@@ -48,17 +52,23 @@ module HasMetadata
       #define_method(:metadata_changed?) { metadata and metadata.changed? }
 
       fields.each do |name, options|
-        delegate name, to: :metadata!
         delegate :"#{name}=", to: :metadata!
-
+        
         if options.kind_of?(Hash) then
-          type = options.delete(:type)
-          validate do |obj|
-            errors.add(name, :incorrect_type) unless
-              metadata_typecast(obj.send(name), type).kind_of?(type) or
-                ((options[:allow_nil] and obj.send(name).nil?) or (options[:allow_blank] and obj.send(name).blank?))
-          end if type
-          validates(name, options) unless options.empty? or (options.keys - [ :allow_nil, :allow_blank ]).empty?
+          default = options.delete(:default)
+          define_method(name) { metadata!.send(name, default) }
+          
+          unless options.empty?
+            type = options.delete(:type)
+            validate do |obj|
+              errors.add(name, :incorrect_type) unless
+                metadata_typecast(obj.send(name), type).kind_of?(type) or
+                  ((options[:allow_nil] and obj.send(name).nil?) or (options[:allow_blank] and obj.send(name).blank?))
+            end if type
+            validates(name, options) unless options.empty? or (options.keys - [ :allow_nil, :allow_blank ]).empty?
+          end
+        else
+          delegate name, to: :metadata!
         end
       end
     end
@@ -103,7 +113,8 @@ module HasMetadata
       super(pairs - fake_attributes)
     end
 
-    # @return [Metadata] An existing associated {Metadata} instance, or new, saved one if none was found.
+    # @return [Metadata] An existing associated {Metadata} instance, or new,
+    #   saved one if none was found.
 
     def metadata!
       if instance_variables.include?(:@metadata) then

data/spec/has_metadata_spec.rb

@@ -14,7 +14,8 @@ module SpecSupport
       can_be_nil: { type: Date, allow_nil: true },
       can_be_blank: { type: Date, allow_blank: true },
       number: { numericality: true },
-      multiparam: { type: SpecSupport::ConstructorTester }
+      multiparam: { type: SpecSupport::ConstructorTester },
+      has_default: { default: 'default' }
     })
   end
 end
@@ -53,6 +54,15 @@ describe HasMetadata do
 
         @object.untyped.should be_nil
       end
+      
+      it "should return a default if one is specified" do
+        @object.has_default.should eql('default')
+      end
+      
+      it "should return nil if nil is stored and the default is not nil" do
+        @metadata.data[:has_default] = nil
+        @object.has_default.should eql(nil)
+      end
     end
     
     it "should make a setter for each field" do

data/spec/spec_helper.rb

@@ -1,4 +1,3 @@
-Bundler.require :default, :test
 require 'active_support'
 require 'active_record'
 

data/templates/create_metadata.rb

@@ -1,4 +1,4 @@
-class CreateMetadatas < ActiveRecord::Migration
+class CreateMetadata < ActiveRecord::Migration
   def self.up
     create_table :metadata do |t|
       t.text :data, null: false

data/templates/metadata.rb

@@ -7,36 +7,5 @@
 #
 # | @data@ | A hash of this metadata's contents (YAML serialized in the database). |
 
-class Metadata < ActiveRecord::Base
-  set_table_name 'metadata'
-  serialize :data, Hash
-
-  after_initialize :initialize_data
-  before_save :nullify_empty_fields
-
-  validates :data,
-            presence: true
-
-  # @private
-  def set_fields(fields)
-    return self if @fields_set
-    @fields_set = true
-    
-    fields.each do |name, _|
-      singleton_class.send(:define_method, name) { data[name] }
-      singleton_class.send(:define_method, :"#{name}=") { |value| data[name] = value }
-    end
-    
-    self
-  end
-
-  private
-
-  def initialize_data
-    self.data ||= Hash.new
-  end
-
-  def nullify_empty_fields
-    data.each { |key, value| data[key] = nil if data[key].blank? }
-  end
+class Metadata < HasMetadata::Model
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Tim Morgan
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-30 00:00:00 -07:00
+date: 2010-11-17 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,6 +31,71 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: RedCloth
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id006
 description: has_metadata lets you move non-indexed and weighty columns off of your big tables by creating a separate metadata table to store all this extra information. Works with Ruby 1.9. and Rails 3.0.
 email: git@timothymorgan.info
 executables: []
@@ -42,7 +107,6 @@ extra_rdoc_files:
 - README.textile
 files: 
 - .document
-- .gitignore
 - .rspec
 - Gemfile
 - Gemfile.lock
@@ -52,7 +116,8 @@ files:
 - VERSION
 - has_metadata.gemspec
 - lib/has_metadata.rb
-- lib/metadata_generator.rb
+- lib/has_metadata/metadata_generator.rb
+- lib/has_metadata/model.rb
 - spec/has_metadata_spec.rb
 - spec/metadata_spec.rb
 - spec/spec_helper.rb
@@ -63,8 +128,8 @@ homepage: http://github.com/riscfuture/has_metadata
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/.gitignore

@@ -1,26 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-.bundle
-.rvmrc
-test.sqlite
-
-## PROJECT::DOCUMENTATION
-.yardoc
-doc