society 0.13.2 → 1.0.0

data/spec/fixtures/foo.rb

@@ -1,22 +1,10 @@
-class Foo
+class Whaler
 
-  def penultimate_method
-    ultimate_method
-  end
-
-  def initial_method
-    penultimate_method
-    penultimate_method
-    penultimate_method
-  end
+  attr_accessor :name, :position
 
-  def external_call
-    Bar.new.say_hello
+  def initialize(name:, position: )
+    @name = name
+    @position = position
   end
 
-  private
-
-  def ultimate_method
-    self.to_s
-  end
-end
+end

data/spec/formatter/graph/json_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'analyst'
+
+describe Society::Formatter::Graph::JSON do
+
+  let(:graph) { Struct.new(:nodes, :edges)}
+  let(:node) { Struct.new(:full_name) }
+  let(:edge) { Struct.new(:from, :to) }
+
+  let(:node_instance_1) { node.new("sample_node")}
+  let(:node_instance_2) { node.new("other_node")}
+  let(:edge_instance) { edge.new(node_instance_1, node_instance_2) }
+
+  let(:graph_instance) { graph.new(
+      [node_instance_1, node_instance_2],
+      [edge_instance]
+    )
+  }
+
+  let(:formatter) { Society::Formatter::Graph::JSON.new(graph_instance) }
+
+  describe "#to_hash" do
+
+    let(:hash) { formatter.to_hash }
+
+    context "returns a hash" do
+      it "with properly formatted nodes" do
+        expect(hash[:nodes]).to eq(
+          [
+            {name: "sample_node"},
+            {name: "other_node"}
+          ]
+        )
+      end
+
+      it "with properly formatted edges" do
+        expect(hash[:edges]).to eq([{from: 0, to: 1}])
+      end
+    end
+  end
+
+  describe "#to_json" do
+
+    let(:json) { formatter.to_json }
+    let(:hash) { formatter.to_hash }
+
+    it "returns json string for the result of #to_hash" do
+      expect(json).to eq hash.to_json
+    end
+  end
+end
+

data/spec/formatter/report/html_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe Society::Formatter::Report::HTML do
+
+  before do # don't actually change the filesystem
+    allow(FileUtils).to receive(:mkpath)
+    allow(File).to receive(:open)
+  end
+
+  let(:json_data) { {foo: 'bar'}.to_json }
+
+  describe "(private) #prepare_output_directory" do
+
+    context "with output directory specified" do
+
+      let(:output_directory) { "./doc" }
+      let(:report) do
+        Society::Formatter::Report::HTML.new(
+          json_data: json_data,
+          output_path: output_directory
+        )
+      end
+
+      it "creates the output directory" do
+        output_directory_matcher = Regexp.new(output_directory)
+        expect(FileUtils).to receive(:mkpath).with(output_directory_matcher)
+        report.send(:prepare_output_directory)
+      end
+    end
+
+    context "with no output directory specified" do
+
+      let(:default_directory) { File.join(%w[doc society]) }
+      let(:report) do
+        Society::Formatter::Report::HTML.new(
+          json_data: json_data
+        )
+      end
+
+      it "creates the default output directory" do
+        default_directory_matcher = Regexp.new(default_directory)
+        expect(FileUtils).to receive(:mkpath).with(default_directory_matcher)
+        report.send(:prepare_output_directory)
+      end
+    end
+  end
+
+  describe "#write" do
+    let(:output_directory) { "./doc" }
+    let(:report) do
+      Society::Formatter::Report::HTML.new(
+        json_data: json_data,
+        output_path: output_directory
+      )
+    end
+    let(:society_css_path) { Regexp.new(File.join(%w[society-assets society.css])) }
+    let(:society_js_path) { Regexp.new(File.join(%w[society-assets society.js])) }
+    let(:d3_js_path) { Regexp.new(File.join(%w[d3 d3.min.js])) }
+    let(:output_directory_matcher) { Regexp.new(output_directory) }
+
+    it "copies bower assets to output dir" do
+      expect(FileUtils).to receive(:cp).with(society_css_path, output_directory_matcher)
+      expect(FileUtils).to receive(:cp).with(society_js_path, output_directory_matcher)
+      expect(FileUtils).to receive(:cp).with(d3_js_path, output_directory_matcher)
+      report.write
+    end
+
+    it "writes the html index file" do
+      index_path_matcher = Regexp.new('index.htm')
+      expect(File).to receive(:open).with(index_path_matcher, 'w')
+      report.write
+    end
+  end
+end
+

data/spec/formatter/report/json_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Society::Formatter::Report::Json do
+
+  before do # don't actually change the filesystem
+    allow(FileUtils).to receive(:mkpath)
+    allow(File).to receive(:open)
+  end
+
+  let(:json_data) { {foo: 'bar'}.to_json }
+
+  describe "(private) #prepare_output_directory" do
+    context "with output path specified" do
+
+      let(:output_path) { File.join(%w[blah mah_data.json]) }
+      let(:report) do
+        Society::Formatter::Report::Json.new(
+          json_data: json_data,
+          output_path: output_path
+        )
+      end
+
+      it "creates the output directory" do
+        output_directory_matcher = /blah/
+        expect(FileUtils).to receive(:mkpath).with(output_directory_matcher)
+        report.send(:prepare_output_directory)
+      end
+    end
+
+    context "with no output path specified" do
+
+      let(:default_output_directory) { File.join(%w[doc society TIMESTAMP]) }
+      let(:report) do
+        Society::Formatter::Report::Json.new(
+          json_data: json_data
+        )
+      end
+
+      it "creates the default directory" do
+        private_timestamp = report.send(:timestamp)
+        output_directory = default_output_directory.gsub('TIMESTAMP', private_timestamp)
+        default_directory_matcher = Regexp.new(output_directory)
+
+        expect(FileUtils).to receive(:mkpath).with(default_directory_matcher)
+        report.send(:prepare_output_directory)
+      end
+    end
+  end
+
+  describe "#write" do
+
+    let(:output_path) { File.join(%w[blah mah_data.json]) }
+    let(:report) do
+      Society::Formatter::Report::Json.new(
+        json_data: json_data,
+        output_path: output_path
+      )
+    end
+
+    let(:open_file) { double }
+
+    it "writes the json data" do
+      expect(File).to receive(:open).with(output_path, 'w') do |path, mode, &block|
+        block.yield open_file
+      end
+      expect(open_file).to receive(:write).with(json_data)
+      report.write
+    end
+  end
+end

data/spec/object_graph_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+require 'analyst'
+
+describe Society::ObjectGraph do
+
+  let(:graph) { Struct.new(:nodes, :edges)}
+  let(:node) { Struct.new(:full_name) }
+  let(:edge) { Struct.new(:from, :to) }
+
+  let(:node_instance_1) { node.new("sample_node")}
+  let(:node_instance_2) { node.new("other_node")}
+  let(:edge_instance) { edge.new(node_instance_1, node_instance_2) }
+
+  let(:graph) { Society::ObjectGraph.new(
+      nodes: [node_instance_1, node_instance_2],
+      edges: [edge_instance]
+    )
+  }
+
+  describe "#initialize" do
+    it "initializes its nodes" do
+      expect(graph.nodes.first.full_name).to eq "sample_node"
+    end
+    it "initializes its edges"  do
+      expect(graph.edges.first.to.full_name).to eq "other_node"
+    end
+
+  end
+
+end

data/spec/parser_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Society::Parser do
+
+  describe "::for_files" do
+
+    it "returns a parser object" do
+      expect(Society::Parser.for_files('./spec/fixtures').class.name).to eq("Society::Parser")
+    end
+
+    it "initializes the parser with an Analyzer object" do
+      expect(Society::Parser.for_files('./spec/fixtures').analyzer.class.name).to eq("Analyst::Parser")
+    end
+
+  end
+
+  describe "::for_source" do
+
+    let(:source) { "class Ship; end" }
+
+    it "returns a parser object" do
+      expect(Society::Parser.for_source(source).class.name).to eq("Society::Parser")
+    end
+
+    it "initializes the parser with an Analyzer object" do
+      expect(Society::Parser.for_source(source).analyzer.class.name).to eq("Analyst::Parser")
+    end
+
+  end
+
+  describe "#report" do
+
+    let(:parser) { Society::Parser.new(nil) }
+    let(:formatter) { double.as_null_object }
+
+    before do
+      allow(parser).to receive(:json_data).and_return('{"json": "is kewl"}')
+    end
+
+    context "with a valid format given" do
+      it "instantiates a formatter" do
+        expect(Society::Formatter::Report::HTML).to receive(:new).and_return(formatter)
+        parser.report(:html)
+      end
+
+      it "triggers the formatter to write its results" do
+        allow(Society::Formatter::Report::Json).to receive(:new).and_return(formatter)
+        expect(formatter).to receive(:write)
+        parser.report(:json)
+      end
+    end
+
+    context "with an invalid format given" do
+      it "raises an ArgumentError" do
+        expect { parser.report(:haiku) }.to raise_error(ArgumentError)
+      end
+    end
+
+  end
+
+end

data/spec/reference_processor_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Society::ReferenceProcessor do
+
+  describe "#references" do
+
+    let(:proxy)     { Struct.new(:name, :full_name, :constants, :constant_assignments) }
+    let(:avatar_1)  { proxy.new("AnimalMan", "Red::AnimalMan", [], []) }
+    let(:avatar_2)  { proxy.new("Arcane", "Rot::Arcane", [], []) }
+    let(:avatar_3)  { proxy.new("SwampThing", "Green::SwampThing", [avatar_1, avatar_2], []) }
+    let(:processor) { Society::ReferenceProcessor.new([avatar_1, avatar_2, avatar_3]) }
+
+    it "returns referenced classes" do
+      expect(processor.references.map(&:to)).to eq([avatar_1, avatar_2])
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -5,3 +5,6 @@ SimpleCov.start
 require 'rubygems'
 require 'rspec'
 require 'society'
+require 'byebug'
+require 'awesome_print'
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: society
 version: !ruby/object:Gem::Version
-  version: 0.13.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Coraline Ada Ehmke
@@ -9,22 +9,36 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-22 00:00:00.000000000 Z
+date: 2014-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: fukuzatsu
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.5
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: analyst
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.5
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
@@ -151,6 +165,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: awesome_print
+  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
@@ -160,6 +202,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".bowerrc"
 - ".gitignore"
 - ".rspec"
 - CODE_OF_CONDUCT.md
@@ -168,18 +211,34 @@ files:
 - README.md
 - Rakefile
 - bin/society
+- bower.json
 - lib/society.rb
+- lib/society/association_processor.rb
 - lib/society/cli.rb
-- lib/society/matrix.rb
-- lib/society/node.rb
+- lib/society/edge.rb
+- lib/society/formatter/graph/json.rb
+- lib/society/formatter/report/html.rb
+- lib/society/formatter/report/json.rb
+- lib/society/formatter/report/templates/components/.gitignore
+- lib/society/formatter/report/templates/components/d3/d3.min.js
+- lib/society/formatter/report/templates/components/society-assets/society.css
+- lib/society/formatter/report/templates/components/society-assets/society.js
+- lib/society/formatter/report/templates/index.htm.haml
 - lib/society/object_graph.rb
 - lib/society/parser.rb
+- lib/society/reference_processor.rb
 - lib/society/version.rb
 - society.gemspec
-- spec/fixtures/bar.rb
+- society_graph.json
+- spec/association_processor_spec.rb
+- spec/cli_spec.rb
 - spec/fixtures/foo.rb
-- spec/matrix_spec.rb
-- spec/node_spec.rb
+- spec/formatter/graph/json_spec.rb
+- spec/formatter/report/html_spec.rb
+- spec/formatter/report/json_spec.rb
+- spec/object_graph_spec.rb
+- spec/parser_spec.rb
+- spec/reference_processor_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Bantik/society
 licenses:
@@ -206,9 +265,14 @@ signing_key:
 specification_version: 4
 summary: Social graph for Ruby objects
 test_files:
-- spec/fixtures/bar.rb
+- spec/association_processor_spec.rb
+- spec/cli_spec.rb
 - spec/fixtures/foo.rb
-- spec/matrix_spec.rb
-- spec/node_spec.rb
+- spec/formatter/graph/json_spec.rb
+- spec/formatter/report/html_spec.rb
+- spec/formatter/report/json_spec.rb
+- spec/object_graph_spec.rb
+- spec/parser_spec.rb
+- spec/reference_processor_spec.rb
 - spec/spec_helper.rb
 has_rdoc: