hollaback 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f738463a8b1b0abeb5b51456d41365d7315cc59d
-  data.tar.gz: 5ef3503097683cfd440c0646725245e57fc4aa79
+SHA256:
+  metadata.gz: ea92615d4b9e2efd215fc0eab350aa723563640a2a3468448b86a4e132aa3c64
+  data.tar.gz: a813bf9aebe70b6410cb7165a7f541a247ada986dcfcba3453e5eac2ae7757bb
 SHA512:
-  metadata.gz: 4a574a01e9818b717949b1c3473ff5f2081508e0853f5c797e060922a6cf8b9a98ab2c619c287469e6363f7b94eb97d2bbaf8b4981b5ddb6e0b245b829d000ed
-  data.tar.gz: e050207bbc9b865f01400558ffc88f696d7f0c3f2ff0120e47eaa2ca4acb52e0a2b811c459f7530d24ea262f71bddae18245c330ac08bbcf5296dc0653096f60
+  metadata.gz: 91de650d823b6ebe4427a6497f83fd0b00ea208b703e4d40d2cbb37e2436cdd6a40850c48d6ac34a2098a1f78281a69c1d450fd575fd5d919496300bcbd97fc5
+  data.tar.gz: 748fe37b4d56647abebdaff118d24066b8849da1a1838ec1db6bd6dea7b9f1287ef9b537daa9693a7dddf626be7c5ef82460b02119f0d0f5fb8fb990bba124cc

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/main.yml

@@ -0,0 +1,34 @@
+name: Main
+on:
+- push
+- pull_request_target
+jobs:
+  ci:
+    name: CI
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+    steps:
+    - uses: actions/checkout@master
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0
+        bundler-cache: true
+    - name: Lint and test
+      run: |
+        bundle exec rubocop --parallel
+        bundle exec rake test
+  automerge:
+    name: AutoMerge
+    needs: ci
+    runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request_target' && (github.actor == github.repository_owner || github.actor == 'dependabot[bot]')
+    steps:
+    - uses: actions/github-script@v3
+      with:
+        script: |
+          github.pulls.merge({
+            owner: context.payload.repository.owner.login,
+            repo: context.payload.repository.name,
+            pull_number: context.payload.pull_request.number
+          })

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/.rubocop.yml

@@ -1,14 +1,30 @@
 AllCops:
   DisplayCopNames: true
   DisplayStyleGuide: true
-  TargetRubyVersion: 2.0
+  TargetRubyVersion: 2.7
   Exclude:
-  - 'vendor/**/*'
+  - '{tmp,vendor,yard}/**/*'
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 80
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+Naming/RescuedExceptionsVariableName:
+  Enabled: false
 
 Style/Documentation:
   Enabled: false
 
-Style/PercentLiteralDelimiters:
-  PreferredDelimiters:
-    '%w': '[]'
-    '%i': '[]'
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.1] - 2021-11-17
+
+### Changed
+
+- Require MFA for releasing.
+
+[unreleased]: https://github.com/kddnewton/hollaback/compare/v0.1.1...HEAD
+[0.1.1]: https://github.com/kddnewton/hollaback/compare/ddb3d6...v0.1.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, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, 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 kddnewton@gmail.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://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    hollaback (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    docile (1.4.0)
+    minitest (5.14.4)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.23.0)
+      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.13.0)
+      parser (>= 3.0.1.1)
+    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
+  bundler (~> 2.0)
+  hollaback!
+  minitest (~> 5.11)
+  rake (~> 13.0)
+  rubocop (~> 1.12)
+  simplecov (~> 0.14)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Localytics http://www.localytics.com
+Copyright (c) 2016-present Kevin Newton
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,7 +1,7 @@
 # Hollaback
 
