custom_log_space 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 98b901d882ede4d8684e25e13741a5e65eb6f61cbbae5b4e8bb597c15781d23e
+  data.tar.gz: bf6f8ccf000f73f92d4b94853847d7f04cfb575b6460bbb791702a1f4ed8514d
+SHA512:
+  metadata.gz: dc4463dfe438bf6d25b200177211506c5e34c3011199caf737013083f121ceb0004d633901d3bf859a89037137b99e9bef5907e1ccdc35ee4e096a8b6e9da096
+  data.tar.gz: 173effc0824a52f8cf383d91c15c027157b03c2c0ffbf46b99368cb0b9a841a05eba2f37131083f61e880bc95ffb5c1fc4b9fa9183f46f1358c08d910ff3d852

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 150
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-09-12
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at tatsunishitatsu@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 nishikawa1031
+
+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 @@
+# CustomLogSpace
+
+The CustomLogSpace gem allows Rails developers to direct Rails logs to files, organized by each controller and action. This organization simplifies debugging and analysis.
+
+## Installation
+
+To begin, add the gem to your application's Gemfile:
+
+```ruby
+group :development do
+  gem 'custom_log_space'
+end
+```
+
+Next, run:
+
+```bash
+$ bundle install
+```
+
+Alternatively, you can install it directly using:
+
+```bash
+$ gem install custom_log_space
+```
+
+## Usage
+Logs are saved in the `log/custom_log_space/[date]/[time]/[controller_name]/` directory. The filenames follow the pattern: "[action_name].log".
+
+<img width="492" alt="スクリーンショット 2023-09-12 8 37 43" src="https://github.com/nishikawa1031/custom_log_space/assets/53680568/95cf44c8-e256-44d0-b0cb-9d6367601985">
+
+
+## Supported environments
+- Rails 7
+- Ruby 3
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/custom_log_space. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/custom_log_space/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+This gem is open-sourced under the [MIT License](https://opensource.org/licenses/MIT) terms.
+
+## Code of Conduct
+
+All participants in the CustomLogSpace project, whether they're interacting with codebases, issue trackers, chat rooms, or mailing lists, are expected to follow the [code of conduct](https://github.com/nishikawa1031/custom_logger/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/custom_log_space.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/custom_log_space/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "custom_log_space"
+  spec.version = CustomLogSpace::VERSION
+  spec.authors = ["nishikawa1031"]
+  spec.email = ["tatsunishitatsu@gmail.com"]
+
+  spec.summary = "A Rails logger extension that organizes logs by controller and action into dedicated folders."
+  spec.description = "CustomLogSpace refines Rails logs by categorizing them by controller and action. It provides a clearer view."
+  spec.homepage = "https://github.com/nishikawa1031/custom_log_space.git"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/nishikawa1031/custom_log_space.git"
+  spec.metadata["changelog_uri"] = "https://github.com/nishikawa1031/custom_log_space/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_runtime_dependency "activesupport", ">= 6.0", "< 8.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/custom_log_space/base_subscriber.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module CustomLogSpace
+  # CustomLogSpace::Subscriber is a class for handling custom logging in Rails applications.
+  # It provides methods for processing different types of log events and organizing log messages.
+  class BaseSubscriber < ActiveSupport::LogSubscriber
+    def start_processing(event)
+      setup_thread_variables(event.payload)
+    end
+
+    def process_action(event)
+      payload = event.payload
+      status = payload[:status]
+      duration = event.duration.round(2)
+      view_runtime = payload[:view_runtime]&.round(2)
+      db_runtime = payload[:db_runtime]&.round(2)
+      allocations = event.allocations
+
+      message = "Completed #{status} #{Rack::Utils::HTTP_STATUS_CODES[status]} in #{duration}ms " \
+          "(Views: #{view_runtime}ms | ActiveRecord: #{db_runtime}ms | Allocations: #{allocations})"
+
+      log_message(message)
+      clear_thread_variables
+    end
+
+    private
+
+    def setup_thread_variables(payload)
+      Thread.current[:current_controller] = payload[:controller]
+      Thread.current[:current_action] = payload[:action]
+      Thread.current[:path] = payload[:path]
+      Thread.current[:params] = payload[:params].except(:controller, :action)
+      Thread.current[:header_written] = false
+    end
+
+    def clear_thread_variables
+      Thread.current[:current_controller] = nil
+      Thread.current[:current_action] = nil
+      Thread.current[:path] = nil
+      Thread.current[:params] = nil
+      Thread.current[:header_written] = nil
+    end
+
+    def log_message(message)
+      current_controller = Thread.current[:current_controller]
+      current_action = Thread.current[:current_action]
+
+      return unless current_controller && current_action
+
+      FileUtils.mkdir_p(controller_log_directory) unless Dir.exist?(controller_log_directory)
+      write_to_custom_log(message)
+    end
+
+    def custom_log_directory
+      today = Time.now.strftime("%Y%m%d")
+      time = Time.now.strftime("%H%M")
+      File.join(Rails.root, "log", "custom_log_space", today, time)
+    end
+
+    def controller_log_directory
+      controller_name = Thread.current[:current_controller].underscore
+      File.join(custom_log_directory, controller_name)
+    end
+
+    def custom_log_file_path
+      action_name = Thread.current[:current_action]
+      log_file_name = "#{action_name}.log"
+      File.join(controller_log_directory, log_file_name)
+    end
+
+    def write_to_custom_log(message)
+      custom_log_path = custom_log_file_path
+
+      File.open(custom_log_path, "a") do |file|
+        write_header_information(file)
+        file.puts(message)
+      end
+    rescue SystemCallError, IOError => e
+      handle_file_error(e)
+    end
+
+    def handle_file_error(error)
+      error_prefix = error.is_a?(SystemCallError) ? "Error" : "IO Error"
+      puts "#{error_prefix}: #{error.message}"
+    end
+
+    def write_header_information(file)
+      return if Thread.current[:header_written]
+
+      current_controller = Thread.current[:current_controller]
+      current_action = Thread.current[:current_action]
+
+      file.puts("") # Add a blank line for better readability.
+      write_request_info(file)
+      write_processing_info(file, current_controller, current_action)
+      write_parameters_info(file)
+      Thread.current[:header_written] = true
+    end
+
+    def write_request_info(file)
+      formatted_time = Time.now.strftime("%Y-%m-%d %H:%M:%S %z")
+      file.puts "Started GET \"#{Thread.current[:path]}\" for ::1 at #{formatted_time}"
+    end
+
+    def write_processing_info(file, current_controller, current_action)
+      file.puts "Processing by #{current_controller}##{current_action} as HTML"
+    end
+
+    def write_parameters_info(file)
+      params = Thread.current[:params] || {}
+      file.puts "Parameters: #{params.inspect}" unless params.empty?
+    end
+  end
+end

data/lib/custom_log_space/sql_subscriber.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# SQLSubscriber logs SQL related events for CustomLogSpace.
+# It extends BaseSubscriber to make use of its logging capabilities.
+class SQLSubscriber < CustomLogSpace::BaseSubscriber
+  def sql(event)
+    payload = event.payload
+    name = payload[:name]
+    sql = payload[:sql]
+    duration = event.duration.round(1)
+    message = "#{name} (#{duration}ms) #{sql}"
+    log_message(message)
+  end
+end

data/lib/custom_log_space/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CustomLogSpace
+  VERSION = "0.1.0"
+end

data/lib/custom_log_space/view_subscriber.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# ViewSubscriber logs view rendering events for CustomLogSpace.
+# It tracks events like template rendering, partial rendering, and collection rendering.
+class ViewSubscriber < CustomLogSpace::BaseSubscriber
+  def render_template(event)
+    identifier = event.payload[:identifier]
+    duration = event.duration.round(2)
+    allocations = event.allocations
+    message = "Rendered #{identifier} (Duration: #{duration}ms | Allocations: #{allocations})"
+
+    log_message(message)
+  end
+
+  def render_partial(event)
+    identifier = event.payload[:identifier]
+    duration = event.duration.round(2)
+    allocations = event.allocations
+    message = "Rendered partial #{identifier} (Duration: #{duration}ms | Allocations: #{allocations})"
+
+    log_message(message)
+  end
+
+  def render_collection(event)
+    identifier = event.payload[:identifier]
+    count = event.payload[:count]
+    duration = event.duration.round(2)
+    allocations = event.allocations
+    message = "Rendered collection #{identifier} (#{count} items) (Duration: #{duration}ms | Allocations: #{allocations})"
+
+    log_message(message)
+  end
+end

data/lib/custom_log_space.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "custom_log_space/base_subscriber"
+require "custom_log_space/sql_subscriber"
+require "custom_log_space/view_subscriber"
+
+CustomLogSpace::BaseSubscriber.attach_to :action_controller
+SQLSubscriber.attach_to :active_record
+ViewSubscriber.attach_to :action_view

data/sig/change_rails_log_path.rbs

@@ -0,0 +1,4 @@
+module CustomLogSpace
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/sig/custom_log_space.rbs

@@ -0,0 +1,4 @@
+module CustomLogSpace
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: custom_log_space
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- nishikawa1031
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+description: CustomLogSpace refines Rails logs by categorizing them by controller
+  and action. It provides a clearer view.
+email:
+- tatsunishitatsu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- custom_log_space.gemspec
+- lib/custom_log_space.rb
+- lib/custom_log_space/base_subscriber.rb
+- lib/custom_log_space/sql_subscriber.rb
+- lib/custom_log_space/version.rb
+- lib/custom_log_space/view_subscriber.rb
+- sig/change_rails_log_path.rbs
+- sig/custom_log_space.rbs
+homepage: https://github.com/nishikawa1031/custom_log_space.git
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/nishikawa1031/custom_log_space.git
+  source_code_uri: https://github.com/nishikawa1031/custom_log_space.git
+  changelog_uri: https://github.com/nishikawa1031/custom_log_space/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: A Rails logger extension that organizes logs by controller and action into
+  dedicated folders.
+test_files: []