texd 0.1.0

data/lib/texd/lookup_context.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Texd
+  # LookupContext is used to find files accross gem, engine and application
+  # barriers. This allows other gems and engines to define additional paths
+  # to look into, when searching for files.
+  #
+  # This mechanism is useful, if you want to build a Rails engine to provide
+  # default files, and reuse those defaults accross multiple Rails apps.
+  #
+  # To add a file to the loolup path set, configure Texd:
+  #
+  #     # in lib/yourgem/railtie.rb
+  #     module Yourgem::Railtie < Rails::Railtie
+  #       initializer "configure Texd" do
+  #         Texd.configure do |config|
+  #           config.lookup_paths << Pathname.new(__dir__).join("../../app/tex")
+  #         end
+  #       end
+  #     end
+  #
+  # Then files in your `app/tex/` directory will be used, if they are not
+  # found in the host application's `app/tex/` directory ("app/tex" is just
+  # a convention, you could add arbitrary directories).
+  class LookupContext
+    # @!parse
+    #   # Raised when LookupContext#find could not find a file.
+    #   class MissingFileError < RenderError; end
+    MissingFileError = Class.new Error
+
+    # A list of directories, in priority order, to search files in.
+    attr_reader :paths
+
+    # @param [Array<String, Pathname>] paths is a set of paths to search
+    #   files in; usually configured with `Texd.config.lookup_paths`
+    def initialize(paths)
+      @paths = (paths || []).map { |path| expand(path) }
+    end
+
+    # Performs file look up in the configured paths.
+    #
+    # @param [String, Pathname] name of file to find.
+    # @return [Pathname] path to file, when found
+    # @raise [MissingFileError] when file could not be found
+    def find(name)
+      return expand(name) if File.absolute_path?(name)
+
+      paths.each do |path|
+        candidate = path.join(name).expand_path
+        return candidate if candidate.exist?
+      end
+
+      msg  = format "file %p not found\nsearch paths:\n\t", name
+      msg << paths.join("\n\t")
+      raise MissingFileError, msg
+    end
+
+    private
+
+    def expand(path)
+      Pathname.new(path).expand_path
+    end
+  end
+end

data/lib/texd/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Texd
+  class Railtie < ::Rails::Railtie
+    initializer "initialize texd" do
+      # register MIME type for .tex files
+      Mime::Type.register "text/x-tex", :tex, ["text/plain"], ["tex"]
+
+      # prepend app/tex for Rails host application
+      Texd.config.lookup_paths.unshift Rails.root.join("app/tex")
+    end
+  end
+end

data/lib/texd/version.rb

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

