frontend_reload_control 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ce57e3e9006ffd80dacc621415dfb14cbfde14ac
+  data.tar.gz: 85551c793b9859dceae4fe3cc5842a68f6da8f2b
+SHA512:
+  metadata.gz: 6f60e5c9506a030640607d92832988b804a5a52a598b37480ea29d36a88c7d2db263813f0a9cec46092868e0a5fddc46e8e679506828e35f26a6d231952803a1
+  data.tar.gz: ac85e4a58bd720668ad3b8f89f60d81186db22b4a936629932d26db14d9cf3744f945fe66e5ab9c656e8ca2909807dd53a397d28a8c2406c6d9fad61e00c628b

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,33 @@
+# Requirements
+- angular
+- angular-cookies (ngCookies)
+
+
+# Rails setup for angular
+
+Add gem
+```
+gem 'frontend_reload_control'
+```
+
+Add in application.js
+```
+//= require frontend_reload_control
+```
+
+Add on your main modules
+```
+.config(function ($httpProvider) {
+  $httpProvider.interceptors.push('FrontendReloadControlInterceptor')
+})
+```
+
+# Cors (optional)
+
+If your frontend and api has diferents domains you need to configure CORS to expose X-Frontend-Reload-Control-Timestamp header.
+Need help? https://github.com/cyu/rack-cors
+
+# Tips
+This gem will looks for timestamp.txt file on root of project to setup the actual version of app, if it doesn't exists it will use Time.now.to_i at APP startup.
+
+If you want to avoid browser to reload for each APP restarts you need to fill timestamp.txt when you deploy your APP.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/assets/javascripts/frontend_reload_control.js

@@ -0,0 +1,33 @@
+;(function () {
+  'use strict'
+
+  angular.module('frontendReloadControl', []).factory('FrontendReloadControlInterceptor', FrontendReloadControlInterceptor)
+
+  FrontendReloadControlInterceptor.$inject = ['$cookies']
+
+  function FrontendReloadControlInterceptor ($cookies) {
+    var service = {
+      'response': response
+    }
+
+    return service
+
+    function response (res) {
+      var newTimestamp = res.headers('X-Frontend-Reload-Control-Timestamp')
+
+      if (newTimestamp) {
+        var currentTimestamp = $cookies.get('X-Frontend-Reload-Control-Timestamp')
+        if (!currentTimestamp) {
+          console.log("Set New X-Frontend-Reload-Control-Timestamp: " + newTimestamp)
+          $cookies.put('X-Frontend-Reload-Control-Timestamp', newTimestamp)
+        } else if (parseInt(newTimestamp) > parseInt(currentTimestamp)) {
+          console.log("Set New X-Frontend-Reload-Control-Timestamp: " + newTimestamp)
+          $cookies.put('X-Frontend-Reload-Control-Timestamp', newTimestamp)
+          location.reload()
+        }
+      }
+      return res
+    }
+  }
+})()
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "frontend_reload_control"
+
+# 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(__FILE__)

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/frontend_reload_control.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'frontend_reload_control/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "frontend_reload_control"
+  spec.version       = FrontendReloadControl::VERSION
+  spec.authors       = ["Wagner Caixeta"]
+  spec.email         = ["wagner.caixeta@al.go.leg.br"]
+
+  spec.summary       = %q{This gem makes browser to reload the page when the rails APP is updated.}
+  spec.description   = %q{This gem makes browser to reload the page when the rails APP is updated. This is usefull for Single Page APPs.}
+  spec.homepage      = "https://github.com/platbr/frontend_reload_control"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/frontend_reload_control.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+require "frontend_reload_control/version"
+require "frontend_reload_control/rails"
+require "frontend_reload_control/engine"

data/lib/frontend_reload_control/engine.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+module FrontendReloadControl
+  class Engine < ::Rails::Engine
+    engine_name 'FrontendReloadControl'
+    initializer 'FrontendReloadControl.load' do
+      timestamp = File.open('timestamp.txt').read.strip rescue nil
+      timestamp ||= Time.now.to_i.to_s
+      ::Rails.cache.write("X-Frontend-Reload-Control-Timestamp", timestamp)
+      ActiveSupport.on_load :action_controller do
+        include FrontendReloadControl::Rails::Inject
+      end
+    end
+  end
+end

data/lib/frontend_reload_control/rails.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+
+require "frontend_reload_control/rails/helpers"
+require "frontend_reload_control/rails/inject"

data/lib/frontend_reload_control/rails/helpers.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+module FrontendReloadControl
+  module Rails
+    module Helpers
+      def add_frontend_reload_control_timestamp
+        response.headers['X-Frontend-Reload-Control-Timestamp'] = ::Rails.cache.fetch("X-Frontend-Reload-Control-Timestamp")
+      end
+    end
+  end
+end

data/lib/frontend_reload_control/rails/inject.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+module FrontendReloadControl
+  module Rails
+    module Inject
+      def self.included(base)
+        base.send :include, FrontendReloadControl::Rails::Helpers
+        if ::Rails.version.split('.')[0].to_i >= 5
+          base.before_action :add_frontend_reload_control_timestamp
+        else
+          base.before_filter :add_frontend_reload_control_timestamp
+        end
+      end
+    end
+  end
+end

data/lib/frontend_reload_control/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module FrontendReloadControl
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: frontend_reload_control
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wagner Caixeta
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This gem makes browser to reload the page when the rails APP is updated.
+  This is usefull for Single Page APPs.
+email:
+- wagner.caixeta@al.go.leg.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- app/assets/javascripts/frontend_reload_control.js
+- bin/console
+- bin/setup
+- frontend_reload_control.gemspec
+- lib/frontend_reload_control.rb
+- lib/frontend_reload_control/engine.rb
+- lib/frontend_reload_control/rails.rb
+- lib/frontend_reload_control/rails/helpers.rb
+- lib/frontend_reload_control/rails/inject.rb
+- lib/frontend_reload_control/version.rb
+homepage: https://github.com/platbr/frontend_reload_control
+licenses: []
+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.6.8
+signing_key: 
+specification_version: 4
+summary: This gem makes browser to reload the page when the rails APP is updated.
+test_files: []
+has_rdoc: