omg_image 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33d5b3da89f0ea6047d3d6a01e546723309e075c1f0b6f5ba30fa1297da946b8
-  data.tar.gz: dbae8d61c3ca72f5e2f98519da9be5ff0a87880e65ed4fca7225637e83cf2f65
+  metadata.gz: b2468443fcac5db5037221c0d614ed9d16fa51ac58e281c5c3ec1aebfd2e3277
+  data.tar.gz: 067c8727a59676100fe820f44eddf256f1bf8882726f100764d43d43ca06e911
 SHA512:
-  metadata.gz: 1a6f2f5a5468e6a556927ab63da98a7f632aac0bcf8ea08bf73313fabe42c38bbd742ba772dee01c937cc21ddd49c0e742af023f5f2e74a7affd694b2d773765
-  data.tar.gz: 3cb611219fd0541cd6879ad27c17409fbaf163e2655b4c124b5b55babb755c03c27544655b790a6371435b72de3bc938f9285310e3aac55ddcc000a2a9d1f651
+  metadata.gz: 7fa3d8b5b59401f968f2d25017ecb67074750347d8519d84dc17b2070085ac8dd9423627b94e255986ae787376b6354a15c4becda1e4d1db699d966012fde3ef
+  data.tar.gz: c9da19ea224ddda303bfd09f1e04e4f16893f8aac6b8ea935004802c4c8736129ddfd050399379ef72b489d99fea37899611cf3548a6c6c78c769222c735b57d

data/README.md

@@ -1,10 +1,15 @@
-# OmgImage
-Short description and motivation.
+# omg_image
+
+Generate preview images on the fly for your HTML snippets.
 
 ## Usage
