method_call_count 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c963a732eead900ad046e8eba20e5a322489649ecbd4efb1639c42fb43af8ea0
+  data.tar.gz: 4432e172eb154e5dc8aab005d30d16078d739f2830c121c61e6e32db9ce569e9
+SHA512:
+  metadata.gz: a8300464c216f1b57bb02c0f806dcb37258258dda55f648c67744b2932b1d7ce8445abc7827cee98b980e71c8608d35726c19708f1d3776671579d3fed2dd84f
+  data.tar.gz: 22eb87fe34aaf3a335e03dd28bef492cc4ac5fa60fbd95891417e5c842a90aca6663f9e0d98c36665f33f4bba3284e54b059a735c768c2d88cabb7b3de57db97

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in method_call_count.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    method_call_count (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (10.5.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  method_call_count!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Colin Horner
+
+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.md

@@ -0,0 +1,61 @@
+# MethodCallCount
+
+This gem is a helper for Rspec or other testing frameworks, in particular in situations where you are using dependency injection, and you want to verify whether a certain input will result in that dependency being called.This will mixin a method into your class #times_called which is a hash that will be incremented each time a method is invoked on an object.  This count is enabled on a class.
+
+There is also separately a class, MethodCallCount::CallableStub, which can be aused as a stub for classes that implement #call with kwargs or an option hash to capture the kwargs that were sent.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'method_call_count'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install method_call_count
+
+## Usage
+
+For MethodCallCount
+
+```
+class MyClass
+  def some_method
+    'do_something'
+  end
+end
+
+MethodCallCount.enable(MyClass)
+
+my_object = MyClass::new
+my_object.some_method
+my_object.times_called[:some_method] # returns 1
+```
+
+For MethodCallCount::CallableStub
+
+```
+my_stub = MethodCallCount::new
+my_stub.call(arg: 'value')
+my_stub.called_with[:arg] # returns 'value'
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/method_call_count.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "method_call_count"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/method_call_count.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'method_call_count/version'
+require 'method_call_count/callable_stub'
+
+class MethodCallCount
+  @@initialized ||= []
+
+  def self.enable(klass)
+    return if @@initialized.include?(klass)
+    @@initialized.push(klass)
+    klass.prepend Module.new{
+      (klass.instance_methods - klass.superclass.instance_methods - [:enable]).each do |method|
+        define_method(method) do |*args|
+          @called[method] = (@called[method] || 0) + 1
+          super(*args)
+        end
+      end
+
+      def initialize(*args)
+        @called = Hash.new{|h, k| h[k] = 0}
+        super(*args)
+      end
+
+      def times_called
+        @called.dup
+      end
+    }
+  end
+
+  class Error < StandardError; end
+end
+

data/lib/method_call_count/callable_stub.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class MethodCallCount
+  class CallableStub
+    def initialize
+      @called_with = {}
+    end
+    def call(options={})
+      @called_with = options
+    end
+    def called_with
+      @called_with.dup
+    end
+  end
+end
+

data/lib/method_call_count/version.rb

@@ -0,0 +1,3 @@
+class MethodCallCount
+  VERSION = '0.1.0'
+end

data/method_call_count.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'method_call_count/version'
+
+Gem::Specification.new 'method_call_count', '0.1.0' do |spec|
+  spec.name          = 'method_call_count'
+  spec.version       = MethodCallCount::VERSION
+  spec.authors       = ['Colin Horner']
+  spec.email         = ['25807014+cmcolinh@users.noreply.github.com']
+
+  spec.summary       = 'Method Call Count'
+  spec.description   = "A mixin that will keep a count of how many times an object's methods were called."
+  #spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.license       = 'MIT'
+
+  spec.metadata['allowed_push_host'] = 'https://www.rubygems.org'
+
+  #spec.metadata['homepage_uri'] = spec.homepage
+  #spec.metadata['source_code_uri'] = "TODO: Put your gem's public repo URL here."
+  #spec.metadata['changelog_uri'] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: method_call_count
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Colin Horner
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A mixin that will keep a count of how many times an object's methods
+  were called.
+email:
+- 25807014+cmcolinh@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/method_call_count.rb
+- lib/method_call_count/callable_stub.rb
+- lib/method_call_count/version.rb
+- method_call_count.gemspec
+homepage: 
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://www.rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Method Call Count
+test_files: []