hisoka 0.0.1

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mark Burns
+
+MIT License
+
+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,41 @@
+# Hisoka
+
+"Hisoka ni" means in secret. It is a simple spy library that can be used
+in a Rails* app.
+
+```
+ひそかに【密かに】
+【人に知られないように隠れて】secretly, in secret;
+```
+
+Easily seeing what methods are called on an object
+during normal usage means you can swap it out for an equivalent.
+
+This project was created because of the need to replace some
+calls to a database with an external service and not port across
+unnecessary methods.
+
+#Usage
+
+##Iterable spies
+```ruby
+#old code
+@users = User.all
+
+#replaced with
+@users = Hisoka::Iterable.new("all-users")
+```
+
+#log output example
+
+```log
+```
+
+#Note
+It doesn't need to be Rails specific, but has been abstracted out of
+being used in 2 Rails apps. Pull requests welcome to make it work
+in a more generic way
+
+## Installation, contributions etc
+All the usual bundler gem/github PR guidelines.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/hisoka.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hisoka/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hisoka"
+  spec.version       = Hisoka::VERSION
+  spec.authors       = ["Mark Burns"]
+  spec.email         = ["markthedeveloper@gmail.com"]
+  spec.summary       = %q{Simple spies for development}
+  spec.description   = %q{Find out what objects in your app are doing}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_development_dependency "debugger"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/hisoka.rb

@@ -0,0 +1,11 @@
+require "active_support/all"
+
+require "hisoka/version"
+require "hisoka/spy_stuff"
+require "hisoka/basic"
+require "hisoka/tryable"
+require "hisoka/iterable"
+require "hisoka/routable"
+
+module Hisoka
+end

data/lib/hisoka/basic.rb

@@ -0,0 +1,5 @@
+module Hisoka
+  class Basic < BasicObject
+    include SpyStuff
+  end
+end

data/lib/hisoka/iterable.rb

@@ -0,0 +1,36 @@
+module Hisoka
+  class Iterable < Tryable
+    Enumerable.instance_methods.each do |m|
+      define_method(m) do |*args|
+        called_method(m, *args)
+      end
+    end
+
+    def as_json(*args)
+      {spy_json: to_s}.to_json
+    end
+
+    def to_json(*args)
+      as_json
+    end
+
+    def to_ary(*args, &block)
+      if block_given?
+        each(&block).to_a
+      else
+        each{}.to_a
+      end
+    end
+
+    def each(&block)
+      called_method(:each)
+
+      result = called_method("block-inside-each")
+      block.call(result)
+    end
+
+    def to_s
+      "#{self.class.name} `#{@name}': #{@parent_method}"
+    end
+  end
+end

data/lib/hisoka/routable.rb

@@ -0,0 +1,11 @@
+module Hisoka
+  class Routable < Iterable
+    def id
+      "some-id"
+    end
+
+    def to_param
+      id
+    end
+  end
+end

data/lib/hisoka/spy_stuff.rb

