ribbonit 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92cd42e89e6bc423c4cb348864a63d84e6391756
-  data.tar.gz: 86fcc204946e0b49b779fc26551de84476568af1
+  metadata.gz: 2b6a0ded118838cf368fd225c19878bca1c1eb0c
+  data.tar.gz: bb1f19446f65b7a98541de0fa5bd254013fd8fa2
 SHA512:
-  metadata.gz: b3d7e825e6930c5fb50f53b6b30456da2a2522873f6c9db9e2b57e46c034f36699d5fddd216d94f95d94862c3e6e0fad3a958cc2a264d46f061c3a2c987ee920
-  data.tar.gz: 025e6c3130034094c042b3725f67673703ddf28c01e12820c05afb1f9133a288c22b2d39d06d03f9c17f045e0b21f535b0af7e3de1d537fc0547a8b00891a8a7
+  metadata.gz: 624b4345796372affc606edcd0db49a865293d72e501a12186b4a94e9566958a0068bac2ebce69b9a311e296f55dbd9b2b393e0303a57cff785689a29bfcf150
+  data.tar.gz: 1b1b3787c21fd1a2b4d054c1e0e04fb8d49e8b86a244c5bea102392372c426edaf8f5d0c3fd21710b260d5627db6db2d1290b2c970ab4fad012e0a26ca919568

data/.github_changelog_generator

@@ -0,0 +1 @@
+exclude-labels="duplicate,question,invalid,wontfix,feature"

data/.gitignore

@@ -10,3 +10,4 @@
 
 .rubocop-http*
 !bin
+coverage

data/.simplecov

@@ -0,0 +1,10 @@
+require 'codacy-coverage'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
+    SimpleCov::Formatter::HTMLFormatter,
+    Codacy::Formatter
+])
+
+SimpleCov.start do
+  add_group 'lib', 'lib'
+end

data/.travis.yml

@@ -6,11 +6,9 @@ rvm:
 cache:
   bundler: true
 
-before_install:
-  - gem install bundler -v 1.14.6
-
 script:
-  - bin/rubocop
+  - bundle exec bin/rspec
+  - bundle exec bin/rubocop
 
 notifications:
   email: false

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+# Change Log
+
+## [Unreleased](https://github.com/anthony-robin/Ribbonit/tree/HEAD)
+
+[Full Changelog](https://github.com/anthony-robin/Ribbonit/compare/v0.1.0...HEAD)
+
+**Implemented enhancements:**
+
+- REFACTOR style using BEM syntax [\#19](https://github.com/anthony-robin/Ribbonit/pull/19) ([anthony-robin](https://github.com/anthony-robin))
+- ADD 'root\_link' option that wraps ribbon [\#18](https://github.com/anthony-robin/Ribbonit/pull/18) ([anthony-robin](https://github.com/anthony-robin))
+- ADD Changelog file [\#17](https://github.com/anthony-robin/Ribbonit/pull/17) ([anthony-robin](https://github.com/anthony-robin))
+- ADD 'git\_branch' option [\#14](https://github.com/anthony-robin/Ribbonit/pull/14) ([anthony-robin](https://github.com/anthony-robin))
+- ADD 'sticky' option [\#13](https://github.com/anthony-robin/Ribbonit/pull/13) ([anthony-robin](https://github.com/anthony-robin))
+- USE Array for infos [\#12](https://github.com/anthony-robin/Ribbonit/pull/12) ([anthony-robin](https://github.com/anthony-robin))
+- REPLACE 'minitest' by 'rspec' [\#8](https://github.com/anthony-robin/Ribbonit/pull/8) ([anthony-robin](https://github.com/anthony-robin))
+- ADD Codacy badges [\#5](https://github.com/anthony-robin/Ribbonit/pull/5) ([anthony-robin](https://github.com/anthony-robin))
+- ADD Gemnasium badge [\#4](https://github.com/anthony-robin/Ribbonit/pull/4) ([anthony-robin](https://github.com/anthony-robin))
+- ADD badge displaying 'gem' version [\#3](https://github.com/anthony-robin/Ribbonit/pull/3) ([anthony-robin](https://github.com/anthony-robin))
+
+**Fixed bugs:**
+
+- RUN specs with Travis [\#7](https://github.com/anthony-robin/Ribbonit/pull/7) ([anthony-robin](https://github.com/anthony-robin))
+
+**Closed issues:**
+
+- ADD 'git\_branch' option to Ribbon displayed informations [\#16](https://github.com/anthony-robin/Ribbonit/issues/16)
+- CREATE a 'CHANGELOG' file [\#11](https://github.com/anthony-robin/Ribbonit/issues/11)
+- ADD 'sticky' option to Ribbon configuration [\#10](https://github.com/anthony-robin/Ribbonit/issues/10)
+
+## [v0.1.0](https://github.com/anthony-robin/Ribbonit/tree/v0.1.0) (2017-05-21)
+**Implemented enhancements:**
+
+- UPDATE travis instructions, FIX rubocop offenses [\#1](https://github.com/anthony-robin/Ribbonit/pull/1) ([anthony-robin](https://github.com/anthony-robin))
+
+**Fixed bugs:**
+
+- ADD 'line-height' css property [\#2](https://github.com/anthony-robin/Ribbonit/pull/2) ([anthony-robin](https://github.com/anthony-robin))
+
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/README.md

@@ -4,7 +4,11 @@
 
 It is completely inspired from the Github 'fork me' ribbon.
 
-![Travis CI](https://travis-ci.org/anthony-robin/Ribbonit.svg?branch=master)
+[![Gem Version](https://badge.fury.io/rb/ribbonit.svg)](https://rubygems.org/gems/ribbonit)
+[![Travis CI](https://travis-ci.org/anthony-robin/Ribbonit.svg?branch=master)](https://travis-ci.org/anthony-robin/Ribbonit)
+[![Codacy Badge Grade](https://api.codacy.com/project/badge/Grade/521429a8cf91432aba574c69f1385aa2)](https://www.codacy.com/app/anthony-robin/Ribbonit)
+[![Codacy Badge Coverage](https://api.codacy.com/project/badge/Coverage/521429a8cf91432aba574c69f1385aa2)](https://www.codacy.com/app/anthony-robin/Ribbonit)
+[![Dependency Status](https://gemnasium.com/badges/github.com/anthony-robin/Ribbonit.svg)](https://gemnasium.com/github.com/anthony-robin/Ribbonit)
 
 ## Installation
 
@@ -54,11 +58,16 @@ You can customize some options through the initializer. Here are the defaults op
 ```ruby
 # config/initializers/ribbonit.rb
 
-display_rails_version = true
-display_ruby_version = true
+# rails_version: Version of Ruby on Rails
+# ruby_version: Version of Ruby
+# git_branch: Current git branch (only displayed in development)
+config.infos_to_display = %i[rails_version ruby_version git_branch]
+
+config.root_link = false # Wrap ribbon with root_url link ?
 
 hide_for_small = true # Display ribbon in small devices ?
 position = 'top-left' # top-right, bottom-left, bottom-right
+sticky = true # stick to page corner ?
 
 # Available colors:
 # orange, blue, green, red, purple, black, white
@@ -79,19 +88,15 @@ staging_name = 'staging'
   <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>
+  <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>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>
@@ -126,6 +131,16 @@ staging_name = 'staging'
 </tr>
 </table>
 
+### Additional informations
+<table>
+<tr>
+  <td><img src="vendor/assets/images/git/branch.png" width="100"></td>
+</tr>
+<tr>
+  <td>Git branch</td>
+</tr>
+</table>
+
 ## Contributing
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/bin/rspec

@@ -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('rspec-core', 'rspec')

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

@@ -0,0 +1,17 @@
+<span class="ribbon__container__environment"><%= Rails.env.capitalize %></span>
+
+<span class="ribbon__container__version">
+  <% if config.infos_to_display.include?(:rails_version) %>
+    Rails: <strong><%= Rails.version %></strong>
+  <% end %>
+
+  <% if config.infos_to_display.include?(:ruby_version) %>
+    Ruby: <strong><%= RUBY_VERSION %></strong>
+  <% end %>
+</span>
+
+<% if config.infos_to_display.include?(:git_branch) && Rails.env.development? %>
+  <span class="ribbon__container__git">
+    Branch: <strong><%= branch_name %></strong>
+  </span>
+<% end %>

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

@@ -2,19 +2,15 @@
 
 <% 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>
+<div id="ribbon" class="ribbon ribbon--<%= config.position %> <%= config.hide_for_small ? 'ribbon--hide-for-small' : '' %> <%= config.sticky ? 'ribbon--sticky' : '' %> ribbon--<%= line_count %>-lines">
+  <div class="ribbon__container ribbon__container--<%= config.themes[Rails.env.to_sym] %>">
+    <% if config.root_link %>
+      <%= link_to root_url do %>
+        <%= render '/lines', config: config %>
       <% end %>
-    </span>
+    <% else %>
+      <%= render '/lines', config: config %>
+    <% end %>
   </div>
 </div>
 

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

@@ -2,8 +2,17 @@ Ribbonit.configure do |config|
   ###
   # Displayed informations
   #
-  config.display_rails_version = true
-  config.display_ruby_version = true
+  # Available options:
+  # - rails_version: Version of Ruby on Rails
+  # - ruby_version: Version of Ruby
+  # - git_branch: Current git branch (only displayed in development)
+  #
+  config.infos_to_display = %i[rails_version ruby_version git_branch]
+
+  ###
+  # Wrap ribbon with link that goes to root_url ?
+  #
+  config.root_link = false
 
   ###
   # Display on small devices ?
@@ -11,14 +20,23 @@ Ribbonit.configure do |config|
   config.hide_for_small = true
 
   ###
-  # Position - available positions are:
-  # 'top-left', 'top-right', 'bottom-left', 'bottom-right'
+  # Position
+  #
+  # Available options:
+  # top-left, top-right, bottom-left, bottom-right
   #
   config.position = 'top-left'
 
   ###
-  # Themes - available options are:
-  # 'orange', 'blue', 'green', 'red', 'purple', 'black', 'white'
+  # Stick ribbon to page on scroll ?
+  #
+  config.sticky = true
+
+  ###
+  # Themes
+  #
+  # Available options:
+  # orange, blue, green, red, purple, black, white
   #
   config.themes = {
     development: 'black',

data/lib/ribbonit/configuration.rb

@@ -13,13 +13,16 @@ end
 class Ribbonit::Configuration
   include ActiveSupport::Configurable
 
-  config_accessor(:display_rails_version) { true }
-  config_accessor(:display_ruby_version) { true }
+  config_accessor(:infos_to_display) do
+    %i[rails_version ruby_version]
+  end
+  config_accessor(:root_link) { false }
   config_accessor(:hide_for_small) { true }
   config_accessor(:position) { 'top-left' }
+  config_accessor(:sticky) { true }
   config_accessor(:themes) do
     {
-      development: 'orange',
+      development: 'black',
       staging: 'blue'
     }
   end

data/lib/ribbonit/version.rb

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

data/lib/ribbonit/view_helpers.rb

@@ -2,4 +2,16 @@ module Ribbonit::ViewHelpers
   def ribbonit
     render '/ribbon'
   end
+
+  def branch_name
+    `git rev-parse --abbrev-ref HEAD`.gsub('feature/', '')
+  end
+
+  def line_count
+    height = 1
+    items = Ribbonit.configuration.infos_to_display
+    height += 1 if items.include?(:ruby_version) || items.include?(:rails_version)
+    height += 1 if items.include?(:git_branch) && Rails.env.development?
+    height
+  end
 end

data/ribbonit.gemspec

@@ -11,19 +11,21 @@ Gem::Specification.new do |spec|
 
   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.homepage      = 'https://github.com/anthony-robin/ribbonit'
 
   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'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.6'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'codacy-coverage', '~> 1.1'
 end

data/vendor/assets/stylesheets/_ribbon.sass

@@ -1,11 +1,12 @@
 $ribbon_width: 165px
 $ribbon_height: 165px
 
-$top: 36px
-$left: -60px
+$top: 33px
+$left: -66px
+$offset: -5px
 
 .ribbon
-  position: fixed
+  position: absolute
   top: 0
   left: 0
   z-index: 1001
@@ -17,37 +18,8 @@ $left: -60px
   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
+  &__container
     position: absolute
     top: $top
     left: $left
@@ -60,6 +32,10 @@ $left: -60px
     text-decoration: none
     font-size: 1rem
     transform: rotate(-45deg)
+    a
+      display: block
+      color: inherit
+      text-decoration: none
 
     &::before, &::after
       position: absolute
@@ -76,31 +52,84 @@ $left: -60px
       bottom: 1px
 
     // Colors
-    &.orange
+    &--orange
       background: #f80
-    &.blue
+    &--blue
       background: #49a
-    &.green
+    &--green
       background: #090
-    &.red
+    &--red
       background: #a00
-    &.purple
+    &--purple
       background: #551a8b
-    &.black
+    &--black
       background: #333
-    &.white
+    &--white
       background: #fff
       color: #333
+      a
+        color: #333
 
     // Displayed informations
-    .env
-      margin-bottom: 0
+    &__environment
+      display: block
       text-transform: uppercase
 
-    .version
+    &__version, &__git
       display: block
       font-size: 11px
 
+  // Sticky
+  &--sticky
+    position: fixed
+
+  // 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)
+
+  // Ribbon size depending of displayed options
+  &--3-lines
+    width: $ribbon_width + 15px
+    height: $ribbon_height + 15px
+    &--top-left
+      top: $offset
+      left: $offset
+    &--top-right
+      top: $offset
+      right: $offset
+    &--bottom-left
+      bottom: $offset
+      left: $offset
+    &--bottom-right
+      right: $offset
+      bottom: $offset
+
 @media only screen and (max-width: 40em)
-  .ribbon.hide-for-small
-    display: none
+  .ribbon
+    &--hide-for-small
+      display: none

metadata

@@ -1,57 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: ribbonit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Anthony Robin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-21 00:00:00.000000000 Z
+date: 2017-05-28 00:00:00.000000000 Z
 dependencies:
+- !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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -81,13 +109,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -95,19 +123,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sassc-rails
+  name: codacy-coverage
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '1.1'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 description: Display an elegant Github like ribbon to your Rails application showing
   environment informations (Rails environment, Ruby version, Rails version, ...)
 email:
@@ -116,15 +144,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github_changelog_generator"
 - ".gitignore"
 - ".rubocop.yml"
+- ".simplecov"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
 - bin/console
+- bin/rspec
 - bin/rubocop
 - bin/setup
+- lib/app/views/partials/_lines.html.erb
 - lib/app/views/partials/_ribbon.html.erb
 - lib/generators/ribbonit/install_generator.rb
 - lib/generators/ribbonit/templates/ribbonit.rb
@@ -142,11 +175,12 @@ files:
 - vendor/assets/images/colors/red.png
 - vendor/assets/images/colors/white.png
 - vendor/assets/images/environments/staging.png
+- vendor/assets/images/git/branch.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
+homepage: https://github.com/anthony-robin/ribbonit
 licenses: []
 metadata: {}
 post_install_message: