social_construct 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a6da2405e4a0117c652f0273ba675242053926527418d9fdcb3acf01df55342
-  data.tar.gz: bb626f6d95fac62a0b0696b8c6ceb083f3109d03b74ad670f5496640f44eacb8
+  metadata.gz: 9b1b86abf2f0675a09e15f221cbd4cbda23fbd5f5b37d0406130c30808e3f127
+  data.tar.gz: 5069906dc7297bddd8600b3bef4b321881c09e475138f63980cea760e0e4ff71
 SHA512:
-  metadata.gz: 29c1411422336bffdfb0fda48294395b8043dddab4ba44dd20b7bc8f3a367311a33dc1a484e79fb30403a5cfdf7c5b17d90512ac594151b7324d189a5be1a013
-  data.tar.gz: ca8995422185f360f50feeb4f0d0860f592e7d821b389305e8199936f388ff7b0d53672fcccc50772f34ba686b49eaa9efade2e864ab3057c2af6836eb8a24e3
+  metadata.gz: a921f74dd5276deef7b2fc446ccfda8adf15d092ff9e2f43fb48c454f7487a4079286b9bf4a3a3346625aaa95716d956229a73f6dce8a4261fa1a0ffbbc7785b
+  data.tar.gz: 84b6f50e3d7a6fa73432304be9ded5dfb08f47c72f0c30d72b56e779c9ec0f1c73de02db0799f9582f6e94ecdfc6f28409e48247f3f4e6afd32cf171a7e4a667

data/README.md

@@ -19,7 +19,7 @@ class PostSocialCard < ApplicationSocialCard
     {
       title: @post.title,
       author: @post.author_name,
-      avatar: image_to_data_url(@post.author.avatar)
+      avatar: attachment_data_url(@post.author.avatar)
     }
   end
 end
@@ -70,8 +70,8 @@ Convert ActiveStorage attachments to Base64 `data://` URLs:
 ```ruby
 def template_assigns
   {
-    cover_image: image_to_data_url(@post.cover_image),
-    avatar: image_to_data_url(@post.author.avatar, resize_to_limit: [200, 200])
+    cover_image: attachment_data_url(@post.cover_image),
+    avatar: attachment_data_url(@post.author.avatar, resize_to_limit: [200, 200])
   }
 end
 ```
@@ -134,7 +134,7 @@ end
 Create preview classes:
 
 ```ruby
-# app/social_cards/previews/post_social_card_preview.rb
+# test/social_cards/previews/post_social_card_preview.rb
 class PostSocialCardPreview
   def default
     PostSocialCard.new(Post.first)
@@ -152,4 +152,3 @@ Visit `http://localhost:3000/rails/social_cards` to preview all cards.
 ## License
 
 MIT
-

data/app/controllers/concerns/social_construct/controller.rb

@@ -3,7 +3,6 @@ module SocialConstruct
     extend ActiveSupport::Concern
 
     included do
-      # Register social card mime type if not already registered
       Mime::Type.register "image/png", :png unless Mime[:png]
     end
 
@@ -35,16 +34,14 @@ module SocialConstruct
 
     # Allow using render with social cards
     def render(*args)
-      if args.first.is_a?(SocialConstruct::BaseCard)
-        card = args.first
-        options = args.second || {}
+      return super unless args.first.is_a?(SocialConstruct::BaseCard)
 
-        respond_to do |format|
-          format.png { send_social_card(card, **options) }
-          format.html { render(html: card.render.html_safe, layout: false) }
-        end
-      else
-        super
+      card = args.first
+      options = args.second || {}
+
+      respond_to do |format|
+        format.png { send_social_card(card, **options) }
+        format.html { render(html: card.render.html_safe, layout: false) }
       end
     end
 

data/app/controllers/social_construct/previews_controller.rb

@@ -1,5 +1,9 @@
 module SocialConstruct
   class PreviewsController < ActionController::Base
+    include SocialConstruct::Controller
+
+    before_action :ensure_previews_enabled
+
     def index
       @preview_classes = find_preview_classes
     end
@@ -27,26 +31,29 @@ module SocialConstruct
 
       @card = preview_class.new.send(example_name)
 
-      respond_to do |format|
-        format.html { render(html: @card.render.html_safe, layout: false) }
-        format.png { send_data(@card.to_png, type: "image/png", disposition: "inline") }
-      end
+      render(@card)
     end
 
     private
 
     def find_preview_classes
