okuribito_rails 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71c24bd6b8d02a6f2bf2e3aca3153d4e01cbeb4e
-  data.tar.gz: 81c7826c60d89e14c8b6511396ea57d82603d27d
+  metadata.gz: f7a139dac2a491953b55242fff83baba4692ae6e
+  data.tar.gz: 19520deb5322bd318ea38afb5bd7d6c75b3f48ce
 SHA512:
-  metadata.gz: 084359cca42f7a890cd3025bc7ebace2c7bc9c247df42abc308b971429c53c75624adf1453877b182e8e4b7b4034fc463343fd36447ba7a4a0fb635024327eff
-  data.tar.gz: 2a68eefce673d5c80ae800ff997261d38613464315ca2ceec402df15c644f36e744877a2ad4bf710f2ca8159d613bad140663b853d78b4dcb8db43fdcd1eb0c0
+  metadata.gz: bfd4139173341dd81cbc0a8bd301e62ec0f5ef4a75b8c9cee9605af316a845527e9fa50a188570acd94d0f7dd2e8204b9b3ea96f5811119854abde8ecbee6788
+  data.tar.gz: b34c654976fac036c2cff3d8b022734a51bae591e7dba080042e1c688cb2a8b968884f290150bca5df97f0cacb3d733fae805dc2f9204be8da6c1f659cfabfa4

data/README.md

