ruby_blogger 1.0.8 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 822a5f173f0f3744fd21a745c7bc97c4846bbfc7c4d133cd39c7ad5cdf3908e8
-  data.tar.gz: 7669e3e7b58e1ddd2b493cc850f83bf9551a0a66006a3454b1e62afc663977a1
+  metadata.gz: 86e0f78c6ceff5429fc848afc12d678da8a596d02032925d1484bca1a11eedf8
+  data.tar.gz: 4e9655942941ed3b2bacbcee19af36a3394af76e523584f2ffdba639943023f9
 SHA512:
-  metadata.gz: 567a616b2336d35180e5e29d0e685dffbd82b9955a8ab94affb91c99e8d2a5d9a99b4ecd7f4cdf2558fc65007ae99edd99d42709da4e55a13ca2d192317ffd66
-  data.tar.gz: eb8a1732fd754fcdffc8d51d500c42ec765c9716a5675669326fa169a5b910e967df549d63d1c4f2180dede5f44738b54b711b6aeb9d8aef1e5769748ab25b83
+  metadata.gz: 702d42d9b17280ad6f99340a1419d5a73ee9a8380c57c576fe8af73c2702a0080eb8f5a53580d92cdc5c50c41ff2e3994e0c1953da94af0ae98ad33cfb183be0
+  data.tar.gz: 60432abdea74ed397af4d1870e92d6d811df072c5a4cab06c86e053a0d4439f5e1434b5ea15065a6413a808c01eaae173f7bd56ee695d41b047bf5c9786326b9

data/lib/Blog.rb

@@ -0,0 +1,101 @@
+require 'bundler/setup'
+require 'yaml'
+require_relative 'BloggerException.rb'
+
+class Blog
+  attr_reader :exceptions, 
+                :count_of_exceptions_in_folder,
+                :unique_files, :count_and_files,
+                :unique_exception_types, :specified_file
+
+  FILE = 'structured_exceptions.yml'
+  NO_EXCEPTIONS = "No exceptions have been raised by files that require 'ruby_blogger'"
+
+  def initialize(specified_file = nil)
+    @exceptions = YAML.load_stream(File.read(FILE))
+    @unique_files = exceptions.map { |exc| exc.file }.uniq
+    @count_and_files = "#{exceptions.length} in #{unique_files.join(' ')}"
+    @unique_exception_types = exceptions.map { |exc| exc.type }.uniq
+    @specified_file = specified_file
+  end
+
+  def count(type) 
+    exceptions.select { |exc| exc.type == type }.length
+  end 
+
+  def header
+    system('clear')
+    puts "Total Exceptions: #{count_and_files}"
+  end
+
+  def folder_exceptions
+    unique_exception_types.each do |type|
+      puts  "\n"
+      puts "Exception Class: #{type}"
+      puts "Total: #{self.count(type)}"
+      puts "-" * 15
+    end
+  end
+
+  def display_summary
+    self.header
+    self.folder_exceptions
+  end
+
+  def read_exceptions_for_file(filename)
+    exceptions.select { |exc| exc.file == filename }
+  end 
+
+  def display_exceptions_for_file(filename)
+    file_exceptions = read_exceptions_for_file(filename)
+    file_exceptions.each do |exc| 
+      display_file_header(filename)
+      exc.display
+    end
+    display_file_trailer
+  end 
+
+  def display_file_header(filename)
+    puts "\n"
+    puts "File: #{filename}"
+    puts '-' * 15
+  end 
+
+  def display_file_trailer
+    puts '-' * 15
+  end
+
+  def display_file_does_not_exist(file)
+    puts "Sorry, #{file} is not a file in this folder."
+  end 
+
+  def display_blog
+    if legit_file?(specified_file)
+      self.display_exceptions_for_file(specified_file) 
+    elsif illegit_file?(specified_file)
+      self.display_file_does_not_exist(specified_file)
+    else 
+      self.display_summary
+    end
+  end
+
+  def legit_file?(file)
+    file && File.exist?(file)
+  end 
+
+  def illegit_file?(file)
+    file && !File.exist?(file)
+  end
+
+  def self.exceptions?
+    unless File.exist?(FILE)
+      puts NO_EXCEPTIONS 
+    else return true
+    end
+  end
+
+  def self.generate_and_display_blog
+    blog = self.new(ARGV[0])
+    blog.display_blog
+  end 
+end

