RubyGems - imageomatic - Versions diffs - 0.1.0 - Mend

imageomatic 0.1.0

Files changed (26) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/README.md +98 -0
data/Rakefile +8 -0
data/app/assets/config/imageomatic_manifest.js +1 -0
data/app/assets/stylesheets/imageomatic/application.css +15 -0
data/app/controllers/concerns/imageomatic/opengraph.rb +35 -0
data/app/controllers/imageomatic/application_controller.rb +4 -0
data/app/helpers/imageomatic/application_helper.rb +4 -0
data/app/helpers/imageomatic/opengraph_tag_helper.rb +7 -0
data/app/jobs/imageomatic/application_job.rb +4 -0
data/app/mailers/imageomatic/application_mailer.rb +6 -0
data/app/models/imageomatic/application_record.rb +5 -0
data/app/models/imageomatic/opengraph/metatag.rb +11 -0
data/app/models/imageomatic/opengraph/model.rb +19 -0
data/app/views/layouts/imageomatic/application.html.erb +15 -0
data/config/initializers/mime_types.rb +3 -0
data/config/routes.rb +2 -0
data/lib/generators/imageomatic/install/USAGE +11 -0
data/lib/generators/imageomatic/install/install_generator.rb +15 -0
data/lib/generators/imageomatic/install/templates/application.opengraph.erb +15 -0
data/lib/imageomatic/engine.rb +5 -0
data/lib/imageomatic/version.rb +3 -0
data/lib/imageomatic.rb +6 -0
data/lib/tasks/imageomatic_tasks.rake +4 -0
metadata +85 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5f21da146260850a58131cbc1beff664ba283c6677e954c66da84e89d2674a8f
+  data.tar.gz: 50c93f247027c69cc997d04cf06c8b6f96df98f0abd14f86aa40e577e66c80b5
+SHA512:
+  metadata.gz: 00060a525441bf8c6621073e1dc101d90dee901aa53951c992630ad3756d65afc84564285294f4734f9afa6b96182f1cd8226eb4fc24cc856dc43afa2f47b74e
+  data.tar.gz: 1a1047e9e4bc9e443f3ee55507f2639530c414fb08d04f15829a0783bcebf74c1e4d79a3af0a75efa23b3aa3ca53d5a19e52a1f8f98ec68238be07ea35d47f1c

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright 2022 Brad Gessler
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md ADDED Viewed

