society 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 673c9e8f1e17a3c47e6605eeaa6e7a70ac9740da
-  data.tar.gz: 63318b570c05e025cbcb26375d9e57ac5dba42be
+  metadata.gz: 5076fd6cc424a742b05b87b217180db69db82834
+  data.tar.gz: f100e43bbfd76036aa5b67e45c4a6c64055fd702
 SHA512:
-  metadata.gz: c2098f06fb8b71b4eef9d0a89eef8c1505b30b98c1a9ef9cf48e0e6a3e15e60e6b84f48b42f512b66ec4e8ad9101f099226851b7bfdc0e34507d2b3517266a6a
-  data.tar.gz: 871e375bf40378a6592ba6d26d6cf35e765ab26f52e55de508021362ce68420cfa00572757925d1e7ccb32d18644430504ef2888b40a375e92a919c27caf5716
+  metadata.gz: a321c55fcf87e30575eea746f84b4864edbc34d698c0f9417042398b6fed6eef3f5ae66d6e36b83e18e4b565d92db6693afb5a2304d01bf401c200893f1eea65
+  data.tar.gz: 743e9ddb3579546dbac9e5531e4ae0b0fedeb173ff3d7eba7941712d6ba5d41afb96863d42901e6d9beb5a335ae67f7c8553e778145694b44b30e3cae44a04a1

data/README.md

@@ -1,9 +1,19 @@
 # Society
 
-Society analyzes and presents a social graph of relationships between classes in a Ruby or Rails project.
+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.
 
+## Sample output
+
+### Network graph
+
+![Network graph][network]
+
+### Heatmap
+
+![Heatmap][heatmap]
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -26,7 +36,9 @@ From your terminal:
 
 and then open `doc/society/index.htm` in your browser.
 
-For more complex applications, society also supports file globbing.
+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
 JSON by passing `--format json`
@@ -50,3 +62,6 @@ By participating in this project you agree to abide by its terms.
 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
+
+[network]: https://raw.githubusercontent.com/CoralineAda/society/master/network_graph.png "Sample network graph"
+[heatmap]: https://raw.githubusercontent.com/CoralineAda/society/master/heatmap.png "Sample heatmap"

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

@@ -47,6 +47,9 @@
       #tabs-2
         %div
           %h2 Heatmap
+          %p.instructions
+            Order by frequency to see how strong the relation between two classes is.
+            Order by hierarchy to visualize the relations in hierarchical clustering.
         #heatmap
     :javascript
       var data = JSON.parse('#{json_data}');

data/lib/society/version.rb

@@ -1,3 +1,3 @@
 module Society
-  VERSION = "1.5.0"
+  VERSION = "1.5.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: society
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Coraline Ada Ehmke
@@ -197,6 +197,7 @@ files:
 - README.md
 - Rakefile
 - bin/society
+- heatmap.png
 - lib/society.rb
 - lib/society/cli.rb
 - lib/society/edge.rb
@@ -211,6 +212,7 @@ files:
 - lib/society/object_graph.rb
 - lib/society/parser.rb
 - lib/society/version.rb
+- network_graph.png
 - society.gemspec
 - spec/cli_spec.rb
 - spec/fixtures/for_parser_spec/whaler.rb