data/lib/BloggerException.rb

@@ -0,0 +1,60 @@
+class BloggerException
+  def initialize
+    @file = $0
+    @line = $!.backtrace[0].split(':')[1]
+    @cause = $!.backtrace[0].split('`')[-1]
+    @message = $!.message
+    @type = $!.class.to_s
+    @description = generate_description(self.type.to_sym)
+    @scope = $!.backtrace[0].split(/\./)[0]
+    @time = Time.now.strftime("%I:%M:%S %p")
+    @date = Time.now.strftime("%m/%d/%y")
+  end
+
+  DESCRIPTIONS = {
+    ZeroDivisionError: "Attempting to divide an Integer by 0.", 
+    NoMethodError: "A method is called on a receiver that does not have that method defined."
+  }
+
+  def to_s
+    <<~MLS 
+    :file: #{file}
+    :line: #{line}
+    :cause: #{cause}
+    :message: #{message}
+    :type: #{type}
+    :description #{description}
+    :scope: #{scope}
+    :time: #{time}
+    MLS
+  end
+
+  def display
+    puts <<~MLS
+    \tClass #{self.type}
+    \tDescription: #{self.description}
+    \tLine: #{self.line}
+    \tTime: #{self.time}
+    \tDate: #{self.date}
+    MLS
+  end
+
+  def log
+    File.open('structured_exceptions.yml', 'a+') do |file|
+      file.write (self.to_yaml)
+    end 
+    puts 'Bug Logged Successfully:'
+  end
+
+  def generate_description(type)
+    return DESCRIPTIONS[type] if DESCRIPTIONS.key?(type)
+    return 'Check out https://ruby-doc.org/core-2.7.0/Exception.html for more information.'
+  end
+
+  attr_reader :file, :line, :type, 
+              :description, :time, :date
+private
+  attr_reader :cause,
+              :message, 
+              :scope
+end

data/lib/read_exceptions.rb

@@ -1,133 +1,8 @@
 require 'bundler/setup'
 require 'yaml'
-#opens the .yml file, which is an IO object, passes it to YAML.load_streams. In the block, yaml_doc represents each exception in the .yml file
-def read_all_exceptions
-  exceptions = []
-  File.open('structured_exceptions.yml') do |yaml_file|
-    YAML.load_stream(yaml_file) do |yaml_doc|
-      exceptions << yaml_doc 
-    end
-  end 
-  exceptions
-end 
+require_relative 'BloggerException.rb'
+require_relative 'Blog.rb'
 
-#The following grouping of methods parse and display exception data for the whole project folder
+Blog.generate_and_display_blog if Blog.exceptions?
 
-def get_total_project_exceptions_and_filenames(exceptions)
-  count = exceptions.length
-  filenames = get_all_filenames(exceptions)
-  "#{count} in #{filenames}"
-end
 
