sprite_animation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea44cd766b7d903541704b202bc2f2d5c97beb7c
+  data.tar.gz: d35e6fed5b7fdc76bec6edf7a18743855d877e5c
+SHA512:
+  metadata.gz: 5547272430b723fa94a328a99c4dfb755938d7fec43b29961b85ccfb62b86a9eb3441ac5d169faa57a42aac06b517e319bad79487e101682657b844eaee4d057
+  data.tar.gz: 3974c38865836b011d25f43e2714ac2c21b1cdf98031f336c0ab64b8ced2df95b7c59ebdac2e989c707bf9e0ef52734dbe0dbdeb6afac8cfa82ed5b87ce010fc

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at danielluz1995@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 DanielsLuz
+
+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,61 @@
+# SpriteAnimation
+
+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`.
+
+`animated_image(image_src, frame_count, params = {})`
+
+**image_src**
+
+The source of the image, just like in [image_tag helper](http://apidock.com/rails/ActionView/Helpers/AssetTagHelper/image_tag).
+Can be a local image or a URL of an image.
+
+**frame_count**
+
+String with the number of frames that your sprite sheet has.
+
+**params**
+
+A hash containing the following optional parameters:
+
+*scale*
+
+Decimal value to resize your frame size. Defaults to 1.
+
+*orientation*
+
+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.
+
+## 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
+```
+
+## Dependencies
+- [jquery-rails](https://github.com/rails/jquery-rails)
+- [fastimage](https://github.com/sdsykes/fastimage)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/DanielsLuz/sprite_animation. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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/app/assets/javascripts/sprite_animation.js

@@ -0,0 +1,19 @@
+var animate = function(i, img) {
+  var frameCount = $(img).attr("frameCount");
+  var frameLength = $(img).attr("frameLength"); 
+  var frameSide = $(img).attr("frameSide");  
+  var margin = "margin-" + frameSide;
+
+  var cont = 0;
+  var rollImage = function() {
+    $(img).css(margin, -1 * (cont*frameLength));  
+    cont++;
+    if(cont == frameCount){
+      cont = 0;
+    }   
+  }
+  setInterval(rollImage, 80);
+}
+$(function(){
+  $("img[class^='animated']").each(animate); 
+})

data/app/assets/javascripts/sprite_animation_main.js

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sprite_animation"
+
+# 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/lib/sprite_animation/sprite_animation_helper.rb

@@ -0,0 +1,63 @@
+require_relative 'sprite_animation_util'
+
+module SpriteAnimation
+  include SpriteAnimationUtil
+
+  def animate_sprite(image_src, frame_count, params = {})
+    scale = params[:scale] || 1
+
+    img_width, img_height = ImageSize.size(image_src).map { |d| d*scale }
+
+    orientation = params[:orientation] ||
+      guess_orientation(img_width, img_height)
+
+    frame =
+      send(orientation,*[img_width,img_height,frame_count])
+
+    image = image_tag(image_url(image_src), class: "animated",
+                      frameCount: frame_count, 
+                      frameLength: frame[:length],
+                      frameSide: frame[:margin],
+                      style: frame[:style])
+
+    content_tag(:div, image, 
+                style: animated_div_style(frame[:width],frame[:height]))
+  end 
+
+  private
+
+  def animated_div_style(frame_width, frame_height)
+    "width: #{frame_width}px;
+     height: #{frame_height}px;
+     display: block;
+     overflow: hidden"
+  end
+
+  def horizontal(img_width, img_height, frame_count)
+    frame_width = img_width / frame_count.to_i
+    frame_height = img_height
+    {
+      width: frame_width,
+      height: frame_height,
+      margin: "left",
+      length: frame_width,
+      style: "height: " + img_height.to_s + "px"
+    }
+  end
+
+  def vertical(img_width, img_height, frame_count)
+    frame_width = img_width
+    frame_height = img_height / frame_count.to_i
+    {
+      width: frame_width,
+      height: frame_height,
+      margin: "top",
+      length: frame_height,
+      style: "width: " + img_width.to_s + "px"
+    }
+  end
+
+  def guess_orientation(img_width, img_height)
+    img_height > img_width ? :vertical : :horizontal
+  end
+end

data/lib/sprite_animation/sprite_animation_util.rb

@@ -0,0 +1,29 @@
+require 'fastimage'
+require 'uri'
+
+module SpriteAnimationUtil
+  class ImageSize
+    def self.size(image_src)
+      FastImage.size(parse_image_path(image_src), :raise_on_failure => true)
+    end
+
+    private
+
+    def self.parse_image_path(image_src)
+      if uri?(image_src)
+        image_src
+      else
+        ::Rails.root.to_s+"/app/assets/images/#{image_src}"
+      end
+    end
+
+    def self.uri?(string)
+      uri = URI.parse(string)
+      %w( http https ).include?(uri.scheme)
+    rescue URI::BadURIError
+      false
+    rescue URI::InvalidURIError
+      false
+    end
+  end
+end

data/lib/sprite_animation/version.rb

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

data/lib/sprite_animation.rb

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

data/sprite_animation.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sprite_animation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sprite_animation"
+  spec.homepage      = "https://github.com/DanielsLuz/rails-sprite-animation"
+  spec.version       = SpriteAnimation::VERSION
+  spec.authors       = ["DanielsLuz"]
+  spec.email         = ["danielluz1995@gmail.com"]
+
+  spec.summary       = %q{Simple gem for sprite sheet animation}
+  spec.description   = %q{This gem makes it easy adding an animated image given a sprite sheet}
+  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 { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_runtime_dependency "fastimage", "~> 2.0"
+  spec.add_runtime_dependency "jquery-rails", "~> 4.0"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: sprite_animation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- DanielsLuz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: fastimage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: This gem makes it easy adding an animated image given a sprite sheet
+email:
+- danielluz1995@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/sprite_animation.js
+- app/assets/javascripts/sprite_animation_main.js
+- bin/console
+- bin/setup
+- lib/sprite_animation.rb
+- lib/sprite_animation/sprite_animation_helper.rb
+- lib/sprite_animation/sprite_animation_util.rb
+- lib/sprite_animation/version.rb
+- sprite_animation.gemspec
+homepage: https://github.com/DanielsLuz/rails-sprite-animation
+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: Simple gem for sprite sheet animation
+test_files: []
+has_rdoc: