flashee 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24d913d85e05b65cba97c90c078b602586ffc7041065afb5343afa20eb9a48dc
-  data.tar.gz: 19158e733d9a0c95a19640bf0441768fdb48c660772f121a6d23e462ebed53e4
+  metadata.gz: 446cda8e1d0cecd2902f3f9805dc6753007571c23875fa54d7a020b87a309477
+  data.tar.gz: 341cc0620380d36ee3d67615f8285f2b3ca09785b10a5df46d2d4f66b611da01
 SHA512:
-  metadata.gz: 7b606779158af5b140ecc890d3393584755af4a9bf6889f5deaf81e1aacfb33c72a99dc0ab8f10c613d494937193fb30be7d4bcc0eb6acd7f3bb9ec24006e2c8
-  data.tar.gz: f837abfd7c06f168f6be930838c0f1cad43c4a24d6c195aa6f3eb9c39398885e8ecc8674affbe84b313c05bcd147aca68eb63e06f6cbe09e18a789b4f068b96e
+  metadata.gz: f4ffd55bc15af4ba41bb917e94e177ba90089aef08317395c4058cc5a2038af0420c967c05a71ec5eba1b499ab895746952d72d38badb00a8f9ab8c9890efaa8
+  data.tar.gz: 0e24d3bd8d6f49783eee53d2d7a637be9f8ea7d0221f73db2fd065dee58e69e689b75256ac8f4e13fe9990ca10c26529564cdc2a53fe9e619dab72877f66dcf0

data/Rakefile

@@ -4,14 +4,18 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
+require 'sdoc'
 require 'rdoc/task'
 
 RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
+  rdoc.rdoc_dir = 'docs'
   rdoc.title    = 'Flashee'
   rdoc.options << '--line-numbers'
+  rdoc.options << '--format=sdoc'
+  rdoc.template = 'rails'
   rdoc.rdoc_files.include('README.md')
   rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.main = 'README.md'
 end
 
 require 'bundler/gem_tasks'

data/lib/flashee.rb

@@ -1,5 +1,6 @@
 require "flashee/railtie"
+require "flashee/builders"
 
 module Flashee
-  # Your code goes here...
+  require 'erb'
 end

data/lib/flashee/builders.rb

@@ -0,0 +1,63 @@
+module Flashee
+  class Builders
+    # Called by install generators to build the appropriate helper file
+    #
+    # == Parameters:
+    #
+    # * flashee_helper_mode::
+    #   A string to define what mode to render the templates in
+    #
+    # == Returns:
+    # A string of the template contents
+    #
+    def self.helper_builder flashee_helper_mode
+      @mode = flashee_helper_mode
+      @template = File.read(File.join(Gem.loaded_specs["flashee"].full_gem_path, "lib", "templates", "flashee_helper.rb.erb"))
+      return ERB.new(@template).result(binding)
+    end
+
+    # Called by install generators to build the appropriate view partial
+    #
+    # == Parameters:
+    #
+    # * flashee_helper_mode::
+    #   if flashee_helper_mode is set to "foundation" it will copy the foundation template.
+    #   Otherwise it will copy the standard template that fits everything else.
+    #
+    # == Returns:
+    # A string of the template contents
+    #
+    def self.view_builder flashee_helper_mode
+      @mode = flashee_helper_mode
+      if @mode == "foundation"
+        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")
+        FileUtils::mkdir_p  File.join(Rails.root, "app", "views", "partials")
+        FileUtils.cp_r view_partial_source, view_partial_target
+      else
+        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")
+        FileUtils::mkdir_p  File.join(Rails.root, "app", "views", "partials")
+        FileUtils.cp_r view_partial_source, view_partial_target
+      end
+    end
+
+    # Called by install generators to create a file inside of the apps file structure
+    #
+    # == Parameters:
+    # * file_path::
+    #   Path to file including filename and extension
+    #
+    # * file_contents::
+    #   Contents to print into the file_path
+    #
+    # == Returns:
+    # A file inside file_path containing file_contents
+    #
+    def self.file_builder file_path, file_contents
+      @out_file = File.new(file_path, 'w')
+      @out_file.puts(file_contents)
+      @out_file.close
+    end
+  end
+end

data/lib/flashee/version.rb

@@ -1,3 +1,4 @@
 module Flashee
-  VERSION = '0.3.3'
+  # Defines the current Gem version
+  VERSION = '0.3.4'
 end

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

@@ -4,23 +4,18 @@ module Flashee
       # 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
-    
-        # 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")
 
-          FileUtils.cp_r helper_source, helper_target
-        end
+        # Creates bootstrap mode helper.
+        def create_helper
+          @helper_file = Builders.helper_builder "bootstrap"
+          helper_target_path = File.join(Rails.root, "app", "helpers", "flashee_helper.rb")
 
-        # 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")
+          Builders.file_builder helper_target_path, @helper_file
+        end
 
-          FileUtils::mkdir_p  File.join(Rails.root, "app", "views", "partials")
-          FileUtils.cp_r view_partial_source, view_partial_target
+        # Creates bootstrap mode view partial
+        def create_partial
+          Builders.view_builder "bootstrap"
         end
 
         # After installation completes, print the ERB snippet to the command line.

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

@@ -5,22 +5,17 @@ module Flashee
       # BulmaGenerator translates to the `flashee:install:bulma` command.
       class BulmaGenerator < Rails::Generators::Base
 
-        # 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")
+        # Creates bulma mode helper.
+        def create_helper
+          @helper_file = Builders.helper_builder "bulma"
+          helper_target_path = File.join(Rails.root, "app", "helpers", "flashee_helper.rb")
 
-          FileUtils.cp_r helper_source, helper_target
+          Builders.file_builder helper_target_path, @helper_file
         end
 
-        # 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")
-
-          FileUtils::mkdir_p  File.join(Rails.root, "app", "views", "partials")
-          FileUtils.cp_r view_partial_source, view_partial_target
+        # Creates bulma mode view partial
+        def create_partial
+          Builders.view_builder "bulma"
         end
 
         # After installation completes, print the ERB snippet to the command line.

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

@@ -4,23 +4,18 @@ module Flashee
       # 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
-        
-        # 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")
 
-          FileUtils.cp_r helper_source, helper_target
-        end
+        # Creates foundation mode helper.
+        def create_helper
+          @helper_file = Builders.helper_builder "foundation"
+          helper_target_path = File.join(Rails.root, "app", "helpers", "flashee_helper.rb")
 
-        # 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")
+          Builders.file_builder helper_target_path, @helper_file
+        end
 
-          FileUtils::mkdir_p  File.join(Rails.root, "app", "views", "partials")
-          FileUtils.cp_r view_partial_source, view_partial_target
+        # Creates foundation mode view partial
+        def create_partial
+          Builders.view_builder "foundation"
         end
 
         # After installation completes, print the ERB snippet to the command line.

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

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

data/lib/generators/flashee/install_generator.rb

@@ -4,22 +4,16 @@ module Flashee
     # InstallGenerator translates to the `flashee:install` command.
     class InstallGenerator < Rails::Generators::Base
 
-      # 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")
-
-        FileUtils.cp_r helper_source, helper_target
+      # Creates basic mode helper.
+      def create_helper
+        @helper_file = Builders.helper_builder "basic"
+        helper_target_path = File.join(Rails.root, "app", "helpers", "flashee_helper.rb")
+        Builders.file_builder helper_target_path, @helper_file
       end
 
-      # 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")
-
-        FileUtils::mkdir_p  File.join(Rails.root, "app", "views", "partials")
-        FileUtils.cp_r view_partial_source, view_partial_target
+      # Creates basic mode view partial
+      def create_partial
+        Builders.view_builder "basic"
       end
 
       # After installation completes, print the ERB snippet to the command line.

data/lib/templates/_flash_messages.html.erb

@@ -2,4 +2,4 @@
   <div class="<%= flashee_for(type) %>">
     <%= message %>
   </div>
-<% end %>
+<% end %>

data/lib/templates/_flash_messages_foundation.html.erb

@@ -2,4 +2,4 @@
   <div data-alert class="<%= flashee_for(type) %>">
     <%= message %>
   </div>
-<% end %>
+<% end %>

data/lib/templates/flashee_helper.rb

@@ -10,15 +10,5 @@ module FlasheeHelper
   # A string for the css class
   #
   def flashee_for flash_type
-    case flash_type.to_s
-      when "success"
-        "success"
-      when "error"
-        "error"
-      when "alert"
-        "alert"
-      else
-        flash_type.to_s
-    end
   end
 end

data/lib/templates/flashee_helper.rb.erb

@@ -0,0 +1,67 @@
+<% if @mode == "basic" %>
+module FlasheeHelper
+  def flashee_for flash_type
+    case flash_type.to_s
+      when "success"
+        "success"
+      when "error"
+        "error"
+      when "alert"
+        "alert"
+      else
+        flash_type.to_s
+    end
+  end
+end
+<% elsif @mode == "bootstrap" %>
+module FlasheeHelper
+  def flashee_for flash_type
+    case flash_type.to_s
+      when "success"
+        "alert alert-success"
+      when "error"
+        "alert alert-danger"
+      when "alert"
+        "alert alert-warning"
+      when "info"
+        "alert alert-primary"
+      else
+        flash_type.to_s
+    end
+  end
+end
+<% elsif @mode == "foundation" %>
+module FlasheeHelper
+  def flashee_for flash_type
+    case flash_type.to_s
+    when "success"
+      "alert-box success"
+    when "error"
+      "alert-box alert"
+    when "alert"
+      "alert-box warning"
+    when "info"
+      "alert-box info"
+    else
+      flash_type.to_s
+    end
+  end
+end
+<% elsif @mode == "bulma" %>
+module FlasheeHelper
+  def flashee_for flash_type
+    case flash_type.to_s
+      when "success"
+        "notification is-success"
+      when "error"
+        "notification is-danger"
+      when "alert"
+        "notification is-warning"
+      when "info"
+        "notification is-primary"
+      else
+        flash_type.to_s
+    end
+  end
+end
+<% end %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flashee
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Josh Burns
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-01 00:00:00.000000000 Z
+date: 2018-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sdoc
+  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: Rails helper to style flash messages
 email:
 - jb@jbernsie.me
@@ -48,6 +62,7 @@ files:
 - README.md
 - Rakefile
 - lib/flashee.rb
+- lib/flashee/builders.rb
 - lib/flashee/railtie.rb
 - lib/flashee/version.rb
 - lib/generators/flashee/install/bootstrap_generator.rb
@@ -57,10 +72,8 @@ files:
 - lib/generators/flashee/install_generator.rb
 - lib/templates/_flash_messages.html.erb
 - lib/templates/_flash_messages_foundation.html.erb
-- lib/templates/flashee_bootstrap_helper.rb
-- lib/templates/flashee_bulma_helper.rb
-- lib/templates/flashee_foundation_helper.rb
 - lib/templates/flashee_helper.rb
+- lib/templates/flashee_helper.rb.erb
 homepage: https://github.com/jbernsie/flashee
 licenses:
 - MIT

data/lib/templates/flashee_bootstrap_helper.rb

@@ -1,16 +0,0 @@
-module FlasheeHelper
-    def flashee_for flash_type
-        case flash_type.to_s
-            when "success"
-                "alert alert-success"
-            when "error"
-                "alert alert-danger"
-            when "alert"
-                "alert alert-warning"
-            when "info"
-                "alert alert-primary"
-            else
-                flash_type.to_s
-        end
-    end
-end

data/lib/templates/flashee_bulma_helper.rb

@@ -1,16 +0,0 @@
-module FlasheeHelper
-    def flashee_for flash_type
-        case flash_type.to_s
-            when "success"
-                "notification is-success"
-            when "error"
-                "notification is-danger"
-            when "alert"
-                "notification is-warning"
-            when "info"
-                "notification is-primary"
-            else
-                flash_type.to_s
-        end
-    end
-end

data/lib/templates/flashee_foundation_helper.rb

@@ -1,16 +0,0 @@
-module FlasheeHelper
-    def flashee_for flash_type
-        case flash_type.to_s
-            when "success"
-                "alert-box success"
-            when "error"
-                "alert-box alert"
-            when "alert"
-                "alert-box warning"
-            when "info"
-                "alert-box info"
-            else
-                flash_type.to_s
-        end
-    end
-end