putter 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16b81ce160fb22785ce8b1bdce7822783ba85eec
-  data.tar.gz: 7bc3095434de6035e590c28a37c8d435216a5e20
+  metadata.gz: 72890e1762d7aad4835c7be72838d2409ecfd101
+  data.tar.gz: 0e24d52624633980ca47e6f1a2830e037d016a99
 SHA512:
-  metadata.gz: 8334e5bea55fae12d4e65fd35d1077069c32895f71fe26c06673b9f006a36e6693de536753d0b13f8158e89a5a4a76d3ec8c486d055389b29ac5c778fb5b373c
-  data.tar.gz: 30885b70b4ae1d78a1b74a2eaae951c91175e1879abd95e4721ed2c5dffdecc51c83f7b187108c2273ed538ea18f9a2abd728593e6e2f21bbccaa1630d4f184a
+  metadata.gz: a575a07d97f70930a795fdfea66d6c14d4ee27a41eee406206fdde067e71f847576e04065702f2ef4611cc6d52b019c4cf32fccaf2fe18628346895de8c44be0
+  data.tar.gz: bf1e697ce25b56fd736742b3a15303547249e355c804326a04951c3f36331505b066bbdda01a0097fd01ef248687a16a48ed73c24f272c9def9d2da78a57d865

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
-### 0.4.0 - 2016-08-16
+### 0.4.1 - 2016-10-16
+- By default, Putter will not run in production mode in Rails, this can be allow via configuration
+- By default, Putter will ignore methods from ActiveRecord::Base if it is present
+- Do not re-define a method if it is whitelisted
+- Code cleanup and README updates
+
+### 0.4.0 - 2016-08-18
 - Add methods option to `Putter.watch`
 - Refactor watch method to use registry
 - Refactor method creation specs

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    putter (0.4.0)
+    putter (0.4.1)
       colorize (~> 0)
 
 GEM
@@ -42,4 +42,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.12.4
+   1.13.5

data/README.md

@@ -9,7 +9,7 @@ Putter is a tool for more easily implementing puts debugging. Instead of litteri
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'putter'
+gem "putter"
 ```
 
 And then execute:
@@ -112,7 +112,7 @@ Putter currently has 3 configuration options:
 
 ```ruby
 Putter.configure do |config|
-  # 'print_strategy' takes a block that receives a data object with the label, line,
+  # "print_strategy" takes a block that receives a data object with the label, line,
   # method, args string, and result respectively. This block will be used after each method
   # is called, it must contain puts or logger calls, to print or any other method callbacks
   # that are helpful.
@@ -121,24 +121,24 @@ Putter.configure do |config|
     puts "#{data.line} - Label: #{data.label}, Method: #{data.method}, Args: #{data.args}, Result: #{data.result}"
   end
 
-  # 'ignore_methods_from' takes an array of class names and will ignore both class and instance methods
+  # "ignore_methods_from" takes an array of class names and will ignore both class and instance methods
   # from those classes when adding methods to the proxy and adding debug output
-  # Defaults to [Object]
+  # 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_whitelist" 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'
+  # in when running "Putter.follow" or "Putter.watch"
+  # Defaults to []
   config.methods_whitelist = [:to_s]
