algoheader 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 872e496205849f1f92511391292617b2720ad1ce07b3d2d4b4741fc15eca7dfe
+  data.tar.gz: 1f4d286c9c1a967762669cf200432d0849923d9aa3fbc2d4ef7b6d8455a37963
+SHA512:
+  metadata.gz: 6b2490b76285ce91ce13e13c19c7269d699a136b3dce4d8bd40ec1fa888c21a880aadfa15925c27509288330ea79037e4d8d911327063700a6370ed390212438
+  data.tar.gz: b0ea6d4f0195cc0469149c2ae9e4f230d70f8c9cc99982045c37084f79d05fe11b9f92070bd744382dad839b49f181f2e402467b7db10e62e19e9075bf6fc127

data/bin/algoheader

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby'
+# frozen_string_literal: true
+
+# Copyright 2021 Dick Davis
+#
+# This file is part of algoheader.
+#
+# algoheader is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# algoheader is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with algoheader.  If not, see <http://www.gnu.org/licenses/>.
+
+##
+# = /bin/algoheader
+# Author::    Dick Davis
+# Copyright:: Copyright 2021 Dick Davis
+# License::   GNU Public License 3
+#
+# Project executable file.
+begin
+  require 'algoheader'
+rescue LoadError
+  require 'rubygems'
+  require 'algoheader'
+end

data/lib/algoheader/base.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Dick Davis
+#
+# This file is part of algoheader.
+#
+# algoheader is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# algoheader is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with algoheader.  If not, see <http://www.gnu.org/licenses/>.
+
+##
+# = /lib/algoheader.rb
+# Author::    Dick Davis
+# Copyright:: Copyright 2021 Dick Davis
+# License::   GNU Public License 3
+#
+# Main application file that loads other files.
+
+require 'algoheader/helpers'
+require 'algoheader/png_transformer'
+require 'algoheader/svg_generator'
+require 'algoheader/version'
+
+require 'optparse'
+require 'English'
+require 'fileutils'
+require 'yaml'
+
+trap('INT') do
+  puts "\nTerminating..."
+  exit
+end
+
+options = {}
+
+# rubocop:disable Metrics/BlockLength
+optparse = OptionParser.new do |opts|
+  opts.banner = 'Usage: algoheader [options]'
+
+  opts.on('-c', '--config FILE', 'Specifies the configuration file to use.') do |config|
+    options[:config] = config
+  end
+
+  opts.on('-d', '--directory NAME', 'Sets the output directory.') do |dir|
+    options[:dir] = dir
+  end
+
+  opts.on('-i', '--images NUMBER', 'Sets the number of images to generate (max 99.)') do |images|
+    options[:images] = images.to_i > 99 ? 99 : images.to_i
+  end
+
+  opts.on('-r', '--raster', 'Create PNG copies of the generated SVGs.') do
+    options[:raster] = true
+  end
+
+  opts.on('-l', '--license', 'Displays the copyright notice') do
+    puts "This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+"
+  end
+
+  opts.on('-w', '--warranty', 'Displays the warranty statement') do
+    puts "This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+"
+  end
+
+  opts.on('-v', '--version', 'Displays the program version') do
+    puts "algoheader v#{Algoheader::VERSION}"
+  end
+
+  opts.on_tail('-h', '--help', 'Displays the help screen') do
+    puts opts
+    exit
+  end
+end
+# rubocop:enable Metrics/BlockLength
+
+begin
+  optparse.parse!
+rescue OptionParser::InvalidOption, OptionParser::MissingArgument
+  puts $ERROR_INFO.to_s
+  puts 'Use -h or --help for options.'
+  exit 1
+end
+
+output_dir = options[:dir] || 'algoheader_output'
+FileUtils.mkdir_p(output_dir)
+
+config_file = options[:config] || Algoheader::Helpers.config_from_home
+config = YAML.load_file(config_file)
+
+selection = Algoheader::Helpers.selection_from_user(config)
+
+(options[:images] || 50).times do |index|
+  filename = "#{selection[:name]}_#{(index + 1).to_s.rjust(2, '0')}"
+
+  svg_blob = Algoheader::SvgGenerator.call(**selection.slice(:fill_colors, :stroke_colors))
+  File.write("#{output_dir}/#{filename}.svg", svg_blob)
+
+  Algoheader::PngTransformer.call(svg_blob, output_dir, filename) if options[:raster]
+end

