Merge pull request #51 from razeware/development

v1.0.10: 🐌 Salon

app/commands/robles_cli.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'irb'
 require 'guard'
 require 'guard/commander' # needed because of https://github.com/guard/guard/issues/793
 
@@ -15,8 +16,7 @@ def self.exit_on_failure?
   option :local, type: :boolean
   def render
     book = runner.render(publish_file: options['publish_file'], local: options['local'])
-    p book.sections.first.chapters.last
-    p book.contributors.to_json
+    p book.cover_image_url.to_json
   end
 
   desc 'serve', 'starts local preview server'
@@ -32,6 +32,15 @@ def serve
     RoblesServer.run!
   end
 
+  desc 'console [PUBLISH_FILE]', 'opens an interactive Ruby console'
+  option :'publish-file', type: :string, desc: 'Location of the publish.yaml file'
+  def console
+    publish_file = options.fetch('publish_file', runner.default_publish_file)
+    parser = Parser::Publish.new(file: publish_file)
+    book = parser.parse
+    binding.irb
+  end
+
   desc 'publish [PUBLISH_FILE]', 'renders and publishes a book'
   option :'publish-file', type: :string, desc: 'Location of the publish.yaml file'
   def publish

app/lib/image_provider/extractor.rb

@@ -12,7 +12,7 @@ def initialize(book)
 
     def extract
       @images = image_paths.map do |path|
-        Image.with_representations(local_url: path[:absolute_path], sku: book.sku)
+        Image.with_representations({ local_url: path[:absolute_path], sku: book.sku }, variants: path[:variants])
       end
     end
 

app/lib/image_provider/markdown_image_extractor.rb

@@ -18,7 +18,11 @@ def images
     end
 
     def image_record(url)
-      { relative_path: cleanpath(url), absolute_path: cleanpath(apply_path(url)) }
+      {
+        relative_path: cleanpath(url),
+        absolute_path: cleanpath(apply_path(url)),
+        variants: ImageRepresentation::DEFAULT_WIDTHS.keys
+      }
     end
 
     def cleanpath(path)

app/lib/image_provider/provider.rb

@@ -27,8 +27,8 @@ def process
     def representations_for_local_url(url)
       clean_url = Pathname.new(url).cleanpath.to_s
       extractor.images
-               .find { |image| image.local_url == clean_url }
-               &.representations
+               .filter { |image| image.local_url == clean_url }
+               .flat_map(&:representations)
     end
 
     def extractor

app/lib/linting/linter.rb

@@ -46,7 +46,7 @@ def lint_with_ui(options:, show_ui: true) # rubocop:disable Metrics/MethodLength
 
       if file_exists?(vend_file)
         with_spinner(title: 'Validating {{bold:vend.yaml}}', show: show_ui) do
-          annotations.concat(Linting::VendLinter.new(file: vend_file).lint)
+          annotations.concat(Linting::VendLinter.new(file: vend_file).lint(options: options))
         end
       else
         puts CLI::UI.fmt('{{x}} Unable to find {{bold:vend.yaml}}--skipping validation.')

app/lib/linting/metadata/edition_reference.rb

@@ -34,13 +34,15 @@ def error_annotation
           locate_edition_reference.merge(
             absolute_path: file,
             annotation_level: 'failure',
-            message: "The edition attribute in `publish.yaml` (#{edition_from_metadata}) should be the same as the one\nspecified in the git branch name (#{current_branch}).",
+            message: "The edition attribute in #{Pathname.new(file).basename} (#{edition_from_metadata}) should be the same as the one\nspecified in the git branch name (#{current_branch}).",
             title: 'Invalid edition specified'
           )
         )
       end
 
-      def locate_edition_reference
+      def locate_edition_reference # rubocop:disable Metrics/MethodLength
+        return { start_line: 0, end_line: 0 } unless attributes[:edition].present?
+
         IO.foreach(file).with_index do |line, line_number|
           next unless line.include?('edition:')
 

app/lib/linting/vend_linter.rb

@@ -3,20 +3,21 @@
 module Linting
   # Lints vend.yaml
   class VendLinter # rubocop:disable Metrics/ClassLength
-    VALID_PRICE_BANDS = %w(free 2020_full_book 2020_short_book 2020_deprecated_book).freeze
+    VALID_PRICE_BANDS = %w[free 2020_full_book 2020_short_book 2020_deprecated_book].freeze
     attr_reader :file, :vend_file
 
     def initialize(file:)
       @file = file
       @annotations = []
     end
 
