image_zoomer 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c895266f84f49e890f76ab6ac25c286b4ce5c842
-  data.tar.gz: 2df7c11928d805e227f398e56e628b250611a1f9
+  metadata.gz: 1fa811da0829b6a088d6ffee24c4d3c882e6ee4b
+  data.tar.gz: d13db14bbe5f5cf10aefb2ee258ce7241eeddde6
 SHA512:
-  metadata.gz: 3cdd7c2e7fcb1f177b8f197b6b010e364afa4fceabac207c746213831a6b3da787337aac83ab327b870b1f18fc4fed2c670ba757bcc6425cad5f8d662a509ebc
-  data.tar.gz: 22c7b3783e087b4de78f97a6e382d73f8cd4b85cb98146a70bbc336bd0686c5ad683f348d6b4eab21ade3cfc723852c552841a25a1b83eda92e32d7efa5eb0f6
+  metadata.gz: 7d6fe47b7774e691e5071b63e02c79f84a25845bce6ac6a48e3982769d0aaba02a4335d81444146a15b326dce79a4035c4bc984879f730af2ab5dd35d79c9de0
+  data.tar.gz: d840df8809afbcbbfba5af81ea1577baae96cfefa05f1e1d6df677ccea0a50ba44111bae9ebef689240e4f5a0e363effd530f3993911d02c152489690855eef3

data/.gitignore

@@ -12,6 +12,8 @@ rerun.txt
 pickle-email-*.html
 config/initializers/secret_token.rb
 config/secrets.yml
+pkg
+doc
 
 ## Environment normalisation:
 /.bundle

data/README.md

@@ -1,6 +1,6 @@
 # ImageZoomer
 
-TODO: Write a gem description
+This is a Rails gem for my [image_zoomer](https://github.com/ilatif/image_zoomer) jQuery plugin. This gem provides an easy way to integrate `image_zoomer` jQuery plugin with your Rails apps.
 
 ## Installation
 
@@ -18,11 +18,31 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To use this gem you can use standard `image_tag` helper that Rails provides. To have image zooming effect on your desired images you have to apply `image_zoomer` class on images. For example:
+
+	image_tag("/path/to/your/image.ext", :class => 'image_zoomer')
+	
+Recommended way is to use `zoom_image_tag` helper that this gem provides. By using `zoom_image_tag` helper you don't have to provide `image_zoomer` class.
+
+	zoom_image_tag("/path/to/your/image.ext", :id => "my_image")
+	
+`zoom_image_tag` is 100% identical to `image_tag`. You can use it in the same way and pass same options that you can pass to `image_tag`. You can also provide `:class => 'class1 class2'` option in `zoom_image_tag` and your provided classes will be applied.
+
+By-default `width` and `height` of zoom lens are set to `90px` and `zoom_level` is set to `1.5`.  To override these default settings you can create an initializer with `image_zoomer.rb` name under `config/initializers` directory and use following code:
+
+	Rails.application.config.image_zoomer.set_options do |options|
+		options.width = 30
+		options.height = 30
+	end
+	
+The above code will override `width` and `height` properties. As we haven't overridden `zoom_level` so it will remain at `1.5`. Restart your server to see these changes in action.
+
+**Note: This gem prepares values dynamically for jQuery plugin when server starts. Due to asset pipeline issue if you make some change in code that overrides default image zooming settings then those changes don't take effect. To make sure that your changes always apply when you start / restart server this gem is deleting tmp/cache/assets directory in development mode. I hope your application is fine with this :-).**
+
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/image_zoomer/fork )
+1. Fork it
 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`)

data/app/assets/javascripts/image_zoomer_initializer.js

@@ -2,5 +2,7 @@ $(function() {
 	if (typeof __ImageZoomer == "undefined") {
 		__ImageZoomer = {options: {}};
 	}
-	$(".image_zoomer").image_zoomer(__ImageZoomer.options);
+	$(".image_zoomer").each(function() {
+		$(this).image_zoomer(__ImageZoomer.options);
+	});
 });

data/image_zoomer.gemspec

@@ -9,11 +9,11 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Imran Latif"]
   spec.email         = ["ilatif.bwp@gmail.com"]
   spec.summary       = %q{Image Zoomer}
-  spec.description   = %q{This gem provides functionality for zooming images by using a jQuery plugin image_zoomer.}
-  spec.homepage      = "http://i8ecoders.com/image_zoomer"
+  spec.description   = %q{This is a Rails gem for my image_zoomer jQuery plugin (https://github.com/ilatif/image_zoomer).}
+  spec.homepage      = "https://github.com/ilatif/image_zoomer_rb"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
+  spec.files         = `git ls-files`.split("\n")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]

data/lib/image_zoomer/configuration.rb

@@ -1,5 +1,16 @@
+# Configuration class to provide information to jQuery plugin to setup lens
 module ImageZoomer
+
 	class Configuration
+
+		# == Parameters:
+		# width::
+		#		Specifies width for zoom lens
+		# height::
+		#   Specifies height for zoom lens
+		# zoom_level::
+		#   Specifies zoom level for zoom lens
+
 		attr_accessor :width
 		attr_accessor :height
 		attr_accessor :zoom_level
@@ -10,6 +21,7 @@ module ImageZoomer
 			@zoom_level = 1.5
 		end
 
+		# Override default options with the provided ones in block
 		def set_options(&block)
 			block.yield(self)
 		end

data/lib/image_zoomer/version.rb

@@ -1,3 +1,3 @@
 module ImageZoomer
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/image_zoomer/zoom_image_helper.rb

@@ -1,3 +1,4 @@
+# Contains code for zoom_image_tag helper
 module ImageZoomer
 	def zoom_image_tag(*args, &block)
 		options = insert_zoom_class(args.extract_options!)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: image_zoomer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Imran Latif
@@ -38,8 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: This gem provides functionality for zooming images by using a jQuery
-  plugin image_zoomer.
+description: This is a Rails gem for my image_zoomer jQuery plugin (https://github.com/ilatif/image_zoomer).
 email:
 - ilatif.bwp@gmail.com
 executables: []
@@ -50,7 +49,6 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - app/assets/javascripts/image_zoomer.js
@@ -64,7 +62,7 @@ files:
 - lib/image_zoomer/railtie.rb
 - lib/image_zoomer/version.rb
 - lib/image_zoomer/zoom_image_helper.rb
-homepage: http://i8ecoders.com/image_zoomer
+homepage: https://github.com/ilatif/image_zoomer_rb
 licenses:
 - MIT
 metadata: {}

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2014 imranjs
-
-MIT License
-
-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.