-def get_count_of_each_exception_class(exceptions)
-  counts = {}
-  exceptions.each do |exception|
-    type = exception[:type]
-    counts[type] ? counts[type] += 1 : counts[type] = 1
-  end 
-  counts
-end
-
-#captures all filenames that require ruby_blogger that have raised exceptions
-def get_all_filenames(exceptions)
-  exceptions.map { |exc| exc[:filename]}.uniq.join(', ')
-end 
-
-#display count of total exceptions and each exception class and its count
-def display_total_and_counts(total, counts)
-  system('clear')
-  puts "Total Exceptions: #{total}"
-  counts.each do |type, count|
-    puts  "\n"
-    puts "Exception Class: #{type}"
-    puts "Total: #{count}"
-    puts "-" * 15
-  end
-end
-
-#combines all get methods to display all exceptions and counts raised by all files in the project folder
-def display_summary
-  exceptions = read_all_exceptions
-  total = get_total_project_exceptions_and_filenames(exceptions)
-  counts = get_count_of_each_exception_class(exceptions)
-  display_total_and_counts(total, counts)
-end 
-
-#These methods parse and display exception data for specified files
-
-#get all exceptions for a given filename
-def read_exceptions_for_file(filename)
-  exceptions = read_all_exceptions
-  exceptions.select do |exc|
-    exc[:filename] == filename
-  end 
-end 
-
-#display all exceptions and data for a given filename
-def display_exceptions_for_file(filename)
-  display_header_info(filename)
-  display_each_exception(filename)
-  display_trailer
-end 
-
-#passes each exception to format_exception_line and outputs each line
-def display_each_exception(filename)
-exceptions = read_exceptions_for_file(filename)
-  lines = exceptions.map do |exc|
-    format_exception_line(exc[:type], 
-                          exc[:description],
-                          exc[:line_number],
-                          exc[:time])
-  end 
-  puts lines
-end 
-
-#provide simple formatting for each exception class and line number
-def format_exception_line(type, description, line, time)
-  date, time, tz = separate_date_and_time(time)
-  line_hash = { class: type,
-                description: description,
-                Line: line,
-                Time: time,
-                Date: date }
-  line_hash.map { |pair| pair.join(': ') }.join("\n   ")
-end 
-
-#separates date, time, and tz
-def separate_date_and_time(time)
-  time.to_s.split(/\s/)
-end 
-
-#display simple header in CL
-def display_header_info(filename)
-  puts "\n"
-  puts "File: #{filename}"
-  puts '-' * 15
-end 
-
-#display simple trailer in CL
-def display_trailer
-  puts '-' * 15
-end
-
-#displays error message if user specifies non-existent file
-def display_file_does_not_exist(file)
-  puts "Sorry, #{file} is not a file in this folder."
-end 
-
-def display_no_exceptions 
-  puts "No exceptions have been raised by files that require 'ruby_blogger'"
-end 
-
-#functional logic to capture command line input and either display information for the file specified in the command line or display data for the entire folder if no file is specified.
-specified_file = ARGV[0]
-
-if !File.exist?('structured_exceptions.yml') 
-  display_no_exceptions
-elsif specified_file && File.exist?(specified_file)
-  display_exceptions_for_file(specified_file) 
-elsif specified_file && !File.exist?(specified_file)
-  display_file_does_not_exist(specified_file)
-else 
-  display_summary
-end

data/lib/ruby_blogger.rb

@@ -1,39 +1,9 @@
 require 'bundler/setup'
 require 'yaml'
+require_relative 'BloggerException.rb'
 
 at_exit do 
-  if $! 
-    blogger = create_instance($!)
-    logging(blogger)
-  end
+  BloggerException.new.log if $!
 end
 
-def get_error_description(type)
-  errors = {
-    ZeroDivisionError: "Attempting to divide an Integer by 0.", 
-    NoMethodError: "A method is called on a receiver that does not have that method defined."
-  }
 
-  return errors[type] if errors.key?(type)
-  return 'Check out https://ruby-doc.org/core-2.7.0/Exception.html for more information.' if !errors.key?(type)
-end
-
-def create_instance(exception)
-  blogger_entry = {}
-  blogger_entry[:filename] = $0
-  blogger_entry[:line_number] = $!.backtrace[0].split(':')[1]
-  blogger_entry[:cause] = $!.backtrace[0].split('`')[-1]
-  blogger_entry[:message] = $!.message
-  blogger_entry[:type] = $!.class.to_s
-  blogger_entry[:description] = get_error_description($!.class.to_s.to_sym)
-  blogger_entry[:scope] = self.to_s
-  blogger_entry[:time] = Time.now
-  blogger_entry
-end
-
-def logging(structured)
-  File.open('structured_exceptions.yml', 'a+') do |file|
-    file.write (structured.to_yaml)
-  end 
-  puts 'Bug Logged Successfully:'
-end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: ruby_blogger
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
 platform: ruby
 authors:
 - Leena Lallmon
 - Austin Miller
 - Mandy Cheang
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-07 00:00:00.000000000 Z
+date: 2021-02-15 00:00:00.000000000 Z
 dependencies: []
 description: A command line developer tool to track exceptions
 email:
@@ -22,13 +22,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/blog
+- lib/Blog.rb
+- lib/BloggerException.rb
 - lib/read_exceptions.rb
 - lib/ruby_blogger.rb
 homepage: https://github.com/aumi9292/blogger
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -44,7 +46,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Capture and display data about exceptions your .rb file raises
 test_files: []