society 0.13.2 → 1.0.0

data/lib/society/formatter/report/templates/index.htm.haml

@@ -0,0 +1,48 @@
+!!!
+%html
+  %head
+    %meta{:charset => "utf-8"}
+      %title Society Relational Analysis
+      :css
+        @import url(stylesheets/society.css);
+      %script{:src => "javascripts/d3.min.js"}
+      %script{:src => "javascripts/society.js"}
+      :css
+        body {
+          background-color: #fff;
+          padding: 1em;
+          font-family: Consolas, Verdana, sans-serif;
+          font-size: 12px;
+        }
+  %body
+    %div{:style => "text-align: center;"}
+      %h1 Relational Matrices
+      %h3
+        Generated by
+        %a{:href => "https://github.com/Bantik/society"} Society
+    %hr{:size => "1"}/
+    %div{:style => "text-align: center;"}
+      %h2 Heatmap
+    #heatmap
+    %hr{:size => "1"}/
+    %div{:style => "text-align: center;"}
+      %h2 Network
+      %p
+        %em
+          Hover over a class name to see incoming references (green) and outgoing
+          references (red).
+    #network{:style => "height: 100%; width: 100%;"}
+    :javascript
+      var data = JSON.parse('#{json_data}');
+      Society.generate("#network", {
+        data: {
+          json: data
+        }
+      });
+      Society.generate("#heatmap", {
+        type: "heatmap",
+        data: {
+          json: data
+        }
+      });
+

data/lib/society/object_graph.rb

@@ -2,10 +2,11 @@ module Society
 
   class ObjectGraph
 
-    attr_accessor :nodes
+    attr_accessor :nodes, :edges
 
-    def initialize(nodes: nodes=[])
+    def initialize(nodes: nodes=[], edges: edges=[])
       @nodes = nodes
+      @edges = edges
     end
 
   end

data/lib/society/parser.rb

@@ -1,52 +1,69 @@
-require 'fukuzatsu'
-
 module Society
 
-  class Parser < Fukuzatsu::Parser
+  class Parser
+
+    def self.for_files(file_path)
+      new(::Analyst.for_files(file_path))
+    end
+
+    def self.for_source(source)
+      new(::Analyst.for_source(source))
+    end
+
+    attr_reader :analyzer
+
+    def initialize(analyzer)
+      @analyzer = analyzer
+    end
+
+    def report(format, output_path=nil)
+      raise ArgumentError, "Unknown format #{format}" unless known_formats.include?(format)
+      options = { json_data: json_data }
+      options[:output_path] = output_path unless output_path.nil?
+      FORMATTERS[format].new(options).write
+    end
+
+    private
 
-    attr_reader :parsed_files
+    FORMATTERS = {
+      html: Society::Formatter::Report::HTML,
+      json: Society::Formatter::Report::Json
+    }
 
-    def initialize(start_path)
-      super(start_path, :none, 0)
-      @parsed_files = parse_files
+    def classes
+      @classes ||= analyzer.classes
     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
+        associations = associations_from(classes) + references_from(classes)
+        # TODO: merge identical classes, and (somewhere else) deal with
+        #       identical associations too. need a WeightedEdge, and each
+        #       one will be unique on [from, to], but will have a weight
+
+        ObjectGraph.new(nodes: classes, edges: associations)
       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
+    def json_data
+      Society::Formatter::Graph::JSON.new(class_graph).to_json
+    end
+
+    def known_formats
+      FORMATTERS.keys
     end
 
-    def matrix(graph)
-      Society::Matrix.new(graph.nodes)
+    def associations_from(all_classes)
+      @association_processor ||= AssociationProcessor.new(all_classes)
+      @association_processor.associations
     end
 
-    def reset_output_directory
+    def references_from(all_classes)
+      @reference_processor ||= ReferenceProcessor.new(all_classes)
+      @reference_processor.references
     end
 
   end
 
 end
+

data/lib/society/reference_processor.rb

@@ -0,0 +1,60 @@
+module Society
+
+  class ReferenceProcessor
+
+    attr_reader :classes, :references, :unresolved_references
+
+    def initialize(classes)
+      @classes = classes
+      @references = []
+      @unresolved_references = []
+      process
+    end
+
+    private
+
+    def process
+      classes.each do |klass|
+        klass.constants.each do |const|
+          if assigned_constant(const, klass)
+            next
+          elsif target = perfect_match_for(const)
+            @references << Edge.new(from: klass,
+                                    to: target,
+                                    meta: {
+                                      type: :perfect,
+                                      entity: const})
+          elsif target = partial_match_for(const)
+            @references << Edge.new(from: klass,
+                                    to: target,
+                                    meta: {
+                                      type: :partial,
+                                      entity: const})
+          else
+            @unresolved_references << { class: klass,
+                                        target_name: const.full_name,
+                                        constant: const }
+          end
+        end
+      end
+    end
+
+    def perfect_match_for(const)
+      classes.detect { |klass| klass.full_name == const.name }
+    end
+
+    def partial_match_for(const)
+      partial_matches = classes.select do |klass|
+        klass.full_name.include? const.full_name
+      end
+      partial_matches.first if partial_matches.size == 1
+    end
+
+    def assigned_constant(const, klass)
+      klass.constant_assignments.map(&:name).include? const.name
+    end
+
+  end
+
+end
+

data/lib/society/version.rb

@@ -1,3 +1,3 @@
 module Society
-  VERSION = "0.13.2"
+  VERSION = "1.0.0"
 end

data/society.gemspec

@@ -18,7 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "fukuzatsu", ">= 1.0.5"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "analyst", ">= 1.0.0"
   spec.add_dependency "parser"
   spec.add_dependency "rainbow"
   spec.add_dependency "terminal-table"
@@ -29,5 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "awesome_print"
 
 end

data/society_graph.json

@@ -0,0 +1 @@
+{"nodes":[{"name":"Account"},{"name":"Attachment"},{"name":"Attempt"},{"name":"Auth"},{"name":"Certificate"},{"name":"Collection"},{"name":"CollectionEnrollment"},{"name":"CollectionGroupEnrollment"},{"name":"CollectionItem"},{"name":"ConcreteConfig"},{"name":"CourseTemplate"},{"name":"CustomField"},{"name":"EnrollingMembership"},{"name":"Enrollment"},{"name":"Group"},{"name":"GroupEnrollment"},{"name":"ImportObject"},{"name":"LearnerCourse"},{"name":"LearnerCustomFieldValue"},{"name":"LearnerFile"},{"name":"LearnerLibraryCourse"},{"name":"LearnerLiveCourse"},{"name":"LearnerSlide"},{"name":"LiveCourse"},{"name":"LiveCourseEnrollment"},{"name":"LiveCourseEnrollmentSource"},{"name":"LiveCourseGroupEnrollment"},{"name":"LiveCourseSession"},{"name":"LiveCourseSessionRegistration"},{"name":"Manager"},{"name":"Membership"},{"name":"MembershipBuilder"},{"name":"NotifiableEnrollment"},{"name":"NotifiableLiveCourseEnrollment"},{"name":"NotifiableLiveCourseSessionRegistration"},{"name":"Notification"},{"name":"NotificationProfile"},{"name":"PasswordToken"},{"name":"Presence"},{"name":"QuestionAnswer"},{"name":"QuestionHash"},{"name":"QuestionResponse"},{"name":"RequestHost"},{"name":"Rule"},{"name":"RulesAttributesNormalizer"},{"name":"SessionToken"},{"name":"Slide"},{"name":"User"},{"name":"Account::Config"},{"name":"Attempt::NullFurthestSlide"},{"name":"Auth::Basic"},{"name":"Auth::CAS"},{"name":"GroupEnrollment::StatisticsCalculator"},{"name":"QuestionHash::Factoid"},{"name":"QuestionHash::Factoid::MultipleChoiceQuestion"},{"name":"QuestionHash::Factoid::Statement"},{"name":"QuestionHash::Factoid::TrueFalseQuestion"},{"name":"QuestionHash::Glossary"},{"name":"QuestionHash::Glossary::MultipleChoiceQuestion"},{"name":"QuestionHash::Glossary::TrueFalseQuestion"},{"name":"QuestionHash::OrderedList"},{"name":"QuestionHash::OrderedList::MultipleChoiceQuestion"},{"name":"QuestionHash::OrderedList::ReorderQuestion"},{"name":"Rule::InvalidPredicate"},{"name":"RulesAttributesNormalizer::FieldRules"},{"name":"Notifications::AuthorCourseDigest"},{"name":"Notifications::CourseAssignedNotificationBuilder"},{"name":"Notifications::CourseDigest"},{"name":"Notifications::LearnerCourseDigest"},{"name":"Notifications::LiveCourseInvitationNotificationBuilder"},{"name":"Notifications::LiveCourseNotificationBuilder"},{"name":"Notifications::LiveCourseRegisteredForSessionNotificationBuilder"},{"name":"Notifications::LiveCourseSessionNotificationBuilder"},{"name":"Notifications::LiveCourseUnregisteredFromCanceledSessionNotificationBuilder"},{"name":"Notifications::LiveCourseUnregisteredFromSessionNotificationBuilder"},{"name":"Notifications::LiveCourseUnregisteredFromUnattendedSessionNotificationBuilder"},{"name":"Notifications::ManagerCourseDigest"},{"name":"Notifications::NotificationBuilder"},{"name":"Notifications::TimeUntilSessionNotificationBuilder"},{"name":"Reports::CourseStatusReport"},{"name":"Reports::PassRateReport"},{"name":"Reports::ScoreDistributionReport"},{"name":"Scorm::Activity"},{"name":"Scorm::Attempt"},{"name":"Scorm::CourseUploadResponse"},{"name":"Scorm::CourseUploadStatusResponse"},{"name":"Scorm::Enrollment"},{"name":"Scorm::RegistrationListResponse"},{"name":"Scorm::RegistrationResponse"},{"name":"Search::CustomFieldValueSearch"},{"name":"Search::EnrollableSearch"}],"edges":[{"from":0,"to":36},{"from":1,"to":46},{"from":2,"to":46},{"from":2,"to":46},{"from":2,"to":13},{"from":2,"to":41},{"from":5,"to":8},{"from":5,"to":6},{"from":5,"to":7},{"from":6,"to":5},{"from":6,"to":47},{"from":7,"to":5},{"from":7,"to":14},{"from":8,"to":5},{"from":8,"to":10},{"from":10,"to":47},{"from":10,"to":8},{"from":10,"to":15},{"from":10,"to":46},{"from":11,"to":18},{"from":11,"to":43},{"from":13,"to":10},{"from":13,"to":47},{"from":13,"to":2},{"from":13,"to":2},{"from":14,"to":30},{"from":14,"to":15},{"from":14,"to":26},{"from":14,"to":43},{"from":14,"to":7},{"from":15,"to":14},{"from":15,"to":10},{"from":16,"to":47},{"from":18,"to":47},{"from":18,"to":11},{"from":23,"to":47},{"from":23,"to":24},{"from":23,"to":27},{"from":23,"to":26},{"from":24,"to":47},{"from":24,"to":23},{"from":24,"to":25},{"from":24,"to":28},{"from":25,"to":24},{"from":26,"to":23},{"from":26,"to":14},{"from":27,"to":23},{"from":27,"to":28},{"from":28,"to":47},{"from":28,"to":27},{"from":28,"to":24},{"from":29,"to":47},{"from":29,"to":47},{"from":30,"to":14},{"from":30,"to":47},{"from":36,"to":0},{"from":41,"to":2},{"from":41,"to":46},{"from":43,"to":14},{"from":43,"to":11},{"from":45,"to":47},{"from":46,"to":10},{"from":46,"to":41},{"from":46,"to":1},{"from":47,"to":13},{"from":47,"to":10},{"from":47,"to":6},{"from":47,"to":24},{"from":47,"to":28},{"from":47,"to":23},{"from":47,"to":45},{"from":47,"to":30},{"from":47,"to":18},{"from":47,"to":29},{"from":47,"to":29},{"from":5,"to":10},{"from":5,"to":47},{"from":5,"to":14},{"from":10,"to":5},{"from":10,"to":14},{"from":11,"to":47},{"from":13,"to":46},{"from":14,"to":10},{"from":14,"to":23},{"from":14,"to":47},{"from":14,"to":5},{"from":23,"to":47},{"from":24,"to":14},{"from":24,"to":27},{"from":27,"to":47},{"from":47,"to":10},{"from":47,"to":23},{"from":47,"to":14},{"from":47,"to":11},{"from":47,"to":47},{"from":47,"to":47},{"from":0,"to":0},{"from":0,"to":3},{"from":0,"to":48},{"from":0,"to":36},{"from":2,"to":49},{"from":2,"to":22},{"from":2,"to":41},{"from":5,"to":13},{"from":5,"to":10},{"from":6,"to":13},{"from":6,"to":2},{"from":10,"to":46},{"from":12,"to":30},{"from":12,"to":30},{"from":13,"to":46},{"from":13,"to":47},{"from":14,"to":10},{"from":14,"to":14},{"from":14,"to":47},{"from":27,"to":78},{"from":27,"to":78},{"from":27,"to":78},{"from":28,"to":78},{"from":31,"to":30},{"from":31,"to":30},{"from":31,"to":30},{"from":32,"to":86},{"from":32,"to":66},{"from":32,"to":66},{"from":33,"to":69},{"from":33,"to":69},{"from":34,"to":71},{"from":34,"to":78},{"from":34,"to":78},{"from":37,"to":78},{"from":37,"to":78},{"from":37,"to":47},{"from":37,"to":37},{"from":40,"to":40},{"from":40,"to":40},{"from":40,"to":55},{"from":40,"to":40},{"from":40,"to":40},{"from":40,"to":40},{"from":40,"to":40},{"from":41,"to":40},{"from":43,"to":63},{"from":45,"to":45},{"from":47,"to":47},{"from":47,"to":47},{"from":47,"to":5},{"from":47,"to":10},{"from":47,"to":14},{"from":47,"to":23},{"from":53,"to":40},{"from":54,"to":40},{"from":53,"to":40},{"from":56,"to":40},{"from":53,"to":55},{"from":57,"to":40},{"from":58,"to":40},{"from":57,"to":40},{"from":59,"to":40},{"from":60,"to":40},{"from":61,"to":40},{"from":60,"to":40},{"from":62,"to":40},{"from":77,"to":35},{"from":82,"to":82},{"from":82,"to":82},{"from":83,"to":83},{"from":83,"to":83},{"from":83,"to":78},{"from":86,"to":83},{"from":86,"to":83},{"from":90,"to":47},{"from":90,"to":14}]}

data/spec/association_processor_spec.rb

@@ -0,0 +1,174 @@
+require 'spec_helper'
+
+describe Society::AssociationProcessor do
+
+  describe "#associations" do
+
+    context "`belongs_to`, `has_many`, and `has_many through:` associations" do
+      let(:code) {
+        <<-CODE
+          class Assembly < ActiveRecord::Base
+            has_many :manifests
+            has_many :parts, through: :manifests
+          end
+
+          class Manifest < ActiveRecord::Base
+            belongs_to :assembly
+            belongs_to :part
+          end
+
+          class Part < ActiveRecord::Base
+            has_many :manifests
+            has_many :assemblies, through: :manifests
+          end
+        CODE
+      }
+
+      let(:parser) { Society::Parser.for_source(code) }
+      let(:processor) { Society::AssociationProcessor.new(parser.analyzer.classes) }
+      let(:assembly) { processor.classes.detect {|c| c.name == "Assembly" } }
+      let(:manifest) { processor.classes.detect {|c| c.name == "Manifest" } }
+      let(:part) { processor.classes.detect {|c| c.name == "Part" } }
+
+      it "records `has_many` and `has_many through:` associations" do
+        assembly_associations = processor.associations.select { |edge| edge.from == assembly }
+        expect(assembly_associations.map(&:to)).to match_array [manifest, part]
+
+        part_associations = processor.associations.select { |edge| edge.from == part }
+        expect(part_associations.map(&:to)).to eq [manifest, assembly]
+      end
+
+      it "records `belongs_to` associations" do
+        manifest_associations = processor.associations.select { |edge| edge.from == manifest }
+        expect(manifest_associations.map(&:to)).to match_array [assembly, part]
+      end
+    end
+
+    context "associations with `class_name` specified" do
+      let(:code) {<<-CODE
+          class Post < ActiveRecord::Base
+            belongs_to :author, :class_name => "User"
+            belongs_to :editor, :class_name => "User"
+          end
+
+          class User < ActiveRecord::Base
+            has_many :authored_posts, :foreign_key => "author_id", :class_name => "Post"
+            has_many :edited_posts, :foreign_key => "editor_id", :class_name => "Post"
+          end
+        CODE
+      }
+      let(:parser) { Society::Parser.for_source(code) }
+      let(:processor) { Society::AssociationProcessor.new(parser.analyzer.classes) }
+      let(:user) { processor.classes.detect {|c| c.name == "User" } }
+      let(:post) { processor.classes.detect {|c| c.name == "Post" } }
+
+      it "records belongs_to's" do
+        post_associations = processor.associations.select { |edge| edge.from == post }
+        expect(post_associations.map(&:to)).to match_array [user, user]
+      end
+
+      it "records has_many's" do
+        user_associations = processor.associations.select { |edge| edge.from == user }
+        expect(user_associations.map(&:to)).to match_array [post, post]
+      end
+    end
+
+    context "associations with `class_name` or `source` specified" do
+      let(:code) { <<-CODE
+        class Post < ActiveRecord::Base
+          has_many :post_authorings, :foreign_key => :authored_post_id
+          has_many :authors, :through => :post_authorings, :source => :post_author
+          belongs_to :editor, :class_name => "User"
+        end
+
+        class User < ActiveRecord::Base
+          has_many :post_authorings, :foreign_key => :post_author_id
+          has_many :authored_posts, :through => :post_authorings
+          has_many :edited_posts, :foreign_key => :editor_id, :class_name => "Post"
+        end
+
+        class PostAuthoring < ActiveRecord::Base
+          belongs_to :post_author, :class_name => "User"
+          belongs_to :authored_post, :class_name => "Post"
+        end
+      CODE
+      }
+      let(:parser) { Society::Parser.for_source(code) }
+      let(:processor) { Society::AssociationProcessor.new(parser.analyzer.classes) }
+      let(:user) { processor.classes.detect {|c| c.name == "User" } }
+      let(:post) { processor.classes.detect {|c| c.name == "Post" } }
+      let(:post_authoring) { processor.classes.detect {|c| c.name == "PostAuthoring" } }
+
+      it "handles `source` and `class_name` correctly" do
+        post_associations = processor.associations.select { |edge| edge.from == post }
+        expect(post_associations.map(&:to)).to match_array [post_authoring, user, user]
+      end
+
+      it "handles `through` and `class_name` correctly" do
+        user_associations = processor.associations.select { |edge| edge.from == user }
+        expect(user_associations.map(&:to)).to match_array [post_authoring, post, post]
+      end
+
+      it "handles `class_name` correctly" do
+        pa_associations = processor.associations.select { |edge| edge.from == post_authoring }
+        expect(pa_associations.map(&:to)).to match_array [user, post]
+      end
+    end
+
+    context "polymorphic associations" do
+      let(:code) { <<-CODE
+        class Picture < ActiveRecord::Base
+          belongs_to :imageable, polymorphic: true
+        end
+
+        class Employee < ActiveRecord::Base
+          has_many :pictures, as: :imageable
+        end
+
+        class Product < ActiveRecord::Base
+          has_many :pictures, as: :imageable
+        end
+      CODE
+      }
+      let(:parser) { Society::Parser.for_source(code) }
+      let(:processor) { Society::AssociationProcessor.new(parser.analyzer.classes) }
+      let(:picture) { processor.classes.detect {|c| c.name == "Picture" } }
+      let(:employee) { processor.classes.detect {|c| c.name == "Employee" } }
+      let(:product) { processor.classes.detect {|c| c.name == "Product" } }
+
+      it "records the `polymorphic: true` side of the association" do
+        picture_associations = processor.associations.select { |edge| edge.from == picture }
+        expect(picture_associations.map(&:to)).to match_array [employee, product]
+      end
+
+      it "records the `as: :something` side of the asociation" do
+        employee_associations = processor.associations.select { |edge| edge.from == employee }
+        expect(employee_associations.map(&:to)).to match_array [picture]
+
+        product_associations = processor.associations.select { |edge| edge.from == product }
+        expect(product_associations .map(&:to)).to match_array [picture]
+      end
+    end
+
+    context "self joins" do
+      let(:code) {<<-CODE
+        class Employee < ActiveRecord::Base
+          has_many :subordinates, class_name: "Employee",
+                                  foreign_key: "manager_id"
+
+          belongs_to :manager, class_name: "Employee"
+        end
+      CODE
+      }
+      let(:parser) { Society::Parser.for_source(code) }
+      let(:processor) { Society::AssociationProcessor.new(parser.analyzer.classes) }
+      let(:employee) { processor.classes.detect {|c| c.name == "Employee" } }
+
+      it "records self joins" do
+        employee_associations = processor.associations.select { |edge| edge.from == employee }
+        expect(employee_associations.map(&:to)).to match_array [employee, employee]
+      end
+    end
+  end
+end
+

data/spec/cli_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require_relative '../lib/society/cli'
+
+describe Society::CLI do
+
+  describe "#from" do
+
+    let(:parser) { Society::Parser.new(nil) }
+
+    it "invokes Society with a path" do
+      allow(parser).to receive(:report)
+      expect(Society).to receive(:new) { parser }
+      Society::CLI.new.from("./spec/fixtures")
+    end
+
+    it "calls report on a Parser instance" do
+      expect(parser).to receive(:report)
+      allow(Society).to receive(:new) { parser }
+      Society::CLI.new.from("./spec/fixtures")
+    end
+
+  end
+
+end
+