active_explorer 0.0.7

data/lib/exploration.rb

@@ -0,0 +1,233 @@
+require 'writer'
+require 'painter'
+require 'config'
+
+module ActiveExplorer
+  class Exploration
+    ASSOCIATION_FILTER_VALUES = [:has_many, :has_one, :belongs_to, :all]
+
+    # Creates new exploration and generates exploration hash.
+    #
+    # @param association_filter [Array]
+    #   Values of array: `:has_many`, `:has_one`, `:belongs_to`, `:all`.
+    #   When empty then it "follows previous association" (i.e. uses `:belongs_to` when previous assoc. was `:belongs_to` and
+    #   uses `:has_xxx` when previous assoc. was `:has_xxx`). To always follow all associations you must specify
+    #   all associations (e.g. uses `ActiveExplorer::Exploration::ASSOCIATION_FILTER_VALUES` as a value).
+    #
+    # @param class_filter [Array or Hash]
+    #   If Array is used then it means to show only those classes in Array.
+    #   When Hash is used then it can have these keys:
+    #     - `:show` - Shows these classes, ignores at all other classes.
+    #     - `:ignore` - Stops processing at these, does not show it and does not go to children. Processing goes back to parent.
+    #   Use plural form (e.g. `books`).
+    #
+    # @param depth [Integer]
+    #   How deep into the subobjects should the explorere go. Depth 1 is only direct children. Depth 0 returns no children.
+    #
+    def initialize(object, depth: 5, class_filter: nil, attribute_filter: nil, attribute_limit: nil, association_filter: nil, parent_object: nil)
+      raise TypeError, "Parameter 'class_filter' must be Array or Hash but is #{class_filter.class}." unless class_filter.nil? || class_filter.is_a?(Array) || class_filter.is_a?(Hash)
+      raise TypeError, "Parameter 'association_filter' must be Array but is #{association_filter.class}." unless association_filter.nil? || association_filter.is_a?(Array)
+      raise TypeError, "Parameter 'association_filter' must only contain values #{ASSOCIATION_FILTER_VALUES.to_s[1..-2]}." unless association_filter.nil? || association_filter.empty? || (association_filter & ASSOCIATION_FILTER_VALUES).any?
+
+      @object = object
+      @depth = depth
+      @parent_object = parent_object
+
+      @attribute_limit = attribute_limit || ActiveExplorer::Config.attribute_limit
+      @attribute_filter = attribute_filter || ActiveExplorer::Config.attribute_filter
+
+      @hash = { class_name: make_safe(@object.class.name),
+                attributes: attributes }
+
+      unless @depth.zero?
+        @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]) : []
+        end
+
+        @association_filter = association_filter || ActiveExplorer::Config.association_filter
+        @association_filter = ASSOCIATION_FILTER_VALUES if @association_filter.present? && @association_filter.include?(:all)
+
+        @associations = associtations(@object, @class_filter, @association_filter)
+
+        subobject_hash = subobjects_hash(@object, @associations)
+        @hash[:subobjects] = subobject_hash unless subobject_hash.empty?
+      end
+    end
+
+    def attributes
+      attrs = @object.attributes.symbolize_keys
+      attrs = attrs.first(@attribute_limit).to_h if @attribute_limit
+
+      return attrs if @attribute_filter.nil?
+
+      filter = @attribute_filter[@object.class.name.downcase.pluralize.to_sym]
+
+      if filter
+        attrs.select { |key| filter.include?(key) }
+      else
+        attrs
+      end
+    end
+
+    def get_hash
+      @hash.deep_dup
+    end
+
+    def to_console
+      Writer.new(self).write
+    end
+
+    def to_image(file, origin_as_root: false)
+      Painter.new(self, file).paint(origin_as_root: origin_as_root)
+    end
+
+    private
+
+    def subobjects_hash(object, associations)
+      associations.each_with_object([]) do |association, results|
+        case association_type(association)
+          when :belongs_to
+            subobject = subobjects_from_association(object, association)
+
+            if subobject.present?
+              results.push subobject_hash(association, object, subobject) unless is_parent?(subobject)
+            end
+
+          when :has_many, :has_one
+            subobjects = subobjects_from_association(object, association)
+
+            if subobjects.present?
+              subobjects.each do |subobject|
+                results.push subobject_hash(association, object, subobject) unless is_parent?(subobject)
+              end
+            end
+        end
+      end
+    end
+
+    def subobject_hash(association, object, subobject)
+      association_type = association_type(association)
+
+      exploration = explore(subobject, parent_object: object, association_type: association_type)
+
+      hash = exploration.get_hash
+      hash[:association] = association_type
+      hash
+    end
+
+    def subobjects_from_association(object, association)
+      subobjects = object.send(association.name)
+      subobjects.present? ? subobjects : nil
+
+    rescue NameError, ActiveRecord::StatementInvalid, ActiveRecord::RecordNotFound => e
+      association_type = is_has_many_association?(association) ? 'has_many' : 'belongs_to'
+      add_error_hash("#{e.message} in #{association_type} :#{association.name}")
+      nil
+    end
+
+    def explore(object, parent_object:, association_type:)
+      association_filter = if !@association_filter.nil? && @association_filter.any?
+                             @association_filter
+                           elsif association_type == :belongs_to
+                             [:belongs_to]
+                           else
+                             [:has_many, :has_one]
+                           end
+
+      Exploration.new object,
+                      depth: @depth - 1,
+                      class_filter: @class_filter,
+                      attribute_filter: @attribute_filter,
+                      attribute_limit: @attribute_limit,
+                      association_filter: association_filter,
+                      parent_object: parent_object
+    end
+
+    def associtations(object, class_filter, association_filter)
+      associations = object.class.reflections.collect do |reflection|
+        reflection.second
+      end
+
+      if !association_filter.nil? && association_filter.any? && !association_filter.include?(:all)
+        associations.select! do |association|
+          association_filter.include? association_type(association)
+        end
+      end
+
+      if class_filter
+        if class_filter[:show].any?
+          associations.select! do |association|
+            should_show?(association)
+          end
+        elsif class_filter[:ignore].any?
+          associations.reject! do |association|
+            should_ignore?(association)
+          end
+        end
+      end
+
+      associations
+    end
+
+    def add_error_hash(message)
+      @hash[:class_name] = make_safe(@object.class.name)
+      @hash[:attributes] = attributes
+
+      @hash[:error_message] = "Error in #{@object.class.name}(#{@object.id}): #{message}"
+    end
+
+    def association_type(association)
+      if association.is_a?(ActiveRecord::Reflection::HasManyReflection) ||
+          association.is_a?(ActiveRecord::Reflection::ThroughReflection) ||
+          association.is_a?(ActiveRecord::Reflection::HasAndBelongsToManyReflection)
+        :has_many
+      elsif association.is_a?(ActiveRecord::Reflection::HasOneReflection)
+        :has_one
+      elsif association.is_a?(ActiveRecord::Reflection::BelongsToReflection)
+        :belongs_to
+      end
+    end
+
+    def make_short(text)
+      text.length < 70 ? text : text[0..70] + " (...)"
+    end
+
+    # Replace characters that conflict with DOT language (used in GraphViz).
+    # These: `{`, `}`, `<`, `>`, `|`, `\`
+    #
+    def make_safe(text)
+      text.tr('{}<>|\\', '')
+    end
+
+    def each_val_to_s(array)
+      array.collect { |a| a.to_s }
+    end
+
+    def is_belongs_to_association?(association)
+      association.is_a?(ActiveRecord::Reflection::BelongsToReflection)
+    end
+
+    def is_has_many_association?(association)
+      association.is_a?(ActiveRecord::Reflection::HasManyReflection)
+    end
+
+    def is_has_one_association?(association)
+      association.is_a?(ActiveRecord::Reflection::HasOneReflection)
+    end
+
+    def is_parent?(object)
+      object === @parent_object
+    end
+
+    def should_show?(association)
+      @class_filter[:show].include? association.plural_name.to_s
+    end
+
+    def should_ignore?(association)
+      @class_filter[:ignore].include? association.plural_name.to_s
+    end
+  end
+end

data/lib/painter.rb

@@ -0,0 +1,101 @@
+module ActiveExplorer
+  class Painter
+    def initialize(exploration, file_path)
+      @exploration = exploration
+      @file_path = file_path
+      @graph = GraphViz.new(:G, :type => :digraph)
+    end
+
+    def paint(origin_as_root: false)
+      @centralized = origin_as_root
+      paint_object @exploration.get_hash, @graph, nil
+      save_to_file
+      @graph
+    end
+
+    private
+
+    def paint_object(hash, graph, parent_node)
+      style = parent_node.nil? ? :origin : nil
+
+      node = add_node(hash, graph, style: style)
+      add_edge(graph, parent_node, node, hash[:association]) unless parent_node.nil?
+
+      paint_subobjects graph, node, hash[:subobjects] unless hash[:subobjects].nil?
+    end
+
+    def paint_subobjects(graph, parent_node, subhashes)
+      subhashes.each do |hash|
+        paint_object hash, graph, parent_node
+      end
+    end
+
+    def add_node(hash, graph, style: nil)
+      id = hash[:attributes][:id]
+      class_name = make_safe(hash[:class_name])
+      attributes = make_safe(hash[:attributes].keys.join("\n"))
+      values = hash[:attributes].values.collect do |val|
+        if val.nil?
+          'nil'
+        elsif val.is_a? String
+          "\"#{make_short(val)}\""
+        else
+          make_short(val.to_s)
+        end
+      end
+      values = make_safe(values.join("\n"))
+
+      if style == :origin
+        graph.add_node("#{class_name}_#{id}", shape: "record", label: "{#{class_name}|{#{attributes}|#{values}}}", labelloc: 't', style: 'filled', fillcolor: 'yellow')
+      else
+        graph.add_node("#{class_name}_#{id}", shape: "record", label: "{#{class_name}|{#{attributes}|#{values}}}", labelloc: 't')
+      end
+    end
+
+    def add_edge(graph, parent_node, node, association)
+      if @centralized
+        graph.add_edge(parent_node, node, label: association == :belongs_to ? ' belongs to' : ' has') unless edge_exists?(graph, parent_node, node)
+      else
+        if association == :belongs_to
+          graph.add_edge(node, parent_node) unless edge_exists?(graph, node, parent_node)
+        else
+          graph.add_edge(parent_node, node) unless edge_exists?(graph, parent_node, node)
+        end
+      end
+    end
+
+    def edge_exists?(graph, node_one, node_two)
+      graph.each_edge do |edge|
+        return true if edge.node_one == node_one.id && edge.node_two == node_two.id
+      end
+
+      false
+    end
+
+    def save_to_file
+      filename = @file_path.split(File::SEPARATOR).last
+      directory = @file_path.chomp filename
+
+      create_directory directory unless directory.empty?
+
+      @graph.output(:png => @file_path)
+    end
+
+    def create_directory(directory)
+      unless directory.empty? || File.directory?(directory)
+        FileUtils.mkdir_p directory
+      end
+    end
+
+    def make_short(text)
+      text.length < 70 ? text : text[0..70] + " (...)"
+    end
+
+    # Replace characters that conflict with DOT language (used in GraphViz).
+    # These: `{`, `}`, `<`, `>`, `|`, `\`
+    #
+    def make_safe(text)
+      text.tr('{}<>|\\', '')
+    end
+  end
+end

