open_blog 0.1.0 → 0.2.0

data/app/assets/fonts/open_blog/OFL-outfit.txt

@@ -0,0 +1,93 @@
+Copyright 2021 The Outfit Project Authors (https://github.com/Outfitio/Outfit-Fonts)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+https://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

data/app/assets/fonts/open_blog/OFL-space-grotesk.txt

@@ -0,0 +1,93 @@
+Copyright 2020 The Space Grotesk Project Authors (https://github.com/floriankarsten/space-grotesk)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

data/app/controllers/open_blog/api/v1/pages_controller.rb

@@ -30,12 +30,12 @@ module OpenBlog
               [ current, created ]
             end
           rescue ActiveRecord::RecordNotUnique, ActiveRecord::RecordInvalid => error
-            collision = error.is_a?(ActiveRecord::RecordNotUnique) ||
-              (error.record.new_record? && error.record.errors.details[:kind].any? { |detail| detail[:error] == :taken })
-            raise unless collision
+            # A concurrent first write can commit between the two uniqueness checks, so only the slug reports taken.
+            collision = error.is_a?(ActiveRecord::RecordNotUnique) || (error.record.new_record? &&
+              %i[kind slug].any? { |field| error.record.errors.of_kind?(field, :taken) })
             attempts += 1
-            retry if attempts == 1
-            raise Error::ValidationFailed.new(details: [ "kind" ])
+            retry if collision && attempts == 1
+            raise
           end
           render json: PageSerializer.call(page, base_url: request.base_url), status: created ? :created : :ok
         end

data/app/helpers/open_blog/faq_helper.rb

@@ -11,7 +11,9 @@ module OpenBlog
         paragraphs = entry[:answer].to_s.gsub(/\r\n?/, "\n").split(/\n[\t ]*\n+/).map do |paragraph|
           tag.p(safe_join(paragraph.split("\n", -1).map { |line| open_blog_faq_links(line) }, safe_join([ tag.br, "\n" ])))
         end
-        tag.div(safe_join([ question, *paragraphs ], "\n"), class: "ob-faq-entry", data: { open_blog_faq_entry: true })
+        collapsed = OpenBlog.config.faq_collapsed
+        content_tag(collapsed ? :details : :div, safe_join([ collapsed ? tag.summary(question) : question, *paragraphs ], "\n"),
+          class: "ob-faq-entry", data: { open_blog_faq_entry: true })
       end
       tag.section(safe_join([ heading, *items ], "\n"), class: "ob-faq", data: { open_blog_faq: true })
     end

data/app/helpers/open_blog/theme_helper.rb

@@ -7,7 +7,8 @@ module OpenBlog
     end
 
     def open_blog_theme_attributes
-      open_blog_fixed_theme ? { data: { theme: open_blog_fixed_theme } } : {}
+      data = { theme: open_blog_fixed_theme, ob_theme: open_blog_preset&.name&.to_s }.compact
+      data.any? ? { data: data } : {}
     end
 
     def open_blog_theme_script
@@ -25,19 +26,42 @@ module OpenBlog
     end
 
     def open_blog_theme_colors
-      safe_join(SURFACES.map do |scheme, surface|
-        tag.meta(name: "theme-color", media: "(prefers-color-scheme: #{scheme})", content: SURFACES.fetch(open_blog_fixed_theme, surface))
+      preset = open_blog_preset
+      surfaces = SURFACES.to_h do |scheme, surface|
+        [ scheme, preset ? preset.public_send(scheme).merge(OpenBlog.config.theme_colors_for(scheme.to_sym)).fetch("surface") : surface ]
+      end
+      safe_join(surfaces.map do |scheme, surface|
+        tag.meta(name: "theme-color", media: "(prefers-color-scheme: #{scheme})", content: surfaces.fetch(open_blog_fixed_theme, surface))
       end, "\n")
     end
 
     def open_blog_stylesheets
-      stylesheets = [ stylesheet_link_tag("open_blog/blog") ]
+      stylesheets = [ open_blog_preset_stylesheet, stylesheet_link_tag("open_blog/blog") ]
       stylesheets << stylesheet_link_tag("open_blog_theme") if open_blog_theme_override?
-      safe_join(stylesheets, "\n")
+      safe_join([ *stylesheets, open_blog_theme_color_overrides ].compact, "\n")
+    end
+
+    def open_blog_theme_stylesheets
+      safe_join([ open_blog_preset_stylesheet, open_blog_theme_color_overrides ].compact, "\n")
     end
 
     private
 
+    def open_blog_preset
+      Themes.fetch(OpenBlog.config.theme) unless OpenBlog.config.theme == :none
+    end
+
+    def open_blog_preset_stylesheet
+      stylesheet_link_tag("open_blog/themes") if open_blog_preset
+    end
+
+    def open_blog_theme_color_overrides
+      return unless open_blog_preset
+      colors = Configuration::THEME_MODES.index_with { |mode| OpenBlog.config.theme_colors_for(mode) }
+      css = Themes.css(open_blog_preset.name, **colors)
+      tag.style(css.html_safe, nonce: content_security_policy_nonce, data: { open_blog_theme_colors: true }) if css.present?
+    end
+
     def open_blog_theme_override?
       assets = Rails.application.assets if Rails.application.respond_to?(:assets)
       if assets.respond_to?(:resolver)

data/lib/generators/open_blog/generator_support.rb

@@ -44,12 +44,12 @@ module OpenBlog
       def copy_reader_views(css: css_setup, javascript: javascript_setup)
         directory "views/open_blog", "app/views/open_blog", **copy_options
         content = File.read(find_in_source_paths("views/layouts/open_blog.html.erb"))
-        stylesheet = case css
-        when :rails then 'stylesheet_link_tag "tailwind", "data-turbo-track": "reload"'
-        when :bundler then 'stylesheet_link_tag "application", "data-turbo-track": "reload"'
-        else "open_blog_stylesheets"
+        asset = { rails: "tailwind", bundler: "application" }[css]
+        if asset
+          content = content.sub(/^(\s*)<%= open_blog_stylesheets %>/) do
+            "#{$1}<%= open_blog_theme_stylesheets %>\n#{$1}<%= stylesheet_link_tag #{asset.dump}, \"data-turbo-track\": \"reload\" %>"
+          end
         end
-        content = content.sub("open_blog_stylesheets", stylesheet)
         if javascript == :bundler
           content = content.sub("javascript_importmap_tags", 'javascript_include_tag "application", "data-turbo-track": "reload", defer: true')
         end

data/lib/generators/open_blog/install/install_generator.rb

@@ -18,8 +18,15 @@ module OpenBlog
       class_option :skip_sample, type: :boolean, default: false
       class_option :skip_migrate, type: :boolean, default: false
       class_option :admin_suite, type: :boolean, default: false
+      class_option :theme, type: :string, desc: "Theme preset: #{OpenBlog::Themes.names.join(', ')} (default: signal)"
+
+      INITIALIZER = "config/initializers/open_blog.rb".freeze
+      THEME_SETTING = /^([ \t]*)config\.theme[ \t]*=[ \t]*(?::(\w+))?[^\n]*$/
 
       def detect
+        unless options[:theme].nil? || OpenBlog::Themes.names.map(&:to_s).include?(options[:theme])
+          raise Thor::Error, "--theme must be #{OpenBlog::Themes.names.to_sentence(last_word_connector: ' or ', two_words_connector: ' or ')}"
+        end
         unless %w[markdown rich_text both].include?(options[:body_format])
           raise Thor::Error, "--body-format must be markdown, rich_text or both"
         end
@@ -44,7 +51,10 @@ module OpenBlog
       def configure_blog
         @site_name = identity(:site_name, "Site name", "Example")
         @author_name = identity(:author_name, "Author name", "Ada Example")
-        template "initializer.rb.tt", "config/initializers/open_blog.rb", **copy_options
+        @theme = options[:theme] || host_read(INITIALIZER)[THEME_SETTING, 2] || "signal"
+        template "initializer.rb.tt", INITIALIZER, **copy_options
+        choose_theme if options[:theme]
+        say "Theme: #{@theme}"
       end
 
       def install_dependencies
@@ -167,6 +177,17 @@ module OpenBlog
         success
       end
 
+      def choose_theme
+        setting = "config.theme = :#{@theme}"
+        if host_read(INITIALIZER).match?(THEME_SETTING)
+          gsub_file INITIALIZER, THEME_SETTING, "\\1#{setting}"
+        elsif host_read(INITIALIZER).match?(/^OpenBlog\.configure do \|config\|\n/)
+          inject_into_file INITIALIZER, "  #{setting}\n", after: /^OpenBlog\.configure do \|config\|\n/
+        elsif !options[:pretend]
+          raise Thor::Error, "Cannot locate the OpenBlog.configure block; set #{setting} in #{INITIALIZER}."
+        end
+      end
+
       def identity(key, prompt, placeholder)
         return options[key] if options[key].present?
         return ask("#{prompt}:", default: placeholder) if $stdin.tty?

data/lib/generators/open_blog/install/templates/initializer.rb.tt

@@ -6,6 +6,7 @@ OpenBlog.configure do |config|
   config.mount_path = <%= options[:mount_at].dump %>
   config.body_formats = [ <%= body_formats.map { |format| ":#{format}" }.join(", ") %> ]
   config.default_body_format = <%= ":#{body_formats.first}" %>
+  config.theme = :<%= @theme %>
   config.primary_list_type = :categories
   config.sign_in_destinations = []
   config.ai_label = :when_required