rails_toastify 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4facfb08cf16ff46f7bb4d9052e9b52a8f331c51b05579ce85eb7faec0758ffc
-  data.tar.gz: 32b3aacc1d3f4cef8d7051193efcba1aa372548cb7172f3009e58674cc653b79
+  metadata.gz: a4c911f3af15f4890c1444105b9f61e171df86f803c36b673664876fd1b5df78
+  data.tar.gz: 925b7c0a30747f92a1e9f2bf7d1ee306a000a445e7d35722c35b35dcb79bd87a
 SHA512:
-  metadata.gz: dd34bf182256c88b3e7b9f4738e70d9867661620e346b24144230d4f231afe7b24d74a12779f53b33da93f20de78fac23d7c67aea18a69ddc5917c9b9c8a7de2
-  data.tar.gz: 81720cc49549376ba3a4841f49ff94d391826ea367cdbd019b62b4e3f69881b78ac33d5d2f3d1b12ccb09b8d67d993686e2e45045cf0dd89f55549ed36f7bc15
+  metadata.gz: 928bab3cac6f526bb1b5261a5fbedb31e33412e335344e60a377c6500c17c14496af4fbe85fb8fa4c8ce7856f29678bf386d38689a431a1cff318872dab7b11b
+  data.tar.gz: 4af1c98f67a8b37f05089c8d11060398a7a0046dcfd8c6d5d9361e93eff8a2a6c28eef410eb24247eda7f105c3683501bfc9bb63931c38c8f6ccd724c87313bf

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+## 0.1.3
+
+- Change README
+- Load configs on module RailsToastify
+- Change engine to add initializer
+- Add style for tailwind template
+- Add generator
+- Add template
+
+## 0.1.2
+
+- Change README
+- Add CHANGELOG
+- Add MIT LICENSE
+- Create Engine
+- Create Javascript
+- Create Style
+  
+## 0.1.1
+
+- Add basic structure
+
+## 0.1.0
+
+- First release

data/MIT-LICENSE.md

@@ -0,0 +1,5 @@
+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

@@ -1,31 +1,72 @@
 # RailsToastify
 
-TODO: Delete this and the text below, and describe your gem
+**Rails Toastify** allows you to easily add notifications to your app. Please note: this gem is still under development. Please CONTRIBUTE.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rails_toastify`. To experiment with that code, run `bin/console` for an interactive prompt.
+The **Rails Toastify** gem is completely inspired by the [React Toastify](https://fkhadra.github.io/react-toastify/introduction/) lib and is specially made for those React developers who are migrating to Rails thanks to Hotwire or for any other reason, and who love using Toasts and wanted a gem that makes it as easy as it is in React. 🎉 
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Add gem in your Gemfile:
+```ruby
+gem 'rails_toastify'
+```
+and run **bundle install**
 
-Install the gem and add to the application's Gemfile by executing:
+After run:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```sh
+rails generate rails_toastify:install
+```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+This will create a file *config/initializers/rails_toastify.rb* where you can define the framework you want to use:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```ruby
+RailsToastify.configure do |config|
+  config.framework = :tailwind # or :bootstrap
+end
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+In your *application.html.erb* add:
 
-## Development
+```ruby
+<%= stylesheet_link_tag 'rails_toastify', media: 'all' %>
+<%= javascript_include_tag 'rails_toastify' %>
+```
+And:
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```html
+<div id="toast-container" class="toast-container"></div>
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+In your *config/manifest.js* add:
 
-## Contributing
+```js
+//= link rails_toastify.css
+//= link rails_toastify.js
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails_toastify.
+And call function `RailsToastify.showToast` any javascript:
+
+```ruby
+RailsToastify.showToast('This is a success message!', 'success');
+RailsToastify.showToast('This is an error message!', 'error');
+RailsToastify.showToast('This is an info message!', 'info');
+RailsToastify.showToast('This is a warning message!', 'warning');
+```
+
+## Requirements
+
+- Ruby >= 2.6.0 (recommended 2.7+)  
+- Rails >= 6.0 (compatible up to Rails 7)
+  
+## Contributing to Rails Toastify
+
+Fork, fix, then send a pull request. Bug reports and pull requests are welcome on GitHub at **https://github.com/eltonsantos/rails_toastify**.
+
+## Licence
+
+This gem is available as open-source under the terms of The MIT License (MIT).
+
+Copyright (c) 2024 **Elton Santos**. See **MIT-LICENSE** for further details.

