self_consciousness 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 98ce3ddf4ac2662e71b68dafb212d7fb90004b44
+  data.tar.gz: 658f350c760e00295dc092377e77b91638f576d2
+SHA512:
+  metadata.gz: 4ca2bee64d1e0649595ce5174b5db8c6d8b559826e5b3d09eae6b5c26f0e7744fe552f6aca5fedf6f689f0b909cd1e76239ba9fce734c3b09a616bedde380981
+  data.tar.gz: 1a9e67c3819187bdca561c57a6ee06780e4a38b38959998a44f0545d07696716c3a1ee3d8746d293938e55065efc42657a2f58ed08bd8674a927ccc3ff4d20ff

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 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,17 @@
+# self_consciousness
+
+A module on top of self_identity to store what's "normal" and how the code has changed since then.
+
+Use `require 'self_identity'` in the script you want to be conscious of. Then have the script, or the script running it, call `SelfConsciousness.normalize`. Whenever that script calls `SelfConsciousness.report`, you'll get a diff of the method chain since you last normalized. You can also call `SelfConsciousness.introspect` to create the diff without reporting.
+
+Confused? Check out the `example` directory.
+
+If you don't know what the method chain is, check out [self_identity](https://github.com/colstrom/self_identity) first.
+
+## Data format:
+
+Inside .self_consciousness you'll find the following key/value Moneta stores:
+
+- `dependencies`: the method chain dependencies that are "normal"
+- `additions`: the dependencies that have been added since normalizing
+- `removals`: the dependencies that have been removed since normalizing

data/Rakefile

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

data/bin/self_consciousness

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+require 'yaml'
+require 'commander/import'
+require 'colorize'
+require_relative '../lib/self_consciousness'
+
+program :name, 'Self Consciousness'
+program :version, '0.0.1'
+program :description, 'Introspection and reporting on a program\'s functionality'
+program :help, 'Author', 'Justin Scott <jvscott@gmail.com>'
+
+command :normalize do |c|
+  c.syntax = 'self_consciousness normalize'
+  c.description = 'Creates an idea of what identity is "normal".'
+  c.action do
+    SelfConsciousness.normalize
+    puts "[#{'Success'.green}] The last run program now defines normal."
+  end
+end
+
+command :report do |c|
+  c.syntax = 'self_consciousness report'
+  c.description = 'Finds how the program deviates from "normal" and displays a method chain diff.'
+  c.action do
+    puts SelfConsciousness.report
+  end
+end

data/example.rb

@@ -0,0 +1,25 @@
+require_relative 'lib/self_consciousness'
+require 'self_identity'
+
+def foo(array)
+  array.push 1
+end
+
+def bar(array)
+  array.push 2
+end
+
+def baz(array)
+  array.push 3
+end
+
+if ARGV[0] == 'prototype'
+  var = foo []
+  var = bar var
+else
+  var = bar []
+  var = baz var
+end
+
+SelfConsciousness.report
+SelfConsciousness.normalize

data/example/README.md

@@ -0,0 +1,11 @@
+`prototype.rb` and `finalized.rb` represent two products in the early and late stage of development. Over time they add and remove functionality and we'd like to track how that changed, perhaps via a Continuous Integration server.
+
+First, run `prototype.rb`. It requires [self_identity](https://github.com/colstrom/self_identity) which will save its state to file. This is what we want to base future comparisons off of so use `self_consciousness normalize` to set that run as "normal".
+
+Then run `finalized.rb`. It will overwrite the previous identity with its own automatically, just like the prototype did. Now run `self_consciousness report` and the method chain differences will be printed.
+
+If you normalize and report again without running any new code, it will let you know that nothing has changed.
+
+## Warning
+
+Make sure that you do this all from the same directory. Ruby will look to the current working directory to find the identity storages held in file.

data/example/finalized.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+require 'self_identity'
+
+def foo(array)
+  array.push 1
+end
+
+def bar(array)
+  array.push 2
+end
+
+def baz(array)
+  puts 'Done!'
+end
+
+var = bar []
+var = baz var

data/example/prototype.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+require 'self_identity'
+
+def foo(array)
+  array.push 1
+end
+
+def bar(array)
+  puts 'done'
+end
+
+var = foo []
+var = bar var

data/kintama/self_consciousness.rb

@@ -0,0 +1,55 @@
+require 'kintama'
+require 'yaml'
+require 'moneta'
+require 'colorize'
+require_relative '../lib/self_consciousness'
+require_relative 'stdout_helper'
+
+def execute(path)
+  thread = Thread.new { system "ruby #{path}" }
+  thread.join
+end
+
+def run_and(method = :normalize)
+  script = method == :normalize ? 'test.rb' : 'test.rb differently'
+  execute "#{__dir__}/#{script}"
+  SelfConsciousness.send method
+end
+
+describe SelfConsciousness do
+  setup do
+    @storage = Moneta.new :File, dir: '.self_consciousness'
+    @expected_introspection_results = {
+      removals: [{:output=>[1], :from=>:foo, :to=>:bar}],
+      additions: [{:output=>[2], :from=>:bar, :to=>:baz}]
+    }
+    SelfConsciousness.clear
+    run_and :normalize
+  end
+
+  should 'decide what\'s "normal"' do
+    expected_dependencies = [{:output=>[1], :from=>:foo, :to=>:bar}]
+    assert_equal true, @storage.key?('dependencies')
+    assert_equal expected_dependencies, @storage.fetch('dependencies', nil)
+  end
+
+  should 'compare itself with its idea of "normal"' do
+    run_and :introspect
+    @expected_introspection_results.each do |key, value|
+      assert_equal value, @storage.fetch(key.to_s, nil)
+    end
+  end
+
+  should 'introspect before reporting' do
+    run_and :report
+    @expected_introspection_results.each do |key, value|
+      assert_equal value, @storage.fetch(key.to_s, nil)
+    end
+  end
+
+  should 'report a diff of additions and removals' do
+    assert_output /-.*+/ do
+      run_and :report
+    end
+  end
+end

data/kintama/stdout_helper.rb

@@ -0,0 +1,27 @@
+module ::Kernel
+  def capture_stdout
+    out = StringIO.new
+    $stdout = out
+    yield
+    out.rewind
+    return out
+  ensure
+    $stdout = STDOUT
+  end
+
+  def silence_stdout
+    $stdout = StringIO.new
+    return yield
+  ensure
+    $stdout = STDOUT
+  end
+end
+
+def assert_output(expected, &block)
+  output = capture_stdout(&block).read
+  if expected.is_a?(Regexp)
+    assert_match expected, output
+  else
+    assert_equal expected, output
+  end
+end

data/kintama/test.rb

@@ -0,0 +1,21 @@
+require 'self_identity'
+
+def foo(array)
+  array.push 1
+end
+
+def bar(array)
+  array.push 2
+end
+
+def baz(array)
+  array.push 3
+end
+
+if ARGV[0].nil?
+  var = foo []
+  var = bar var
+else
+  var = bar []
+  var = baz var
+end

data/lib/self_consciousness.rb

@@ -0,0 +1,49 @@
+require 'moneta'
+require 'fileutils'
+require 'colorize'
+
+module SelfConsciousness
+  def self.without_self_identity
+    begin
+      previously_enabled = SelfIdentity.enabled?
+      SelfIdentity.disable
+      yield if block_given?
+      SelfIdentity.enable if previously_enabled
+    rescue NameError => e
+      yield if block_given?
+    end
+  end
+
+  def self.normalize
+    without_self_identity do
+      FileUtils.mkdir_p '.self_consciousness'
+      FileUtils.cp '.self_identity/dependencies', '.self_consciousness/dependencies'
+    end
+  end
+
+  def self.clear
+    without_self_identity do
+      conscious = Moneta.new :File, dir: '.self_consciousness'
+      conscious['dependencies'] = []
+    end
+  end
+
+  def self.introspect
+    without_self_identity do
+      latest = Moneta.new :File, dir: '.self_identity'
+      conscious = Moneta.new :File, dir: '.self_consciousness'
+      conscious['removals'] = conscious['dependencies'] - latest['dependencies']
+      conscious['additions'] = latest['dependencies'] - conscious['dependencies']
+    end
+  end
+
+  def self.report
+    without_self_identity do
+      introspect
+      conscious = Moneta.new :File, dir: '.self_consciousness'
+      conscious['removals'].each { |item| puts "- #{item.to_s}".colorize(:red) }
+      conscious['additions'].each { |item| puts "+ #{item.to_s}".colorize(:green) }
+      puts 'Nothing has changed' if conscious['removals'].concat(conscious['additions']).empty?
+    end
+  end
+end

data/self_consciousness.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |gem|
+  gem.name        = 'self_consciousness'
+  gem.version     = '0.1.0'
+  gem.licenses    = 'MIT'
+  gem.authors     = ['Justin Scott']
+  gem.email       = 'jvscott@gmail.com'
+  gem.homepage    = 'http://www.github.com/jscott/self_consciousness/'
+  gem.summary     = 'Self Consciousness'
+  gem.description = 'Allowing code to introspect and report on its own functionality.'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- kintama/**/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/self_consciousness`.split("\n").map { |f| File.basename(f) }
+
+  gem.add_runtime_dependency 'colorize'
+  gem.add_runtime_dependency 'moneta'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'kintama'
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: self_consciousness
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Justin Scott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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: 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 introspect and report on its own functionality.
+email: jvscott@gmail.com
+executables:
+- self_consciousness
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/self_consciousness
+- example.rb
+- example/README.md
+- example/finalized.rb
+- example/prototype.rb
+- kintama/self_consciousness.rb
+- kintama/stdout_helper.rb
+- kintama/test.rb
+- lib/self_consciousness.rb
+- self_consciousness.gemspec
+homepage: http://www.github.com/jscott/self_consciousness/
+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 Consciousness
+test_files: []