state_inspector 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 91381367b1700878be9583f54504f203f15175ca
+  data.tar.gz: 22dc94bacd8aaaec80b95fdd6277730dcbbcec47
+SHA512:
+  metadata.gz: c5ef7d1e269c4874c8a7c9c937c8ce649a1d23e27797def648fb73d20c91ab3e81862199392d60b40181db1ac202931d216f3c7a984d63334ed02a21de4100bd
+  data.tar.gz: c066d620a79f942ef71fe8ffe84962bddf143d75c841f170351d970e1029f929c1c409346f54501b18acddc23facd5a9721e3a59a3afdf3b63a5cf0ce18004e7

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/log/
+/pkg/
+/spec/reports/
+/tmp/
+**/*.swp
+*.gem

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.13.7

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in state_inspector.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Daniel P. Clark
+
+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,139 @@
+# StateInspector
+[![Gem Version](https://badge.fury.io/rb/state_inspector.svg)](http://badge.fury.io/rb/state_inspector)
+[![Build Status](https://travis-ci.org/danielpclark/state_inspector.svg?branch=master)](https://travis-ci.org/danielpclark/state_inspector)
+
+The original purpose of this project is to log state change on target objects.  This will expand
+further into additional introspection as new versions are made available.
+
+**Currently this project depends on attr hooks.**
+
+This project uses a variation of the observer pattern.  There is a hash of Reporters where you can
+mark the key as a class instance or the class itself and point it to an Observer object.  Three
+observers are included for you to use under StateInspector::Observers which are NullObserver (default),
+InternalObserver, and SessionLoggerObserver.  When you toggle on an "informant" on a class instance or
+class then each time a setter method is called it will pass that information on to the relevant observer
+which handles the behavior you want to occur with that information.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'state_inspector'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install state_inspector
+
+## Usage
+
+The preferred usage is to pick what classes you want to track state change in and have them logged to
+a session logger.  To do this you would need to do the following.
+
+```ruby
+require 'state_inspector'
+require 'state_inspector/observers/session_logger_observer'
+include StateInspector::Observers
+
+class MyClass
+  attr_writer :thing
+end
+
+StateInspector::Reporter[MyClass] = SessionLoggerObserver
+
+MyClass.toggle_informant
+```
+
+Now everytime the setter method is used for `thing` a new line will be entered into a log file
+of the object, method, old value, and new value.  So you will see what is changed from where in
+the order that the changed occurred.  This session logger will grab as many objects state changes
+as you want and give you a nice ordered history of what has occurred.
+
+If you don't want to inform on all instances of one class then instead of running `toggle_informant`
+on the class then execute that method on just the instances of that class you want instead.
+
+If you want to see the expected results of the current observer/reporters then see [test/reporter_test.rb](https://github.com/danielpclark/state_inspector/blob/master/test/reporter_test.rb).
+
+## Observers
+
+To include all Observers into scope you can do:
+
+```ruby
+require 'state_inspector/observers'
+include StateInspector::Observers
+```
+
+You may look at the available observers in [state_inspector/observers](https://github.com/danielpclark/state_inspector/tree/master/lib/state_inspector/observers).
+
+Observers will have a few methods they each have in common.
+
+```ruby
+module Observer
+  def update *vals
+    values() << vals
+  end
+
+  def display
+    values.join " "
+  end
+
+  def values
+    @values ||= []
+  end
+
+  def purge
+    @values = []
+  end
+end
+```
+
+When you're writing your own observer you'll include this Observer onto a module's instance and
+overwrite whatever methods you want there.
+
+```ruby
+module ExampleObserver
+  class << self
+    include Observer
+    def display
+      "Custom display code here"
+    end
+  end
+end
+```
+
+And to register this observer to a target class you simply write:
+
+```ruby
+StateInspector::Reporter[MyTargettedClass] = ExampleObserver
+```
+
+
+## Road Map
+
+* 0.8.0 State inspection of all flagged objects on setter methods.
+Includes logger observer, internal observer, and null observer.
+
+* 0.9.0 Sweep for missed setter methods and prepend inspection behavior.
+
+* 1.0.0 Optional reporting on all/target method calls
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/danielpclark/state_inspector.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

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

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/state_inspector.rb

@@ -0,0 +1,8 @@
+require 'state_inspector/version'
+require 'state_inspector/snoop'
+
+module StateInspector
+  class ::Object
+    extend Snoop
+  end
+end

data/lib/state_inspector/observers.rb

@@ -0,0 +1,3 @@
+require_relative 'observers/null_observer'
+require_relative 'observers/internal_observer'
+require_relative 'observers/session_logger_observer'

data/lib/state_inspector/observers/internal_observer.rb

@@ -0,0 +1,14 @@
+require_relative 'observer'
+
+module StateInspector
+  module Observers
+    module InternalObserver
+      class << self
+        include Observer
+        def purge
+          @values = []
+        end
+      end
+    end
+  end
+end

data/lib/state_inspector/observers/null_observer.rb

@@ -0,0 +1,12 @@
+require_relative 'observer'
+
+module StateInspector
+  module Observers
+    module NullObserver
+      class << self
+        include Observer
+        def update *_; end
+      end
+    end
+  end
+end

data/lib/state_inspector/observers/observer.rb

@@ -0,0 +1,21 @@
+module StateInspector
+  module Observers
+    module Observer
+      def update *vals
+        values() << vals
+      end
+
+      def display
+        values.join " "
+      end
+
+      def values
+        @values ||= []
+      end
+
+      def purge
+        @values = []
+      end
+    end
+  end
+end

data/lib/state_inspector/observers/session_logger_observer.rb

@@ -0,0 +1,82 @@
+require_relative 'observer'
+require 'fileutils'
+require 'logger'
+
+module StateInspector
+  module Observers
+    module SessionLoggerObserver
+      class << self
+        include Observer
+        def update *values
+          folder = File.join ['log', 'state_inspector']
+          @file ||= File.join(
+              folder,
+              ['session', Time.now.to_i, 'log'].join('.')
+            )
+          FileUtils.mkdir_p folder
+          File.open(@file, File::WRONLY | File::APPEND | File::CREAT) do |file|
+            logger = Logger.new(file)
+            logger << values.
+              map(&value_mapper).
+              join(splitter) 
+            logger << "\n"
+          end
+        end
+
+        def file= f
+          warn("Warning! Log file #{@file} was already set!") if @file
+          @file = f
+        end
+
+        def display
+          if @file
+            File.open(@file, File::RDONLY) {|f| f.read }
+          else
+            ""
+          end
+        end
+
+        def values
+          if @file
+            File.open(@file, File::RDONLY) {|f| f.readlines}.map(&:chomp).map do |line|
+              if line.empty?
+                nil
+              else
+                line.split(splitter).map(&value_mapper)
+              end
+            end.compact
+          else
+            []
+          end
+        end
+
+        def purge
+          File.delete(@file) if File.exist? @file
+          @file = nil
+        end
+
+        private
+        def splitter
+          "\t\t"
+        end
+
+        def value_mapper
+          ->v{
+            case v
+            when nil
+              "nil"
+            when "nil"
+              nil
+            when Symbol
+              v.inspect
+            when ->val{ val.is_a?(String) && val =~ /\A:/ }
+              v[1..-1].to_sym
+            else
+              v
+            end
+          }
+        end
+      end
+    end
+  end
+end

data/lib/state_inspector/reporter.rb

@@ -0,0 +1,30 @@
+require_relative 'observers/null_observer'
+
+module StateInspector
+  # OBSERVABLE PATTERN
+  # HASH-LIKE KEY OF OJECT TO OBSERVER/LOGGER INSTANCE
+  module Reporter
+    class << self
+      def [](key)
+        reporters[key]
+      end
+
+      def []=(key, value)
+        reporters[key] = value
+      end
+
+      def default observer=nil
+        @default = observer if observer
+        reporters.default = @default 
+        @default
+      end
+
+      private
+      def reporters
+        @reporters ||= Hash.new.tap {|h|
+          h.default = @default || Observers::NullObserver
+        }
+      end
+    end
+  end
+end

data/lib/state_inspector/snoop.rb

@@ -0,0 +1,47 @@
+require_relative 'state_inspector'
+require_relative 'reporter'
+
+module StateInspector
+  module Snoop
+    def Snoop.extended(base)
+      base.include ClassMethods
+    end
+
+    def attr_writer attr_name
+      define_method("#{attr_name}=") do |value|
+        tell_si __method__.to_s.chop,
+          instance_variable_get("@#{attr_name.to_s}"),
+          value 
+
+        instance_variable_set("@#{attr_name.to_s}", value)
+      end
+      nil
+    end
+
+    def attr_accessor attr_name
+      define_method("#{attr_name}") do
+        instance_variable_get("@#{attr_name.to_s}")
+      end
+
+      self.attr_writer(attr_name)
+    end
+
+    module ClassMethods
+      def state_inspector
+        StateInspector
+      end
+
+      def tell_si what, old, new
+        state_inspector.report( self, "@#{what.to_s}", old, new ) if informant?
+      end
+
+      def toggle_informant
+        @informant = !@informant
+      end
+
+      def informant?
+        @informant || self.class.instance_variable_get(:@informant)
+      end
+    end
+  end
+end

data/lib/state_inspector/state_inspector.rb

@@ -0,0 +1,8 @@
+module StateInspector
+  class StateInspector
+    def self.report who, what, old, new
+      key = who.respond_to?(:class_eval) ? who : who.class
+      Reporter[key].update who, what, old, new
+    end
+  end
+end

data/lib/state_inspector/version.rb

@@ -0,0 +1,3 @@
+module StateInspector
+  VERSION = "0.8.0"
+end

data/state_inspector.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'state_inspector/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "state_inspector"
+  spec.version       = StateInspector::VERSION
+  spec.authors       = ["Daniel P. Clark"]
+  spec.email         = ["6ftdan@gmail.com"]
+
+  spec.summary       = %q{Introspection tool for reporting state change.}
+  spec.description   = %q{Introspection tool for reporting state change.  Instance varialbes and method call debugging.}
+  spec.homepage      = "https://github.com/danielpclark/state_inspector"
+  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.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: state_inspector
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- Daniel P. Clark
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Introspection tool for reporting state change.  Instance varialbes and
+  method call debugging.
+email:
+- 6ftdan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/state_inspector.rb
+- lib/state_inspector/observers.rb
+- lib/state_inspector/observers/internal_observer.rb
+- lib/state_inspector/observers/null_observer.rb
+- lib/state_inspector/observers/observer.rb
+- lib/state_inspector/observers/session_logger_observer.rb
+- lib/state_inspector/reporter.rb
+- lib/state_inspector/snoop.rb
+- lib/state_inspector/state_inspector.rb
+- lib/state_inspector/version.rb
+- state_inspector.gemspec
+homepage: https://github.com/danielpclark/state_inspector
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Introspection tool for reporting state change.
+test_files: []