proxified 0.1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd5b3ded355bfb619efec1c6a3314498662945cd1ca2e36d2b38ae71823a0bb6
-  data.tar.gz: e16834d5a79ab0cd7d5b38b40ed7e7f7af2203c37b84c569e90f33a57ebd6c18
+  metadata.gz: db679149f605d627c1f13b11feb5911db64c080446fdfb79e026f17f54026610
+  data.tar.gz: 0d49c35b8b93dc08174945e2d3c725fc112ed16b776f7c068937f35fc5bceb68
 SHA512:
-  metadata.gz: 56ba529f8c836164dd010395d7311511bcce0123dd482574585e3327bc66060f1a512984379397f148f73cbcc0d66efae98d3ff1cf54133eb0d269ef1c93ec41
-  data.tar.gz: c7553667d0ff27a830d315a33c44d7a5b257451a7d53201e0dadb13507a419cc4e0e331e1667977503b3032ba0391e614b92f97b63f66d877c605f6798640324
+  metadata.gz: 259fb1d8f0107a193f453e0b8cdd73fc93d37fcd96c604655ff64f89988aa5e39bc05466caa9c7635e8cbf62ff4cf18a1aaa97c37aea0c62862c46202b8f5bb3
+  data.tar.gz: 2a98c2d904564d26e90c69abd96ac303a89a6e5b60cb37869a38906e1b6f0d0773ddc364f2a4d7af84d0e3a09c35452c173c20f878db9456e2822a9b35f4b113

data/.dockerignore

@@ -2,6 +2,7 @@
 docker-compose.yml
 Dockerfile
 .env
+.env.remote_dev
 
 log
 tmp

data/.env.remote_dev

@@ -0,0 +1,5 @@
+# environment variables for docker-compose
+COMPOSE_PROJECT_NAME=gem-proxified
+APP_NAME=gem-proxified
+BUNDLE_PATH=/home/gem-proxified/bundle
+REPO_PATH=/home/gem-proxified/repo

data/.rubocop.yml

@@ -1,5 +1,13 @@
+AllCops:
+
+  TargetRubyVersion: '3.3'
 Metrics/BlockLength:
   Exclude:
+    - lib/proxified.rb
     - spec/**/*
     - Guardfile
     - proxified.gemspec
+
+Naming/MethodName:
+  Exclude:
+    - lib/proxified.rb

data/.travis.yml

@@ -3,5 +3,5 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.6.0
-before_install: gem install bundler -v 1.17.2
+  - 3.3.0
+before_install: gem install bundler -v 2.5.3

data/Dockerfile

@@ -1,7 +1,27 @@
-# Build args for base image
-ARG bundle_path
-# Base image with the tools to build a ruby gem
-FROM awruby:gems
+# Base Ruby image
+FROM ruby:3.3.0-slim
+
+# Install the (minimum) required packages
+RUN apt-get update -qq && apt-get install -y --fix-missing --no-install-recommends \
+      # Required packages for building gems etc
+      build-essential \
+      git \
+    # Clean apt cache
+    && rm -rf /var/lib/apt/lists/*
+
+# Base args
+ARG home=/home
+ARG bundle_path=/usr/local/bundle
+
+# Set base environment variables
+ENV HOME=$home \
+    BUNDLE_PATH=$bundle_path \
+    BUNDLE_APP_CONFIG=$bundle_path \
+    GEM_HOME=$bundle_path \
+    PATH=$PATH:$bundle_path/bin:$bundle_path/gems/bin
+
+# Create base directories if do not exist
+RUN mkdir -p $HOME $BUNDLE_PATH
 
 # App user and dirs args
 ARG app_name

data/Gemfile.lock

@@ -1,30 +1,30 @@
 PATH
   remote: .
   specs:
-    proxified (0.1.0)
-      activesupport (~> 5.2, >= 5.2.2)
+    proxified (1.0.1)
+      activesupport (~> 5.2.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.2)
+    activesupport (5.2.8.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    ast (2.4.0)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.4)
-    diff-lcs (1.3)
-    ffi (1.10.0)
-    formatador (0.2.5)
-    guard (2.15.0)
+    ast (2.4.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.3.4)
+    diff-lcs (1.5.1)
+    ffi (1.17.0-x86_64-linux-gnu)
+    formatador (1.1.0)
+    guard (2.18.1)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
       nenv (~> 0.1)
       notiffany (~> 0.0)
-      pry (>= 0.9.12)
+      pry (>= 0.13.0)
       shellany (~> 0.0)
       thor (>= 0.18.1)
     guard-bundler (2.2.1)
@@ -36,77 +36,82 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    guard-rubocop (1.3.0)
+    guard-rubocop (1.5.0)
       guard (~> 2.0)
-      rubocop (~> 0.20)
-    i18n (1.5.3)
+      rubocop (< 2.0)
+    i18n (1.14.6)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.2)
-    listen (3.1.5)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-      ruby_dep (~> 1.2)
-    lumberjack (1.0.13)
-    method_source (0.9.2)
-    minitest (5.11.3)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    listen (3.9.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.10)
+    method_source (1.1.0)
+    minitest (5.25.1)
     nenv (0.3.0)
-    notiffany (0.1.1)
+    notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parallel (1.13.0)
-    parser (2.6.0.0)
-      ast (~> 2.4.0)
-    powerpack (0.1.2)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rainbow (3.0.0)
-    rake (10.5.0)
-    rb-fsevent (0.10.3)
-    rb-inotify (0.10.0)
+    parallel (1.26.3)
+    parser (3.3.5.0)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (12.3.3)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
       ffi (~> 1.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    regexp_parser (2.9.2)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.1)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.63.1)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.66.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.4.0)
-    ruby-progressbar (1.10.0)
-    ruby_dep (1.5.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.32.3)
+      parser (>= 3.3.1.0)
+    ruby-progressbar (1.13.0)
     shellany (0.0.1)
-    thor (0.20.3)
+    thor (1.3.2)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.11)
       thread_safe (~> 0.1)
-    unicode-display_width (1.4.1)
+    unicode-display_width (2.6.0)
 
 PLATFORMS
-  ruby
+  x86_64-linux-gnu
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler (~> 2.5)
   guard (~> 2.15)
   guard-bundler (~> 2.2, >= 2.2.1)
   guard-rspec (~> 4.7, >= 4.7.3)
   guard-rubocop (~> 1.3)
   proxified!
-  rake (~> 10.0)
+  rake (~> 12.3.3)
   rspec (~> 3.8)
 
 BUNDLED WITH
-   1.17.2
+   2.5.3

data/Guardfile

@@ -17,7 +17,7 @@
 #
 # and, you'll have to watch "config/Guardfile" instead of "Guardfile"
 
-# Note: The cmd option is now required due to the increasing number of ways
+# NOTE: The cmd option is now required due to the increasing number of ways
 #       rspec may be run, below are examples of the most common uses.
 #  * bundler: 'bundle exec rspec'
 #  * bundler binstubs: 'bin/rspec'
@@ -48,6 +48,8 @@ group :red_green_refactor, halt_on_fail: true do
     # Ruby files
     ruby = dsl.ruby
     dsl.watch_spec_files_for(ruby.lib_files)
+
+    watch(ruby.lib_files) { "#{rspec.spec_dir}/global_methods_spec.rb" }
   end
 
   guard :rubocop, all_on_start: true, cli: ['-a'] do

data/README.md

@@ -1,8 +1,10 @@
+[![Gem Version](https://badge.fury.io/rb/proxified.svg)](https://badge.fury.io/rb/proxified)
+
 # Proxified
 
-Proxify any object with a few lines of code.
+A simple way to put a proxy in front of any object, at any time.
 
-A simple way to add (and remove) a proxy to any object's instance methods and to inherit and change the behaviour down the class hierarchy.
+You can add and remove a proxy to and from any object instance methods and inherit or change the behavior down the class hierarchy.
 
 ## Installation
 
@@ -22,114 +24,156 @@ Or install it yourself as:
 
 ## Usage
 
-Just `include Proxified` in your class and call `proxify` with the method(s) you want to proxify and the code you want to run.
+You have two options to *proxify* and *unproxify* objects:
+
+  * *statically*: if you want to put a proxy on a class while defining it, just `include Proxified` and call `proxify` with the method(s) you want to *proxify* and the code you want to run.
+     When you want to remove a proxy, just call `unproxify` with the method(s) you want to *unproxify*, or without methods if you want to *unproxify* all *proxified* methods.
+     To check if a given method is *proxified*, call `proxified?` with the method name, or without arguments to check if any instance method is *proxified*.
 
-If you want to remove a proxy, just call `unproxify` with the method(s) you want to unproxify.
+  * *dynamically*: if you want to put a proxy on a class at runtime, or on a single object without affecting its class, call `Proxify` with the class/object and the method(s) you want to *proxify*.
+     Similarly, use `Unproxify` and `Proxified?` with the class/object and the method(s) you want to *unproxify*/*check*.
 
-In order to not change the class interface, a method is only `proxified` when the corresponding instance method is defined (before or after the proxy definition).
-Similarly, a `proxified method` is removed whenever the corresponding instance method is removed from the class.
+You can also mix the two approaches! (see the examples below)
 
-Moreover, the `proxified methods` take the arguments specified by the `block`, so it should take the same arguments as the original `methods`.
-Finally, it's possible to call the actual `methods` invoking `super` inside the `block`.
+In order not to change the class interface, a method is only *proxified* when the corresponding instance method is defined (before or after the proxy definition).
+Similarly, a *proxified method* is removed whenever the corresponding instance method is removed from the class.
+
+Moreover, the *proxified methods* take the arguments specified by the block, so it should take the same arguments as the original methods.
+Finally, it's possible to call the actual methods invoking `super` inside the block.
 
 ```ruby
 
 require 'proxified'
 
-# Basic usage:
+# Static proxy:
+
 class A
   include Proxified
 
-  proxify :welcome, :goodbye do |name|
-    check(name)
-    super(name)
+  proxify :foo, :bar, :biz do
+    "proxified #{super()}"
   end
 
-  def check(name)
-    puts "checking #{name}"
-  end
+  def foo; 'foo'; end
 
-  def welcome(name)
-    puts "hello #{name}!"
-  end
+  def bar; 'bar'; end
 
-  def goodbye(name)
-    puts "goodbye #{name}!"
-  end
+  def biz; 'biz'; end
+
+  def baz; 'baz'; end
 end
 
-a = A.new
-a.welcome('jack') => 'checking jack'; 'welcome jack!';
-a.goodbye('jack') => 'checking jack'; 'goodbye jack!';
-a.welcome         => raises ArgumentError
-a.check('jack')   => 'checking jack' # not proxified
+A.ancestors # => [A::Proxy, A, Proxified, ...]
 
-# Unproxifing a proxified method:
-class B < A
-  unproxify :welcome
-end
+a1, a2 = A.new, A.new
 
-b = B.new
-b.welcome('jack') => 'welcome jack!';
-b.goodbye('jack') => 'checking jack'; 'goodbye jack!';
+a1.foo # => 'proxified foo'
+a2.foo # => 'proxified foo'
+a1.bar # => 'proxified bar'
+a2.bar # => 'proxified bar'
+a1.biz # => 'proxified biz'
+a2.biz # => 'proxified biz'
+a1.baz # => 'baz'
+a2.baz # => 'baz'
 
 
-# Redefining a proxified method:
-class C < A
-  def welcome(name)
-    puts "welcome #{name.upcase}!"
-  end
-end
+# unproxify the :foo method
+A.unproxify(:foo)  # => [:foo]
 
-c = C.new
-c.welcome('jack') => 'checking jack'; 'welcome JACK!';
-c.goodbye('jack') => 'checking jack'; 'goodbye jack!';
+# the :foo method is not proxified anymore
+A.proxified?(:foo) # => false
+# A is still proxified, i.e. it has at least one proxified method
+A.proxified?       # => true
 
+a1.foo # => 'foo'
+a2.foo # => 'foo'
+a1.bar # => 'proxified bar'
+a2.bar # => 'proxified bar'
+a1.biz # => 'proxified biz'
+a2.biz # => 'proxified biz'
+a1.baz # => 'baz'
+a2.baz # => 'baz'
 
-# Reproxifing a proxified method:
-class D < A
-  proxify :welcome do |name|
-    super(name.upcase)
-  end
-end
 
-d = D.new
-d.welcome('jack') => 'checking JACK'; 'welcome JACK!';
-d.goodbye('jack') => 'checking jack'; 'goodbye jack!';
+# unproxify all the methods
+A.unproxify  # => [:bar, :biz]
 
+# A is not proxified anymore
+A.proxified? # => false
 
-# Reproxifing and redefining a proxified method:
-class E < A
-  proxify :welcome do |name|
-    super(name.upcase)
-  end
+a1.foo # => 'foo'
+a2.foo # => 'foo'
+a1.bar # => 'bar'
+a2.bar # => 'bar'
+a1.biz # => 'biz'
+a2.biz # => 'biz'
+a1.baz # => 'baz'
+a2.baz # => 'baz'
 
-  def welcome(name)
-    puts "hello #{name}!"
-  end
-end
 
-e = E.new
-e.welcome('jack') => 'hello JACK!';
-e.goodbye('jack') => 'checking jack'; 'goodbye jack!';
+# Dynamic proxy:
 
+# on a class
+Proxify(A, :foo, :bar) { 'proxified again' } # => [:foo, :bar]
 
-# Redefining a proxified method to call super:
-class F < A
-  def welcome(name)
-    # Will call F's proxy, then A's proxy and finally A's method
-    super(name)
-    puts 'hi'
-  end
-end
+a1.foo # => 'proxified again'
+a2.foo # => 'proxified again'
+a1.bar # => 'proxified again'
+a2.bar # => 'proxified again'
+a1.biz # => 'biz'
+a2.biz # => 'biz'
+a1.baz # => 'baz'
+a2.baz # => 'baz'
+
+
+# on a single object
+Proxify(a1, :bar, :biz) { 'singleton proxy' } # => [:bar, :biz]
+
+a1.foo # => 'proxified again'
+a2.foo # => 'proxified again'
+a1.bar # => 'singleton proxy'
+a2.bar # => 'proxified again'
+a1.biz # => 'singleton proxy'
+a2.biz # => 'biz'
+a1.baz # => 'baz'
+a2.baz # => 'baz'
+
+
+# unproxify all the methods of a1
+Unproxify(a1)  # => [:foo, :bar, :biz]
+
+# still proxified because of the class' proxy
+Proxified?(a1) # => true
+
+a1.foo # => 'proxified again'
+a2.foo # => 'proxified again'
+a1.bar # => 'proxified again'
+a2.bar # => 'proxified again'
+a1.biz # => 'biz'
+a2.biz # => 'biz'
+a1.baz # => 'baz'
+a2.baz # => 'baz'
+
+
+# unproxify all the methods of A
+Unproxify(A, :foo, :bar)  # => [:foo, :bar]
+
+a1.foo # => 'foo'
+a2.foo # => 'foo'
+a1.bar # => 'bar'
+a2.bar # => 'bar'
+a1.biz # => 'biz'
+a2.biz # => 'biz'
+a1.baz # => 'baz'
+a2.baz # => 'baz'
 
-f = F.new
-f.welcome('jack') => 'checking jack'; 'checking jack'; 'welcome jack!'; 'hi';
-f.goodbye('jack') => 'checking jack'; 'goodbye jack!';
 ```
+
+Just look at the code documentation to see more examples of what you can/cannot do.
+
 ## Notes
 
-This is my first gem, something I extracted from a bigger project and a first attempt to give back something to the community.
+This is my first gem, something I extracted from a bigger project and a first attempt to give something back to the community.
 
 Any constructive feedback is welcome and appreciated, thank you!
 

data/bin/compose_up

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+# shortcut with necessary args in remote dev envs (e.g. env-file)
+docker compose -f "docker-compose.yml" --env-file ".env.remote_dev" up -d --build

data/bin/console

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

data/docker-compose.yml

@@ -1,5 +1,3 @@
-version: "3.7"
-
 services:
   app:
     build:
@@ -12,7 +10,7 @@ services:
       - bundle:$BUNDLE_PATH
     tty: true
   guard:
-    image: "${APP_NAME}_app:latest"
+    image: "${APP_NAME}-app:latest"
     volumes:
       - .:$REPO_PATH
       - bundle:$BUNDLE_PATH

data/lib/proxified/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Proxified
-  VERSION = '0.1.0'.freeze
+  VERSION = '1.0.1'
 end