cognitive_distance 0.0.1.pre

data/.autotest

@@ -0,0 +1,19 @@
+# vim: set filetype=ruby : 
+
+require 'autotest/restart'
+require 'autotest/growl'
+
+Autotest.add_hook :initialize do |at|
+  at.testlib = 'minitest/spec'
+  
+  at.clear_mappings
+  at.add_mapping(/^lib\/(.*)\.rb$/) { |f, m| "spec/#{m[1]}_spec.rb" }
+  at.add_mapping(/^spec\/.*_spec\.rb$/) { |f,_| f }
+  at.add_mapping(/^spec\/spec_helper\.rb$/) { |f,_|
+    at.files_matching(/^spec\/.*_spec\.rb$/)
+  }
+  
+  at.add_exception '.git'
+  at.add_exception 'coverage'
+end
+

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*~
+*.swp
+.DS_Store
+coverage/*
+exs/*
+

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.2
+script: bundle exec rake test
+

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in cognitive_distance.gemspec
+gemspec
+
+group :test do
+  gem 'minitest'
+  gem 'minitest-emoji'
+  gem 'autotest'
+  gem 'autotest-growl'
+  gem 'simplecov'
+end

data/LICENSE.md

@@ -0,0 +1,221 @@
+# Apache License
+
+Version 2.0, January 2004
+
+[http://www.apache.org/licenses/](http://www.apache.org/licenses/)
+
+## TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+### 1. Definitions
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+### 2. Grant of Copyright License
+
+Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+### 3. Grant of Patent License
+Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+### 4. Redistribution
+
+You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+<ol style="list-style-type: lower-alpha;">
+  <li>
+    You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+  </li>
+  <li>
+    You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+  </li>
+  <li>
+    You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+  </li>
+  <li>
+    If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+  </li>
+</ol>
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+### 5. Submission of Contributions
+Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+### 6. Trademarks
+This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+### 7. Disclaimer of Warranty
+Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+### 8. Limitation of Liability
+In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+### 9. Accepting Warranty or Additional Liability
+While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+## END OF TERMS AND CONDITIONS
+
+## APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "[]"
+replaced with your own identifying information. (Don't include
+the brackets!)  The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+    Copyright [yyyy] [name of copyright owner]
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+

data/README.md

@@ -0,0 +1,50 @@
+# Cognitive Distance
+
+[![Build Status](https://secure.travis-ci.org/iande/cognitive_distance.png)](http://travis-ci.org/iande/cognitive_distance)
+
+## Installing
+
+Not yet.
+
+## Usage
+
+### Measure the number of modules "hopped" by a method call
+
+    class Mine
+      def my_method
+        Yours.new.your_method
+      end
+    end
+
+    class Yours
+      def initialize
+      end
+
+      def your_method
+      end
+    end
+
+    CognitiveDistance::Measurements.measure_module_hops Mine.new, :my_method
+    # => 2
+    CognitiveDistance::Measurements.measure_distinct_module_hopes Mine.new, :my_method
+    # => 1
+
+The module hops are:
+
+1. Initializing the newly instantiated `Yours` object (`Yours#initialize`)
+2. Calling `your_method` on the new instance
+
+There is only 1 distinct module hop because `my_method => Yours#initialize`
+and `my_method => Yours#your_method` cross the same boundary.
+
+At this time, only Ruby code is traced, so if `Yours` did not define an
+`initialize` method, both hop counts would be 1.
+
+*Brief Aside*: tracing `c-call` events changes nothing in this case, as no
+instance methods of the `Yours` instance are invoked until `#your_method` is
+called.
+
+## License
+
+Let's go with Apache 2.0, I've been using it pretty frequently.
+

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end
+
+desc "Generate a coverage report from tests with simplecov"
+task :coverage do  
+  ENV['SCOV'] = '1'
+  Rake::Task['test'].invoke
+end

data/cognitive_distance.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "cognitive_distance/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cognitive_distance"
+  s.version     = CognitiveDistance::VERSION
+  s.authors     = ["Ian D. Eccles"]
+  s.email       = ["ian.eccles@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{A (currently incomplete) measure of locality}
+  s.description = %q{A tool for measuring locality of Ruby source. No real features yet, wait for the non-pre version}
+
+  s.rubyforge_project = "cognitive_distance"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'rake'
+end
+

data/lib/cognitive_distance.rb

@@ -0,0 +1,23 @@
+require 'cognitive_distance/version'
+require 'cognitive_distance/structures'
+require 'cognitive_distance/tracer'
+require 'cognitive_distance/measurements'
+require 'cognitive_distance/transforms'
+require 'cognitive_distance/presenters'
+
+module CognitiveDistance
+end
+# Copyright 2012 Ian D. Eccles
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+# http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+

data/lib/cognitive_distance/measurements.rb

@@ -0,0 +1,16 @@
+module CognitiveDistance::Measurements
+  class << self
+    def register_measurement mod, method, measurement
+      instance_eval <<-EODEF, __FILE__, __LINE__
+        def measure_#{measurement}(*args)
+          #{mod.name}.#{method} *args
+        end
+      EODEF
+    end
+  end
+end
+
+require 'cognitive_distance/measurements/measurement'
+require 'cognitive_distance/measurements/module_hops'
+require 'cognitive_distance/measurements/distinct_module_hops'
+

data/lib/cognitive_distance/measurements/distinct_module_hops.rb

@@ -0,0 +1,19 @@
+module CognitiveDistance::Measurements
+  class DistinctModuleHops
+    extend Measurement
+
+    register :distinct_module_hops
+
+    def measure tree
+      CognitiveDistance::Transforms::CallTreeToModuleBoundaryGraph.
+        transform(tree).map { |(v1,v2)|
+          [v1.context, v2.context]
+        }.uniq.size
+    end
+
+    def self.measure obj, meth
+      new.measure(CognitiveDistance::Tracer.new(obj).trace(meth))
+    end
+  end
+end
+

data/lib/cognitive_distance/measurements/measurement.rb

@@ -0,0 +1,7 @@
+module CognitiveDistance::Measurements
+  module Measurement
+    def register name, measure=:measure
+      CognitiveDistance::Measurements.register_measurement self, measure, name 
+    end
+  end
+end

data/lib/cognitive_distance/measurements/module_hops.rb

@@ -0,0 +1,17 @@
+module CognitiveDistance::Measurements
+  class ModuleHops
+    extend Measurement
+    
+    register :module_hops
+
+    def measure tree
+      CognitiveDistance::Transforms::CallTreeToModuleBoundaryGraph.
+        transform(tree).edges.size
+    end
+
+    def self.measure obj, meth
+      new.measure(CognitiveDistance::Tracer.new(obj).trace(meth))
+    end
+  end
+end
+