retina_image 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85a37773ab9ca391ddde0d42273fc50c5c127008
-  data.tar.gz: 106a2410703b7e108bdecae785cac85e001c964b
+  metadata.gz: 273a90d2884d5e32dedd581385f28e92a708d86d
+  data.tar.gz: a7cdbbebe7ca9832cfa9a76d698d25861a7afe66
 SHA512:
-  metadata.gz: 99bda0cab407ca085ba0a080af48067ce64488e8b318c86e80e5c41f94c818246246df5a39d39229f96a2533c7a5b332b028a0670e661f9dd257967f784ac7c6
-  data.tar.gz: 8e06248e07aad4341a781d83b9d8b57394c47dd8e14daf22ccdcd085643aa9a442385590c9f9a8c6d514be8fc460dea61792a2afdd9908734a1567e83e8d2048
+  metadata.gz: 74d7d8aa7d54b6fd2cff6d50be1aced40837307dc1e094989724df9b22b8c68efac8656acf57f1fbc2f418623073a8507eb0c2efdaca030543749a0dc84e7b90
+  data.tar.gz: 97ae519be08637eea992b27927d54a21dc5223f4b57ee7911ee0dd61e220244c674896216d79770f36a339dbb8d9e2cea08c86bb279f1157d9a14adb576cf74a

data/README.md

@@ -1,12 +1,38 @@
 # RetinaImage
 Retina Image is a simple retina image tag that supports high resolution images using assets pipeline.
+It will find the suitable image for any resolution for you.
 Also, this gem does not override your original image_tag.
 
 
 ## Usage
+Add images as `example_1x.png`, `example_2x.png`, `example_3x.png` to your asset pipeline
+then add below code to your view.
 ```ruby
 <%= retina_image_tag 'example.png' %>
 ```
+Output
+```html
+<img srcset="/example_1x.png 1x, /example_2x.png 2x, /example_3x.png 3x" alt="Example" src="/example_1x.png">
+```
+
+Add other options. For example
+```ruby
+<%= retina_image_tag 'example.png', alt: 'Example Wow' %>
+```
+Output
+```html
+<img srcset="/example_1x.png 1x, /example_2x.png 2x, /example_3x.png 3x" alt="Example Wow" src="/example_1x.png">
+```
+
+Disable retina image tag by adding `include_srcsets: false`
+```ruby
+<%= retina_image_tag 'example.png', include_srcsets: false%>
+```
+Output
+```html
+<img src="/example_1x.png" alt="Example" >
+``` 
+
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -26,7 +52,7 @@ $ gem install retina_image
 ```
 
 ## Contributing
-Contribution directions go here.
+Create pull requests. Raise issues.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/retina_image/version.rb

@@ -1,3 +1,3 @@
 module RetinaImage
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/retina_image.rb

@@ -1,4 +1,4 @@
-module RetinaImage
+class RetinaImage
   def retina_tag(source, options = {})
     options.reverse_merge!(include_srcsets: true)
 
@@ -12,25 +12,24 @@ module RetinaImage
     image_tag(srcset["1x"], options)
   end
 
-  private def srcset_from_source(source)
-    dir, file, extension = split_path(source)
-
-    (1..3).each_with_object({}) do |i, srcset|
-      scale = "#{i}x"
-      srcset[scale] = build_image_path(dir, "#{file}_#{scale}#{extension}")
-    end
-  end
-
   private def split_path(source)
     [
         File.dirname(source),
-        File.basename(source, '.*'),
+        filename(source),
         File.extname(source)
     ]
   end
 
+  private def filename(source)
+    File.basename(source, '.*')
+  end
+
+  private def alt(source)
+    filename(source).titleize
+  end
+
   private def build_image_path(dirname, filename)
-    asset_path = (dirname == '.' ? filename : File.join(dirname, filename))
-    image_path(asset_path)
+    path = (dirname == '.' ? filename : File.join(dirname, filename))
+    image_path(path)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: retina_image
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Palm Stable