-[![Build Status](https://travis-ci.org/localytics/hollaback.svg?branch=master)](https://travis-ci.org/localytics/hollaback)
-[![Coverage Status](https://coveralls.io/repos/github/localytics/hollaback/badge.svg?branch=master)](https://coveralls.io/github/localytics/hollaback?branch=master)
+[![Build Status](https://github.com/kddnewton/hollaback/workflows/Main/badge.svg)](https://github.com/kddnewton/hollaback/actions)
+[![Gem Version](https://img.shields.io/gem/v/hollaback.svg)](https://rubygems.org/gems/hollaback)
 
 Builds method chains such that you can execute functions inside of a predefined set of callbacks.
 
@@ -23,7 +23,31 @@ Or install it yourself as:
 
 ## Usage
 
-Sometimes you want to execute code in the context of hooks. With this gem you can build `before`, `after`, and `around` callbacks that are executed in the context of the given object. For `before`s and `after`s you can use either symbols are procs. For `around`s you can use symbols.
+Sometimes you want to execute code in the context of hooks. With this gem you can build `before`, `after`, and `around` callbacks that are executed in the context of the given object. For `before`s and `after`s you can use either symbols or procs. For `around`s you can use symbols.
+
+First, create a `Hollaback::Chain` object that will represent all of the callbacks that will be called around a block of code.
+
+```ruby
+require 'hollaback'
+chain = Hollaback::Chain.new
+```
+
+Then, specify the callbacks that will be called.
+
+```ruby
+chain.before :say_hello
+chain.before { puts 'How are you?' }
+chain.after :say_goodbye
+chain.around :say
+```
+
+Then, provide a block of code around which the callbacks will be called.
+
+```ruby
+compiled = chain.compile { '- Hollaback' }
+```
+
+Finally, call the compiled sequence of callbacks (with or without an optional context object on which the symbol callbacks should be defined).
 
 ```ruby
 class Callbacker
@@ -42,15 +66,18 @@ class Callbacker
   end
 end
 
-require 'hollaback'
-chain = Hollaback::Chain.new
+compiled.call(Callbacker.new)
+```
 
-chain.before :say_hello
-chain.before { puts 'How are you?' }
-chain.after :say_goodbye
-chain.around :say
+In the above example, the following will output to stdout:
 
-chain.compile { '- Hollaback' }.call(Callbacker.new)
+```
+speaking... 
+Hello!
+How are you?
+Goodbye!
+- Hollaback
+...done.
 ```
 
 ## Development
@@ -61,7 +88,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/localytics/hollaback.
+Bug reports and pull requests are welcome on GitHub at https://github.com/kddnewton/hollaback.
 
 ## License
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 

data/bin/console

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

data/bin/setup

@@ -4,5 +4,3 @@ IFS=$'\n\t'
 set -vx
 
 bundle install
-
-# Do any other automated setup that you need to do here

data/hollaback.gemspec

@@ -1,29 +1,37 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'hollaback/version'
+# frozen_string_literal: true
+
+require_relative 'lib/hollaback/version'
+
+version = Hollaback::VERSION
+repository = 'https://github.com/kddnewton/hollaback'
 
 Gem::Specification.new do |spec|
   spec.name          = 'hollaback'
-  spec.version       = Hollaback::VERSION
-  spec.authors       = ['Localytics']
-  spec.email         = ['oss@localytics.com']
+  spec.version       = version
+  spec.authors       = ['Kevin Newton']
+  spec.email         = ['kddnewton@gmail.com']
 
   spec.summary       = 'Add callbacks to your methods'
-  spec.homepage      = 'https://github.com/localytics/hollaback'
+  spec.homepage      = repository
   spec.license       = 'MIT'
 
-  files              = `git ls-files -z`.split("\x0")
-  spec.files         = files.reject { |f| f.match(%r{^test/}) }
+  spec.metadata      = {
+    'bug_tracker_uri' => "#{repository}/issues",
+    'changelog_uri' => "#{repository}/blob/v#{version}/CHANGELOG.md",
+    'source_code_uri' => repository,
+    'rubygems_mfa_required' => 'true'
+  }
+
+  spec.files         =
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^test/}) }
 
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.12'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'simplecov', '~> 0.11'
-  spec.add_development_dependency 'coveralls', '~> 0.8'
-  spec.add_development_dependency 'rubocop', '~> 0.39'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'minitest', '~> 5.11'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop', '~> 1.12'
+  spec.add_development_dependency 'simplecov', '~> 0.14'
 end

data/lib/hollaback/callback.rb

@@ -1,18 +1,23 @@
+# frozen_string_literal: true
+
 module Hollaback
+  # A callback that can be executed later
   class Callback
     attr_reader :type, :executable
 
     def initialize(type, execute = nil, &block)
       @type       = type
-      @executable = (execute ? execute : block)
+      @executable = (execute || block)
     end
 
     def build
       case executable
       when Symbol
-        -> (target, &block) { target.send(executable, &block) }
+        ->(target, &block) { target.send(executable, &block) }
       when Proc
-        -> (target) { target.instance_eval(&executable) }
+        ->(target) { target.instance_eval(&executable) }
+      else
+        raise ArgumentError, "Invalid callback argument: #{executable.inspect}"
       end
     end
   end

data/lib/hollaback/chain.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module Hollaback
+  # A set of callbacks
   class Chain
     attr_reader :callbacks
 

data/lib/hollaback/sequence.rb

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
 module Hollaback
+  # An object that contains a sequence of callbacks along with a main execution
+  # function
   class Sequence
     attr_reader :befores, :afters, :main
 
@@ -18,18 +22,18 @@ module Hollaback
       self
     end
 
-    # rubocop:disable Performance/RedundantBlockCall
     def around(&around)
       Sequence.new do |target|
         around.call(target) { call(target) }
       end
     end
 
-    def call(target)
+    def call(target = nil)
       befores.each { |before| before.call(target) }
-      value = main.call(target)
-      afters.each { |after| after.call(target) }
-      value
+
+      main.call(target).tap do
+        afters.each { |after| after.call(target) }
+      end
     end
   end
 end

data/lib/hollaback/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Hollaback
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'
 end

data/lib/hollaback.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'hollaback/callback'
 require 'hollaback/chain'
 require 'hollaback/sequence'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hollaback
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
-- Localytics
-autorequire: 
+- Kevin Newton
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-10-11 00:00:00.000000000 Z
+date: 2021-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,95 +16,85 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
-- !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'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.11'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.39'
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.39'
-description: 
+        version: '0.14'
+description:
 email:
-- oss@localytics.com
+- kddnewton@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -116,11 +106,15 @@ files:
 - lib/hollaback/chain.rb
 - lib/hollaback/sequence.rb
 - lib/hollaback/version.rb
-homepage: https://github.com/localytics/hollaback
+homepage: https://github.com/kddnewton/hollaback
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/kddnewton/hollaback/issues
+  changelog_uri: https://github.com/kddnewton/hollaback/blob/v0.1.1/CHANGELOG.md
+  source_code_uri: https://github.com/kddnewton/hollaback
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -135,9 +129,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Add callbacks to your methods
 test_files: []

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm: 2.3.1
-cache: bundler
-script:
-- bundle exec rake
-- bundle exec rubocop