pry-state 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0140187e1248cf48aac29d8488f98ffaf47f7751
-  data.tar.gz: 710d9174d37fc3c03ed4fe52f406c3d11ea71d1f
+  metadata.gz: 520ba178a70a9cab1929c9368b5ce0664b49fc2f
+  data.tar.gz: ae440f7fbf8ef7d606d9dff0b165efa0098bd1df
 SHA512:
-  metadata.gz: 89da620165a3624c63dd2348ca87f732ef1c3a6a220688b688ab10b2909cede436a10e6f03de981de929400641e3f8647ab85facf1bf4536e5ebed59e7116366
-  data.tar.gz: f59041400c929d9a8b0430c17c23d90c814145b3fae043871711eaa646be4f0bc3f950fe4c08383722a3ce73a7b1c42cf777d2361fc621e26ace63683eaf8703
+  metadata.gz: 48f95903fd105d8fa9fb979f35aa6788ae2c6c8a01a922cc8019c5b207ff6eb37431da9cf06adb9ff23aa254a508869defde467c5bd4ddd349fef4f2b8e36db1
+  data.tar.gz: d71c27d2503db830047624a2fe26871b0bbbe23a3e17477cd515631f793442eb7160cbf8e8b64d4bc3c351269f3e804fb6dd7337386cba966b01f3f25a9ea206

data/README.md

@@ -1,8 +1,11 @@
 # Pry-State
 
+Why?
+When you are debugging, you care about the state of your program. You want to inspect which value is nil or which array is still empty or something similar. The default pry session doesn't give you all these info. You have to evaluate the variables in the prompt to really see what's going on. It is this problem that this extension of pry is trying to solve.
+
 Pry state is an extension of pry. With pry state you can see the values of the instance and local variables in a pry session.
 
