camaleon_image_optimizer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 867ba9921e9adf85de5414f060ad9334c6d45b4b5386125c074a203772d9f146
+  data.tar.gz: 7327557f0b96194031ce99813d437369ce6c8f62a59dc56d7d9188cafb572dcb
+SHA512:
+  metadata.gz: fe873c0db1e3eb96103586df94be7c98cb6f801653254bf63a0cbc4b6379a5a17b09c847540977b3857c06f158c6e267b1f17b590488ff416f57e909f60db129
+  data.tar.gz: 7f918fb5289319ddeb6a7fa7d7b69b7ec4687735ad86df632b36c8c73f263a61674a34916294fa5492be70c5f3b33682b49781bfd6842a7d4a50e809832b98ec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Brian Kephart
+
+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

@@ -0,0 +1,25 @@
+# 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_rails gem](https://github.com/toy/image_optim_rails) under the hood. Currently no settings are exposed in Camaleon, but that may happen in the future. Until then, the default settings will still compress quite a bit without sacrificing quality.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'camaleon_image_optimizer', github: 'brian-kephart/camaleon_image_optimizer'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install camaleon_image_optimizer
+```
+
+## Usage
+Just activate the plugin in Camaleon's admin panel.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+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')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

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

@@ -0,0 +1,18 @@
+class Plugins::CamaleonImageOptimizer::AdminController < CamaleonCms::Apps::PluginsAdminController
+  include Plugins::CamaleonImageOptimizer::MainHelper
+  def index
+  end
+
+  # show settings form
+  def settings
+  end
+
+  # save values from settings form
+  def save_settings
+    @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'
+  end
+  # add custom methods below ....
+end

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

@@ -0,0 +1,8 @@
+class Plugins::CamaleonImageOptimizer::FrontController < CamaleonCms::Apps::PluginsFrontController
+  include Plugins::CamaleonImageOptimizer::MainHelper
+  def index
+    # actions for frontend module
+  end
+
+  # add custom methods below
+end

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

@@ -0,0 +1,41 @@
+module Plugins::CamaleonImageOptimizer::MainHelper
+  require 'image_optim'
+
+  def self.included(klass)
+    # klass.helper_method [:my_helper_method] rescue "" # here your methods accessible from views
+  end
+
+  # here all actions on going to active
+  # you can run sql commands like this:
+  # results = ActiveRecord::Base.connection.execute(query);
+  # plugin: plugin model
+  def camaleon_image_optimizer_on_active(plugin)
+  end
+
+  # here all actions on going to inactive
+  # plugin: plugin model
+  def camaleon_image_optimizer_on_inactive(plugin)
+  end
+
+  # here all actions to upgrade for a new version
+  # plugin: plugin model
+  def camaleon_image_optimizer_on_upgrade(plugin)
+  end
+
+  # hook listener to add settings link below the title of current plugin (if it is installed)
+  # args: {plugin (Hash), links (Array)}
+  # permit to add unlimmited of links...
+  def camaleon_image_optimizer_on_plugin_options(args)
+    args[:links] << link_to('Settings', admin_plugins_camaleon_image_optimizer_settings_path)
+  end
+
+  def cama_optimize_image(settings)
+    # settings in config/image_optim.yml
+    spec = Gem::Specification.find_by_name("camaleon_image_optimizer")
+    gem_root = Pathname.new spec.gem_dir
+    image_optim = ImageOptim.new YAML.load_file(gem_root.join('config', 'image_optim.yml'))
+    image_optim.optimize_image! settings[:uploaded_io].path
+    settings[:uploaded_io] = File.open settings[:uploaded_io].path
+  end
+
+end

data/app/models/plugins/camaleon_image_optimizer/camaleon_image_optimizer.rb

@@ -0,0 +1,6 @@
+# class Plugins::CamaleonImageOptimizer::CamaleonImageOptimizer < ActiveRecord::Base
+  # belongs_to :site, class_name: "CamleonCms::Site"
+
+  # here create your models normally
+  # notice: your tables in database will be plugins_camaleon_image_optimizer in plural (check rails documentation)
+# end

data/app/views/plugins/camaleon_image_optimizer/admin/index.html.erb

@@ -0,0 +1,9 @@
+<%#= javascript_include_tag plugin_asset("my_file.js") %>
+<div class="panel panel-default">
+    <div class="panel-heading">
+        <h4>My Title</h4>
+    </div>
+    <div class="panel-body">
+        <p>Plugin ready to use in admin panel!.</p>
+    </div>
+</div>

data/app/views/plugins/camaleon_image_optimizer/admin/settings.html.erb

@@ -0,0 +1,21 @@
+<div class="panel panel-default">
+    <div class="panel-heading">
+        <h4>My Plugin Settings</h4>
+    </div>
+    <div class="panel-body">
+        <%= form_tag(url_for(action: :save_settings), class: 'validate') do %>
+            <div class="form-group">
+                <label>My Option Setting</label>
+                <%= text_field_tag 'options[my_setting]', @plugin.get_option('my_setting'), class: 'form-control required' %>
+            </div>
+            <div class="form-group">
+                <label>My Meta Setting</label>
+                <%= text_field_tag 'metas[my_setting]', @plugin.get_meta('my_setting'), class: 'form-control required' %>
+            </div>
+            <%= render partial: "camaleon_cms/admin/settings/custom_fields/render", locals: {record: @plugin, field_groups: @plugin.get_field_groups} %>
+            <div class="form-group text-right">
+                <%= submit_tag 'Save Settings', class: 'btn btn-primary' %>
+            </div>
+        <% end %>
+    </div>
+</div>

data/app/views/plugins/camaleon_image_optimizer/front/index.html.erb

@@ -0,0 +1,2 @@
+<%#= javascript_include_tag plugin_gem_asset("js/my_file.js") %>
+Plugin ready to use! in frontend.

data/app/views/plugins/camaleon_image_optimizer/layouts/readme.txt

@@ -0,0 +1,2 @@
+You can create your layouts here.
+To load your custom layout you can use: layout: plugin_layout(<layout_name>) in your controller

data/config/camaleon_plugin.json

@@ -0,0 +1,14 @@
+{
+  "title": "Camaleon Image Optimizer",
+  "descr": "",
+  "key": "camaleon_image_optimizer",
+  "helpers": [
+    "Plugins::CamaleonImageOptimizer::MainHelper"
+  ],
+  "hooks": {
+    "on_active": ["camaleon_image_optimizer_on_active"],
+    "on_inactive": ["camaleon_image_optimizer_on_inactive"],
+    /* "plugin_options": ["camaleon_image_optimizer_on_plugin_options"], */
+    "before_upload": ["cama_optimize_image"]
+  }
+}

data/config/image_optim.yml

@@ -0,0 +1,17 @@
+# see https://github.com/toy/image_optim for config options
+skip_missing_workers: true
+pngout: false
+svgo: false
+
+allow_lossy: true
+advpng: false
+jpegoptim:
+  allow_lossy: true
+  max_quality: 70
+jpegrecompress:
+  allow_lossy: true
+  quality: 0
+optipng: false
+pngcrush: false
+pngquant:
+  allow_lossy: true

data/config/initializers/custom_models.rb

@@ -0,0 +1,5 @@
+#Rails.application.config.to_prepare do
+#   CamaleonCms::Site.class_eval do
+#     has_many :attack, class_name: "Plugins::Attack::Models::Attack"
+#   end
+# end

data/config/routes.rb

@@ -0,0 +1,31 @@
+Rails.application.routes.draw do
+
+    scope PluginRoutes.system_info["relative_url_root"] do
+      scope '(:locale)', locale: /#{PluginRoutes.all_locales}/, :defaults => {  } do
+        # frontend
+        namespace :plugins do
+          namespace 'camaleon_image_optimizer' do
+            get 'index' => 'front#index'
+          end
+        end
+      end
+
+      #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
+
+      # main routes
+      #scope 'camaleon_image_optimizer', module: 'plugins/camaleon_image_optimizer/', as: 'camaleon_image_optimizer' do
+      #  Here my routes for main routes
+      #end
+    end
+  end

data/lib/camaleon_image_optimizer.rb

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

data/lib/camaleon_image_optimizer/engine.rb

@@ -0,0 +1,4 @@
+module CamaleonImageOptimizer
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/camaleon_image_optimizer/version.rb

@@ -0,0 +1,3 @@
+module CamaleonImageOptimizer
+  VERSION = '0.1.0'
+end

data/lib/tasks/camaleon_image_optimizer_tasks.rake

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

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: camaleon_image_optimizer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brian Kephart
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: camaleon_cms
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: image_optim_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+- !ruby/object:Gem::Dependency
+  name: image_optim_pack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Compress uploaded images for faster page loads and better SEO.
+email:
+- briantkephart@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/camaleon_image_optimizer_manifest.js
+- app/controllers/plugins/camaleon_image_optimizer/admin_controller.rb
+- app/controllers/plugins/camaleon_image_optimizer/front_controller.rb
+- app/helpers/plugins/camaleon_image_optimizer/main_helper.rb
+- app/models/plugins/camaleon_image_optimizer/camaleon_image_optimizer.rb
+- app/views/plugins/camaleon_image_optimizer/admin/index.html.erb
+- app/views/plugins/camaleon_image_optimizer/admin/settings.html.erb
+- app/views/plugins/camaleon_image_optimizer/front/index.html.erb
+- app/views/plugins/camaleon_image_optimizer/layouts/readme.txt
+- config/camaleon_plugin.json
+- config/image_optim.yml
+- config/initializers/custom_models.rb
+- config/routes.rb
+- lib/camaleon_image_optimizer.rb
+- lib/camaleon_image_optimizer/engine.rb
+- lib/camaleon_image_optimizer/version.rb
+- lib/tasks/camaleon_image_optimizer_tasks.rake
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.5
+signing_key: 
+specification_version: 4
+summary: Compress uploaded images for faster page loads and better SEO.
+test_files: []