camaleon_image_optimizer 0.3.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e60040d7a6d80e6c40da8401f4df1d5c28f6b7c1509bbec1fcd4c037353e909
-  data.tar.gz: 91d60e7de6e09305f4dfb05a8a4b51014d284cbbb2ab0214819211c964338926
+  metadata.gz: ea86f69f0f3ed35a2200b76b67fc4138f8e5970d932ea52cc870a9c45d71a8b0
+  data.tar.gz: 33af3d85ac320d0c92208f64e069cf7b28a47e872de05847e21ce7d4ed0b4628
 SHA512:
-  metadata.gz: e9d717a08310badad8ef8956a3af0722f14feb3cc7e9f19d134202341caf148e97cca4656ad240db59cc526c5d3a68a324f030a6b2224f73d3c4d3a916e7a0e5
-  data.tar.gz: d74f2e68ed11bef999b721438aaa5fab5416e10cc2292be7719229a5e3fbf452f92880a405d0bcb93dc21a07d4d71761c16e5b88f5deb972b123d4c5bf1c33d3
+  metadata.gz: ee5d5987c3290a815ecffcd1c5028a9cda2666a0064ce81ee9f6378da1e73d4756e96915a5825d0e7fbe895ffd8608acb4cfe3f18dc7b38623cca9eeb09f8d6a
+  data.tar.gz: 985fcee951cc6c1545aca3e6bb33bcb34f650a32860090b051280a0cfb7af6a16cd272ff8d91cf795d5d672a0cbdc6647ee318f220632ae75da9e416267930d7

data/README.md

@@ -1,3 +1,10 @@
+![](https://img.shields.io/badge/ruby-2.5%2B-red.svg)
+![Gem Version](https://img.shields.io/gem/v/camaleon_image_optimizer.svg?colorB=blue)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
+[![Build Status](https://travis-ci.org/brian-kephart/camaleon_image_optimizer.svg?branch=master)](https://travis-ci.org/brian-kephart/camaleon_image_optimizer)
+
+
+
 # Camaleon Image Optimizer
 This is a convenient image optimizer plugin for Camaleon CMS. Compressing images improves load times and thus SEO. It uses the [image_optim gem](https://github.com/toy/image_optim) under the hood. This gem contains multiple utilities for compressing GIF, JPEG, PNG, and SVG files. My experience has been that GIFs JPEGs are easily crushable with these tools, but using multiple PNG compressors is extremely slow. Thus, only one of the PNG compressors is enabled here.
 
@@ -25,8 +32,24 @@ If you need support for compressing SVG files, install [SVGO](https://github.com
 $ npm install -g svgo
 ```
 
+If you instead install SVGO locally:
+```bash
+$ npm install svgo
+```
+or:
+```bash
+$ yarn add svgo
+```
+...then you must add this variable to your Production environment:
+```
+SVGO_BIN='node_modules/svgo/bin/svgo'
+```
+
 ## Usage
 Just activate the plugin in Camaleon's admin panel.
 
+## Contributing
+See CONTRIBUTING.md
+
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,31 +1,33 @@
+# frozen_string_literal: true
+
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
-require 'rdoc/task'
+require "rdoc/task"
 
 RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'CamaleonImageOptimizer'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "CamaleonImageOptimizer"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
 APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
-load 'rails/tasks/engine.rake'
+load "rails/tasks/engine.rake"
 
-load 'rails/tasks/statistics.rake'
+load "rails/tasks/statistics.rake"
 
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
 
-require 'rake/testtask'
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
   t.verbose = false
 end
 

data/app/controllers/plugins/camaleon_image_optimizer/admin_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Plugins::CamaleonImageOptimizer::AdminController < CamaleonCms::Apps::PluginsAdminController
   include Plugins::CamaleonImageOptimizer::MainHelper
   def index
@@ -12,6 +14,6 @@ class Plugins::CamaleonImageOptimizer::AdminController < CamaleonCms::Apps::Plug
     @plugin.set_options(params[:options]) if params[:options].present? # save option values
     @plugin.set_metas(params[:metas]) if params[:metas].present? # save meta values
     @plugin.set_field_values(params[:field_options]) if params[:field_options].present? # save custom field values
-    redirect_to url_for(action: :settings), notice: 'Settings Saved Successfully'
+    redirect_to url_for(action: :settings), notice: "Settings Saved Successfully"
   end
 end

data/app/helpers/plugins/camaleon_image_optimizer/main_helper.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
+# This modules public methods are called via hooks defined in config/camaleon_plugin.json
 module Plugins::CamaleonImageOptimizer::MainHelper
-  require 'image_optim'
+  require "image_optim"
 
   def self.included(klass)
-    # klass.helper_method [:my_helper_method] rescue "" # here your methods accessible from views
+    # klass.helper_method [:my_helper_method] rescue "" # methods accessible from views
   end
 
   def camaleon_image_optimizer_on_active(plugin)
@@ -17,7 +20,7 @@ module Plugins::CamaleonImageOptimizer::MainHelper
   end
 
   def camaleon_image_optimizer_on_plugin_options(args)
-    args[:links] << link_to('Settings', admin_plugins_camaleon_image_optimizer_settings_path)
+    args[:links] << link_to("Settings", admin_plugins_camaleon_image_optimizer_settings_path)
   end
 
   def cama_optimize_image(settings)
@@ -26,28 +29,27 @@ module Plugins::CamaleonImageOptimizer::MainHelper
     settings[:uploaded_io] = File.open settings[:uploaded_io].path
   end
 
-private
+  private
 
   def camaleon_image_optimizer_options(plugin)
-    plugin.set_option('quality', camaleon_image_optimizer_default_settings['jpegoptim']['max_quality']) unless plugin.get_option('quality').present?
+    plugin.set_option("quality", camaleon_image_optimizer_default_settings["jpegoptim"]["max_quality"]) unless plugin.get_option("quality").present?
   end
 
   def camaleon_image_optimizer_settings
     @camaleon_image_optimizer_settings ||= camaleon_image_optimizer_default_settings.tap do |cios|
-      unless current_plugin.get_option('quality').blank?
-        cios['jpegoptim']['max_quality'] = current_plugin.get_option 'quality'
-        cios['pngquant']['quality'] = (0..current_plugin.get_option('quality'))
+      unless current_plugin.get_option("quality").blank?
+        cios["jpegoptim"]["max_quality"] = current_plugin.get_option "quality"
+        cios["pngquant"]["quality"] = (0..current_plugin.get_option("quality"))
       end
     end
   end
 
+  # default settings in config/image_optim.yml
   def camaleon_image_optimizer_default_settings
     @camaleon_image_optimizer_default_settings ||= begin
-      # default settings in config/image_optim.yml
-      spec = Gem::Specification.find_by_name 'camaleon_image_optimizer'
+      spec = Gem::Specification.find_by_name "camaleon_image_optimizer"
       gem_root = Pathname.new spec.gem_dir
-      YAML.load_file gem_root.join('config', 'image_optim.yml')
+      YAML.safe_load File.open(gem_root.join("config", "image_optim.yml")), [Range]
     end
   end
-
 end

data/config/camaleon_plugin.json

@@ -8,6 +8,7 @@
   "hooks": {
     "on_active": ["camaleon_image_optimizer_on_active"],
     "on_inactive": ["camaleon_image_optimizer_on_inactive"],
+    "on_upgrade": ["camaleon_image_optimizer_on_upgrade"],
     "plugin_options": ["camaleon_image_optimizer_on_plugin_options"],
     "before_upload": ["cama_optimize_image"]
   }

data/config/routes.rb

@@ -1,17 +1,21 @@
-Rails.application.routes.draw do
+# frozen_string_literal: true
+
+require "plugin_routes"
+require "camaleon_cms/engine"
 
-    scope PluginRoutes.system_info["relative_url_root"] do
-      #Admin Panel
-      scope :admin, as: 'admin', path: PluginRoutes.system_info['admin_path_name'] do
-        namespace 'plugins' do
-          namespace 'camaleon_image_optimizer' do
-            controller :admin do
-              get :index
-              get :settings
-              post :save_settings
-            end
+Rails.application.routes.draw do
+  scope PluginRoutes.system_info["relative_url_root"] do
+    # Admin Panel
+    scope :admin, as: "admin", path: PluginRoutes.system_info["admin_path_name"] do
+      namespace "plugins" do
+        namespace "camaleon_image_optimizer" do
+          controller :admin do
+            get :index
+            get :settings
+            post :save_settings
           end
         end
       end
     end
   end
+end

data/lib/camaleon_image_optimizer.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
+
 require "camaleon_image_optimizer/engine"
 
 module CamaleonImageOptimizer
-  # Your code goes here...
 end

data/lib/camaleon_image_optimizer/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CamaleonImageOptimizer
   class Engine < ::Rails::Engine
   end

data/lib/camaleon_image_optimizer/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CamaleonImageOptimizer
-  VERSION = '0.3.0'
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: camaleon_image_optimizer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Brian Kephart
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-03-26 00:00:00.000000000 Z
+date: 2021-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: camaleon_cms
@@ -56,16 +56,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 description: Compress uploaded images for faster page loads and better SEO.
 email:
 - briantkephart@gmail.com
@@ -86,11 +86,14 @@ files:
 - lib/camaleon_image_optimizer.rb
 - lib/camaleon_image_optimizer/engine.rb
 - lib/camaleon_image_optimizer/version.rb
-homepage: ''
+homepage: https://www.github.com/brian-kephart/camaleon_image_optimizer
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://www.github.com/brian-kephart/camaleon_image_optimizer
+  changelog_uri: https://www.github.com/brian-kephart/camaleon_image_optimizer/blob/master/CHANGELOG.md
+  source_code_uri: https://www.github.com/brian-kephart/camaleon_image_optimizer
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -98,16 +101,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.5
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Compress uploaded images for faster page loads and better SEO.
 test_files: []