flashee 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db739791f4f0f26df44f738fd357b6a5c51fe468d324b1a8ada0ac56c3b5067e
-  data.tar.gz: 2e6e89df16f95ac6a16c7356aa3d23561d96c5d7e3bf7b9d34f7ab82e6032dd2
+  metadata.gz: 24d913d85e05b65cba97c90c078b602586ffc7041065afb5343afa20eb9a48dc
+  data.tar.gz: 19158e733d9a0c95a19640bf0441768fdb48c660772f121a6d23e462ebed53e4
 SHA512:
-  metadata.gz: 2fe1852624da34dac2483cb790ba6c6f4cc4145d35fd7fdad828c5fb15434560cab4f9edac9c0a58d1d0e641a12200ee679597b90b2bed5b2dbbc692a3538bfd
-  data.tar.gz: 23053ef42fba5034e8a6fc2cc0b2e9ad00b7ef0edbe84f53a6b0314ab1fcd252dd4ef1c665686296ecdbaaa11563d243f9c0b83345fa64c3d2a7a1368785917e
+  metadata.gz: 7b606779158af5b140ecc890d3393584755af4a9bf6889f5deaf81e1aacfb33c72a99dc0ab8f10c613d494937193fb30be7d4bcc0eb6acd7f3bb9ec24006e2c8
+  data.tar.gz: f837abfd7c06f168f6be930838c0f1cad43c4a24d6c195aa6f3eb9c39398885e8ecc8674affbe84b313c05bcd147aca68eb63e06f6cbe09e18a789b4f068b96e

data/lib/flashee/version.rb

@@ -1,3 +1,3 @@
 module Flashee
-  VERSION = '0.3.2'
+  VERSION = '0.3.3'
 end

data/lib/generators/flashee/install/bootstrap_generator.rb

@@ -1,9 +1,11 @@
 module Flashee
   module Generators
     module Install
+      # Houses the logic to install flashee into the target rails app using the bootstrap CSS framework.
+      # BootstrapGenerator translates to the `flashee:install:bootstrap
       class BootstrapGenerator < Rails::Generators::Base
-
-        desc "install helper file"
+    
+        # Copies `lib/templates/flashee_bootstrap_helper.rb` into `app/helpers/flashee_helper.rb`.
         def copy_helper
           helper_source = File.join(Gem.loaded_specs["flashee"].full_gem_path, "lib", "templates", "flashee_bootstrap_helper.rb")
           helper_target = File.join(Rails.root, "app", "helpers", "flashee_helper.rb")
@@ -11,7 +13,8 @@ module Flashee
           FileUtils.cp_r helper_source, helper_target
         end
 
-        desc "install parital"
+        # Copies `lib/templates/_flash_messages.html.erb` to `app/views/partials/_flash_messages.html.erb`,
+        # will also create `app/partials` if it doesn't exist already.
         def copy_partial
           view_partial_source = File.join(Gem.loaded_specs["flashee"].full_gem_path, "lib", "templates", "_flash_messages.html.erb")
           view_partial_target = File.join(Rails.root, "app", "views", "partials", "_flash_messages.html.erb")
@@ -20,7 +23,7 @@ module Flashee
           FileUtils.cp_r view_partial_source, view_partial_target
         end
 
-        # Print post install info
+        # After installation completes, print the ERB snippet to the command line.
         def print_post_install_info
           puts "==================================================================="
           puts "# One more step to go, To render the                              #"

data/lib/generators/flashee/install/bulma_generator.rb

@@ -1,9 +1,11 @@
 module Flashee
   module Generators
     module Install
+      # Houses the logic to install flashee into the target rails app using the bulma CSS framework.
+      # BulmaGenerator translates to the `flashee:install:bulma` command.
       class BulmaGenerator < Rails::Generators::Base
 
-        desc "install helper file"
+        # Copies `lib/templates/flashee_bulma_helper.rb` into `app/helpers/flashee_helper.rb`.
         def copy_helper
           helper_source = File.join(Gem.loaded_specs["flashee"].full_gem_path, "lib", "templates", "flashee_bulma_helper.rb")
           helper_target = File.join(Rails.root, "app", "helpers", "flashee_helper.rb")
@@ -11,7 +13,8 @@ module Flashee
           FileUtils.cp_r helper_source, helper_target
         end
 
-        desc "install parital"
+        # Copies `lib/templates/_flash_messages.html.erb` to `app/views/partials/_flash_messages.html.erb`,
+        # will also create `app/partials` if it doesn't exist already.
         def copy_partial
           view_partial_source = File.join(Gem.loaded_specs["flashee"].full_gem_path, "lib", "templates", "_flash_messages.html.erb")
           view_partial_target = File.join(Rails.root, "app", "views", "partials", "_flash_messages.html.erb")