+
+  # "allow_production" takes a boolean and determines whether or not Putter will run if
+  # `Rails.env == "production"`
+  # Defaults to false
+  config.allow_production = false
 end
 ```
 
-## Planned Features
-Feel free to open a PR to implement any of these if they are not yet added:
-
-- Active Record specific printing
-- Checking Rails.env to double check that putter is not called in production
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/dewyze/putter. 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.

data/lib/putter/configuration.rb

@@ -1,11 +1,13 @@
 module Putter
   class Configuration
-    attr_accessor :print_strategy
+    attr_accessor :print_strategy, :allow_production
     attr_writer :ignore_methods_from, :methods_whitelist
 
     def initialize
       @ignore_methods_from = [Object]
+      @ignore_methods_from << ActiveRecord::Base if defined?(ActiveRecord::Base)
       @print_strategy = PrintStrategy::Default
+      @allow_production = false
       @methods_whitelist = []
     end
 

data/lib/putter/follower.rb

@@ -2,7 +2,7 @@ module Putter
   class Follower < BasicObject
     include MethodCreator
 
-    attr_reader :object, :proxied_methods, :proxy
+    attr_reader :object, :proxy
 
     def initialize(obj, options={})
       @object = obj
@@ -12,11 +12,11 @@ module Putter
       rescue ::NoMethodError
         ::Kernel.raise ::Putter::BasicObjectError
       end
-      _set_options(options)
+      @data = FollowerData.new(@object, @proxy, options)
     end
 
     def method_missing(method, *args, &blk)
-      if _add_method?(method)
+      if @data.add_method?(method)
         add_method(method)
       end
 
@@ -28,52 +28,9 @@ module Putter
     end
 
     def add_method(method)
-      data = ProxyMethodData.new({ label: @label, method: method})
+      proxy_method_data = ProxyMethodData.new(label: @data.label, method: method)
 
-      add_putter_instance_method_to_proxy(@proxy, data)
-    end
-
-    def _add_method?(method)
-      return true if _is_whitelisted_method?(method)
-      return false if _is_ignored_method?(method)
-      return false if @proxy.instance_methods.include?(method)
-      return @proxy_all_methods || proxied_methods.include?(method.to_s)
-    end
-
-    def _is_ignored_method?(method)
-      ::Putter.configuration.ignore_methods_from.each do |klass|
-        return true if klass.methods.include?(method.to_sym)
-        return true if klass.instance_methods.include?(method.to_sym)
-      end
-      return false
-    end
-
-    def _is_whitelisted_method?(method)
-      ::Putter.configuration.methods_whitelist.map(&:to_sym).include?(method.to_sym)
-    end
-
-    def _set_label(label)
-      if !label.nil?
-        @label = label
-      elsif @object.class == ::Class
-        @label = @object.name
-      else
-        @label = @object.class.name + " instance"
-      end
-    end
-
-    def _set_methods(methods)
-      if methods.nil?
-        @proxy_all_methods = true
-      else
-        @proxied_methods = methods.map(&:to_s)
-        @proxy_all_methods = false
-      end
-    end
-
-    def _set_options(options)
-      _set_label(options[:label])
-      _set_methods(options[:methods])
+      add_putter_instance_method_to_proxy(@proxy, proxy_method_data)
     end
   end
 end

data/lib/putter/follower_data.rb

@@ -0,0 +1,41 @@
+module Putter
+  class FollowerData
+    attr_accessor :label
+
+    def initialize(object, proxy, options)
+      @proxy = proxy
+      @proxied_methods = options[:methods] || []
+      _set_label(options[:label], object)
+    end
+
+    def add_method?(method)
+      return false if @proxy.instance_methods.include?(method)
+      return true if _is_whitelisted_method?(method)
+      return false if _is_ignored_method?(method)
+      return true if @proxied_methods.empty?
+      return true if @proxied_methods.include?(method)
+    end
+
+    def _set_label(label, object)
+      if !label.nil?
+        @label = label
+      elsif object.class == Class
+        @label = object.name
+      else
+        @label = object.class.name + " instance"
+      end
+    end
+
+    def _is_whitelisted_method?(method)
+      ::Putter.configuration.methods_whitelist.map(&:to_sym).include?(method.to_sym)
+    end
+
+    def _is_ignored_method?(method)
+      ::Putter.configuration.ignore_methods_from.each do |klass|
+        return true if klass.methods.include?(method.to_sym)
+        return true if klass.instance_methods.include?(method.to_sym)
+      end
+      return false
+    end
+  end
+end

data/lib/putter/version.rb

@@ -1,3 +1,3 @@
 module Putter
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/lib/putter/watcher.rb

@@ -30,7 +30,7 @@ module Putter
       proxy = MethodProxy.new
 
       Putter::Watcher.methods_for(klass).each do |method|
-        data = ProxyMethodData.new({ label: Putter::Watcher.label_for(klass), method: method })
+        data = ProxyMethodData.new(label: Putter::Watcher.label_for(klass), method: method)
         add_putter_class_method_to_proxy(proxy, data)
       end
 

data/lib/putter/watcher_data.rb

@@ -3,25 +3,25 @@ module Putter
     attr_accessor :label, :proxy_methods
 
     def initialize(options, klass)
-      _set_label(options[:label], klass)
-      _set_methods(options[:methods], klass)
+      @label = _set_label(options[:label], klass)
+      @proxy_methods = _set_methods(options[:methods], klass.singleton_class)
     end
 
     def _set_label(label, klass)
       if !label.nil? && label != ""
-        @label = label
+        label
       else
-        @label = klass.name
+        klass.name
       end
     end
 
-    def _set_methods(methods, klass)
+    def _set_methods(methods, singleton_klass)
       if methods.nil?
-        @proxy_methods = _methods_to_proxy(klass.singleton_class)
+        _methods_to_proxy(singleton_klass)
       elsif !methods.is_a?(Array)
-        @proxy_methods = [methods]
+        [methods]
       else
-        @proxy_methods = methods
+        methods
       end
     end
 

data/lib/putter.rb

@@ -1,5 +1,6 @@
 require "putter/configuration"
 require "putter/errors"
+require "putter/follower_data"
 require "putter/instance_follower"
 require "putter/method_creator"
 require "putter/method_proxy"
@@ -16,25 +17,37 @@ module Putter
 
   class << self
     attr_writer :configuration
-  end
-
-  def self.follow(obj, options={})
-    Putter::Follower.new(obj, options)
-  end
-
-  def self.watch(obj, options={})
-    Putter::Watcher.watch(obj, options)
-  end
-
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
-
-  def self.configure
-    yield configuration
-  end
 
-  def self.reset_configuration
-    @configuration = Configuration.new
+    def follow(obj, options={})
+      with_production_check do
+        Putter::Follower.new(obj, options)
+      end
+    end
+
+    def watch(obj, options={})
+      with_production_check do
+        Putter::Watcher.watch(obj, options)
+      end
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+
+    def reset_configuration
+      @configuration = Configuration.new
+    end
+
+    def with_production_check
+      if !configuration.allow_production && defined?(Rails) && Rails.env == "production"
+        puts "Putter cannot be run in production unless the 'allow_production' option is configured to true".colorize(:red)
+      else
+        yield
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: putter
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - John DeWyze
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-19 00:00:00.000000000 Z
+date: 2016-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -109,6 +109,7 @@ files:
 - lib/putter/configuration.rb
 - lib/putter/errors.rb
 - lib/putter/follower.rb
+- lib/putter/follower_data.rb
 - lib/putter/instance_follower.rb
 - lib/putter/method_creator.rb
 - lib/putter/method_proxy.rb