-    def lint
+    def lint(options: {})
       load_file
       return @annotations unless @annotations.empty?
 
       check_price_band
       check_total_percentage
+      @annotations.concat(Linting::Metadata::EditionReference.lint(file: file, attributes: vend_file)) unless options['without-edition']
       return @annotations unless @annotations.empty?
 
       check_for_razeware_user

app/lib/parser/publish.rb

@@ -7,9 +7,9 @@ class Publish
     include Linting::FileExistenceChecker
 
     VALID_BOOK_ATTRIBUTES = %i[sku edition title description_md released_at materials_url
-                               cover_image gallery_image twitter_card_image trailer_video_url
-                               version_description professional difficulty platform
-                               language editor domains categories who_is_this_for_md
+                               cover_image gallery_image twitter_card_image artwork_image icon_image
+                               trailer_video_url version_description professional difficulty
+                               platform language editor domains categories who_is_this_for_md
                                covered_concepts_md hide_chapter_numbers in_flux forum_url
                                pages short_description recommended_skus isbn amazon_url].freeze
 

app/lib/parser/vend.rb

@@ -8,7 +8,8 @@ class Vend
     def parse
       {
         contributors: contributors,
-        price_band: vend_file[:price_band]
+        price_band: vend_file[:price_band],
+        edition: vend_file[:edition]
       }
     end
 

app/lib/renderer/image_attachable.rb

@@ -15,8 +15,7 @@ def attach_images
       return if image_provider.blank?
 
       object.image_attachment_loop do |local_url|
-        representations = image_provider.representations_for_local_url(local_url)
-        representations.find { |r| r.width == :original }.remote_url
+        image_provider.representations_for_local_url(local_url)
       end
     end
   end

app/lib/renderer/image_attributes.rb

@@ -19,6 +19,8 @@ def src(relative_url)
 
     def representations(local_url)
       image_provider.representations_for_local_url(local_url)
+                    .filter { |r| ImageRepresentation::DEFAULT_WIDTHS.keys.include?(r.variant) }
+                    .uniq(&:variant)
     end
 
     def class_list(alt_text)

app/models/book.rb

@@ -8,15 +8,17 @@ class Book
   include Concerns::MarkdownRenderable
 
   attr_accessor :sku, :edition, :title, :description_md, :released_at, :sections, :git_commit_hash,
-                :materials_url, :cover_image, :gallery_image, :twitter_card_image,
-                :trailer_video_url, :version_description, :professional, :difficulty,
+                :materials_url, :cover_image, :gallery_image, :twitter_card_image, :artwork_image,
+                :icon_image, :trailer_video_url, :version_description, :professional, :difficulty,
                 :platform, :language, :editor, :domains, :categories, :who_is_this_for_md,
                 :covered_concepts_md, :root_path, :hide_chapter_numbers, :in_flux,
                 :forum_url, :pages, :short_description, :recommended_skus, :contributors,
                 :price_band, :isbn, :amazon_url
-  attr_image :cover_image_url, source: :cover_image
+  attr_image :cover_image_url, source: :cover_image, variants: %i[original w594 w300]
   attr_image :gallery_image_url, source: :gallery_image
-  attr_image :twitter_card_image_url, source: :twitter_card_image
+  attr_image :twitter_card_image_url, source: :twitter_card_image, variants: %i[original w1800]
+  attr_image :artwork_image_url, source: :artwork_image, variants: %i[original w180]
+  attr_image :icon_image_url, source: :icon_image, variants: %i[original w180]
   attr_markdown :who_is_this_for, source: :who_is_this_for_md, file: false
   attr_markdown :covered_concepts, source: :covered_concepts_md, file: false
   attr_markdown :description, source: :description_md, file: false
