facebook_cover_resize 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5707f679f0c85e492939ab95c2b7d3b5b625b739
-  data.tar.gz: 9d65c69774143a91190e3fe8e1c515f7f8fcf07c
+  metadata.gz: ae8b549158edc3e8266b43bc0bca3dd02623758b
+  data.tar.gz: 2a68f2c0b8a814e08d20a774e9597941b5d795b2
 SHA512:
-  metadata.gz: 3ee4b5916e5cd6caa1f124351bae81964629b9a05a99416c212fe6875f1ec60bba369c46fb0ff9fd22ca8cdf9ecf3083c27c00a19bfd45761f2bb524de3911a9
-  data.tar.gz: 9bba516e5e645d20bc629e09beb356530132d0455d2a8215a8a9656f013fd5da2941198a29275e08037b376ba77215c4f8d2958a1f9f98c24ae706ca948d4fd7
+  metadata.gz: 9b94ce8e7618abc4b4e9b4fbe5cf199cb4ea40b77cf5168f758a9c687e08ef9790ea8888e5c4beb5e2dd7d9ea7353a9bb7cf5255bb9ca3c41bb014dd7b1e6f92
+  data.tar.gz: 6122d32a491fb2ccc3cf907fd6e2711fe7fef13310248112d67348d01acc94afc0471a322ffba5528f58897c46fe104faf74b75f96e4e4ccfeedcd3f41238122

data/.travis.yml

@@ -1,5 +1,11 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.0
+  - jruby-19mode
+  - 2.0.0
+  - 2.2
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
 before_install: gem install bundler -v 1.13.7

data/README.md

@@ -1,22 +1,22 @@
 # 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.
+[![Build Status](https://travis-ci.org/gbarillot/facebook_cover_resize.png)](https://travis-ci.org/gbarillot/facebook_cover_resize)
 
-To use this Gem, you have to grab 3 parameters from Facebook:
+This Ruby Gem let you display and resize both Facebook events and accounts cover images according to offset_x / offset_y provided by Facebook Graph API. Using this Gem, you can display cover images exactly as they are on Facebook.
+
+To use this Gem, you have to grab 3 parameters from Facebook API:
 
 * 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
+Aside from these data provided by Facebook, you'll also need the dimensions of the image itself.
+Personally 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:
+Add this line to your Gemfile:
 
 ```ruby
 gem 'facebook_cover_resize'
@@ -32,30 +32,39 @@ Or install it yourself as:
 
 ## Usage
 
-This Gem contains an algorithm for image size computations, and a Rails view helper. Using the view helper
-is as simple as :
+This Gem contains an algorithm for image size computations, and some Rails view helpers. Using the view helpers
+to display and resize an event cover is as simple as:
 
 ```ruby
 - @event = Event.find(123)
+# @event.cover: String (raw URL)
+# @event.original: Array, containing 2 positive integers
+# @event.offsets: Array, containing 2 integers
+
 = 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.
+If you want to display an account cover:
+
+```ruby
+- @account = Account.find(123)
+
+= account_cover_tag source: @account.cover, original: @account.cover_size, offsets: @account.offsets, width: 500
+```
 
-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
+*Note:* This Gem handles resizing, but you MUST respect the original Facebook width/height ratios,
+which is 1.91 (500/262) for events, and 2.66 (829/312) for an account cover. That's why you only have to set the new width for your thumbnails, height being automatically computed.
 
-### Life outside of Rails
+### Life outside of the Rails
 
-If you don't want to use Rails, you can however just use the plain Algorithm:
+If you don't want to use Rails, you can however simply use the plain Algorithm:
 
 ```ruby
 FacebookCoverResize.compute(
   original: [original_width, original_height],
-  offsets: [offst_x, offset_y],
+  offsets: [offset_x, offset_y],
   width: width_you_want_for_final_display_in_pixels
+  ratio: 1.91
 )
 ```
 This outputs an array containing 4 values :

data/facebook_cover_resize.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   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.summary       = "Compute width/size and offsets x/y for Facebook cover images"
+  spec.description   = "Compute width/size and offsets x/y for Facebook cover images"
   spec.homepage      = "https://github.com/gbarillot/facebook_cover_resize"
   spec.license       = "MIT"
 

data/lib/facebook_cover_resize.rb

@@ -4,7 +4,7 @@ require 'facebook_cover_resize/railtie' if defined?(Rails)
 module FacebookCoverResize
   def self.compute(args)
     ow = args[:width].to_f
-    oh = (ow / 1.91)
+    oh = (ow / args[:ratio])
 
     if args[:original].any? && args[:offsets].any?
       nw = args[:original].first.to_f
@@ -59,7 +59,7 @@ module FacebookCoverResize
       offset_y = 0
     end
 
-    # [top, left, width, height]
+    # [margin-top, margin-left, image width, image height]
     out = [
       offset_y.ceil,
       offset_x.ceil,

data/lib/facebook_cover_resize/version.rb

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

data/lib/facebook_cover_resize/view_helpers.rb

@@ -1,9 +1,17 @@
 module FacebookCoverResize
   module ViewHelpers
     def event_cover_tag(args)
-      dims = FacebookCoverResize.compute(original: args[:original], offsets: args[:offsets], width: args[:width])
+      tag_generator(args.update(ratio: 1.91))
+    end
+
+    def account_cover_tag(args)
+      tag_generator(args.update(ratio: 2.66))
+    end
+
+    def tag_generator(args)
+      dims = FacebookCoverResize.compute(original: args[:original], offsets: args[:offsets], width: args[:width], ratio: args[:ratio])
       width = args[:width].to_i
-      height = (width / 1.91).ceil
+      height = (width / args[:ratio]).ceil
       source = args[:source]
 
       content_tag(:div,
@@ -13,6 +21,5 @@ module FacebookCoverResize
         style: "width: #{width}px !important; height: #{height}px !important; overflow: hidden !important;position: relative !important; padding:0 !important"
       )
     end
-
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: facebook_cover_resize
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - guillaume barillot
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-14 00:00:00.000000000 Z
+date: 2017-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: Compute width/size and offsets x/y for Facebook events cover image
+description: Compute width/size and offsets x/y for Facebook cover images
 email:
 - gbarillot@gmail.com
 executables: []
@@ -97,5 +97,5 @@ 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
+summary: Compute width/size and offsets x/y for Facebook cover images
 test_files: []