ribbonit 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a55b27e404938b7ef984d33d6954ec1c8fd3da96
-  data.tar.gz: 93c489cfcc963a51ce748546f5b196ce5dadbbdc
+  metadata.gz: 59e312f51b512269d4ea31095f39b27c2d67e37a
+  data.tar.gz: 6e346df688f98baa773efda599fc5c46647452d3
 SHA512:
-  metadata.gz: 96525a7a80502abd1ab189954114b340f969e2905f99edc736e0da420ff5a24d84ff0ddc66a2aa0aabd13efac81b78ac9e4427ecd97460c18e2d656db0535af6
-  data.tar.gz: d573bb97c9d3dc597c90f369c0cf1918490621bd9966f26b8d9ecc3b9b7f06b7759d1912fa343c6eeff304fa6bff1eb6493ec6b2f5f869b3b9a600765fba2fc5
+  metadata.gz: 4c14899ba350feb3d23f684a3c84f34e8227f1d475ea7ad484d5d34afbf1dc24fcde2c95df3790008d87901cc4bbd13c3fd9d280de70970c2a49a5ff27878771
+  data.tar.gz: 6fa6226506a52ef05c0d017e994bdb9a1770f5830bd2e27de73d3c26a84431d4a1f075a5ecd56364226a97a88836f54120e84f385c343ba212eaa8368546ebcf

data/.rubocop.yml

@@ -1,4 +1,12 @@
-inherit_from: https://raw.githubusercontent.com/anthony-robin/rubocop-rules/master/.rubocop.yml
+inherit_from:
+  - https://raw.githubusercontent.com/anthony-robin/rubocop-rules/master/.rubocop-bundler.yml
+  - https://raw.githubusercontent.com/anthony-robin/rubocop-rules/master/.rubocop-layout.yml
+  - https://raw.githubusercontent.com/anthony-robin/rubocop-rules/master/.rubocop-lint.yml
+  - https://raw.githubusercontent.com/anthony-robin/rubocop-rules/master/.rubocop-naming.yml
+  - https://raw.githubusercontent.com/anthony-robin/rubocop-rules/master/.rubocop-performance.yml
+  - https://raw.githubusercontent.com/anthony-robin/rubocop-rules/master/.rubocop-style.yml
+  - https://raw.githubusercontent.com/anthony-robin/rubocop-rules/master/.rubocop-rails.yml
 
 AllCops:
+  DisabledByDefault: true
   TargetRubyVersion: 2.4

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Change Log
 
+## [v0.3.0](https://github.com/anthony-robin/Ribbonit/tree/v0.3.0) (2017-11-06)
+[Full Changelog](https://github.com/anthony-robin/Ribbonit/compare/v0.2.1...v0.3.0)
+
+**Implemented enhancements:**
+
+- REFACTOR way to define environments to apply [\#25](https://github.com/anthony-robin/Ribbonit/pull/25) ([anthony-robin](https://github.com/anthony-robin))
+- UPDATE Rubocop sources [\#24](https://github.com/anthony-robin/Ribbonit/pull/24) ([anthony-robin](https://github.com/anthony-robin))
+
+**Merged pull requests:**
+
+- CLEAN documentation options [\#26](https://github.com/anthony-robin/Ribbonit/pull/26) ([anthony-robin](https://github.com/anthony-robin))
+
+## [v0.2.1](https://github.com/anthony-robin/Ribbonit/tree/v0.2.1) (2017-06-04)
+[Full Changelog](https://github.com/anthony-robin/Ribbonit/compare/v0.2.0...v0.2.1)
+
+**Fixed bugs:**
+
+- FIX broken CSS [\#21](https://github.com/anthony-robin/Ribbonit/pull/21) ([anthony-robin](https://github.com/anthony-robin))
+
 ## [v0.2.0](https://github.com/anthony-robin/Ribbonit/tree/v0.2.0) (2017-05-28)
 [Full Changelog](https://github.com/anthony-robin/Ribbonit/compare/v0.1.0...v0.2.0)
 

data/README.md

@@ -53,33 +53,34 @@ body
 ```
 
 ## Options
-You can customize some options through the initializer. Here are the defaults options:
+You can customize some options through the initializer. Here are the default ones:
 
 ```ruby
 # config/initializers/ribbonit.rb
-
-# 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
-themes = {
-  development: 'black',
-  staging: 'blue'
-}
-
-# Sometimes, people use another name for this environment
-staging_name = 'staging'
+Ribbonit.configure do |config|
+  # 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 ?
+
+  config.hide_for_small = true # Display ribbon in small devices ?
+  config.position = 'top-left' # top-right, bottom-left, bottom-right
+  config.sticky = true # stick to page corner ?
+
+  # Available colors:
+  # orange, blue, green, red, purple, black, white
+  config.themes = {
+    development: 'black',
+    staging: 'blue',
+    my_custom_environment: 'purple'
+  }
+end
 ```
 
+To add a custom environment, just add it inside the `themes` option and set the color you want (careful, if you define `config.themes` in your initializer it will erase default environments values so you will have to readd them).
+
 ## Screenshots
 ### Colors
 <table>

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

@@ -10,7 +10,7 @@
   <% end %>
 </span>
 
-<% if config.infos_to_display.include?(:git_branch) && Rails.env.development? %>
+<% if config.infos_to_display.include?(:git_branch) %>
   <span class="ribbon__container__git">
     Branch: <strong><%= branch_name %></strong>
   </span>

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

@@ -1,6 +1,6 @@
 <% config = Ribbonit.configuration %>
 
-<% if Rails.env.development? || Rails.env.send("#{config.staging_name}?") %>
+<% if config.themes.keys.include? Rails.env.to_sym %>
 
 <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] %>">

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

@@ -42,9 +42,4 @@ Ribbonit.configure do |config|
     development: 'black',
     staging: 'blue'
   }
-
-  ###
-  # Environment name
-  #
-  config.staging_name = 'staging'
 end

data/lib/ribbonit/configuration.rb

@@ -8,23 +8,22 @@ module Ribbonit
   def self.configure
     yield configuration
   end
-end
 
-class Ribbonit::Configuration
-  include ActiveSupport::Configurable
+  class Configuration
+    include ActiveSupport::Configurable
 
-  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: 'black',
-      staging: 'blue'
-    }
+    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: 'black',
+        staging: 'blue'
+      }
+    end
   end
-  config_accessor(:staging_name) { 'staging' }
 end

data/lib/ribbonit/rails/engine.rb

@@ -4,7 +4,7 @@ require 'ribbonit/view_helpers'
 module Ribbonit
   module Rails
     class Engine < ::Rails::Engine
-      initializer 'ribbonit.view_helpers' do |app|
+      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"

data/lib/ribbonit/version.rb

@@ -1,3 +1,3 @@
 module Ribbonit
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/lib/ribbonit/view_helpers.rb

@@ -1,17 +1,19 @@
-module Ribbonit::ViewHelpers
-  def ribbonit
-    render '/ribbon'
-  end
+module Ribbonit
+  module ViewHelpers
+    def ribbonit
+      render '/ribbon'
+    end
 
-  def branch_name
-    `git rev-parse --abbrev-ref HEAD`.gsub('feature/', '')
-  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
+    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)
+      height
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ribbonit
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Anthony Robin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-04 00:00:00.000000000 Z
+date: 2017-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails