draft_log 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 36f46dd78b0ded9dcdeba3b153dec5ab87c47806
+  data.tar.gz: 5246d03add703e7f90ae834d8f149a7503358e32
+SHA512:
+  metadata.gz: e66b0b32931677b61f0f6c5fd7ca860c5c6ed386c89024ca3a9e3cadb7c94d3490abf9acdb8fc9d80c4c0a8a53726b8e7576ae9aea82da31780ea925cfd73b01
+  data.tar.gz: 9c213af1dd133002a66775cc082f0d914ccfe5b7552349d7051d3311ba9e4fd3a59bf61189f11558ba9d0264b3c4df1f76f2850d111eb25b386fce44d53c4cdd

data/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "juwelier", "~> 2.1.0"
+  gem "simplecov", ">= 0"
+end
+
+gem 'awesome_print'

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2018 Murugan
+
+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.rdoc

@@ -0,0 +1,18 @@
+= draft_log
+
+Description goes here.
+
+== Contributing to draft_log
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2018 Firstdraft. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+require 'juwelier'
+Juwelier::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "draft_log"
+  gem.homepage = "http://github.com/firstdraft/draft_log"
+  gem.license = "MIT"
+  gem.summary = %Q{Helpful log for beginners}
+  gem.description = %Q{Helpful log for beginners}
+  gem.email = "murugan@firstdraft.com"
+  gem.authors = ["Murugan"]
+
+  # dependencies defined in Gemfile
+end
+Juwelier::RubygemsDotOrgTasks.new
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "draft_log #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/draft_log.gemspec