@@ -0,0 +1,98 @@
+# Imageomatic
+[![Ruby](https://github.com/imageomatic/ruby/actions/workflows/ruby.yml/badge.svg)](https://github.com/imageomatic/ruby/actions/workflows/ruby.yml)
+The easiest way to make Rails applications look great in Apple Messages, Facebook, LinkedIn, Twitter, and any other website that use Open Graph.
+## Installation
+From the root of your Rails application, run:
+```bash
+$ bundle add "imageomatic"
+```
+Then run:
+```bash
+$ rails generate install:imageomatic
+```
+This creates a `app/views/layout/application.opengraph.erb` file and adds `include Imageomatic::Opengraph` to `ApplicationController`.
+Add to your `app/views/layouts/application.html.erb` file:
+```
+<head>
+  <%= opengraph_meta_tags %>
+</head>
+```
+That's it for the bare minimum! A screenshot of the top part of the webpage will appear by default for all open graph images. Custom badges are where its at though, so read on my friend.
+## Setting OpenGraph data
+Open graph data can be set from the view or controller via the `opengraph` method.
+### Controller
+Here's a few ways to set opengraph data from a controller.
+```ruby
+class PostsController < ApplicationController
+  before_action: :assign_opengraph_data
+  def edit
+    # This overrides the title that's set from `assign_opengraph_data`
+    opengraph.title = "Editing #{@post.title}"
+  end
+  protected
+  def assign_opengraph_data
+    opengraph.title = @post.title
+    opengraph.description = @post.summary
+    # Displays the first image of a blog post, instead of a screenshot, for the opengraph image.
+    # Assumes the image was managed via ActiveStorage.
+    opengraph.image = url_for(@post.images.first)
+  end
+end
+```
+### View
+Opengraph data may also be set from the view:
+```erb
+<%
+  opengraph.title = @post.title
+  opengraph.description = @post.summary
+%>
+<h1><%= @post.title %></h1>
+<article><%= @post.body %></article>
+```
+## Custom badges with Rails Views
+The real power in Imageomatic Open Graph is creating custom badges via the `opengraph` format in your rails views. For the example below, we'll create an Open Graph badge for a blog post. Assuming a blog application has a `/posts/:id` with a view at `app/views/posts/show.html.erb`, we'd create a new view with the `opengraph` format:
+```bash
+$ touch ./app/views/posts/show.opengraph.erb
+```
+Open the file and add something like:
+```erb
+<h1><%= @post.title %></h1>
+<article><%= truncate @post.body, length: 100 %></article>
+<p>This article will take <%= time_to_read @post.body %> minutes to read</p>
+```
+The Imageomatic screenshot service will take a screenshot of the content at this URL and use it for the Open Graph image.
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile ADDED Viewed

@@ -0,0 +1,8 @@
+require "bundler/setup"
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+require "bundler/gem_tasks"

data/app/assets/config/imageomatic_manifest.js ADDED Viewed

	@@ -0,0 +1 @@
1	+ //= link_directory ../stylesheets/imageomatic .css

data/app/assets/stylesheets/imageomatic/application.css ADDED Viewed

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/concerns/imageomatic/opengraph.rb ADDED Viewed

@@ -0,0 +1,35 @@
+module Imageomatic
+  module Opengraph
+    extend ActiveSupport::Concern
+    included do
+      before_action :assign_opengraph_fallback_formats, if: :opengraph_request?
+      before_action :assign_opengraph_defaults
+      helper Imageomatic::OpengraphTagHelper
+      helper_method :opengraph
+    end
+    protected
+      def assign_opengraph_fallback_formats
+        request.formats = [ :opengraph, :html ]
+      end
+      def opengraph_request?
+        request.format.opengraph?
+      end
+      def url_for_opengraph_image
+        url_for(format: :opengraph)
+      end
+      def opengraph
+        @opengraph ||= Model.new
+      end
+      def assign_opengraph_defaults
+        opengraph.image ||= url_for_opengraph_image
+      end
+  end
+end

data/app/controllers/imageomatic/application_controller.rb ADDED Viewed

@@ -0,0 +1,4 @@
+module Imageomatic
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/imageomatic/application_helper.rb ADDED Viewed

@@ -0,0 +1,4 @@
+module Imageomatic
+  module ApplicationHelper
+  end
+end

data/app/helpers/imageomatic/opengraph_tag_helper.rb ADDED Viewed

@@ -0,0 +1,7 @@
+module Imageomatic
+  module OpengraphTagHelper
+    def opengraph_meta_tags(model=opengraph)
+      model.to_html
+    end
+  end
+end

data/app/jobs/imageomatic/application_job.rb ADDED Viewed

@@ -0,0 +1,4 @@
+module Imageomatic
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/imageomatic/application_mailer.rb ADDED Viewed

@@ -0,0 +1,6 @@
+module Imageomatic
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/imageomatic/application_record.rb ADDED Viewed

@@ -0,0 +1,5 @@
+module Imageomatic
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/imageomatic/opengraph/metatag.rb ADDED Viewed

@@ -0,0 +1,11 @@
+module Imageomatic
+  module Opengraph
+    class Metatag < Struct.new(:property, :content)
+      include ActionView::Helpers::TagHelper
+      def to_html
+        tag :meta, property: "og:#{property}", content: content
+      end
+    end
+  end
+end

data/app/models/imageomatic/opengraph/model.rb ADDED Viewed

@@ -0,0 +1,19 @@
+module Imageomatic
+  module Opengraph
+    class Model < Struct.new(:title, :image, :description)
+      include ActionView::Helpers::OutputSafetyHelper
+      def metatags
+        Enumerator.new do |y|
+          each_pair do |property, content|
+            y << Metatag.new(property, content) if content.present?
+          end
+        end
+      end
+      def to_html
+        safe_join metatags.map(&:to_html), "\n"
+      end
+    end
+  end
+end

data/app/views/layouts/imageomatic/application.html.erb ADDED Viewed

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Imageomatic</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+  <%= stylesheet_link_tag    "imageomatic/application", media: "all" %>
+</head>
+<body>
+<%= yield %>
+</body>
+</html>

data/config/initializers/mime_types.rb ADDED Viewed

@@ -0,0 +1,3 @@
+# Used to represent the HTML pages that will be converted into an
+# image and served up for open graph image previews.
+Mime::Type.register "text/html", :opengraph

data/config/routes.rb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ Imageomatic::Engine.routes.draw do
2	+ end

data/lib/generators/imageomatic/install/USAGE ADDED Viewed

@@ -0,0 +1,11 @@
+Description:
+    Installs Imageomatic in Rails
+Example:
+    bin/rails generate install:imageomatic
+    Creates the files:
+        app/views/layouts/application.opengraph.html
+    Patches ApplicationController by adding:
+        include Imageomatic::Opengraph

data/lib/generators/imageomatic/install/install_generator.rb ADDED Viewed

@@ -0,0 +1,15 @@
+class Imageomatic::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path("templates", __dir__)
+  def include_controller_helper
+    inject_into_file 'app/controllers/application_controller.rb', after: "class ApplicationController < ActionController::Base\n" do <<-'RUBY'
+  include Imageomatic::Opengraph
+    RUBY
+    end
+  end
+  def copy_layout
+    copy_file "application.opengraph.erb", "app/views/layouts/application.opengraph.erb"
+  end
+end

data/lib/generators/imageomatic/install/templates/application.opengraph.erb ADDED Viewed

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= opengraph.title %></title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+    <%= stylesheet_link_tag "application", "data-turbo-track": "reload" %>
+    <%= javascript_importmap_tags %>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/lib/imageomatic/engine.rb ADDED Viewed

@@ -0,0 +1,5 @@
+module Imageomatic
+  class Engine < ::Rails::Engine
+    isolate_namespace Imageomatic
+  end
+end

data/lib/imageomatic/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module Imageomatic
+  VERSION = "0.1.0"
+end

data/lib/imageomatic.rb ADDED Viewed

@@ -0,0 +1,6 @@
+require "imageomatic/version"
+require "imageomatic/engine"
+module Imageomatic
+  # Your code goes here...
+end

data/lib/tasks/imageomatic_tasks.rake ADDED Viewed

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :imageomatic do
+#   # Task goes here
+# end

metadata ADDED Viewed

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: imageomatic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brad Gessler
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+description: Easiest way to generate fresh images for Rails applications.
+email:
+- brad@imageomatic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/imageomatic_manifest.js
+- app/assets/stylesheets/imageomatic/application.css
+- app/controllers/concerns/imageomatic/opengraph.rb
+- app/controllers/imageomatic/application_controller.rb
+- app/helpers/imageomatic/application_helper.rb
+- app/helpers/imageomatic/opengraph_tag_helper.rb
+- app/jobs/imageomatic/application_job.rb
+- app/mailers/imageomatic/application_mailer.rb
+- app/models/imageomatic/application_record.rb
+- app/models/imageomatic/opengraph/metatag.rb
+- app/models/imageomatic/opengraph/model.rb
+- app/views/layouts/imageomatic/application.html.erb
+- config/initializers/mime_types.rb
+- config/routes.rb
+- lib/generators/imageomatic/install/USAGE
+- lib/generators/imageomatic/install/install_generator.rb
+- lib/generators/imageomatic/install/templates/application.opengraph.erb
+- lib/imageomatic.rb
+- lib/imageomatic/engine.rb
+- lib/imageomatic/version.rb
+- lib/tasks/imageomatic_tasks.rake
+homepage: https://www.imageomatic.com/
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://www.imageomatic.com/
+  source_code_uri: https://github.com/imageomatic/ruby
+  changelog_uri: https://github.com/imageomatic/ruby/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.15
+signing_key:
+specification_version: 4
+summary: Easiest way to generate fresh images for Rails applications.
+test_files: []