sprite_animation 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea44cd766b7d903541704b202bc2f2d5c97beb7c
-  data.tar.gz: d35e6fed5b7fdc76bec6edf7a18743855d877e5c
+  metadata.gz: 8f277c6078b5214f161cff653cfb61439e412abf
+  data.tar.gz: 1953ac9e2752bc00a2527bb149a78863b2c7b22b
 SHA512:
-  metadata.gz: 5547272430b723fa94a328a99c4dfb755938d7fec43b29961b85ccfb62b86a9eb3441ac5d169faa57a42aac06b517e319bad79487e101682657b844eaee4d057
-  data.tar.gz: 3974c38865836b011d25f43e2714ac2c21b1cdf98031f336c0ab64b8ced2df95b7c59ebdac2e989c707bf9e0ef52734dbe0dbdeb6afac8cfa82ed5b87ce010fc
+  metadata.gz: 0f46c562b1dd10d737dd9dfc7ba951d18b8f05b0d861cc72656006cd1df18882c871d492c3f6136b98030ad8165cab59ab9f31401108459171654278cd9647b4
+  data.tar.gz: e90569d2ab773296e1849931bbf0698c39b866be97992c33ffdcd6ecd5e132842e17b6397424b6b45d77b82c6a36dabec365ad9a445afc716f40702e3133baa1

data/README.md

@@ -1,13 +1,22 @@
+# NOT FUNCTIONAL
+# WORKING ON IT
+
 # SpriteAnimation
 
+> Attention please.<br>
+> I'm still working on documenting it.<br>
+> There are still no tests whatsoever.<br>
+> Any contribution would be extremely appreciated.<br>
+
+
 This gem makes it easy creating animated images in your views given a sprite sheet. Just add it to your project and start animating sprite sheets.
 SpriteAnimation gem encapsulates all the javascript, jquery and rails logic you need. It was made to be as simple as possible. Try it!
 
 ## Usage
 
-SpriteAnimation gem extends your view helpers with one more method: `animated_image`.
+SpriteAnimation gem extends your view helpers with one more method: `animate_sprite`.
 
-`animated_image(image_src, frame_count, params = {})`
+`animate_sprite(image_src, frame_count, params = {})`
 
 **image_src**
 
@@ -20,24 +29,35 @@ String with the number of frames that your sprite sheet has.
 
 **params**
 
-A hash containing the following optional parameters:
-
-*scale*
+An optional hash containing the following parameters:
 
-Decimal value to resize your frame size. Defaults to 1.
+* scale: Decimal value to resize your frame size. Defaults to 1.
+* orientation: A symbol containing the orientation of your sprite sheet. <br>Can be: `:vertical` or `:horizontal`.
+ If it's not given, SpriteAnimation will try to guess it based on the height and width of your sprite sheet.
 
-*orientation*
+## Installation
+Add this line to your application's Gemfile:
+```ruby
+gem 'sprite_animation'
+```
+ 
+Then run
+```ruby
+bundle install
+```
 
-A symbol containing the orientation of your sprite sheet. Can be: `:vertical` or `:horizontal`.
-If it's not given, SpriteAnimation will try to guess it based on the height and width of your sprite sheet.
+After that, just add the require statement to your `application.js`
+```ruby
+//= require sprite_animation
+```
 
 ## Examples
 Using [slim-template](https://github.com/slim-template/slim)
 ```
-= animated_image("sample-sheet.png", "10")      # Looks for a sprite sheet located at app/assets/images/ with 10 frames.
-= animated_image("sample-sheet.png", "10", scale: 0.5)      # Same as above, but reducing the frame size to 50% of the original.
-= animated_image("horizontal-sheet.png", "10", orientation: :horizontal)    # Forces the orientation to be horizontal
-= animated_image("http://www.remotesheet.com/sheet.jpg", "12") # Fetches the sprite sheet at the URL and animates it with 12 frames
+= animate_sprite("sample-sheet.png", "10")      # Looks for a sprite sheet located at app/assets/images/ with 10 frames.
+= animate_sprite("sample-sheet.png", "10", scale: 0.5)      # Same as above, but reducing the frame size to 50% of the original.
+= animate_sprite("horizontal-sheet.png", "10", orientation: :horizontal)    # Forces the orientation to be horizontal
+= animate_sprite("http://www.remotesheet.com/sheet.jpg", "12") # Fetches the sprite sheet at the URL and animates it with 12 frames
 ```
 
 ## Dependencies

data/lib/sprite_animation/sprite_animation_helper.rb

@@ -3,6 +3,15 @@ require_relative 'sprite_animation_util'
 module SpriteAnimation
   include SpriteAnimationUtil
 
+  # Returns an image_tag inside a div, an populates the image
+  # with data so it can be animated via javascript
+  # Params:
+  # +image_src+:: a sprite sheet source, just as you would pass to image_tag
+  # +frame_count+:: a string representing the number of frames for the sheet
+  # +params+:: a hash containing two optional parameters for the animation
+  ##- +scale+:: a decimal number that will multiply the frame size. Default: 1
+  ##- +orientation+:: a symbol representing the orientation of your sheet.
+  ## Can be: :vertical or :horizontal. If not given, it will try to guess.
   def animate_sprite(image_src, frame_count, params = {})
     scale = params[:scale] || 1
 

data/lib/sprite_animation/sprite_animation_util.rb

@@ -1,7 +1,7 @@
 require 'fastimage'
 require 'uri'
 
-module SpriteAnimationUtil
+module SpriteAnimationUtil #:nodoc: all
   class ImageSize
     def self.size(image_src)
       FastImage.size(parse_image_path(image_src), :raise_on_failure => true)

data/lib/sprite_animation/version.rb

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

data/lib/sprite_animation.rb

@@ -1,11 +1,11 @@
 require "sprite_animation/version"
 require "sprite_animation/sprite_animation_helper"
 
-module SpriteAnimation 
-  class Engine < Rails::Engine
+module SpriteAnimation
+  class Engine < Rails::Engine #:nodoc:
   end
 
-  class Railtie < Rails::Railtie
+  class Railtie < Rails::Railtie #:nodoc:
     initializer "sprite_animation.initialize_sprite_animation_helper" do |app|
       ActiveSupport.on_load(:action_view) do
         include SpriteAnimation

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sprite_animation
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - DanielsLuz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-13 00:00:00.000000000 Z
+date: 2016-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,7 +95,6 @@ files:
 - README.md
 - Rakefile
 - app/assets/javascripts/sprite_animation.js
-- app/assets/javascripts/sprite_animation_main.js
 - bin/console
 - bin/setup
 - lib/sprite_animation.rb
@@ -129,4 +128,3 @@ signing_key:
 specification_version: 4
 summary: Simple gem for sprite sheet animation
 test_files: []
-has_rdoc: 

data/app/assets/javascripts/sprite_animation_main.js

@@ -1 +0,0 @@
-//= require_tree .