nitrolinks-rails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24302bf169536da10cb236af115866831fa6386f
-  data.tar.gz: e9ce52c3071979143845632d695b42fcadd0e3a5
+  metadata.gz: 02876071ee063c5549016d3b2067f0d2556b0e19
+  data.tar.gz: 854ba5bc3278599e9ba3875bec3bd1fb21cfe526
 SHA512:
-  metadata.gz: 349d7988a2ec9060822049d635eb21b3f0b6349d0b4efffbce8314e443fa00886ce81f0de5408eb8b76e60dc87809367dcd30e588aff681a61f8693c91debebc
-  data.tar.gz: c2117dc35daaaaba0e7755e37d37ad8ce5f818fd731d6184ef41a3d17c512060f833f30e65478467a103a68f6cf8879052cbae07cbda7c6e146ee1ecce6c137f
+  metadata.gz: 0163b8b372e197a13b997ca96fd0cb929c6cd187b63b32f789d5e64036d270b82c0ffd306bf8141f358dedd212a32e35364e333cd9c444fc6c57ae25ec381299
+  data.tar.gz: 08facc91ca92d4f09d0c3d047e820bdbf296ac583c07c3886ef4be89ed5c683661019aa6aabca9bfed030d07d87abee2c5f1d17e927e09a201cc244488d6b64d

data/.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 /.bundle/
 /.yardoc
 /Gemfile.lock
@@ -7,3 +8,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+features/dummy/db/*.sqlite3
+features/dummy/db/*.sqlite3-journal
+features/dummy/log/*.log
+features/dummy/tmp/

data/Gemfile

@@ -1,4 +1,18 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in nitrolinks-rails.gemspec
 gemspec
+
+group :test do
+  gem "cucumber-rails", ">= 1.5.0", require: false
+  gem 'selenium-webdriver'
+  gem 'chromedriver-helper', '>= 1.1.0'
+end
+
+group :test, :development do
+  gem "slim-rails", "~> 3.1"
+  gem 'sass-rails', '~> 5.0'
+  gem 'coffee-rails', '~> 4.2'
+end
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Wayne Duran
+
+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

@@ -19,11 +19,11 @@ gem 'nitrolinks-rails'
 
 And then execute:
 
-    $ bundle
+$ bundle
 
 Or install it yourself as:
 
-    $ gem install nitrolinks-rails
+$ gem install nitrolinks-rails
 
 ## Usage
 

data/Rakefile

@@ -1,2 +1,24 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Nitrolinks::Rails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../features/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+

data/app/assets/javascripts/nitrolinks/testing.coffee

@@ -0,0 +1,195 @@
+whenReady = (fn) ->
+  if (if document.attachEvent then document.readyState == 'complete' else document.readyState != 'loading')
+    fn()
+  else
+    document.addEventListener "DOMContentLoaded", ->
+      fn()
+
+select = (selector) ->
+  selectAll(selector)[0]
+
+selectAll = (selector) ->
+  document.querySelectorAll(selector)
+
+eventListen = (event, handler) ->
+  document.addEventListener event, (e) ->
+    handler.call document, e
+
+last = (collection) ->
+  if collection.length > 0
+    collection[collection.length - 1]
+
+class NitrolinksTesting
+  constructor: (@window, @document) ->
+    @active = false
+    @store = new NitrolinksTestStore(@window.localStorage)
+    @domLoadKey = 'nitroDomLoad'
+    @fetchLoadKey = 'nitroFetchLoad'
+    @cacheLoadKey = 'nitroCacheLoad'
+    @loadCount = 0
+    @errors = []
+
+  init: ->
+    @listen()
+
+  body: ->
+    select('body')
+
+  markAsLoading: (from)->
+    @active = true
+    @body().classList.add('testing-visiting')
+
+  markAsDoneLoading: ->
+    @active = false
+    @body().classList.remove('testing-visiting')
+
+  listen: ->
+    eventListen 'nitrolinks:visit', =>
+      @markAsLoading('nitrolinks:visit')
+
+    loads = (e) =>
+      @loadCount += 1
+      @markAsDoneLoading()
+      @showDebugData()
+
+    eventListen 'nitrolinks:load', loads
+    eventListen 'nitrolinks:load-blank', loads
+
+    eventListen 'nitrolinks:load-from-fetch', (e) =>
+      @addToFetched(e.detail.url)
+
+    eventListen 'nitrolinks:load-from-cache', (e) =>
+      @addToCached(e.detail.url)
+
+    @window.addEventListener 'error', (e) =>
+      @addToErrors(e)
+
+    whenReady =>
+      return unless select('#nitro-debugging')
+      @addToLoaded(@window.location.href)
+      @showDebugData()
+      @markAsDoneLoading()
+
+  addToFetched: (url) ->
+    @addToArrayStored(@fetchLoadKey, url)
+
+  addToLoaded: (url) ->
+    @addToArrayStored(@domLoadKey, url)
+
+  addToCached: (url) ->
+    @addToArrayStored(@cacheLoadKey, url)
+
+  addToArrayStored: (key, input) ->
+    loads = @store.get(key, [])
+    loads.push input
+    @store.set(key, loads)
+
+  addToErrors: (e) ->
+    if e.error
+      @errors.push e.error.message
+    else
+      @errors.push e
+    console.log e
+    @loadShowerFromCollection(@errorsEl(), @errors)
+
+  showDebugData: ->
+    if select('#nitro-debugging')
+      @showNitroLoadCount()
+      @showDomLoads()
+      @showFetchLoads()
+      @showCacheLoads()
+
+  showNitroLoadCount: ->
+    select('#nitro-debugging .nitro-load-count').textContent = @loadCount
+
+  errorsEl: ->
+    select('#nitro-debugging .javascript-errors')
+
+  domEl: ->
+    select('#nitro-debugging .dom-loads')
+
+  showDomLoads: ->
+    @loadShowerFromCollection(@domEl(), @errors)
+
+  loadShower: ($el, storeKey) ->
+    @loadShowerFromCollection($el, @store.get(storeKey, []))
+
+  loadShowerFromCollection: ($el, loads) ->
+    htmlStr = ''
+    for load in loads
+      htmlStr += "<li>#{load}</li>"
+    $el.innerHTML = htmlStr
+
+  fetchEl: ->
+    select('#nitro-debugging .fetch-loads')
+
+  showFetchLoads: ->
+    @loadShower(@fetchEl(), @fetchLoadKey)
+
+  cacheEl: ->
+    select('#nitro-debugging .cache-loads')
+
+  showCacheLoads: ->
+    @loadShower(@cacheEl(), @cacheLoadKey)
+
+  clearDomLoads: ->
+    @store.remove(@domLoadKey)
+    @clearSessionLoads()
+
+  clearSessionLoads: ->
+    @store.remove(@fetchLoadKey)
+    @store.remove(@cacheLoadKey)
+
+  domLoadCount: ->
+    @store.get(@domLoadKey, []).length
+
+  isPageFetched: (path) ->
+    @compareItem(@fetchEl(), path)
+
+  isPageNormallyLoaded: (path) ->
+    @compareItem(@domEl(), path, (item) ->
+      @urlPath(item.textContent)
+    )
+
+  isPageCacheRestored: (path) ->
+    @compareItem(@cacheEl(), path)
+
+  compareItem: (el, path, comparator) ->
+    comparator ||= (item) ->
+      item.textContent
+    lastItem = last(el.querySelectorAll('li'))
+    if lastItem
+      comparator(lastItem) == path
+    else
+      false
+
+  urlPath: (urlStr) ->
+    url = new URL(urlStr)
+    if url.origin == url.toString()
+      url.pathname
+    else
+      url.toString().replace(url.origin, '')
+
+  hasJavascriptErrors: ->
+    @errorsEl().querySelectorAll('li').length > 0
+
+class NitrolinksTestStore
+  constructor: (@localStore) ->
+
+  set: (key, value) ->
+    @localStore.setItem(key, JSON.stringify(value))
+
+  get: (key, def = null) ->
+    stored = @localStore.getItem(key)
+    if stored
+      JSON.parse stored
+    else
+      def
+
+  remove: (key) ->
+    @localStore.removeItem(key)
+
+whenReady =>
+  @nitroTesting = new NitrolinksTesting(window, document)
+  @nitroTesting.init()
+

data/bin/rails

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/nitrolinks/rails/engine', __FILE__)
+APP_PATH = File.expand_path('../../features/dummy/config/application', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+# Pick the frameworks you want:
+require "action_controller/railtie"
+require "action_view/railtie"
+require "sprockets/railtie"
+
+require 'rails/engine/commands'

data/config/cucumber.yml

@@ -0,0 +1,8 @@
+<%
+rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
+rerun_opts = rerun.to_s.strip.empty? ? "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
+std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} --strict --tags 'not @wip'"
+%>
+default: <%= std_opts %> features
+wip: --tags @wip:3 --wip features
+rerun: "<%= rerun_opts %> --format rerun --out rerun.txt --strict --tags 'not @wip'"

data/lib/nitrolinks/rails/version.rb

@@ -1,5 +1,5 @@
 module Nitrolinks
   module Rails
-    VERSION = "0.1.0"
+    VERSION = '0.2.0'
   end
 end

data/lib/tasks/cucumber.rake

@@ -0,0 +1,76 @@
+# IMPORTANT: This file is generated by cucumber-rails - edit at your own peril.
+# It is recommended to regenerate this file in the future when you upgrade to a
+# newer version of cucumber-rails. Consider adding your own code to a new file
+# instead of editing this one. Cucumber will automatically load all features/**/*.rb
+# files.
+
+
+unless ARGV.any? {|a| a =~ /^gems/} # Don't load anything when running the gems:* tasks
+
+vendored_cucumber_bin = Dir["#{Rails.root}/vendor/{gems,plugins}/cucumber*/bin/cucumber"].first
+$LOAD_PATH.unshift(File.dirname(vendored_cucumber_bin) + '/../lib') unless vendored_cucumber_bin.nil?
+
+begin
+  require 'cucumber/rake/task'
+
+  namespace :cucumber do
+    Cucumber::Rake::Task.new({:ok => 'test:prepare'}, 'Run features that should pass') do |t|
+      t.binary = vendored_cucumber_bin # If nil, the gem's binary is used.
+      t.fork = true # You may get faster startup if you set this to false
+      t.profile = 'default'
+    end
+
+    Cucumber::Rake::Task.new({:wip => 'test:prepare'}, 'Run features that are being worked on') do |t|
+      t.binary = vendored_cucumber_bin
+      t.fork = true # You may get faster startup if you set this to false
+      t.profile = 'wip'
+    end
+
+    Cucumber::Rake::Task.new({:rerun => 'test:prepare'}, 'Record failing features and run only them if any exist') do |t|
+      t.binary = vendored_cucumber_bin
+      t.fork = true # You may get faster startup if you set this to false
+      t.profile = 'rerun'
+    end
+
+    desc 'Run all features'
+    task :all => [:ok, :wip]
+
+    task :statsetup do
+      require 'rails/code_statistics'
+      ::STATS_DIRECTORIES << %w(Cucumber\ features features) if File.exist?('features')
+      ::CodeStatistics::TEST_TYPES << "Cucumber features" if File.exist?('features')
+    end
+
+    task :annotations_setup do
+      Rails.application.configure do
+        if config.respond_to?(:annotations)
+          config.annotations.directories << 'features'
+          config.annotations.register_extensions('feature') { |tag| /#\s*(#{tag}):?\s*(.*)$/ }
+        end
+      end
+    end
+  end
+  desc 'Alias for cucumber:ok'
+  task :cucumber => 'cucumber:ok'
+
+  task :default => :cucumber
+
+  task :features => :cucumber do
+    STDERR.puts "*** The 'features' task is deprecated. See rake -T cucumber ***"
+  end
+
+  # In case we don't have the generic Rails test:prepare hook, append a no-op task that we can depend upon.
+  task 'test:prepare' do
+  end
+
+  task :stats => 'cucumber:statsetup'
+
+  task :notes => 'cucumber:annotations_setup'
+rescue LoadError
+  desc 'cucumber rake task not available (cucumber not installed)'
+  task :cucumber do
+    abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+  end
+end
+
+end

data/nitrolinks-rails.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |spec|
   spec.summary       = "Single-page Apps feel with less overhead"
   spec.description   = "Like Pjax and Turbolinks but with smarter DOM updating"
   spec.homepage      = "https://github.com/asartalo/nitrolinks-rails"
+  spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -19,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rails", "~> 5.1"
+  spec.add_dependency 'coffee-rails', '~> 4.2'
 
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nitrolinks-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Wayne Duran
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-19 00:00:00.000000000 Z
+date: 2017-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -77,18 +91,24 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
+- MIT-LICENSE
 - README.md
 - Rakefile
 - app/assets/javascripts/nitrolinks.coffee
+- app/assets/javascripts/nitrolinks/testing.coffee
 - app/assets/javascripts/nitrolinks/utilities.coffee
+- bin/rails
+- config/cucumber.yml
 - lib/nitrolinks/rails.rb
 - lib/nitrolinks/rails/controller.rb
 - lib/nitrolinks/rails/engine.rb
 - lib/nitrolinks/rails/version.rb
+- lib/tasks/cucumber.rake
 - nitrolinks-rails.gemspec
 - vendor/assets/javascripts/set-dom.js
 homepage: https://github.com/asartalo/nitrolinks-rails
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []