MockActiveRecord 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2007 Lone Star Software Engineering Services, Inc.
+Written by Tony Payne
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,32 @@
+Provides facilities for creating mock ActiveRecord objects and their associations.
+ 
+Author:: Tony Payne <tony@lonestarsoftware.net>
+Copyright:: Lone Star Software Engineering Services, Inc., 2007
+Homepage:: http://lonestarsoftware.net
+Blog:: http://blog.lonestarsoftware.net
+License:: MIT
+Version:: 0.1
+Dependencies:: RubyGems, ActiveSupport (Inflector)
+
+Currently, there is not a whole lot of ActiveRecord functionality supported. I've only implemented 
+what I need for the active_resources plugin. Hopefully this will provide a good basis to build on
+for other needs, as well.
+
+As of 0.1, *the tests pass with 100% code coverage and pass heckling with no mutations remaining*
+
+Example:
+
+  include MockActiveRecord::Mixin
+  mock :Book do |book|
+    book.column :id, :integer
+    book.column :title, :string, :default => ''
+    book.column :publisher_id, :integer
+    book.column :foo, :string, :content => false
+    book.column :bar_id, :integer, :content => true
+ 
+    book.has_many :authorships
+    book.has_many :authors, :through => :authorships
+    book.belongs_to :publisher
+    book.has_one :fresnarus
+  end
+  

data/lib/mock_active_record.rb

@@ -0,0 +1,162 @@
+require 'rubygems'
+require 'active_support/inflector'
+
+# :include:README
+# :main:MockActiveRecord
+# :title:MockActiveRecord Documentation
+module MockActiveRecord
+  # Represents an association reflection as returned by MockActiveRecord::Base#reflect_on_all_associations
+  class Association
+    include Inflector
+    attr_reader :name, :macro, :primary_key_name, :active_record, :through_reflection, :class_name, :options
+    def initialize(name, macro, active_record, options = {})
+      pk = options.delete(:primary_key_name) || underscore(active_record.name.to_s) + "_id"
+      cn = options.delete(:class_name) || camelize(singularize(name.to_s))
+      @name = name
+      @macro = macro
+      @active_record = active_record
+      @primary_key_name = pk
+      @options = options
+      @class_name = cn
+      @through_reflection = true if options[:through]
+    end
+  end
+
+  # Represents an active record column as returned by MockActiveRecord::Base#columns
+  class Column
+    attr_reader :name, :type, :default
+    def initialize(name, type, default=nil)
+      @name = name
+      @type = type
+      @default = default
+    end
+  end
+
+  # Base class from which all mock model objects inherit
+  class Base
+    @@name = ''
+    @@columns = {}
+    @@content_columns = {}
+    @@associations = {}
+
+    # Returns the model name
+    def self.name
+      @@name
+    end
+    
+    # Returns a list of MockActiveRecord::Column objects in the model
+    def self.columns
+      @@columns.values
+    end
+    
+    # Returns a hash of MockActiveRecord::Column objects in the model with the name as the key value
+    def self.columns_hash()
+      return @@columns
+    end
+    
+    # Returns a list of MockActiveRecord::Column objects in the model which contain content
+    def self.content_columns
+      @@content_columns.keys
+    end
+    
+    # Returns a list of all MockActiveRecord::Association objects in the model
+    def self.reflect_on_all_associations
+      @@associations.values
+    end
+    
+    # Adds a :has_many association to the model class
+    # Example:
+    #   MockClass.has_many :fresnari, :through => :sharpoze
+    #
+    # Supported options are:
+    # [:through]    creates a has-many :through association
+    # [:class_name] sets the name of the associated class
+    def self.has_many(name, options = {})
+      @@associations[name] = MockActiveRecord::Association.new(name, :has_many, self, options)
+    end
+
+    # Adds a :has_one association to the model class
+    # Example:
+    #   MockClass.has_one :fresnarus, :class_name => Sharpoze
+    #
+    # Supported options are:
+    # [:class_name] sets the name of the associated class
+    def self.has_one(name, options = {})
+      @@associations[name] = MockActiveRecord::Association.new(name, :has_one, self, options)
+    end
+
+    # Adds a :belongs_to association to the model class
+    # Example:
+    #   MockClass.belongs_to :fresnarus
+    # 
+    # Supported options are:
+    # [:class_name] sets the name of the associated class
+    def self.belongs_to(name, options = {})
+      @@associations[name] = MockActiveRecord::Association.new(name, :belongs_to, self, options)
+    end
+    
+    # Adds a column to the model class
+    # Example:
+    #   MockClass.column :id, :integer
+    #   MockClass.column :kind, :string, :default => 'fresnarus'
+    #
+    # name:: name of column
+    # type:: type of column (:integer, :string, etc)
+    # options:: Supported values are:
+    # [:default] sets the default value for the column
+    # [:content] overrides the default behavior for determining if a column contains meaningful data.
+    #            By default, this is determined by the absence of "_id" at the end of the column name
+    #            except for the special columns (id, created|update|deleted_at|on, lock_version)  
+    def self.column(name, type, options = {})
+  	  mock_ar_column = MockActiveRecord::Column.new(name.to_s, type, options[:default])
+      @@columns[name.to_sym] = mock_ar_column
+      if options.has_key?(:content)
+        @@content_columns[name.to_sym] = true if options[:content]
+      else
+        @@content_columns[name.to_sym] = true if is_content_column?(name)
+      end
+    end
+
+    # Creates a new instance of the model object
+    # attrs:: Set the initial values for the object's columns
+    def initialize(attrs={})
+      @attrs = attrs.dup
+      self.class.columns.each do |column|
+        @attrs[column.name] = column.default
+      end
+    end
+    
+    # Returns the current attribute values for the model instance
+    def attributes
+      @attrs
+    end
+    
+    protected
+    # Returns true if the column name looks like it holds meaningful data
+    def self.is_content_column?(name)
+      return false if name.to_s == 'id'
+      return false if name.to_s =~ /_id$/
+      return false if %w(created_at created_on update_at updated_on deleted_at deleted_on lock_version).include?(name.to_s)
+      return true
+    end
+  end
+
+  module Mixin
+    # Create a new mock class with the given name. The class is yielded to the block so that you can call the setup methods:
+    #   mock :Book do |book|
+    #     book.column :id, :integer
+    #     book.column :title, :string
+    #     book.has_many :authorships
+    #     book.has_many :authors, :through => :authorships
+    #     etc...
+    #   end
+    def mock(name, &block) # :yields: Class
+      Kernel.module_eval <<-__END__
+        class #{name} < MockActiveRecord::Base
+          @@name = "#{name}"
+        end
+      __END__
+      yield Kernel.const_get(name)
+    end
+  end
+end

