putter 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bb34206f87355ec6413702f263574ba0ea9f45fbf01da9578af7c899d4bbe0d
-  data.tar.gz: 444c407875667ffcc61d8be7908faeb0e67cd2fc21c2b87e0db45171dc1ac0ad
+  metadata.gz: 504b551c265d3896f609a36f0492fe8734b6d19806d79caa22e32b7bca6af033
+  data.tar.gz: 1f00f4a645b5191ab44e1a6e0da551cc8a796777b030ef0872afb4fa7872a094
 SHA512:
-  metadata.gz: d928358ecf0442f8512988f46f7090e7faade53aea9e14c0419ebe2cf830a666d16bfb67a3ff5d789de9d83a7634464fe57a9134a7739c1451849b0fc257ca67
-  data.tar.gz: a2fb566c1bf2b1f99e8f8cb681a97f3968259e6e7e502341ba8dbd32b69ca127eaab24274e502d11e511da4c87270397bddc09cdc9b725c43386f99b8de284ba
+  metadata.gz: 829f154421ed19a1274fd0ca25256f933bf85c408aa152de0a4d0b17d708b969e3f1c4170ad02461425a1a9595a374aa0a67556c9627e346d7e0ed528242af95
+  data.tar.gz: 5713fc62de7b5e666979cf2c0b71d1e16f2d7d9ac17ba26c7004db6858917ea9ecd585c1ea0bd7ec7071e53e2d61bb2d79a068ceedf409e81a8775f2a350ba05

data/CHANGELOG.md

@@ -1,7 +1,11 @@
 # CHANGELOG
+### 0.7.0 - 2022-10-14
+- Change whitelist/blacklist, to allowlist/denylist but maintain backwards
+    compatibility
+
 ### 0.6.1 - 2021-08-02
 - Update required ruby version to at least 2.7
--
+
 ### 0.6.0 - 2021-08-02
 - Update required ruby version to 2.7
 

data/README.md

@@ -1,6 +1,6 @@
 # Putter
 
-### Still Maintained as of February 2020
+### Still Maintained as of October 2022
 
 ## Description
 
@@ -68,7 +68,7 @@ Putter.follow(
   # Will be "ClassName" for classes or "ClassName instance" for instances
   methods: ["my_method"],  # Optional - If array is empty, then all methods will be watched.
   # Otherwise, this is an array of methods to print debugging input for. This will override
-  # any settings in the configuration blacklist
+  # any settings in the configuration denylist
 )
 ```
 
@@ -111,7 +111,7 @@ Putter.watch(
   label: "My class",  # Optional - Label to use after "Putter Debugging:  My class". Will be "ClassName" for classes or "ClassName instance #" for instances
   methods: ["my_method"],  # Optional - If array is empty, then all methods will be watched.
   # Otherwise, this is an array of methods to print debugging input for. This will override
-  # any settings in the configuration blacklist
+  # any settings in the configuration denylist
 )
 ```
 
@@ -137,18 +137,18 @@ Putter.configure do |config|
   # Defaults to [Object] or [Object, ActiveRecord::Based] if defined
   config.ignore_methods_from = [Object, ActiveRecord::Base]
 
-  # "methods_whitelist" takes an array of methods and will always proxy and debug those methods
+  # "methods_allowlist" takes an array of methods and will always proxy and debug those methods
   # regardless of whether or not the class is ignored and regardless of what methods are passed
   # in when running "Putter.follow" or "Putter.watch"
 
   # Defaults to []
-  config.methods_whitelist = [:to_s]
+  config.methods_allowlist = [:to_s]
 
-  # "methods_blacklist" takes an array of methods and will never proxy. If this is combined
-  # with the `methods_whitelist` then it will raise a `MethodConflictError`.
+  # "methods_denylist" takes an array of methods and will never proxy. If this is combined
+  # with the `methods_allowlist` then it will raise a `MethodConflictError`.
 
   # Defaults to []
-  config.methods_blacklist = [:to_s]
+  config.methods_denylist = [:to_s]
 
   # "allow_production" takes a boolean and determines whether or not Putter will run if
   # `Rails.env == "production"`

data/lib/putter/configuration.rb

