pennyworth 9.3.0 → 11.0.0

data/lib/pennyworth/models/encoding.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Pennyworth
+  module Models
+    # Defines an encoding.
+    Encoding = Struct.new :name, :aliases, keyword_init: true
+  end
+end

data/lib/pennyworth/models/http_status.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Pennyworth
+  module Models
+    # Defines HTTP status details.
+    HTTPStatus = Struct.new :code, :label, :url, keyword_init: true
+  end
+end

data/lib/pennyworth/models/system/error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Pennyworth
+  module Models
+    module System
+      # Defines a system error.
+      Error = Struct.new :id, :name, :description, keyword_init: true
+    end
+  end
+end

data/lib/pennyworth/models/system/signal.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Pennyworth
+  module Models
+    module System
+      # Defines a low-level operating system signal.
+      Signal = Struct.new :number, :name, keyword_init: true
+    end
+  end
+end

data/lib/pennyworth/models/text.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Pennyworth
+  module Models
+    # Defines basic text.
+    Text = Struct.new :id, :content, keyword_init: true
+  end
+end

data/lib/pennyworth/presenters/encoding.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Pennyworth
+  module Presenters
+    # Renders encoding into a compatible format for use in Alfred script filters.
+    class Encoding
+      def initialize record
+        @record = record
+      end
+
+      def id = record.name
+
+      def label = record.name
+
+      def aliases = record.aliases
+
+      private
+
+      attr_reader :record
+    end
+  end
+end

data/lib/pennyworth/presenters/gem.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "refinements/strings"
+
+module Pennyworth
+  module Presenters
+    # Renders RubyGems records into a compatible format for use in Alfred script filters.
+    class Gem
+      using Refinements::Strings
+
+      def initialize record, inflector: Inflector.new
+        @record = record
+        @inflector = inflector
+      end
+
+      def id = record.fetch(:name)
+
+      def label = inflector.call(id.titleize)
+
+      def subtitle
+        "Version: #{version}. " \
+        "Updated: #{updated_at[..9]}. " \
+        "Licenses: #{licenses}. " \
+        "Downloads: #{downloads}."
+      end
+
+      def version = record.fetch(__method__)
+
+      def licenses = record.fetch(__method__).join(", ")
+
+      def downloads = record.fetch(__method__)
+
+      def site_url = record.fetch(:homepage_uri)
+
+      def source_url = record.fetch(:source_code_uri)
+
+      def changes_url = record.fetch(:changelog_uri)
+
+      def issues_url = record.fetch(:bug_tracker_uri)
+
+      def updated_at = record.fetch(:version_created_at)
+
+      private
+
+      attr_reader :record, :inflector
+    end
+  end
+end

data/lib/pennyworth/presenters/http_status.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "forwardable"
+require "refinements/strings"
+
+module Pennyworth
+  module Presenters
+    # Renders system error into a compatible format for use in Alfred script filters.
+    class HTTPStatus
+      extend Forwardable
+
+      using Refinements::Strings
+
+      delegate %i[code label url] => :record
+
+      def initialize record, inflector: Inflector.new
+        @record = record
+        @inflector = inflector
+      end
+
+      def id = record.code
+
+      def subtitle = "#{id} #{label}"
+
+      def symbol = ":#{inflector.call name}"
+
+      private
+
+      attr_reader :record, :inflector
+
+      def name
+        label.snakecase
+             .tr("/", "_")
+             .gsub(/(\(|\))/, "")
+             .sub("h_t_t_p_version_not_supported", "http_version_not_supported")
+             .sub("i_m_used", "im_used")
+             .sub("u_r_i_too_long", "uri_too_long")
+      end
+    end
+  end
+end

data/lib/pennyworth/presenters/repository.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "refinements/strings"
+
+module Pennyworth
+  module Presenters
+    # Renders a GitHub repository record into a compatible format for use in Alfred script filters.
+    class Repository
+      using Refinements::Strings
+
+      def initialize record, inflector: Inflector.new
+        @record = record
+        @inflector = inflector
+      end
+
+      def id = record.fetch(:name)
+
+      def label = inflector.call(id.titleize)
+
+      def subtitle = record.fetch(:description)
+
+      def site_url = record.fetch(:homepage)
+
+      def source_url = record.fetch(:html_url)
+
+      def changes_url = "#{site_url}/changes.html"
+
+      def issues_url = "#{source_url}/issues"
+
+      private
+
+      attr_reader :record, :inflector
+    end
+  end
+end

data/lib/pennyworth/presenters/system/error.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module Pennyworth
+  module Presenters
+    module System
+      # Renders system error into a compatible format for use in Alfred script filters.
+      class Error
+        extend Forwardable
+
+        delegate %i[id description] => :record
+
+        def initialize record
+          @record = record
+        end
+
+        def label = record.name
+
+        def subtitle = "#{label}: #{description}."
+
+        private
+
+        attr_reader :record
+      end
+    end
+  end
+end

data/lib/pennyworth/presenters/system/signal.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Pennyworth
+  module Presenters
+    module System
+      # Renders strings into a compatible format for use in Alfred script filters.
+      class Signal
+        def initialize record
+          @record = record
+        end
+
+        def id = record.number
+
+        def label = record.name
+
+        private
+
+        attr_reader :record
+      end
+    end
+  end
+end