data/app/assets/javascripts/rails_toastify.js

@@ -0,0 +1,27 @@
+document.addEventListener('DOMContentLoaded', () => {
+  window.RailsToastify = {
+    showToast(message, type = 'info', duration = 3000) {
+      const toastContainer = document.querySelector('.toast-container') || createToastContainer();
+      const toast = createToast(message, type);
+      toastContainer.appendChild(toast);
+      setTimeout(() => {
+        toast.classList.add('fade-out');
+        toast.addEventListener('transitionend', () => toast.remove());
+      }, duration);
+    }
+  };
+
+  function createToastContainer() {
+    const container = document.createElement('div');
+    container.className = 'toast-container';
+    document.body.appendChild(container);
+    return container;
+  }
+
+  function createToast(message, type) {
+    const toast = document.createElement('div');
+    toast.className = `toast toast--${type}`;
+    toast.textContent = message;
+    return toast;
+  }
+});

data/app/assets/stylesheets/rails_toastify.css

@@ -0,0 +1,60 @@
+<% if RailsToastify.configuration.framework == :bootstrap %>
+  .toast-container {
+    position: fixed;
+    z-index: 9999;
+    pointer-events: none;
+    top: 20px;
+    right: 20px;
+  }
+
+  .toast {
+    display: flex;
+    align-items: center;
+    background-color: #fff;
+    border-radius: 4px;
+    box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
+    padding: 16px;
+    margin: 8px;
+    color: #333;
+  }
+
+  .toast--success {
+    border-left: 5px solid #4caf50;
+  }
+
+  .toast--error {
+    border-left: 5px solid #f44336;
+  }
+
+  .toast--info {
+    border-left: 5px solid #2196f3;
+  }
+
+  .toast--warning {
+    border-left: 5px solid #ff9800;
+  }
+<% elsif RailsToastify.configuration.framework == :tailwind %>
+  .toast-container {
+    @apply fixed z-50 pointer-events-none top-4 right-4;
+  }
+
+  .toast {
+    @apply flex items-center bg-white rounded shadow p-4 my-2 text-gray-800;
+  }
+
+  .toast--success {
+    @apply border-l-4 border-green-500;
+  }
+
+  .toast--error {
+    @apply border-l-4 border-red-500;
+  }
+
+  .toast--info {
+    @apply border-l-4 border-blue-500;
+  }
+
+  .toast--warning {
+    @apply border-l-4 border-yellow-500;
+  }
+<% end %>

data/lib/generators/rails_toastify/install/install_generator.rb

@@ -0,0 +1,13 @@
+module RailsToastify
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      desc "Create RailsToastify config"
+
+      def create_config_file
+        copy_file "rails_toastify.rb", "config/initializers/rails_toastify.rb"
+      end
+    end
+  end
+end

data/lib/generators/rails_toastify/install/templates/rails_toastify.rb

@@ -0,0 +1,3 @@
+RailsToastify.setup do |config|
+  config.framework = :tailwind #or :bootstrap
+end

data/lib/rails_toastify/engine.rb

@@ -0,0 +1,7 @@
+module RailsToastify
+  class Engine < ::Rails::Engine
+    initializer 'rails_toastify.assets.precompile' do |app|
+      app.config.assets.precompile += %w(rails_toastify.js rails_toastify.css)
+    end
+  end
+end

data/lib/rails_toastify/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsToastify
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/rails_toastify.rb

@@ -4,6 +4,22 @@ require_relative "rails_toastify/version"
 require_relative "rails_toastify/engine"
 
 module RailsToastify
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.setup
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :framework
+
+    def initialize
+      @framework = :tailwind
+    end
+  end
+
   class Error < StandardError; end
-  # Your code goes here...
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_toastify
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Elton Santos
@@ -18,10 +18,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- MIT-LICENSE.md
 - README.md
 - Rakefile
 - app/assets/javascripts/rails_toastify.js
 - app/assets/stylesheets/rails_toastify.css
+- lib/generators/rails_toastify/install/install_generator.rb
+- lib/generators/rails_toastify/install/templates/rails_toastify.rb
 - lib/rails_toastify.rb
 - lib/rails_toastify/engine.rb
 - lib/rails_toastify/version.rb