@@ -0,0 +1,79 @@
+module Hisoka
+  class ColorString < String
+    def blue;           Hisoka.C("\033[34m#{self}\033[0m") end
+    def magenta;        Hisoka.C("\033[35m#{self}\033[0m") end
+    def cyan;           Hisoka.C("\033[36m#{self}\033[0m") end
+    def gray;           Hisoka.C("\033[37m#{self}\033[0m") end
+    def bold;           Hisoka.C("\033[1m#{self}\033[22m") end
+    def reverse_color;  Hisoka.C("\033[7m#{self}\033[27m") end
+  end
+
+
+  def self.C(string, *methods)
+    color = ColorString.new(string)
+
+    methods.each do |m|
+      color = color.send(m)
+    end
+
+    color
+  end
+
+  class StdoutLogger
+    def info(*args)
+      $stdout.puts *args
+    end
+    def warn(*args)
+      $stdout.puts *args
+    end
+    def error(*args)
+      $stdout.puts *args
+    end
+  end
+  module SpyStuff
+    extend ActiveSupport::Concern
+
+    def initialize(name, logger=nil)
+      @name = name
+      @logger ||= (Rails.logger rescue StdoutLogger.new)
+    end
+
+    def parent_method=(m)
+      @parent_method = m
+    end
+
+    def new_child_node(name, parent_method=nil)
+      self.class.new(name).tap{|r|r.parent_method = parent_method}
+    end
+
+    def method_missing(method_name, *args)
+      called_method(method_name, *args)
+    end
+
+    def called_method(method_name, *args)
+      args = if args.empty?
+               ""
+             else
+               "with args #{args.to_s}"
+             end
+
+      call_info = caller[1..1][0].to_s.gsub(/:in `.*haml[\d|_]*'$/, "")
+      call_info.gsub!(/#{Rails.root}/, "") rescue nil
+
+      title = Hisoka.C("\nHisoka", :bold, :blue)
+
+      title = "#{title}: #{@name} ".ljust(50, " ")
+      meth = "#{@parent_method}.#{Hisoka.C(method_name.to_s,:cyan)} "
+      stack = "(called from #{call_info} )"
+
+      @logger.info "#{title} #{stack} #{meth} #{args}"
+
+      new_child_node(@name, [@parent_method, method_name].compact.join("."))
+    end
+
+    def to_s
+      "#{self.class.name} `#{@name}'"
+    end
+  end
+end
+

data/lib/hisoka/tryable.rb

@@ -0,0 +1,5 @@
+module Hisoka
+  class Tryable
+    include SpyStuff
+  end
+end

data/lib/hisoka/version.rb

@@ -0,0 +1,3 @@
+module Hisoka
+  VERSION = "0.0.1"
+end

data/spec/integration_spec.rb

@@ -0,0 +1,74 @@
+require "./lib/hisoka"
+
+describe Hisoka::Routable do
+  let(:hisoka) { Hisoka::Routable.new "my spy"}
+
+  def expect_log(value)
+    l = lambda {|s|
+      if value.is_a?(Regexp)
+        s =~ value
+      else
+        s[value].present?
+      end
+    }
+
+    expect($stdout).to receive(:puts).
+      with(l), "expected #{value}"
+  end
+
+  it "logs the spy name" do
+    expect_log "my spy"
+    hisoka.doesnt_matter
+  end
+
+  it "is routable" do
+    expect(hisoka.to_param).to eq "some-id"
+  end
+
+  it "is convertible to json" do
+    expect_log "each"
+    expect_log "block-inside-each"
+
+    json = {"spy_json" => "Hisoka::Routable `my spy': block-inside-each"}
+
+    hisoka.each do |h|
+      expect(JSON.parse(h.to_json)).to eq json
+    end
+  end
+
+
+
+  it "logs messages called" do
+    expect_log /this_gets_called/
+
+    hisoka.this_gets_called
+  end
+
+  it "logs attributes" do
+    expect_log "an argument"
+
+    hisoka.called_with "an argument"
+  end
+
+  it "logs multiple calls" do
+    expect_log "first"
+    expect_log "second"
+
+    hisoka.first
+    hisoka.second
+  end
+
+  it "is iterable" do
+    expect_log "each"
+    expect_log "block-inside-each"
+    expect_log "inside_loop"
+    expect_log "another_inside_loop"
+    expect_log "with parameters"
+
+    hisoka.each do |h|
+      h.inside_loop
+      h.another_inside_loop
+      h.one_more "with parameters"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,90 @@
+require "debugger"
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: hisoka
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mark Burns
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Find out what objects in your app are doing
+email:
+- markthedeveloper@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hisoka.gemspec
+- lib/hisoka.rb
+- lib/hisoka/basic.rb
+- lib/hisoka/iterable.rb
+- lib/hisoka/routable.rb
+- lib/hisoka/spy_stuff.rb
+- lib/hisoka/tryable.rb
+- lib/hisoka/version.rb
+- spec/integration_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23.2
+signing_key: 
+specification_version: 3
+summary: Simple spies for development
+test_files:
+- spec/integration_spec.rb
+- spec/spec_helper.rb