facebook_cover_resize 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5707f679f0c85e492939ab95c2b7d3b5b625b739
+  data.tar.gz: 9d65c69774143a91190e3fe8e1c515f7f8fcf07c
+SHA512:
+  metadata.gz: 3ee4b5916e5cd6caa1f124351bae81964629b9a05a99416c212fe6875f1ec60bba369c46fb0ff9fd22ca8cdf9ecf3083c27c00a19bfd45761f2bb524de3911a9
+  data.tar.gz: 9bba516e5e645d20bc629e09beb356530132d0455d2a8215a8a9656f013fd5da2941198a29275e08037b376ba77215c4f8d2958a1f9f98c24ae706ca948d4fd7

data/.gitignore

@@ -0,0 +1,60 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+=======
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.13.7

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in facebook_cover_resize.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Guillaume Barillot
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 guillaume barillot
+
+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,102 @@
+# Facebook Cover Resize
+
+This Gem allows to display and resize Facebook events' cover image according to offset_x / offset_y
+given by Facebook. Using this Gem, you can display event cover image exactly like they are on Facebook,
+no more distortions, no more poor cropping.
+
+To use this Gem, you have to grab 3 parameters from Facebook:
+
+* offset_x (positive integer)
+* offset_y (positive integer)
+* cover source (the URL of the image)
+
+WARNING: aside from these data provided by Facebook, you'll also need the dimensions of the image itself!
+I use the [Fastimage](https://github.com/sdsykes/fastimage) Gem for this
+and it's working perfectly fine.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'facebook_cover_resize'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install facebook_cover_resize
+
+## Usage
+
+This Gem contains an algorithm for image size computations, and a Rails view helper. Using the view helper
+is as simple as :
+
+```ruby
+- @event = Event.find(123)
+= event_cover_tag source: @event.cover, original: @event.cover_size, offsets: @event.offsets, width: 500
+```
+
+Note: Although this Gem handles resizing, you MUST consider the original Facebook width/height ratio,
+which is 1.91 (500/262). That's why you can only set the new width for your thumbnails,
+height is then automatically computed.
+
+Example: Let's say you need to display your thumbnails in a 250px wide container. You only have to
+call the Gem using this width, height being automatically set to 250 / 1.91 = 131px
+
+### Life outside of Rails
+
+If you don't want to use Rails, you can however just use the plain Algorithm:
+
+```ruby
+FacebookCoverResize.compute(
+  original: [original_width, original_height],
+  offsets: [offst_x, offset_y],
+  width: width_you_want_for_final_display_in_pixels
+)
+```
+This outputs an array containing 4 values :
+
+```ruby
+[
+  offset_y,
+  offset_x,
+  image_width,
+  image_height
+]
+```
+You can then build a container, surrounding an img tag, using these values like this :
+
+```html
+<div
+  style="
+    width: 500px !important;       # Container width
+    height: 262px !important;      # Container width / 1.91
+    overflow: hidden !important;   
+    position: relative !important;
+    padding:0 !important
+  ">
+  <img
+    style="
+      position: absolute !important;
+      top: 0px !important;        # offset_y
+      left: 0px !important;       # offset_x
+      width: 500px !important;    # image_width
+      height:824px !important;    # image_height
+      margin: 0 !important"
+    src="FACEBOOK_URL/event_cover.jpg" # The cover source URL
+  />
+</div>
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gbarillot/facebook_cover_resize.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "facebook_cover_resize"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/facebook_cover_resize.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'facebook_cover_resize/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "facebook_cover_resize"
+  spec.version       = FacebookCoverResize::VERSION
+  spec.authors       = ["guillaume barillot"]
+  spec.email         = ["gbarillot@gmail.com"]
+
+  spec.summary       = "Compute width/size and offsets x/y for Facebook events cover image"
+  spec.description   = "Compute width/size and offsets x/y for Facebook events cover image"
+  spec.homepage      = "https://github.com/gbarillot/facebook_cover_resize"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/facebook_cover_resize/railtie.rb

@@ -0,0 +1,8 @@
+require 'facebook_cover_resize/view_helpers'
+module FacebookCoverResize
+  class Railtie < Rails::Railtie
+    initializer "facebook_cover_tags.view_helpers" do
+      ActionView::Base.send :include, ViewHelpers
+    end
+  end
+end

data/lib/facebook_cover_resize/version.rb

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

data/lib/facebook_cover_resize/view_helpers.rb

@@ -0,0 +1,18 @@
+module FacebookCoverResize
+  module ViewHelpers
+    def event_cover_tag(args)
+      dims = FacebookCoverResize.compute(original: args[:original], offsets: args[:offsets], width: args[:width])
+      width = args[:width].to_i
+      height = (width / 1.91).ceil
+      source = args[:source]
+
+      content_tag(:div,
+        image_tag(source,
+          style: "position: absolute !important;top: #{dims[0]}px !important;left: #{dims[1]}px !important;width: #{dims[2]}px !important;height:#{dims[3]}px !important; margin: 0 !important"
+        ),
+        style: "width: #{width}px !important; height: #{height}px !important; overflow: hidden !important;position: relative !important; padding:0 !important"
+      )
+    end
+
+  end
+end

data/lib/facebook_cover_resize.rb

@@ -0,0 +1,72 @@
+require "facebook_cover_resize/version"
+require 'facebook_cover_resize/railtie' if defined?(Rails)
+
+module FacebookCoverResize
+  def self.compute(args)
+    ow = args[:width].to_f
+    oh = (ow / 1.91)
+
+    if args[:original].any? && args[:offsets].any?
+      nw = args[:original].first.to_f
+      nh = args[:original].last.to_f
+      ox = args[:offsets].first.to_f
+      oy = args[:offsets].last.to_f
+
+      if ox == 0 && oy == 0
+        w = ow
+        h = nh * (ow / nw)
+        if h < oh
+          h = oh
+          w = nw * (oh / nh)
+          offset_x = ow - w
+          offset_y = 0
+        else
+          offset_x = 0
+          if w < h
+            offset_y = 0
+          else
+            offset_y = oh - h
+          end
+        end
+      else
+        if oy > 0
+          w = ow
+          h = nh * (ow / nw)
+          offset_x = 0
+          offset_y = (oh - h) * (oy / 100.0)
+          if h < oh
+            h = oh
+            w = nw * (oh / nh)
+            offset_x = (ow - w) / 2
+            offset_y = 0
+          end
+        elsif ox > 0
+          h = oh
+          w = nw * (oh / nh)
+          offset_x = (ow - w) / 2
+          offset_y = 0
+        else
+          w = ow
+          h = nh * (ow / nw)
+          offset_x = 0
+          offset_y = 0
+        end
+      end
+    else
+      w = ow
+      h = oh
+      offset_x = 0
+      offset_y = 0
+    end
+
+    # [top, left, width, height]
+    out = [
+      offset_y.ceil,
+      offset_x.ceil,
+      w.ceil,
+      h.ceil
+    ]
+
+    return out
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: facebook_cover_resize
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- guillaume barillot
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Compute width/size and offsets x/y for Facebook events cover image
+email:
+- gbarillot@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- facebook_cover_resize.gemspec
+- lib/facebook_cover_resize.rb
+- lib/facebook_cover_resize/railtie.rb
+- lib/facebook_cover_resize/version.rb
+- lib/facebook_cover_resize/view_helpers.rb
+homepage: https://github.com/gbarillot/facebook_cover_resize
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Compute width/size and offsets x/y for Facebook events cover image
+test_files: []