gem_lookup 1.0.0

data/lib/gem_lookup/ruby_gems.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require 'colorize'
+
+module GemLookup
+  class RubyGems
+    # Creates a new instance of RubyGems.
+    # @param gems [Array] an array of gems and/or flags.
+    def initialize(gems)
+      @gem_list = gems
+      @flags = []
+      @display_mode = :emoji
+      @serializer = nil
+      @continue = true
+    end
+
+    # Handles the preparation and processing of the gems and/or flags.
+    def find_all
+      format_list
+      process_flags if valid?
+
+      return unless continue?
+
+      process_gems if valid?
+      display_help! unless valid?
+    end
+
+    private
+
+    # Processes the detection and handling of flags.
+    def process_flags
+      detect_flags
+      handle_flags
+      detect_serializer
+    end
+
+    # Looks for strings that start with a dash and marks them as flags, and removes them from the
+    # gem list.
+    def detect_flags
+      @flags = @gem_list.select {|g| g[0] == '-' }
+      @gem_list -= @flags
+    end
+
+    # Lower-cases the entire gem list, and then removes duplicate entries.
+    def format_list
+      @gem_list.map!(&:downcase).uniq!
+    end
+
+    # Creates a new GemLookup::Gems instance and calls #process.
+    def process_gems
+      Gems.new(@gem_list, serializer: @serializer).process
+    end
+
+    # Calls the #check_flags method if there are any flag entries.
+    def handle_flags
+      return unless @flags.any?
+
+      check_flags
+    rescue GemLookup::Errors::UnsupportedFlag => e
+      error message: "Unsupported flag [#{e.message}]"
+    rescue GemLookup::Errors::UnsupportedFlags => e
+      error message: "Unsupported flags [#{e.message}]"
+    end
+
+    # Looks through the flags and calls GemLookup::Flags to assist, and either calls GemLookup::Help
+    # or sets the display mode, where appropriate.
+    # rubocop:disable Metrics/MethodLength
+    def check_flags
+      if Flags.supported?(:help, flags: @flags)
+        Help.display exit_code: 0
+        @continue = false
+      elsif Flags.supported?(:version, flags: @flags)
+        Help.version exit_code: 0
+        @continue = false
+      elsif Flags.supported?(:wordy, flags: @flags)
+        @display_mode = :wordy
+      elsif Flags.supported?(:json, flags: @flags)
+        @display_mode = :json
+      else
+        Flags.unsupported(flags: @flags)
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    # Utilizes the display mode to identify which serializer to utilize.
+    def detect_serializer
+      @serializer = case @display_mode
+                    when :wordy
+                      Serializers::Wordy
+                    when :json
+                      Serializers::Json
+                    when :emoji
+                      Serializers::Emoji
+                    end
+
+      invalid_display_mode! if @serializer.nil?
+    end
+
+    # Raises the Invalid display mode error.
+    def invalid_display_mode!
+      @continue = false
+      raise GemLookup::Errors::InvalidDisplayMode, @display_mode
+    rescue GemLookup::Errors::InvalidDisplayMode => e
+      error message: "Invalid display mode [#{e.message}]"
+    end
+
+    # If the lookup process should continue.
+    # @return [Boolean] whether to continue the lookup process or not.
+    def continue?
+      @continue
+    end
+
+    # If the gem list is valid.
+    # @return [Boolean] whether there are any entries in the gem list.
+    def valid?
+      @gem_list.any?
+    end
+
+    # Calls the GemLookup::Help.display method and exits with an exit code of 1.
+    def display_help!
+      Help.display exit_code: 1
+    end
+
+    # Outputs the passed in message in a standard error format, in red, and exits with an exit code
+    # of 1.
+    # @param message [String] the error message to present.
+    def error(message:)
+      puts "=> Error: #{message}".red
+      exit 1
+    end
+  end
+end