@@ -0,0 +1,67 @@
+# Generated by juwelier
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: draft_log 0.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "draft_log"
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Murugan"]
+  s.date = "2018-01-16"
+  s.description = "Helpful log for beginners"
+  s.email = "murugan@firstdraft.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "draft_log.gemspec",
+    "lib/draft_log.rb",
+    "lib/draft_log/add_extra_request_log_data.rb",
+    "lib/draft_log/log_subscriber.rb",
+    "lib/draft_log/rails_ext/rack/logger.rb",
+    "lib/draft_log/railtie.rb",
+    "lib/draft_log/view_log_subscriber.rb"
+  ]
+  s.homepage = "http://github.com/firstdraft/draft_log"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.5.1"
+  s.summary = "Helpful log for beginners"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<awesome_print>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<juwelier>, ["~> 2.1.0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<awesome_print>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<juwelier>, ["~> 2.1.0"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<awesome_print>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<juwelier>, ["~> 2.1.0"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/lib/draft_log.rb

@@ -0,0 +1,41 @@
+require "draft_log/log_subscriber"
+require "draft_log/view_log_subscriber"
+require "draft_log/add_extra_request_log_data"
+require "awesome_print"
+
+if defined? Rails
+  require "draft_log/railtie"
+  require 'draft_log/rails_ext/rack/logger'
+end
+
+module DraftLog
+  module_function
+
+  def setup
+    remove_existing_log_subscriptions
+    ActionController::Base.send :prepend, AddExtraRequestLogData
+  end
+
+  def remove_existing_log_subscriptions
+    ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
+      case subscriber
+      when ActionController::Base
+      when ActionView::LogSubscriber
+        unsubscribe(:action_view, subscriber)
+      when ActionController::LogSubscriber
+        unsubscribe(:action_controller, subscriber)
+      end
+    end
+  end
+
+  def unsubscribe(component, subscriber)
+    events = subscriber.public_methods(false).reject { |method| method.to_s == 'call' }
+    events.each do |event|
+      ActiveSupport::Notifications.notifier.listeners_for("#{event}.#{component}").each do |listener|
+        if listener.instance_variable_get('@delegate') == subscriber
+          ActiveSupport::Notifications.unsubscribe listener
+        end
+      end
+    end
+  end
+end

data/lib/draft_log/add_extra_request_log_data.rb

@@ -0,0 +1,16 @@
+module DraftLog
+  module AddExtraRequestLogData
+    def append_info_to_payload(payload)
+      super
+      payload[:query_string] = request.query_parameters
+      payload[:params] = request.params.except(:controller, :action)
+      payload[:cookies] = cookies.to_h.select{|x| !x.ends_with?("_session") }
+      payload[:session] = session.to_hash.select{|x| ["session_id", "_csrf_token"].exclude?(x) }
+      payload[:path_param] = request.path_parameters.except(:controller, :action, :format, :_method, :only_path)
+      payload[:controller_instance_var] = instance_variables.select{|x| !x.to_s.start_with?('@_') }.reject{|y| y == :@marked_for_same_origin_verification }.
+        inject({}) {|result, element| result[element.to_s] = instance_variable_get(element.to_s).to_s; result }
+      payload[:view_log_event_data] = Thread.current[:view_log_payload]
+      Thread.current[:view_log_payload] = nil
+    end
+  end
+end

data/lib/draft_log/log_subscriber.rb

@@ -0,0 +1,70 @@
+require "active_support"
+
+module DraftLog
+  class LogSubscriber < ActiveSupport::LogSubscriber
+
+    def process_action(event)
+      payload = event.payload
+      param_method = payload[:params]["_method"]
+      method = param_method ? param_method.upcase : payload[:method]
+      
+      message = %Q{\nWe received a request at #{Time.now.strftime("%I:%M%p on %A, %b %d!")} Someone wants to
+  #{method} #{payload[:path]}
+
+The route told me to use the #{payload[:controller].ai} and #{payload[:action].ai} action.\n\n}
+
+      message += flexible_path_segment(payload) if payload[:path_param].present?
+      message += custom_query_string(payload) if payload[:query_string].present?
+      message += custom_params(payload) if payload[:params].present?
+      # message += custom_cookies(payload) if payload[:cookies].present?
+      # message += custom_session(payload) if payload[:session].present?
+      message += custom_instance_var(payload) if payload[:controller_instance_var].present?
+      message += view_log(payload) if payload[:view_log_event_data].present?
+      message += "==============================================================================================================\n"
+
+      logger.warn message
+    end
+
+    private
+
+    def flexible_path_segment(payload)
+      "I found these inputs in flexible path segments:
+#{payload[:path_param].ai}\n\n"
+    end
+
+    def custom_query_string(payload)
+      "I found these inputs in the query string:
+#{payload[:query_string].ai}\n\n"
+    end
+
+    def custom_params(payload)
+      "The final params hash containing all inputs looks like this:
+  # params
+#{payload[:params].ai}\n\n"
+    end
+
+    def custom_cookies(payload)
+      "Here are the cookies that came along with the request:
+  # cookies
+#{payload[:cookies].ai}\n\n"
+    end
+
+    def custom_session(payload)
+      "  # session
+#{payload[:session].ai}\n\n"
+    end
+
+    def custom_instance_var(payload)
+      %Q{The "#{payload[:controller].ai}##{payload[:action].ai}" action defined these instance variables:
+#{payload[:controller_instance_var].ai}\n\n}
+    end
+
+    def view_log(payload)
+      template_path = payload[:view_log_event_data][:identifier].sub("#{Rails.root.to_s}/", '')
+      %Q{The #{(payload[:controller] + "#" + payload[:action]).ai} action told me to use
+  #{template_path.ai}
+to format the response.\n\n}
+    end
+
+  end
+end

data/lib/draft_log/rails_ext/rack/logger.rb

@@ -0,0 +1,9 @@
+module Rails
+  module Rack
+    class Logger < ActiveSupport::LogSubscriber
+      def started_request_message(request)
+        
+      end
+    end
+  end
+end

data/lib/draft_log/railtie.rb

@@ -0,0 +1,12 @@
+module DraftLog
+  class Railtie < Rails::Railtie
+
+    config.after_initialize do |app|
+      DraftLog.setup
+      ActionController::Base.send :prepend, AddExtraRequestLogData
+    end
+
+    DraftLog::LogSubscriber.attach_to :action_controller
+    DraftLog::ViewLogSubscriber.attach_to :action_view
+  end
+end

data/lib/draft_log/view_log_subscriber.rb

@@ -0,0 +1,11 @@
+require "active_support"
+
+module DraftLog
+  class ViewLogSubscriber < ActiveSupport::LogSubscriber
+
+    def render_template(event)
+      Thread.current[:view_log_payload] = event.payload
+    end
+
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: draft_log
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Murugan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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: shoulda
+  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: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: juwelier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Helpful log for beginners
+email: murugan@firstdraft.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- draft_log.gemspec
+- lib/draft_log.rb
+- lib/draft_log/add_extra_request_log_data.rb
+- lib/draft_log/log_subscriber.rb
+- lib/draft_log/rails_ext/rack/logger.rb
+- lib/draft_log/railtie.rb
+- lib/draft_log/view_log_subscriber.rb
+homepage: http://github.com/firstdraft/draft_log
+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: Helpful log for beginners
+test_files: []