active_mocker 1.5.2 → 1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f663b4c6a2cc7e33f7452262782b2c880108f11
-  data.tar.gz: 3c20207a292f97736ab241483da432d4da87510a
+  metadata.gz: 35f6abbcfa326377ac5fa015a3e1f9b434a9f936
+  data.tar.gz: 8aad0e3c8158712b9a09790d663854df1f5c96ec
 SHA512:
-  metadata.gz: fbb61f7da2ff8078c5a02dc1f865f85e54a24ea3693e8928cb4be590ee1947aefbf8f5693529a57129631b769d0e6d6a49d6a1546c0800fc197d6b6cc7902b72
-  data.tar.gz: afd4c94e4f99f62b8f380aa7196174fc9968e0fae7fd0f15ea1b80d3dbfd751fe1f65aa6aea48387dc1451a854db1f02edf262cf96e2a60815649d28932b7903
+  metadata.gz: 50d226edfaa35c359327b9ee3eb888bccd395fbe378d943302e368b04f7ed2885609fe6044ea4dffec02364af7fe46f11ced835d874c0acb8a957e61ee2e6ed7
+  data.tar.gz: ecc81c94d5186bf9a1e9b2e55556a2ec709ad97411df75b0a7806fc12d1491445eb44ba3d9971e7bcf0448837ac78b2ef9cb4d1e451a53cb2aa05850087d514c

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 All notable changes to this project will be documented in this file.
+## 1.6 - 2014-07-29
+
+### Enhancement
+- When calling limit and then delete_all will raises an ActiveMocker error:
+- When mass assignment an unknown attribute the error message will mirror ActiveRecord.
+- `where` can now accept a range instead of just an array as a value.
+- `update` can update multiple records.
+- `delete` can take an array or an integer
+- `find` will now raise RecordNotFound
+- `count` can now take an attribute name and will return the total count of records where the attribute is present.
+- `create` now supports creating multiple records at once.
+
+### Added
+- Added documentation for many methods.
+- find_or_create_by/find_or_initialize_by now accessible from any collection.
+- Instance methods attribute_names, attribute_present?, has_attribute?
+- Using `ActiveMocker::Mock.config.experimental = true`. This will turn on features that are not complete and may not work as expected, especially if you have complex relationships. This will activate the following features:
+    - When passing in collection all item in collection will set its foreign key to the parent.
+    - When setting association by object it will set the child association.
+
+### Fixed
+- `new_record?` would return the opposite of the truth.
+- Remove method `to_hash` because it is unsupported in ActiveRecord.
+- Requiring `active_mocker/rspec_helper` will now require loaded_mocks class. If no mocks were required the constant lookup would fails.
+- When a model is deleted the mock file will not linger and letting tests pass.
 
 ## 1.5.2 - 2014-07-14
 

data/README.md

@@ -5,19 +5,25 @@
 [![Dependency Status](https://gemnasium.com/zeisler/active_mocker.svg)](https://gemnasium.com/zeisler/active_mocker)
 [![Gitter chat](https://badges.gitter.im/zeisler/active_mocker.png)](https://gitter.im/zeisler/active_mocker)
 
-ActiveMocker creates mocks classes from ActiveRecord models. Allowing your test suite to run very fast by not loading Rails or hooking to a database. It parses the schema definition and the defined methods on a model then saves a ruby file that can be included within a test. Mocks are regenerated when the schema is modified so your mocks will not go stale. This prevents the case where your units tests pass but production code is failing.
+ActiveMocker creates mocks classes from ActiveRecord models. Allowing your test suite to run very fast by not loading Rails or hooking to a database. It parses the schema definition and the defined methods on a model then saves a ruby file that can be included within a test. The mock can be run by themselves and run with a partial implementation of ActiveRecord. Mocks are regenerated when the schema is modified so your mocks will not go stale. Preventing the case where your units tests pass but production code is failing.
 
-Example from a real app
+Examples from a real apps
 
 		Finished in 0.54599 seconds
 		190 examples, 0 failures
+		
+------
+		
+		Finished in 1 seconds
+		374 examples, 0 failures
 
 
 ------------------------------------------
+
+* [Documentation](#documentation)
 * [Contact](#contact)
 * [Installation](#installation)
 * [Setup](#setup)
-  * [Configuration](#overwrite_defaults_configuration)
   * [Generate](#generate_mocks)
 * [Dependencies](#dependencies)
 * [Usage](#usage)
@@ -29,6 +35,12 @@ Example from a real app
 * [Contributing](#contributing)
 
 
+---------------------------
+
+## Documentation
+
+[rdoc](http://rdoc.info/github/zeisler/active_mocker/master/ActiveMocker)
+
 ------------------------------------------
 
 ## Contact
@@ -59,15 +71,6 @@ Or install it yourself as:
 
 ## Setup
 
-### Overwrite defaults configuration
-
-    ActiveMocker::Generate.configure do |config|
-      config.schema_file = File.join(Rails.root, 'db/schema.rb')
-      config.model_dir   = File.join(Rails.root, 'app/models')
-      config.mock_dir    = File.join(Rails.root, 'spec/mocks')
-      config.logger      = Rails.logger
-    end
-
 ### Generate Mocks
 
 Running this rake task builds/rebuilds the mocks. It will be ran automatically after every schema modification. If the model changes this rake task needs to be called manually. You could add a file watcher for when your models change and have it run the rake task.
@@ -105,26 +108,44 @@ Running this rake task builds/rebuilds the mocks. It will be ran automatically a
 
     end
  
------------------   
+----------------- 
+  
+### Using With Rspec, --tag active_mocker:true
 
-    #person_spec.rb
+    require 'rspec'
+    require 'active_mocker/rspec_helper'
+    require 'spec/mocks/person_mock'
+    require 'spec/mocks/account_mock'
+        
+    describe 'Example', active_mocker:true do
+    
+       before do
+          Person.create # stubbed for PersonMock.create
+       end
+    
+    end
+       
+----------
 
-    require 'spec/mocks/person_mock.rb'
-    require 'spec/mocks/account_mock.rb'
+* Assigning the tag `active_mocker:true` will stub any ActiveRecord model Constants for Mock classes in `it` or `before/after(:each)`. This removes any need for dependency injection. Write tests and code like you would normally.
+* To stub any Constants in `before(:all)`, `after(:all)` use `mock_class('ClassName')`.
+* Will call `ActiveMocker::LoadedMocks.delete_all` in `after(:all)` block to clean up mock state for other tests.
 
-    PersonMock.column_names
+---------
+    
+    Person.column_names
         => ["id", "account_id", "first_name", "last_name", "address", "city"]
 
-    person_mock = PersonMock.new( first_name:  "Dustin", 
+    person = Person.new( first_name:  "Dustin", 
     							  last_name:   "Zeisler", 
     							  account:      AccountMock.new )
         => "#<PersonMock id: nil, account_id: nil, first_name: "Dustin", last_name: "Zeisler, address: nil, city: nil>"
 
-     person_mock.first_name
+     person.first_name
         => "Dustin"
 
 ### When schema.rb changes, the mock fails
-(Requires a regeneration of the mocks files.)
+(After `rake db:migrate` is called the mocks will be regenerated.)
  
 	#db/schema.rb
 
@@ -142,34 +163,38 @@ Running this rake task builds/rebuilds the mocks. It will be ran automatically a
 
 --------------
 
-    #person_spec.rb
-
-     PersonMock.new(first_name: "Dustin", last_name: "Zeisler")
-             =>#<RuntimeError Rejected params: {"first_name"=>"Dustin", "last_name"=>"Zeisler"} for PersonMock>
+     Person.new(first_name: "Dustin", last_name: "Zeisler")
+             =>#<UnknownAttributeError unknown attribute: first_name >
 
 ## Mocking Methods
 
 
 ### Class Methods
 
-     PersonMock.bar('baz')
+     Person.bar('baz')
         => RuntimeError: ::bar is not Implemented for Class: PersonMock
 
      # Rspec 3 Mocks
-     allow(PersonMock).to receive(:bar) do  |name, type=nil|
-        "Now implemented with #{name} and #{type}"
+     
+     RSpec.configure do |config|
+       config.mock_framework = :rspec
+       config.mock_with :rspec do |mocks|
+         mocks.verify_doubled_constant_names = true
+         mocks.verify_partial_doubles = true
+       end
      end
      
+     allow(Person).to receive(:bar) do  |name, type=nil|
+        "Now implemented with #{name} and #{type}"
+     end
 
-### Instance Methods
-
-      PersonMock.new.bar('foo', 'type')
-        => "Now implemented with foo and type"
-
-      # Rspec 3 Mocks
-      allow_any_instance_of(PersonMock).to receive(:bar) do
-         "Now implemented"
-      end
+     Person.bar('foo', 'type')
+       => "Now implemented with foo and type"
+       
+     # Rspec 3 mock class method
+     allow_any_instance_of(Person).to receive(:bar) do
+        "Now implemented"
+     end
 
 
 #### When the model changes, the mock fails
@@ -188,9 +213,7 @@ Running this rake task builds/rebuilds the mocks. It will be ran automatically a
    
 --------------
 
-    #person_spec.rb
-
-    person_mock.new.bar('foo', 'type')
+    Person.new.bar('foo', 'type')
       => ArgumentError: wrong number of arguments (2 for 1)
 
 ----------------
@@ -208,69 +231,36 @@ Running this rake task builds/rebuilds the mocks. It will be ran automatically a
     
 --------------
 
-     #person_spec.rb
-
     # Rspec 3 Mocks
-    allow(person_mock).to receive(:bar) do  |name, type=nil|
+    allow(person).to receive(:bar) do  |name, type=nil|
       "Now implemented with #{name} and #{type}"
     end
       => NoMethodError: undefined method `bar' for class `PersonMock'
+      
+### Constants and Modules are Available.
 
-### Managing Mocks
+* Any locally defined modules will not be included or extended.
 
-Rspec Tag - active_mocker:true
+---------------
 
-    describe 'Example', active_mocker:true do
-    
+    class Person < ActiveRecord::Base
+       CONSTANT_VALUE = 13
     end
-    
-  Assigning this tag will stub any ActiveRecord model Constants for Mock classes in any `it's` or `before(:each)`. To stub any Constants in `before(:all)`, `after(:all)` use `mock_class('ClassName')`. 
-
-Deletes All Records and Clears Mocked Methods
-    
-    PersonMock.clear_mock     
-    
-Clears all Loaded Mocks - (Use in after(:all) to keep state from leaking to other tests.)
-    
-    ActiveMocker::LoadedMocks.clear_all
-
-Deletes All Records for Loaded Mocks - (Useful in after(:each) to clean up state between examples)
-    
-    ActiveMocker::LoadedMocks.delete_all
-    
-List All Loaded Mocks
-    
-    ActiveMocker::LoadedMocks.all
-    		=> { 'PersonMock' => PersonMock } 
-
-Map The Mock Class to it's Model
-
-	ActiveMocker::LoadedMocks.class_name_to_mock
-		=> { 'Person' => PersonMock } 
-		
-
-
-### Constants and included and extended Modules are Available.
-
-	#app/models/person.rb
-
-	class User < ActiveRecord::Base
-	   CONSTANT_VALUE = 13
-	end
 
 -----------------------
 
-	#user_spec.rb
+    PersonMock::CONSTANT_VALUE
+    	=> 13
 
-	require 'spec/mocks/user_mock.rb'
 
-	UserMock::CONSTANT_VALUE
-		=> 13
+### Scoped Methods 
+* As long the mock file that holds the scope method is required it will be available but implemented.
 
-### Mocked Class
-	
-	UserMock.mocked_class
-		=> 'User'
+### Managing Mocks  
+
+Deletes All Records for Loaded Mocks - (Useful in after(:each) to clean up state between examples)
+    
+    ActiveMocker::LoadedMocks.delete_all
 
 ### ActiveRecord supported methods
 **class methods**
@@ -278,6 +268,10 @@ Map The Mock Class to it's Model
   * new
   * create/create!
   * column_names/attribute_names
+  * delete_all/destroy_all
+  
+**Query Methods**
+  * all
   * find
   * find_by/find_by!
   * find_or_create_by
@@ -289,10 +283,28 @@ Map The Mock Class to it's Model
   * delete_all(conditions_hash)
   * destroy(id)/delete(id)
   * update_all
-  * all
+  * update(id, attributes)
   * count
+  * uniq
   * first/last
+  * average(:field_name)
+  * minimum(:field_name)
+  * maximum(:field_name)
+  * sum(:field_name)
+  * order(:field_name)
+  * reverse_order
   * limit
+  
+**Relation Methods**
+  * concat
+  * include
+  * push
+  * clear
+  * take
+  * empty?
+  * replace
+  * any?
+  * many?
 
 **instance methods**
   
@@ -301,50 +313,29 @@ Map The Mock Class to it's Model
   * save/save!
   * write_attribute/read_attribute - (protected, can be used within modules)
   * delete
+  * new_record?
+  * persisted?
+  * reload
 
-**has_one/belongs_to**
+**has_one/belongs_to/has_many**
 
   * build_< association >
   * create_< association >
   * create_< association >!
-
-**has_many associations/Collections**
-
-  * empty?
-  * length/size/count
-  * uniq
-  * replace
-  * first/last
-  * concat
-  * include
-  * push
-  * clear
-  * take
-  * average(:field_name)
-  * minimum(:field_name)
-  * maximum(:field_name)
-  * sum(:field_name)
-  * find
-  * find_by/find_by!
-  * where(conditions_hash)
-  * where(key: array_of_values)
-  * where.not(conditions_hash)
-  * update_all
-  * delete_all
-  * order(:field_name)
-  * reverse_order
-  * limit
   * < association >.create
   * < association >.build
+  
 
 ### Schema/Migration Option Support
 * All schema types are supported and coerced by [Virtus](https://github.com/solnic/virtus). If coercion fails the passed value will be retained.
-* Default value
-* Scale and Precision not supported.
+* Default value is supported.
+* Scale and Precision are not supported.
 
 ### Known Limitations
 * Model names and table names must follow the default ActiveRecord naming pattern.
-* Whatever associations are setup in one mock object will not reflected in any other objects.
+* Whatever associations are setup in one mock object will not be reflected in any other objects. 
+    * There partial support for this feature coming in v1.6 when `ActiveMocker::Mock.config.experimental = true` is set. 
+
 * Validation are not present in mocks.
 * Sql queries, joins, etc will never be supported.
 

data/lib/active_mocker.rb

@@ -12,7 +12,7 @@ require 'active_mocker/logger'
 require 'active_support/all'
 require 'active_mocker/table'
 require 'active_mocker/field'
-require 'file_reader'
+require 'active_mocker/file_reader'
 require 'active_mocker/reparameterize'
 require 'active_mocker/active_record'
 require 'active_mocker/model_reader'

data/lib/active_mocker/active_record.rb

@@ -5,12 +5,12 @@ require 'active_mocker/active_record/unknown_class_method'
 require 'active_mocker/active_record/unknown_module'
 
 module ActiveMocker
+  # @api private
   module ActiveRecord
-    class Base #< ::ActiveRecord::Base
+    class Base
       extend Scope
       extend Relationships
       extend UnknownClassMethod
-      # extend UnknownModule
 
       def self.table_name=(table_name)
         @table_name = table_name

data/lib/active_mocker/active_record/relationships.rb

@@ -1,101 +1,111 @@
 require 'ostruct'
 require 'active_support/core_ext/string'
-module Relationships
-
-  def self.included(base)
-    base.extend(ClassMethods)
-  end
-
-  module ClassMethods
-    attr_reader :has_and_belongs_to_many, :belongs_to, :has_one, :has_many
-  end
-
-  def relationships
-    OpenStruct.new({has_many:   @has_many   ||= [],
-                    has_one:    @has_one    ||= [],
-                    belongs_to: @belongs_to ||= [],
-                    has_and_belongs_to_many: @has_and_belongs_to_many ||= []})
-  end
-
-  def single_relationships
-    belongs_to + has_one
-  end
-
-  def collections
-    has_and_belongs_to_many + has_many
-  end
-
-  class Relationship
-    attr_reader :name
-    def initialize(name, options={})
-      @name = name
-      @options = options.reduce(HashWithIndifferentAccess.new, :merge)
-    end
+module ActiveMocker
 
-    def options
-      @options.symbolize_keys
-    end
+  module ActiveRecord
 
-    def through
-      options[:through]
-    end
+    module Relationships
 
-    def class_name
-      options[:class_name] || name.to_s.camelize.singularize
-    end
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
 
-    def foreign_key
-      options[:foreign_key] || name.to_s.foreign_key
-    end
+      module ClassMethods
+        attr_reader :has_and_belongs_to_many, :belongs_to, :has_one, :has_many
+      end
 
-    def join_table
-      options[:join_table]
-    end
-  end
+      def relationships
+        OpenStruct.new({has_many: @has_many ||= [],
+                        has_one: @has_one ||= [],
+                        belongs_to: @belongs_to ||= [],
+                        has_and_belongs_to_many: @has_and_belongs_to_many ||= []})
+      end
 
-  class HasMany < Relationship
+      def single_relationships
+        belongs_to + has_one
+      end
 
-    attr_reader :klass_name
+      def collections
+        has_and_belongs_to_many + has_many
+      end
 
-    def initialize(name, klass_name, options={})
-      @klass_name = klass_name
-      super(name, options)
-    end
+      class Relationship
+        attr_reader :name
 
-    def foreign_key
-      options[:foreign_key] || klass_name.to_s.foreign_key
-    end
+        def initialize(name, options={})
+          @name = name
+          @options = options.reduce(HashWithIndifferentAccess.new, :merge)
+        end
+
+        def options
+          @options.symbolize_keys
+        end
+
+        def through
+          options[:through]
+        end
+
+        def class_name
+          options[:class_name] || name.to_s.camelize.singularize
+        end
 
-  end
+        def foreign_key
+          options[:foreign_key] || name.to_s.foreign_key
+        end
 
-  def has_many(*args)
-    @has_many ||= []
-    @has_many.push HasMany.new(args.shift, self.name, args)
-  end
+        def join_table
+          options[:join_table]
+        end
+      end
 
-  class HasOne < Relationship
-  end
+      class HasMany < Relationship
 
-  def has_one(*args)
-    @has_one ||= []
-    @has_one.push HasOne.new(args.shift, args)
-  end
+        attr_reader :klass_name
 
-  class BelongsTo < Relationship
-  end
+        def initialize(name, klass_name, options={})
+          @klass_name = klass_name
+          super(name, options)
+        end
 
-  def belongs_to(*args)
-    @belongs_to ||= []
-    @belongs_to.push BelongsTo.new(args.shift, args)
-  end
+        def foreign_key
+          options[:foreign_key] || klass_name.to_s.foreign_key
+        end
 
+      end
 
-  class HasAndBelongsToMany < Relationship
-  end
+      def has_many(*args)
+        @has_many ||= []
+        @has_many.push HasMany.new(args.shift, self.name, args)
+      end
+
+      class HasOne < Relationship
+      end
+
+      def has_one(*args)
+        @has_one ||= []
+        @has_one.push HasOne.new(args.shift, args)
+      end
+
+      class BelongsTo < Relationship
+      end
+
+      def belongs_to(*args)
+        @belongs_to ||= []
+        @belongs_to.push BelongsTo.new(args.shift, args)
+      end
+
+
+      class HasAndBelongsToMany < Relationship
+      end
+
+      def has_and_belongs_to_many(*args)
+        @has_and_belongs_to_many ||= []
+        @has_and_belongs_to_many.push HasAndBelongsToMany.new(args.shift, args)
+      end
+
+
+    end
 
-  def has_and_belongs_to_many(*args)
-    @has_and_belongs_to_many ||= []
-    @has_and_belongs_to_many.push HasAndBelongsToMany.new(args.shift, args)
-  end
+end
 
 end