lay_me_out 1.2.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b821c76a87f35b36fcf58900c84cbf803d4364fb
+  data.tar.gz: 075f0427d11be11061c3d4fb1d11958e2b22a5fa
+SHA512:
+  metadata.gz: 2582116f29a042dd09893a2ab39c83f8e7961bad0f5abeb76de3e80026479ceb931c25c91b1b8b17785593038a110966676121ada1c57ce38c65f4354a20c8ad
+  data.tar.gz: 91132a4ceeabdcfb8f8ced8249593ee5ce103187378a121eb6ca78777643d40a4589d6b5bdadbbeaf7926d0649e08c992d6cc71456689c13f884b6fcf37247bc

data/README.md

@@ -0,0 +1,172 @@
+# LayMeOut
+
+Provides the common layout and assets for all PayrollHero apps. **LayMeOut requires the asset pipeline to automatically include stylesheets.**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'lay_me_out'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lay_me_out
+
+## Usage
+
+Add this line to your app's `ApplicationController`:
+
+    include LayMeOut::Layout
+
+then require LayMeOut in your application.css file:
+
+    *= require self
+    *= require lay_me_out
+
+and in your application.js file:
+
+    //= require jquery
+    //= require lay_me_out
+
+and you are all hooked up!
+
+### Simple Layout
+
+Lay-Me-Out comes with two different types of layouts - the default layout, and a basic layout.  If you would like to use the basic layout, simply add the following line after the include in your controller:
+
+    use_simple_layout
+
+### User Profile
+
+The user profile partial expects a method called `#current_user_details` to be available from the current controller. It should return a `LayMeOut::UserDetails` object that responds to the following:
+* `#name` - Returns a string representing the user's name
+* `#position` - Returns a string representing the user's job position
+* `#links` - Returns a hash representing the links to appear in the user profile drop down.  The key should be the link title, the value should be the link itself.
+* `#profile_picture` - Returns a url to the user's profile picture.
+
+```ruby
+def current_user_details
+  LayMeOut::UserDetails.new(
+    :name => "Bruce Wayne",
+    :position => "Caped Crusader",
+    :links => { "Bruce Wayne" => "http://localhost:3000", "Profile Settings" => "http://localhost:3000/profile", "Logout" => "http://localhost:3000/logout" },
+    :profile_picture => "https://example.com/profile.png"
+  )
+end
+```
+
+The only required field is name.
+
+### Navigation
+
+The navigation bar expects a method called `#navigation_links` to be available from the current controller. It should return a hash where the keys are the link title, and the value is either the path or a nested hash.
+E.g.
+
+```ruby
+{
+  "Dashboards" => root_path,
+  "My Clock" => {
+    "My Clock" => "/my_clock",
+    "Time Card & Accruals" => "/time_card"
+  },
+  "Scheduling" => "/scheduling",
+  "Analytics" => "/analytics",
+  "Developer" => {
+    "Biometric Verification" => "/verification",
+  }
+}
+```
+
+### Flash Messages
+
+Flash messages are built in to the layout gem. If it is a flash message displayed through a normal page reload, then they will automatically work.
+If you want to display the messages through an AJAX request, you can currently do so by calling the following function in your Javascript:
+
+```javascript
+var flash = LayMeOut.Utils.FlashMessage.getInstance({
+  containerId: 'flash',
+  messageClass: 'message',
+  messageTemplateId: 'flash-message-template',
+  interval: 5000
+});
+```
+
+Then you can show a message using:
+
+```javascript
+flash.showFlashMessages({ type: "error", content: "You did something bad!"});
+```
+
+Or multiple messages using:
+
+```javascript
+flash.showFlashMessages([ { type: "error", content: "You did something bad!"},
+                          { type: "warning", content: "Meh, whatever"},
+                          { type: "success", content: "You did something good!"},
+                          { type: "success", content: "And another thing too!"}
+                        ]);
+```
+
+Currently supported flash message types are **error**, **warning** and **success**.
+
+### Breadcrumbs
+
+LayMeOut uses [breadcrumbs_on_rails](https://github.com/weppos/breadcrumbs_on_rails) to display breadcrumbs. The basic way to add breadcrumbs is like this:
+
+```ruby
+class MyController < ApplicationController
+  add_breadcrumb "home", :root_path
+  add_breadcrumb "my", :my_path
+
+  def index
+    # ...
+
+    add_breadcrumb "index", index_path
+  end
+end
+```
+
+Please see the [breadcrumbs_on_rails docs](http://www.simonecarletti.com/code/breadcrumbs_on_rails/) for further usage.
+
+### Styleguide
+
+Add this line to your app's `config/routes.rb`:
+
+```ruby
+mount LayMeOut::Engine => "/lay_me_out"
+```
+
+Then go to `localhost:3000/lay_me_out` on your app to see the style guide.
+
+### Segment.io Support
+
+LayMeOut provides client-side support for Segment.io.  In order to configure it, simply provide an initializer file in config/initializers with the Segment.io secret as follows:
+
+```ruby
+#config/initializers/segment_io.rb
+SegmentIO.configure do |config|
+  config.api_key = 'abcd123456' #replace with your segment.io API key
+end
+```
+
+**Segment.io will only be applied when Rails is using the production environment. If you want server-side support, you will need to include the [analytics-ruby](https://github.com/segmentio/analytics-ruby) gem and set it up with your web server**
+
+### Layout Hooks
+
+There are two yields in both layouts in case you need to insert content such as css and javascript include tags in the head tag or the footer div. In your view, for the header use:
+
+```ruby
+- content_for :header_content do
+  #content to insert
+```
+
+And for the footer use:
+
+```ruby
+- content_for :footer_content do
+  #content to insert
+```

data/Rakefile

@@ -0,0 +1,89 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+require 'ansi'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'LayMeOut'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+begin
+  require 'jasmine'
+  load 'jasmine/tasks/jasmine.rake'
+rescue LoadError
+  task :jasmine do
+    abort "Jasmine is not available. In order to run jasmine, you must: (sudo) gem install jasmine"
+  end
+end
+
+require "bundler/gem_tasks"
+require "yaml"
+
+def version_file_name
+  "lib/#{gem_name}/version.rb"
+end
+
+def get_version
+  r = eval "module TempVersionModule; #{File.read(version_file_name)}; end", binding, version_file_name
+  Object.send(:remove_const, "TempVersionModule")
+  r
+end
+
+def gem_name
+  File.basename(Dir["*.gemspec"].first).gsub(/\.gemspec$/, '')
+end
+
+def git_directory_dirty?
+  status = `git status --porcelain`
+  status.strip == '' ? false : status
+end
+
+task :ensure_clean_working_directory do
+  if dirty = git_directory_dirty?
+    $stderr.puts ANSI.red { "Can't push! Working directory not clean!" }
+    $stderr.puts ANSI.yellow { dirty }
+    exit 1
+  end
+end
+
+task :push_version_changes_to_git do
+  sh "git add #{version_file_name} #{gem_name}.gemspec"
+  sh "git commit -m '#{get_version}'"
+  sh "git push"
+end
+
+task :push => :ensure_clean_working_directory do
+
+  raise "please set EDITOR variable" unless ENV["EDITOR"]
+  system "$EDITOR #{version_file_name}"
+
+  unless git_directory_dirty?
+    $stderr.puts ANSI.red { "version not changed!" }
+    exit 1
+  end
+
+  Rake::Task[:build].invoke
+
+  system("fury push pkg/#{gem_name}-#{get_version}.gem --as=payrollhero")
+  puts "Done"
+
+  Rake::Task[:push_version_changes_to_git].invoke
+end

data/app/assets/javascripts/lay_me_out.js

@@ -0,0 +1,18 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery_ujs
+//= require lay_me_out/utils/namespace
+//= require lay_me_out/application-config
+//= require lay_me_out/utils/flash-message
+//= require lay_me_out/navigation.js
+//= require lay_me_out/user_profile.js

data/app/assets/javascripts/lay_me_out/application-config.js

@@ -0,0 +1,3 @@
+LayMeOut.namespace('LayMeOut.Navigation');
+LayMeOut.namespace('LayMeOut.UserProfile');
+LayMeOut.namespace('LayMeOut.Utils');

data/app/assets/javascripts/lay_me_out/navigation.js

@@ -0,0 +1,29 @@
+(function (Navigation, $) {
+  var displaySubmenu = function(menuItem, submenu) {
+    var activeMenuItem = $(menuItem);
+    $(submenu).hide();
+
+    if (activeMenuItem.hasClass('has-sub-menu')) activeMenuItem.find(submenu).show();
+  };
+
+  var activateMenuItem = function(menu, menuItem) {
+    $(menu + "> ul > li").removeClass('active');
+    menuItem.addClass('active');
+  }
+
+  Navigation.displaySubmenu = displaySubmenu;
+  Navigation.activateMenuItem = activateMenuItem;
+})(LayMeOut.Navigation, jQuery);
+
+$(function(){
+  LayMeOut.Navigation.displaySubmenu('nav.main > ul > li.active', '.sub-menu');
+
+  $('nav.main > ul > li > a').click(function() {
+      var menuItem = $(this).parent();
+
+      if (menuItem.hasClass('has-sub-menu')) event.preventDefault();
+
+      LayMeOut.Navigation.activateMenuItem('nav.main', menuItem)
+      LayMeOut.Navigation.displaySubmenu('nav.main > ul > li.active', '.sub-menu');
+  });
+});

data/app/assets/javascripts/lay_me_out/user_profile.js

@@ -0,0 +1,25 @@
+(function (UserProfile, $) {
+  var toggleMenu = function(menu) {
+    var menu = $(menu);
+
+    if (menu.is(':visible')) {
+      menu.hide();
+    }
+    else {
+      menu.show();
+
+      $('body').one('click',function() {
+        toggleMenu(menu);
+      });
+    };
+  };
+
+  UserProfile.toggleMenu = toggleMenu;
+})(LayMeOut.UserProfile, jQuery);
+
+$(function(){
+  $('div.user-profile div.drop-down').click(function(event) {
+    event.stopPropagation();
+    LayMeOut.UserProfile.toggleMenu('ul.user-nav');
+  });
+});

data/app/assets/javascripts/lay_me_out/utils/flash-message.js

@@ -0,0 +1,68 @@
+(function(Application, jQuery, _){
+  _.extend(
+    Application.namespace('LayMeOut.Utils'),
+    (function($) {
+      var _FlashMessage = function(options) {
+        this.containerId = '#' + options.containerId;
+        this.messageClass = '.' + options.messageClass;
+        this.messageTemplateId = options.messageTemplateId;
+        this.interval = options.interval;
+      };
+
+      _FlashMessage.prototype = (function() {
+        var _showFlashMessage = function(message) {
+          var self = this;
+          var element = _addFlashMessage.apply(self, [message]);
+          element.fadeIn('slow');
+
+          setTimeout(function(){
+            _removeFlashMessage.apply(self, [element]);
+          }, self.interval);
+        };
+
+        var _showFlashMessages = function(messages) {
+          var self = this;
+
+          if(!_.isArray(messages)) {
+            messages = [messages];
+          }
+          _.each(messages, function(message) {
+            _showFlashMessage.apply(self, [message]);
+          });
+        };
+
+        var _addFlashMessage = function(message) {
+          var self = this;
+          var rawHtml = ich[self.messageTemplateId](message);
+          $(self.containerId).prepend(rawHtml);
+          return $(self.containerId).find(self.messageClass).first()
+        };
+
+        var _removeFlashMessage = function(element) {
+          $(element).fadeOut(function(){
+            $(this).remove();
+          });
+        };
+
+        return {
+          showFlashMessages: _showFlashMessages
+        };
+      }());
+
+      var FlashMessage = (function() {
+        var instance;
+
+        return {
+          getInstance: function(options) {
+            if(_.isUndefined(instance)) {
+              instance = new _FlashMessage(options);
+            }
+            return instance;
+          }
+        };
+      }());
+
+      return {FlashMessage: FlashMessage};
+    }(jQuery, ich))
+  );
+}(window.LayMeOut = window.LayMeOut || {}, jQuery, _));

data/app/assets/javascripts/lay_me_out/utils/namespace.js

@@ -0,0 +1,17 @@
+(function(LayMeOut){
+  LayMeOut.namespace = function(namespace_str) {
+    var namespace_parts = namespace_str.split('.'),
+      parent_namespace = LayMeOut;
+
+    if(_.first(namespace_parts) === "LayMeOut") {
+      namespace_parts = namespace_parts.slice(1);
+    }
+
+    _.each(namespace_parts, function(namespace_part) {
+      parent_namespace[namespace_part] = parent_namespace[namespace_part] || {};
+      parent_namespace = parent_namespace[namespace_part];
+    });
+
+    return parent_namespace;
+  };
+}(window.LayMeOut = window.LayMeOut || {}));