polites 0.1.0

data/lib/polites/plist.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'json'
+
+module Polites
+  # Read macos binary .plist files into a Hash by converting them to JSON format
+  # using the macos native `plutil` program. This only works on macos.
+  class Plist
+    # @param [#to_s] path
+    def initialize(path)
+      @path = path
+    end
+
+    # @return [Hash]
+    def to_h
+      @content ||= read_plist
+    end
+
+    private
+
+    def read_plist
+      "plutil -convert json -o - #{@path}"
+        .then { |s| Open3.capture2(s) }
+        .then { |(json, _)| JSON.parse(json) }
+    end
+  end
+end

data/lib/polites/range_tag.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative './tag'
+
+module Polites
+  # A range tag is a {Tag} defined by a start and an end pattern, such as used
+  # by defining bold formatting.
+  class RangeTag < Tag
+    # @return [String]
+    attr_reader :start_pattern
+    # @return [String]
+    attr_reader :end_pattern
+
+    # @param [String] name
+    # @param [String] start_pattern
+    # @param [String] end_pattern
+    def initialize(name, start_pattern, end_pattern)
+      super(name)
+      @start_pattern = start_pattern
+      @end_pattern = end_pattern
+    end
+
+    def eql?(other)
+      super &&
+        start_pattern == other.start_pattern &&
+        end_pattern == other.end_pattern
+    end
+  end
+end

data/lib/polites/settings.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative './plist'
+
+module Polites
+  # Settings is a wrapped around the combined configurations Polites writes to
+  # various Plist files in external directory.
+  class Settings
+    # Read all combined .plist files in a directory into a single data
+    # structure.
+    #
+    # @param [#to_s, #to_path] path root directory to look up .plist files in.
+    # @return [Polites::Settings]
+    def self.from_directory(path)
+      Pathname(path)
+        .glob('.*.plist')
+        .inject({}) { |s, f| s.merge Plist.new(f).to_h }
+        .then { |s| new(s) }
+    end
+
+    # @param [Hash] settings
+    def initialize(settings = {})
+      @settings = settings.to_h
+      freeze
+    end
+
+    # Look up a setting by key.
+    #
+    # @param [String] key
+    # @return [Object]
+    def [](key)
+      @settings[key]
+    end
+  end
+end

data/lib/polites/sheet.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Polites
+  # A sheet is represents a single "document" in Polites. It composes the main
+  # content in {Sheet#content}, its markup definition in {Sheet#markup}, any
+  # attaches files in {Sheet#files} and some metadata.
+  class Sheet
+    # @return [String]
+    attr_reader :version
+
+    # @return [String]
+    attr_reader :app_version
+
+    # @return [Markup]
+    attr_reader :markup
+
+    # @return [Array<Node>]
+    attr_reader :content
+
+    # @return [Array<String>]
+    attr_reader :keywords
+
+    # @return [Array<String>]
+    attr_reader :files
+
+    # @return [Array<Array<Node>>]
+    attr_reader :notes
+
+    # @param [String] version
+    # @param [String] app_version
+    # @param [Markup] markup
+    # @param [Array<Node>] content
+    # @param [Array<String>] keywords
+    # @param [Array<String>] files
+    # @param [Array<Array<Node>>] notes
+    def initialize(version:, app_version:, markup:, content:, keywords: [], files: [], notes: [])
+      @version = version
+      @app_version = app_version
+      @markup = markup
+      @content = content
+      @keywords = keywords
+      @files = files
+      @notes = notes
+    end
+
+    # Get all files that were referenced in the content, such as inline images.
+    #
+    # @return [Array<Span::Image>]
+    def inline_files
+      content.flat_map do |node|
+        node.children.grep(Span::Image)
+      end
+    end
+
+    # Get all files that were attached to the sheet without explicit mention in
+    # the content.
+    #
+    # @return [Array<String>]
+    def attached_files
+      files - inline_files.map(&:image)
+    end
+  end
+end

data/lib/polites/simple_tag.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative './tag'
+
+module Polites
+  # A simple tag is a {Tag} defined by a single pattern, such as for headings.
+  class SimpleTag < Tag
+    # @return [String]
+    attr_reader :pattern
+
+    # @param [String] name
+    # @param [String] pattern
+    def initialize(name, pattern)
+      super(name)
+      @pattern = pattern
+    end
+
+    def eql?(other)
+      super && pattern == other.pattern
+    end
+  end
+end

data/lib/polites/span.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative '../polites'
+require_relative './node'
+
+module Polites
+  # A span is an element mapping to inline formatting, such as text formatting
+  # and images. Spans only exist within blocks and cannot themselves contain
+  # {Block} nodes.
+  class Span < Node
+    # Build the proper kind of span from the given arguments.
+    #
+    # @param [Array<Node>] children
+    # @param [String] kind the type Polites has given to this node.
+    # @param [String, nil] url the URL attribute for links.
+    # @param [String, nil] image the image fingerprint referring to a sheet file.
+    # @param [String, nil] filename the explicit filename to use for images.
+    # @param [String, nil] title the title attribute for links, images.
+    # @param [String, nil] description the description attribute used by images.
+    # @param [String, nil] width the explicitly configured image width
+    # @param [String, nil] height the explicitly configured image height
+    # @param [Array<Node>] text the contents of footnoes and annotation.
+    # @raise [ParseError] when encountering unexpected `kind`
+    # @return [Span]
+    def self.build(children = [], kind: nil, url: nil, image: nil, filename: nil, title: nil, description: nil, width: nil, height: nil, text: nil)
+      case kind
+      when 'link'
+        Span::Link.new(children, url: url, title: title)
+      when 'mark'
+        Span::Mark.new(children)
+      when 'emph'
+        Span::Emph.new(children)
+      when 'strong'
+        Span::Strong.new(children)
+      when 'annotation'
+        Span::Annotation.new(children, text)
+      when 'footnote'
+        Span::Footnote.new(children, text)
+      when 'delete'
+        Span::Delete.new(children)
+      when 'code'
+        Span::Code.new(children)
+      when 'image'
+        Span::Image.new(children, image: image, filename: filename, title: title, description: description, width: width, height: height)
+      else
+        raise ParseError, "unexpected kind #{kind.inspect}"
+      end
+    end
+  end
+end
+
+require_relative './span/link'
+require_relative './span/emph'
+require_relative './span/annotation'
+require_relative './span/strong'
+require_relative './span/footnote'
+require_relative './span/image'
+require_relative './span/mark'
+require_relative './span/delete'
+require_relative './span/code'

data/lib/polites/span/annotation.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative '../span'
+
+module Polites
+  class Span::Annotation < Span
+    attr_reader :text
+
+    def initialize(children, text)
+      super(children)
+      @text = text
+    end
+
+    def eql?(other)
+      super && text == other.text
+    end
+  end
+end

data/lib/polites/span/code.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative '../span'
+
+module Polites
+  class Span::Code < Span
+  end
+end

data/lib/polites/span/delete.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative '../span'
+
+module Polites
+  class Span::Delete < Span
+  end
+end

data/lib/polites/span/emph.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative '../span'
+
+module Polites
+  class Span::Emph < Span
+  end
+end

data/lib/polites/span/footnote.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative '../span'
+
+module Polites
+  class Span::Footnote < Span
+    attr_reader :text
+
+    def initialize(children, text)
+      super(children)
+      @text = text
+    end
+
+    def eql?(other)
+      super && text == other.text
+    end
+  end
+end

data/lib/polites/span/image.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative '../span'
+
+module Polites
+  class Span::Image < Span
+    attr_reader :children, :image, :filename, :title, :description, :width, :height
+
+    def initialize(children, image:, filename: nil, title: nil, description: nil, width: nil, height: nil)
+      super(children)
+      @image = image
+      @filename = filename
+      @title = title
+      @description = description
+      @width = width
+      @height = height
+    end
+
+    def eql?(other)
+      super &&
+        image == other.image &&
+        filename == other.filename &&
+        title == other.title &&
+        description == other.description &&
+        width == other.width &&
+        height == other.height
+    end
+  end
+end

data/lib/polites/span/link.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative '../span'
+
+module Polites
+  class Span::Link < Span
+    attr_reader :url, :title
+
+    def initialize(children = [], url:, title: nil)
+      super(children)
+      @url = url
+      @title = title
+    end
+
+    def eql?(other)
+      super &&
+        url == other.url &&
+        title == other.title
+    end
+  end
+end

data/lib/polites/span/mark.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative '../span'
+
+module Polites
+  class Span::Mark < Span
+  end
+end

data/lib/polites/span/strong.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative '../span'
+
+module Polites
+  class Span::Strong < Span
+  end
+end

data/lib/polites/tag.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Polites
+  # A tag is used to define the markup used in Polites documents.
+  class Tag
+    # @return [String]
+    attr_reader :name
+
+    # @param [String] name
+    def initialize(name)
+      @name = name
+    end
+
+    def eql?(other)
+      other.is_a?(self.class) && name == other.name
+    end
+
+    alias == eql?
+  end
+end

data/lib/polites/text.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Polites
+  # A piece of simple text to be output directly. A stand-in for a simple
+  # string.
+  class Text
+    attr_reader :text
+
+    # @param [String] text
+    def initialize(text)
+      @text = text
+    end
+
+    def eql?(other)
+      other.is_a?(self.class) && text == other.text
+    end
+
+    alias == eql?
+  end
+end

data/lib/polites/version.rb

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

data/polites-nanoc.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'lib/polites/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'polites-nanoc'
+  spec.version = Polites::VERSION
+  spec.authors = ['Arjan van der Gaag']
+  spec.email = ['arjan@arjanvandergaag.nl']
+
+  spec.summary = 'Integrate the Ulysess gem with Nanoc.'
+  spec.description = 'Use Polites\' .ulyz files as a data source in static sites generated with Nanoc.'
+  spec.homepage = 'https://github.com/avdgaag/polites'
+  spec.license = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/avdgaag/polites'
+  spec.metadata['changelog_uri'] = 'https://github.com/avdgaag/polites'
+
+  # 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__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }.grep(/nanoc/)
+  end
+  spec.require_paths = ['lib']
+  spec.add_dependency 'nanoc', '~> 4'
+  spec.add_dependency 'polites', "~> #{Polites::VERSION}"
+end