peek-alt-routes 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8ed9b128d4408a50aaa11406a0036f4f9b4983d0
+  data.tar.gz: f7b03c7969dfbd0182cc572467606363764f3fd2
+SHA512:
+  metadata.gz: 01140f38b2c4664823c49f0e0c6dee7de5f3359ff024f558ec021114063507930b4001d58240fe4920fda0bd32b2cd8f69ec6e1e12e286d0e29c9381e4beadd6
+  data.tar.gz: b5835862b728e95c535f593702b78dfb96e1bdec4ca91567890937f09a3ffaf461a37abb0b64d3d06804d36080a45b0def1b81591bf83da7e696175877e95e73

data/.gitignore

@@ -0,0 +1,17 @@
+*.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/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 1.0
+
+- Initial release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Chris Ewald
+
+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,109 @@
+# Peek::AltRoutes
+
+Easily toggle alternate controllers and routes.
+
+![screen shot 2016-01-15 at 11 33 56 pm](https://cloud.githubusercontent.com/assets/283496/12372401/67358846-bc23-11e5-83eb-20778411ff0d.png)
+
+
+Things this peek view provides:
+
+- A ready to go route constraint for switching controllers/views or routes
+- A toggle button to quickly enable and disable the alternate routes
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'peek-alt-routes
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install peek-alt-routes
+
+## Usage
+
+Add the following to your `config/initializers/peek.rb`:
+
+```ruby
+Peek.into Peek::Views::AltRoutes
+```
+
+You may provide a `name` option to the Peek view to set the button display text:
+
+```ruby
+Peek.into Peek::Views::AltRoutes, name: 'Site Redesign'
+```
+
+Add the following to your `app/assets/javascripts/application.js`:
+
+```javascript
+//= require peek/views/alt_routes
+```
+
+Add the following to your `app/assets/javascripts/application.css`:
+
+```css
+/*
+ *= require peek/views/alt_routes
+ */
+```
+
+Use the `peek_alt_routes?` route constraint as you see fit. In `config/routes.rb`:
+
+```ruby
+  # Remember that Rails matches the first route it finds (top to bottom) so
+  # be sure to put any constrained routes before the open routes.
+
+  # Route group example:
+  constraints peek_alt_routes?: true do
+    get '/about', to: 'next_site#about'
+    get '/contact', to: 'next_site#contact'
+  end
+  get '/about', to: 'site#about'
+  get '/contact', to: 'site#contact'
+
+  # Single case example:
+  get 'new-site-only' to: 'new_site#only', constraints: { peek_alt_routes?: true }
+
+  # DRY routes using routing concerns ( >= Rails 4.0 ) example:
+  concern :static_pages do
+    get '/about, action: 'about'
+    get '/contact, action: 'contact'
+  end
+  scope controller: 'next_site', constraints: { peek_alt_routes?: true } do
+    concerns :static_pages
+    get '/help', action: 'help'
+  end
+  scope controller: 'site' do
+    concerns :static_pages
+  end
+
+```
+
+## When to use this vs Flipper
+
+ * [Flipper](https://github.com/jnunemaker/flipper) is a full featured gem that
+   is supplementary to this gem.
+ * Prefer this gem only for cases when a full visual redesign is wanted. This
+   gem only does quick user facing feature toggling better than flipper.
+ * Use flipper for multiple or non-visual feature toggles or when advanced roll
+   out procedures are needed.
+
+## Notes
+
+ * Be sure to render the Peek bar in your alternate views so it may be disabled.
+ * Be sure to implement user security into your alternate controllers. Peek-alt-routes
+ simply sets and checks a cookie for determining which routes to use.
+ * The `peek_alt_routes?` method is available in controllers as well should you need it.
+
+## 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 @@
+require "bundler/gem_tasks"

data/app/assets/javascripts/peek/views/alt_routes.js.coffee

@@ -0,0 +1,28 @@
+class PeekAltRoutes
+  checkboxEl: '.peek-alt-routes input'
+  tipsyEl:    '.peek-alt-routes .peek-alt-routes-btn'
+
+  render: ->
+    $(@checkboxEl).on 'change', @checkboxClicked
+    $(@tipsyEl).attr('title', @tipsyMessage())
+    $(@tipsyEl).tipsy gravity: $.fn.tipsy.autoNS
+
+  checkboxClicked: (event) ->
+    document.cookie = "peek-alt-routes=#{event.target.checked}; path=/"
+    document.location.reload(true)
+
+  altRoutesEnabled: ->
+    $(@checkboxEl)[0].checked
+
+  altRoutesDisplayName: ->
+    $(@checkboxEl).siblings('label').text()
+
+  tipsyMessage: ->
+    msg = "\'#{@altRoutesDisplayName()}\' is currently "
+    if @altRoutesEnabled()
+      msg += 'enabled.'
+    else
+      msg += 'disabled.'
+
+$(document).ready ->
+  (new PeekAltRoutes).render()

data/app/assets/stylesheets/peek/views/alt_routes.css.scss

@@ -0,0 +1,36 @@
+.peek-alt-routes .peek-alt-routes-btn {
+  position: relative;
+
+  input {
+    left: 8px;
+    position: absolute;
+    top: 12px;
+    z-index: 3;
+  }
+
+  label {
+    border: 1px solid rgba(0, 0, 0, .8);
+    border-radius: 3px;
+    box-shadow: inset 1px 1px 0 rgba(255, 255, 255, .2), 1px 1px 2px rgba(0, 0, 0, .25);
+    color: #fff;
+    letter-spacing: 0.8px;
+    padding: 5px 8px 5px 25px;
+    position: relative;
+    top: 1px;
+    z-index: 1;
+
+    &:hover {
+      box-shadow: 0 0 4px rgba(255, 255, 255, .85);
+      background-color: rgba(0, 0, 0, .2);
+    }
+  }
+
+  &.active label {
+    background-color: rgba(0, 0, 0, .2);
+    box-shadow: 0 1px 0 rgba(255, 255, 255, .2), inset 0 2px 2px rgba(0, 0, 0, .25);
+
+    &:hover {
+      box-shadow: 0 0 4px rgba(255, 255, 255, .85);
+    }
+  }
+}

data/app/views/peek/views/_alt_routes.html.erb

@@ -0,0 +1,6 @@
+<div class="peek-alt-routes">
+  <div class="peek-alt-routes-btn <%= 'active' if request.peek_alt_routes? %>">
+    <%= check_box_tag 'peek-alt-routes', '1', request.peek_alt_routes? %>
+    <label for="peek-alt-routes"><%= view.name %></label>
+  </div>
+</div>

data/lib/peek-alt-routes.rb

@@ -0,0 +1,3 @@
+require 'peek/views/alt_routes'
+require 'peek-alt-routes/version'
+require 'peek-alt-routes/railtie'

data/lib/peek-alt-routes/railtie.rb

@@ -0,0 +1,14 @@
+require 'peek/alt-routes/request_extensions'
+
+module Peek
+  module AltRoutes
+    class Railtie < ::Rails::Engine
+      initializer 'peek.alt_routes.include_request_extensions' do
+        ActiveSupport.on_load(:action_controller) do
+          ActionDispatch::Request.send(:include, Peek::AltRoutes::RequestExtensions)
+          delegate :peek_alt_routes?, to: :request
+        end
+      end
+    end
+  end
+end

data/lib/peek-alt-routes/version.rb

@@ -0,0 +1,5 @@
+module Peek
+  module AltRoutes
+    VERSION = '1.0.0'
+  end
+end

data/lib/peek/alt-routes/request_extensions.rb

@@ -0,0 +1,9 @@
+module Peek
+  module AltRoutes
+    module RequestExtensions
+      def peek_alt_routes?
+        cookies['peek-alt-routes'] == 'true'
+      end
+    end
+  end
+end

data/lib/peek/views/alt_routes.rb

@@ -0,0 +1,16 @@
+module Peek
+  module Views
+    class AltRoutes < View
+      attr_reader :name
+      # A view that allows for quick toggling of alternative routes.
+      #
+      # name - Text that will be displayed in the peek bar. The name
+      #        of the feature or pages that will be toggled.
+      #
+      # Returns Peek::Views::AltRoutes
+      def initialize(options = {})
+        @name = options.fetch(:name, 'Alternate Routes')
+      end
+    end
+  end
+end

data/peek-alt-routes.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'peek-alt-routes/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'peek-alt-routes'
+  gem.version       = Peek::AltRoutes::VERSION
+  gem.authors       = ['Chris Ewald']
+  gem.email         = ['chrisewald@gmail.com']
+  gem.description   = %q{Easily toggle alternate controllers and routes with peek.}
+  gem.summary       = %q{Easily toggle alternate controllers and routes with peek.}
+  gem.homepage      = 'https://github.com/mkcode/peek-alt-routes'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'peek'
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: peek-alt-routes
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Chris Ewald
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: peek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easily toggle alternate controllers and routes with peek.
+email:
+- chrisewald@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/peek/views/alt_routes.js.coffee
+- app/assets/stylesheets/peek/views/alt_routes.css.scss
+- app/views/peek/views/_alt_routes.html.erb
+- lib/peek-alt-routes.rb
+- lib/peek-alt-routes/railtie.rb
+- lib/peek-alt-routes/version.rb
+- lib/peek/alt-routes/request_extensions.rb
+- lib/peek/views/alt_routes.rb
+- peek-alt-routes.gemspec
+homepage: https://github.com/mkcode/peek-alt-routes
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Easily toggle alternate controllers and routes with peek.
+test_files: []