qippet 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75af562af4fa5c5309e08b59ca945cc430d29d63b61bb2845f6b477c8cfacbd3
-  data.tar.gz: f2e3a26ed13432de0eb406ce171fc1841f53a744568d8ac619bc416f33d11043
+  metadata.gz: 529b8f0f4110561fd449bc25ce3cadb3527722934960c62bb70c379b78e6afc3
+  data.tar.gz: 1ebc1a337117b53b3ccee1def99b6d0494e23ea8d84aa91ad688bd8bad3feb35
 SHA512:
-  metadata.gz: b986f24cd41c5861deb53f90afda144bb80e70d203cf77a1cdea223d33567cbbe945d03820f67b7c042247fa0f4e8e752ac3ecf31e7b668ca53f0ccd6bca70a1
-  data.tar.gz: 77eb388abd688187579a3807595c2716c80ce8b8025050ed24fa886d0c717d6750da1bf306c9fca7f63e6cdcbfee03005b8c33535d8d247593bd6647e4fbbc3b
+  metadata.gz: c8afc5349405c422bac83dfb7924db87a119c2b8749266a4ddcdc753904328c45f66559861ca1e460a4c329ed78681971de21b85343dc72fa1458ca8a41d0a94
+  data.tar.gz: 4348f9a542374f87b51a4bb54ff0ece4779c581374ef352ed707ec0e380e1ab4f9617159cb09c1ae4234dc79379138d74b3fa8be6c32ad0eb6cc9faec1af28f1

data/.rubocop.yml

@@ -1,6 +1,5 @@
 AllCops:
   TargetRubyVersion: 3.0
-  DisabledByDefault: true
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes

data/lib/qippet/boxes/box.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "rmagick"
+require "active_support/core_ext/enumerable"
+
+module Qippet
+  module Boxes
+    # Abstract Class definiton for Box
+    class Box
+      attr_reader :node, :image
+
+      PADDING = 40
+      PADDING_X = 30
+
+      def initialize
+        self.class.setup_attributes
+      end
+
+      def add_child(child)
+        children << child
+      end
+
+      def render
+        construct_box_image
+      end
+
+      def children
+        @children ||= []
+      end
+
+      def add_attributes(attributes_value)
+        allowed_attributes = attributes_value.filter { |key, _| self.class::ALLOWED_ATTRIBUTES.include?(key.to_sym) }
+        allowed_attributes.each { |key, val| instance_variable_set "@#{key}", val }
+      end
+
+      def self.setup_attributes
+        return unless const_defined? "ALLOWED_ATTRIBUTES"
+
+        self::ALLOWED_ATTRIBUTES.each { |attr| attr_accessor attr }
+      end
+
+      private
+
+      def construct_box_image
+        children_images = children.map(&:render)
+        height = image_height(children_images)
+        width = image_width(children_images)
+        @image = Magick::Image.new(width, height)
+        arrange_children_in_image(children_images)
+      end
+
+      def arrange_children_in_image(children_images)
+        acc = 10
+        children_images.each do |child_image|
+          image.composite! child_image, PADDING_X, acc, Magick::OverCompositeOp
+          acc += child_image.rows
+        end
+        image
+      end
+
+      def image_height(children_images)
+        children_images.sum(&:columns) + PADDING
+      end
+
+      def image_width(children_images)
+        (children_images.max { |a, b| a.rows <=> b.rows }&.rows || 0) + PADDING
+      end
+
+      # def get_image
+      #   throw :undefined, "Box Abstract Method not defined"
+      # end
+    end
+  end
+end