data/lib/gem_lookup/serializers/emoji.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require 'colorize'
+require 'date'
+
+module GemLookup
+  module Serializers
+    class Emoji < Interface
+      class << self
+        # Outputs the emoji-based format for the gem
+        # @param json [Hash] the json hash, with symbolized keys.
+        def display(json:)
+          if json[:timeout]
+            puts timed_out(gem_name: json[:name])
+          elsif json[:exists]
+            puts gem_details(json: json)
+          else
+            puts not_found(gem_name: json[:name])
+          end
+        end
+
+        # Outputs the number of gems being queried.
+        # @param num [Numeric] the number of gems.
+        def gem_count(num:)
+          puts "=> 🤔 #{num} gems".light_cyan
+        end
+
+        # Outputs the current batch and total number of batches
+        # @param num [Numeric] the current batch number.
+        # @param total [Numeric] the total number of batches.
+        def batch_iterator(num:, total:)
+          puts "=> 🧺 #{num} of #{total}".yellow
+        end
+
+        # Outputs the list of gems being looked up from the batch.
+        # @param batch [Array] the array of gems.
+        def querying(batch:)
+          puts "=> 🔎 #{batch.join(", ")}".light_yellow
+        end
+
+        # Returns if the serializer is meant to be used to stream content.
+        # @return [Boolean] whether the serializer is meant for streaming content.
+        def streaming?
+          true
+        end
+
+        private
+
+        # rubocop:disable Metrics/AbcSize
+        # Returns the emoji-based format for the gem
+        # @param json [Hash] the json hash, with symbolized keys.
+        def gem_details(json:)
+          [].tap do |output|
+            output.push "=> 💎 #{json[:name]} is at #{json[:version]}".green
+            output.push "==> 📅 #{convert_date(date: json[:version_created_at])}"
+            output.push "==> 🏠 #{json[:homepage_uri]}"
+            output.push source_code(source_code_uri: json[:source_code_uri])
+            output.push changelog(changelog_uri: json[:changelog_uri])
+            output.push mailing_list(mailing_list_uri: json[:mailing_list_uri])
+          end.join "\n"
+        end
+        # rubocop:enable Metrics/AbcSize
+
+        # Generates the "Source Code" string
+        # @param source_code_uri [String] the source code uri.
+        # @return [String] the repository string.
+        def source_code(source_code_uri:)
+          if source_code_uri && !source_code_uri.empty?
+            "==> 🔗 #{source_code_uri}"
+          else
+            '==> 🔗 Unavailable'.light_red
+          end
+        end
+
+        # Generates the "changelog" string
+        # @param changelog_uri [String] the changelog uri.
+        # @return [String] the changelog string.
+        def changelog(changelog_uri:)
+          if changelog_uri && !changelog_uri.empty?
+            "==> 📑 #{changelog_uri}".light_cyan
+          else
+            '==> 📑 Unavailable'.light_red
+          end
+        end
+
+        # Generates the "mailing list" string
+        # @param mailing_list_uri [String] the mailing list uri.
+        # @return [String] the mailing list string.
+        def mailing_list(mailing_list_uri:)
+          if mailing_list_uri && !mailing_list_uri.empty?
+            "==> 💌 #{mailing_list_uri}".light_cyan
+          else
+            '==> 💌 Unavailable'.light_red
+          end
+        end
+
+        # Generates the "gem lookup timed out" string
+        # @param gem_name [String] the name of the gem that the lookup timed out on.
+        # @return [String] the gem lookup timed out string.
+        def timed_out(gem_name:)
+          "=> 💎 #{gem_name} lookup timed out".red
+        end
+
+        # Generates the "gem not found" string
+        # @param gem_name [String] the name of the gem that was not found.
+        # @return [String] the gem not found string.
+        def not_found(gem_name:)
+          "=> 💎 #{gem_name} not found".red
+        end
+
+        # Parses the passed date/datetime string into the desired format, aka "November 13, 2014".
+        # @param date [String] the date to be parsed.
+        # @return [String] the formatted date.
+        def convert_date(date:)
+          Date.parse(date).strftime '%B %-d, %Y'
+        end
+      end
+    end
+  end
+end

data/lib/gem_lookup/serializers/interface.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module GemLookup
+  module Serializers
+    class Interface
+      class << self
+        # rubocop:disable Lint/UnusedMethodArgument
+
+        # Should be overriden to output the desired output format for the gem
+        # @param json [Hash] the json hash, with symbolized keys.
+        def display(json:)
+          not_implemented __method__, params: %w[:json]
+        end
+
+        # Should be overriden to output the number of gems being queried.
+        # @param num [Numeric] the number of gems.
+        def gem_count(num:)
+          not_implemented __method__, params: %w[:num]
+        end
+
+        # Should be overriden to output the current batch and total number of batches
+        # @param num [Numeric] the current batch number.
+        # @param total [Numeric] the total number of batches.
+        def batch_iterator(num:, total:)
+          not_implemented __method__, params: %w[:num :total]
+        end
+
+        # Should be overridden to output the list of gems being looked up from the batch.
+        # @param batch [Array] the array of gems.
+        def querying(batch:)
+          not_implemented __method__, params: %w[:batch]
+        end
+
+        # Should be overriden to return if the serializer is meant to be used to stream content.
+        # @return [Boolean] whether the serializer is meant for streaming content.
+        def streaming?
+          not_implemented __method__
+        end
+        # rubocop:enable Lint/UnusedMethodArgument
+
+        private
+
+        def not_implemented(method, params: [])
+          required = params.any? ? " with params (#{params.join(", ")})" : ''
+          raise GemLookup::Errors::UndefinedInterfaceMethod,
+                "Class method .#{method}#{required} must be implemented by sub-class"
+        end
+      end
+    end
+  end
+end

