spin_loader 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b43b7b043e789cc8ab3e8c671c24a9c40b0c4c34
-  data.tar.gz: 608db5a1c5c8f6a0345ba2b0ca39e024e952e523
+  metadata.gz: 42cc6abf5f08ddd69d341fd1cd10299a17fcf353
+  data.tar.gz: 5b13a2c75870bbef3533eaf3b7fb1a933c995308
 SHA512:
-  metadata.gz: 0195fb8b10e17dfd7afc3434b8f9624b8dde291ad52d84a003404548a65698fd87f3ec730f4c06d6a52f79ce6614c611c355be23775b64f000c7a16030ab6dfc
-  data.tar.gz: 30ba9de728a003004ccccc4d852a54205d7471eb54ac79d758db60456bc862bb98f6ca713ae5a4118c0b2e43022c1f280a1cbbaac750cd9afe9dfb80cf634d5f
+  metadata.gz: 742fea7f53ca253bb7ec03e11e41dece8829160f869663013c70a7da714598d3ca6bb79c56817c652e5e4ea0d00aef6fc62a9215b12cf55f50e0811f393bb067
+  data.tar.gz: cfea83c56915e16c49ab399eb304bf1800c91ca8bf2b08014b661bb6aae3a17862d761f9c993f49e38f2026fa0adf317c8a45b98675ff278a62dfb39f01f29bc

data/Gemfile

@@ -2,3 +2,6 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in spin_loader.gemspec
 gemspec
+
+# Use CoffeeScript for .js.coffee assets and views
+gem 'coffee-rails', '~> 4.0.0'

data/README.md

@@ -49,9 +49,18 @@ Now, you have 2 commands, one to start the loader e other to stop the loader.
 // This starts the loader
 root.start_loading()
 
-//This stops the loader
+// This stops the loader
 root.stop_loading()
 ```
+### Configure the Spinner
+
+Run the generator:
+
+    $ rails g spin_loader:install
+
+This will generate the file config/spin_loader_config.yml. Edit this file according to [Spin.js](http://fgnass.github.io/spin.js/).
+
+> For changes on the config file to happen, you need to run rake tmp:clear.
 
 ## Contributing
 

data/app/assets/javascript/spin_loader.coffee.erb

@@ -0,0 +1,43 @@
+#= require spin.min
+#= require_self
+
+root = exports ? this
+
+<% SPIN_LOADER_CONFIG = File.exist?("#{Rails.root}/config/spin_loader_config.yml") ? YAML.load(File.read("#{Rails.root}/config/spin_loader_config.yml"))[Rails.env].symbolize_keys : {lines: 13, length: 6, width: 2, radius: 5, corners: 1, rotate: 0, direction: 1, color: '#b1aea9', speed: 1, trail: 60, shadow: false, hwaccel: false, className: 'spinner', zIndex: 2e9, top: 'auto', left: 'auto'} %>
+
+opts = {
+  lines: <%= SPIN_LOADER_CONFIG[:lines] %>
+  length: <%= SPIN_LOADER_CONFIG[:length] %>
+  width: <%= SPIN_LOADER_CONFIG[:width] %>
+  radius: <%= SPIN_LOADER_CONFIG[:radius] %>
+  corners: <%= SPIN_LOADER_CONFIG[:corners] %>
+  rotate: <%= SPIN_LOADER_CONFIG[:rotate] %>
+  direction: <%= SPIN_LOADER_CONFIG[:direction] %>
+  color: "<%= SPIN_LOADER_CONFIG[:color] %>"
+  speed: <%= SPIN_LOADER_CONFIG[:speed] %>
+  trail: <%= SPIN_LOADER_CONFIG[:trail] %>
+  shadow: <%= SPIN_LOADER_CONFIG[:shadow] %>
+  hwaccel: <%= SPIN_LOADER_CONFIG[:hwaccel] %>
+  className: "<%= SPIN_LOADER_CONFIG[:className] %>"
+  zIndex: <%= SPIN_LOADER_CONFIG[:zIndex] ||= 2e9 %>
+  top: "<%= SPIN_LOADER_CONFIG[:top] %>"
+  left: "<%= SPIN_LOADER_CONFIG[:left] %>"
+}
+
+target = undefined
+spinner = new Spinner(opts).spin()
+
+$ ->
+  $('body').prepend $('<div>').prop('id':'loading_overlay').addClass('loading_overlay')
+  target = $('#loading_overlay')
+  target.append(spinner.el)
+  $('.spinner').css
+    left : '50%'
+    top : '50%'
+  target.hide()
+
+root.start_loading = ->
+  target.fadeIn('fast')
+
+root.stop_loading = ->
+  target.fadeOut('fast')

data/lib/generators/spin_loader/install/USAGE

@@ -0,0 +1,10 @@
+Description:
+    The spin_loader install generator creates a YAML file in your config directory and an initializer to load this config. The config has a separate section for each environment.
+
+    The config is loaded into a constant called SPIN_LOADER_CONFIG by default.
+
+Examples:
+    rails generate spin_loader:install
+
+        Config:      config/spin_loader_config.yml
+        Initializer: config/initializers/load_spin_loader_config.rb

data/lib/generators/spin_loader/install/install_generator.rb

@@ -0,0 +1,12 @@
+module SpinLoader
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def generate_install
+        copy_file 'spin_loader_config.yml', 'config/spin_loader_config.yml'
+      end
+    end
+  end
+end

data/lib/generators/spin_loader/install/templates/spin_loader_config.yml

@@ -0,0 +1,26 @@
+defaults: &defaults
+  lines: 13
+  length: 6
+  width: 2
+  radius: 5
+  corners: 1
+  rotate: 0
+  direction: 1
+  color: '#b1aea9'
+  speed: 1
+  trail: 60
+  shadow: false
+  hwaccel: false
+  className: 'spinner'
+  zIndex: 2e9
+  top: 'auto'
+  left: 'auto'
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+production:
+  <<: *defaults

data/lib/spin_loader/version.rb

@@ -1,3 +1,3 @@
 module SpinLoader
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spin_loader.gemspec

@@ -20,5 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
-  spec.add_dependency 'coffee-rails'
+  spec.add_dependency 'coffee-rails', '~> 4.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spin_loader
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Ariel Schvartz
@@ -42,16 +42,16 @@ dependencies:
   name: coffee-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0
 description: Creates a full screen loader with a background mask based on spin.js
   library. Creates coffeescript helpers.
 email:
@@ -65,8 +65,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- app/assets/javascript/spin_loader.js.coffee
+- app/assets/javascript/spin_loader.coffee.erb
 - app/assets/stylesheet/spin_loader.css.sass
+- lib/generators/spin_loader/install/USAGE
+- lib/generators/spin_loader/install/install_generator.rb
+- lib/generators/spin_loader/install/templates/spin_loader_config.yml
 - lib/spin_loader.rb
 - lib/spin_loader/engine.rb
 - lib/spin_loader/version.rb

data/app/assets/javascript/spin_loader.js.coffee

@@ -1,41 +0,0 @@
-#= require spin.min
-#= require_self
-
-root = exports ? this
-
-opts = {
-  lines: 13
-  length: 6
-  width: 2
-  radius: 5
-  corners: 1
-  rotate: 0
-  direction: 1
-  color: '#b1aea9'
-  speed: 1
-  trail: 60
-  shadow: false
-  hwaccel: false
-  className: 'spinner'
-  zIndex: 2e9
-  top: 'auto'
-  left: 'auto'
-}
-
-target = undefined
-spinner = new Spinner(opts).spin()
-
-$ ->
-  $('body').prepend $('<div>').prop('id':'loading_overlay').addClass('loading_overlay')
-  target = $('#loading_overlay')
-  target.append(spinner.el)
-  $('.spinner').css
-    left : '50%'
-    top : '50%'
-  target.hide()
-
-root.start_loading = ->
-  target.fadeIn('fast')
-
-root.stop_loading = ->
-  target.fadeOut('fast')