-      # Look for preview classes in the host app
-      preview_path = Rails.root.join("app/social_cards/previews")
-      return [] unless preview_path.exist?
-
-      Dir[preview_path.join("*_preview.rb")]
-        .map do |file|
-          require_dependency(file)
-          class_name = File.basename(file, ".rb").camelize
-          class_name.constantize if Object.const_defined?(class_name)
+      return [] unless (paths = Rails.application.config.social_construct.preview_paths)
+
+      paths
+        .map do |path|
+          next [] unless path.exist?
+
+          glob = path.join("*_preview.rb")
+
+          Dir[glob]
+            .map do |file|
+              require_dependency(file)
+              class_name = File.basename(file, ".rb").camelize
+              class_name.constantize if Object.const_defined?(class_name)
+            end
+            .compact
         end
-        .compact
+        .flatten
     end
 
     def find_preview_class(name)
@@ -57,5 +64,11 @@ module SocialConstruct
     rescue NameError
       nil
     end
+
+    def ensure_previews_enabled
+      unless Rails.application.config.social_construct.show_previews
+        raise ActionController::RoutingError, "Social card previews are disabled"
+      end
+    end
   end
 end

data/app/models/social_construct/base_card.rb

@@ -196,7 +196,7 @@ module SocialConstruct
       {}
     end
 
-    def image_to_data_url(attachment, variant_options = {})
+    def attachment_data_url(attachment, variant_options = {})
       return nil unless attachment.attached?
 
       begin

data/config/routes.rb

@@ -4,4 +4,6 @@ SocialConstruct::Engine.routes.draw do
       get(":example_name", action: :preview, as: :example)
     end
   end
+
+  root(to: redirect("previews"))
 end

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

@@ -28,7 +28,7 @@ module SocialConstruct
       end
 
       def create_example_preview
-        template("example_social_card_preview.rb", "app/social_cards/previews/example_social_card_preview.rb")
+        template("example_social_card_preview.rb", "test/social_cards/previews/example_social_card_preview.rb")
       end
 
       def add_route
@@ -42,10 +42,6 @@ module SocialConstruct
 
         route(route_string)
       end
-
-      def display_post_install
-        readme("POST_INSTALL") if behavior == :invoke
-      end
     end
   end
 end

data/lib/generators/social_construct/install/templates/example_social_card.html.erb

@@ -1,7 +1,7 @@
-<% content_for :head do %>
+<%% content_for :head do %>
   <style>
     body {
-      background-color: <%= background_color %>;
+      background-color: <%%= background_color %>;
       display: flex;
       align-items: center;
       justify-content: center;
@@ -9,11 +9,11 @@
       text-align: center;
       padding: 60px;
     }
-    
+
     .content {
       max-width: 900px;
     }
-    
+
     .title {
       font-size: 72px;
       font-weight: 800;
@@ -21,26 +21,26 @@
       margin-bottom: 24px;
       letter-spacing: -2px;
     }
-    
+
     .subtitle {
       font-size: 32px;
       font-weight: 400;
       opacity: 0.8;
       line-height: 1.3;
     }
-    
+
     .logo {
       position: absolute;
       bottom: 60px;
       right: 60px;
     }
-    
+
     .logo img {
       height: 40px;
       width: auto;
       opacity: 0.9;
     }
-    
+
     .decoration {
       position: absolute;
       top: 0;
@@ -51,19 +51,13 @@
       pointer-events: none;
     }
   </style>
-<% end %>
+<%% end %>
 
 <div class="decoration"></div>
 
 <div class="content">
-  <h1 class="title"><%= title %></h1>
-  <% if subtitle.present? %>
-    <p class="subtitle"><%= subtitle %></p>
-  <% end %>
+  <h1 class="title"><%%= title %></h1>
+  <%% if subtitle.present? %>
+    <p class="subtitle"><%%= subtitle %></p>
+  <%% end %>
 </div>
-
-<% if logo_data_url %>
-  <div class="logo">
-    <img src="<%= logo_data_url %>" alt="Logo">
-  </div>
-<% end %>

data/lib/generators/social_construct/install/templates/example_social_card.rb

@@ -1,6 +1,5 @@
 class ExampleSocialCard < ApplicationSocialCard
   def initialize(title: "Hello World", subtitle: nil, background_color: "#1a1a1a")
-    super()
     @title = title
     @subtitle = subtitle
     @background_color = background_color
@@ -12,8 +11,7 @@ class ExampleSocialCard < ApplicationSocialCard
     {
       title: @title,
       subtitle: @subtitle,
-      background_color: @background_color,
-      logo_data_url: logo_data_url
+      background_color: @background_color
     }
   end
 end

data/lib/generators/social_construct/install/templates/example_social_card_preview.rb

@@ -5,33 +5,4 @@ class ExampleSocialCardPreview
       subtitle: "Beautiful social cards for your Rails app"
     )
   end
-
-  def dark_theme
-    ExampleSocialCard.new(
-      title: "Dark Theme Example",
-      subtitle: "Perfect for modern applications",
-      background_color: "#0a0a0a"
-    )
-  end
-
-  def colorful
-    ExampleSocialCard.new(
-      title: "Colorful Background",
-      subtitle: "Make your cards stand out",
-      background_color: "#6366f1"
-    )
-  end
-
-  def long_title
-    ExampleSocialCard.new(
-      title: "This is a very long title that demonstrates how text wrapping works in social cards",
-      subtitle: "Subtitle remains readable"
-    )
-  end
-
-  def no_subtitle
-    ExampleSocialCard.new(
-      title: "Simple and Clean"
-    )
-  end
 end

data/lib/generators/social_construct/install/templates/social_cards_layout.html.erb

@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html lang="<%= I18n.locale %>">
+<html lang="<%%= I18n.locale %>">
   <head>
     <meta charset="utf-8">
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
@@ -10,13 +10,13 @@
         padding: 0;
         box-sizing: border-box;
       }
-      
+
       html {
         width: 1200px;
         height: 630px;
         background: white;
       }
-      
+
       body {
         width: 1200px;
         height: 630px;
@@ -28,23 +28,23 @@
         -webkit-font-smoothing: antialiased;
         -moz-osx-font-smoothing: grayscale;
       }
-      
+
       /* Ensure images don't have borders */
       img {
         border: 0;
         max-width: 100%;
       }
-      
+
       /* Default text rendering */
       h1, h2, h3, h4, h5, h6, p {
         font-weight: normal;
         margin: 0;
       }
     </style>
-    <%= yield :head %>
+    <%%= yield :head %>
   </head>
   <body>
-    <%= yield %>
+    <%%= yield %>
   </body>
 </html>
 

data/lib/generators/social_construct/install/templates/social_construct.rb

@@ -1,9 +1,16 @@
-# SocialConstruct configuration
 Rails.application.configure do
   # Configure the template path for social card views
   # Default: "social_cards"
   # config.social_construct.template_path = "social_cards"
 
+  # Configure paths for social card previews
+  # Default: ["test/social_cards/previews"]
+  # config.social_construct.preview_paths = ["test/social_cards/previews"]
+
+  # Enable social card previews
+  # Default: true in development, false otherwise
+  # config.social_construct.show_previews = Rails.env.development?
+
   # Enable debug logging for social card generation
   # Default: false
   # SocialConstruct::BaseCard.debug = true

data/lib/social_construct/engine.rb

@@ -4,12 +4,14 @@ module SocialConstruct
 
     config.social_construct = ActiveSupport::OrderedOptions.new
     config.social_construct.template_path = "social_cards"
+    config.social_construct.preview_paths = []
+    config.social_construct.show_previews = Rails.env.development?
 
-    # Ensure dependencies are loaded
-    config.before_initialize do
-      require "ferrum"
-      require "marcel"
-
+    # Set default preview path after application initializes
+    config.after_initialize do |app|
+      if app.config.social_construct.preview_paths.empty?
+        app.config.social_construct.preview_paths = [Rails.root.join("test/social_cards/previews")]
+      end
     end
   end
 end

data/lib/social_construct/version.rb

@@ -1,3 +1,3 @@
 module SocialConstruct
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/social_construct.rb

@@ -6,7 +6,4 @@ require "ferrum"
 require "marcel"
 
 module SocialConstruct
-  # Configuration for template paths and other settings
-  mattr_accessor :template_path
-  @@template_path = "social_cards"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: social_construct
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mikkel Malmberg
@@ -68,7 +68,6 @@ files:
 - app/views/social_construct/previews/show.html.erb
 - config/routes.rb
 - lib/generators/social_construct/install/install_generator.rb
-- lib/generators/social_construct/install/templates/POST_INSTALL
 - lib/generators/social_construct/install/templates/application_social_card.rb
 - lib/generators/social_construct/install/templates/example_social_card.html.erb
 - lib/generators/social_construct/install/templates/example_social_card.rb

data/lib/generators/social_construct/install/templates/POST_INSTALL

@@ -1,34 +0,0 @@
-===============================================================================
-
-  SocialConstruct has been successfully installed! 🎉
-
-  Next steps:
-  
-  1. Update the logo path in app/social_cards/application_social_card.rb
-     to point to your actual logo file.
-  
-  2. Run your Rails server and visit:
-     http://localhost:3000/rails/social_cards
-     
-     You should see the example social card previews.
-  
-  3. Create your own social card classes:
-     - Inherit from ApplicationSocialCard
-     - Create matching templates in app/views/social_cards/
-     - Add preview classes in app/social_cards/previews/
-  
-  4. Use in your controllers:
-     
-     class YourController < ApplicationController
-       include SocialConstruct::Controller
-       
-       def og
-         @model = Model.find(params[:id])
-         render YourSocialCard.new(@model)
-       end
-     end
-  
-  For more information, see:
-  https://github.com/brnbw/social_construct
-
-===============================================================================