bridgetown-cloudinary 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e2a0a39fcc006a2b1293e4a18feddac2cbb2aa37d305c45830c3493a3b031543
+  data.tar.gz: 6a3b8794b0151383dc4f331df4d9282a229681b315fa490c26791ca96fa04c92
+SHA512:
+  metadata.gz: b1680c1d594c65fe4d1ffda7818c1bc46ffc2951a5d13569678e7054feab59442ae3f0fda80037d22bac46e7c39e04aa4c7a141d59070fc2b5cca7c25b914a42
+  data.tar.gz: 62cc8410cd8248e69d61793b94b9c9ff91744c2cc4650d720f795789244c3fb067b6c60b0d558281c4a3a94e7986a423a5961b852a1b3ceeba9867baea5edbf7

data/.gitignore

@@ -0,0 +1,38 @@
+/vendor
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+Gemfile.lock
+.bundle
+.ruby-version
+
+# Node
+node_modules
+.npm
+.node_repl_history
+
+# Yarn
+yarn-error.log
+yarn-debug.log*
+.pnp/
+.pnp.js
+
+# Yarn Integrity file
+.yarn-integrity
+
+spec/dest
+.bridgetown-metadata
+.bridgetown-cache
+.bridgetown-webpack

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rubocop.yml

@@ -0,0 +1,26 @@
+require: rubocop-bridgetown
+
+inherit_gem:
+  rubocop-bridgetown: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Include:
+    - lib/**/*.rb
+
+  Exclude:
+    - .gitignore
+    - .rspec
+    - .rubocop.yml
+
+    - Gemfile.lock
+    - CHANGELOG.md
+    - LICENSE.txt
+    - README.md
+
+    - script/**/*
+    - vendor/**/*
+
+Metrics/AbcSize:
+  Exclude:
+    - lib/bridgetown-cloudinary/utils.rb

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# master
+
+# 1.0.0 / 2020-05-18
+
+* First version of the Cloudinary plugin for Bridgetown, including defaults for
+  various image sizes.

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2020-present
+
+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,137 @@
+# Bridgetown Cloudinary Plugin
+
+[Bridgetown](https://www.bridgetownrb.com) is a Ruby-powered static site generator.
+[Cloudinary](https://www.cloudinary.com) is digital asset management service which
+makes uploading and serving resized, transformed, and compressed images and videos
+easy and fast.
+
+This plugin wires the two up so you can use Cloudinary images in your blog posts,
+articles, product pages, site templates, and anywhere else you might need to
+reference media optimized for mobile and responsive design.
+
+## Installation
+
+Run this command to add this plugin to your site's Gemfile:
+
+```shell
+$ bundle add bridgetown-cloudinary -g bridgetown_plugins
+```
+
+Or simply add this line to your Gemfile and run `bundle install`:
+
+```ruby
+gem 'bridgetown-cloudinary', group: "bridgetown_plugins"
+```
+
+Then modify your `bridgetown.config.yml` configuration to point to your Cloudinary
+cloud name:
+
+```yaml
+cloudinary:
+  cloud_name: my-cloud-name
+```
+
+## Usage
+
+The simplest usage of the Bridgetown Cloudinary plugin is to add a `cloudinary_id` to
+the front matter of a page or document. For example:
+
+```yaml
+---
+title: I'm a Blog Post
+cloudinary_id: some-folder-with/image-in-cloudinary
+category: neat
+---
+
+I'm a blog post with an image!
+```
+
+The plugin will automatically add `image.path` front matter with a generated URL to
+the image in Cloudinary using the default configured transformation `open_graph`.
+This sizes and compresses an image suitable for use on Twitter, Facebook, etc.
+(See below for information on how to change the default transformation or add your
+own.)
+
+You can use `image.path` in a template:
+
+`{{ post.image.path }}`
+
+Since `image.path` is also referenced by the Bridgetown [Feed](https://github.com/bridgetownrb/bridgetown-feed) and [SEO](https://github.com/bridgetownrb/bridgetown-seo-tag) plugins,
+your Cloudinary images will be picked up in those contexts automatically.
+
+To reference other available sizes, you can use either a Liquid tag or filter,
+depending on your needs. Using a tag:
+
+`{% cloudinary_img "Alt text goes here", post.cloudinary_id, "large" %}`
+
+Or a filter:
+
+`<img alt="Alt text" src="{{ post.cloudinary_id | cloudinary_url: "medium" }}" />`
+
+
+### Default Sizes Included
+
+Here's a list of all the Cloudinary transformation strings that ship with the plugin:
+
+```yaml
+open_graph: "c_fill,g_face:center,w_1600,h_900,q_50" # default
+tiny: "w_300,c_limit,q_90"
+small: "w_600,c_limit,q_85"
+medium: "w_1200,c_limit,q_80"
+large: "w_1800,c_limit,q_80"
+xlarge: "w_2048,c_limit,q_75"
+```
+
+The image format used in all cases is JPG.
+
+### Optional Configuration Options
+
+If you'd like to reference any of the configured image sizes directly through front
+matter as an alternative to using tags or filters, you can switch this on in your
+`bridgetown.config.yml`:
+
+```yaml
+cloudinary:
+  add_transformed_urls_to_image_front_matter: true
+```
+
+Then you'll be able to reference image sizes like so:
+
+`<img alt="Alt text" src="{{ post.image.tiny }}" />`
+
+Be aware that if an `image` front matter variable has already defined for a document,
+it will remain intact and the Cloudinary image transformations won't be apply for
+that document.
+
+You can also change or add your own transformations! Simply define them in your
+config:
+
+```yaml
+cloudinary:
+  transformations:
+    tiny: w_300,c_limit,q_90 # this overrides the builtin tiny transformation
+    max_bw: e_grayscale,w_4096,c_limit,q_65 # this is a new custom transformation
+```
+
+If you configure transformations to get added to front matter, all custom
+transformations will show up there as well:
+
+`B&W image URL: {{ post.image.max_bw }}`
+
+## Testing
+
+* Run `bundle exec rspec` to run the test suite
+* Or run `script/cibuild` to validate with Rubocop and test with rspec together
+
+## Contributing
+
+1. Fork it (https://github.com/bridgetownrb/bridgetown-cloudinary/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Releasing
+
+To release a new version of the plugin, simply bump up the version number in
+`version.rb` and then run `script/release`.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bridgetown-cloudinary.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "lib/bridgetown-cloudinary/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bridgetown-cloudinary"
+  spec.version       = Bridgetown::Cloudinary::VERSION
+  spec.author        = "Bridgetown Team"
+  spec.email         = "maintainers@bridgetownrb.com"
+  spec.summary       = "Embed or access images with transformations using Cloudinary"
+  spec.homepage      = "https://github.com/bridgetownrb/bridgetown-cloudinary"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script|spec|features|frontend)/!) }
+  spec.test_files    = spec.files.grep(%r!^spec/!)
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.add_dependency "bridgetown", ">= 0.14", "< 2.0"
+  spec.add_dependency "cloudinary", ">= 0.13"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "nokogiri", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop-bridgetown", "~> 0.2"
+end

data/lib/bridgetown-cloudinary.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "bridgetown"
+require "cloudinary"
+require "bridgetown-cloudinary/utils"
+require "bridgetown-cloudinary/builder"

data/lib/bridgetown-cloudinary/builder.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Cloudinary
+    class Builder < Bridgetown::Builder
+      CONFIG_DEFAULTS = {
+        cloudinary: {
+          cloud_name: nil,
+          default_transformation: "open_graph",
+          default_image_format: "jpg",
+          transformations: {
+            open_graph: "c_fill,g_face:center,w_1600,h_900,q_50",
+            tiny: "w_300,c_limit,q_90",
+            small: "w_600,c_limit,q_85",
+            medium: "w_1200,c_limit,q_80",
+            large: "w_1800,c_limit,q_80",
+            xlarge: "w_2048,c_limit,q_75",
+          },
+          add_transformed_urls_to_image_front_matter: false,
+        },
+      }.freeze
+
+      # Set up the Cloudinary configuration
+      def build
+        ::Cloudinary.config({
+          "cloud_name" => config[:cloudinary][:cloud_name],
+          "secure"     => true,
+        })
+
+        generator :add_image_urls_to_documents
+        liquid_tag "cloudinary_img", :img_tag
+        liquid_filter "cloudinary_url", :url_filter
+      end
+
+      # Populate front matter
+      def add_image_urls_to_documents
+        Bridgetown::Cloudinary::Utils.add_image_urls_to_documents(
+          site, config[:cloudinary]
+        )
+      end
+
+      # Define the "cloudinary_img" Liquid tag
+      def img_tag(attributes, tag)
+        alt, id, transformation = attributes.split(",").map(&:strip)
+        alt.delete! '"'
+        if id.include? '"'
+          id.delete! '"'
+        elsif id.include? "."
+          obj, var = id.split(".")
+          id = tag.context[obj][var]
+        else
+          id = tag.context[id]
+        end
+        transformation&.delete! '"'
+
+        "<img alt=\"#{alt}\" src=\"#{url_filter(id, transformation)}\" />"
+      end
+
+      # Define the "cloudinary_url" Liquid filter
+      def url_filter(id, transformation = nil)
+        Bridgetown::Cloudinary::Utils.url(
+          config: config[:cloudinary], id: id, transformation: transformation
+        )
+      end
+    end
+  end
+end
+
+Bridgetown::Cloudinary::Builder.register

data/lib/bridgetown-cloudinary/utils.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Cloudinary
+    module Utils
+      def self.url(config:, id:, transformation:)
+        transformation = if transformation
+                           "/#{config[:transformations][transformation]}"
+                         else
+                           "/#{config[:transformations][config[:default_transformation]]}"
+                         end
+        image_format = config[:default_image_format]
+
+        cloudinary_url = ::Cloudinary::Utils.cloudinary_url(
+          id, { format: image_format }
+        )
+
+        cloudinary_url&.sub("/image/upload", "/image/upload#{transformation}")
+      end
+
+      def self.add_image_urls_to_documents(site, config)
+        (site.documents + site.pages).each do |page|
+          next unless page.data[:cloudinary_id] && !page.data[:image]
+
+          page.data[:image] = {
+            path: url(
+              config: config,
+              id: page.data[:cloudinary_id],
+              transformation: nil
+            ),
+          }
+          next unless config[:add_transformed_urls_to_image_front_matter]
+
+          config[:transformations].each_key do |transformation|
+            page.data[:image][transformation] = url(
+              config: config,
+              id: page.data[:cloudinary_id],
+              transformation: transformation
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bridgetown-cloudinary/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Cloudinary
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: bridgetown-cloudinary
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Bridgetown Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: cloudinary
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: 
+email: maintainers@bridgetownrb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bridgetown-cloudinary.gemspec
+- lib/bridgetown-cloudinary.rb
+- lib/bridgetown-cloudinary/builder.rb
+- lib/bridgetown-cloudinary/utils.rb
+- lib/bridgetown-cloudinary/version.rb
+homepage: https://github.com/bridgetownrb/bridgetown-cloudinary
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: Embed or access images with transformations using Cloudinary
+test_files: []