crouton 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 547d77e7d2b5efcaac506b282fa5572bc0989fd3
+  data.tar.gz: 81e881ab0ef92b2c4dca9d7fefc209e55dbf7eac
+SHA512:
+  metadata.gz: c3a8841f50d17158041be5e3dee63697856df8659f9336fe54e1e0a803f4afdb5e848fecd32517825ba573acd9a8f2a0894acad241356534de52281deaaadb47
+  data.tar.gz: e9e177e8dedf83704121d7a3962b876f82e254215067fc239a2b1535cdb92a2fa86b7db12e5b4f42199d82bfc96a935141c836c0feb94eef6da0f0111cb29462

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Máximo Mussini
+
+MIT License
+
+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.md

@@ -0,0 +1,86 @@
+Crouton
+=====================
+[![Gem Version](https://badge.fury.io/rb/crouton.svg)](http://badge.fury.io/rb/crouton)
+
+Context sensitive notifications for Rails && XHR.
+
+## Installation
+
+    gem install 'crouton'
+
+## Usage
+
+Simply require `crouton` in your javascript and css:
+
+``` javascript
+//= require crouton
+```
+
+``` sass
+@import crouton
+```
+
+Now, use the `render_crouton` method in your controllers, any option you pass
+will be converted to a message, and displayed in the browser.
+
+``` ruby
+class PostsController < ActionController::Base
+
+  def update
+    if @post.save
+      render_crouton notice: 'Saved'
+    else
+      render_crouton errors: @post.errors
+    end
+  end
+end
+```
+
+## Customization
+Three styles are supported out of the box: __info__, __warning__ and __danger__.
+The duration of each message is 1500, 2000 and 3000 respectively.
+
+![screen shot 2014-08-11 at 3 44 10 pm](https://cloud.githubusercontent.com/assets/1158253/3881070/74f526c4-218a-11e4-8ada-63110a789647.png)
+![screen shot 2014-08-11 at 3 43 44 pm](https://cloud.githubusercontent.com/assets/1158253/3881068/74eb79e4-218a-11e4-9734-3a118e9ff853.png)
+![screen shot 2014-08-11 at 3 43 23 pm](https://cloud.githubusercontent.com/assets/1158253/3881069/74ebb8a0-218a-11e4-90e6-3efe5cfade53.png)
+
+You can customize the colours for this three styles by defining the following SASS variables:
+ - `$crouton-info`
+ - `$crouton-warning`
+ - `$crouton-danger`
+
+You can also create your custom messages:
+
+```ruby
+render_crouton Crouton::Message.new(:hint, 'You can double tap for more info.', duration: 5000)
+```
+
+License
+--------
+
+    Copyright (c) 2014 Máximo Mussini
+
+    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.
+
+
+Credits
+--------
+
+The name and the idea of Crouton originates in a [blog article](http://cyrilmottier.com/2012/07/24/the-making-of-prixing-4-activity-tied-notifications/) by Cyril Mottier.

data/app/views/crouton/_croutons.js.erb

@@ -0,0 +1,3 @@
+$('<%= croutons.placeholder %>').showCroutons(
+  '<%=j (render partial: 'crouton/message', collection: croutons.messages, as: :message) %>'
+);

data/app/views/crouton/_message.html.erb

@@ -0,0 +1,4 @@
+<div class="crouton crouton-<%= message.css %>" data-duration="<%= message.duration %>">
+  <button aria-hidden="true" class="close" data-dismiss="alert">&times;</button>
+  <span class="message"><%= message.content %></span>
+</div>

data/crouton.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = "crouton"
+  s.version = '0.1.0'
+  s.description = "Context sensitive notifications for Rails."
+  s.summary = "Context sensitive notifications for Rails, the name and idea originated in a blog article written by Cyril Mottier on Android notifications."
+  s.licenses = ['MIT']
+
+  s.authors = ["Máximo Mussini"]
+  s.email = ["maximomussini@gmail.com"]
+  s.homepage = %q{https://github.com/ElMassimo/crouton}
+
+  s.platform = Gem::Platform::RUBY
+  s.required_ruby_version = '>=1.9'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = ["README.md"]
+
+  s.add_dependency 'railties'
+  s.add_dependency 'sass-rails'
+  s.add_dependency 'jquery-rails'
+
+  s.add_development_dependency 'bundler', '~> 1.3'
+  s.add_development_dependency 'rake'
+end

data/lib/assets/javascripts/crouton.js

@@ -0,0 +1,27 @@
+var DEFAULT_ANIMATION_MILLIS = 300;
+var DEFAULT_DURATION_MILLIS = 1500;
+
+function animateCrouton(crouton) {
+  animationMillis = crouton.data('animation') || DEFAULT_ANIMATION_MILLIS;
+  durationMillis = crouton.data('duration') || DEFAULT_DURATION_MILLIS;
+
+  crouton.animate({height: 'toggle'}, animationMillis, 'swing', function hideCrouton() {
+    crouton.delay(durationMillis).animate({ height: 'toggle' }, animationMillis, 'swing', removeCrouton);
+  });
+}
+
+function removeCrouton() {
+  $(this).remove();
+}
+
+$.fn.showCrouton = function(crouton) {
+  $(this).before(crouton.hide());
+  animateCrouton(crouton);
+}
+
+$.fn.showCroutons = function(croutons) {
+  placeholder = $(this);
+  $(croutons).each(function(i) {
+    placeholder.showCrouton($(this));
+  });
+}

data/lib/assets/stylesheets/crouton.css.scss

@@ -0,0 +1,42 @@
+$crouton-height: 36px !default;
+$crouton-big-height: $crouton-height*1.5 !default;
+
+$crouton-info: #0A97B1 !default;
+$crouton-warning: #E1AA27 !default;
+$crouton-danger: #B10A0A !default;
+
+.crouton {
+  height: $crouton-height; line-height: $crouton-height;
+  color: white;
+  text-align: center;
+  font-weight: 100;
+  position: relative;
+
+  &.crouton-info {
+    background: $crouton-info;
+  }
+  &.crouton-warning {
+    background: $crouton-warning;
+  }
+  &.crouton-danger{
+    background: $crouton-danger;
+  }
+}
+
+.crouton, .crouton + .card-content {
+  box-shadow: inset 0px 4px 6px -7px black;
+}
+
+.crouton > .close {
+  position: absolute;
+  right: 8px;
+  font-size: 28px;
+  line-height: inherit;
+}
+
+.crouton-big {
+  height: inherit;
+  line-height: $crouton-big-height - 20px;
+  font-size: 25px;
+  padding: 8px 10%;
+}

data/lib/crouton.rb

@@ -0,0 +1 @@
+require 'crouton/crouton'

data/lib/crouton/crouton.rb

@@ -0,0 +1,18 @@
+require 'crouton/presenter'
+
+module Crouton
+
+  module Concern
+    def render_crouton(messages={}, options={})
+      render partial: 'crouton/croutons', locals: { croutons: Presenter.new(messages, options) }
+    end
+  end
+
+  class Engine < Rails::Engine
+    initializer :crouton_controller do
+      ActionController::Base.class_eval do
+        include Crouton::Concern
+      end
+    end
+  end
+end

data/lib/crouton/message.rb

@@ -0,0 +1,30 @@
+module Crouton
+  class Message
+    attr_reader :type, :content, :duration
+
+    DEFAULT_MESSAGE = 'Saved'
+    CSS = { notice: :info, error: :danger, alert: :warning }
+
+    def initialize(type=:info, content=DEFAULT_MESSAGE, options={})
+      @type, @content = type.to_sym, content
+      @duration = options[:duration] || default_duration
+    end
+
+    def css
+      CSS[@type] || @type
+    end
+
+    private
+
+    def default_duration
+      case css
+      when :danger then 3000
+      when :warning then 2000
+      end
+    end
+
+    def self.to_proc
+      ->(args){ new(*args) }
+    end
+  end
+end

data/lib/crouton/presenter.rb

@@ -0,0 +1,31 @@
+require 'crouton/message'
+
+module Crouton
+  class Presenter
+    attr_reader :placeholder, :messages
+    delegate :each, to: :messages
+
+    def initialize(messages, options={})
+      @placeholder = options.delete(:placeholder) || '.crouton-placeholder'
+      messages = from_hash(messages) if messages.is_a?(Hash)
+      @messages = *messages
+    end
+
+    private
+
+    def from_hash(messages)
+      messages.delete_if {|name, msg| msg.blank? }
+
+      if (errors = messages[:errors]).present?
+        errors_to_messages(errors)
+      else
+        messages.map(&Message).presence || [Message.new]
+      end
+    end
+
+    # Internal: Converts errors to an array of error messages.
+    def errors_to_messages(errors)
+      errors.full_messages.map {|error| Message.new(:error, error) }
+    end
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: crouton
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Máximo Mussini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  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: sass-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: jquery-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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: Context sensitive notifications for Rails.
+email:
+- maximomussini@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- app/views/crouton/_croutons.js.erb
+- app/views/crouton/_message.html.erb
+- crouton.gemspec
+- lib/assets/javascripts/crouton.js
+- lib/assets/stylesheets/crouton.css.scss
+- lib/crouton.rb
+- lib/crouton/crouton.rb
+- lib/crouton/message.rb
+- lib/crouton/presenter.rb
+homepage: https://github.com/ElMassimo/crouton
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Context sensitive notifications for Rails, the name and idea originated in
+  a blog article written by Cyril Mottier on Android notifications.
+test_files: []
+has_rdoc: