flash_me 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5a25b97958ca4d078392ceb68e87160c4482094b
+  data.tar.gz: b84fc2650f0470438428e8378f54e0152085f6f5
+SHA512:
+  metadata.gz: 9576b1acfc0e482a5be1422044db11c8a69bff73bea752106ebd7d5f86933938f1a50420255f0d39bbe851df46bdf44ab41db9ad2a4aabd9098fd1c60da2a9bb
+  data.tar.gz: 0479b76ae941ffe79b7e306f6774b49d739807e40a1fce1b87ad3c74a3a10a29e5cdef3b8df9e72902ba27af004b858c93e23e18927edc57cc816395c07fa25c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Kevin J. Storberg
+
+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,69 @@
+# Name
+  FlashMe
+
+
+
+# Description
+  FlashMe simplifies flash messages by consolidating them into a single module where they can be easily edited and stylized.
+
+
+
+# Usage
+  A quick and dirty way to send a message.
+
+## Simple and easy dynamic messages for crud actions
+  - FlashMe is smart, and will can automatically build messages for CRUD actions
+  - Ex: calling flash_message('alert') will generate a flash message of 'User successfully updated' when called in users#update
+
+## Customize messages for unique circumstances
+  - Add a new message to /controllers/concerns/flash_me.rb' by adding a method to the file
+  - Name the method using the structure 'flash_name_of_method' so FlashMe can find it
+  - This method will return a hash containing all of the information about your message
+  - 'text' points to the actual content of the message
+  - 'type' points to the category of message (e.g. 'alert' or 'success')
+  - 'clear' tells FlashMe whether the message will be available to the next action
+
+
+
+# Installation
+  1. Add this line to your application's Gemfile:
+      ```ruby
+      gem 'flash_me'
+      ```
+
+  2. Next execute:
+      ```bash
+      $ bundle
+      ```
+
+      Or install it yourself as:
+      ```bash
+      $ gem install flash_me
+      ```
+
+  3. Then install the FlashMe Controller Concern
+      ```bash
+      $ rails g flash_me:install
+      ```
+
+  4. Finally, include FlashMe in your controllers
+
+
+
+# Authors
+  - Kevin J. Storberg, Ooftypop Inc.
+
+
+
+# Contributing
+  We welcome collaboration on all of our open source projects.
+
+  When contributing to SnoopDogg, we ask that you:
+  - notify us of your intended contribution so we may provide feedback
+  - make a PR on Github with a short description of your changes
+  - update any relevant documentation
+
+
+
+# License
+  The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+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    = 'FlashMe'
+  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 << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/flash_me.rb

@@ -0,0 +1,5 @@
+require "flash_me/railtie"
+
+module FlashMe
+  
+end

data/lib/flash_me/railtie.rb

@@ -0,0 +1,4 @@
+module FlashMe
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/flash_me/version.rb

@@ -0,0 +1,3 @@
+module FlashMe
+  VERSION = '0.1.1'
+end

data/lib/generators/flash_me/install_generator.rb

@@ -0,0 +1,9 @@
+module FlashMe
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    def copy_flash_me_concern_file
+      template "flash_me_concern.rb", "app/controllers/concerns/flash_me.rb"
+    end
+  end
+end

data/lib/generators/flash_me/templates/flash_me_concern.rb

@@ -0,0 +1,95 @@
+module FlashMessages
+  extend ActiveSupport::Concern
+  private
+
+  # Authorizations =============================================================
+  def flash_user_not_found
+    {
+      text: "No user was found matching the provided data.",
+      type: "alert"
+    }
+  end
+
+  # Bulk Data Requests =========================================================
+  def flash_everything_up_to_date
+    {
+      text: "Everything is up to date.",
+      type: "success"
+    }
+  end
+
+  def flash_fetch_data_success
+    {
+      text: "Successfully fetched data requested.",
+      type: "success"
+    }
+  end
+
+  def flash_fetch_data_failed
+    {
+      text: "Failed to fetch data requested!!",
+      type: "alert"
+    }
+  end
+
+  def flash_update_data_success
+    {
+      text: "Successfully updated the data requested.",
+      type: "success"
+    }
+  end
+
+  def flash_update_data_failed
+    {
+      text: "Failed to update the requested data!!",
+      type: "alert"
+    }
+  end
+
+  # CRUD =======================================================================
+  def flash_alert
+    {
+      clear: true,
+      text: "Failed to #{action_name} #{flash_object_name}.",
+      type: "alert"
+    }
+  end
+
+  def flash_success
+    {
+      clear: false,
+      text: "#{flash_object_name} successfully #{flash_action_name}.",
+      type: "success"
+    }
+  end
+
+  # ============================================================================
+  # Flash Builders =============================================================
+  # ============================================================================
+  included do
+    def clear_flash_messages
+      flash.clear
+    end
+
+    def flash_message(*messages)
+      messages.each do |message|
+
+        message_params = send("flash_#{message}".to_sym)
+
+        clear = message_params[:clear]
+        text  = message_params[:text]
+        type  = message_params[:type].to_sym
+
+        clear ? (flash.now[type] = text) : (flash[type] = text)
+      end
+    end
+
+    def flash_action_name
+      ['destroy', 'publish'].include?(action_name) ? action_name + "ed" : action_name + "d"
+    end
+
+    def flash_object_name
+      controller_name.underscore.humanize.split.map {|word| word.singularize }.join(" ")
+    end
+  end
+end

data/lib/tasks/flash_me_tasks.rake

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

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: flash_me
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Kevin J. Storberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: A quick and dirty way to send a message
+email:
+- kevin@storberg.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/flash_me.rb
+- lib/flash_me/railtie.rb
+- lib/flash_me/version.rb
+- lib/generators/flash_me/install_generator.rb
+- lib/generators/flash_me/templates/flash_me_concern.rb
+- lib/tasks/flash_me_tasks.rake
+homepage: https://github.com/ooftypop/flash_me
+licenses:
+- MIT
+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.6.10
+signing_key: 
+specification_version: 4
+summary: A quick and dirty way to send a message
+test_files: []