data/lib/algoheader/helpers.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Dick Davis
+#
+# This file is part of algoheader.
+#
+# algoheader is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# algoheader is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with algoheader.  If not, see <http://www.gnu.org/licenses/>.
+
+module Algoheader
+  ##
+  # = Helpers
+  # Author::    Dick Davis
+  # Copyright:: Copyright 2021 Dick Davis
+  # License::   GNU Public License 3
+  #
+  # Module that provides helper methods.
+  module Helpers
+    def self.config_from_home
+      config_dir = "#{ENV['XDG_CONFIG_HOME'] || "#{Dir.home}/.config"}/algoheader"
+      FileUtils.mkdir_p(config_dir)
+
+      config_filename = "#{config_dir}/config.yml"
+      unless File.exist?(config_filename)
+        config_asset = File.expand_path(File.join(File.dirname(__FILE__), '..', 'assets', 'config.yml'))
+        FileUtils.cp(config_asset, config_filename)
+      end
+
+      config_filename
+    end
+
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    def self.selection_from_user(config, selection = '')
+      while selection.empty?
+        puts 'Choose a color scheme from the list below:'
+
+        schemes = config['color_schemes'].collect { |scheme| scheme['name'] }
+        schemes.each.with_index do |scheme, index|
+          puts "#{index}: #{scheme}"
+        end
+
+        puts 'Selection => '
+        user_input = gets.chomp.to_i
+        next unless (0..schemes.length - 1).include?(user_input)
+
+        selection = config['color_schemes'].select { |scheme| scheme['name'] == schemes[user_input] }
+                                           .first
+                                           .transform_keys(&:to_sym)
+      end
+
+      selection
+    end
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+  end
+end

data/lib/algoheader/png_transformer.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Dick Davis
+#
+# This file is part of algoheader.
+#
+# algoheader is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# algoheader is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with algoheader.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'rmagick'
+require_relative 'service_object'
+
+module Algoheader
+  ##
+  # = PngTransformer
+  # Author::    Dick Davis
+  # Copyright:: Copyright 2021 Dick Davis
+  # License::   GNU Public License 3
+  #
+  # Service object that writes SVG blobs to PNG files.
+  class PngTransformer < ServiceObject
+    attr_reader :svg, :dir, :filename
+
+    def initialize(svg, dir, filename)
+      super
+      @svg = svg
+      @dir = dir
+      @filename = filename
+    end
+
+    def call
+      img = Magick::Image.from_blob(svg) do
+        self.format = 'SVG'
+        self.background_color = 'transparent'
+      end
+      img[0].write("#{dir}/#{filename}.png")
+    end
+  end
+end

data/lib/algoheader/service_object.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Dick Davis
+#
+# This file is part of algoheader.
+#
+# algoheader is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# algoheader is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with algoheader.  If not, see <http://www.gnu.org/licenses/>.
+
+module Algoheader
+  ##
+  # = ServiceObject
+  # Author::    Dick Davis
+  # Copyright:: Copyright 2021 Dick Davis
+  # License::   GNU Public License 3
+  #
+  # Superclass for classes using the service object design pattern.
+  class ServiceObject
+    ##
+    # Allows subclasses to be initialized and called at the same time.
+    def self.call(*args, **kwargs, &block)
+      new(*args, **kwargs, &block).call
+    end
+  end
+end