data/lib/qippet/boxes/code_box.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require_relative "./box"
+require "qippet/extract"
+require "qippet/colors"
+require "rouge"
+
+module Qippet
+  module Boxes
+    # Box for creating code
+    class CodeBox < Box
+      # Class to formate code tokens
+      class BareColorFormatter < Rouge::Formatter
+        def stream(tokens)
+          token_lines(tokens).with_index do |line_tokens, lineno|
+            line_tokens_with_color = line_tokens.map do |token|
+              token_color = Colors.get_color_by_shortname(token[0].shortname)
+              [token_color, *token]
+            end
+
+            yield line_tokens_with_color, lineno
+          end
+        end
+      end
+
+      attr_reader :code_content, :code_lines, :show_line, :writer, :tokenizer, :formatter
+
+      ALLOWED_ATTRIBUTES = %i[source path range].freeze
+
+      TAB_SPACE = 20
+      CODE_LINE_HEIGHT = 19
+      CODE_CHAR_WIDTH = 8
+
+      def initialize
+        super
+        @show_line = false
+      end
+
+      def add_child(*)
+        throw :no_children_for_node, "Code Box cannot contain chidren"
+      end
+
+      def render
+        fetch_code_from_source
+        extract_line_range
+        return nil if code_content.nil?
+
+        setup_syntax_highliter
+        setup_writer
+        super
+        write_code_on_image
+      end
+
+      private
+
+      def fetch_code_from_source
+        @code_content = source == "github" ? Extract.from_github(path) : Extract.from_file(path)
+        return nil if code_content.nil?
+
+        @code_lines = code_content.split("\n")
+      end
+
+      def extract_line_range
+        return if range.nil?
+
+        ranges = range.split(",").first(2).map { |val| Integer(val.strip) }
+        @code_lines = @code_lines[(ranges[0] || 0)..(ranges[1] || @code_lines.length)]
+      end
+
+      def write_code_on_image
+        @row_position = PADDING + CODE_LINE_HEIGHT
+
+        formatter.format(tokenizer.lex(code_lines.join("\n"))) do |line, index|
+          @column_position = PADDING
+          add_line_number(index + 1) if show_line
+
+          line.each do |token_with_color|
+            write_token(token_with_color)
+          end
+          @row_position += CODE_LINE_HEIGHT
+        end
+        image
+      end
+
+      def write_token(token_with_color)
+        color, token_type, token = token_with_color
+        token.prepend("\\") if token_type.shortname.blank?
+
+        escape_special_characters(token)
+        token_width = writer.get_type_metrics(token).width
+
+        writer.annotate(image, 0, 0, @column_position, @row_position, token) { |opt| opt.fill = color }
+        @column_position += token_width
+      end
+
+      def setup_syntax_highliter
+        @tokenizer = Rouge::Lexers::Ruby.new
+        @formatter = BareColorFormatter.new
+      end
+
+      def escape_special_characters(str)
+        str.gsub!(/%/, "%" => "%%")
+      end
+
+      def add_line_number(number)
+        writer.annotate(image, 0, 0, @column_position, @row_position, number.to_s) { |opt| opt.fill = "black" }
+        @column_position += TAB_SPACE
+      end
+
+      def add_line_indentation(line)
+        line.chars.each do |c|
+          break if c != " "
+
+          @row_position += CODE_CHAR_WIDTH
+        end
+      end
+
+      def setup_writer
+        @writer = Magick::Draw.new
+        @writer.font_family = "helvetica"
+        @writer.pointsize = 15
+      end
+
+      def image_height(*)
+        (code_lines.length * CODE_LINE_HEIGHT) + (2 * PADDING)
+      end
+
+      def image_width(*)
+        code_lines.map { |line| line.blank? ? 0 : writer.get_type_metrics(line).width }.max + (2 * PADDING)
+      end
+    end
+  end
+end

data/lib/qippet/boxes/container_box.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "./box"
+
+module Qippet
+  module Boxes
+    # Container Class create from the "q" keyword
+    class ContainerBox < Box
+      ALLOWED_ATTRIBUTES = [].freeze
+    end
+  end
+end

data/lib/qippet/boxes/text_box.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "./box"
+
+module Qippet
+  module Boxes
+    # Text box created from the "text" keyword
+    class TextBox < Box
+      ALLOWED_ATTRIBUTES = [].freeze
+    end
+  end
+end

data/lib/qippet/builder/xml.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+require "qippet/boxes/container_box"
+require "qippet/boxes/text_box"
+require "qippet/boxes/code_box"
+
+module Qippet
+  module Builder
+    # Builder from XML content to box
+    module Xml
+      extend ActiveSupport::Autoload
+      extend self
+
+      def build(content = "")
+        structured_content = create_structure_from_xml_content(content)
+        return nil if structured_content.nil?
+
+        setup_node(structured_content[:root])
+      end
+
+      private
+
+      def create_structure_from_xml_content(content)
+        return nil if content.empty?
+
+        parsed_data = Nokogiri::XML.parse(content)
+        parsed_data.deconstruct_keys([:root])
+      end
+
+      def setup_node(node)
+        return nil unless node.presence
+
+        node.content.strip!
+        node_box = get_node_box(node.name.presence)
+        add_box_attributes(node_box, node.attribute_nodes)
+        return node_box if node.children.empty?
+
+        node.children.each do |child|
+          box = setup_node(child)
+          node_box.add_child box if box.present?
+        end
+
+        node_box
+      end
+
+      def add_box_attributes(box, attribute_nodes)
+        box.add_attributes(attribute_nodes.map { |attr| [attr.name, attr.value] })
+      end
+
+      def get_node_box(node_name)
+        case node_name
+        when "q"
+          Qippet::Boxes::ContainerBox.new
+        when "code"
+          Qippet::Boxes::CodeBox.new
+        when "text"
+          Qippet::Boxes::TextBox.new
+        else
+          throw :unrecognize_structure, "Structure contains unrecognize element."
+        end
+      end
+    end
+  end
+end

data/lib/qippet/builder.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/core_ext/object/blank"
+
+# Qippet
+module Qippet
+  extend ActiveSupport::Autoload
+
+  # Builder Class
+  module Builder
+    extend ActiveSupport::Autoload
+
+    autoload :Xml
+
+    class << self
+      def build(content)
+        Xml.build(content)
+      end
+    end
+  end
+end

data/lib/qippet/colors.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Qippet
+  # Module contains all colors for code
+  module Colors
+    DEFAULT_COLORS = {
+      w: "red",
+      o: "black",
+      nb: "blue",
+      c1: "gray",
+      s2: "#FF7F50",
+      no: "#50D0FF"
+    }.freeze
+
+    def self.get_color_by_shortname(shortname)
+      DEFAULT_COLORS.fetch(shortname.to_sym, "black")
+    end
+  end
+end

data/lib/qippet/extract.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "uri"
+require "net/http"
+require "base64"
+require "json"
+require "pathname"
+
+module Qippet
+  # Extract Class
+  class Extract
+    class << self
+      GITHUB_BASE_API_URL = "https://api.github.com/repos/"
+
+      def from_file(path)
+        path = Pathname.new(Dir.pwd).join(path)
+        read_file(path)
+      end
+
+      def from_github(path = "rails/rails/contents/version.rb")
+        url = URI("#{GITHUB_BASE_API_URL}#{path}")
+        response = Net::HTTP.get_response(url)
+        response = JSON.parse(response.body)
+        Base64.decode64(response["content"])
+      rescue StandardError
+        nil
+      end
+
+      private
+
+      def read_file(path)
+        File.read(path)
+      rescue Errno::ENOENT, Errno::EISDIR
+        nil
+      end
+    end
+  end
+end

data/lib/qippet/version.rb

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

data/lib/qippet.rb

@@ -1,10 +1,16 @@
 # frozen_string_literal: true
 
+require "active_support"
 require_relative "qippet/version"
 
 # Main object for Qippet. This is the main entry point for
 # the application.
 module Qippet
+  extend ActiveSupport::Autoload
+
+  # autoload :Xml, "qippet/extraction/xml"
+  autoload :Extract
+  autoload :Builder
   class Error < StandardError; end
 
   # Configuration class Object
@@ -27,5 +33,17 @@ module Qippet
     def configure
       yield configuration
     end
+
+    def generate(path, output_file)
+      yield configuration if block_given?
+
+      extracted = Extract.from_file(path)
+      node = Builder.build(extracted)
+      puts "File does not contain a valid Qippet structure" if node.nil?
+
+      node&.render
+      # result.write(output_file)
+      output_file
+    end
   end
 end

metadata

@@ -1,15 +1,89 @@
 --- !ruby/object:Gem::Specification
 name: qippet
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Unegbu Kingsley
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-04-11 00:00:00.000000000 Z
-dependencies: []
+date: 2024-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3.2
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.5
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
 description: Create beautify code snippet image.
 email: kingsobino@gmail.com
 executables: []
@@ -24,6 +98,14 @@ files:
 - README.md
 - Rakefile
 - lib/qippet.rb
+- lib/qippet/boxes/box.rb
+- lib/qippet/boxes/code_box.rb
+- lib/qippet/boxes/container_box.rb
+- lib/qippet/boxes/text_box.rb
+- lib/qippet/builder.rb
+- lib/qippet/builder/xml.rb
+- lib/qippet/colors.rb
+- lib/qippet/extract.rb
 - lib/qippet/version.rb
 - sig/qippet.rbs
 homepage: https://github.com/Urchmaney/qippet