ribbonit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 92cd42e89e6bc423c4cb348864a63d84e6391756
+  data.tar.gz: 86fcc204946e0b49b779fc26551de84476568af1
+SHA512:
+  metadata.gz: b3d7e825e6930c5fb50f53b6b30456da2a2522873f6c9db9e2b57e46c034f36699d5fddd216d94f95d94862c3e6e0fad3a958cc2a264d46f061c3a2c987ee920
+  data.tar.gz: 025e6c3130034094c042b3725f67673703ddf28c01e12820c05afb1f9133a288c22b2d39d06d03f9c17f045e0b21f535b0af7e3de1d537fc0547a8b00891a8a7

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.rubocop-http*
+!bin

data/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from: https://raw.githubusercontent.com/anthony-robin/rubocop-rules/master/.rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.4

data/.travis.yml

@@ -0,0 +1,16 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+
+cache:
+  bundler: true
+
+before_install:
+  - gem install bundler -v 1.14.6
+
+script:
+  - bin/rubocop
+
+notifications:
+  email: false

data/Gemfile

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

data/README.md

@@ -0,0 +1,134 @@
+# Ribbonit
+
+**Ribbonit** displays an elegant ribbon to the corner of the page displaying useful information about the application: **Rails environment**, **Rails version**, **Ruby version**.
+
+It is completely inspired from the Github 'fork me' ribbon.
+
+![Travis CI](https://travis-ci.org/anthony-robin/Ribbonit.svg?branch=master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+# Gemfile
+gem 'ribbonit'
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+```shell
+$ gem install ribbonit
+```
+
+## Usage
+
+1) Run initializer
+```shell
+$ bin/rails g ribbonit:install
+```
+This will create a `ribbonit.rb` file in `config/initializers`
+
+2) Import assets
+```sass
+// application.sass
+@import ribbon
+```
+
+3) Call ribbon in layout
+```slim
+/ application.slim
+...
+body
+  = ribbonit
+```
+
+## Options
+You can customize some options through the initializer. Here are the defaults options:
+
+```ruby
+# config/initializers/ribbonit.rb
+
+display_rails_version = true
+display_ruby_version = true
+
+hide_for_small = true # Display ribbon in small devices ?
+position = 'top-left' # top-right, bottom-left, bottom-right
+
+# Available colors:
+# orange, blue, green, red, purple, black, white
+themes = {
+  development: 'black',
+  staging: 'blue'
+}
+
+# Sometimes, people use another name for this environment
+staging_name = 'staging'
+```
+
+## Screenshots
+### Colors
+<table>
+<tr>
+  <td><img src="vendor/assets/images/colors/orange.png" width="100"></td>
+  <td><img src="vendor/assets/images/colors/blue.png" width="100"></td>
+  <td><img src="vendor/assets/images/colors/green.png" width="100"></td>
+  <td><img src="vendor/assets/images/colors/red.png" width="100"></td>
+</tr>
+<tr>
+  <td>Orange</td>
+  <td>Blue</td>
+  <td>Green</td>
+  <td>Red</td>
+</tr>
+<tr>
+  <td><img src="vendor/assets/images/colors/purple.png" width="100"></td>
+  <td><img src="vendor/assets/images/colors/black.png" width="100"></td>
+  <td><img src="vendor/assets/images/colors/white.png" width="100"></td>
+</tr>
+<tr>
+  <td>Purple</td>
+  <td>Black</td>
+  <td>White</td>
+</tr>
+</table>
+
+### Positions
+<table>
+<tr>
+  <td><img src="vendor/assets/images/colors/blue.png" width="100"></td>
+  <td><img src="vendor/assets/images/positions/top-right.png" width="100"></td>
+  <td><img src="vendor/assets/images/positions/bottom-right.png" width="100"></td>
+  <td><img src="vendor/assets/images/positions/bottom-left.png" width="100"></td>
+</tr>
+<tr>
+  <td>Top/Left</td>
+  <td>Top/Right</td>
+  <td>Bottom/Right</td>
+  <td>Bottom/Left</td>
+</tr>
+</table>
+
+### Environments
+<table>
+<tr>
+  <td><img src="vendor/assets/images/colors/purple.png" width="100"></td>
+  <td><img src="vendor/assets/images/environments/staging.png" width="100"></td>
+</tr>
+<tr>
+  <td>Development</td>
+  <td>Staging</td>
+</tr>
+</table>
+
+## 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,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

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

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rubocop', 'rubocop')

data/bin/setup

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

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

@@ -0,0 +1,21 @@
+<% config = Ribbonit.configuration %>
+
+<% if Rails.env.development? || Rails.env.send("#{config.staging_name}?") %>
+
+<div id="ribbon" class="ribbon <%= config.position %> <%= config.hide_for_small ? 'hide-for-small' : '' %>">
+  <div class="ribbon-container <%= config.themes[Rails.env.to_sym] %>">
+    <span class="env"><%= Rails.env.capitalize %></span>
+
+    <span class="version">
+      <% if config.display_rails_version %>
+        Rails: <strong><%= Rails.version %></strong>
+      <% end %>
+
+      <% if config.display_ruby_version %>
+        Ruby: <strong><%= RUBY_VERSION %></strong>
+      <% end %>
+    </span>
+  </div>
+</div>
+
+<% end %>

data/lib/generators/ribbonit/install_generator.rb

@@ -0,0 +1,13 @@
+# rubocop:disable ClassAndModuleChildren
+module Ribbonit
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      desc 'Copy Ribbonit initializer configuration'
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_initializer
+        template 'ribbonit.rb', 'config/initializers/ribbonit.rb'
+      end
+    end
+  end
+end

data/lib/generators/ribbonit/templates/ribbonit.rb

@@ -0,0 +1,32 @@
+Ribbonit.configure do |config|
+  ###
+  # Displayed informations
+  #
+  config.display_rails_version = true
+  config.display_ruby_version = true
+
+  ###
+  # Display on small devices ?
+  #
+  config.hide_for_small = true
+
+  ###
+  # Position - available positions are:
+  # 'top-left', 'top-right', 'bottom-left', 'bottom-right'
+  #
+  config.position = 'top-left'
+
+  ###
+  # Themes - available options are:
+  # 'orange', 'blue', 'green', 'red', 'purple', 'black', 'white'
+  #
+  config.themes = {
+    development: 'black',
+    staging: 'blue'
+  }
+
+  ###
+  # Environment name
+  #
+  config.staging_name = 'staging'
+end

data/lib/ribbonit.rb

@@ -0,0 +1,3 @@
+require 'ribbonit/version'
+require 'ribbonit/configuration'
+require 'ribbonit/rails/engine' if defined?(Rails)

data/lib/ribbonit/configuration.rb

@@ -0,0 +1,27 @@
+require 'active_support/configurable'
+
+module Ribbonit
+  def self.configuration
+    @configuration ||= Ribbonit::Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+end
+
+class Ribbonit::Configuration
+  include ActiveSupport::Configurable
+
+  config_accessor(:display_rails_version) { true }
+  config_accessor(:display_ruby_version) { true }
+  config_accessor(:hide_for_small) { true }
+  config_accessor(:position) { 'top-left' }
+  config_accessor(:themes) do
+    {
+      development: 'orange',
+      staging: 'blue'
+    }
+  end
+  config_accessor(:staging_name) { 'staging' }
+end

data/lib/ribbonit/rails/engine.rb

@@ -0,0 +1,15 @@
+require 'ribbonit/view_helpers'
+
+# rubocop:disable ClassAndModuleChildren
+module Ribbonit
+  module Rails
+    class Engine < ::Rails::Engine
+      initializer 'ribbonit.view_helpers' do |app|
+        ActionView::Base.send :include, ViewHelpers
+        ActiveSupport.on_load(:action_controller) do
+          append_view_path "#{Gem.loaded_specs['ribbonit'].full_gem_path}/lib/app/views/partials"
+        end
+      end
+    end
+  end
+end

data/lib/ribbonit/version.rb

@@ -0,0 +1,3 @@
+module Ribbonit
+  VERSION = '0.1.0'.freeze
+end

data/lib/ribbonit/view_helpers.rb

@@ -0,0 +1,5 @@
+module Ribbonit::ViewHelpers
+  def ribbonit
+    render '/ribbon'
+  end
+end

data/ribbonit.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ribbonit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ribbonit'
+  spec.version       = Ribbonit::VERSION
+  spec.authors       = ['Anthony Robin']
+  spec.email         = ['contact@anthony-robin.fr']
+
+  spec.summary       = 'Display Ribbon with Rails env'
+  spec.description   = 'Display an elegant Github like ribbon to your Rails application showing environment informations (Rails environment, Ruby version, Rails version, ...)'
+  spec.homepage      = 'https://github.com/anthony-robin'
+
+  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.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rubocop'
+
+  spec.add_dependency 'rails'
+  spec.add_dependency 'sassc-rails'
+end

data/vendor/assets/stylesheets/_ribbon.sass

@@ -0,0 +1,106 @@
+$ribbon_width: 165px
+$ribbon_height: 165px
+
+$top: 36px
+$left: -60px
+
+.ribbon
+  position: fixed
+  top: 0
+  left: 0
+  z-index: 1001
+  display: block
+  overflow: hidden
+  width: $ribbon_width
+  height: $ribbon_height
+  font-size: 16px
+  font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif
+  line-height: 1rem
+
+  // Position
+  &.top-right
+    right: 0
+    left: inherit
+    .ribbon-container
+      right: $left
+      left: inherit
+      transform: rotate(45deg)
+
+  &.bottom-left
+    top: inherit
+    bottom: 0
+    .ribbon-container
+      top: inherit
+      bottom: $top
+      transform: rotate(45deg)
+
+  &.bottom-right
+    top: inherit
+    right: 0
+    bottom: 0
+    left: inherit
+    .ribbon-container
+      top: inherit
+      right: $left
+      bottom: $top
+      left: inherit
+      transform: rotate(-45deg)
+
+  // Container
+  .ribbon-container
+    position: absolute
+    top: $top
+    left: $left
+    padding: 7px 40px
+    width: 100%
+    background: #333
+    box-shadow: 1px 1px 3px rgba(#000, .8)
+    color: #FFF
+    text-align: center
+    text-decoration: none
+    font-size: 1rem
+    transform: rotate(-45deg)
+
+    &::before, &::after
+      position: absolute
+      top: 1px
+      left: 0
+      display: block
+      width: 100%
+      height: 1px
+      background: #FFF
+      content: ''
+
+    &::after
+      top: auto
+      bottom: 1px
+
+    // Colors
+    &.orange
+      background: #f80
+    &.blue
+      background: #49a
+    &.green
+      background: #090
+    &.red
+      background: #a00
+    &.purple
+      background: #551a8b
+    &.black
+      background: #333
+    &.white
+      background: #fff
+      color: #333
+
+    // Displayed informations
+    .env
+      margin-bottom: 0
+      text-transform: uppercase
+
+    .version
+      display: block
+      font-size: 11px
+
+@media only screen and (max-width: 40em)
+  .ribbon.hide-for-small
+    display: none

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: ribbonit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anthony Robin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-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.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: sassc-rails
+  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: Display an elegant Github like ribbon to your Rails application showing
+  environment informations (Rails environment, Ruby version, Rails version, ...)
+email:
+- contact@anthony-robin.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/rubocop
+- bin/setup
+- lib/app/views/partials/_ribbon.html.erb
+- lib/generators/ribbonit/install_generator.rb
+- lib/generators/ribbonit/templates/ribbonit.rb
+- lib/ribbonit.rb
+- lib/ribbonit/configuration.rb
+- lib/ribbonit/rails/engine.rb
+- lib/ribbonit/version.rb
+- lib/ribbonit/view_helpers.rb
+- ribbonit.gemspec
+- vendor/assets/images/colors/black.png
+- vendor/assets/images/colors/blue.png
+- vendor/assets/images/colors/green.png
+- vendor/assets/images/colors/orange.png
+- vendor/assets/images/colors/purple.png
+- vendor/assets/images/colors/red.png
+- vendor/assets/images/colors/white.png
+- vendor/assets/images/environments/staging.png
+- vendor/assets/images/positions/bottom-left.png
+- vendor/assets/images/positions/bottom-right.png
+- vendor/assets/images/positions/top-right.png
+- vendor/assets/stylesheets/_ribbon.sass
+homepage: https://github.com/anthony-robin
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Display Ribbon with Rails env
+test_files: []