society 1.6 → 1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d5405b409b32bc4c1fbcdcd16045f6e89f914dc0
-  data.tar.gz: 37a9b9232cb5ad32076b44b93a79d23d8dfbecaf
+SHA256:
+  metadata.gz: 528e86c646a2d410350036ae115b42446814588b8db6f0ed5213a9c4aa06f6b9
+  data.tar.gz: 3a909c1be6b6f52d753ed2ca4f7e566bc3873a7bb6f6b50b548033ac411b9828
 SHA512:
-  metadata.gz: 16e7aa59852b0fc41fe030d3d65794cb9db6d9f1ff14897ea6f2e2cc08402456c30921b99acaf7931f978eba1d5427d79d3585724455fda8d184722a3a343109
-  data.tar.gz: fbb2a78386bbc8642fdc036e6a216430814c3df7052afb9ab8e5b6042224d58153737ed04e3f02eb449f55a474f2822e5e46cde94140d14e107619b9ff8c0179
+  metadata.gz: 410d5b6562be164fda0b715d6de2ace7d1c6eac2dd83be2e76545e1c0a3ff31bfc6171f19ea9b44f1d2fa195fb3dda1e82284c79cf42e4658d85ac0048ba9d2c
+  data.tar.gz: 1cd4bb7ea504a6610ce84984f37a995f4ee09637265a29f68384d5e7ee61ed0a66dafeff18c0dcbcdc7657a097728654033f3bf08e7be22c5abeda7c511c0f9e

data/README.md

@@ -1,6 +1,6 @@
 # Society
 
-Society analyzes and presents social graphs of relationships between classes in a Ruby or Rails project. It displays relationships that are either explicitly declared (e.g. in an ActiveRecord relation) or defined by calls between classes (e.g. in the source of ClassA there is a call to ClassB). 
+Society analyzes and presents social graphs of relationships between classes in a Ruby or Rails project. It displays relationships that are either explicitly declared (e.g. in an ActiveRecord relation) or defined by calls between classes (e.g. in the source of ClassA there is a call to ClassB).
 
 Please note that Society requires Ruby 2.1 or later.
 
@@ -18,7 +18,9 @@ Please note that Society requires Ruby 2.1 or later.
 
 Add this line to your application's Gemfile:
 
-    gem 'society'
+```ruby
+gem 'society'
+```
 
 And then execute:
 
@@ -32,15 +34,15 @@ Or install it yourself as:
 
 From your terminal:
 
-    society from path/to/models [more/paths/if/applicable]
+    $ society from path/to/models [more/paths/if/applicable]
 
-and then open `doc/society/index.htm` in your browser.
+and then open `doc/society/index.htm` or `doc/society/society.csv` in your browser.
 
 For more complex applications, society also supports file globbing:
 
     society from ../path/to/models/*user*
 
-The default format is HTML; you can skip the HTML interface and just get the
+The default format is HTML and CSV; you can skip the HTML interface and just get the
 JSON by passing `--format json`
 
 Note that all JSON data is timestamped (regardless of output format) to store

data/lib/society.rb

@@ -9,6 +9,7 @@ require_relative "society/node"
 require_relative "society/object_graph"
 require_relative "society/formatter/report/html"
 require_relative "society/formatter/report/json"
+require_relative "society/formatter/report/csv"
 require_relative "society/parser"
 require_relative "society/version"
 
@@ -19,4 +20,3 @@ module Society
   end
 
 end
-

data/lib/society/cli.rb

@@ -5,7 +5,7 @@ module Society
 
   class CLI < Thor
 
-    desc_text = "Formats are html (default) and json."
+    desc_text = "Formats are html (default), json, and csv."
     desc_text << "Example: society from foo/ -f json -o ./society_data.json"
 
     desc "from PATH_TO_FILE [-f FORMAT] [-o OUTPUT_PATH]", desc_text

data/lib/society/formatter/report/csv.rb

@@ -0,0 +1,40 @@
+module Society
+  module Formatter
+    module Report
+      class CSV
+
+        attr_reader :csv_data, :output_path
+
+        def initialize(csv_data:, output_path: nil)
+          @csv_data = csv_data
+          @output_path = output_path
+        end
+
+        def write
+          if output_path
+            prepare_output_directory
+            write_csv_data
+          else
+            puts csv_data
+          end
+        end
+
+        private
+
+        def timestamp
+          @timestamp ||= Time.now.strftime("%Y_%m_%d_%H_%M_%S")
+        end
+
+        def prepare_output_directory
+          raise "No output path was specified" if output_path.nil?
+          directory_path = File.split(output_path).first
+          FileUtils.mkpath directory_path
+        end
+
+        def write_csv_data
+          File.open(output_path, 'w') { |file| file.write csv_data }
+        end
+      end
+    end
+  end
+end

data/lib/society/formatter/report/html.rb

@@ -13,6 +13,7 @@ module Society
         def write
           prepare_output_directory
           write_html
+          write_csv
           copy_assets
           write_json_data
           puts "Results written to #{self.output_path}." unless self.output_path.nil?
@@ -28,6 +29,10 @@ module Society
           File.open(File.join(output_path, 'index.htm'), 'w') {|outfile| outfile.write(index)}
         end
 
+        def write_csv
+          File.open(File.join(output_path, 'society.csv'), 'w') {|outfile| outfile.write(csv)}
+        end
+
         def copy_assets
           bower_dir = File.join(File.dirname(__FILE__), 'templates', 'components')
           FileUtils.cp(
@@ -50,6 +55,17 @@ module Society
           )
         end
 
+        def csv
+          Haml::Engine.new(csv_template).render(
+            Object.new, json_data: json_data
+          )
+        end
+
+        def csv_template
+          path = File.join(File.dirname(__FILE__), 'templates', 'society.csv.haml')
+          File.read(path)
+        end
+
         def template
           path = File.join(File.dirname(__FILE__), 'templates', 'index.htm.haml')
           File.read(path)

data/lib/society/formatter/report/templates/society.csv.haml

@@ -0,0 +1,4 @@
+Model, Coupled Model, Weight
+- JSON.parse(json_data).sort{|a,b| a[0] <=> b[0]}.each do |node, edges|
+  - edges.each do |edge|
+    #{node},#{edge[0]},#{edge[1]}

data/lib/society/parser.rb

@@ -476,7 +476,7 @@ module Society
 
     FORMATTERS = {
       html: Society::Formatter::Report::HTML,
-      json: Society::Formatter::Report::Json
+      json: Society::Formatter::Report::Json,
     }
 
     # Internal: List known output formatters.

data/lib/society/version.rb

@@ -1,3 +1,3 @@
 module Society
-  VERSION = "1.6"
+  VERSION = "1.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: society
 version: !ruby/object:Gem::Version
-  version: '1.6'
+  version: '1.7'
 platform: ruby
 authors:
 - Coraline Ada Ehmke
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-17 00:00:00.000000000 Z
+date: 2018-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -201,6 +201,7 @@ files:
 - lib/society.rb
 - lib/society/cli.rb
 - lib/society/edge.rb
+- lib/society/formatter/report/csv.rb
 - lib/society/formatter/report/html.rb
 - lib/society/formatter/report/json.rb
 - lib/society/formatter/report/templates/components/.gitignore
@@ -208,6 +209,7 @@ files:
 - 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/formatter/report/templates/society.csv.haml
 - lib/society/node.rb
 - lib/society/object_graph.rb
 - lib/society/parser.rb
@@ -241,7 +243,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Social graph for Ruby objects