society 0.13.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0f4ebba200840ada80d8b3179a38dbc15d14ad22
+  data.tar.gz: fbb95e9ef6fd48d8f5856362aeaa9d38118160d6
+SHA512:
+  metadata.gz: 30410ae520e57a09d9e789a3e0d69da885be214e24cf4cc3c5067b4ce381971fc09396140421fb360199b67ad45d48d3165a73318444c3c002d861be0f9c0fdc
+  data.tar.gz: b11f888a578119d654ad89122f25c694af6c12c8729084f4641944769fef7e72e00c849eb5dcf017a13c8c83ebd17db466c5753c986fa5c1767986d2f2315af9

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.console_history

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# CODE OF CONDUCT
+
+This project has adopted version 0.4 of the [Contributor Covenant](https://github.com/bantik/contributor_covenant/).
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+If any participant in this project has issues or takes exception with a contribution, they are obligated to provide constructive feedback and never resort to personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+We promise to extend courtesy and respect to everyone involved in this project regardless of gender, gender identity, sexual orientation, ability or disability, ethnicity, religion, or level of experience.

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Coraline Ada Ehmke  / Instructure.inc
+
+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,52 @@
+# Society
+
+Society analyzes and presents a social graph of relationships between classes or methods.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'society'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install society
+
+## Usage
+
+Initialize a parser with source files:
+
+     parser = Society::Parser.new("path/to/models")
+
+Generate an object dependency graph:
+
+     graph = parser.class_graph
+
+Generate a method dependency graph:
+
+     graph = parser.method_graph
+
+Generate JSON dependency matrix for export to d3:
+
+    parser.matrix.to_jsno
+
+## TODO
+
+* Add fukuzatsu as a dependency
+
+* Wrap fukuzatsu parsing and remove duplicate classes
+
+## Contributing
+
+Please note that this project is released with a [Contributor Code of Conduct](https://github.com/Bantik/society/blob/master/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
+
+
+1. Fork it ( https://github.com/[my-github-username]/society/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/bin/society

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'society/cli'
+Society::CLI.start

data/lib/society.rb

@@ -0,0 +1,13 @@
+require "fileutils"
+
+module Society
+end
+
+require_relative "society/analyzer"
+require_relative "society/cli"
+require_relative "society/matrix"
+require_relative "society/node"
+require_relative "society/object_graph"
+require_relative "society/parser"
+require_relative "society/version"
+

data/lib/society/analyzer.rb

@@ -0,0 +1,134 @@
+require 'parser/current'
+require 'pry'
+
+module Society
+
+  class Analyzer
+
+    attr_reader :content
+
+    DEFAULT_CLASS_NAME = "Unknown"
+
+    def initialize(content)
+      @content = content
+    end
+
+    def class_name
+      find_class(parsed) || DEFAULT_CLASS_NAME
+    end
+
+    def methods
+      @methods ||= methods_from(parsed)
+    end
+
+    def constants
+      @constants ||= constants_from(parsed)
+    end
+
+    private
+
+    def method_list
+      @method_list ||= method_names_from(parsed.children.first)
+    end
+
+    def method_names_from(node, found=[])
+      if node.type == :def || node.type == :defs
+        name = node.loc.name
+        found << content[name.begin_pos..name.end_pos - 1].to_sym
+      end
+      node.children.each do |child|
+        method_names_from(child, found) if parent_node?(child)
+      end
+      found
+    end
+
+    def constants_from(node, found=[])
+      if node.type == :const
+        expression = node.loc.expression
+        found << content[expression.begin_pos..expression.end_pos - 1]
+      end
+      node.children.each do |child|
+        constants_from(child, found) if parent_node?(child)
+      end
+      found.reject{ |constant| constant == class_name }
+    end
+
+    def find_class(node)
+      return unless node && node.respond_to?(:type)
+      concat = []
+      if node.type == :module || node.type == :class
+        concat << text_at(node.loc.name.begin_pos, node.loc.name.end_pos)
+      end
+      concat << node.children.map{|child| find_class(child)}.compact
+      concat.flatten.reject(&:empty?).join('::')
+    end
+
+    def extract_references_from(node, found=[])
+      return found unless node && node.respond_to?(:type)
+      if node.type == :send
+        reference = node.loc.expression
+        found << node.children.last
+      end
+      node.children.each do |child|
+        extract_references_from(child, found)
+      end
+      found.select{|name| method_list.include?(name)}
+    end
+
+    def methods_from(node, found=[])
+      if node.type == :def || node.type == :defs
+        name = node.loc.name
+        expression = node.loc.expression
+        type = case(node.type)
+          when :defs
+            :class
+          when :def
+            :instance
+          when :class
+            :none
+        end
+        found << ParsedMethod.new(
+          name: content[name.begin_pos..name.end_pos - 1],
+          content: content[expression.begin_pos..expression.end_pos - 1],
+          type: type,
+          refs: extract_references_from(node)
+        )
+      end
+      node.children.each do |child|
+        if parent_node?(child)
+          methods_from(child, found)
+        end
+      end
+      found
+    end
+
+    def parent_node?(node)
+      node.respond_to?(:type) || node.respond_to?(:children)
+    end
+
+    def parse!
+      traverse(parsed) && complexity
+    end
+
+    def parsed
+      @parsed ||= ::Parser::CurrentRuby.parse(content)
+    end
+
+    def text_at(start_pos, end_pos)
+      content[start_pos..end_pos - 1]
+    end
+
+    def traverse(node, accumulator=[], extract_methods=false)
+      accumulator << node.type
+      node.children.each do |child|
+        if parent_node?(child)
+          accumulator << child.type
+          traverse(child, accumulator)
+        end
+      end
+      accumulator
+    end
+
+  end
+
+end

data/lib/society/cli.rb

@@ -0,0 +1,26 @@
+require "thor"
+
+module Society
+
+  class CLI < Thor
+
+    desc_text = ""
+
+    desc "from PATH_TO_FILE", desc_text
+    def from(path="./")
+      parser = Society::Parser.new(path)
+      parser.parse_files
+      parser.report
+    end
+
+    default_task :from
+
+    private
+
+    def formatter
+      Formatters::Text
+    end
+
+  end
+
+end

data/lib/society/matrix.rb

@@ -0,0 +1,36 @@
+require 'json'
+
+module Society
+
+  class Matrix
+
+    attr_reader :nodes
+
+    def initialize(nodes)
+      @nodes = nodes
+    end
+
+    def to_json
+      { names: node_names, matrix: matrix }.to_json
+    end
+
+    private
+
+    def node_names
+      self.nodes.map(&:name)
+    end
+
+    def matrix
+      reference_matrix = [[]]
+      nodes.each_with_index do |node, i|
+        references = node_names.map do |name|
+          node.references.include?(name) ? 1 : 0
+        end
+        reference_matrix.push(references)
+      end
+      reference_matrix
+    end
+
+  end
+
+end

data/lib/society/node.rb

@@ -0,0 +1,19 @@
+module Society
+  class Node
+
+    attr_reader   :name       # method or class name
+    attr_reader   :address    # file name or file name + loc
+    attr_accessor :edges      # relation between nodes
+
+    def initialize(name: name, address: address, edges: edges=[])
+      @name = name
+      @address = address
+      @edges = edges
+    end
+
+    def edge_count
+      edges.count
+    end
+
+  end
+end

data/lib/society/object_graph.rb

@@ -0,0 +1,13 @@
+module Society
+
+  class ObjectGraph
+
+    attr_accessor :nodes
+
+    def initialize(nodes: nodes=[])
+      @nodes = nodes
+    end
+
+  end
+
+end

data/lib/society/parser.rb

@@ -0,0 +1,52 @@
+require 'fukuzatsu'
+
+module Society
+
+  class Parser < Fukuzatsu::Parser
+
+    attr_reader :parsed_files
+
+    def initialize(start_path)
+      super(start_path, :none, 0)
+      @parsed_files = parse_files
+    end
+
+    def class_graph
+      @class_graph ||= begin
+        graph = ObjectGraph.new
+        graph.nodes = parsed_files.map do |parsed_file|
+          Node.new(
+            name: parsed_file.class_name,
+            address: parsed_file.path_to_file,
+            edges: parsed_file.class_references
+          )
+        end
+        graph
+      end
+    end
+
+    def method_graph
+      @method_graph ||= begin
+        graph = ObjectGraph.new
+        target = parsed_files.first
+        graph.nodes = target.methods.map do |method|
+          Node.new(
+            name: method.name,
+            address: target.class_name,
+            edges: method.references
+          )
+        end
+        graph
+      end
+    end
+
+    def matrix(graph)
+      Society::Matrix.new(graph.nodes)
+    end
+
+    def reset_output_directory
+    end
+
+  end
+
+end

data/lib/society/version.rb

@@ -0,0 +1,3 @@
+module Society
+  VERSION = "0.13.0"
+end

data/society.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'society/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "society"
+  spec.version       = Society::VERSION
+  spec.authors       = ["Coraline Ada Ehmke", "Kerri Miller"]
+  spec.email         = ["coraline@instructure.com", "kerrizor@gmail.com"]
+  spec.summary       = %q{Social graph for Ruby objects}
+  spec.description   = %q{Social graph for Ruby objects}
+  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 "fukuzatsu", ">= 1.0.5"
+  spec.add_dependency "parser"
+  spec.add_dependency "rainbow"
+  spec.add_dependency "terminal-table"
+  spec.add_dependency "thor"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+
+end

data/spec/analyzer_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Society::Analyzer do
+
+  let(:source) { File.open("./spec/fixtures/foo.rb", "r").read }
+  let(:analyzer) { Society::Analyzer.new(source) }
+
+  describe "#initialize" do
+    it "assigns its content" do
+      expect(analyzer.content).to eq(source)
+    end
+  end
+
+  describe "#class_name" do
+    xit "doesn't get confused by multiple class declarations in one file"
+
+    it "returns a class name" do
+      expect(analyzer.class_name).to eq "Foo"
+    end
+  end
+
+  describe "#methods" do
+    it "returns a list of methods from its source" do
+      expected = ["#penultimate_method", "#initial_method", "#external_call", "#ultimate_method"]
+      expect(analyzer.methods.map(&:name)).to eq(expected)
+    end
+  end
+
+  describe "constants" do
+    it "returns a list of classes" do
+      expected = ["Bar"]
+      expect(analyzer.constants).to eq(expected)
+    end
+  end
+
+end

data/spec/fixtures/bar.rb

@@ -0,0 +1,6 @@
+class Bar
+
+  def say_hello
+  end
+
+end

data/spec/fixtures/foo.rb

@@ -0,0 +1,22 @@
+class Foo
+
+  def penultimate_method
+    ultimate_method
+  end
+
+  def initial_method
+    penultimate_method
+    penultimate_method
+    penultimate_method
+  end
+
+  def external_call
+    Bar.new.say_hello
+  end
+
+  private
+
+  def ultimate_method
+    self.to_s
+  end
+end

data/spec/matrix_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Society::Matrix do
+
+  let(:node)   { Struct.new(:name, :references)}
+  let(:nodes)  {
+    [
+      node.new("foo", %w{bar bat baz}),
+      node.new("bar", %w{foo bat baz})
+    ]
+  }
+  let(:matrix) { Society::Matrix.new(nodes) }
+
+  describe "#initialize" do
+    it "assigns its nodes" do
+      expect(matrix.nodes).to eq(nodes)
+    end
+  end
+
+  describe "#to_json" do
+    it "generates a json representation" do
+      expected = "{\"names\":[\"foo\",\"bar\"],\"matrix\":[[],[0,1],[1,0]]}"
+      expect(matrix.to_json).to eq(expected)
+    end
+  end
+
+end

data/spec/node_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Society::Node do
+
+  let(:node) { Society::Node.new(
+      name:     "Foo",
+      address:  "./foo.rb",
+      edges:    %w{Bar Bat}
+    )
+  }
+
+  describe "#initialize" do
+    it "assigns its name" do
+      expect(node.name).to eq("Foo")
+    end
+    it "assigns its address" do
+      expect(node.address).to eq("./foo.rb")
+    end
+    it "assigns its edges" do
+      expect(node.edges).to eq(["Bar", "Bat"])
+    end
+  end
+
+  describe "#edge_count" do
+    it "returns a count of its edges" do
+      expect(node.edge_count).to eq 2
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'simplecov'
+
+SimpleCov.start
+
+require 'rubygems'
+require 'rspec'
+require 'society'

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: society
+version: !ruby/object:Gem::Version
+  version: 0.13.0
+platform: ruby
+authors:
+- Coraline Ada Ehmke
+- Kerri Miller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fukuzatsu
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: parser
+  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: rainbow
+  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: terminal-table
+  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: thor
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: 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: rspec
+  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: simplecov
+  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: Social graph for Ruby objects
+email:
+- coraline@instructure.com
+- kerrizor@gmail.com
+executables:
+- society
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/society
+- lib/society.rb
+- lib/society/analyzer.rb
+- lib/society/cli.rb
+- lib/society/matrix.rb
+- lib/society/node.rb
+- lib/society/object_graph.rb
+- lib/society/parser.rb
+- lib/society/version.rb
+- society.gemspec
+- spec/analyzer_spec.rb
+- spec/fixtures/bar.rb
+- spec/fixtures/foo.rb
+- spec/matrix_spec.rb
+- spec/node_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Social graph for Ruby objects
+test_files:
+- spec/analyzer_spec.rb
+- spec/fixtures/bar.rb
+- spec/fixtures/foo.rb
+- spec/matrix_spec.rb
+- spec/node_spec.rb
+- spec/spec_helper.rb
+has_rdoc: