grift 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27b2eccd337c396229e197435ace7c447cc7575b1a0a65deddd350a3e63a3faa
-  data.tar.gz: 3be36076623ba83a2654a827b5375da903168b8594390678fe461d74a9a5baef
+  metadata.gz: d0691b07f2ab035b9c6110605b00bc162822394c078cf27271e458fd60026a18
+  data.tar.gz: b14b4078f42413059aab0114a62c0785c8ed19acb30a6f743e8c0c7fcab771fb
 SHA512:
-  metadata.gz: c8080f30c6fd6a9dcdad37e500a575f6056eddb404a155bce5e153761227040684200e00d45d1c06c4e42355ea077fede56e52c7ba29a454a1eefc7717cad806
-  data.tar.gz: c34f2ac31553fba7687503926e5fc5baa1b282516258fb48d669d157ff1e7b9b6ab8650297cf4ccd0d6741c79045836a18942dff42da90a6bcf2c764193d99a1
+  metadata.gz: 3719002c8f0a986c3ecd97555b7008ef21b34f5397fed8de7e721eca0a5767d101493d9b8c2852c85bc27f9742b88d2ad8c23c700d6487b6bf2e16a9baf131fa
+  data.tar.gz: 6d7eb236900d1be7c8928b33f5c0e5649fd96bf443f8ff1542da71f5818e8e5b8aa4d0247a10c829537bd6879bc4e741ef8015f795f18083b2b80c7af7534ace

data/.github/CODEOWNERS

@@ -0,0 +1 @@
+.github/ @clarkedb

data/.github/CONTRIBUTING.md

