dieses 0.0.1

data/README.md

@@ -0,0 +1,18 @@
+Diesis
+======
+
+[![test](https://github.com/alaturka/dieses/actions/workflows/test.yml/badge.svg)](https://github.com/alaturka/dieses/actions/workflows/test.yml)
+[![codebeat badge](https://codebeat.co/badges/7e57d6fa-d244-4359-a324-c4239217b749)](https://codebeat.co/projects/github-com-alaturka-dieses-master)
+
+Guide sheets for penmanship, calligraphy, lettering, and sketching.
+[Click](https://github.com/alaturka/dieses/tree/master/docs/sheets) to reach the all available guide sheet combinations.
+
+Couldn't find the guide sheet you were looking for?  [Open an
+issue](https://github.com/alaturka/dieses/issues/new/choose) and let's see what we can do.
+
+Install
+-------
+
+```sh
+gem install dieses
+```

data/bin/dieses

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'dieses/application/cli'
+
+def main
+  Dieses::Application::CLI::Multi.(*ARGV)
+end
+
+main

data/bin/diesis

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'dieses/application/cli'
+
+def main
+  Dieses::Application::CLI::Single.(*ARGV)
+end
+
+main

data/dieses.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+
+require 'dieses/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'dieses'
+  s.author      = 'Recai Oktaş'
+  s.email       = 'roktas@gmail.com'
+  s.license     = 'GPL-3.0-or-later'
+  s.version     = Dieses::VERSION.dup
+  s.summary     = 'Guide sheets generator for penmanship, calligraphy, lettering, and sketching'
+  s.description = 'Guide sheets generator for penmanship, calligraphy, lettering, and sketching'
+
+  s.homepage      = 'https://alaturka.github.io/dieses'
+  s.files         = Dir['CHANGELOG.md', 'LICENSE.md', 'README.md', 'BENİOKU.md', 'dieses.gemspec', 'lib/**/*']
+  s.executables   = %w[diesis dieses]
+  s.require_paths = %w[lib]
+
+  s.metadata['changelog_uri']     = 'https://github.com/alaturka/dieses/blob/master/CHANGELOG.md'
+  s.metadata['source_code_uri']   = 'https://github.com/alaturka/dieses'
+  s.metadata['bug_tracker_uri']   = 'https://github.com/alaturka/dieses/issues'
+
+  s.required_ruby_version = '>= 2.7.0' # rubocop:disable Gemspec/RequiredRubyVersion
+
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'minitest-focus', '>= 1.2.1'
+  s.add_development_dependency 'minitest-reporters', '>= 1.4.3'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'rubocop-minitest'
+  s.add_development_dependency 'rubocop-performance'
+  s.add_development_dependency 'rubocop-rake'
+  s.add_development_dependency 'rubygems-tasks'
+end

data/lib/dieses.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative 'dieses/support'
+require_relative 'dieses/error'
+require_relative 'dieses/geometry'
+require_relative 'dieses/application'
+require_relative 'dieses/version'

data/lib/dieses/application.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'application/common'
+require_relative 'application/paper'
+require_relative 'application/canvas'
+require_relative 'application/pen'
+require_relative 'application/mixins'
+require_relative 'application/sheet'
+require_relative 'application/sheets'
+require_relative 'application/batch'
+
+module Dieses
+  module Application
+    module_function
+
+    def produce(sheet, variant: Undefined, paper: Paper.default, orientation: Orientation.default, **render_args)
+      sheet(sheet, variant: variant, paper: paper, orientation: orientation).produce(**render_args)
+    end
+
+    def sheet(sheet, variant: Undefined, paper: Paper.default, orientation: Orientation.default)
+      Sheets.sheet(sheet.to_sym).new(Paper.public_send(paper.to_sym).orient(orientation.to_sym), variant: variant)
+    end
+  end
+end

data/lib/dieses/application/batch.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'json'
+
+module Dieses
+  module Application
+    module Batch
+      Production = Struct.new :sheet, :variant, :desc, :paper, :orientation, :file, :produce, keyword_init: true do
+        def self.call(**kwargs)
+          new(**kwargs.slice(*members)).tap do |production|
+            production.file = production.relfile unless production.file
+          end
+        end
+
+        def to_s
+          suffix = orientation.to_s == 'landscape' ? 'l' : ''
+          "#{sheet}-#{variant}@#{paper}#{suffix}"
+        end
+
+        def key
+          to_s.to_sym
+        end
+
+        def relfile
+          File.join(reldir, "#{self}.svg")
+        end
+
+        def call
+          Application.produce(sheet, variant: variant, paper: paper, orientation: orientation)
+        end
+
+        def run(basedir)
+          unless produce
+            warn "Undefined production request; skipping: #{self}" if produce.nil?
+
+            return
+          end
+
+          outfile = File.join(File.expand_path(basedir), file)
+          content = call
+
+          FileUtils.mkdir_p(File.dirname(outfile))
+          File.write(outfile, content)
+        end
+
+        private
+
+        def reldir
+          File.join(sheet, paper)
+        end
+      end
+
+      private_constant :Production
+
+      module_function
+
+      PAPERS       = %i[a4 a5].freeze
+      ORIENTATIONS = Orientation.values
+
+      # rubocop:disable Metrics/MethodLength
+      # codebeat:disable[BLOCK_NESTING]
+      def all(papers: PAPERS, orientations: ORIENTATIONS)
+        Set.new.tap do |productions|
+          papers.each do |paper|
+            Sheets.available.each do |sheet, proto|
+              proto.variants.each do |variant|
+                orientations.each do |orientation|
+                  productions << Production.(sheet:       sheet.to_s,
+                                             variant:     variant.to_s,
+                                             desc:        variant.desc,
+                                             paper:       paper.to_s,
+                                             orientation: orientation.to_s)
+                end
+              end
+            end
+          end
+        end
+      end
+      # codebeat:enable[BLOCK_NESTING]
+
+      def defaults
+        Set.new(
+          Sheets.defaults.map do |sheet, variant|
+            Production.(sheet:       sheet.to_s,
+                        variant:     variant.to_s,
+                        desc:        variant.desc,
+                        paper:       Paper.default.to_s,
+                        orientation: Orientation.default.to_s)
+          end
+        )
+      end
+
+      def index(productions)
+        previous = Support.hashify_by productions, :key
+        current  = Support.hashify_by Batch.all, :key
+
+        unprocessed = []
+        current.each do |name, production|
+          unless previous.key?(name)
+            unprocessed << production
+
+            next
+          end
+
+          production.produce = previous[name].produce
+        end
+
+        [current.values, unprocessed]
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def from_json_file(file)
+        JSON.load_file(file).map do |hash|
+          hash.transform_keys!(&:to_sym)
+          Production.(**hash.slice(*Production.members))
+        end
+      end
+
+      def to_json_file(file, productions)
+        content = JSON.pretty_generate(productions.map(&:to_h)).chomp
+
+        File.write(file, "#{content}\n")
+      end
+    end
+  end
+end

data/lib/dieses/application/canvas.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'delegate'
+
+module Dieses
+  module Application
+    class Canvas < DelegateClass(Geometry::Rect)
+      TEMPLATE = <<~XML
+        <?xml version="1.0" standalone="no"?>
+        <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+        <svg xmlns="http://www.w3.org/2000/svg" width="%{width}mm" height="%{height}mm" viewBox="0 0 %{width} %{height}" %{header}>
+        %{style}
+          <g id="sheet">
+        %{content}
+          </g>
+        </svg>
+      XML
+
+      attr_reader :elements, :paper
+
+      def initialize(paper = Paper.a4)
+        super(paper.inner)
+
+        @paper    = paper
+        @elements = Set.new
+      end
+
+      def to_h
+        @paper.to_h
+      end
+
+      def <<(items)
+        [*items].each do |item|
+          case item
+          when Array             then item.each { |element| elements << element }
+          when Geometry::Element then elements << item
+          else                        raise Error, 'Item must be an Array or Element'
+          end
+        end
+      end
+
+      def render(header: EMPTY_STRING, style: EMPTY_STRING)
+        # We avoid prettifying XML through REXML which is pretty slow, at the cost of some ugly hacks.
+        format(TEMPLATE, **to_h,
+               content: Geometry.to_svg(elements, paper, prefix: ' ' * 4),
+               header:  header,
+               style:   style.empty? ? '' : format('<style>%{style}</style>', style: style))
+      end
+    end
+  end
+end

data/lib/dieses/application/cli.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'diesis'
+
+require_relative 'cli/single'
+require_relative 'cli/multi'

data/lib/dieses/application/cli/multi.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require 'optparse'
+require 'ostruct'
+
+module Dieses
+  module Application
+    module CLI
+      module Multi
+        OPTIONS = EMPTY_HASH
+
+        def self.call(*argv, **options)
+          options = OpenStruct.new(OPTIONS.merge(options))
+          args options(argv, options), argv
+
+          index_file = argv.first
+
+          return build_index(index_file, options) if options.index
+
+          batch_run(index_file, options)
+        rescue OptionParser::InvalidOption, Dieses::Error => e
+          abort(e.message)
+        end
+
+        class << self
+          private
+
+          def options(argv, options) # rubocop:disable Metrics/MethodLength
+            Signal.trap('INT') { Kernel.abort '' }
+
+            OptionParser.new do |option|
+              program_name = option.program_name
+              option.banner = <<~BANNER
+                Usage: #{program_name} [options...] <INDEXFILE>
+
+                See #{program_name}(1) manual page for detailed help.
+
+                Options:
+
+              BANNER
+
+              option.on('--index', 'Create index for all variants without producing sheets') do |opt|
+                options.index = opt
+              end
+
+              option.on('--destdir DIR', 'Destination directory') do |opt|
+                options.destdir = opt
+              end
+
+              option.on('--no-clobber', 'Do not overwrite an existing file or directory') do
+                options.no_clobber = true
+              end
+
+              option.on('--pdf', 'Generate PDF') do |_opt|
+                raise NotImplementedError
+              end
+
+              option.on_tail('-h', '--help', 'Show this message') do
+                abort option.help
+              end
+
+              option.on_tail('-v', '--version', 'Show version') do
+                warn VERSION
+                exit
+              end
+            end.tap { |parser| parser.parse!(argv) } # rubocop:disable Style/MultilineBlockChain
+          end
+
+          def args(parser, argv)
+            if argv.empty?
+              warn parser.help
+              warn ''
+              abort 'Error: Index file required.'
+            end
+
+            return if argv.size <= 1
+
+            warn parser.help
+            warn ''
+            abort 'Error: Too many arguments.'
+          end
+
+          def build_index(index_file, options)
+            abort("Index file exists: #{index_file}") if options.no_clobber && File.exist?(index_file)
+
+            productions, unprocessed = Batch.index Batch.from_json_file(index_file)
+
+            warn "Warning: There are #{unprocessed.size} new sheets which should be processed" unless unprocessed.empty?
+
+            Batch.to_json_file(index_file, productions)
+          end
+
+          def batch_run(index_file, options)
+            abort("Index file not found: #{index_file}") unless File.exist?(index_file)
+
+            destdir = options.destdir || File.join(File.dirname(index_file))
+            abort("Destination directory exists: #{destdir}") if Dir.exist?(destdir) && options.no_clobber
+
+            FileUtils.rm_rf(Dir[File.join(destdir, '*')].select { |file| File.directory?(file) })
+            Batch.from_json_file(index_file).each { |production| production.run(destdir) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dieses/application/cli/single.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Dieses
+  module Application
+    module CLI
+      module Single
+        def self.call(*argv, **options)
+          options = OpenStruct.new(options)
+          args options(argv, options), argv
+
+          sheet = argv.first
+
+          return puts(out = Application.produce(sheet, **options.to_h)) unless options[:output]
+
+          File.write(options[:output], out)
+        rescue OptionParser::InvalidOption, Dieses::Error => e
+          abort(e.message)
+        end
+
+        class << self
+          private
+
+          # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
+          # codebeat:disable[LOC]
+          def options(argv, options)
+            Signal.trap('INT') { Kernel.abort '' }
+
+            OptionParser.new do |option| # rubocop:disable Metrics/BlockLength
+              program_name = option.program_name
+              option.banner = <<~BANNER
+                Usage: #{program_name} [options...] <SHEET>
+
+                See #{program_name}(1) manual page for detailed help.
+
+                Options:
+
+              BANNER
+
+              option.on('--paper PAPER', 'Paper size [default: a4]', String) do |opt|
+                options.paper = opt
+              end
+
+              option.on('--variant VARIANT', 'Sheet variant', String) do |opt|
+                options.variant = opt
+              end
+
+              option.on('--landscape', 'Use landscape orientation') do
+                options.orientation = :landscape
+              end
+
+              option.on('-o', '--output FILE', 'Output file', String) do |opt|
+                options.output = opt
+              end
+
+              option.on('--pdf', 'Generate PDF') do |_opt|
+                raise NotImplementedError
+              end
+
+              option.on('-l', '--list', 'List guidesheets') do
+                list
+                exit
+              end
+
+              option.on_tail('-h', '--help', 'Show this message') do
+                abort option.help
+              end
+
+              option.on_tail('-v', '--version', 'Show version') do
+                warn VERSION
+                exit
+              end
+            end.tap { |parser| parser.parse!(argv) } # rubocop:disable Style/MultilineBlockChain
+          end
+          # codebeat:enable[LOC]
+          # rubocop:enable Metrics/MethodLength,Metrics/AbcSize
+
+          def args(parser, argv)
+            if argv.empty?
+              warn parser.help
+              warn ''
+              abort "Error: Guidesheet type required. Type #{parser.program_name} -l to list all available guidesheets."
+            end
+
+            return if argv.size <= 1
+
+            warn parser.help
+            warn ''
+            abort 'Error: Too many arguments.'
+          end
+
+          def list
+            warn 'Sheets:'
+            warn ''
+            warn Sheets.dump(prefix: "\t")
+          end
+        end
+      end
+    end
+  end
+end