data/lib/gem_lookup/serializers/json.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module GemLookup
+  module Serializers
+    class Json < Interface
+      class << self
+        # Outputs the json (in a pretty format) for the gem
+        # @param json [Hash] the json hash.
+        def display(json:)
+          puts JSON.pretty_generate json
+        end
+
+        # Returns if the serializer is meant to be used to stream content.
+        # @return [Boolean] whether the serializer is meant for streaming content.
+        def streaming?
+          false
+        end
+      end
+    end
+  end
+end

data/lib/gem_lookup/serializers/wordy.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require 'colorize'
+require 'date'
+
+module GemLookup
+  module Serializers::Wordy
+    class << self
+      # Outputs the emoji-based format for the gem
+      # @param json [Hash] the json hash, with symbolized keys.
+      def display(json:)
+        if json[:timeout]
+          puts timed_out(gem_name: json[:name])
+        elsif json[:exists]
+          puts gem_details(json: json)
+        else
+          puts not_found(gem_name: json[:name])
+        end
+      end
+
+      # Outputs the number of gems being queried.
+      # @param num [Numeric] the number of gems.
+      def gem_count(num:)
+        puts "=> Query: #{num} gems".light_cyan
+      end
+
+      # Outputs the current batch and total number of batches
+      # @param num [Numeric] the current batch number.
+      # @param total [Numeric] the total number of batches.
+      def batch_iterator(num:, total:)
+        puts "=> Batch: #{num} of #{total}".yellow
+      end
+
+      # Outputs the list of gems being looked up from the batch.
+      # @param batch [Array] the array of gems.
+      def querying(batch:)
+        puts "=> Looking up: #{batch.join(", ")}".light_yellow
+      end
+
+      # Returns if the serializer is meant to be used to stream content.
+      # @return [Boolean] whether the serializer is meant for streaming content.
+      def streaming?
+        true
+      end
+
+      private
+
+      # rubocop:disable Metrics/AbcSize
+      # Returns the emoji-based format for the gem.
+      # @param json [Hash] the json hash, with symbolized keys.
+      def gem_details(json:)
+        [].tap do |output|
+          output.push "=> Gem: #{json[:name]} is at #{json[:version]}".green
+          output.push "==> Updated:      #{convert_date(date: json[:version_created_at])}"
+          output.push "==> Homepage:     #{json[:homepage_uri]}"
+          output.push source_code(source_code_uri: json[:source_code_uri])
+          output.push changelog(changelog_uri: json[:changelog_uri])
+          output.push mailing_list(mailing_list_uri: json[:mailing_list_uri])
+        end.join "\n"
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      # Generates the "Source Code" string
+      # @param source_code_uri [String] the source code uri.
+      # @return [String] the repository string.
+      def source_code(source_code_uri:)
+        if source_code_uri && !source_code_uri.empty?
+          "==> Source Code:  #{source_code_uri}"
+        else
+          '==> Source Code:  Unavailable'.light_red
+        end
+      end
+
+      # Generates the "changelog" string
+      # @param changelog_uri [String] the changelog uri.
+      # @return [String] the changelog string.
+      def changelog(changelog_uri:)
+        if changelog_uri && !changelog_uri.empty?
+          "==> Changelog:    #{changelog_uri}".light_cyan
+        else
+          '==> Changelog:    Unavailable'.light_red
+        end
+      end
+
+      # Generates the "mailing list" string
+      # @param mailing_list_uri [String] the mailing list uri.
+      # @return [String] the mailing list string.
+      def mailing_list(mailing_list_uri:)
+        if mailing_list_uri && !mailing_list_uri.empty?
+          "==> Mailing List: #{mailing_list_uri}".light_cyan
+        else
+          '==> Mailing List: Unavailable'.light_red
+        end
+      end
+
+      # Generates the "gem lookup timed out" string
+      # @param gem_name [String] the name of the gem that the lookup timed out on.
+      # @return [String] the gem lookup timed out string.
+      def timed_out(gem_name:)
+        "=> Gem: #{gem_name} lookup timed out".red
+      end
+
+      # Generates the "gem not found" string.
+      # @param gem_name [String] the name of the gem that was not found.
+      # @return [String] the gem not found string.
+      def not_found(gem_name:)
+        "=> Gem: #{gem_name} not found".red
+      end
+
+      # Parses the passed date/datetime string into the desired format, aka "November 13, 2014".
+      # @param date [String] the date to be parsed.
+      # @return [String] the formatted date.
+      def convert_date(date:)
+        Date.parse(date).strftime '%B %-d, %Y'
+      end
+    end
+  end
+end