snippr 0.15.10 → 0.15.11

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTM3MjI1MmNmMmIxYmEzYTY4Nzk1MjI3MDFlNjVhNzEzZTQyYmFiZA==
+    MGFjMTEwNGFiZTU4OTNmNDczNmZiYjk2MWQxNjFjZDRkOWRjNDlmNA==
   data.tar.gz: !binary |-
-    MjJkYWVmM2Q2ZWVjOGUzNTdjZmY2OGZkMDQ4ODhmYWI4OGY1NmIzNQ==
+    YjE1ZDg5NjZlZDdkOTQzMmZmMDBmMWE1ZTVmZTM5N2NhYTQ5NTE0Nw==
 SHA512:
   metadata.gz: !binary |-
-    OTA3NjY3YmVkODRjZjlkYmJkMzIzNTE5NjY4NThiOTBlMjY2Y2JhYzJhMTQy
-    OGExN2Y4NTBkZjUyNjk1OTYxYTM3YTRjNWNjN2ZmZDFjN2I5OWUzZjRiYzBh
-    NjJjMjJiODQ3MmRkNWZhMzJjMjljNmQ0NDk0NjYyNTg2YzhkYmM=
+    YmRkYWI0YjAzMWJhMWU2ZjE4ZTI5NGFiNGU1YjU0OTYyMzdhODI1MDg5OGJl
+    OWI5YTI4MTFmODM5ZjcyZTQ5ZDg4YzZlZmI1NWMwNTMyMzUxN2EzMWY2NGZj
+    Y2FlYzQxOWMyNjBiMjI4OGZlMjJkZjFkMmVmNGUzZmM1Nzk3N2Q=
   data.tar.gz: !binary |-
-    YjM5NWEyZmM0MDY1OWUzNWZmZWVkNTA4ZTM2NjBjODk4MzBkYjQ2ZjRmNjY0
-    YjQxZjE4NmYzMjFmNjc5OWM3ODAzYmJhODIzYzdkYWMyMzU2OGRiMjcwNDQy
-    ZTY4M2Y2NmUxMWVhZWRkM2QwMWQwYTc0MjQ2NTNhN2EzOThlMTk=
+    OTc3OTY4OTMyNWE4YTFjZWJmMzU2MWE5ODc0MmI3MGQ5ZjY2MTkzYTQwYzQ0
+    YmE0NGEyMTdlMzU5YWVjYjM0MDI0YzU1YTFlNzczODA5NjZiZjUyZDcxYWM4
+    NjU5MzI2M2Q3NjYzNTY2NGU4NGE5MTMyYzRmMjIzZDBiNTUyOGI=

data/README.md

@@ -209,3 +209,30 @@ Edit `application.rb` (or the environment specific files in config/environments)
       # or even for defered configuration with a lambda:
       # config.snippr.path = lambda { SomeClassThatsAvailableLater.path }
     end
+
+## Bigger on the inside
+Starting with 0.15.11 the gem supports rewinding and advancing time to display the state of a webpage on that moment.  
+This is especially useful when using `valid_from` or `valid_to`time based segment filters.
+
+For that to work you need to configure the so called "snippr tardis" to be active.  
+Configuration is done via application.rb like so:
+
+    class Application < Rails::Application
+      config.snippr.tardis_enabled = true # or false or a Proc
+    end
+
+Then call the `snippr_tardis` helper in your view:  
+
+    <%= snippr_tardis if Rails.env.development? %>
+
+You will then see the tardis appear in the upper right corner after a server restart.
+Click on the tardis icon.
+
+Now use one of the following and click "warp":
+
++1d : advance time one day  
+-4d : rewind time four days  
+-7h : rewind time 7 hours  
++10m : advance ten minutes  
+
+You get the idea. Exterminate!

data/lib/app/assets/javascripts/snippr_tardis/snippr_tardis.js

@@ -0,0 +1,19 @@
+$(function snipprTardisScope() {
+  'use strict';
+  var tardis = $('#snippr_tardis');
+
+  tardis.find('button.warp').on('click', function (e) {
+    e.preventDefault();
+    window.location.href = '?snippr_tardis=' + encodeURIComponent(tardis.find('.interval').val());
+  });
+
+  tardis.find('button.reset').on('click', function (e) {
+    e.preventDefault();
+    window.location.href = '?snippr_tardis=0';
+  });
+
+  tardis.find('.tardis').on('click', function (e) {
+    e.preventDefault();
+    tardis.find('.content').toggle();
+  });
+});

data/lib/app/assets/stylesheets/snippr_tardis/snippr_tardis.css

@@ -0,0 +1,33 @@
+#snippr_tardis {
+  background-color: #fff;
+  position: absolute;
+  top: 0;
+  right: 0;
+  padding: 4px 5px 5px 5px;
+  min-height: 18px;
+  border-left: 1px solid #000;
+  border-bottom: 1px solid #000;
+  z-index: 10000;
+}
+
+#snippr_tardis .tardis, #snippr_tardis .headline {
+  float: left;
+}
+
+#snippr_tardis .header {
+  margin-bottom: 5px;
+  overflow: hidden;
+}
+
+#snippr_tardis .hinterval {
+  width: 40px;
+}
+
+#snippr_tardis .current {
+  margin-bottom: 5px;
+}
+
+#snippr_tardis .content {
+  display: none;
+  width: 200px;
+}

data/lib/app/helpers/snippr_tardis_helper.rb

@@ -0,0 +1,6 @@
+# -*- encoding : utf-8 -*-
+module SnipprTardisHelper
+  def snippr_tardis
+    render "partials/snippr_tardis"
+  end
+end

data/lib/app/views/partials/_snippr_tardis.html.erb

@@ -0,0 +1,17 @@
+<%# encoding: utf-8 %>
+<%= stylesheet_link_tag 'snippr_tardis/snippr_tardis' %>
+<%= javascript_include_tag 'snippr_tardis/snippr_tardis' %>
+<div id="snippr_tardis">
+  <div class="header">
+    <%= image_tag("snippr_tardis/icon-close.png", class: "tardis") %>
+    <div class="headline content">
+      Snippr Timewarp:
+    </div>
+  </div>
+  <div class="content">
+    <%= Snippr::Clock.now %>
+    <input class="interval" type="text" placeholder="<%= session[:snippr_tardis_interval] || "+1d" %>" />
+    <button class="warp">Warp</botton>
+    <button class="reset">Reset</botton>
+  </div>
+</div>

data/lib/snippr/rails/controller_extension.rb

@@ -0,0 +1,17 @@
+# -*- encoding : utf-8 -*-
+module Snippr
+  module Rails
+    module ControllerExtension
+
+      private
+
+      def activate_snippr_tardis
+        if params[:snippr_tardis].present?
+          session[:snippr_tardis_interval] = params[:snippr_tardis]
+          Snippr::Clock.interval = session[:snippr_tardis_interval]
+        end
+      end
+
+    end
+  end
+end

data/lib/snippr/railtie.rb

@@ -1,15 +1,32 @@
 # -*- encoding : utf-8 -*-
 module Snippr
-
   class Railtie < Rails::Railtie
 
     config.snippr = ActiveSupport::OrderedOptions.new
 
+    config.before_configuration do |app|
+      app.config.paths["app/helpers"] << File.expand_path("../../app/helpers", __FILE__)
+      app.config.paths["app/views"] << File.expand_path("../../app/views", __FILE__)
+    end
+
     initializer :setup_snippr, :group => :all do |app|
       Snippr.i18n = app.config.snippr.i18n
       Snippr.path = app.config.snippr.path
+      Snippr.tardis_enabled = app.config.snippr.tardis_enabled
+
       Snippr::Normalizer.add app.config.snippr.normalizers if app.config.snippr.normalizers
       Snippr.adjust_urls_except += Array(app.config.snippr.adjust_urls_except) if app.config.snippr.adjust_urls_except
+
+      if Snippr.tardis_enabled
+        require "snippr/rails/controller_extension"
+
+        app.config.paths["app/assets"] << File.expand_path("../../app/assets", __FILE__)
+        app.config.assets.precompile << "snippr_tardis/snippr_tardis.css"
+        app.config.assets.precompile << "snippr_tardis/snippr_tardis.js"
+
+        ActionController::Base.send(:include, Snippr::Rails::ControllerExtension)
+        ActionController::Base.send(:prepend_before_filter, :activate_snippr_tardis)
+      end
     end
 
   end

data/lib/snippr/snippr.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require "logger"
 
 # = Snippr
@@ -18,6 +19,14 @@ module Snippr
     Path.path = path
   end
 
+  def tardis_enabled=(bool_or_block)
+    Tardis.enabled = bool_or_block
+  end
+
+  def tardis_enabled
+    Tardis.enabled
+  end
+
   # Returns whether to use I18n snippr files.
   def i18n?
     I18n.enabled?
@@ -54,7 +63,7 @@ module Snippr
 
   # Lists all snips inside a snippr directory specified by path parts.
   def list(*args)
-    Path.list *args
+    Path.list(*args)
   end
 
 end

data/lib/snippr/tardis.rb

@@ -0,0 +1,16 @@
+# -*- encoding : utf-8 -*-
+module Snippr
+  class Tardis
+    def self.enabled=(bool_or_block)
+      if bool_or_block.kind_of?(Proc)
+        @enabled_condition = bool_or_block
+      else
+        @enabled_condition = -> { !!bool_or_block }
+      end
+    end
+
+    def self.enabled
+      @enabled_condition.call
+    end
+  end
+end

data/lib/snippr.rb

@@ -8,6 +8,7 @@ require 'snippr/links'
 require 'snippr/meta_data'
 require 'snippr/normalizer'
 require 'snippr/path'
+require 'snippr/tardis'
 require 'snippr/processor'
 require 'snippr/railtie' if defined?(Rails)
 require 'snippr/view_helper'

data/snippr.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name        = "snippr"
-  s.version     = "0.15.10"
+  s.version     = "0.15.11"
   s.date        = Time.now
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Daniel Harrington", "Thomas Jachmann", "Frank Schumacher"]
@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rake", "~> 10.0"
 
   unless ENV["CI"]
-    s.add_development_dependency "debugger"
+    s.add_development_dependency "pry-debugger"
   end
 
   s.files         = `git ls-files`.split("\n").reject{ |a| a.start_with?("\"") }

data/spec/snippr/snippr_spec.rb

@@ -15,6 +15,17 @@ describe Snippr do
     subject.path = 'path'
   end
 
+  it "delegates tardis= to Snippr::Tardis.enabled=" do
+    Snippr::Tardis.expects(:enabled=).with(true)
+    subject.tardis_enabled = true
+  end
+
+  it "delegates tardis to Snippr::Tardis.enabled" do
+    Snippr::Tardis.should respond_to(:enabled)
+    Snippr::Tardis.expects(:enabled)
+    subject.tardis_enabled
+  end
+
   it "delegates i18n? to Snippr::I18n.enabled?" do
     Snippr::I18n.should respond_to(:enabled?)
     Snippr::I18n.expects(:enabled?).returns(true)

data/spec/snippr/tardis_spec.rb

@@ -0,0 +1,16 @@
+# -*- encoding : utf-8 -*-
+require "spec_helper"
+
+describe Snippr::Tardis do
+  describe ".enabled=" do
+    it "accepts a block" do
+      Snippr::Tardis.enabled = -> { "truthy" }
+      Snippr::Tardis.enabled.should eq "truthy"
+    end
+
+    it "accepts simple values" do
+      Snippr::Tardis.enabled = "truthy"
+      Snippr::Tardis.enabled.should be_true
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snippr
 version: !ruby/object:Gem::Version
-  version: 0.15.10
+  version: 0.15.11
 platform: ruby
 authors:
 - Daniel Harrington
@@ -97,7 +97,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: debugger
+  name: pry-debugger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
@@ -127,6 +127,11 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- lib/app/assets/images/snippr_tardis/icon-close.png
+- lib/app/assets/javascripts/snippr_tardis/snippr_tardis.js
+- lib/app/assets/stylesheets/snippr_tardis/snippr_tardis.css
+- lib/app/helpers/snippr_tardis_helper.rb
+- lib/app/views/partials/_snippr_tardis.html.erb
 - lib/snippr.rb
 - lib/snippr/clock.rb
 - lib/snippr/i18n.rb
@@ -142,6 +147,7 @@ files:
 - lib/snippr/processor/functions.rb
 - lib/snippr/processor/links.rb
 - lib/snippr/processor/wikilinks.rb
+- lib/snippr/rails/controller_extension.rb
 - lib/snippr/railtie.rb
 - lib/snippr/segment_filter/base.rb
 - lib/snippr/segment_filter/on_host.rb
@@ -151,6 +157,7 @@ files:
 - lib/snippr/segment_parser.rb
 - lib/snippr/snip.rb
 - lib/snippr/snippr.rb
+- lib/snippr/tardis.rb
 - lib/snippr/view_helper.rb
 - snippr.gemspec
 - spec/fixtures/a/path/aSnippet.snip
@@ -190,6 +197,7 @@ files:
 - spec/snippr/segment_parser_spec.rb
 - spec/snippr/snip_spec.rb
 - spec/snippr/snippr_spec.rb
+- spec/snippr/tardis_spec.rb
 - spec/snippr/view_helper_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/blaulabs/snippr
@@ -254,6 +262,7 @@ test_files:
 - spec/snippr/segment_parser_spec.rb
 - spec/snippr/snip_spec.rb
 - spec/snippr/snippr_spec.rb
+- spec/snippr/tardis_spec.rb
 - spec/snippr/view_helper_spec.rb
 - spec/spec_helper.rb
 has_rdoc: