active_mocker 2.5.1 → 2.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 785f7ca8b4d2444dfd83cb8352f76590228b6f75
-  data.tar.gz: 90ca606083940692eaa6775f0628320028bde325
+  metadata.gz: 5e2c739418bd430963f4bd13337a9ede2fad3530
+  data.tar.gz: 8a5a7d90e9a7c1169a8738c8df531d85b841f411
 SHA512:
-  metadata.gz: a8aaaa9f3670f62b90e3f8ea0b9e7a0448b713c7d12187ed7bf69eb52ef2d5d9e266092a38bccd6e810fb30d25837154f083c80453ffed6d01a4e008b649696d
-  data.tar.gz: 94726fc0af740ead662ab8965ab8f47300c000980c0ef16cc0643b52a9e49f2bcb20e4cd4da2e0915b64d71e950a6c9e3187017d462d4f5940cad889414af05c
+  metadata.gz: ab36a730b55d55dee3c9eeb2420573fb4fd25542c81206e66960f38fc6a3655674e747a74901625f598a6afec3f457047fa48c9531d7e74ecc30d2eae36a0a50
+  data.tar.gz: 62d6910efdf106bb1243f99fa871238b03a7eb7b9834a70f34e64066965f436d77012586d962e1e774a208c06bc432843d7084780a70c44864ae24963e4e5cb2

data/CHANGELOG.md

@@ -1,6 +1,30 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## 2.5.2 - 2017-09-29
+### Feature
+- Add mockable class methods to relations.
+- In ActiveRecord model comment Macro `ActiveMocker.safe_methods` now allow class_methods 
+```ruby
+ActiveMocker.safe_methods(*instance_methods, scopes: [], instance_methods: [], class_methods: [])
+```
+
+### Enhancement
+- Better error message when calling mockable method. Shows RSpec syntax to stub method.
+```ruby     
+    Unknown implementation for mock method: UserMock.new_remember_token
+    Stub method to continue.
+    
+    RSpec:
+    allow(
+      UserMock
+    ).to receive(:new_remember_token).and_return(:some_expected_result)
+```
+
+### Removed
+- `ActiveMocker::MockAbilities` required by "active_mocker/deprecated_components/mock_abilities"
+- `mock_method('ClassName')` required by "active_mocker/deprecated_components/rspec" Use `active_mocker.mocks.find('ClassName')` instead
+
 ## 2.5.1 - 2017-07-21
 ### Feature
 - Support ActiveRecord v5.1 when generating under that version delete_all does not accept any arguments.

data/README.md

@@ -6,7 +6,15 @@
 [![Gittip](http://img.shields.io/gittip/zeisler.svg)](https://www.gittip.com/zeisler/)
 
 ## Description
-ActiveMocker creates mock classes from ActiveRecord models, allowing your test suite to run at breakneck speed. This can be done by not loading Rails or hitting a database. The models are read dynamically and statically so that ActiveMocker can generate a Ruby file to require within a test. The mock file can be run by itself and comes with a partial implementation of ActiveRecord. Attributes and associations can be used the same as in ActiveRecord. Methods have the same argument signature but raise a NotImplementedError when called, allowing you to stub it with a mocking framework, like RSpec. Mocks are regenerated when the schema is modified so your mocks won't go stale, preventing the case where your units tests pass but production code fails.
+ActiveMocker creates mock classes from ActiveRecord models, 
+allowing your test suite to run at breakneck speed.
+ This is done by not loading Rails or hitting the database.
+  The models are read dynamically/statically so that ActiveMocker can generate a Ruby file to require within a test. 
+  The mock file can be run standalone and comes with many use parts of ActiveRecord included.
+   Attributes and associations can be used the same as in ActiveRecord. 
+   Method signatures can be brought over for stubbing or ActiveMocker friendly code can be brought over in it's entirety.
+   Mocks are regenerated when the schema is modified so your mocks won't go stale, 
+   preventing the case where your units tests pass but production code fails.
 
 Examples from a real apps
 
@@ -221,7 +229,7 @@ ActiveMocker::LoadedMocks.features.enable(:stub_active_record_exceptions)
   Be careful that it does not contain anything that ActiveMocker cannot run.
   
   ```ruby
-  # ActiveMocker.safe_methods(scopes: [], instance_methods: [:full_name])
+  # ActiveMocker.safe_methods(scopes: [], instance_methods: [:full_name], class_methods: [])
   class User
     def full_name
       "#{first_name} + #{last_name}"

data/lib/active_mocker/mock.rb

@@ -12,6 +12,7 @@ require "active_mocker/loaded_mocks"
 require "active_mocker/mock/hash_process"
 require "active_mocker/mock/collection"
 require "active_mocker/mock/queries"
+require "active_mocker/mock/mockable_method"
 require "active_mocker/mock/relation"
 require "active_mocker/mock/mock_relation"
 require "active_mocker/mock/association"

data/lib/active_mocker/mock/base.rb

@@ -5,6 +5,8 @@ module ActiveMocker
     include TemplateMethods
     extend Queries
     extend AliasAttribute
+    extend MockableMethod
+    include MockableMethod
 
     def self.inherited(subclass)
       ActiveMocker::LoadedMocks.send(:add, subclass)
@@ -155,16 +157,6 @@ module ActiveMocker
         end
         raise UpdateMocksError.new(name, version, ActiveMocker::Mock::VERSION) if version != ActiveMocker::Mock::VERSION
       end
-
-      # @deprecated
-      def call_mock_method(method:, caller:, arguments: [])
-        is_implemented(method, "::", caller)
-      end
-
-      # @deprecated
-      def is_implemented(method, type, call_stack)
-        raise NotImplementedError, "#{type}#{method} for Class: #{name}. To continue stub the method.", call_stack
-      end
     end
 
     # @deprecated

data/lib/active_mocker/mock/mockable_method.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ActiveMocker
+  module MockableMethod
+    private
+
+    def __am_raise_not_mocked_error(method:, caller:, type:)
+      variable_name = if is_a?(Relation)
+                        "#{self.class.name.underscore.split("/").first}_relation"
+                      elsif type == "#"
+                        "#{self.class.name.underscore}_record"
+                      else
+                        name
+                      end
+
+      message = <<-ERROR.strip_heredoc
+        Unknown implementation for mock method: #{variable_name}.#{method}
+        Stub method to continue.
+
+        RSpec:
+          allow(
+            #{variable_name}
+          ).to receive(:#{method}).and_return(:some_expected_result)
+      ERROR
+
+      raise NotImplementedError, message, caller
+    end
+  end
+end

data/lib/active_mocker/mock/relation.rb

@@ -2,6 +2,7 @@
 module ActiveMocker
   class Relation < Collection
     include Queries
+    include MockableMethod
 
     def initialize(collection = [])
       super
@@ -18,14 +19,14 @@ module ActiveMocker
       @from_limit
     end
 
+    def name
+      self.class.name
+    end
+
     private
 
     def set_from_limit
       @from_limit = true
     end
-
-    def name
-      self.class.name
-    end
   end
 end

data/lib/active_mocker/mock_creator.rb

@@ -9,9 +9,9 @@ module ActiveMocker
       :modules_constants,
       :class_methods,
       :attributes,
-      :scopes,
       :recreate_class_method_calls,
       :defined_methods,
+      :scopes,
       :associations,
     ].freeze
 

data/lib/active_mocker/mock_creator/defined_methods.rb

@@ -25,20 +25,21 @@ module ActiveMocker
       def create_method(m, type)
         plural_type = (type.to_s + "s").to_sym
         if safe_methods[plural_type].include?(m)
-          raise "ActiveMocker.safe_methods(class_methods: []) is currently unsupported." if type == :method
-          def_method = class_introspector.parsed_source.defs.detect { |meth| meth.name == m }
+          def_type   = type == :method ? :class_defs : :defs
+          def_method = class_introspector.parsed_source.public_send(def_type).detect { |meth| meth.name == m }
           Method.new(
             m,
             def_method.arguments,
             def_method.body
           )
         else
+          type_symbol = type == :method ? "::" : "#"
           Method.new(
             m,
             ReverseParameters.new(
               class_introspector.get_class.send(type, m).parameters
             ).parameters,
-            "call_mock_method(method: __method__, caller: Kernel.caller, arguments: [])"
+            "__am_raise_not_mocked_error(method: __method__, caller: Kernel.caller, type: '#{type_symbol}')"
           )
         end
       end

data/lib/active_mocker/mock_creator/scopes.rb

@@ -19,10 +19,13 @@ module ActiveMocker
         if safe_methods[:scopes].include?(name)
           find_scope_body_from_ast(name)
         else
-          "#{class_name}.send(:call_mock_method, " \
-                           "method: '#{name}', " \
-                           "caller: Kernel.caller, " \
-                           "arguments: [#{arguments.arguments}])"
+          <<-METHOD
+            __am_raise_not_mocked_error(
+              method: "#{name}",
+              caller: Kernel.caller,
+              type: "::"
+            )
+          METHOD
         end
       end
 

data/lib/active_mocker/mock_template.erb

@@ -7,7 +7,7 @@ class <%= class_name + mock_append_name %> < <%= parent_class_inspector.parent_m
 <%= partials.class_methods %>
 <%= partials.attributes %>
 <%= partials.associations %>
-<%= partials.scopes %>
 <%= partials.recreate_class_method_calls %>
 <%= partials.defined_methods %>
+<%= partials.scopes %>
 end

data/lib/active_mocker/mock_template/_defined_methods.erb

@@ -3,8 +3,12 @@
     <%= method.body %>
   end
 <% end -%>
+module ClassMethods
 <% class_methods.each do |method| -%>
-  def self.<%= method.name %><%= "(#{method.arguments})" unless method.arguments.blank? %>
+    def <%= method.name %><%= "(#{method.arguments})" unless method.arguments.blank? %>
     <%= method.body %>
   end
 <% end -%>
+end
+
+extend ClassMethods

data/lib/active_mocker/mock_template/_scopes.erb

@@ -14,6 +14,7 @@ end
 
   class ScopeRelation < ActiveMocker::Association
     include <%= class_name + mock_append_name %>::Scopes
+include ClassMethods
   end
 
   def self.__new_relation__(collection)

data/lib/active_mocker/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module ActiveMocker
-  VERSION = "2.5.1"
+  VERSION = "2.5.2"
   module Mock
     VERSION = "2" # This increments when breaking changes happen in the generated mocks
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_mocker
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.5.2
 platform: ruby
 authors:
 - Dustin Zeisler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-21 00:00:00.000000000 Z
+date: 2017-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -212,8 +212,6 @@ files:
 - lib/active_mocker/attribute_types/enum.rb
 - lib/active_mocker/attribute_types/register.rb
 - lib/active_mocker/config.rb
-- lib/active_mocker/deprecated_components/mock_abilities.rb
-- lib/active_mocker/deprecated_components/rspec.rb
 - lib/active_mocker/display_errors.rb
 - lib/active_mocker/error_object.rb
 - lib/active_mocker/file_path_to_ruby_class.rb
@@ -244,6 +242,7 @@ files:
 - lib/active_mocker/mock/has_one.rb
 - lib/active_mocker/mock/hash_process.rb
 - lib/active_mocker/mock/mock_relation.rb
+- lib/active_mocker/mock/mockable_method.rb
 - lib/active_mocker/mock/object_inspect.rb
 - lib/active_mocker/mock/queries.rb
 - lib/active_mocker/mock/records.rb

data/lib/active_mocker/deprecated_components/mock_abilities.rb

@@ -1,106 +0,0 @@
-# frozen_string_literal: true
-module ActiveMocker
-  # @deprecated to keep using until removal, require this file.
-  module MockAbilities
-    module InstanceAndClassMethods
-      def mock_instance_method(method, exe_bind = false, &block)
-        mockable_instance_methods[method.to_sym] = MockMethod.new(block, exe_bind)
-      end
-
-      alias stub_instance_method mock_instance_method
-
-      def clear_mocked_methods
-        mockable_instance_methods.clear
-        mockable_class_methods.clear
-      end
-
-      # @deprecated
-      def clear_mock
-        clear_mocked_methods
-        delete_all
-      end
-
-      private
-
-      def mockable_instance_methods
-        @mockable_instance_methods ||= {}
-      end
-
-      def class_name
-        return name if self.class == Class
-        self.class
-      end
-
-      def is_implemented(val, method, type, call_stack)
-        raise NotImplementedError, "#{type}#{method} for Class: #{class_name}. To continue stub the method.", call_stack if val.nil?
-      end
-
-      def execute_block(method)
-        return instance_exec(method.arguments, &method.block) if method.exe_bind
-        method.block.call(*method.arguments)
-      end
-    end
-
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-
-    def self.prepended(base)
-      class << base
-        prepend(ClassMethods)
-      end
-    end
-
-    module ClassMethods
-      include InstanceAndClassMethods
-
-      def mockable_class_methods
-        @mockable_class_methods ||= {}
-      end
-
-      def mock_class_method(method, exe_bind = false, &block)
-        mockable_class_methods[method.to_sym] = MockMethod.new(block, exe_bind)
-      end
-
-      alias stub_class_method mock_class_method
-
-      def call_mock_method(method:, caller:, arguments: [])
-        mock_method = mockable_class_methods[method.to_sym]
-        is_implemented(mock_method, method, "::", caller)
-        mock_method.arguments = arguments
-        execute_block(mock_method)
-      end
-
-      private :call_mock_method
-    end
-
-    include InstanceAndClassMethods
-
-    def call_mock_method(method:, caller:, arguments: [])
-      mock_method = mockable_instance_methods[method.to_sym]
-      mock_method = self.class.send(:mockable_instance_methods)[method.to_sym] if mock_method.nil?
-      is_implemented(mock_method, method, '#', caller)
-      mock_method.arguments = arguments
-      execute_block mock_method
-    end
-
-    private :call_mock_method
-
-    def clear_mocked_methods
-      mockable_instance_methods.clear
-    end
-
-    class MockMethod
-      attr_accessor :block, :arguments, :exe_bind
-
-      def initialize(block, exe_bind)
-        @block    = block
-        @exe_bind = exe_bind
-      end
-    end
-  end
-
-  class Base
-    prepend MockAbilities
-  end
-end

data/lib/active_mocker/deprecated_components/rspec.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-require "active_mocker/rspec"
-
-module ActiveMocker
-  module Rspec
-    # @deprecated method, will be removed in version 2.1
-    # Use +active_mocker.mocks.find('ClassName')+ instead
-    # To keep using until removal, require this file.
-    def mock_class(*args)
-      active_mocker.mocks.find(*args)
-    end
-  end
-end