memo_wise 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a1b98d394deb079784021cd44f5c7b41abdbf1cce2b0ce14b0a3957b12bfdabe
+  data.tar.gz: 45b6796cf708b5401a56edfd68156587f92826a71d833b7fe3bec24985d81ac9
+SHA512:
+  metadata.gz: 9ba145822aef3d07b2385daffaef15c22f5ffd4604e68d1fbad5d2bdf682c7723bb9a109cdda69d26efd6e5c05a21c1f0310ae70a1dbfd0f18a28cbe92d13d6f
+  data.tar.gz: 210c34c42f11e9d761c0fda0512daf62a533ec0fe2f19609a6cf0e052a1f2e2fdf22a55711764865616a319e387bff83fc5a6505973a4d89483ef383af008d13

data/.dependabot/config.yml

@@ -0,0 +1,13 @@
+# Reference: https://dependabot.com/docs/config-file/
+version: 1
+update_configs:
+  - package_manager: "ruby:bundler"
+    directory: "/"
+    update_schedule: "live"
+    automerged_updates:
+      - match:
+          dependency_type: "development"
+          update_type: "all"
+  - package_manager: "ruby:bundler"
+    directory: "/benchmarks"
+    update_schedule: "live"

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,4 @@
+**Before merging:**
+
+- [ ] Copy the latest benchmark results into the `README.md` and update this PR
+- [ ] If this change merits an update to `CHANGELOG.md`, add an entry following Keep a Changelog [guidelines](https://keepachangelog.com/en/1.0.0/) with [semantic versioning](https://semver.org/)

data/.github/workflows/auto-approve-dependabot.yml

@@ -0,0 +1,26 @@
+# This workflow auto-approves pull-requests when the github actor is a
+# dependabot user and it is opening a new pull request.
+#
+# The problem that this workflow solves is that we have branch protection on
+# our repositories that prevent PRs from merging unless there is an
+# approval present. The problem is that this will block PRs that dependabot
+# may want to merge automatically. Auto-approving dependabot PRs will allow
+# the automatic merge to complete. We control what gets automerged through
+# the dependabot configuration.
+#
+# This is a known issue: https://github.com/dependabot/feedback/issues/852
+name: Auto-approve dependabot pull requests
+on:
+  pull_request:
+    types: [opened]
+
+jobs:
+  dependabot-triage:
+    runs-on: ubuntu-latest
+    if: (github.actor == 'dependabot[bot]' || github.actor == 'dependabot-preview[bot]')
+
+    steps:
+      - name: Auto-approve for dependabot
+        uses: hmarr/auto-approve-action@v2.0.0
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"

data/.github/workflows/main.yml

@@ -0,0 +1,40 @@
+name: Main
+on:
+  pull_request:
+    branches:
+    - main
+  push:
+    branches:
+    - main
+jobs:
+  ci:
+    name: CI
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [jruby, 2.4, 2.5, 2.6, 2.7, 3.0]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@main
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - uses: actions/cache@v1
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gems-
+    - run: bundle config path vendor/bundle
+    - run: bundle config set without 'checks:docs'
+      if: matrix.ruby != 3.0
+    - run: bundle install --jobs 4 --retry 3
+    - run: bundle exec rspec
+    - run: bundle exec rubocop
+      if: matrix.ruby == 3.0
+    - run: bundle exec yard doctest
+      if: matrix.ruby == 3.0
+    - run: |
+        BUNDLE_GEMFILE=benchmarks/Gemfile bundle install --jobs 4 --retry 3
+        BUNDLE_GEMFILE=benchmarks/Gemfile bundle exec ruby benchmarks/benchmarks.rb
+      if: matrix.ruby == '2.7' || matrix.ruby == '3.0'

data/.github/workflows/remove-needs-qa.yml

@@ -0,0 +1,35 @@
+# This workflow removes a "Needs QA" label from a PR when the actor is the
+# dependabot user merging a PR.
+#
+# We need this mechanism to allow for automerging whitelisted dependencies while
+# also allowing for blocking a merge to main for deployment (in the way that
+# our other PRs work). When the automerge script runs in henchman, it looks
+# for `Needs QA` on github pull requests, and if the label is present,
+# blocks the commit from merging.
+name: Remove 'Needs QA' label for auto-merged PRs.
+on:
+  pull_request:
+    types: [closed]
+
+jobs:
+  remove-label:
+    runs-on: ubuntu-latest
+    if: >
+      (github.actor == 'dependabot[bot]' || github.actor == 'dependabot-preview[bot]')
+      && github.event.pull_request.merged
+
+    steps:
+      # Our triage workflow adds 'Needs QA' to the PR in order to block it from
+      # merging to production. This removes that label when dependabot is doing
+      # the merging.
+      - name: Remove QA Label
+        uses: actions/github-script@0.4.0
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            github.issues.removeLabel({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              name: 'Needs QA'
+            })

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/benchmarks/.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/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_gem:
+  panolint: rubocop.yml

data/.ruby-version

@@ -0,0 +1 @@
+3.0.0

data/.yardopts

@@ -0,0 +1,8 @@
+--readme README.md
+--title 'MemoWise Documentation'
+--charset utf-8
+--markup markdown
+--plugin yard-doctest
+--no-private
+'lib/**/*.rb' - '*.md'
+LICENSE.txt

data/CHANGELOG.md

@@ -0,0 +1,57 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+(nothing yet!)
+
+## [0.3.0] - 2021-02-11
+### Added
+- Changelog and tags
+- Logo
+- Memoization of class methods
+- Support for instances created with `Class#allocate`
+- Official testing and benchmarks for Ruby 3.0
+- Release procedure for gem
+
+## [0.2.0] - 2020-10-28
+### Added
+- `#preset_memo_wise` to preset memoization values
+- YARD docs
+- Code coverage setup, badge, tests to ensure 100% coverage
+
+## [0.1.2] - 2020-10-01
+### Added
+- Tests to assert memoization works with Values gem
+- Badges for tests, docs and gem
+
+### Changed
+- Internal data structure for memoization is a nested hash
+- Separate `*args` and `**kwargs` in method signatures
+
+## [0.1.1] - 2020-08-03
+### Added
+- Benchmarks comparing `MemoWise` to other Ruby memoization gems
+- `#reset_memo_wise` resets memoization for specific arguments for methods
+
+## [0.1.0] - 2020-07-20
+### Added
+- `#memo_wise` defined to enable memoization
+- `#reset_memo_wise` and `#reset_all_memo_wise` defined to reset memoization
+
+## [0.0.1] - 2020-06-29
+### Added
+- Initial gem project structure
+- Panolint
+- Dependabot setup
+
+[Unreleased]: https://github.com/panorama-ed/memo_wise/compare/v0.3.0...HEAD
+[0.3.0]: https://github.com/panorama-ed/memo_wise/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/panorama-ed/memo_wise/compare/v0.1.2...v0.2.0
+[0.1.2]: https://github.com/panorama-ed/memo_wise/compare/v0.1.1...v0.1.2
+[0.1.1]: https://github.com/panorama-ed/memo_wise/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/panorama-ed/memo_wise/compare/v0.0.1...v0.1.0
+[0.0.1]: https://github.com/panorama-ed/memo_wise/releases/tag/v0.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at engineering@panoramaed.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an
+incident. Further details of specific enforcement policies may be posted
+separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at
+[https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+gemspec
+
+group :test do
+  gem "rspec", "~> 3.10"
+  gem "values", "~> 1"
+end
+
+# Excluded from CI except on latest MRI Ruby, to reduce compatibility burden
+group :checks do
+  gem "codecov"
+  gem "panolint", github: "panorama-ed/panolint"
+end
+
+# Excluded from CI except on latest MRI Ruby, to reduce compatibility burden
+group :docs do
+  gem "redcarpet", "~> 3.5"
+  gem "yard", "~> 0.9"
+  gem "yard-doctest", "~> 0.1"
+end
+
+# Optional, only used locally to release to rubygems.org
+group :release, optional: true do
+  gem "rake"
+end

data/Gemfile.lock

@@ -0,0 +1,111 @@
+GIT
+  remote: https://github.com/panorama-ed/panolint.git
+  revision: ca5edaa1f6985e2812998a937229f972c07bce56
+  specs:
+    panolint (0.1.2)
+      brakeman (>= 4.8, < 6.0)
+      rubocop (>= 0.83, < 2.0)
+      rubocop-performance (~> 1.5)
+      rubocop-rails (~> 2.5)
+      rubocop-rake (~> 0.5)
+      rubocop-rspec (~> 2.0)
+
+PATH
+  remote: .
+  specs:
+    memo_wise (0.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.4.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.2)
+    brakeman (5.0.0)
+    codecov (0.4.3)
+      simplecov (>= 0.15, < 0.22)
+    concurrent-ruby (1.1.8)
+    diff-lcs (1.4.4)
+    docile (1.3.5)
+    i18n (1.8.8)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.3)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    redcarpet (3.5.1)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.9.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.9.2)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.9.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 0.90.0, < 2.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.2.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
+    unicode-display_width (2.0.0)
+    values (1.8.0)
+    yard (0.9.26)
+    yard-doctest (0.1.17)
+      minitest
+      yard
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  codecov
+  memo_wise!
+  panolint!
+  rake
+  redcarpet (~> 3.5)
+  rspec (~> 3.10)
+  values (~> 1)
+  yard (~> 0.9)
+  yard-doctest (~> 0.1)
+
+BUNDLED WITH
+   2.2.3