@@ -35,11 +37,12 @@ def initialize(attributes = {})
   # Used for serialisation
   def attributes
     { sku: nil, edition: nil, title: nil, description: nil, released_at: nil, sections: [],
-      git_commit_hash: nil, materials_url: nil, cover_image_url: nil, gallery_image_url: nil,
-      twitter_card_image_url: nil, trailer_video_url: nil, version_description: nil,
-      professional: nil, difficulty: nil, platform: nil, language: nil, editor: nil, domains: [],
-      categories: [], who_is_this_for: nil, covered_concepts: nil, hide_chapter_numbers: nil,
-      in_flux: nil, forum_url: nil, pages: nil, short_description: nil, recommended_skus: [],
-      contributors: [], price_band: nil, isbn: nil, amazon_url: nil }.stringify_keys
+      git_commit_hash: nil, materials_url: nil, cover_image_url: [], gallery_image_url: [],
+      twitter_card_image_url: [], artwork_image_url: [], icon_image_url: [],
+      trailer_video_url: nil, version_description: nil, professional: nil, difficulty: nil,
+      platform: nil, language: nil, editor: nil, domains: [], categories: [], who_is_this_for: nil,
+      covered_concepts: nil, hide_chapter_numbers: nil, in_flux: nil, forum_url: nil, pages: nil,
+      short_description: nil, recommended_skus: [], contributors: [], price_band: nil, isbn: nil,
+      amazon_url: nil }.stringify_keys
   end
 end

app/models/concerns/image_attachable.rb

@@ -11,8 +11,14 @@ module ImageAttachable
 
     class_methods do
       # Specify the name of the attribute that the CDN image URL should be stored in
-      def attr_image(attribute, source:)
-        _image_attachable_attributes.push({ destination: attribute, source: source })
+      def attr_image(attribute, source:, variants: nil)
+        _image_attachable_attributes.push(
+          {
+            destination: attribute,
+            source: source,
+            variants: variants.presence || %i[original]
+          }
+        )
         attr_accessor attribute
       end
     end
@@ -25,21 +31,24 @@ def image_attachment_paths
 
         {
           relative_path: path,
-          absolute_path: (Pathname.new(root_path) + path).to_s
+          absolute_path: (Pathname.new(root_path) + path).to_s,
+          variants: attr[:variants]
         }
       end.compact
     end
 
-    # Allows looping through the image attachment attributes, populating their remote URLs
+    # Allows looping through the image attachment attributes, populating the remote representations
     # Takes a block with one argument--the local URL of the file
     def image_attachment_loop(&block)
       _image_attachable_attributes.each do |attribute|
         path = send(attribute[:source])
         next if path.blank?
 
         local_url = (Pathname.new(root_path) + path).to_s
-        remote_url = block.call(local_url)
-        send("#{attribute[:destination]}=".to_sym, remote_url)
+        representations = block.call(local_url)
+                               .filter { |r| attribute[:variants].include?(r.variant) }
+                               .uniq(&:variant)
+        send("#{attribute[:destination]}=".to_sym, representations)
       end
     end
   end

app/models/image.rb

@@ -8,9 +8,10 @@ class Image
 
   attr_accessor :local_url, :representations
 
-  def self.with_representations(attributes = {})
+  def self.with_representations(attributes = {}, variants: nil)
+    variants ||= ImageRepresentation::DEFAULT_WIDTHS.keys
     new(attributes).tap do |image|
-      image.representations = ImageRepresentation::WIDTHS.keys.map do |width|
+      image.representations = variants.map do |width|
         ImageRepresentation.new(width: width, image: image)
       end
     end
@@ -48,9 +49,9 @@ def upload
         next
       end
 
-      logger.info "Generating #{representation.width}px for #{local_url}"
+      logger.info "Generating #{representation.width} variant for #{local_url}"
       representation.generate
-      logger.info "Uploading #{representation.width}px for #{local_url}"
+      logger.info "Uploading #{representation.width} variant for #{local_url}"
       representation.upload
     end
   end

app/models/image_representation.rb

@@ -3,16 +3,26 @@
 # Defines a specific size of an image
 class ImageRepresentation
   include ActiveModel::Model
+  include ActiveModel::Serializers::JSON
   include ImageProvider::Concerns::Resizable
   include ImageProvider::Concerns::Uploadable
 
-  WIDTHS = {
+  DEFAULT_WIDTHS = {
     small: 150,
     medium: 300,
     large: 700,
     original: nil
   }.freeze
 
+  OTHER_WIDTHS = {
+    w180: 180,
+    w300: 300,
+    w594: 594,
+    w1800: 1800
+  }.freeze
+
+  WIDTHS = DEFAULT_WIDTHS.merge(OTHER_WIDTHS).freeze
+
   attr_accessor :width, :image
 
   validates :width, inclusion: { in: WIDTHS.keys }, presence: true
@@ -36,4 +46,12 @@ def width_px
   def source_url
     image.local_url
   end
+
+  # Used for serialisation
+  alias url remote_url
+  alias variant width
+
+  def attributes
+    { url: nil, variant: nil }
+  end
 end