fixjour 0.0.1

data/lib/core_ext/hash.rb

@@ -0,0 +1,9 @@
+class Hash
+  # Makes a hash able to be accessed via symbol or string keys.
+  def make_indifferent!
+    keys_values = self.dup
+    indifferent = Hash.new { |h,k| h[k.to_s] if Symbol === k }
+    replace(indifferent)
+    merge!(keys_values)
+  end
+end

data/lib/fixjour/builders.rb

@@ -0,0 +1,68 @@
+module Fixjour
+  class << self
+    # The list of classes that have builders defined.
+    def builders
+      @builders ||= Set.new
+    end
+
+    # Registers a class' builder. This allows us to make sure
+    # redundant builders aren't defined, which can lead to confusion
+    # when trying to figure out where objects are being created.
+    def add_builder(klass)
+      unless builders.add?(klass)
+        raise RedundantBuilder.new("You already defined a builder for #{klass.inspect}")
+      end
+    end
+    
+    # This method should always return a valid instance of
+    # a model object.
+    def define_builder(klass, &block)
+      add_builder(klass)
+
+      name = name_for(klass)
+
+      define_new(name, block)
+      define_create(name)
+      define_valid_attributes(name)
+    end
+    
+    private
+    
+    def name_for(klass)
+      klass.model_name.singular
+    end
+    
+    # Defines the new_* method
+    def define_new(name, block)
+      define_method("new_#{name}") do |*args|
+        overrides = args.first || { }
+        block.bind(self).call(overrides)
+      end
+    end
+    
+    # Defines the create_* method
+    def define_create(name)
+      define_method("create_#{name}") do |*args|
+        model = send("new_#{name}", *args)
+        model.save!
+        model
+      end
+    end
+    
+    # Defines the valid_*_attributes method
+    def define_valid_attributes(name)
+      define_method("valid_#{name}_attributes") do |*args|
+        if instance_variable_get("@__valid_#{name}_attrs").nil?
+          valid_attributes = send("new_#{name}").attributes
+          valid_attributes.delete_if { |key, value| value.nil? }
+          instance_variable_set("@__valid_#{name}_attrs", valid_attributes)
+        end
+
+        overrides = args.extract_options!
+        attrs = instance_variable_get("@__valid_#{name}_attrs").merge(overrides)
+        attrs.make_indifferent!
+        attrs
+      end
+    end
+  end
+end

data/lib/fixjour/errors.rb

@@ -0,0 +1,14 @@
+module Fixjour
+  # Raised when a builder returns an invalid object
+  class InvalidBuilder < StandardError; end
+  
+  # Raised when a builder returns an object of the wrong type
+  class WrongBuilderType < StandardError; end
+  
+  # Raised when a builder is defined for a class that already
+  # has one.
+  class RedundantBuilder < StandardError; end
+  
+  # Raised when a builder block saves the object.
+  class BuilderSavedRecord < StandardError; end
+end

data/lib/fixjour/verify.rb

@@ -0,0 +1,36 @@
+module Fixjour
+  class << self
+    # Checks each builder to ensure that they:
+    #
+    # * Return valid objects
+    # * The new_* methods return new records
+    # * The creation methods return objects of the proper type
+    def verify!
+      builders.each do |klass|
+        result = validity_checker.send("new_#{name_for(klass)}")
+        
+        unless result.valid?
+          raise InvalidBuilder.new("The builder for #{klass} returns an invalid object")
+        end
+        
+        unless result.new_record?
+          raise BuilderSavedRecord.new("The builder for #{klass} must not save the object")
+        end
+        
+        unless result.is_a?(klass)
+          raise WrongBuilderType.new("The builder for #{klass} must return instance of #{klass}")
+        end
+      end
+    end
+
+    private
+
+    def validity_checker
+      @evaluator ||= begin
+        klass = Class.new
+        klass.send :include, self
+        klass.new
+      end
+    end
+  end
+end

data/lib/fixjour.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH << File.dirname(__FILE__)
+
+require 'rubygems'
+require 'activerecord'
+require 'core_ext/hash'
+require 'fixjour/verify'
+require 'fixjour/errors'
+require 'fixjour/builders'
+
+# This method is just for prettiness
+def Fixjour(&block)
+  return Fixjour unless block_given?
+  Fixjour.module_eval(&block)
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: fixjour
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Pat Nakajima
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-29 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: patnakajima@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/core_ext
+- lib/core_ext/hash.rb
+- lib/fixjour
+- lib/fixjour/builders.rb
+- lib/fixjour/errors.rb
+- lib/fixjour/verify.rb
+- lib/fixjour.rb
+has_rdoc: true
+homepage: http://github.com/nakajima/fixjour
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Object creation methods everyone already has
+test_files: []
+