-How to use my plugin.
+
+## Requirements
+
+- Google chrome (headless)
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -21,19 +26,31 @@ Or install it yourself as:
 $ gem install omg_image
 ```
 
+## Google Chrome Installation
+
+- sudo apt install gdebi-core
+- wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
+- sudo gdebi google-chrome-stable_current_amd64.deb
+- verify chrome is installed `google-chrome --version`
+
 ## Development
 
-- install chrome headless 
+- install chrome headless
 - add to `/etc/hosts` new host `127.0.0.0     site.com`
 - in `puma.rb` put `workers ENV.fetch("WEB_CONCURRENCY") { 3 }` (required because screenshot is made from another request)
-- 
+-
+
+## More about Chrome
+
+- https://linuxize.com/post/how-to-install-google-chrome-web-browser-on-ubuntu-18-04/
 
 ## Issues
 
 - if you process too many requests and because of timeouts dead processes may appear. To kill them `parents_of_dead_kids=$(ps -ef | grep [d]efunct | awk '{print $3}' | sort | uniq | egrep -v '^1$'); echo "$parents_of_dead_kids" | xargs kill`
 
 ## Contributing
-Contribution directions go here.
+
+You are welcome to contribute.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/helpers/omg_image/application_helper.rb

@@ -6,73 +6,5 @@ require 'open4'
 module OmgImage
   module ApplicationHelper
     include OmgHelper
-
-    def omg_image_preview(template, options)
-      options        ||= {}
-      options[:size] ||= '800,400'
-      options[:key]  ||= options.to_s
-
-      image = OmgImage::Image.find_by(key: options[:key])
-      if image && !image.file.attached?
-        image.destroy
-        image = nil
-      end
-
-      file = image&.file || create_screenshot(template, options)
-
-      url_for(file) if file
-    end
-
-    private
-
-    def create_screenshot(template, options)
-      begin
-        start = Time.now
-        body  = OmgImage::Renderer.render(template, locals: options)
-        log_smt "  to_html: #{(Time.now - start).round(2)}"
-
-        input = BetterTempfile.new("input.html")
-        input.write(body)
-        input.flush
-
-        output = BetterTempfile.new("image.png")
-
-        cli_options = { file: output, size: options[:size], path: input.path }
-        command = build_chrome_command(cli_options)
-        log_smt "  => #{command}"
-
-        start = Time.now
-        begin
-          process = open4.spawn(command, timeout: 10)
-        rescue Timeout::Error
-          Process.kill('KILL', process.pid) rescue nil
-          log_smt "omg error: please retry. options: #{options}"
-          return nil
-        end
-        log_smt "  to_image: #{(Time.now - start).round(2)}"
-
-        image   = OmgImage::Image.find_by(key: options[:key])
-        image ||= OmgImage::Image.new(key: options[:key])
-        if !image.file.attached?
-          image.file.attach(io: File.open(output.path), filename: "image.png", content_type: "image/png")
-          image.save!
-        end
-
-        image.file
-      ensure
-        output&.close!
-        input&.close!
-      end
-    end
-
-    def build_chrome_command(options)
-      size_opts = options[:size] == :auto ? nil : "--window-size=#{options[:size]}"
-      "google-chrome --headless --disable-gpu --no-sandbox --ignore-certificate-errors --screenshot=#{options[:file].path} #{size_opts} \"file://#{options[:path]}\""
-    end
-
-    def log_smt(str)
-      Rails.logger.debug(str)
-    end
-
   end
 end

data/lib/omg_image.rb

@@ -1,7 +1,10 @@
 require "better_tempfile"
 
+require "omg_image/os"
 require "omg_image/engine"
 require "omg_image/renderer"
+require "omg_image/shell"
+require "omg_image/processor"
 
 module OmgImage
 end

data/lib/omg_image/os.rb

@@ -0,0 +1,17 @@
+module OS
+  def OS.windows?
+    (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM) != nil
+  end
+
+  def OS.mac?
+   (/darwin/ =~ RUBY_PLATFORM) != nil
+  end
+
+  def OS.unix?
+    !OS.windows?
+  end
+
+  def OS.linux?
+    OS.unix? and not OS.mac?
+  end
+end

data/lib/omg_image/processor.rb

@@ -0,0 +1,99 @@
+module OmgImage
+  class Processor
+    attr_reader :template, :options
+
+    def initialize(template, options)
+      template.downcase!
+      options        ||= {}
+      options[:size] ||= '800,400'
+      options[:key]  ||= options.to_s
+      template         = "#{template}.html.erb" unless template.ends_with?(".html.erb")
+      @template        = template
+      @options         = options
+    end
+
+    def cached_or_new(regenerate: false)
+      reset_cache if regenerate
+      cached&.file || generate&.file
+    end
+
+    def generate(cache: true)
+      output = create_screenshot
+      if cache
+        image = save_to_cache(output)
+        output&.close
+        image
+      else
+        output
+      end
+    end
+
+    def with_screenshot(&block)
+      create_screenshot(&block)
+    end
+
+    private
+
+    def create_screenshot
+      begin
+        start = Time.now
+        body  = OmgImage::Renderer.render(template, locals: options)
+        log_smt "  to_html: #{(Time.now - start).round(2)}"
+
+        input = BetterTempfile.new("input.html")
+        input.write(body)
+        input.flush
+
+        output = BetterTempfile.new("image.png")
+
+        command = Shell.command({ file: output, size: options[:size], path: input.path })
+        log_smt "  => #{command}"
+
+        start = Time.now
+        begin
+          process = open4.spawn(command, timeout: 10)
+        rescue Timeout::Error
+          Process.kill('KILL', process.pid) rescue nil
+          log_smt "omg error: please retry. options: #{options}"
+          return nil
+        end
+        log_smt "  to_image: #{(Time.now - start).round(2)}"
+
+        yield(output) if block_given?
+
+        output
+      ensure
+        #output&.close!
+        input&.close!
+      end
+    end
+
+    def log_smt(str)
+      Rails.logger.debug(str)
+    end
+
+    def reset_cache
+       OmgImage::Image.where(key: options[:key]).destroy_all
+    end
+
+    def cached
+      image = OmgImage::Image.find_by(key: options[:key])
+      if image && !image.file.attached?
+        image.destroy
+        image = nil
+      end
+      image
+    end
+
+    def save_to_cache(output)
+      image   = OmgImage::Image.find_by(key: options[:key])
+      image ||= OmgImage::Image.new(key: options[:key])
+      if !image.file.attached?
+        image.file.attach(io: File.open(output.path), filename: "image.png", content_type: "image/png")
+        image.save!
+      end
+      image
+    end
+
+  end
+end

data/lib/omg_image/renderer.rb

@@ -2,8 +2,8 @@ module OmgImage
   class Renderer
     def Renderer.render(template, layout: nil, locals: {})
       ::ApplicationController.render(
-        file: "/#{Rails.root}/app/omg/#{template}", 
-        layout: layout, 
+        file: "/#{Rails.root}/app/omg/#{template}",
+        layout: layout,
         locals: locals
       )
     end

data/lib/omg_image/shell.rb

@@ -0,0 +1,20 @@
+module OmgImage
+  class Shell
+    def Shell.command(options)
+      size_opts = options[:size] == :auto ? nil : "--window-size=#{options[:size]}"
+      "#{chrome} --headless --disable-gpu --no-sandbox --ignore-certificate-errors --screenshot=#{options[:file].path} #{size_opts} \"file://#{options[:path]}\""
+    end
+
+    private
+
+    def self.chrome
+      if OS.windows?
+        "chrome"
+      elsif OS.mac?
+        "\"/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome\""
+      else
+        "google-chrome"
+      end
+    end
+  end
+end

data/lib/omg_image/version.rb

@@ -1,3 +1,3 @@
 module OmgImage
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omg_image
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Igor Kasyanchuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-05 00:00:00.000000000 Z
+date: 2018-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -123,7 +123,10 @@ files:
 - lib/generators/templates/db/migrate/20180928082949_create_omg_image_images.rb
 - lib/omg_image.rb
 - lib/omg_image/engine.rb
+- lib/omg_image/os.rb
+- lib/omg_image/processor.rb
 - lib/omg_image/renderer.rb
+- lib/omg_image/shell.rb
 - lib/omg_image/version.rb
 homepage: https://github.com/igorkasyanchuk/omg_image
 licenses: