pretty_association_inspect 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2cf4a0aa15d29d6596bb7c227aff74cd0665f2a1
+  data.tar.gz: e754a3b84739cd215cd787c0abf7047783d717b9
+SHA512:
+  metadata.gz: b3b2ec246f63152898062d5149d7bdbbf3ef1a668e014af135b0333c1c86c4bea7056029f1f25e6f45e5a28301476dd9a352d80e65b7cdfb21cbda1cdfff4a1e
+  data.tar.gz: 4ae7644a1a2790f16c5cebede36a1237a186546ee5cf5a7e4ead9dd019924b2c3aa81a754a956e10aac47260bb10c98d3e7d2912ced7d886555e0e3bc52f90a2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

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 pretty_association_inspect.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 TODO: Write your name
+
+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,47 @@
+# PrettyAssociationInspect
+モデルで定義されたメソッド、関連、バリデーションを
+コンソール上で美しく表示します。
+
+## Installation
+
+```ruby
+gem 'pretty_association_inspect'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pretty_association_inspect
+
+## Usage
+
+### メソッド、関連、バリデーションを表示する
+
+```rb
+User.to
+```
+
+### 関連を、４モデル先まで表示する(デフォルトは１モデル先)
+
+```rb
+User.toto 4
+```
+
+### カラムのカラムの部分一致検索
+
+```rb
+User.s "小野寺"
+```
+
+### カラムのカラムの完全一致検索
+
+```rb
+User.ss "小野寺"
+```
+
+## 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 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pretty_association_inspect"
+
+# 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/lib/pretty_association_inspect/version.rb

@@ -0,0 +1,3 @@
+module PrettyAssociationInspect
+  VERSION = "1.0.1"
+end

data/lib/pretty_association_inspect.rb

@@ -0,0 +1,247 @@
+# -*- coding: utf-8 -*-
+# モデルに関連情報を見やすく表示するメソッドを定義します。
+module PrettyAssociationInspect
+  extend self
+
+  class Edge
+    def initialize(cost, node_id)
+      @cost, @node_id = cost, node_id
+    end
+    attr_reader :cost, :node_id
+  end
+
+  class Node
+    def initialize(id, edges, cost=nil, done=false, from=nil)
+      @id, @edges, @cost, @done, @from = id, edges, cost, done, from
+    end
+    attr_accessor :id, :edges, :cost, :done, :from
+  end
+
+  class Graph
+    def initialize(data)
+      @nodes = data.map do |node_id, edges|
+        edges.map!{|edge| Edge.new(*edge)}
+        Node.new(node_id, edges)
+      end
+    end
+
+    def print_route(route)
+      return false if route[0].cost.nil?
+      route_arr  = route.map{|node| node.id}
+      start_name = route_arr.pop.to_s.camelize
+      route_arr.reverse!
+      h = Hash.new
+      h[route_arr.first] = {} if route_arr.count == 1
+      h[route_arr.first] = route_arr.second if route_arr.count == 2
+      h[route_arr.first] = {route_arr.second => route_arr.third} if route_arr.count == 3
+      h[route_arr.first] = {route_arr.second => {route_arr.third => route_arr.fourth}} if route_arr.count == 4
+      route_str = "#{start_name}.joins(#{h.to_s}).last." + route_arr.join(".").gsub("s.", "s.last.")
+      ap route_str
+      return route_str
+    end
+
+    def minimum_route(start_id, goal_id, max_cost)
+      search_by_dikstra(start_id, goal_id, max_cost)
+      passage = @nodes.find { |node| node.id == goal_id }
+      route = [passage]
+      while passage = @nodes.find { |node| node.id == passage.from }
+        route << passage
+      end
+      route
+    end
+
+    def search_by_dikstra(start_id, goal_id, max_cost)
+      @nodes.each do |node|
+        node.cost = node.id == start_id ? 0 : nil
+        node.done = false
+        node.from = nil
+      end
+      loop do
+        next_node = nil
+        @nodes.each do |node|
+          next if node.done || node.cost.nil?
+          next_node = node if next_node.nil? || node.cost < next_node.cost
+        end
+        break if next_node.nil?
+        next_node.done = true
+        next_node.edges.each do |edge|
+          reachble_node = @nodes.find { |node| node.id == edge.node_id }
+          reachble_cost = next_node.cost + edge.cost
+          next if reachble_node.nil?
+          next if reachble_cost > max_cost
+          if reachble_node.cost.nil? || reachble_cost < reachble_node.cost
+            reachble_node.cost = reachble_cost
+            reachble_node.from = next_node.id
+          end
+        end
+      end
+    end
+  end
+
+  def build_association_node(start, max_cost)
+    models = ActiveRecord::Base.subclasses.map(&:name)
+    data = models.each_with_object({}) do |model_name_str, hash|
+      eval(model_name_str).reflect_on_all_associations.each do |m|
+        model_single_name   = eval(model_name_str).model_name.singular.to_sym
+        model_multiple_name = eval(model_name_str).model_name.plural.to_sym
+        hash[model_single_name]   ||= []
+        hash[model_multiple_name] ||= []
+        hash[model_single_name]   << [1, m.name]
+        hash[model_multiple_name] << [1, m.name]
+      end
+    end
+    graph = Graph.new(data)
+    route_hash = {}
+    data.each do |goal, v|
+      next if start == goal
+      new_route = graph.print_route(graph.minimum_route(start, goal, max_cost))
+      _model_ = ActiveRecord::Base.module_eval(goal.to_s.camelize.singularize).model_name.human rescue nil
+      human_str = PrettyAssociationInspect.jp_scripe(_model_)
+      route_hash["#{goal} #{human_str}"] = new_route if new_route
+    end
+    route_hash
+  end
+
+
+  # 『関連を可愛く表示するメソッド』を定義する
+  def pretty_association_inspect_define(klass)
+    klass.class_eval do |model|
+      self.define_singleton_method(:to){
+        associations_hash = PrettyAssociationInspect.build_association_hash(model)
+        PrettyAssociationInspect.printed(klass, model, associations_hash)
+        return self.first || self
+      }
+
+      define_method(:to){
+        associations_hash = PrettyAssociationInspect.build_association_hash(model)
+        PrettyAssociationInspect.printed(klass, model, associations_hash)
+        return self
+      }
+      self.define_singleton_method(:toto){ |max_cost=1, start = nil|
+        model_name_sym = model_name.singular.to_sym
+        route_arr = PrettyAssociationInspect.build_association_node(start || model_name_sym, max_cost)
+        ap route_arr.map { |route| [route.first, eval(route.last.to_s)] rescue nil }
+        ap route_arr
+        return nil
+      }
+      define_method(:toto){ |max_cost = 1, start = nil|
+        model_name_sym = model_name.singular.to_sym
+        route_arr = PrettyAssociationInspect.build_association_node(start || model_name_sym, max_cost)
+        ap route_arr.map { |route| [route.first, eval(route.last.to_s)] rescue nil }
+        ap route_arr
+        return nil
+      }
+      self.define_singleton_method(:s){ |name = nil|
+        results = Module.const_get(self.to_s).columns.select{|m| m.sql_type=~/char/}.map(&:name).map(&:to_sym).each_with_object([]) { |attr, records|
+          result   = self.where(self.arel_table[attr].matches("%#{name}%"))
+          records << [attr, result.ids, result]
+        }.select{|m| m.second.present? }
+        ap results
+        result_where = self.where(id: results.map(&:second).flatten)
+        ap result_where
+        return result_where
+      }
+    end
+  end
+
+  # バリューを整形
+  def value_convert(k, v, klass)
+    klass.class_eval {
+      return columns_hash[k.to_s].type if v.blank?
+      is_e  = Object.const_defined?(:Enumerize) && first.send(k).kind_of?(Enumerize::Value)
+      return "#{v} #{first.send(k).text} #{send(k).values} #{send(k).values.map(&:text)}" if is_e
+      return v.strftime("%y年%m月%d日 %H:%M") if v.respond_to?(:strftime)
+    }
+  end
+
+  # アソシエーションをハッシュに変換
+  def build_association_hash(model)
+    pretty_hash = model.reflect_on_all_associations.each_with_object({}) do |m, hash|
+      name = m.class.to_s.gsub("ActiveRecord::Reflection::", "").gsub("Reflection", "").to_sym
+      hash[name] ||= []
+      human_name = PrettyAssociationInspect.jp_scripe(m.klass.model_name.human)
+      hash[name] << [
+        m.name, human_name
+      ].compact.join(' | ')
+      hash[name] = hash[name]
+    end
+  end
+
+  # 表示
+  def printed(klass, model, associations_hash)
+    pretty_hash = {}
+    begin
+      klass.class_eval{|klass|
+        klass.first.attributes.each{|k ,v|
+          pretty_hash[k.to_sym] =
+            [
+              PrettyAssociationInspect.value_convert(k, v, klass),
+              PrettyAssociationInspect.jp_scripe(klass.human_attribute_name(k)),
+              v
+            ].compact.join(' | ')
+        }
+      }
+    rescue => e
+      ap e
+    end
+    ap "-"*100;
+    ap "#{klass.name} #{jp_scripe(klass.model_name.human)}"
+    ap "[クラスメソッド]"
+    base_pattern   = "(before|after|around)_(add|remove|restore)|_associated_records_for_|inherited"
+    extr_pattern   = "attribute_type_decorations|soft_de|_restore_callback|indexed_|_by_resource"
+    delete_pattern = Regexp.new( [ base_pattern, extr_pattern ].join('|') )
+    class_m  = model.methods(false) - model.instance_methods
+    ap (class_m).delete_if{|name|
+      delete_pattern.match(name) }.sort
+    ap "[インスタンスメソッド]"
+    instance_m = model.instance_methods(false) - model.superclass.instance_methods
+    ap (instance_m).delete_if{|name|
+      delete_pattern.match(name) }.sort
+    ap "[バリデーション]"
+    ap model.validators.map{|m|
+      m.class.name.gsub(/Active|Record|Validations|Model|Validator|::/,"")
+        .concat(" #{m.attributes.join(', ')} #{m.options}") }.sort.uniq
+    ap "[アソシエーション]"
+    ap associations_hash
+    ap "[詳細]"
+    ap pretty_hash
+    ap "-"*100
+  end
+
+  # 日本語だけ抽出
+  def jp_scripe(str)
+    japanese = Regexp.new(/[亜-熙ぁ-んァ-ヶ]/)
+    str if japanese =~ str
+  end
+
+  # 全てのモデルにメソッドを定義する
+  def all_models_define
+    model_names_array = load_all_models
+    model_names_array.each do |model_name|
+      begin
+        klass = eval(model_name)
+        pretty_association_inspect_define(klass)
+      rescue
+        next
+      end
+    end
+  end
+
+  # 全てのモデルを読み込み、モデル名配列を返す
+  def load_all_models
+    models_file_path = Dir.glob(Rails.root.join("app/models/*")).grep(/rb\z/)
+    models_file_path.each { |m| require(m) rescue next }
+    return ActiveRecord::Base.subclasses.map(&:name)
+  end
+
+end
+module Kernel
+  extend self
+  define_method(:ss) {|keyword = nil|
+    ActiveRecord::Base.connection.tables.map(&:classify).map{|m| Object.const_get(m) rescue nil}.each_with_object({}){|m,h| h[m.try(:name).try(:to_sym)] = m.try(:column_names)}.compact.select{|_,v| v.any?{|m| keyword.nil? ? true : m.match(keyword) }}
+  }
+  define_method(:sss) {|keyword = nil|
+    result = ActiveRecord::Base.connection.tables.map(&:classify).map{|m| Object.const_get(m) rescue nil}.each_with_object({}){|m,h| h[m.try(:name).try(:to_sym)] = m.try(:column_names)}.compact.select{|_,v| v.any?{|m| keyword.nil? ? true : m == keyword }}
+    result.keys
+  }
+end

data/pretty_association_inspect.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pretty_association_inspect/version'
+
+
+Gem::Specification.new do |spec|
+  spec.name          = "pretty_association_inspect"
+  spec.version       = PrettyAssociationInspect::VERSION
+  spec.authors       = ["小野寺　優太"]
+  spec.email         = ["s1160054@gmail.com"]
+
+  spec.summary       = %q{モデルで定義されたメソッド、関連、バリデーションを、Railsコンソール上で美しく表示します。}
+  spec.description   = %q{すべてのモデルに「to」というクラスメソッド及びインスタンスメソッドが追加されます。}
+  spec.homepage      = "https://github.com/s1160054/pretty_association_inspect.git"
+  spec.license       = "MIT"
+
+  #Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  #delete this section to allow pushing this gem to any host.
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rails"
+  spec.add_development_dependency "awesome_print"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: pretty_association_inspect
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- "小野寺　優太"
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: rails
+  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'
+description: "すべてのモデルに「to」というクラスメソッド及びインスタンスメソッドが追加されます。"
+email:
+- s1160054@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pretty_association_inspect.rb
+- lib/pretty_association_inspect/version.rb
+- pretty_association_inspect.gemspec
+homepage: https://github.com/s1160054/pretty_association_inspect.git
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: "モデルで定義されたメソッド、関連、バリデーションを、Railsコンソール上で美しく表示します。"
+test_files: []