data/lib/writer.rb

@@ -0,0 +1,48 @@
+module ActiveExplorer
+  class Writer
+    def initialize(exploration)
+      @exploration = exploration
+    end
+
+    def write
+      exploration_hash = @exploration.get_hash
+
+      puts "\nExplored #{exploration_hash[:class_name]}(#{exploration_hash[:attributes][:id]}):\n\n"
+      write_object(exploration_hash)
+      puts "\n"
+    end
+
+    private
+
+    def write_object(object, level = 0)
+      class_name = object[:class_name]
+      id = object[:attributes][:id]
+      attributes = object[:attributes]
+      error_message = object[:error_message]
+
+      attributes.delete :id
+
+      margin = '    ' * level
+
+      if level > 0
+        margin[-2] = '->'
+        margin += object[:association] == :belongs_to ? 'belongs to ' : 'has '
+      end
+
+      puts "#{margin}#{class_name}(#{id}) #{attributes}"
+
+      if error_message.present?
+        margin = '    ' * level
+        puts "#{margin}(#{error_message})" if error_message.present?
+      end
+
+      write_objects object[:subobjects], level + 1 unless object[:subobjects].nil?
+    end
+
+    def write_objects(objects, level)
+      objects.each do |object|
+        write_object object, level
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,284 @@
+--- !ruby/object:Gem::Specification
+name: active_explorer
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+platform: ruby
+authors:
+- Marek Ulicny
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
+  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: guard
+  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: guard-rspec
+  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: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        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: 1.2.2
+- !ruby/object:Gem::Dependency
+  name: mysql
+  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: standalone_migrations
+  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'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  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: appraisal
+  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: Visualization of data and associations represented by Active Record.
+email:
+- xulicny@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".standalone_migrations"
+- ".travis.yml"
+- Appraisals
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_explorer.gemspec
+- bin/console
+- bin/setup
+- gemfiles/activerecord_3_0.gemfile
+- gemfiles/activerecord_3_0.gemfile.lock
+- gemfiles/activerecord_3_1.gemfile
+- gemfiles/activerecord_3_1.gemfile.lock
+- gemfiles/activerecord_3_2.gemfile
+- gemfiles/activerecord_3_2.gemfile.lock
+- gemfiles/activerecord_4_0.gemfile
+- gemfiles/activerecord_4_0.gemfile.lock
+- gemfiles/activerecord_4_1.gemfile
+- gemfiles/activerecord_4_1.gemfile.lock
+- gemfiles/activerecord_4_2.gemfile
+- gemfiles/activerecord_4_2.gemfile.lock
+- gemfiles/activerecord_5_0.gemfile
+- gemfiles/activerecord_5_0.gemfile.lock
+- lib/active_explorer.rb
+- lib/active_explorer/version.rb
+- lib/config.rb
+- lib/exploration.rb
+- lib/painter.rb
+- lib/writer.rb
+homepage: https://github.com/rascasone/active_explorer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Visualization of data and associations represented by Active Record.
+test_files: []