darko 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4811d58ebc63ef9dd14b764131e95ffa9487445e8715fff764b7c297017fc2f5
+  data.tar.gz: 2fae7e1a75b8a5399ad99d50e6ad8548f67779b3a977656b5cb3815bf3ca1726
+SHA512:
+  metadata.gz: e582f791ae350bca78b46050fe6ecdbad2e380fa42c11e04e95729798e898399e76f9634b9353ff10a5e34b67c3d563486805b6bf65a6e7364efe38623827ade
+  data.tar.gz: a7fbfaa1b2acddee76eb210f7e3b2236335861e5c901686f13c2d0dde22ef605a1c4d4afb983f44e4e22a48363c55015988a801ef8e13257fb1dbe6115f2b656

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+Darko

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.5.5

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.5
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at donniepropst@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in Darko.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    darko (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  darko!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Donnie Propst
+
+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,80 @@
+# Darko
+
+## 28:06:42:12 
+
+Darko helps you debug.  A great use case for Darko is if you want to know *exactly* when a piece of data is accessed or mutated. This enables you to quickly get to the bottom of _where_ something is happening.
+
+Just like Frank without the bunny suit.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'darko'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install darko
+
+## Usage
+
+This is a super simple example with watching an instance of class `Foo`
+
+```ruby
+require 'darko'
+# Some class with something you aren't sure why is changing
+class Foo
+  attr_accessor :data
+  def initialize data
+    @data = data
+  end
+end
+
+an_object = Foo.new('data')
+frank = Darko::Watcher.new(an_object, :@data)
+frank.enable! # this will start the object spy
+foo.data << 'add some data'
+
+frank.disable! # this will quit spying and put everything back to normal :)
+```
+
+```ruby
+# You can log darko data to files too
+frank = Darko::Watcher.new(an_object, :@data, true).enable! 
+
+```
+
+## TODO
+ - Darko::Configuration class
+ - figure out how to follow object reassignment
+ - watch objects, not only object attributes
+ - allow watchers on method call
+ - stats about access
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/prodion23/darko. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/prodion23/darko/blob/master/CODE_OF_CONDUCT.md).
+
+All PR's are welcome :) - before merging you must provide test coverage of the feature.  If you plan to do any extreme rewrites or redesigns please open an issue so we can talk about it.  
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+TL;DR - Be nice to everyone
+
+Everyone interacting in the Darko project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/Darko/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

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/darko.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/darko/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "darko"
+  spec.version       = Darko::VERSION
+  spec.authors       = ["Donnie Propst"]
+  spec.email         = ["donniepropst@gmail.com"]
+
+  spec.summary       = "A debugging assistant - figure out whats going on"
+  spec.description   = "Darko allows you to spy on objects"
+  spec.homepage      = "https://github.com/prodion23/darko"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/prodion23/darko"
+  spec.metadata["changelog_uri"] = "https://github.com/prodion23/darko"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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"]
+end

data/lib/darko.rb

@@ -0,0 +1,6 @@
+module Darko
+  class Error < StandardError; end
+end
+require_relative './darko/version'
+require_relative './darko/watcher'
+require_relative './darko/delegator'

data/lib/darko/delegator.rb

@@ -0,0 +1,38 @@
+require 'logger'
+
+module Darko
+  class Delegator < SimpleDelegator
+
+    def initialize object, log_to_file
+      @initialized = false
+      @log_to_file = log_to_file
+      @logger = log_to_file ? Logger.new(File.new("#{object.class}-#{Time.now.to_i}.darko.log", "w")) : Logger.new(STDOUT)
+      super(object)
+      @initialized = true
+      @logger.debug('Darko delegator initialized')
+    end
+
+    alias_method :darko__getobj__, :__getobj__
+    # TODO: Differentiate between access and mutation - this should be a filter passed through the watcher init
+    def __getobj__
+      called(:access) if @initialized # not fan
+      darko__getobj__
+    end
+
+    def __setobj__ new_obj
+      called(:mutation) if @initialized # not fan
+      super(new_obj)
+    end
+
+    # Anything we want to do on watcher object access do it here
+    def called action_type
+      begin
+        stack_without_darko = Kernel.caller(3..-1).join("\n")
+        @logger.debug("Object: #{action_type} detected at: ")
+        @logger.debug "\t#{stack_without_darko}"
+      rescue
+        @logger.error('Unable to collect a stack trace')
+      end
+    end
+  end
+end

data/lib/darko/version.rb

@@ -0,0 +1,3 @@
+module Darko
+  VERSION = "0.1.0"
+end

data/lib/darko/watcher.rb

@@ -0,0 +1,48 @@
+module Darko
+  class Watcher
+    attr_accessor :delegator
+    def initialize object, attribute=nil, log_to_file=false
+      @object = object
+      @attribute = attribute
+      @delegator = Darko::Delegator.new(attribute_target, log_to_file)
+    end
+
+    # Enabling the Darko::Watcher replaces the object with a Darko::Delegator to spy on mutations
+    def enable!
+      swap_in_delegator
+    end
+
+    # Disabling the Darko::Watcher will reset the object attribute to the original - removing the delegator
+    def disable!
+      swap_out_delegator
+    end
+
+    private
+
+    def swap_out_delegator
+      original_obj = @delegator.instance_variable_get(:@delegate_sd_obj)
+      @object.send(target_setter_message, @attribute, original_obj)
+    end
+
+    def swap_in_delegator
+      @object.send(target_setter_message, @attribute, @delegator)
+    end
+
+    def class_target?
+      @object.is_a?(Class) && @object.class_variables.include?(@attribute)
+    end
+
+    # Depending on if the target object is a class or instance changes what message we need to send,
+    # some memoization just to avoid  if/elses - I'd like this to live elsewhere
+    def target_getter_message
+      @_target_getter_message ||= class_target? ? :class_variable_get : :instance_variable_get
+    end
+    def target_setter_message
+      @_target_setter_message ||= class_target? ? :class_variable_set : :instance_variable_set
+    end
+
+    def attribute_target
+      @object.send(target_getter_message, @attribute)
+    end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: darko
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Donnie Propst
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-19 00:00:00.000000000 Z
+dependencies: []
+description: Darko allows you to spy on objects
+email:
+- donniepropst@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- darko.gemspec
+- lib/darko.rb
+- lib/darko/delegator.rb
+- lib/darko/version.rb
+- lib/darko/watcher.rb
+homepage: https://github.com/prodion23/darko
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/prodion23/darko
+  source_code_uri: https://github.com/prodion23/darko
+  changelog_uri: https://github.com/prodion23/darko
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: A debugging assistant - figure out whats going on
+test_files: []