data/lib/algoheader/svg_generator.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Dick Davis
+#
+# This file is part of algoheader.
+#
+# algoheader is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# algoheader is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with algoheader.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'ascii_to_svg'
+require_relative 'service_object'
+
+module Algoheader
+  ##
+  # = SvgGenerator
+  # Author::    Dick Davis
+  # Copyright:: Copyright 2021 Dick Davis
+  # License::   GNU Public License 3
+  #
+  # Generates SVGs by providing randomized input to algorithm.
+  class SvgGenerator < ServiceObject
+    SYMBOLS = ['/', '|', '\\', '-', '+', 'x', 'o', "\#", '.'].freeze
+    WIDTHS = [0.75, 1.0, 1.5].freeze
+    LINECAPS = %w[butt round square].freeze
+    OPACITIES = [0.8, 0.9, 1.0].freeze
+
+    attr_reader :fill_colors, :stroke_colors
+
+    def initialize(fill_colors:, stroke_colors:)
+      super
+      @fill_colors = fill_colors
+      @stroke_colors = stroke_colors
+    end
+
+    def call
+      ascii = AsciiToSvg.example_string(random_symbol_sample, 80)
+      AsciiToSvg.from_string(ascii, 16, **options)
+    rescue ZeroDivisionError
+      retry
+    end
+
+    private
+
+    def canvas_color
+      @canvas_color ||= random_fill_color
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    def options
+      {
+        canvas__size__x: 1500,
+        style__canvas__fill__color: canvas_color,
+        style__line__stroke__width: random_width,
+        style__line__stroke__color: random_stroke_color,
+        style__line__stroke__opacity: random_opacity,
+        style__line__stroke__linecap: random_linecap,
+        style__ellipse__stroke__width: random_width,
+        style__ellipse__stroke__color: random_stroke_color,
+        style__ellipse__stroke__opacity: random_opacity,
+        style__ellipse__stroke__linecap: random_linecap,
+        style__ellipse__fill: random_fill_color,
+        style__rectangle__fill__color: random_fill_color
+      }
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def random_symbol_sample
+      SYMBOLS.sample(rand(SYMBOLS.length))
+    end
+
+    def random_width
+      WIDTHS.sample
+    end
+
+    def random_opacity
+      OPACITIES.sample
+    end
+
+    def random_linecap
+      LINECAPS.sample
+    end
+
+    def random_fill_color
+      return fill_colors.sample if @canvas_color.nil?
+
+      fill_colors.reject { |color| color == canvas_color }.sample
+    end
+
+    def random_stroke_color
+      stroke_colors.reject { |color| color == canvas_color }.sample
+    end
+  end
+end

data/lib/algoheader/version.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Dick Davis
+#
+# This file is part of algoheader.
+#
+# algoheader is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# algoheader is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with algoheader.  If not, see <http://www.gnu.org/licenses/>.
+
+##
+# = version.rb
+# Author::    Dick Davis
+# Copyright:: Copyright 2021 Dick Davis
+# License::   GNU Public License 3
+#
+# Module for namespacing application classes.
+module Algoheader
+  # Program version number
+  VERSION = '0.0.1'
+end

data/lib/algoheader.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Dick Davis
+#
+# This file is part of algoheader.
+#
+# algoheader is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# algoheader is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with algoheader.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'algoheader/base'
+
+##
+# = Algoheader
+# Author::    Dick Davis
+# Copyright:: Copyright 2021 Dick Davis
+# License::   GNU Public License 3
+#
+# Module for namespacing application classes.
+module Algoheader; end

data/lib/assets/config.yml

@@ -0,0 +1,14 @@
+color_schemes:
+  - name: 'magnolia'
+    fill_colors:
+      - 'rgb(246,238,235)'
+      - 'rgb(234,213,207)'
+      - 'rgb(200,224,228)'
+      - 'white'
+    stroke_colors:
+      - 'rgb(246,238,235)'
+      - 'rgb(234,213,207)'
+      - 'rgb(200,224,228)'
+      - 'rgb(113,151,160)'
+      - 'rgb(34,48,83)'
+      - 'white'

data/test/test_hello.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Dick Davis
+#
+# This file is part of algoheader.
+#
+# algoheader is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# algoheader is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with algoheader.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'minitest/autorun'
+require_relative '../lib/algoheader/hello'
+
+##
+# = HelloTest
+# Author::    Dick Davis
+# Copyright:: Copyright 2021 Dick Davis
+# License::   GNU Public License 3
+#
+# Contains tests for Hello class.
+class HelloTest < Minitest::Test
+  ##
+  # Initializes test with sample data
+  def setup
+    @name = 'friend'
+  end
+
+  ##
+  # Ensures the greeter is behaving as expected
+  def test_hello
+    assert_equal('Hello, friend.', Algoheader::Hello.greeting(@name))
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: algoheader
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dick Davis
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ascii_to_svg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+description: 'Programmatically generate beautiful header images for blogs or social
+  media accounts.
+
+  '
+email: dick@hey.com
+executables:
+- algoheader
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/algoheader
+- lib/algoheader.rb
+- lib/algoheader/base.rb
+- lib/algoheader/helpers.rb
+- lib/algoheader/png_transformer.rb
+- lib/algoheader/service_object.rb
+- lib/algoheader/svg_generator.rb
+- lib/algoheader/version.rb
+- lib/assets/config.yml
+- test/test_hello.rb
+homepage: https://github.com/d3d1rty/algoheader
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Programmatically generate beautiful header images for blogs or social media
+  accounts.
+test_files:
+- test/test_hello.rb