console_buddy 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1974a84f07b540eb25e77ad91b3e5271dc2a8db54b182f98a6ff7c7edcef6070
+  data.tar.gz: 9aa0bba710385fb7e39dc04911591f99506b187698f3466777ec5cb48646b4ba
+SHA512:
+  metadata.gz: 87fd331b06f92bc97f36d02d5bbd0eb18ff784bd627be1d8ccedaad0c3669cbbf34713f488a8d986931bc4405babf9c72b4d41066d0eed8dc8769f8be9a4172d
+  data.tar.gz: e15e875ec308c774041d3dc670c5d4a793e3dc9fa9ac7b2ecf8f1838d26777b3884928499af27dcd692363fa44fbc8c645e3fbd04828ac5874be09796d390d2b

data/lib/console_buddy/augment.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+
+# Example:
+# 
+# Here we are defining a method called `sps` on the `User` model.
+# This method will return the saved posts for a given user record.
+# 
+# 
+# ConsoleBuddy::Augment.define do
+#   method User, :sps do |args|
+#     saved_posts
+#   end
+# end
+
+module ConsoleBuddy
+  class Augment
+    class << self
+      def define(&block)
+        if block_given?
+          instance = ::ConsoleBuddy::Augment::DSL.new
+          instance.instance_eval(&block)
+        end
+      end
+    end
+
+    class DSL
+      class InvalidTypeError < StandardError; end
+
+      def method(klass, method_name, type: :instance, &block)
+        raise InvalidTypeError, "Invalid method type. Must be either :instance or :class" unless %i[instance class].include?(type)
+
+        store(klass) <<  { method_name: method_name, block: block, method_type: type }
+      end
+
+      def method_alias(klass, method_name, new_method_name, type: :instance)
+        raise InvalidTypeError, "Invalid method type. Must be either :instance or :class" unless %i[instance class].include?(type)
+
+        block = ::Proc.new { |*args| send(method_name, *args) }
+        store(klass) <<  { method_name: new_method_name, block: block, method_type: type }
+      end
+
+      private
+
+      def store(klass)
+        ConsoleBuddy.store.augment_helper_methods[klass.to_s]
+      end
+    end
+  end
+end

data/lib/console_buddy/base.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "irb"
+
+module ConsoleBuddy
+  class Base
+    include ::ConsoleBuddy::IRB
+  end
+end

data/lib/console_buddy/byebug/buddy_command.rb

@@ -0,0 +1,62 @@
+require 'byebug'
+require 'byebug/command'
+
+require_relative '../irb'
+
+module ConsoleBuddy
+  module Byebug
+    class BuddyCommand < ::Byebug::Command
+      include ::ConsoleBuddy::IRB
+      #
+      # Return a regex to match the "buddy" command input.
+      #
+      # Example: buddy.ping "http://example.com"
+      def self.regexp
+        /^\s*buddy(?:\.(\w+))?\s*(.*)$/
+      end
+
+      def self.buddy
+        ::ConsoleBuddy::Base.new
+      end
+
+      #
+      # Execute the command.
+      #
+      def execute
+        method_name = @match[1]
+        args = @match[2]
+
+        if method_name
+          result = self.class.buddy.send(method_name, *parse_args(args))
+          puts result
+        else
+          puts "Buddy command executed"
+        end
+      end
+
+      #
+      # Short description shown in the 'help' output.
+      #
+      def short_description
+        "Executes buddy commands"
+      end
+
+      #
+      # Long description shown in the 'help <command>' output.
+      #
+      def long_description
+        "Executes buddy commands with optional method calls, e.g., buddy.ping"
+      end
+
+
+      private
+
+      def parse_args(args)
+        eval(args)
+      rescue SyntaxError, NameError => e
+        puts "Error parsing arguments: #{e.message}"
+        []
+      end
+    end
+  end
+end

data/lib/console_buddy/byebug/hello_command.rb

@@ -0,0 +1,34 @@
+require 'byebug'
+require 'byebug/command'
+
+module ConsoleBuddy
+  module Byebug
+    #
+    # A demo "hey_buddy" command for Byebug.
+    #
+    class HelloCommand < ::Byebug::Command
+      #
+      # Return a regex to match the "hey_buddy" command input.
+      #
+      def self.regexp
+        /^\s*hey_buddy\s*$/
+      end
+
+      #
+      # Short description shown in the 'help' output.
+      #
+      def self.description
+        <<-EOD
+          hello: Prints "Hi, I'm buddy!"
+        EOD
+      end
+
+      #
+      # Called when the user types `hey_buddy` in Byebug.
+      #
+      def execute
+        puts "Hi, I'm buddy!"
+      end
+    end
+  end
+end