data/lib/pennyworth/presenters/text.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module Pennyworth
+  module Presenters
+    # Renders text into a compatible format for use in Alfred script filters.
+    class Text
+      extend Forwardable
+
+      delegate %i[id content] => :record
+
+      def initialize record, inflector: Inflector.new
+        @record = record
+        @inflector = inflector
+      end
+
+      def label = inflector.call(record.content.to_s)
+
+      private
+
+      attr_reader :record, :inflector
+    end
+  end
+end

data/lib/pennyworth/processor.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Pennyworth
+  # Processes all steps required to render an Alfred Script Filter response.
+  class Processor
+    def self.for_encodings
+      new loader: Loaders::Encodings.new,
+          presenter: Presenters::Encoding,
+          serializer: Serializers::Encoding
+    end
+
+    def self.for_gems
+      new loader: Loaders::Projects.for_ruby_gems,
+          presenter: Presenters::Gem,
+          serializer: Serializers::Project
+    end
+
+    def self.for_http_statuses
+      new loader: Loaders::HTTPStatuses.new,
+          presenter: Presenters::HTTPStatus,
+          serializer: Serializers::HTTPStatus
+    end
+
+    def self.for_projects
+      new loader: Loaders::Projects.for_git_hub,
+          presenter: Presenters::Repository,
+          serializer: Serializers::Project
+    end
+
+    def self.for_system_signals
+      new loader: Loaders::System::Signals.new,
+          presenter: Presenters::System::Signal,
+          serializer: Serializers::System::Signal
+    end
+
+    def self.for_system_errors
+      new loader: Loaders::System::Errors.new,
+          presenter: Presenters::System::Error,
+          serializer: Serializers::System::Error
+    end
+
+    def self.for_text
+      new loader: Loaders::Text.new, presenter: Presenters::Text, serializer: Serializers::Text
+    end
+
+    def initialize steps
+      @steps = steps
+    end
+
+    def call content = nil
+      loader.call(content)
+            .map { |record| presenter.new record }
+            .sort_by(&:label)
+            .map { |record| serializer.new record }
+            .then { |records| {items: records.map(&:to_h)} }
+    end
+
+    private
+
+    attr_reader :steps
+
+    def loader = steps.fetch(__method__)
+
+    def presenter = steps.fetch(__method__)
+
+    def serializer = steps.fetch(__method__)
+  end
+end

data/lib/pennyworth/serializers/encoding.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Pennyworth
+  module Serializers
+    # Serializes a encoding into a compatible format for parsing within Alfred script filters.
+    class Encoding
+      def initialize presenter
+        @presenter = presenter
+      end
+
+      def to_h
+        {
+          uid: presenter.id,
+          title: label,
+          subtitle: %(Aliases: #{aliases}.),
+          arg: label,
+          mods: {
+            alt: {subtitle: "Copy aliases.", arg: aliases}
+          },
+          text: {copy: label, largetype: label}
+        }
+      end
+
+      private
+
+      attr_reader :presenter
+
+      def label = presenter.label
+
+      def aliases = presenter.aliases.join(", ")
+    end
+  end
+end

data/lib/pennyworth/serializers/http_status.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Pennyworth
+  module Serializers
+    # Serializes a HTTP status into a compatible format for parsing within Alfred script filters.
+    class HTTPStatus
+      def initialize presenter
+        @presenter = presenter
+      end
+
+      def to_h
+        {
+          uid: id,
+          title: code,
+          subtitle: label,
+          arg: presenter.symbol,
+          mods: modifications,
+          text: {copy: "#{code} #{label}", largetype: "#{code} #{label}"}
+        }
+      end
+
+      private
+
+      attr_reader :presenter
+
+      def id = presenter.id
+
+      def code = presenter.code
+
+      def label = presenter.label
+
+      def modifications
+        {
+          control: {subtitle: "Copy code.", arg: id},
+          alt: {subtitle: "Copy label.", arg: label},
+          cmd: {subtitle: "View documentation.", arg: presenter.url}
+        }
+      end
+    end
+  end
+end

data/lib/pennyworth/serializers/project.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Pennyworth
+  module Serializers
+    # Serializes a project into a compatible format for parsing within Alfred script filters.
+    class Project
+      def initialize presenter
+        @presenter = presenter
+      end
+
+      def to_h
+        {
+          uid: presenter.id,
+          title: presenter.label,
+          subtitle: presenter.subtitle,
+          arg: site_url,
+          quicklookurl: site_url,
+          mods: modifications,
+          text: text
+        }
+      end
+
+      private
+
+      attr_reader :presenter
+
+      def modifications
+        {
+          control: modification(presenter.changes_url, "View changes."),
+          alt: modification(presenter.source_url, "View source."),
+          cmd: modification(presenter.issues_url, "View issues.")
+        }
+      end
+
+      def modification argument, subtitle
+        {
+          subtitle: subtitle,
+          arg: argument
+        }
+      end
+
+      def text
+        {
+          copy: site_url,
+          largetype: site_url
+        }
+      end
+
+      def site_url = presenter.site_url
+    end
+  end
+end