ticker-rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1a7f49e8f310991b5d61ea4a39ac05fd6fd9862
+  data.tar.gz: febec768144770551ca7b307679e7e0580301785
+SHA512:
+  metadata.gz: 833b8f95e238c2068806fc3d6c8e8431e093b5fa8d0d8f716bdb45c6c38da47459ace9e339f1296abcba2de053915772cf5d7b5ae5271d6d46c729331f80dcb2
+  data.tar.gz: 3d40d8feeb78fc9cbb5a6fd33ed34c0b4391f7b0bcb35e5e4e8734e2b320721c7eb3958b068632221649802991521e19b99aea30bb52694ce6dafbb8105315b5

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+

data/Dockerfile

@@ -0,0 +1,35 @@
+# How to use it
+# =============
+#
+# Visit http://blog.zedroot.org/using-docker-to-maintain-a-ruby-gem/
+
+# ~~~~ Image base ~~~~
+# Base image with the latest Ruby only
+FROM litaio/ruby:2.2.2
+MAINTAINER Guillaume Hain zedtux@zedroot.org
+
+
+# ~~~~ Set up the environment ~~~~
+ENV DEBIAN_FRONTEND noninteractive
+
+# ~~~~ OS Maintenance ~~~~
+RUN apt-get update && apt-get install -y git
+
+# ~~~~ Rails Preparation ~~~~
+# Rubygems and Bundler
+RUN touch ~/.gemrc && \
+  echo "gem: --no-ri --no-rdoc" >> ~/.gemrc && \
+  gem install rubygems-update && \
+  update_rubygems && \
+  gem install bundler && \
+  mkdir -p /gem/
+
+WORKDIR /gem/
+ADD . /gem/
+RUN bundle install
+
+# Import the gem source code
+VOLUME .:/gem/
+
+ENTRYPOINT ["bundle", "exec"]
+CMD ["rake", "-T"]

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sammerset
+
+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.

data/README.md

@@ -0,0 +1,43 @@
+# Ticker-Rails
+
+This Gem integrates https://github.com/BenjaminRH/jquery-ticker. The original has no public Github Repo, issues tracking etc.
+
+It integrates this fork with your Rails project and is versioned to track the fork's version.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ticker-rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ticker-rails
+
+## Usage
+
+This gem uses a Rails Engine to make JQuery ticker assets available to you.
+
+Require the JavaScript files from your `application.js` or wherever needed using:
+
+```
+//= require ticker-slider
+```
+
+Require the CSS files from your `application.scss` or wherever needed using:
+
+```
+*= require ticker-slider
+```
+
+## Contributing
+
+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`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler/gem_tasks'
+require 'fileutils'
+
+desc 'Update the JQuery ticker Javascript and CSS files'
+task :update_slider do
+  def download_slider(version)
+    base_url = 'https://github.com/BenjaminRH/jquery-ticker'
+    puts "Downlading JQuery ticker #{version} ..."
+    `curl -o vendor/assets/javascripts/jquery-ticker.js \
+      #{base_url}/jquery.ticker.js`
+  end
+
+  FileUtils.mkdir_p('vendor/assets/javascripts')
+  FileUtils.mkdir_p('vendor/assets/stylesheets')
+  download_slider(TickerRails::Rails::VERSION)
+  puts "\e[32mDone!\e[0m"
+end

data/lib/ticker-rails.rb

@@ -0,0 +1,9 @@
+require 'ticker-rails/version'
+
+module TickerRails
+  module Rails
+    class Engine < ::Rails::Engine
+      # Make assets avaiable
+    end
+  end
+end

data/lib/ticker-rails/version.rb

@@ -0,0 +1,5 @@
+module TickerRails
+  module Rails
+    VERSION = '1.0.0'
+  end
+end

data/ticker-rails.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ticker-rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ticker-rails'
+  spec.version       = TickerRails::Rails::VERSION
+  spec.authors       = ['Sammerset']
+  spec.email         = ['sammerset@ukr.net']
+  spec.description   = %q{Make JQuery ticker available to Rails}
+  spec.summary       = %q{This Gem integrates BenjaminRH's fork of JQuery ticker
+                          with Rails, exposing its JavaScript and CSS assets via
+                          a Rails Engine.}
+  spec.homepage      = 'http://github.com/sammerset/ticker-rails'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'railties', '>= 3.2', '< 5.0'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/vendor/assets/javascripts/ticker-rails.js

@@ -0,0 +1,302 @@
+/*!
+ * jQuery Ticker Plugin v1.2.1
+ * https://github.com/BenjaminRH/jquery-ticker
+ * https://github.com/sammerset/ticker-rails
+ *
+ * Copyright 2014 Benjamin Harris
+ * Released under the MIT license
+ */
+(function($) {
+
+    // The ticker plugin
+    $.fn.ticker = function(options) {
+        // Extend our defaults with user-specified options
+        var opts = $.extend({}, $.fn.ticker.defaults, options);
+
+        // Handle each of the given containers
+        return this.each(function () {
+            // Setup the ticker elements
+            var tickerContainer = $(this);                     // Outer-most ticker container
+            var headlineContainer;                             // Inner headline container
+            var headlineElements = tickerContainer.find('li'); // Original headline elements
+            var headlines = [];                                // List of all the headlines
+            var headlineTagMap = {};                           // Maps the indexes of the HTML tags in the headlines to the headline index
+            var outerTimeoutId;                                // Stores the outer ticker timeout id for pauses
+            var innerTimeoutId;                                // Stores the inner ticker timeout id for pauses
+            var currentHeadline = 0;                           // The index of the current headline in the list of headlines
+            var currentHeadlinePosition = 0;                   // The index of the current character in the current headline
+            var firstOuterTick = true;                         // Whether this is the first time doing the outer tick
+            var firstInnerTick = true;                         // Whether this is the first time doing the inner tick in this rendition of the outer one
+
+            var allowedTags = ['a', 'b', 'strong', 'span', 'i', 'em', 'u'];
+
+            if (opts.finishOnHover || opts.pauseOnHover) {
+                // Setup monitoring hover state
+                tickerContainer.removeClass('hover');
+                tickerContainer.hover(function() {
+                    $(this).toggleClass('hover');
+                });
+            }
+
+            // Save all the headline text
+            var h, l;
+            headlineElements.each(function (index, element) {
+                h = stripTags($(this).html(), allowedTags); // Strip all but the allowed tags
+                l = locateTags(h); // Get the locations of the allowed tags
+                h = stripTags(h); // Remove all of the HTML tags from the headline
+                headlines.push(h); // Add the headline to the headlines list
+                headlineTagMap[headlines.length - 1] = l; // Associate the tag map with the headline
+            });
+
+            // Randomize?
+            if (opts.random) shuffleArray(headlines);
+
+            // Now delete all the elements and add the headline container
+            tickerContainer.find('ul').after('<div></div>').remove();
+            headlineContainer = tickerContainer.find('div');
+
+            // Function to actually do the outer ticker, and handle pausing
+            function outerTick() {
+                firstInnerTick = true;
+
+                if (firstOuterTick) {
+                    firstOuterTick = false;
+                    innerTick();
+                    return;
+                }
+
+                outerTimeoutId = setTimeout(function () {
+                    if (opts.pauseOnHover && tickerContainer.hasClass('hover')) {
+                        // User is hovering over the ticker and pause on hover is enabled
+                        clearTimeout(innerTimeoutId);
+                        outerTick();
+                        return;
+                    }
+
+                    innerTick();
+                }, opts.itemSpeed);
+            }
+
+            // Function to handle the ticking for individual headlines
+            function innerTick() {
+                if (firstInnerTick) {
+                    firstInnerTick = false;
+                    tick();
+                    return;
+                }
+
+                if (currentHeadlinePosition > headlines[currentHeadline].length) {
+                    advance();
+                    return;
+                }
+
+                if (opts.finishOnHover && opts.pauseOnHover && tickerContainer.hasClass('hover') && currentHeadlinePosition <= headlines[currentHeadline].length) {
+                    // Let's quickly complete the headline
+                    // This is outside the timeout because we want to do this instantly without the pause
+
+                    // Update the text
+                    headlineContainer.html(getCurrentTick());
+                    // Advance our position
+                    currentHeadlinePosition += 1;
+
+                    innerTick();
+                    return;
+                }
+                else {
+                    // Handle as normal
+                    innerTimeoutId = setTimeout(function () {
+                        if (opts.pauseOnHover && tickerContainer.hasClass('hover')) {
+                            // User is hovering over the ticker and pause on hover is enabled
+                            clearTimeout(innerTimeoutId);
+                            innerTick();
+                            return;
+                        }
+
+                        tick();
+                        advance();
+                    }, opts.cursorSpeed);
+                }
+            }
+
+            function advance() {
+                // Advance headline and reset character position, if it's at the end of the current headline
+                if (currentHeadlinePosition > headlines[currentHeadline].length) { // > here and not == because the ticker cursor takes an extra loop
+                    currentHeadline += 1;
+                    currentHeadlinePosition = 0;
+
+                    // Reset the headline and character positions if we've cycled through all the headlines
+                    if (currentHeadline == headlines.length) currentHeadline = 0;
+
+                    // STOP! We've advanced a headline. Now we just need to pause.
+                    clearTimeout(innerTimeoutId);
+                    clearTimeout(outerTimeoutId);
+                    outerTick();
+                }
+            }
+
+            // Do the individual ticks
+            function tick() {
+                // Now let's update the ticker with the current tick string
+                if (currentHeadlinePosition === 0 && opts.fade) {
+                    clearTimeout(innerTimeoutId);
+
+                    // Animate the transition if it's enabled
+                    headlineContainer.fadeOut(opts.fadeOutSpeed, function () {
+                        // Now it's faded out, let's update the text
+                        headlineContainer.html(getCurrentTick());
+                        // And fade in
+                        headlineContainer.fadeIn(opts.fadeInSpeed, function () {
+                            // Advance our position
+                            currentHeadlinePosition += 1;
+                            // And now we're in, let's start the thing off again without the delay
+                            innerTick();
+                        });
+                    });
+                }
+                else {
+                    // Update the text
+                    headlineContainer.html(getCurrentTick());
+                    // Advance our position
+                    currentHeadlinePosition += 1;
+                    clearTimeout(innerTimeoutId);
+                    innerTick();
+                }
+            }
+
+            // Get the current tick string
+            function getCurrentTick() {
+                var cursor, i, j, location;
+                switch (currentHeadlinePosition % 2) {
+                    case 1:
+                        cursor = opts.cursorOne;
+                        break;
+                    case 0:
+                        cursor = opts.cursorTwo;
+                        break;
+                }
+
+                // Don't display the cursor this was the last character of the headline
+                if (currentHeadlinePosition >= headlines[currentHeadline].length) cursor = '';
+
+                // Generate the headline
+                var headline = '';
+                var openedTags = [];
+                for (i = 0; i < currentHeadlinePosition; i++) {
+                    location = null;
+                    // Check to see if there's meant to be a tag at this index
+                    for (j = 0; j < headlineTagMap[currentHeadline].length; j++) {
+                        // Find a tag mapped to this location, if one exists
+                        if (headlineTagMap[currentHeadline][j] && headlineTagMap[currentHeadline][j].start === i) {
+                            location = headlineTagMap[currentHeadline][j]; // It does exist!
+                            break;
+                        }
+                    }
+
+                    if (location) {
+                        // Add the tag to the headline
+                        headline += location.tag;
+
+                        // Now deal with the tag for proper HTML
+                        if (! location.selfClosing) {
+                            if (location.tag.charAt(1) === '/') {
+                                openedTags.pop();
+                            }
+                            else {
+                                openedTags.push(location.name);
+                            }
+                        }
+                    }
+
+                    // Add the character to the headline
+                    headline += headlines[currentHeadline][i];
+                }
+
+                // Now close the tags, if we need to (because it hasn't finished with all the text in the tag)
+                for (i = 0; i < openedTags.length; i++) {
+                    headline += '</' + openedTags[i] + '>';
+                }
+
+                return headline + cursor;
+            }
+
+            // Start it
+            outerTick();
+        });
+    };
+
+    /**
+     * Randomize array element order in-place.
+     * Using Fisher-Yates shuffle algorithm.
+     */
+    function shuffleArray(array) {
+        for (var i = array.length - 1; i > 0; i--) {
+            var j = Math.floor(Math.random() * (i + 1));
+            var temp = array[i];
+            array[i] = array[j];
+            array[j] = temp;
+        }
+        return array;
+    }
+
+    /**
+     * Strip all HTML tags from a string.
+     * An array of safe tags can be passed, which will not be
+     * stripped from the string with the rest of the tags.
+     */
+    function stripTags(text, safeTags) {
+        safeTags = safeTags || [];
+        var tags = /<\/?([a-z][a-z0-9]*)\b[^>]*>/img;
+        var comments = /<!--.*?-->/img;
+        return text.replace(comments, '').replace(tags, function (a, b) {
+            return safeTags.indexOf(b.toLowerCase()) !== -1 ? a : '';
+        });
+    }
+
+    /**
+     * Locates all of the requested tags in a string.
+     */
+    function locateTags(text, tagList) {
+        tagList = tagList || [];
+        var tags = /<\/?([a-z][a-z0-9]*)\b[^>]*>/im;
+        var selfClosing = /\/\s{0,}>$/m;
+        var locations = [];
+        var match, location;
+
+        while ((match = tags.exec(text)) !== null) {
+            if (tagList.length === 0 || tagList.indexOf(match[1]) !== -1) {
+                location = {
+                    tag: match[0],
+                    name: match[1],
+                    selfClosing: selfClosing.test(match[0]),
+                    start: match.index,
+                    end: match.index + match[0].length - 1
+                };
+                locations.push(location);
+
+                // Now remove this tag from the string
+                // so that each location will represent it in a string without any of the tags
+                text = text.slice(0, location.start) + text.slice(location.end + 1);
+
+                // Reset the regex
+                tags.lastIndex = 0;
+            }
+        }
+
+        return locations;
+    }
+
+    // Plugin default settings
+    $.fn.ticker.defaults = {
+        random:        false, // Whether to display ticker items in a random order
+        itemSpeed:     3000,  // The pause on each ticker item before being replaced
+        cursorSpeed:   50,    // Speed at which the characters are typed
+        pauseOnHover:  true,  // Whether to pause when the mouse hovers over the ticker
+        finishOnHover: true,  // Whether or not to complete the ticker item instantly when moused over
+        cursorOne:     '_',   // The symbol for the first part of the cursor
+        cursorTwo:     '-',   // The symbol for the second part of the cursor
+        fade:          true,  // Whether to fade between ticker items or not
+        fadeInSpeed:   600,   // Speed of the fade-in animation
+        fadeOutSpeed:  300    // Speed of the fade-out animation
+    };
+
+})(jQuery);

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: ticker-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sammerset
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Make JQuery ticker available to Rails
+email:
+- sammerset@ukr.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Dockerfile
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ticker-rails.rb
+- lib/ticker-rails/version.rb
+- ticker-rails.gemspec
+- vendor/assets/javascripts/ticker-rails.js
+homepage: http://github.com/sammerset/ticker-rails
+licenses:
+- MIT
+metadata: {}
+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: This Gem integrates BenjaminRH's fork of JQuery ticker with Rails, exposing
+  its JavaScript and CSS assets via a Rails Engine.
+test_files: []