@@ -20,7 +23,7 @@ module Flashee
           FileUtils.cp_r view_partial_source, view_partial_target
         end
 
-        # Print post install info
+        # After installation completes, print the ERB snippet to the command line.
         def print_post_install_info
           puts "==================================================================="
           puts "# One more step to go, To render the                              #"

data/lib/generators/flashee/install/foundation_generator.rb

@@ -1,9 +1,11 @@
 module Flashee
   module Generators
     module Install
+      # Houses the logic to install flashee into the target rails app using the foundation CSS framework.
+      # FoundationGenerator translates to the `flashee:install:foundation` command.
       class FoundationGenerator < Rails::Generators::Base
-
-        desc "install helper file"
+        
+        # Copies `lib/templates/flashee_foundation_helper.rb` into `app/helpers/flashee_helper.rb`.
         def copy_helper
           helper_source = File.join(Gem.loaded_specs["flashee"].full_gem_path, "lib", "templates", "flashee_foundation_helper.rb")
           helper_target = File.join(Rails.root, "app", "helpers", "flashee_helper.rb")
@@ -11,7 +13,8 @@ module Flashee
           FileUtils.cp_r helper_source, helper_target
         end
 
-        desc "install parital"
+        # Copies `lib/templates/_flash_messages_foundation.html.erb` to `app/views/partials/_flash_messages.html.erb`,
+        # will also create `app/partials` if it doesn't exist already.
         def copy_partial
           view_partial_source = File.join(Gem.loaded_specs["flashee"].full_gem_path, "lib", "templates", "_flash_messages_foundation.html.erb")
           view_partial_target = File.join(Rails.root, "app", "views", "partials", "_flash_messages.html.erb")
@@ -20,7 +23,7 @@ module Flashee
           FileUtils.cp_r view_partial_source, view_partial_target
         end
 
-        # Print post install info
+        # After installation completes, print the ERB snippet to the command line.
         def print_post_install_info
           puts "==================================================================="
           puts "# One more step to go, To render the                              #"

data/lib/generators/flashee/install/install.rb

@@ -0,0 +1,15 @@
+module Flashee
+  module Generators
+    # Parent class that houses all of the sub generators, fund below a list of current generators and their corresponding commands.
+    # 
+    # * Install::BootstrapGenerator
+    #     flashee:install:bootstrap
+    # * Install::BulmaGenerator
+    #     flashee:install:bulma
+    # * Install::FoundationGenerator
+    #     flashee:install:foundation
+    #
+    module Install
+    end
+  end
+end

data/lib/generators/flashee/install_generator.rb

@@ -1,8 +1,10 @@
 module Flashee
   module Generators
+    # Houses the logic to install flashee into the target rails app.
+    # InstallGenerator translates to the `flashee:install` command.
     class InstallGenerator < Rails::Generators::Base
 
-      desc "install helper file"
+      # Copies `lib/templates/flashee_helper.rb` into `app/helpers/flashee_helper.rb`.
       def copy_helper
         helper_source = File.join(Gem.loaded_specs["flashee"].full_gem_path, "lib", "templates", "flashee_helper.rb")
         helper_target = File.join(Rails.root, "app", "helpers", "flashee_helper.rb")
@@ -10,7 +12,8 @@ module Flashee
         FileUtils.cp_r helper_source, helper_target
       end
 
-      desc "install parital"
+      # Copies `lib/templates/_flash_messages.html.erb` to `app/views/partials/_flash_messages.html.erb`,
+      # will also create `app/partials` if it doesn't exist already.
       def copy_partial
         view_partial_source = File.join(Gem.loaded_specs["flashee"].full_gem_path, "lib", "templates", "_flash_messages.html.erb")
         view_partial_target = File.join(Rails.root, "app", "views", "partials", "_flash_messages.html.erb")
@@ -19,7 +22,7 @@ module Flashee
         FileUtils.cp_r view_partial_source, view_partial_target
       end
 
-      # Print post install info
+      # After installation completes, print the ERB snippet to the command line.
       def print_post_install_info
         puts "==================================================================="
         puts "# One more step to go, To render the                              #"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flashee
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Josh Burns
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-30 00:00:00.000000000 Z
+date: 2018-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -53,6 +53,7 @@ files:
 - lib/generators/flashee/install/bootstrap_generator.rb
 - lib/generators/flashee/install/bulma_generator.rb
 - lib/generators/flashee/install/foundation_generator.rb
+- lib/generators/flashee/install/install.rb
 - lib/generators/flashee/install_generator.rb
 - lib/templates/_flash_messages.html.erb
 - lib/templates/_flash_messages_foundation.html.erb