active_explorer 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 06742c7c307e540ef325ad2ac528671d59d9a297
+  data.tar.gz: db6d67d3a4820510613db45a503474583e1edfa2
+SHA512:
+  metadata.gz: 5e57990c0112436d90669f9800e0c81ad2ef155503856d01413c1683b1264db99a975e744a9d57b61d21dae9f1aa0ef2bb29cd0369ec1a5a6991e4c783e73e2f
+  data.tar.gz: aebfa88db865056d5cb26cf1a44dee67924dea329d6f2457f8e909af7afe23e661801eefc4d1906d678e34bfbadb481afd115c9aa741d493a703e88b78589069

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea
+/spec/files/generated

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--format Nc

data/.ruby-gemset

@@ -0,0 +1 @@
+active-explorer

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.standalone_migrations

@@ -0,0 +1,6 @@
+db:
+    seeds: spec/support/db/seeds.rb
+    migrate: spec/support/db/migrate
+    schema: spec/support/db/schema.rb
+config:
+    database: spec/support/db/config.yml

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Appraisals

@@ -0,0 +1,27 @@
+appraise "activerecord-3-0" do
+  gem "activerecord", "~> 3.0.20"
+end
+
+appraise "activerecord-3-1" do
+  gem "activerecord", "~> 3.1.12"
+end
+
+appraise "activerecord-3-2" do
+  gem "activerecord", "~> 3.2.22.2"
+end
+
+appraise "activerecord-4-0" do
+  gem "activerecord", "~> 4.0.13"
+end
+
+appraise "activerecord-4-1" do
+  gem "activerecord", "~> 4.1.15"
+end
+
+appraise "activerecord-4-2" do
+  gem "activerecord", "~> 4.2.6"
+end
+
+appraise "activerecord-5-0" do
+  gem "activerecord", "~> 5.0.0.rc1"
+end

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_explorer.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,27 @@
+
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Marek Ulicny (xulicny@gmail.com), Rascasone (www.rascasone.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,230 @@
+# Active Explorer
+
+Active Explorer is a Ruby gem for visualization of run-time data and associations represented by Active Record.
+
+**NOTE: Only Active Record 4.2.x is currently supported. More versions comming next week. Come back soon ;)** 
+
+**NOTE: This is pre-alpha version. Many things might change.** 
+
+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).
+
+One picture is worth a thousand words:
+
+TODO: Add that picture ;)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_explorer'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install active_explorer
+```
+
+## Usage
+
+In Rails, place this code into `application.rb`:
+
+```ruby
+require "active_explorer"
+```
+
+Call:
+
+```ruby
+ex my_object # Prints output to console
+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.
+
+## Configuration
+
+### Parameters
+
+Only `exf` has:
+
+```ruby
+file_name = nil # When not specified, gem will create file composed of "object class" and "object id", e.g. "book_12.png"
+```
+
+Both `ex` and `exf` have: 
+
+```ruby
+class_filter: nil,          # Allowed or ignored classes 
+attribute_filter: nil,      # Attributes to be displayed (per class setting)
+attribute_limit: nil,       # First "n" attributes to be displayed
+association_filter: nil,    # Which direction to explore (parents, children, all)?
+depth: 5                    # Recursion depth at which to stop
+```
+
+Example:
+
+```ruby
+ex Author.first, class_filter: [:books, :reviews],          
+               attribute_filter: { books: [:id, :title], reviews: [:id, :text] }, 
+               association_filter: [:has_many], 
+               attribute_limit: 5,
+               depth: 10
+```
+
+Important: Use **plural form** of your classes.
+
+See [Examples](#Examples) (or test cases) see exact usage.
+
+Check [Global Configuration](#Global) to easily set this filter once for all future calls.
+
+### Global Configuration
+
+Place this to initializer. E.g. `initializers/active_explorer.rb`:
+
+```ruby
+ActiveExplorer::Config.class_filter = {ignore: [:reviews]}
+ActiveExplorer::Config.attribute_limit = 5
+ActiveExplorer::Config.depth = 10
+```
+
+This configuration will be applied for every call of `ex` or `exf` as if respective parameters were added to the call.
+
+## Examples
+
+All examples assume following data and associations:
+
+```ruby
+Author(1) {:first_name=>"Perer", :last_name=>"Brett"}
+  -> has Book(1) {:author_id=>1, :title=>"The Warded Man", :year=>2008}
+      -> has Review(1) {:stars=>5, :text=>"Very nice book. Life changing experience.", :book_id=>1}
+  -> has Book(2) {:author_id=>1, :title=>"The Desert Spear", :year=>2010}
+```
+
+### Output to Console
+
+Use `ex` to print text output to Console.
+
+```ruby
+ex Book.first
+```
+
+Use this in code or in IRB / Rails Console.
+
+### Output to Image
+
+Use `exf` to print output as a nice graph to image file. Following command generates file `book_1.png` (for Book with id: 1).
+
+```ruby
+exf Book.first
+```
+
+Use this in code or in IRB / Rails Console.
+
+### Class Filter
+
+#### Show
+
+Show only classes that you want.
+
+```ruby
+ex Author.first, class_filter: [:books]
+```
+
+This will only display Author (as a root) and objects of Book class. Processing stops with Book classes and does not go further to parents or children.
+
+Alternative notation using `show` parameter.
+
+```ruby
+ex Author.first, class_filter: { show: [:books] }
+```
+
+#### Ignore
+
+```ruby
+ex Author.first, class_filter: { ignore: [:reviews] }
+```
+
+### Attribute Filter
+
+For any class you can specify list of attributes that will be displayed.
+
+```ruby
+ex Author.first, attribute_filter: { books: [:id, :title], reviews: [:id] }
+```
+
+### Attribute Limit
+
+Set limit to show just first couple of attributes. This is useful when your classes contain many attributes and final output gets too big (especially image output). When you do not need all attributes to be displayed, this is fastest way to make output much nicer.
+
+```ruby
+ex Author.first, attribute_limit: 3
+```
+
+### Association Filter
+
+By default, the gem follows two ways:
+
+- finds objects associated by `belongs_to` and continues to look only for `belongs_to` associations of these objects (recursively for all subobjects) 
+- finds objects associated by `has_many` / `has_one` and continues to look only for `has_many` / `has_one` associations of these objects (recursively for all subobjects) 
+
+You can change the default configuration by specifying array containing some of possible values: `:has_many`, `:has_one`, `:belongs_to`, `:all`.
+
+Value `:all` means that for each explored object the exploration continues in both `has_xxx` and `belongs_to` directions.
+
+```ruby
+ex Book.first, association_filter: [:has_many]
+```
+
+This will explore only the "down" way (through children) of Book object.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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.
+- Support all versions of Active Record >= 3.0.x
+- Export to yuml.me graphing website.
+- Interactive graph.
+- Rubymine plugin ;)
+
+## 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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_explorer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_explorer"
+  spec.version       = ActiveExplorer::VERSION
+  spec.authors       = ["Marek Ulicny"]
+  spec.email         = ["xulicny@gmail.com"]
+
+  spec.summary       = "Visualization of data and associations represented by Active Record."
+  spec.description   = "Visualization of data and associations represented by Active Record."
+  spec.homepage      = 'https://github.com/rascasone/active_explorer'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'ruby-graphviz'
+  spec.add_dependency 'activerecord', '~> 4.2.0'  # TODO: Support older versions as well.
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec' , '>=3.0.0'
+  spec.add_development_dependency "rspec-nc"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  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'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_explorer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gemfiles/activerecord_3_0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 3.0.20"
+
+gemspec :path => "../"

data/gemfiles/activerecord_3_0.gemfile.lock

@@ -0,0 +1,111 @@
+PATH
+  remote: ../
+  specs:
+    active_explorer (0.0.6)
+      activerecord
+      ruby-graphviz
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.0.20)
+      activesupport (= 3.0.20)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.20)
+      activemodel (= 3.0.20)
+      activesupport (= 3.0.20)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.20)
+    appraisal (2.1.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (2.0.10)
+    awesome_print (1.7.0)
+    builder (2.1.2)
+    coderay (1.1.1)
+    diff-lcs (1.2.5)
+    factory_girl (4.7.0)
+      activesupport (>= 3.0.0)
+    ffi (1.9.10)
+    formatador (0.2.5)
+    guard (2.14.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.2)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    i18n (0.5.4)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.10)
+    method_source (0.8.2)
+    mysql (2.9.1)
+    nenv (0.3.0)
+    notiffany (0.1.0)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.5.0)
+    rb-fsevent (0.9.7)
+    rb-inotify (0.9.7)
+      ffi (>= 0.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-nc (0.3.0)
+      rspec (>= 3)
+      terminal-notifier (>= 1.4)
+    rspec-support (3.4.1)
+    ruby-graphviz (1.2.2)
+    ruby_dep (1.3.1)
+    shellany (0.0.1)
+    slop (3.6.0)
+    terminal-notifier (1.6.3)
+    thor (0.19.1)
+    tzinfo (0.3.49)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_explorer!
+  activerecord (~> 3.0.20)
+  appraisal
+  awesome_print
+  bundler (~> 1.10)
+  factory_girl
+  guard
+  guard-rspec
+  mysql
+  rake (~> 10.0)
+  rspec (>= 3.0.0)
+  rspec-nc
+  ruby-graphviz (~> 1.2, >= 1.2.2)
+
+BUNDLED WITH
+   1.11.2

data/gemfiles/activerecord_3_1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 3.1.12"
+
+gemspec :path => "../"

data/gemfiles/activerecord_3_1.gemfile.lock

@@ -0,0 +1,113 @@
+PATH
+  remote: ../
+  specs:
+    active_explorer (0.0.6)
+      activerecord
+      ruby-graphviz
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.1.12)
+      activesupport (= 3.1.12)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.12)
+      activemodel (= 3.1.12)
+      activesupport (= 3.1.12)
+      arel (~> 2.2.3)
+      tzinfo (~> 0.3.29)
+    activesupport (3.1.12)
+      multi_json (~> 1.0)
+    appraisal (2.1.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (2.2.3)
+    awesome_print (1.7.0)
+    builder (3.0.4)
+    coderay (1.1.1)
+    diff-lcs (1.2.5)
+    factory_girl (4.7.0)
+      activesupport (>= 3.0.0)
+    ffi (1.9.10)
+    formatador (0.2.5)
+    guard (2.14.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.2)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    i18n (0.7.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.10)
+    method_source (0.8.2)
+    multi_json (1.12.1)
+    mysql (2.9.1)
+    nenv (0.3.0)
+    notiffany (0.1.0)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.5.0)
+    rb-fsevent (0.9.7)
+    rb-inotify (0.9.7)
+      ffi (>= 0.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-nc (0.3.0)
+      rspec (>= 3)
+      terminal-notifier (>= 1.4)
+    rspec-support (3.4.1)
+    ruby-graphviz (1.2.2)
+    ruby_dep (1.3.1)
+    shellany (0.0.1)
+    slop (3.6.0)
+    terminal-notifier (1.6.3)
+    thor (0.19.1)
+    tzinfo (0.3.49)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_explorer!
+  activerecord (~> 3.1.12)
+  appraisal
+  awesome_print
+  bundler (~> 1.10)
+  factory_girl
+  guard
+  guard-rspec
+  mysql
+  rake (~> 10.0)
+  rspec (>= 3.0.0)
+  rspec-nc
+  ruby-graphviz (~> 1.2, >= 1.2.2)
+
+BUNDLED WITH
+   1.11.2