@@ -1,3 +1,7 @@
+[![CircleCI](https://circleci.com/gh/muramurasan/okuribito_rails.svg?style=svg)](https://circleci.com/gh/muramurasan/okuribito_rails)
+[![Code Climate](https://codeclimate.com/github/muramurasan/okuribito_rails.png)](https://codeclimate.com/github/muramurasan/okuribito_rails)
+[![Test Coverage](https://codeclimate.com/github/muramurasan/okuribito_rails/badges/coverage.svg)](https://codeclimate.com/github/muramurasan/okuribito_rails/coverage)
+
 # OkuribitoRails
 
 OkuribitoRails is an engine for Rails that aims to be the managing method call status.
@@ -10,6 +14,17 @@ In other words, you can identify methods that have not been called from anywhere
 
 ![OkuribitoRails](https://raw.githubusercontent.com/muramurasan/okuribito_rails/master/doc/sample.png)
 
+# 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
+
 # Installation
 
 Installing OkuribitoRails is easy.
@@ -52,17 +67,6 @@ Micropost:
   - '.from_users_followed_by'
 ```
 
-And put it in the path defined in `config / initializers / okuribito_rails.rb`.
+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

@@ -1,30 +1,13 @@
 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
-
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec
 
-task default: :test
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'

data/app/controllers/okuribito_rails/application_controller.rb

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

data/app/controllers/okuribito_rails/method_call_situations_controller.rb

@@ -3,7 +3,10 @@ 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)
+      @method_call_situations = MethodCallSituation
+                                .page(params[Kaminari.config.param_name])
+                                .per(20)
+                                .order(class_name: :asc, method_symbol: :asc, method_name: :asc)
     end
   end
 end

data/app/models/okuribito_rails/method_call_log.rb

@@ -1,5 +1,9 @@
 module OkuribitoRails
   class MethodCallLog < ActiveRecord::Base
     belongs_to :method_call_situation
+
+    validates :class_name, presence: true, length: { minimum: 1, maximum: 255 }
+    validates :method_symbol, presence: true, inclusion: { in: %w(. #) }
+    validates :method_name, presence: true, length: { minimum: 1, maximum: 255 }
   end
 end

data/app/models/okuribito_rails/method_call_situation.rb

@@ -1,5 +1,12 @@
 module OkuribitoRails
   class MethodCallSituation < ActiveRecord::Base
     has_many :method_call_logs
+
+    validates :class_name, presence: true, length: { minimum: 1, maximum: 255 }
+    validates :method_symbol, presence: true, inclusion: { in: %w(. #) }
+    validates :method_name, presence: true, length: { minimum: 1, maximum: 255 }
+    validates :called_num,
+              presence: true,
+              numericality: { only_integer: true, less_than_or_equal_to: 9_999 }
   end
 end

data/lib/generators/okuribito_rails/install_generator.rb

@@ -1,12 +1,12 @@
-require 'rails/generators'
+require "rails/generators"
 
 module OkuribitoRails
   class InstallGenerator < Rails::Generators::Base
-    class_option "with-migrate", :type => :boolean
+    class_option "with-migrate", type: :boolean
 
     def start
       puts "Start installing okuribito_rails..."
-      puts ("*" * 80) + "\n"
+      puts "*" * 80 + "\n"
     end
 
     def install_migrations
@@ -17,10 +17,9 @@ module OkuribitoRails
     end
 
     def run_migrations
-      if options["with-migrate"]
-        puts "Running rake db:migrate"
-        `rake db:migrate`
-      end
+      return unless options["with-migrate"]
+      puts "Running rake db:migrate"
+      `rake db:migrate`
     end
 
     def mount_engine
@@ -30,8 +29,8 @@ module OkuribitoRails
 
     def create_config_initializer
       puts "Create configuration..."
-      OkuribitoRails::InstallGenerator.source_root File.expand_path('../templates', __FILE__)
-      template 'initializer.erb', 'config/initializers/okuribito_rails.rb'
+      OkuribitoRails::InstallGenerator.source_root File.expand_path("../templates", __FILE__)
+      template "initializer.erb", "config/initializers/okuribito_rails.rb"
     end
 
     def finished
@@ -41,4 +40,4 @@ module OkuribitoRails
       puts "(The yaml that defines the method you want to monitor)"
     end
   end
-end
+end

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

@@ -3,5 +3,5 @@ OkuribitoRails.configure do |config|
   config.setting_path = "config/okuribito.yml"
 
   # Detecting method calls only once during application running.
-  config.once_detect = false
+  config.once_detect = true
 end

data/lib/okuribito_rails/config.rb

@@ -5,4 +5,4 @@ module OkuribitoRails
     config_accessor :once_detect
     config_accessor :setting_path
   end
-end
+end

data/lib/okuribito_rails/observe_method.rb

@@ -3,7 +3,9 @@ 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|
+      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)
@@ -18,4 +20,4 @@ module OkuribitoRails
       end
     end
   end
-end
+end

data/lib/okuribito_rails/railtie.rb

@@ -4,15 +4,17 @@ 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'
+      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)
+        unless yaml_path.nil?
+          # 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)
+          # 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/version.rb

@@ -1,3 +1,3 @@
 module OkuribitoRails
-  VERSION = "0.0.1"
+  VERSION = "0.0.2".freeze
 end

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,5 @@
+
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css
+//= link okuribito_rails_manifest.js

data/spec/dummy/app/assets/javascripts/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 any plugin's vendor/assets/javascripts directory 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. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the rails generate channel command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * 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 any plugin's vendor/assets/stylesheets directory 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 bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+
+    <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track': 'reload' %>
+    <%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/bin/update

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  puts "\n== Updating database =="
+  system! 'bin/rails db:migrate'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require_relative 'boot'
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+require "active_job/railtie"
+require "action_cable/engine"
+# require "rails/test_unit/railtie"
+require "sprockets/railtie"
+
+Bundler.require(*Rails.groups)
+require "okuribito_rails"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/spec/dummy/config/cable.yml

@@ -0,0 +1,9 @@
+development:
+  adapter: async
+
+test:
+  adapter: async
+
+production:
+  adapter: redis
+  url: redis://localhost:6379/1

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative 'application'
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,54 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Enable/disable caching. By default caching is disabled.
+  if Rails.root.join('tmp/caching-dev.txt').exist?
+    config.action_controller.perform_caching = true
+
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      'Cache-Control' => 'public, max-age=172800'
+    }
+  else
+    config.action_controller.perform_caching = false
+
+    config.cache_store = :null_store
+  end
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  config.action_mailer.perform_caching = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Suppress logger output for asset requests.
+  config.assets.quiet = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+
+  # Use an evented file watcher to asynchronously detect changes in source code,
+  # routes, locales, etc. This feature depends on the listen gem.
+  # config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+end