data/lib/texd.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module Texd
+  # @!parse
+  #   # Catch-all error for all exceptions raised by Texd
+  #   class Error < StandarError; end
+  Error = Class.new StandardError
+end
+
+require "rails"
+
+require_relative "texd/version"
+require_relative "texd/config"
+require_relative "texd/helpers"
+require_relative "texd/client"
+require_relative "texd/attachment"
+require_relative "texd/document"
+require_relative "texd/lookup_context"
+require_relative "texd/railtie"
+
+module Texd
+  extend self
+
+  # Reconfigures Texd. Should be called once in your initializer.
+  #
+  # @example config/initializers/texd.rb
+  #   Texd.configure do |config|
+  #     config.endpoint     = ENV.fetch("TEXD_ENDPOINT", "http://localhost:2201/")
+  #     config.error_format = ENV.fetch("TEXD_ERRORS", "full")
+  #     config.tex_engine   = ENV["TEXD_ENGINE"]
+  #     config.tex_image    = ENV["TEXD_IMAGE"]
+  #     config.helpers      = []
+  #     config.lookup_paths = [Rails.root.join("app/tex")]
+  #   end
+  #
+  # @yield [Texd::Configuration] the previous config object
+  # @return [Texd::Configuration] the new current config object
+  def configure
+    yield config if block_given?
+    config
+  end
+
+  # @return [Texd::Configuration] the current config object.
+  def config
+    @config ||= Configuration.new
+  end
+
+  # @return [Texd::Client] the currently configured HTTP client.
+  def client
+    if (new_hash = config.hash) && new_hash != @config_hash
+      @client      = Client.new(config)
+      @config_hash = new_hash
+    end
+
+    @client
+  end
+
+  # Creates a helper module containing (a) the `texd_attach` helper,
+  # and (b) any other helper configured in Text.config.helpers.
+  #
+  # This needs to be dynamic, because the attachment list is volatile.
+  #
+  # @api private
+  def helpers(attachments)
+    Module.new do
+      include Texd::Helpers
+
+      define_method :texd_attach do |path, rename: true, with_extension: true|
+        attachments.attach(path, rename).name(with_extension)
+      end
+
+      define_method :texd_reference do |path, rename: true, with_extension: true|
+        attachments.reference(path, rename).name(with_extension)
+      end
+
+      alias_method :texd_references, :texd_reference
+
+      Texd.config.helpers.each do |mod|
+        include mod
+      end
+    end
+  end
+
+  # Render compiles a template, uploads the files to the texd instance,
+  # and returns the PDF.
+  #
+  # The arguments are directly forwarded to ApplicationController#render
+  # (which in turn delegates to ActionView::Renderer#render).
+  #
+  # @example Render app/views/document/document.tex.erb
+  #   begin
+  #     pdf = Texd.render(template: "documents/document")
+  #   rescue Texd::Client::CompilationError => err
+  #     # Compilation failed and we might have a log in err.logs (only
+  #     # Texd.config.error_format is "full" or "condensed").
+  #     # Otherwise some details might be available in err.details.
+  #     # have a log in err.details
+  #   rescue Texd::Client::InputError => err
+  #     # something failed during input file processing. For details see
+  #     # err.details
+  #   rescue Texd::Client::QueueError => err
+  #     # server is busy, try again later.
+  #   rescue Texd::Error => err
+  #     # something went wrong before we even got to sent data to the server
+  #   end
+  #
+  # @raise [Texd::Client::ResponseError] on input and queue errors. Also on
+  #   compilation errors, if Texd.config.error_format is set to JSON.
+  # @raise [Texd::Error] on other Texd related errors.
+  # @return [String] the PDF object
+  def render(*args)
+    doc = Document.compile(*args)
+
+    client.render doc.to_upload_ios,
+      input: doc.main_input_name
+  rescue Client::ReferenceError => err
+    # retry once with resolved references
+    client.render doc.to_upload_ios(missing_refs: err.references),
+      input: doc.main_input_name
+  end
+end

data/texd.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative "lib/texd/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "texd"
+  spec.version = Texd::VERSION
+  spec.authors = ["Dominik Menke"]
+  spec.email   = ["dom@digineo.de"]
+
+  spec.summary     = "texd is a Ruby client for the texd web service."
+  spec.description = "The texd project provides a network reachable TeX compiler. This gem is a client for that."
+  spec.homepage    = "https://github.com/digineo/texd-ruby"
+  spec.license     = "MIT"
+
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["rubygems_mfa_required"] = "true"
+  spec.metadata["homepage_uri"]          = spec.homepage
+  spec.metadata["source_code_uri"]       = spec.homepage
+  spec.metadata["changelog_uri"]         = "#{spec.homepage}/blob/v#{Texd::VERSION}/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) {
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  }
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "multipart-post", "~> 2.0"
+  spec.add_dependency "rails", ">= 6.0", "< 8"
+
+  spec.add_development_dependency "combustion"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-rails"
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: texd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dominik Menke
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The texd project provides a network reachable TeX compiler. This gem
+  is a client for that.
+email:
+- dom@digineo.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Makefile
+- README.md
+- Rakefile
+- gemfiles/rails-6.0
+- gemfiles/rails-6.0.lock
+- gemfiles/rails-6.1
+- gemfiles/rails-6.1.lock
+- gemfiles/rails-7.0
+- gemfiles/rails-7.0.lock
+- lib/texd.rb
+- lib/texd/attachment.rb
+- lib/texd/client.rb
+- lib/texd/config.rb
+- lib/texd/document.rb
+- lib/texd/helpers.rb
+- lib/texd/lookup_context.rb
+- lib/texd/railtie.rb
+- lib/texd/version.rb
+- texd.gemspec
+homepage: https://github.com/digineo/texd-ruby
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/digineo/texd-ruby
+  source_code_uri: https://github.com/digineo/texd-ruby
+  changelog_uri: https://github.com/digineo/texd-ruby/blob/v0.1.0/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: texd is a Ruby client for the texd web service.
+test_files: []