before_hooks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 35dae4a64cc957dd77b40476a38990940c0a6006ffad173aebae8e8709ebe733
+  data.tar.gz: 1b469cc134e5e982a412fbe31a0698d59031d1ca34aba8074fe5c0aaa96db921
+SHA512:
+  metadata.gz: 12deb1488fc1306020450895e135db69e97a5e6626d42e00591f4c111eecb3f72a2dd2713a2d17fce8c04b6256b16a2b7815dcf9067f7315abd41a61970affb3
+  data.tar.gz: cea4f1b1094db8d5803ddc8a2921cba19e83c44478255298001c49372e8320506b9f4e22ab313bc543b64c78d6b47fabb5b10f68eea82efa8d62e0ff973da4b3

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.byebug_history
+
+*.gem
+
+Gemfile.lock
+gemfiles/*.lock

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,11 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.0.0
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
+  - 2.5.1
+before_install: gem install bundler -v 1.16.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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 jrpolidario@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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in before_hooks.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Jules Roman B. Polidario
+
+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,192 @@
+# BeforeHooks
+
+[![Build Status](https://travis-ci.org/jrpolidario/before_hooks.svg?branch=master)](https://travis-ci.org/jrpolidario/before_hooks)
+
+Adds `before_extended`, `before_included`, and `before_prepended` methods hooks which would be called before the standard `extended`, `included`, and `prepended` Ruby hooks, respectively.
+
+Especially useful when you require to "do" something just before the module gets `extended`, `included`, or `prepended` to a module/class.
+In particular, in my specific case, I needed to "do" something first if a specific method already exists in the `base` class before being extended, of which then I'd use `before_extended`.
+
+## Dependencies
+
+* **Ruby ~> 2.0**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'before_hooks', '~> 0.1'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install before_hooks
+
+## Usage
+
+### `before_included` Example
+
+```ruby
+require 'bundler/setup'
+require 'before_hooks'
+
+module SomeModule
+  # not required to be defined
+  def self.before_included(base)
+    pp 'SomeModule#before_included'
+    pp base
+    pp base.ancestors
+  end
+
+  # not required to be defined:
+  def self.included(base)
+    pp 'SomeModule#included'
+    pp base
+    pp base.ancestors
+  end
+end
+
+class SomeClass
+  include SomeModule
+end
+
+# upon code execution, will print...
+
+=begin
+
+SomeModule#before_included
+SomeClass
+[SomeClass, BeforeHooks, Object, PP::ObjectMixin, Kernel, BasicObject]
+SomeModule#included
+SomeClass
+[SomeClass, SomeModule, BeforeHooks, Object, PP::ObjectMixin, Kernel, BasicObject]
+
+=end
+```
+
+### `before_extended` Example
+
+```ruby
+require 'bundler/setup'
+require 'before_hooks'
+
+module SomeModule
+  # not required to be defined
+  def self.before_extended(base)
+    pp 'SomeModule#before_extended'
+    pp base
+    pp base.singleton_class.ancestors
+  end
+
+  # not required to be defined:
+  def self.extended(base)
+    pp 'SomeModule#extended'
+    pp base
+    pp base.singleton_class.ancestors
+  end
+end
+
+class SomeClass
+  extend SomeModule
+end
+
+# upon code execution, will print...
+
+=begin
+
+SomeModule#before_extended
+SomeClass
+[#<Class:SomeClass>,
+ BeforeHooks::ClassMethods,
+ #<Class:Object>,
+ #<Class:BasicObject>,
+ Class,
+ Module,
+ BeforeHooks,
+ Object,
+ PP::ObjectMixin,
+ Kernel,
+ BasicObject]
+SomeModule#extended
+SomeClass
+[#<Class:SomeClass>,
+ SomeModule,
+ BeforeHooks::ClassMethods,
+ #<Class:Object>,
+ #<Class:BasicObject>,
+ Class,
+ Module,
+ BeforeHooks,
+ Object,
+ PP::ObjectMixin,
+ Kernel,
+ BasicObject]
+
+=end
+```
+
+### `before_prepended` Example
+
+```ruby
+require 'bundler/setup'
+require 'before_hooks'
+
+module SomeModule
+  # not required to be defined
+  def self.before_prepended(base)
+    pp 'SomeModule#before_prepended'
+    pp base
+    pp base.ancestors
+  end
+
+  # not required to be defined:
+  def self.prepended(base)
+    pp 'SomeModule#prepended'
+    pp base
+    pp base.ancestors
+  end
+end
+
+class SomeClass
+  prepend SomeModule
+end
+
+# upon code execution, will print...
+
+=begin
+
+SomeModule#before_prepended
+SomeClass
+[SomeClass, BeforeHooks, Object, PP::ObjectMixin, Kernel, BasicObject]
+SomeModule#prepended
+SomeClass
+[SomeModule, SomeClass, BeforeHooks, Object, PP::ObjectMixin, Kernel, BasicObject]
+
+=end
+```
+
+## TODOs
+* Need help or further research on how to support `before_inherited` as a "before" hook to `inherited` standard ruby method.
+
+## 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/jrpolidario/before_hooks. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the BeforeHooks project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jrpolidario/before_hooks/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/before_hooks.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'before_hooks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'before_hooks'
+  spec.version       = BeforeHooks::VERSION
+  spec.authors       = ['Jules Roman Polidario']
+  spec.email         = ['jrpolidario@gmail.com']
+
+  spec.summary       = 'Adds `before_extended`, `before_included`, and `before_prepended` methods hooks which would be called before the standard `extended`, `included`, and `prepended` Ruby hooks, respectively.'
+  spec.description   = 'Especially useful when you require to "do" something just before the module gets `extended` or `included` to a module/class. In particular, in my specific case, I needed to "do" something if a specific method already exists in the `base` class.'
+  spec.homepage      = 'https://github.com/jrpolidario/before_hooks'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.required_ruby_version = '~> 2.0'
+
+  spec.add_development_dependency 'byebug', '~> 9.0'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rspec', '~> 3.7.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "before_hooks"
+
+# 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/before_hooks.rb

@@ -0,0 +1,42 @@
+require 'before_hooks/version'
+
+module BeforeHooks
+  # `base` is expected to be and should be an `Object`
+  def self.prepended(base)
+    base.singleton_class.send(:prepend, ClassMethods)
+  end
+
+  module ClassMethods
+    def extend(*modules)
+      modules.each do |_module|
+        if _module.singleton_class.instance_methods.include? :before_extended
+          _module.before_extended(self)
+        end
+      end
+
+      super
+    end
+
+    def include(*modules)
+      modules.each do |_module|
+        if _module.singleton_class.instance_methods.include? :before_included
+          _module.before_included(self)
+        end
+      end
+
+      super
+    end
+
+    def prepend(*modules)
+      modules.each do |_module|
+        if _module.singleton_class.instance_methods.include? :before_prepended
+          _module.before_prepended(self)
+        end
+      end
+
+      super
+    end
+  end
+end
+
+Object.send(:prepend, BeforeHooks)

data/lib/before_hooks/version.rb

@@ -0,0 +1,3 @@
+module BeforeHooks
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: before_hooks
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jules Roman Polidario
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.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'
+description: Especially useful when you require to "do" something just before the
+  module gets `extended` or `included` to a module/class. In particular, in my specific
+  case, I needed to "do" something if a specific method already exists in the `base`
+  class.
+email:
+- jrpolidario@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- before_hooks.gemspec
+- bin/console
+- bin/setup
+- lib/before_hooks.rb
+- lib/before_hooks/version.rb
+homepage: https://github.com/jrpolidario/before_hooks
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Adds `before_extended`, `before_included`, and `before_prepended` methods
+  hooks which would be called before the standard `extended`, `included`, and `prepended`
+  Ruby hooks, respectively.
+test_files: []