okuribito_rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 71c24bd6b8d02a6f2bf2e3aca3153d4e01cbeb4e
+  data.tar.gz: 81c7826c60d89e14c8b6511396ea57d82603d27d
+SHA512:
+  metadata.gz: 084359cca42f7a890cd3025bc7ebace2c7bc9c247df42abc308b971429c53c75624adf1453877b182e8e4b7b4034fc463343fd36447ba7a4a0fb635024327eff
+  data.tar.gz: 2a68eefce673d5c80ae800ff997261d38613464315ca2ceec402df15c644f36e744877a2ad4bf710f2ca8159d613bad140663b853d78b4dcb8db43fdcd1eb0c0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 YOURNAME
+
+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,68 @@
+# OkuribitoRails
+
+OkuribitoRails is an engine for Rails that aims to be the managing method call status.
+
+You should create a configuration file. (Describe the method name you want to monitor)
+
+When OkuribitoRails detected a method call during application execution, it registers the method call information in the DB.
+
+In other words, you can identify methods that have not been called from anywhere in production!
+
+![OkuribitoRails](https://raw.githubusercontent.com/muramurasan/okuribito_rails/master/doc/sample.png)
+
+# Installation
+
+Installing OkuribitoRails is easy.
+
+## Specify Gem dependencies
+
+```ruby
+gem 'okuribito_rails'
+```
+
+## Run the installer
+
+Run the installer.
+
+```shell
+rails g okuribito_rails:install
+```
+
+The installer makes the following settings.
+
+- Create migration files (Used by OkuribitoRails)
+- Updating routing (Mount engine)
+- Create default configuration
+
+## Run db:migrate
+
+```shell
+rake db:migrate
+```
+
+## Definition of monitoring method
+
+Create a file that defines the method to be monitored.
+
+```ruby
+User:
+  - '#feed'
+  - '#profile'
+Micropost:
+  - '.from_users_followed_by'
+```
+
+And put it in the path defined in `config / initializers / okuribito_rails.rb`.
+
+(By Default `config/okuribito.yml`)
+
+## Features
+
+Here's a comprehensive list of the features currently in OkuribitoRails:
+
+* Monitoring
+  * During application execution, monitor specified method calls
+    * After detecting the method call, register the call history in the DB
+* Web UI
+  * Viewing monitored methods
+  * Viewing call history of monitored methods

data/Rakefile

@@ -0,0 +1,30 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'OkuribitoRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/okuribito_rails/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/okuribito_rails/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/assets/stylesheets/okuribito_rails/method_call_info.css

@@ -0,0 +1,19 @@
+.method_call_info{
+  width: 100%;
+  border-collapse: collapse;
+  margin-bottom: 10px;
+}
+.method_call_info th{
+  padding: 6px;
+  text-align: left;
+  vertical-align: top;
+  color: #333;
+  background-color: #eee;
+  border: 1px solid #b9b9b9;
+}
+.method_call_info td{
+  padding: 6px;
+  background-color: #fff;
+  border: 1px solid #b9b9b9;
+  font-size: 0.9em
+}

data/app/controllers/okuribito_rails/application_controller.rb

@@ -0,0 +1,4 @@
+module OkuribitoRails
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/okuribito_rails/method_call_logs_controller.rb

@@ -0,0 +1,9 @@
+require_dependency "okuribito_rails/application_controller"
+
+module OkuribitoRails
+  class MethodCallLogsController < ApplicationController
+    def index
+      @method_call_logs = MethodCallLog.page(params[Kaminari.config.param_name]).per(20)
+    end
+  end
+end

data/app/controllers/okuribito_rails/method_call_situations_controller.rb

@@ -0,0 +1,9 @@
+require_dependency "okuribito_rails/application_controller"
+
+module OkuribitoRails
+  class MethodCallSituationsController < ApplicationController
+    def index
+      @method_call_situations = MethodCallSituation.page(params[Kaminari.config.param_name]).per(20)
+    end
+  end
+end

data/app/helpers/okuribito_rails/application_helper.rb

@@ -0,0 +1,4 @@
+module OkuribitoRails
+  module ApplicationHelper
+  end
+end

data/app/models/okuribito_rails/method_call_log.rb

@@ -0,0 +1,5 @@
+module OkuribitoRails
+  class MethodCallLog < ActiveRecord::Base
+    belongs_to :method_call_situation
+  end
+end

data/app/models/okuribito_rails/method_call_situation.rb

@@ -0,0 +1,5 @@
+module OkuribitoRails
+  class MethodCallSituation < ActiveRecord::Base
+    has_many :method_call_logs
+  end
+end

data/app/views/layouts/okuribito_rails/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>OkuribitoRails</title>
+  <%= stylesheet_link_tag    "okuribito_rails/application", media: "all" %>
+  <%= javascript_include_tag "okuribito_rails/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/okuribito_rails/method_call_logs/index.html.erb

@@ -0,0 +1,24 @@
+<table class="method_call_info">
+  <tbody>
+    <tr>
+      <th>Method name</th>
+      <th>Backtrace</th>
+      <th>Recording date</th>
+    </tr>
+    <% @method_call_logs.each do |method_call_log| %>
+      <tr>
+        <td>
+          <%= method_call_log.class_name %><%= method_call_log.method_symbol %><%= method_call_log.method_name %>
+        </td>
+        <td>
+          <%= method_call_log.back_trace %>
+        </td>
+        <td>
+          <%= method_call_log.created_at %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<%= paginate @method_call_logs %>

data/app/views/okuribito_rails/method_call_situations/index.html.erb

@@ -0,0 +1,30 @@
+<table class="method_call_info">
+  <tbody>
+    <tr>
+      <th>Method name</th>
+      <th>Number of calls</th>
+      <th>Monitoring start date</th>
+      <th>Last call date</th>
+    </tr>
+    <% @method_call_situations.each do |method_call_situation| %>
+      <tr>
+        <td>
+          <%= method_call_situation.class_name %><%= method_call_situation.method_symbol %><%= method_call_situation.method_name %>
+        </td>
+        <td>
+          <%= method_call_situation.called_num %>
+        </td>
+        <td>
+          <%= method_call_situation.created_at %>
+        </td>
+        <td>
+          <%= method_call_situation.called_num > 0 ? method_call_situation.updated_at : "Not called" %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<%= paginate @method_call_situations %>
+
+

data/config/routes.rb

@@ -0,0 +1,4 @@
+OkuribitoRails::Engine.routes.draw do
+  resources :method_call_logs
+  resources :method_call_situations
+end

data/db/migrate/20161027145839_create_okuribito_rails_method_call_situations.rb

@@ -0,0 +1,14 @@
+class CreateOkuribitoRailsMethodCallSituations < ActiveRecord::Migration
+  def change
+    create_table :okuribito_rails_method_call_situations do |t|
+      t.string :class_name, null: false
+      t.string :method_symbol, null: false
+      t.string :method_name, null: false
+      t.integer :called_num, null: false, default: 0
+
+      t.timestamps
+    end
+    add_index :okuribito_rails_method_call_situations, :class_name
+    add_index :okuribito_rails_method_call_situations, :method_name
+  end
+end

data/db/migrate/20161027150000_create_okuribito_rails_method_call_logs.rb

@@ -0,0 +1,15 @@
+class CreateOkuribitoRailsMethodCallLogs < ActiveRecord::Migration
+  def change
+    create_table :okuribito_rails_method_call_logs do |t|
+      t.integer :method_call_situation_id, null: false
+      t.string :class_name, null: false
+      t.string :method_symbol, null: false
+      t.string :method_name, null: false
+      t.text :back_trace
+
+      t.timestamps
+    end
+    add_index :okuribito_rails_method_call_logs, :class_name
+    add_index :okuribito_rails_method_call_logs, :method_name
+  end
+end

data/lib/generators/okuribito_rails/install_generator.rb

@@ -0,0 +1,44 @@
+require 'rails/generators'
+
+module OkuribitoRails
+  class InstallGenerator < Rails::Generators::Base
+    class_option "with-migrate", :type => :boolean
+
+    def start
+      puts "Start installing okuribito_rails..."
+      puts ("*" * 80) + "\n"
+    end
+
+    def install_migrations
+      puts "Copying over OkuribitoRails migrations..."
+      Dir.chdir(Rails.root) do
+        `rake okuribito_rails:install:migrations`
+      end
+    end
+
+    def run_migrations
+      if options["with-migrate"]
+        puts "Running rake db:migrate"
+        `rake db:migrate`
+      end
+    end
+
+    def mount_engine
+      puts "Insert routing..."
+      route("mount OkuribitoRails::Engine, :at => '/okuribito_rails'")
+    end
+
+    def create_config_initializer
+      puts "Create configuration..."
+      OkuribitoRails::InstallGenerator.source_root File.expand_path('../templates', __FILE__)
+      template 'initializer.erb', 'config/initializers/okuribito_rails.rb'
+    end
+
+    def finished
+      puts "\n" + ("*" * 80)
+      puts "Done! OkuribitoRails has been successfully installed."
+      puts "Please create and deploy a configuration file of okuribito."
+      puts "(The yaml that defines the method you want to monitor)"
+    end
+  end
+end

data/lib/generators/okuribito_rails/templates/initializer.erb

@@ -0,0 +1,7 @@
+OkuribitoRails.configure do |config|
+  # The path of the yaml file that describes the method you want to monitor.
+  config.setting_path = "config/okuribito.yml"
+
+  # Detecting method calls only once during application running.
+  config.once_detect = false
+end

data/lib/okuribito_rails/config.rb

@@ -0,0 +1,8 @@
+module OkuribitoRails
+  class Config
+    include ActiveSupport::Configurable
+
+    config_accessor :once_detect
+    config_accessor :setting_path
+  end
+end

data/lib/okuribito_rails/engine.rb

@@ -0,0 +1,15 @@
+module OkuribitoRails
+  class Engine < ::Rails::Engine
+    isolate_namespace OkuribitoRails
+  end
+
+  class << self
+    def config
+      @config ||= Config.new
+    end
+
+    def configure
+      yield config
+    end
+  end
+end

data/lib/okuribito_rails/observe_method.rb

@@ -0,0 +1,21 @@
+require "okuribito"
+
+module OkuribitoRails
+  class ObserveMethod
+    def patch_okuribito
+      Okuribito::OkuribitoPatch.new(once_detect: OkuribitoRails.config.once_detect) do |method_name, _obj_name, caller_info, class_name, method_symbol|
+        situation = MethodCallSituation.find_by(class_name: class_name,
+                                                method_symbol: method_symbol,
+                                                method_name: method_name)
+        if situation.present?
+          situation.increment!(:called_num)
+          MethodCallLog.create(method_call_situation: situation,
+                               class_name: class_name,
+                               method_symbol: method_symbol,
+                               method_name: method_name,
+                               back_trace: caller_info[0])
+        end
+      end
+    end
+  end
+end

data/lib/okuribito_rails/railtie.rb

@@ -0,0 +1,19 @@
+require "okuribito_rails/regist_method"
+require "okuribito_rails/observe_method"
+
+module OkuribitoRails
+  class Railtie < ::Rails::Railtie
+    config.after_initialize do
+      if ActiveRecord::Base.connection.table_exists? 'okuribito_rails_method_call_situations'
+        yaml_path = OkuribitoRails.config.setting_path
+
+        # Update database by observed methods.
+        RegistMethod.new.update_observe_methods(yaml_path)
+
+        # Define behavior that when method called.
+        okuribito = ObserveMethod.new.patch_okuribito
+        okuribito.apply(yaml_path) if File.exist?(yaml_path)
+      end
+    end
+  end
+end

data/lib/okuribito_rails/regist_method.rb

@@ -0,0 +1,44 @@
+require "yaml"
+
+module OkuribitoRails
+  class RegistMethod
+    def update_observe_methods(path)
+      input = yaml_to_array(path)
+      base  = db_to_array
+      new_methods = input - base
+      new_methods.each do |new_method|
+        array = new_method.split(/\s*(#|\.)\s*/)
+        MethodCallSituation.create(class_name: array[0],
+                                   method_symbol: array[1],
+                                   method_name: array[2])
+      end
+      delete_methods = base - input
+      delete_methods.each do |delete_method|
+        array = delete_method.split(/\s*(#|\.)\s*/)
+        MethodCallSituation.find_by(class_name: array[0],
+                                    method_symbol: array[1],
+                                    method_name: array[2]).destroy
+      end
+    end
+
+    def yaml_to_array(path)
+      yaml = YAML.load_file(path)
+      methods_array = []
+      yaml.each do |class_name, observe_methods|
+        observe_methods.each do |observe_method|
+          methods_array.push(class_name + observe_method)
+        end
+      end
+      methods_array
+    end
+
+    def db_to_array
+      methods_array = []
+      results = MethodCallSituation.all
+      results.each do |result|
+        methods_array.push(result.class_name + result.method_symbol + result.method_name)
+      end
+      methods_array
+    end
+  end
+end

data/lib/okuribito_rails/version.rb

@@ -0,0 +1,3 @@
+module OkuribitoRails
+  VERSION = "0.0.1"
+end

data/lib/okuribito_rails.rb

@@ -0,0 +1,8 @@
+require "kaminari"
+
+require "okuribito_rails/engine"
+require "okuribito_rails/railtie"
+require "okuribito_rails/config"
+
+module OkuribitoRails
+end

data/lib/tasks/okuribito_rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :okuribito_rails do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: okuribito_rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yasuhiro Matsumura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: okuribito
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  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: sqlite3
+  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: rspec-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'
+description: OkuribitoRails is an engine for Rails that aims to be the managing method
+  call status.You should create a configuration file. (Describe the method name you
+  want to monitor)When OkuribitoRails detected a method call during application execution,
+  it registers the method call information in the DB.In other words, you can identify
+  methods that have not been called from anywhere in production!
+email:
+- ym.contributor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/javascripts/okuribito_rails/application.js
+- app/assets/stylesheets/okuribito_rails/application.css
+- app/assets/stylesheets/okuribito_rails/method_call_info.css
+- app/controllers/okuribito_rails/application_controller.rb
+- app/controllers/okuribito_rails/method_call_logs_controller.rb
+- app/controllers/okuribito_rails/method_call_situations_controller.rb
+- app/helpers/okuribito_rails/application_helper.rb
+- app/models/okuribito_rails/method_call_log.rb
+- app/models/okuribito_rails/method_call_situation.rb
+- app/views/layouts/okuribito_rails/application.html.erb
+- app/views/okuribito_rails/method_call_logs/index.html.erb
+- app/views/okuribito_rails/method_call_situations/index.html.erb
+- config/routes.rb
+- db/migrate/20161027145839_create_okuribito_rails_method_call_situations.rb
+- db/migrate/20161027150000_create_okuribito_rails_method_call_logs.rb
+- lib/generators/okuribito_rails/install_generator.rb
+- lib/generators/okuribito_rails/templates/initializer.erb
+- lib/okuribito_rails/config.rb
+- lib/okuribito_rails/engine.rb
+- lib/okuribito_rails/observe_method.rb
+- lib/okuribito_rails/railtie.rb
+- lib/okuribito_rails/regist_method.rb
+- lib/okuribito_rails/version.rb
+- lib/okuribito_rails.rb
+- lib/tasks/okuribito_rails_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/muramurasan/okuribito_rails
+licenses: []
+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.0.14.1
+signing_key: 
+specification_version: 4
+summary: OkuribitoRails is an engine for Rails that aims to be the managing method
+  call status.
+test_files: []