@@ -0,0 +1,37 @@
+# How to become a contributor and submit your own code
+
+1. Submit an issue on GitHub describing your proposed change to this repo
+1. A repo owner will respond to your issue promptly
+1. Fork the repo, develop and test your code changes
+1. Ensure that your code adheres to the existing style in the code to which you are contributing
+1. Ensure that your code has an appropriate set of tests which all pass
+1. Title your pull request following [Conventional Commits](https://www.conventionalcommits.org/) styling
+1. Submit a pull request.
+
+## Policy on inclusive language
+
+To make Grift a pleasant and effective experience for everyone, we use try to use inclusive language.
+
+These resources can help:
+
+- Google's tutorial [Writing inclusive documentation](https://developers.google.com/style/inclusive-documentation) teaches by example, how to reword non-inclusive things.
+- Linux kernel mailing list's [Coding Style: Inclusive Terminology](https://lkml.org/lkml/2020/7/4/229) said "Add no new instances of non-inclusive words, here is a list of words not include new ones of."
+- Linguistic Society of America published [Guidelines for Inclusive Language](https://www.linguisticsociety.org/resource/guidelines-inclusive-language) which concluded: "We encourage all linguists to consider the possible reactions of their potential audience to their writing and, in so doing, to choose expository practices and content that is positive, inclusive, and respectful."
+
+This project attempts to improve in these areas. Join us in doing that important work.
+
+## Required checks
+
+Before pushing your code and opening a PR, we recommend you run the following checks to avoid
+our GitHub Actions Workflow to block your contribution.
+
+```bash
+# install dependencies
+$ bundle install
+
+# Run unit tests and check code coverage
+$ bundle exec rake test
+
+# Check code style
+$ bundle exec rubocop
+```

data/.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+
+updates:
+  - directory: /
+    open-pull-requests-limit: 10
+    package-ecosystem: bundler
+    target-branch: develop
+    schedule:
+      interval: weekly
+    labels:
+      - dependencies

data/.github/workflows/ci.yml

@@ -0,0 +1,46 @@
+name: CI
+
+on: push
+
+env:
+  GIT_COMMIT_SHA: ${{ github.sha }}
+  GIT_BRANCH: ${{ github.ref }}
+
+jobs:
+  linting:
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_WITH: lint
+      BUNDLE_WITHOUT: development:test
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby 2.7
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+
+      - name: Rubocop
+        run: bundle exec rubocop --format progress
+
+  build:
+    needs: [ linting ]
+    runs-on: ubuntu-latest
+    name: build (ruby v${{ matrix.ruby }})
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.5', '2.6', '2.7', '3.0' ]
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Test
+        continue-on-error: ${{ matrix.experimental }}
+        run: bundle exec rake test

data/.gitignore

@@ -11,27 +11,11 @@
 /tmp/
 
 # Used by dotenv library to load environment variables.
-# .env
+.env
 
 # Ignore Byebug command history file.
 .byebug_history
 
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-*.bridgesupport
-build-iPhoneOS/
-build-iPhoneSimulator/
-
-## Specific to RubyMotion (use of CocoaPods):
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-# vendor/Pods/
-
 ## Documentation cache and generated files:
 /.yardoc/
 /_yardoc/
@@ -46,11 +30,15 @@ build-iPhoneSimulator/
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
 # Gemfile.lock
-# .ruby-version
-# .ruby-gemset
+.ruby-version
+.ruby-gemset
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
 
 # Used by RuboCop. Remote config files pulled in from inherit_from directive.
 # .rubocop-https?--*
+
+# IDE and system files
+.vscode/
+**/.DS_STORE

data/.rubocop.yml

@@ -0,0 +1,159 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+
+# General
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+
+# Layout
+Layout/BlockAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: start_of_block
+
+Layout/ClassStructure:
+  Enabled: true
+
+Layout/DotPosition:
+  Enabled: true
+  EnforcedStyle: leading
+
+Layout/FirstArrayElementIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+
+Layout/HashAlignment:
+  Enabled: true
+  EnforcedColonStyle: key
+  EnforcedLastArgumentHashStyle: always_inspect
+
+Layout/LineEndStringConcatenationIndentation:
+  Enabled: true
+  EnforcedStyle: aligned
+
+Layout/LineLength:
+  Enabled: true
+  Max: 120
+
+Layout/MultilineArrayLineBreaks:
+  Enabled: true
+
+Layout/MultilineAssignmentLayout:
+  Enabled: false
+
+Layout/MultilineHashKeyLineBreaks:
+  Enabled: true
+
+Layout/MultilineMethodArgumentLineBreaks:
+  Enabled: true
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented_relative_to_receiver
+
+Layout/MultilineOperationIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Layout/ParameterAlignment:
+  Enabled: true
+  EnforcedStyle: with_first_parameter
+
+Layout/RedundantLineBreak:
+  Enabled: true
+  InspectBlocks: false
+
+Layout/SingleLineBlockChain:
+  Enabled: false
+
+Layout/SpaceBeforeBrackets:
+  Enabled: true
+
+Layout/TrailingEmptyLines:
+  Enabled: true
+  EnforcedStyle: final_newline
+
+# Lint
+Lint/AmbiguousAssignment:
+  Enabled: true
+
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: true
+
+Lint/AmbiguousRange:
+  Enabled: true
+
+# Metrics
+Metrics/AbcSize:
+  Max: 20
+  Exclude:
+    - "test/**/*"
+
+Metrics/ClassLength:
+  Max: 150
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+  Exclude:
+    - "test/**/*"
+
+Metrics/MethodLength:
+  Max: 20
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+  Exclude:
+    - "test/**/*"
+
+# Naming
+Naming/InclusiveLanguage:
+  Enabled: true
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
+# Style
+Style/AndOr:
+  EnforcedStyle: always
+
+Style/ArrayCoercion:
+  Enabled: true
+
+Style/CollectionCompact:
+  Enabled: true
+
+Style/ConstantVisibility:
+  Enabled: true
+  IgnoreModules: true
+
+Style/Documentation:
+  Exclude:
+    - "test/**/*"
+
+Style/DocumentationMethod:
+  Enabled: true
+  Exclude:
+    - "test/**/*"
+
+Style/SelectByRegexp:
+  Enabled: false
+
+Style/SwapValues:
+  Enabled: true
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma

data/.yardopts

@@ -0,0 +1 @@
+-o ./docs - LICENSE

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+N/A
+
+## [1.0.0](https://github.com/clarkedb/grift/releases/tag/v1.0.0) - 2021-11-06
+
+The first major version of Grift! 100% documentation and 100% code coverage.
+
+### Added
+
+* Spying on method
+* Mocking method return values
+* Mocking method implementation
+* Restricted methods that cannot be mocked
+* MiniTest Plugin to use hooks and clean up after tests
+* Documentation!
+
+## [0.1.0](https://github.com/clarkedb/grift/releases/tag/v0.1.0) - 2021-10-12
+
+The initial version of Grift. This was never intended for use and should be considered **deprecated**.

data/Gemfile

@@ -1,7 +1,21 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-# Specify your gem's dependencies in grift.gemspec
+source 'https://rubygems.org'
+
+# Grift's gem dependencies are defined in grift.gemspec
 gemspec
 
-gem "minitest", "~> 5.0"
-gem "rake", "~> 12.0"
+gem 'rake', '>= 12.0'
+
+group :development, :test do
+  gem 'minitest', '>= 5.0'
+  gem 'minitest-reporters', '>= 1.4.3'
+  gem 'simplecov', '>= 0.21.2'
+end
+
+group :development, :lint do
+  gem 'rubocop'
+  gem 'rubocop-minitest'
+  gem 'rubocop-packaging', '>= 0.5'
+  gem 'rubocop-performance', '>= 1.0'
+end

data/Gemfile.lock

@@ -1,21 +1,68 @@
 PATH
   remote: .
   specs:
-    grift (0.1.0)
+    grift (1.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ansi (1.5.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    docile (1.4.0)
     minitest (5.14.4)
+    minitest-reporters (1.4.3)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
     rake (12.3.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.22.3)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.12.0)
+      parser (>= 3.0.1.1)
+    rubocop-minitest (0.15.2)
+      rubocop (>= 0.90, < 2.0)
+    rubocop-packaging (0.5.1)
+      rubocop (>= 0.89, < 2.0)
+    rubocop-performance (1.11.5)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   grift!
-  minitest (~> 5.0)
-  rake (~> 12.0)
+  minitest (>= 5.0)
+  minitest-reporters (>= 1.4.3)
+  rake (>= 12.0)
+  rubocop
+  rubocop-minitest
+  rubocop-packaging (>= 0.5)
+  rubocop-performance (>= 1.0)
+  simplecov (>= 0.21.2)
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -1,5 +1,9 @@
 # Grift
 
+[![gem version](https://badge.fury.io/rb/grift.svg)](https://rubygems.org/gems/grift)
+[![downloads](https://ruby-gem-downloads-badge.herokuapp.com/grift)](https://rubygems.org/gems/grift)
+[![build](https://github.com/clarkedb/grift/actions/workflows/ci.yml/badge.svg)](https://github.com/clarkedb/grift/actions?query=workflow%3ACI)
+
 Mocking and spying in Ruby's MiniTest framework
 
 ## Installation
@@ -22,16 +26,84 @@ Or install it yourself as:
 gem install grift
 ```
 
+### MiniTest Plugin
+
+We recommend using the plugin so that mocks are cleaned up after each test automatically. To enable the plugin, add the following lines of code to your `test_helper` file.
+
+```ruby
+class Minitest::Test
+  include Grift::MinitestPlugin
+end
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+For complete usage guide, see the [docs](https://clarkedb.github.io/grift/).
+
+### Spy
+
+To "mock" a method and spy on its call args and results without changing the behavior of the method:
+
+```ruby
+my_mock = Grift.spy_on(MyClass, :my_method)
+```
+
+### Mock
+
+To mock a method and its return value:
+
+```ruby
+my_mock = Grift.mock(MyClass, :my_method, return_value)
+
+my_spy = Grift.spy_on(MyClass, :my_method)
+my_spy.mock_return_value(return_value)
+```
+
+To mock the implementation:
+
+```ruby
+my_spy = Grift.spy_on(MyClass, :my_method)
+my_spy.mock_implementation do |arg1, arg2|
+    x = do_something(arg1, arg2)
+    do_something_else(x) # the last line will be returned
+end
+```
+
+### Chaining
+
+You can chain `mock_return_value` and `mock_implementation` after initializing the mock.
+
+```ruby
+my_mock = Grift.spy_on(MyClass, :my_method).mock_implementation do |*args|
+    do_something(*args)
+end
+#=> Grift::MockMethod object is returned
+```
+
+### Results
+
+To get the results and details of the calls, call `mock` on your mock method object.
+
+```ruby
+# get the number of times the mocked method has been called
+my_mock.mock.count
+#=> 2
+
+# get args for each call to the method while mocked
+my_mock.mock.calls
+#=> [['first_arg1', 'second_arg1'], ['first_arg2', 'second_arg2']]
+
+# get results (return value) for each call to the method while mocked
+my_mock.mock.results
+#=> ['result1', 'result2']
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After forking the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+When developing, to install Grift whith your changes 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 [clarkedb/grift](https://github.com/clarkedb/grift).
+Bug reports and pull requests are welcome on GitHub at [clarkedb/grift](https://github.com/clarkedb/grift). Before submitting a pull request, see [CONTRIBUTING](.github/CONTRIBUTING.md).

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'grift'

data/grift.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'lib/grift/version'
 
 Gem::Specification.new do |spec|

data/lib/grift/config/restricted.yml

@@ -0,0 +1,31 @@
+Grift:
+  - "*"
+
+Minitest:
+  - "*"
+
+# ruby classes
+Array:
+  - count
+  - empty?
+  - include?
+  - map
+  - push
+
+Class:
+  - "*"
+
+Hash:
+  - "[]"
+  - "[]="
+  - include?
+  - select
+
+String:
+  - "=="
+  - "[]"
+  - to_sym
+
+Symbol:
+  - "=="
+  - to_s

data/lib/grift/config.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Grift
+  ##
+  # The config for Grift. This is readonly for now.
+  #
+  module Config
+    @restricted_methods = YAML.safe_load(File.read('lib/grift/config/restricted.yml'))
+
+    class << self
+      ##
+      # The restricted methods as a hash organized by class as the key and then the
+      # methods in an array as the value. A '*' means all methods are restricted.
+      # A '^' preceding a method overrides the wildcard restriction.
+      #
+      # @example
+      #   Grift::Config.restricted_methods
+      #   #=> { 'Class' => ['method1', ...], ... }
+      #
+      # @return [Hash] the restricted methods organized by class
+      #
+      attr_reader :restricted_methods
+    end
+  end
+end

data/lib/grift/error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Grift
+  ##
+  # The error used for all of Grift.
+  #
+  class Error < StandardError; end
+end

data/lib/grift/minitest_plugin.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Grift
+  ##
+  # A plugin to clean up mocks after tests in Minitest.
+  # It is recommended that you include this plugin to avoid
+  # needing to cleanup the mocks after each test.
+  #
+  # To setup the plugin for your tests, you should include the
+  # following code in your `test_helper`
+  #
+  #   class Minitest::Test
+  #     include Grift::MinitestPlugin
+  #   end
+  #
+  module MinitestPlugin
+    ##
+    # After each test restores all mocks with no watching.
+    #
+    # @return [Grift::MockStore]
+    #
+    def after_teardown
+      super
+      Grift.restore_all_mocks(watch: false)
+    end
+  end
+end