data/tests/mock_active_record_test.rb

@@ -0,0 +1,69 @@
+require 'test/unit'
+require File.expand_path(File.dirname(__FILE__) + "/../lib/mock_active_record")
+class ActiveResourcesTest < Test::Unit::TestCase
+  include MockActiveRecord::Mixin
+  public
+  def setup
+    mock :Book do |book|
+      book.column :id, :integer
+      book.column :title, :string, :default => ''
+      book.column :publisher_id, :integer
+      book.column :foo, :string, :content => false
+      book.column :bar_id, :integer, :content => true
+      
+      book.has_many :authorships
+      book.has_many :authors, :through => :authorships
+      book.belongs_to :publisher
+      book.has_one :fresnarus
+    end
+  end
+
+  def test_name
+    assert_equal 'Book', Book.name
+  end
+
+  def test_columns
+    assert_equal ['bar_id', 'foo', 'id', 'publisher_id', 'title'], Book.columns.collect{|c| c.name}.sort
+  end
+
+  def test_columns_hash
+    h = Book.columns_hash
+    
+    assert h.has_key?(:id)
+    assert_equal 'id', h[:id].name
+    assert_equal :integer, h[:id].type
+    
+    assert h.has_key?(:publisher_id)
+    assert_equal 'publisher_id', h[:publisher_id].name
+    assert_equal :integer, h[:publisher_id].type
+    
+    assert h.has_key?(:title)
+    assert_equal 'title', h[:title].name
+    assert_equal :string, h[:title].type
+    
+    assert h.has_key?(:foo)
+    assert_equal 'foo', h[:foo].name
+    assert_equal :string, h[:foo].type
+    
+    assert h.has_key?(:bar_id)
+    assert_equal 'bar_id', h[:bar_id].name
+    assert_equal :integer, h[:bar_id].type
+  end
+
+  def test_content_columns
+    assert_equal ['bar_id', 'title'], Book.content_columns.collect{|c| c.to_s}.sort
+  end
+
+  def test_reflect_on_all_associations
+    assert_equal ['authors', 'authorships', 'fresnarus', 'publisher'], Book.reflect_on_all_associations.collect{|a| a.name.to_s}.sort
+    assert_equal [:has_many, :has_many, :has_one, :belongs_to], Book.reflect_on_all_associations.sort_by{|a| a.name.to_s}.collect{|a| a.macro}
+  end
+  
+  def test_new
+    assert_equal 'Book', Book.new.class.name
+  end
+  
+  def test_attrs
+    assert_equal({'bar_id' => nil, 'foo' => nil, 'id' => nil, 'publisher_id' => nil, 'title' => ''}, Book.new.attributes)
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: MockActiveRecord
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2007-03-09 00:00:00 -08:00
+summary: Mock ActiveRecord Classes
+require_paths: 
+- lib
+email: tony@lonestarsoftware.net
+homepage: http://lonestarsoftware.net/
+rubyforge_project: 
+description: 
+autorequire: mock_active_record
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Tony Payne
+files: 
+- tests/mock_active_record_test.rb
+- lib/mock_active_record.rb
+- README
+- MIT-LICENSE
+test_files: 
+- tests/mock_active_record_test.rb
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: