rails-bootstrap-sass-grid_size_display 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: adda83231d0d9768e2d5fbd1bd1bebb2cac7b0cc
+  data.tar.gz: 046e3d722358d96e65fac247e2b28ea44f22252a
+SHA512:
+  metadata.gz: 6c217dfdb927c16cf46d0d4501dab99f5ba54289e7352eec47f58b09a43f5548698853c86d06dcf5cb5334d3d39c08bd496cf7a017f3fe63150dce01b16df4b7
+  data.tar.gz: b6900d999404a7a6d1fa69794b4df36654e726ab511f77d9d4adf43e05e0cca2edc678dc6306e60d1a9ec09213c2098e16e5a8931093e3577c5e3430deb833db

data/.gitignore

@@ -0,0 +1,23 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache
+
+/*.gem
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.DS_Store
+
+/.gems
+/.byebug_history
+/.rspec

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in grid_size_display.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]
+

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 jgdreyes
+
+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.rdoc

@@ -0,0 +1,56 @@
+= GridSizeDisplay
+
+If you are using Rails and the bootstrap-sass gem, display a visual indicator to let
+you know what bootstrap grid size you are using.  This gem uses the default
+bootstrap variables names to determine grid sizes.  The gem works even if you've overwritten
+the default values of the variables.
+
+
+From the Bootstrap3 documentation:
+```
+@media (max-width: @screen-xs-max) { ... }
+@media (min-width: @screen-sm-min) and (max-width: @screen-sm-max) { ... }
+@media (min-width: @screen-md-min) and (max-width: @screen-md-max) { ... }
+@media (min-width: @screen-lg-min) { ... }
+```
+
+- `col-xs-*` = Red
+- `col-sm-*` = Orange
+- `col-md-*` = Yellow
+- `col-lg-*` = Green
+
+
+
+
+
+## Installation
+
+Add this line to your applications Rails + bootstrap-sass enabled application Gemfile:
+
+```ruby
+group :development do
+  gem 'gem_size_display'
+end
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Include the Sass partial to your application.scss file. Be sure to include it after bootstrap.
+
+```sass
+// app/assets/stylesheets/application.scss
+...
+@import "bootstrap-sprockets";
+@import "bootstrap";
+@import "grid_size_display/media_sizes";
+```
+
+## Special query strings
+
+By default the visual indicator will be displayed on every request.  If you include
+the query string `grid_size_display=disable` at the end of your request you will disable
+the display for your session.  To re-enable just add the query string `grid_size_display=enable`.

data/Rakefile

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

data/app/assets/stylesheets/grid_size_display/_media_sizes.scss

@@ -0,0 +1,28 @@
+#grid-size-display-container {
+  position: absolute;
+  top: 0;
+  width: 100%;
+  height: 10px;
+  z-index: 10000;
+}
+
+@media (max-width: $screen-xs-max) {
+  #grid-size-display-container {
+    background-color: red;
+  }
+}
+@media (min-width: $screen-sm-min) and (max-width: $screen-sm-max) {
+  #grid-size-display-container {
+    background-color: orange;
+  }
+}
+@media (min-width: $screen-md-min) and (max-width: $screen-md-max) {
+  #grid-size-display-container {
+    background-color: yellow;
+  }
+}
+@media (min-width: $screen-lg-min) {
+  #grid-size-display-container {
+    background-color: green;
+  }
+}

data/app/controllers/grid_size_display/application_controller.rb

@@ -0,0 +1,4 @@
+module GridSizeDisplay
+  class ApplicationController < ActionController::Base
+  end
+end

data/lib/grid_size_display/engine.rb

@@ -0,0 +1,63 @@
+module GridSizeDisplay
+  class Engine < ::Rails::Engine
+
+    isolate_namespace GridSizeDisplay
+
+    initializer "rails-bootstrap-sass_grid_size_display.add_middleware" do |app|
+      app.middleware.use GridSizeDisplay::Rack
+    end
+  end
+
+  class Rack
+    DEFAULT_INSERTION_POINT = '</body>'.freeze
+    HTML_CONTENT_TYPE = 'text/html'.freeze
+
+    def initialize(app, options = {})
+      @app, @options = app, options
+      @options[:insertion_point] ||= DEFAULT_INSERTION_POINT
+    end
+
+    def call(env)
+      status, headers, response = @app.call(env)
+
+      req = process_display_param(env)
+
+      if headers['Content-Type'].to_s.include?(HTML_CONTENT_TYPE) && display_grid?(req)
+        new_response = []
+        response.each do |body|
+          # find the last matching insertion point in the body and insert the content
+          partition = body.rpartition(@options[:insertion_point])
+          partition[0] += %q{<div id="grid-size-display-container"></div>}
+          new_response << partition.join
+        end
+
+        # Update the content-length
+        headers['Content-Length'] = new_response.inject(0) do |len, body|
+          len += body.bytesize
+        end.to_s
+
+        [status, headers, new_response]
+      else
+        [status, headers, response]
+      end
+    end
+
+    def display_grid?(req)
+      req.session['grid_size_display']
+    end
+
+
+    def process_display_param(env)
+      req = ::Rack::Request.new(env)
+
+      case req.params['grid_size_display']
+      when 'enable' then req.session['grid_size_display'] = true
+      when 'disable' then req.session['grid_size_display'] = false
+      end
+
+      req.session['grid_size_display'] = true if req.session['grid_size_display'].nil?
+      req
+    end
+
+  end
+end

data/lib/grid_size_display/version.rb

@@ -0,0 +1,3 @@
+module GridSizeDisplay
+  VERSION = "0.0.1"
+end

data/lib/rails-bootstrap-sass-grid_size_display.rb

@@ -0,0 +1,4 @@
+require "grid_size_display/engine"
+
+module GridSizeDisplay
+end

data/rails-bootstrap-sass-grid_size_display.gemspec

@@ -0,0 +1,31 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "grid_size_display/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |spec|
+  spec.name        = "rails-bootstrap-sass-grid_size_display"
+  spec.version     = GridSizeDisplay::VERSION
+
+  spec.authors       = ["Jennifer Reyes"]
+  spec.email         = ["jgdreyes@gmail.com"]
+
+  spec.summary       = %q{Display a colored grid size indicator when using bootstrap-sass with Rails.}
+  spec.description   = %q{Display a colored grid size indicator when using bootstrap-sass with Rails. Display a colored grid size indicator at the top of the page.  The colors correspond to the bootstrap breakpoints.}
+  spec.homepage      = "https://github.com/jgdreyes/rails-bootstrap-sass-grid_size_display"
+  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_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "rails", "~> 4.2"
+  spec.add_dependency "bootstrap-sass", "~> 3.3"
+  spec.add_dependency "byebug", "~> 8.2"
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: rails-bootstrap-sass-grid_size_display
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jennifer Reyes
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: 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: bootstrap-sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+description: Display a colored grid size indicator when using bootstrap-sass with
+  Rails. Display a colored grid size indicator at the top of the page.  The colors
+  correspond to the bootstrap breakpoints.
+email:
+- jgdreyes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- app/assets/stylesheets/grid_size_display/_media_sizes.scss
+- app/controllers/grid_size_display/application_controller.rb
+- lib/grid_size_display/engine.rb
+- lib/grid_size_display/version.rb
+- lib/rails-bootstrap-sass-grid_size_display.rb
+- rails-bootstrap-sass-grid_size_display.gemspec
+homepage: https://github.com/jgdreyes/rails-bootstrap-sass-grid_size_display
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Display a colored grid size indicator when using bootstrap-sass with Rails.
+test_files: []