@@ -1,31 +1,34 @@
 module Putter
   class Configuration
-    attr_accessor :allow_production, :methods_whitelist, :methods_blacklist, :print_strategy
+    attr_accessor :allow_production, :methods_allowlist, :methods_denylist, :print_strategy
     attr_writer :ignore_methods_from
 
+    alias_method :methods_whitelist=, :methods_allowlist=
+    alias_method :methods_blacklist=, :methods_denylist=
+
     def initialize
       @ignore_methods_from = [Object]
       @ignore_methods_from << ActiveRecord::Base if defined?(ActiveRecord::Base)
       @print_strategy = PrintStrategy::Default
       @allow_production = false
-      @methods_whitelist = []
-      @methods_blacklist = []
+      @methods_allowlist = []
+      @methods_denylist = []
     end
 
     def ignore_methods_from
       convert_to_array(@ignore_methods_from)
     end
 
-    def methods_whitelist=(methods)
-      raise ::Putter::MethodConflictError unless (@methods_blacklist & methods).empty?
+    def methods_allowlist=(methods)
+      raise ::Putter::MethodConflictError unless (@methods_denylist & methods).empty?
 
-      @methods_whitelist = methods
+      @methods_allowlist = methods
     end
 
-    def methods_blacklist=(methods)
-      raise ::Putter::MethodConflictError unless (@methods_whitelist & methods).empty?
+    def methods_denylist=(methods)
+      raise ::Putter::MethodConflictError unless (@methods_allowlist & methods).empty?
 
-      @methods_blacklist = methods
+      @methods_denylist = methods
     end
 
     private

data/lib/putter/errors.rb

@@ -6,7 +6,7 @@ module Errors
   end
 
   class MethodConflictError < StandardError
-    def initialize(msg="Methods cannot be white and blacklisted")
+    def initialize(msg="Methods cannot be allow and denylisted")
       super
     end
   end

data/lib/putter/follower_data.rb

@@ -11,8 +11,8 @@ module Putter
     def add_method?(method)
       return false if @proxy.instance_methods.include?(method)
       return true if @proxied_methods.include?(method)
-      return true if is_whitelisted_method?(method)
-      return false if is_blacklisted_method?(method)
+      return true if is_allowed_method?(method)
+      return false if is_denied_method?(method)
       return false if is_ignored_method?(method)
       return true if @proxied_methods.empty?
     end
@@ -29,12 +29,12 @@ module Putter
       end
     end
 
-    def is_whitelisted_method?(method)
-      ::Putter.configuration.methods_whitelist.map(&:to_sym).include?(method.to_sym)
+    def is_allowed_method?(method)
+      ::Putter.configuration.methods_allowlist.map(&:to_sym).include?(method.to_sym)
     end
 
-    def is_blacklisted_method?(method)
-      ::Putter.configuration.methods_blacklist.map(&:to_sym).include?(method.to_sym)
+    def is_denied_method?(method)
+      ::Putter.configuration.methods_denylist.map(&:to_sym).include?(method.to_sym)
     end
 
     def is_ignored_method?(method)

data/lib/putter/version.rb

@@ -1,3 +1,3 @@
 module Putter
-  VERSION = "0.6.1"
+  VERSION = "0.7.0"
 end

data/lib/putter/watcher_data.rb

@@ -26,15 +26,15 @@ module Putter
     end
 
     def methods_to_proxy(singleton_klass)
-      ignored_methods = Putter.configuration.methods_blacklist.map(&:to_sym)
+      ignored_methods = Putter.configuration.methods_denylist.map(&:to_sym)
 
       Putter.configuration.ignore_methods_from.each do |klass|
         ignored_methods += klass.methods
       end
 
-      whitelist = Putter.configuration.methods_whitelist.map(&:to_sym) + [:new]
+      allowlist = Putter.configuration.methods_allowlist.map(&:to_sym) + [:new]
 
-      singleton_klass.instance_methods - ignored_methods + whitelist
+      singleton_klass.instance_methods - ignored_methods + allowlist
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: putter
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - John DeWyze
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-02 00:00:00.000000000 Z
+date: 2022-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -137,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Putter makes puts debugging easy.