self_identity 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 76cc850d44cf9d6588f6cd346620dee7941f6d28
+  data.tar.gz: cff98d7975aba2c313bd8f4f41abdf8a91ae3be0
+SHA512:
+  metadata.gz: a8e3b1582a4093f61a57eff22955a1d9e2df58b0dd191156cfd952f216fa2b2532c0b6cfea99ce09fe508ba672a32237bc1f1d5d431a51787c73f259b44354ff
+  data.tar.gz: b93ae7bda9e8c6e2205cec178e642bffb51174aff16046bfb50486133ae6a834c362c76702e9c71f35204fb90f734760a10850d0e6096f5e81f5d51f8b2a74d0

data/.gitignore

@@ -0,0 +1,3 @@
+.self_identity
+Gemfile.lock
+*.gem

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Chris Olstrom and Justin Scott
+
+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,57 @@
+self_identity
+=============
+
+Helping code understand itself, an adventure in alternative testing methodology.
+
+Usage
+-----
+
+`require 'self_identity'` and your code will record its method dependencies each time it runs.
+
+From the working directory the script was run from, you'll find a [Moneta](https://github.com/minad/moneta) file storage with the following arrays and element formats:
+
+### calls
+
+- __name__: the method called
+- __input_reference__: object_id's of the input
+- __input__: the given input array
+
+### returns
+
+- __name__: the method returned from
+- __output_reference__: object_id of the output
+- __output__: the generated output
+
+### dependencies
+
+- __output__: the object passed between the methods
+- __from__: the method returned from
+- __to__: the method called
+
+Background
+----------
+
+At the end of 2014, @brixen posted a fascinating rant on the state of RubySpec. One bit stuck out as inspiring: "Ruby is what Ruby does."
+
+MRI 1.8 had pretty spotty (or no) test coverage. When confirming the accuracy of Rubinius in the face of an absent or incomplete test suite, @brixen asserted that "The way a Ruby program behaves is the definition of Ruby". From this assertion came RubySpec, a comprehensive suite of specifications describing "what Ruby does" so alternative implementations could do the same thing.
+
+self_identity applies this mindset to automated testing.
+
+Objectives
+----------
+
+1. Be able to define method signatures. Given input x (of type a) to method m, the output will be y (of type b).
+2. Be able to define what qualifies as valid input. For input x, what is it required to ```respond_to?``` within method m.
+3. Be able to define what qualifies as valid output. For output y from method m, what will it be expected to ```respond_to?``` from creation until it is reaped by the garbage collection valkyries.
+
+_Together, these allow a program to assert its identity: the collection of canonical method signatures and object interactions that state "This is what I am, and how I operate."_
+
+Notes
+-----
+
+This is not a replacement for *good* tests, or specs. It does not validate that the code is correct (beyond the syntax checking inherent in running the program), or that it performs as expected. However, being able to assert that "it did what it did last time, given the same conditions" is better than untested code.
+
+Authors
+-------
+
+Chris Olstrom and Justin Scott

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rake'
+
+task :test do
+  require_relative 'kintama/self_identity'
+end

data/kintama/expected/outcomes.yaml

@@ -0,0 +1,45 @@
+---
+- name: basic_usage
+  dependencies:
+    - :output: [1]
+      :from: :foo
+      :to: :bar
+
+- name: nested_calls
+  dependencies:
+    - :output: [1]
+      :from: :foo
+      :to: :bar
+    - :output: [1]
+      :from: :foo
+      :to: :baz
+
+- name: calls_and_returns
+  calls:
+    - :name: :foo
+      :input: [[]]
+    - :name: :bar
+      :input: [[1]]
+  returns:
+    - :name: :foo
+      :output: [1]
+    - :name: :bar
+      :output: [1, 2]
+
+- name: passthrough_methods
+  dependencies:
+    - :output: [1]
+      :from: :foo
+      :to: :bar
+    - :output: [1]
+      :from: :foo
+      :to: :baz
+    - :output: [1]
+      :from: :bar
+      :to: :baz
+
+- name: tracking_id_not_value
+  dependencies:
+    - :output: [1,2]
+      :from: :bar
+      :to: :baz

data/kintama/scripts/basic_usage.rb

@@ -0,0 +1,12 @@
+require_relative '../../lib/self_identity'
+
+def foo(array)
+  array.push 1
+end
+
+def bar(array)
+  array.push 2
+end
+
+var = foo []
+var = bar var

data/kintama/scripts/calls_and_returns.rb

@@ -0,0 +1,12 @@
+require_relative '../../lib/self_identity'
+
+def foo(array)
+  array.push 1
+end
+
+def bar(array)
+  array.push 2
+end
+
+var = foo []
+var = bar var

data/kintama/scripts/nested_calls.rb

@@ -0,0 +1,17 @@
+require_relative '../../lib/self_identity'
+
+def foo(array)
+  array.push 1
+end
+
+def bar(array)
+  baz array
+  array.push 2
+end
+
+def baz(array)
+  # do work with array
+end
+
+var = foo []
+var = bar var

data/kintama/scripts/passthrough_methods.rb

@@ -0,0 +1,18 @@
+require_relative '../../lib/self_identity'
+
+def foo(array)
+  array.push 1
+end
+
+def bar(array)
+  # do work with array
+  array
+end
+
+def baz(array)
+  array.push 2
+end
+
+var = foo []
+var = bar var
+var = baz var

data/kintama/scripts/tracking_id_not_value.rb

@@ -0,0 +1,17 @@
+require_relative '../../lib/self_identity'
+
+def foo(array)
+  array.push 1
+end
+
+def bar(array)
+  array.push 2
+end
+
+def baz(array)
+  array.push 3
+end
+
+var = foo []
+var = bar [1]
+var = baz var

data/kintama/self_identity.rb

@@ -0,0 +1,38 @@
+require 'kintama'
+require 'yaml'
+require 'moneta'
+#require_relative 'helpers'
+# TODO: clean this up with helpers and such
+
+$scripts = YAML.load_file "#{__dir__}/expected/outcomes.yaml"
+
+def remove_reference_keys_for(hash)
+  hash.reject! { |key| key.match /reference/ }
+end
+
+given 'self_identity is required' do
+  setup do
+    @script_dir = "#{__dir__}/scripts"
+    @storage = Moneta.new :File, dir: '.self_identity'
+  end
+  
+  $scripts.each do |script|
+    context "running scripts for #{script['name']}" do
+      setup do
+        script_path = "#{@script_dir}/#{script['name']}.rb"
+        thread = Thread.new { system "ruby #{script_path}" }
+        thread.join
+      end
+
+      ['calls', 'returns', 'dependencies'].each do |data|
+        if script[data]
+          should "archive method #{data}" do
+            actual = @storage.fetch data, []
+            actual.each { |hash| remove_reference_keys_for hash }
+            assert_equal script[data], actual
+          end
+        end
+      end
+    end
+  end
+end

data/lib/data_constructors.rb

@@ -0,0 +1,48 @@
+def safe_clone(object)
+  begin
+    object.clone
+  rescue TypeError => e
+    object
+  end
+end
+
+def sanitize(object)
+  if object.is_a? Proc
+    object.to_s
+  else
+    safe_clone object
+  end
+end
+
+def new_method_call(from:)
+  parameters = from.binding.eval "method(__method__).parameters.map { |p| eval p.last.to_s }"
+  {
+    name: from.method_id,
+    input_reference: parameters.map(&:object_id),
+    input: parameters.map { |parameter| sanitize parameter }
+  }
+end
+
+def new_method_return(from:)
+  {
+    name: from.method_id,
+    output_reference: from.return_value.object_id,
+    output: sanitize(from.return_value)
+  }
+end
+
+def returns_that_pass_to(current)
+  @returns.select do |previous|
+    current[:input_reference].detect { |given_input| given_input.equal? previous[:output_reference] }
+  end
+end
+
+def dependencies_for(method_call)
+  returns_that_pass_to(method_call).map do |method_return|
+    {
+      output: method_return[:output],
+      from: method_return[:name],
+      to: method_call[:name]
+    }
+  end
+end

data/lib/self_identity.rb

@@ -0,0 +1,52 @@
+require 'moneta'
+require_relative 'data_constructors'
+
+storage = Moneta.new :File, dir: '.self_identity'
+storage['calls'] = []
+storage['returns'] = []
+storage['dependencies'] = []
+
+@trace = TracePoint.trace do |trace|
+  @calls ||= []
+  @returns ||= []
+  @dependencies ||= []
+  case trace.event
+  when :call
+    method_call = new_method_call from: trace
+    @dependencies.concat dependencies_for(method_call)
+    @calls.push method_call
+  when :return
+    @returns.push new_method_return(from: trace)
+  when :b_return
+    # not sure how to hook into method blocks
+    # __method__ returns the method it was called from
+  when :c_return
+    # might need a C extension to hook into C calls
+    # __method__ returns 'main'
+  else
+  end
+  script_name = File.basename($PROGRAM_NAME, '.rb')
+  storage.store 'calls', @calls
+  storage.store 'returns', @returns
+  storage.store 'dependencies', @dependencies
+end
+
+module SelfIdentity
+  @@trace = @trace
+
+  def self.enabled?
+    @@trace.enabled?
+  end
+
+  def self.enable
+    @@trace.enable
+  end
+
+  def self.disable
+    @@trace.disable
+  end
+end
+
+@trace = nil
+
+# don't put anything here unless you want it traced

data/self_identity.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |gem|
+  gem.name        = 'self_identity'
+  gem.version     = '0.1.0'
+  gem.licenses    = 'MIT'
+  gem.authors     = ['Justin Scott','Chris Olstrom']
+  gem.email       = 'jvscott@gmail.com'
+  gem.homepage    = 'http://www.github.com/colstrom/self_identity/'
+  gem.summary     = 'Self Identity'
+  gem.description = 'Allowing code to understand its own functionality.'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- kintama/**/*`.split("\n")
+
+  gem.add_runtime_dependency 'moneta'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'kintama'
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: self_identity
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Justin Scott
+- Chris Olstrom
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: moneta
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kintama
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allowing code to understand its own functionality.
+email: jvscott@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- kintama/expected/outcomes.yaml
+- kintama/scripts/basic_usage.rb
+- kintama/scripts/calls_and_returns.rb
+- kintama/scripts/nested_calls.rb
+- kintama/scripts/passthrough_methods.rb
+- kintama/scripts/tracking_id_not_value.rb
+- kintama/self_identity.rb
+- lib/data_constructors.rb
+- lib/self_identity.rb
+- self_identity.gemspec
+homepage: http://www.github.com/colstrom/self_identity/
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Self Identity
+test_files:
+- kintama/expected/outcomes.yaml
+- kintama/scripts/basic_usage.rb
+- kintama/scripts/calls_and_returns.rb
+- kintama/scripts/nested_calls.rb
+- kintama/scripts/passthrough_methods.rb
+- kintama/scripts/tracking_id_not_value.rb