data/lib/console_buddy/csv.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'csv'
+
+module ConsoleBuddy
+  module CSV
+    def generate_csv(headers, rows, filename: DateTime.now.to_s, dir: 'tmp')
+      Dir.mkdir(dir) unless Dir.exist?(dir)
+
+      file_path = ::File.join(dir, "#{filename}.csv")
+      ::CSV.open(file_path, 'w') do |csv|
+        csv << headers
+        rows.each do |row|
+          csv << row
+        end
+      end
+
+      puts "CSV created. CSV can be found at: #{file_path}"
+    end
+
+    def read_csv(file_path, skip_headers: true)
+      data = []
+      ::CSV.foreach(file_path, headers: skip_headers) do |row|
+        data << row
+      end
+      data
+    end
+  end
+end

data/lib/console_buddy/helpers.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Example usage
+# 
+# ConsoleBuddy::Helpers.define do
+#   console_method :call_api do |status, message|
+#     puts "making api call"
+
+#     puts "RESPONSE: { #{status}, #{message} }"
+#   end
+# end
+
+# $ call_api(200, "ok")
+# 
+#  call_api can be used anywhere in your rails console
+# 
+module ConsoleBuddy
+  class Helpers
+    class << self
+      def define(&block)
+        if block_given?
+          instance = ::ConsoleBuddy::Helpers::DSL.new
+          instance.instance_eval(&block)
+        end
+      end
+    end
+
+    class DSL
+      def console_method(method_name, &block)
+        ::ConsoleBuddy.store.console_method[method_name] = block
+        nil
+      end
+    end
+  end
+end
+

data/lib/console_buddy/http_request.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'httparty'
+
+module ConsoleBuddy
+  module HttpRequest
+    def ping(url)
+      response = ::HTTParty.get(url)
+      ::JSON.parse(response.body)
+    end
+  end
+end

data/lib/console_buddy/initializers/byebug.rb

@@ -0,0 +1,4 @@
+# Load Byebug if it's defined and the user wants to use it.
+if defined? Byebug && ConsoleBuddy.use_in_debuggers
+  ConsoleBuddy.load_byebug!
+end

data/lib/console_buddy/initializers/rails.rb

@@ -0,0 +1,5 @@
+# Load the Railtie if Rails is defined
+# This is necessary so that the commands are loaded when the Rails console is started.
+if defined? Rails
+  require_relative "../railtie"
+end

data/lib/console_buddy/initializers/rspec.rb

@@ -0,0 +1,11 @@
+# TODO: Add support for other test frameworks
+#
+# This runs the ConsoleBuddy.start! method before the test suite is run.
+if defined? RSpec
+  RSpec.configure do |config|
+    config.before(:suite) do
+      ConsoleBuddy.start! if ConsoleBuddy.use_in_tests
+      ConsoleBuddy.load_byebug! if ConsoleBuddy.use_in_debuggers
+    end
+  end
+end

data/lib/console_buddy/irb.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "csv"
+require_relative "http_request"
+require_relative "one_off_job"
+require_relative "report"
+
+module ConsoleBuddy
+  module IRB
+    include ::ConsoleBuddy::CSV
+    include ::ConsoleBuddy::HttpRequest
+    include ::ConsoleBuddy::Report
+
+    # This method is used to define a method on the `Object` class.
+    # This method will return a new instance of the `ConsoleBuddy::Base` class.
+    # Example Usage:
+    # buddy.table_for(User.all)
+    def buddy
+      ::ConsoleBuddy::Base.new
+    end
+    alias console_buddy buddy
+  end
+end

data/lib/console_buddy/job.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative 'one_off_job'
+
+# This class is used to integrate the ConsoleBuddy::OneOffJob with Resque, Sidekiq, and ActiveJob.
+# You can define your job and then run it using the `perform` method of this class.
+# That will then delegate this performance to the correct "job" class based on the service type.
+# 
+# Example Usage: ConsoleBuddy::Job.perform("foo", "bar")
+module ConsoleBuddy
+  class Job
+    def perform(*args)
+      job_type = ::ConsoleBuddy::OneOffJob.service_type
+
+      case job_type
+      when :resque
+        require_relative "jobs/resque"
+        ::ConsoleBuddy::Jobs::Resque.perform(*args)
+      when :sidekiq
+        require_relative "jobs/sidekiq"
+        ::ConsoleBuddy::Jobs::Sidekiq.new.perform(*args)
+      when :active_job
+        require_relative "jobs/active_job"
+        ::ConsoleBuddy::Jobs::ActiveJob.perform(*args)
+      else
+        ::ConsoleBuddy::OneOffJob.perform(*args)
+      end
+    end
+
+    class << self
+      def perform_async(*args)
+        job_type = ::ConsoleBuddy::OneOffJob.service_type
+
+        case job_type
+        when :resque
+          require_relative "jobs/resque"
+          ::ConsoleBuddy::Jobs::Resque.perform_later(*args)
+        when :sidekiq
+          require_relative "jobs/sidekiq"
+          ::ConsoleBuddy::Jobs::Sidekiq.perform_async(*args)
+        when :active_job
+          require_relative "jobs/active_job"
+          ::ConsoleBuddy::Jobs::ActiveJob.perform_later(*args)
+        else
+          ::ConsoleBuddy::OneOffJob.perform(*args)
+        end
+      end
+
+      def perform_later(*args)
+        self.perform_async(*args)
+      end
+    end
+  end
+end

data/lib/console_buddy/jobs/active_job.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "../one_off_job"
+
+# Example Usage: ConsoleBuddy::Jobs::ActiveJob.perform_later("foo", "bar")
+# 
+# This class is used to integrate the ConsoleBuddy::OneOffJob with ActiveJob.
+module ConsoleBuddy
+  module Jobs
+    class ActiveJob < ::ActiveJob::Base
+      def perform(*args)
+        ::ConsoleBuddy::OneOffJob.perform(*args)
+      end
+    end
+  end
+end

data/lib/console_buddy/jobs/resque.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "../one_off_job"
+
+# Example Usage: ConsoleBuddy::Jobs::Resque.perform_later("foo", "bar")
+# 
+# This class is used to integrate the ConsoleBuddy::OneOffJob with Resque.
+module ConsoleBuddy
+  module Jobs
+    class Resque
+      @queue = :console_buddy
+
+      def perform(*args)
+        ::ConsoleBuddy::OneOffJob.perform(*args)
+      end
+    end
+  end
+end

data/lib/console_buddy/jobs/sidekiq.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "../one_off_job"
+
+# Example Usage: ConsoleBuddy::Jobs::Sidekiq.perform_later("foo", "bar")
+# 
+# This class is used to integrate the ConsoleBuddy::OneOffJob with Sidekiq.
+module ConsoleBuddy
+  module Jobs
+    class Sidekiq
+      include ::Sidekiq::Job
+
+      def perform(*args)
+        ::ConsoleBuddy::OneOffJob.perform(*args)
+      end
+    end
+  end
+end

data/lib/console_buddy/method_store.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ConsoleBuddy
+  class MethodStore
+    attr_accessor :augment_helper_methods, :console_method
+
+    def initialize
+      @augment_helper_methods = ::Hash.new { |hash, key| hash[key] = [] }
+      @console_method = ::Hash.new
+    end
+  end
+end

data/lib/console_buddy/one_off_job.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+# 
+# Example:
+# ConsoleBuddy::OneOffJob.define { puts "one offer man...another one"; puts User.last.attributes; }
+# Usage: ConsoleBuddy::OneOffJob.perform
+# 
+# Example 2:
+# 
+# ConsoleBuddy::OneOffJob.define do |user_id|
+#   puts User.find(user_id).attributes
+# end
+# 
+module ConsoleBuddy
+  class InvalidJobServiceType < StandardError; end
+
+  class OneOffJob
+    SERVICE_TYPES = [:sidekiq, :resque, :active_job, :inline].freeze
+    class << self
+      def service_type
+        return @service_type if defined?(@service_type)
+        return ConsoleBuddy.one_off_job_service_type if ConsoleBuddy.one_off_job_service_type.present?
+
+        :inline
+      end
+
+      def service_type=(type)
+        raise InvalidJobServiceType, "Valid service types are #{SERVICE_TYPES.join(', ')}" unless SERVICE_TYPES.include?(type)
+        @service_type = type
+      end
+
+      def define(&block)
+        @block = block
+      end
+
+      def perform(*args)
+        return unless @block
+
+        @block.call(*args)
+      end
+    end
+  end
+end

data/lib/console_buddy/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+# Load console buddy when the Rails console is started
+module ConsoleBuddy
+  class Railtie < ::Rails::Railtie
+    console do
+      ::ConsoleBuddy.start!
+    end
+  end
+end
+
+require "console_buddy/railtie" if defined?(::Rails::Railtie)

data/lib/console_buddy/report.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'table_print'
+require 'terminal-table'
+
+module ConsoleBuddy
+  module Report
+    # Example Usage:
+    # ConsoleBuddy::Report.table_print(User.all, "username")
+    # 
+    # Example 2:
+    # table_print User.all, "username"
+    def table_print(data, options = {})
+      puts ::TablePrint::Printer.table_print(data, options)
+    end
+    alias print_data table_print
+
+    # Example Usage:
+    # ConsoleBuddy::Report.table_for([["foo", "bar"], ["baz", "qux"]], ["col1", "col2"])
+    # 
+    # Example 2:
+    # table_for([["foo", "bar"], ["baz", "qux"]], ["col1", "col2"])
+    def table_for(rows, headers = [])
+      table = ::Terminal::Table.new(headings: headers, rows: rows)
+      puts table
+    end
+  end
+end

data/lib/console_buddy/version.rb

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