-![SCREENSHOT] (https://cloud.githubusercontent.com/assets/1620848/8893566/c4a69ea6-33b2-11e5-90e4-d80cd498f135.png)
+![SCREENSHOT] (https://cloud.githubusercontent.com/assets/1620848/9140567/d57047a4-3d4f-11e5-901e-d508c01c8d52.png)
 
 ## Installation
 
@@ -30,6 +33,11 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+## Roadmap
+
+1. Indicate the CHANGE in value between pry sessions by different color.
+2. Associate the variables with numbers, and support command to evaluate the variable through these numbers. eg. command 's1' will show the value of first variable and so on.
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/pry-state/fork )

data/lib/pry-state.rb

@@ -4,5 +4,5 @@ require 'pry-state/hook_action'
 
 
 Pry.hooks.add_hook(:before_session, "pry_state_hook") do |output, binding, pry|
-  HookAction.new(binding).act
+  HookAction.new(binding, pry).act
 end

data/lib/pry-state/hook_action.rb

@@ -1,66 +1,57 @@
+require 'pry-state/printer'
+
 class HookAction
   IGNORABLE_LOCAL_VARS = [:__, :_, :_ex_, :_pry_, :_out_, :_in_, :_dir_, :_file_]
-  IGNORABLE_INSTANCE_VARS = [:@_request, :@_response, :@_routes]
 
-  def initialize binding
-    @binding = binding
-    @instance_variables = @binding.eval('instance_variables')
-    @local_variables = @binding.eval('local_variables')
+  CONTROLLER_INSTANCE_VARIABLES = [:@_request, :@_response, :@_routes]
+  RSPEC_INSTANCE_VARIABLES = [:@__inspect_output, :@__memoized]
+  IGNORABLE_INSTANCE_VARS = CONTROLLER_INSTANCE_VARIABLES + RSPEC_INSTANCE_VARIABLES
+
+  def initialize binding, pry
+    @binding, @pry = binding, pry
+
   end
 
   def act
-    (instance_variables - IGNORABLE_INSTANCE_VARS).each do |var|
-      eval_and_print var, 'green'
+    # when using guard, locals :e, :lib, :pry_state_prev get printed.
+    # this 'if' cuts them off.
+    if @binding.eval("self.class") == Object
+      return
+    end
+
+    (binding.eval('instance_variables') - IGNORABLE_INSTANCE_VARS).each do |var|
+      eval_and_print var, var_color: 'green'
     end
 
-    (local_variables - IGNORABLE_LOCAL_VARS).each do |var|
-      eval_and_print var, 'cyan'
+    (binding.eval('local_variables') - IGNORABLE_LOCAL_VARS).each do |var|
+      eval_and_print var, var_color: 'cyan'
     end
   end
 
   private
-  attr_reader :binding, :instance_variables, :local_variables
+  attr_reader :binding, :pry
 
-  def eval_and_print var, color
-    var_name_adjusted = var.to_s.ljust(25)
-    print Pry::Helpers::Text.send(color, truncate(var_name_adjusted, 25) )
+  def eval_and_print var, var_color: 'green', value_color: 'white'
     value = binding.eval(var.to_s)
-    print_stringified_val_or_nil value
-  end
-
-  def print_stringified_val_or_nil value
-    value = stringify_value value
-    if value.empty?
-      print Pry::Helpers::Text.red 'nil'
-    else
-      print truncate(value, 60)
+    if value_changed? var, value
+      var_color = "bright_#{var_color}"; value_color = 'bright_yellow'
     end
-    print "\n"
+    Printer.trunc_and_print var, value, var_color, value_color
+    stick_value! var, value # to refer the value in next
   end
 
-  def stringify_value value
-    if value.class == String
-      "\"#{value}\""
-    elsif value.class == Array
-      "len:#{value.count} #{value}"
-    else
-      value.to_s
-    end
+  def value_changed? var, value
+    prev_state[var] and prev_state[var] != value
   end
 
-  def truncate text, length
-    if text.nil? then return end
-    l = length - "...".chars.to_a.size
-    (text.chars.to_a.size > length ? text.chars.to_a[0...l].join + "..." : text).to_s
+  def stick_value! var, value
+    prev_state[var] = value
   end
 
-  # def prev_value var
-  #   prev_binding = binding.eval('@_prev_binding')
-  #   puts binding
-  #   puts prev_binding
-  #   value = prev_binding.eval var.to_s
-  #   print "prev value of #{var} is #{value.to_s.truncate(20)}"
-  #   value
-  # end
+  def prev_state
+    # init a hash to store state to be used in next session
+    # in finding diff
+    pry.config.extra_sticky_locals[:pry_state_prev] ||= {}
+  end
 
 end

data/lib/pry-state/printer.rb

@@ -0,0 +1,36 @@
+module Printer
+  extend self
+
+  def trunc_and_print var, value, var_color, value_color
+    var_name_adjusted = var.to_s.ljust(25)
+    print Pry::Helpers::Text.send(var_color, truncate(var_name_adjusted, 25) )
+    print_stringified_val_or_nil value, value_color
+    print "\n"
+  end
+
+  private
+  def truncate text, length
+    if text.nil? then return end
+    l = length - "...".chars.to_a.size
+    (text.chars.to_a.size > length ? text.chars.to_a[0...l].join + "..." : text).to_s
+  end
+
+  def print_stringified_val_or_nil value, color
+    value = stringify_value value
+    if value.empty?
+      print Pry::Helpers::Text.red 'nil'
+    else
+      print Pry::Helpers::Text.send(color, truncate(value, 60) )
+    end
+  end
+
+  def stringify_value value
+    if value.class == String
+      "\"#{value}\""
+    elsif value.class == Array
+      "len:#{value.count} #{value}"
+    else
+      value.to_s
+    end
+  end
+end

data/lib/pry-state/version.rb

@@ -1,3 +1,3 @@
 module PryState
-  VERSION = '0.1.4'
+  VERSION = '0.1.6'
 end

data/pry-state.gemspec

@@ -20,10 +20,11 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.9"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency 'rspec', '~> 0'
+  spec.add_development_dependency 'rspec', '~> 3.3', '>= 3.3.0'
+  spec.add_development_dependency 'rspec-core', '~> 3.3', '>= 3.3.2'
+  spec.add_development_dependency 'pry-nav', '~> 0.2.4'
+  spec.add_development_dependency 'guard', '~> 2.13', '>= 2.13.0'
+  spec.add_development_dependency 'guard-rspec', '~> 4.6', '>= 4.6.3'
   spec.add_runtime_dependency 'pry', '>= 0.9.10', '< 0.11.0'
-  spec.add_development_dependency "pry-nav", '~> 0'
-  spec.add_development_dependency "guard", '~> 0'
-  spec.add_development_dependency "guard-rspec", '~> 0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pry-state
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Sudhagar
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-02 00:00:00.000000000 Z
+date: 2015-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,76 +44,114 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.10
-    - - "<"
+        version: '3.3'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.0
-  type: :runtime
+        version: 3.3.2
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.10
-    - - "<"
+        version: '3.3'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 3.3.2
 - !ruby/object:Gem::Dependency
   name: pry-nav
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.4
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.13.0
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.6.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.6.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
 description: Pry state lets you to see the values of the instance and local variables
   in a pry session
 email:
@@ -134,6 +172,7 @@ files:
 - bin/setup
 - lib/pry-state.rb
 - lib/pry-state/hook_action.rb
+- lib/pry-state/printer.rb
 - lib/pry-state/version.rb
 - pry-state.gemspec
 homepage: https://github.com/SudhagarS/pry-state