tell-them 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f882c372fb43f905bc91fe9122f45b28fa9a395
+  data.tar.gz: c6d75ccc1115649c8ef1b7a9640f9efe6b842f48
+SHA512:
+  metadata.gz: 1c469feecc9cf35294b312d9db72a0473dfebdbc1ae705161a69fb57a8ceb76da6b7b8b3e807ed99a8d2830e321aaf3e9abc266c5b8c3745322c65c0789bfbae
+  data.tar.gz: e508c5162dadd4169b19ea4fb6bfc7219f7b59eb5faf6cc9d8d93bdc7f00332991e3d60c1aaf91849ddd5687ecc3ada72d4d3ba3c5951d7d4916ef31612c3a2b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/README.md

@@ -0,0 +1,57 @@
+# TellThem
+
+> Well, OK. But I don't want people thinking we're
+> robo-sexuals, so if anyone asks, you're my debugger.
+>
+> -- <cite>Bender, Futurama</cite>
+
+TellThem is a drop-in development aid for rails that puts a nice hovering box over any page which you want to provide debug information for.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tell-them'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tell-them
+
+## Usage
+
+You'll need to include the tell-them style file in app/assets/stylesheets/application.scss,
+
+```
+ //= require tell-them
+```
+
+...and add a line into your layout (say in apps/views/layouts/application.html.erb) that will insert the necessary HTML:
+
+```
+<%= TellThem.html %>
+```
+
+[OPTIONAL] add the script files in app/assets/javascripts/application.js (TellThem doesn't need the javascript to work, but it enables a few nice features like saved prefs, choosing the position of the pop-up debugging box and allowing you to pin it open)
+
+```
+ //= require tell-them
+```
+
+When all that's done, TellThem is ready to use! Whenever you want to expose internal data from the controller to the developer in the webpage, just add it as one or more key:value pairs using a map:
+
+```
+TellThem.add(this: 'this is some data!', :'Become Admin' => '/become_admin?source=tell-them')
+```
+
+This data will now appear in a little pop-up box on the webpage. Note that the popup box will only appear if Rails.env.development? is true, and it will only appear if at some point in rendering of the page some data has been added with TellThem.add()
+
+* No data? No box
+* In production/staging/test? No box
+
+If the value of any item will parse as a URI, TellThem will wrap it in a link so that it's clickable.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/app/assets/javascripts/tell-them.js.coffee

@@ -0,0 +1,41 @@
+load_prefs = ->
+  prefs = JSON.parse(localStorage.getItem("tellThemPrefs"))
+  return if !prefs?
+  $('#tell-them-box').removeClass('pinned')
+  if prefs.pinned == 1
+  	$('#tell-them-box').addClass('pinned')
+  	$('#tell-them-box .controls .pin').text('Unpin')
+  $('#tell-them-box').addClass(prefs.corner)
+  $('#tell-them-box .controls .corners button').removeClass('current')
+  $('#tell-them-box .controls .corners button[data-target-corner=' + prefs.corner +  ']').addClass('current')
+
+save_prefs = ->
+  pin_value = 0
+  if $('#tell-them-box').hasClass('pinned')
+  	pin_value = 1
+  prefs = {
+  	corner: $('#tell-them-box .controls .corners button.current').data('target-corner'),
+  	pinned: pin_value
+  }
+  localStorage.setItem("tellThemPrefs", JSON.stringify(prefs))
+
+change_corners = (e) ->
+  $('#tell-them-box').removeClass('top-left top-right bottom-left bottom-right')
+  $('#tell-them-box .controls .corners button').removeClass('current')
+  $(this).addClass('current')
+  $('#tell-them-box').addClass($(this).data('target-corner'))
+  save_prefs()
+
+toggle_pin = (e) ->
+  $('#tell-them-box').toggleClass('pinned')
+  if $('#tell-them-box').hasClass('pinned')
+  	$('#tell-them-box .controls .pin').text('Unpin')
+  else
+  	$('#tell-them-box .controls .pin').text('Pin')
+  save_prefs()
+
+$ ->
+  load_prefs()
+  $('#tell-them-box .controls .corners button').on 'click', change_corners
+  $('#tell-them-box .controls .pin').on 'click', toggle_pin
+  $('#tell-them-box .controls').css('display', 'block')

data/app/assets/stylesheets/tell-them.sass

@@ -0,0 +1,110 @@
+=positionable-box($distance)
+	position: fixed
+	bottom: $distance
+	right: $distance
+	border-radius: 1em
+	box-sizing: border-box
+	box-shadow: 0.1em 0.1em 0.5em rgba(128,64,0,0.3)
+	background-color: orange
+	&.top-right
+		top: $distance
+		right: $distance
+		bottom: initial
+		left: initial
+	&.top-left
+		top: $distance
+		left: $distance
+		bottom: initial
+		right: initial
+	&.bottom-right
+		bottom: $distance
+		right: $distance
+		top: initial
+		left: initial
+	&.bottom-left
+		bottom: $distance
+		left: $distance
+		top: initial
+		right: initial
+
+$pad: 2%
+
+#tell-them-box
+	+positionable-box($pad)
+	width: 5%
+	padding-top: 1em
+	cursor: pointer
+	box-shadow: 0.2em 0.2em 1em rgba(128,64,0,0.8)
+	-webkit-transition: width 0.1s height 0.1s
+	transition: width 0.1s height 0.1s
+	text-align: center
+	&:before
+		content: "?"
+		color: white
+		font-size: 32pt
+		font-weight: bold
+	.contents
+		display: none
+		.controls
+			display: none
+			position: relative
+			margin: $pad
+			border-radius: 1em
+			padding: $pad
+			background-color: white
+			.corners
+				position: relative
+				width: 2em
+				height: 2em
+				button
+					position: absolute
+					width: 50%
+					height: 50%
+					border: 1px solid black
+					background-color: white
+					cursor: pointer
+					&.current
+						background-color: black
+					&:hover
+						background-color: gray
+					&[data-target-corner="top-left"]
+						top: 0
+						left: 0
+					&[data-target-corner="top-right"]
+						top: 0
+						right: 0
+					&[data-target-corner="bottom-left"]
+						bottom: 0
+						left: 0
+					&[data-target-corner="bottom-right"]
+						bottom: 0
+						right: 0
+			.pin
+				position: absolute
+				top: 40%
+				right: $pad
+				border-radius: $pad
+				background-color: white
+				color: black
+				cursor: pointer
+		dl
+			text-align: left
+			margin: $pad
+			border-radius: 1em
+			padding: $pad
+			background-color: white
+			dt
+				font-weight: bold
+	&:hover, &.pinned
+		cursor: default
+		width: 50%
+		&:before
+			display: none
+		.contents
+			display: block
+	&.pinned
+		.contents
+			.controls
+				.pin
+					background-color: black
+					color: white

data/bin/console

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

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/tell-them/tell-them.rb

@@ -0,0 +1,68 @@
+module TellThem
+  def self.add(data)
+    TellThemStore.instance.add(data)
+  end
+
+  def self.has_data?
+    TellThemStore.instance.has_data?
+  end
+
+  def self.data
+    TellThemStore.instance.data
+  end
+
+  def self.html
+    return '' unless has_data? && ::Rails.env.development?
+    box_html.html_safe
+  end
+
+  private
+
+  def self.box_html
+    box =  '<div id="tell-them-box">'
+    box += '  <div class="contents">'
+    box += '    <div class="controls">'
+    box += '      <div class="corners">'
+    box += '        <button data-target-corner="top-left"></button>'
+    box += '        <button data-target-corner="top-right"></button>'
+    box += '        <button data-target-corner="bottom-left"></button>'
+    box += '        <button class="current" data-target-corner="bottom-right"></button>'
+    box += '      </div>'
+    box += '      <button class="pin">Pin</button>'
+    box += '    </div>'
+    box += '    <dl class="items">'
+    data.each do |k,v|
+      box += "      <dt>#{k}</dt>"
+      begin
+        URI::parse(v)
+        box += "      <dd><a href=\"#{v}\">#{v}</a></dd>"
+      rescue URI::InvalidURIError
+        box += "      <dd>#{v}</dd>"
+      end
+    end
+    box += '    </dl>'
+    box += '  </div>'
+    box += '</div>'
+    box
+  end
+
+  class TellThemStore
+    include Singleton
+
+    def initialize
+      @data_store = {}
+    end
+
+    def add(data)
+      data.each { |k,v| @data_store[k] = v }
+    end
+
+    def has_data?
+      @data_store.any?
+    end
+
+    def data
+      @data_store
+    end
+  end
+end

data/lib/tell-them/version.rb

@@ -0,0 +1,5 @@
+module TellThem
+  module Rails
+    VERSION = "0.1.0"
+  end
+end

data/lib/tell-them.rb

@@ -0,0 +1,9 @@
+require "tell-them/tell-them"
+require "tell-them/version"
+
+module TellThem
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/tell-them.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tell-them/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tell-them"
+  spec.version       = TellThem::Rails::VERSION
+  spec.authors       = ["K M Lawrence"]
+  spec.email         = ["keith@kludge.co.uk"]
+
+  spec.summary       = %q{Adds a fixed debug button to a dev site}
+  spec.description   = %q{Adds a fixed debug button to a dev site, which you can put debug information into easily}
+  spec.homepage      = "https://www.github.com/KludgeKML/tell_them"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "railties", ">= 3.1"
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: tell-them
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- K M Lawrence
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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'
+description: Adds a fixed debug button to a dev site, which you can put debug information
+  into easily
+email:
+- keith@kludge.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- app/assets/javascripts/tell-them.js.coffee
+- app/assets/stylesheets/tell-them.sass
+- bin/console
+- bin/setup
+- lib/tell-them.rb
+- lib/tell-them/tell-them.rb
+- lib/tell-them/version.rb
+- tell-them.gemspec
+homepage: https://www.github.com/KludgeKML/tell_them
+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: Adds a fixed debug button to a dev site
+test_files: []