active_explorer 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06742c7c307e540ef325ad2ac528671d59d9a297
-  data.tar.gz: db6d67d3a4820510613db45a503474583e1edfa2
+  metadata.gz: 350cfdb7eafac2d2671f1d1c61183734237befd0
+  data.tar.gz: b7ab716a5f2423778ff9181cacba93678d90efd8
 SHA512:
-  metadata.gz: 5e57990c0112436d90669f9800e0c81ad2ef155503856d01413c1683b1264db99a975e744a9d57b61d21dae9f1aa0ef2bb29cd0369ec1a5a6991e4c783e73e2f
-  data.tar.gz: aebfa88db865056d5cb26cf1a44dee67924dea329d6f2457f8e909af7afe23e661801eefc4d1906d678e34bfbadb481afd115c9aa741d493a703e88b78589069
+  metadata.gz: 65f14a606e3e393a2dbc862fa0a40f87543edef4f241b0a26e5650a1d4b7b49cd5396d8c896f0ffd86d39ca23879f14d18e1693dec5d492b39f36526e2820110
+  data.tar.gz: 128b93d226a28d24113ed9cb1b5d8cd10e897dafd5896ffaf6229131f5242b8fd2837d348e57e28935090af14b72f4aca68ec86c1c9d7b400e754784fe7b57c1

data/README.md

@@ -8,11 +8,24 @@ Active Explorer is a Ruby gem for visualization of run-time data and association
 
 How the gem works? It simply looks for `has_many`, `has_one` and `belongs_to` associations 
 and traverse through them to associated objects. Then it does the same with them until it explores all the surroundings.
-It then prints nice graph represantation to image file (or simple output to console).
+
+It then prints nice graph represantation:
+
+- to image file or
+- to console
 
 One picture is worth a thousand words:
 
-TODO: Add that picture ;)
+![Display hierarchy for Author object.](docs/images/author_books_reviews.png)
+
+And the same objects in console output:
+
+```ruby
+Author(1592) {:first_name=>"Perer", :last_name=>"Brett"}
+  -> has Book(1642) {:author_id=>1592, :title=>"The Warded Man", :year=>2008}
+      -> has Review(796) {:stars=>5, :text=>"Very nice book. Life changing experience.", :book_id=>1642}
+  -> has Book(1643) {:author_id=>1592, :title=>"The Desert Spear", :year=>2010}
+```
 
 ## Installation
 
@@ -51,7 +64,7 @@ exf my_object # Prints output as a graph to image file
 
 Note: `ex` is abbreviation for `explore` and `exf` for `explore_to_file` methods.
 
-See [Examples](#Examples) (or test cases) for more examples.
+See [Examples](#examples) (or test cases) for more examples.
 
 ## Configuration
 
@@ -85,9 +98,9 @@ ex Author.first, class_filter: [:books, :reviews],
 
 Important: Use **plural form** of your classes.
 
-See [Examples](#Examples) (or test cases) see exact usage.
+See [Examples](#examples) (or test cases) see exact usage.
 
-Check [Global Configuration](#Global) to easily set this filter once for all future calls.
+Check [Global Configuration](#global-configuration) to easily set this filter once for all future calls.
 
 ### Global Configuration
 
@@ -195,22 +208,6 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-### Migrations
-
-For testing purposes I use [Standalone Migrations](https://github.com/thuss/standalone-migrations)
-
-Generate new migration:
-
-```
-$ rake db:new_migration name=foo_bar_migration
-```
-
-Create database as usually:
-
-```
-$ rake db:create db:migrate RAILS_ENV=test
-```
-
 ## TODO
 
 - Bug hunt.
@@ -219,9 +216,19 @@ $ rake db:create db:migrate RAILS_ENV=test
 - Interactive graph.
 - Rubymine plugin ;)
 
+## Known Issues
+
+### Timeout in Debugger
+
+When calling `exf` during debugging session in Rubymine, gem returns timeout error. Apart from this message everything works. The image gets saved and it is saved far before the timeout appears.
+
+It seems that it has something to do with Ruby GraphViz gem.
+
+If you have any hint on this please contact me.
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/active-explorer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/rascasone/active_explorer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 
 ## License

data/Rakefile

@@ -2,6 +2,3 @@ require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
 
 # RSpec::Core::RakeTask.new(:spec)
-
-require 'standalone_migrations'
-StandaloneMigrations::Tasks.load_tasks

data/active_explorer.gemspec

@@ -29,10 +29,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-nc"
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "sqlite3"
   spec.add_development_dependency 'ruby-graphviz', '~> 1.2', '>= 1.2.2'
-  spec.add_development_dependency 'mysql'
-  spec.add_development_dependency 'standalone_migrations'
   spec.add_development_dependency 'awesome_print'
   spec.add_development_dependency 'factory_girl'
   spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'pry'
 end

data/lib/active_explorer/version.rb

@@ -1,3 +1,3 @@
 module ActiveExplorer
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/exploration.rb

@@ -43,8 +43,10 @@ module ActiveExplorer
         @class_filter = class_filter || ActiveExplorer::Config.class_filter
         @class_filter = { show: @class_filter } if @class_filter.is_a?(Array)
 
-        [:show, :ignore].each do |group|
-          @class_filter[group] = @class_filter[group].present? ? each_val_to_s(@class_filter[group]) : []
+        if @class_filter
+          [:show, :ignore].each do |group|
+            @class_filter[group] = @class_filter[group].present? ? each_val_to_s(@class_filter[group]) : []
+          end
         end
 
         @association_filter = association_filter || ActiveExplorer::Config.association_filter

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_explorer
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Marek Ulicny
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-08 00:00:00.000000000 Z
+date: 2016-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-graphviz
@@ -123,41 +123,41 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ruby-graphviz
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.2
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: mysql
+  name: ruby-graphviz
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.2
 - !ruby/object:Gem::Dependency
-  name: standalone_migrations
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -171,7 +171,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: factory_girl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -185,7 +185,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: factory_girl
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -199,7 +199,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -237,6 +237,7 @@ files:
 - active_explorer.gemspec
 - bin/console
 - bin/setup
+- docs/images/author_books_reviews.png
 - gemfiles/activerecord_3_0.gemfile
 - gemfiles/activerecord_3_0.gemfile.lock
 - gemfiles/activerecord_3_1.gemfile