sweetify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f789039fd2d9f4ab21db360af580e92b1af57315
+  data.tar.gz: ef1a2472e02d7713835d70172bdc5639713d6846
+SHA512:
+  metadata.gz: 81b4a5787bfbb2ed630fc5be61dd9f1dcca5565e8909867fc01be63a63a98d269a5d73a28725b02b3c7bfcedc00329c6e3798c596331b9162380e5f3360d730b
+  data.tar.gz: 0ec18b7173fe8a1005950f455f7eb352044509d171e5d0a3ce51df7c13050d2cd508d973e3b8382b162389b0c38e5fa5b617b4e9010a31b839e4632d225aa0b5

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2016, Atrox
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of Sweetify nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,92 @@
+# Sweetify - SweetAlert for Rails
+This gem allows you to use [SweetAlert](http://t4t5.github.io/sweetalert/) for your flash messages.
+_See the examples below, to see how it looks like_
+
+## Installation
+**Note: This package does not provide the client side javascript and css files of SweetAlert. You have to provide them yourself.**
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sweetify'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Next add the following line to the bottom of your application's layout file:
+```html
+...
+
+<%= render 'sweetify/alert' %>
+
+</body>
+</html>
+```
+
+**You have to restart your rails server after installing the gem**
+
+## Usage
+You can now easily create alerts in your controllers with any of the following methods provided by **Sweetify**:
+```ruby
+# Base Method, no type specified
+sweetalert(text, title = '', opts = {})
+
+# Additional methods with the type already defined
+alert_info(text, title = '', opts = {})
+alert_success(text, title = '', opts = {})
+alert_error(text, title = '', opts = {})
+alert_warning(text, title = '', opts = {})
+```
+
+## Example Usage
+```ruby
+# POST /resource
+def create
+    alert_success('Your resource is created and available.', 'Successfully created', persistent: 'Awesome!')
+    redirect_to resource_path
+end
+```
+
+That would look like this after the redirect:
+
+![Example Alert](http://i.imgur.com/3WMvk0y.png)
+
+
+## Options
+**By default, all alerts will dismiss after a sensible default number of seconds.**
+
+Default Options set by **Sweetify**:
+```ruby
+{
+    showConfirmButton: false,
+    timer:             2000,
+    allowOutsideClick: true,
+    confirmButtonText: 'OK'
+}
+```
+
+The following special options provided by **Sweetify** are available:
+```ruby
+sweetalert('Text', 'Title', button: true) # Shows an button with the default content on the alert but still closes automatically
+sweetalert('Text', 'Title', button: 'Awesome!') # Same as above just with a specified text
+
+sweetalert('Text', 'Title', persistent: true) # Shows the dialog with an button and the alert only closes if the button is pressed
+sweetalert('Text', 'Title', persistent: 'Awesome!') # Same as above just with a specified text
+```
+
+You also can use any other available option that [SweetAlert accepts](http://t4t5.github.io/sweetalert/):
+```ruby
+alert_info('Here is a custom image', 'Sweet!', imageUrl: 'images/thumbs-up.jpg', timer: 5000)
+```
+
+
+## Contributing
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/atrox/sweetify/issues)
+- Fix bugs and [submit pull requests](https://github.com/atrox/sweetify/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Sweetify'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+
+task default: :test

data/app/views/sweetify/_alert.html.erb

@@ -0,0 +1,5 @@
+<% if flash[:sweetify].present? %>
+    <script>
+      swal(<%= flash[:sweetify].html_safe %>)
+    </script>
+<% end %>

data/lib/sweetify.rb

@@ -0,0 +1,2 @@
+require 'sweetify/engine'
+require 'sweetify/sweetify'

data/lib/sweetify/engine.rb

@@ -0,0 +1,4 @@
+module Sweetify
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/sweetify/sweetify.rb

@@ -0,0 +1,93 @@
+module Sweetify
+
+  # Display an alert with a text and an optional title
+  # Default without an specific type
+  #
+  # @param [String] text Body of the alert (gets automatically the title if no title is specified)
+  # @param [String] title TItle of the alert
+  # @param [Hash] opts Optional Parameters
+  def sweetalert(text, title = '', opts = {})
+    opts = {
+        showConfirmButton: false,
+        timer:             2000,
+        allowOutsideClick: true,
+        confirmButtonText: 'OK'
+    }.merge(opts)
+
+    opts[:text]  = text
+    opts[:title] = title
+
+    if opts[:button]
+      opts[:showConfirmButton] = true
+      opts[:confirmButtonText] = opts[:button] if opts[:button].is_a?(String)
+    end
+
+    if opts[:persistent]
+      opts[:showConfirmButton] = true
+      opts[:allowOutsideClick] = false
+      opts[:timer]             = nil
+      opts[:confirmButtonText] = opts[:persistent] if opts[:persistent].is_a?(String)
+    end
+
+    flash_config(opts)
+  end
+
+  # Information Alert
+  #
+  # @param [String] text Body of the alert (gets automatically the title if no title is specified)
+  # @param [String] title TItle of the alert
+  # @param [Hash] opts Optional Parameters
+  def alert_info(text, title = '', opts = {})
+    opts[:type] = :info
+    sweetalert(text, title, opts)
+  end
+
+  # Success Alert
+  #
+  # @param [String] text Body of the alert (gets automatically the title if no title is specified)
+  # @param [String] title TItle of the alert
+  # @param [Hash] opts Optional Parameters
+  def alert_success(text, title = '', opts = {})
+    opts[:type] = :success
+    sweetalert(text, title, opts)
+  end
+
+  # Error Alert
+  #
+  # @param [String] text Body of the alert (gets automatically the title if no title is specified)
+  # @param [String] title TItle of the alert
+  # @param [Hash] opts Optional Parameters
+  def alert_error(text, title = '', opts = {})
+    opts[:type] = :error
+    sweetalert(text, title, opts)
+  end
+
+  # Warning Alert
+  #
+  # @param [String] text Body of the alert (gets automatically the title if no title is specified)
+  # @param [String] title TItle of the alert
+  # @param [Hash] opts Optional Parameters
+  def alert_warning(text, title = '', opts = {})
+    opts[:type] = :warning
+    sweetalert(text, title, opts)
+  end
+
+  private
+
+  # Flash the configuration as json
+  # If no title is specified, use the text as the title
+  #
+  # @param [Hash] opts
+  # @return [Void]
+  def flash_config(opts)
+    if opts[:title].blank?
+      opts[:title] = opts[:text]
+      opts.delete(:text)
+    end
+
+    flash[:sweetify] = opts.to_json
+  end
+
+end
+
+ActionController::Base.send :include, Sweetify

data/lib/sweetify/version.rb

@@ -0,0 +1,3 @@
+module Sweetify
+  VERSION = '0.1.0'
+end

data/lib/tasks/sweetify_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :sweetify do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: sweetify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Atrox
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  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: Sweetify allows you to easily use SweetAlert within your controllers
+email:
+- mail@atrox.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/views/sweetify/_alert.html.erb
+- lib/sweetify.rb
+- lib/sweetify/engine.rb
+- lib/sweetify/sweetify.rb
+- lib/sweetify/version.rb
+- lib/tasks/sweetify_tasks.rake
+homepage: https://github.com/atrox/sweetify
+licenses:
+- BSD-3-Clause
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: SweetAlert integrated in Ruby on Rails
+test_files: []