barkest_core 1.5.3.0

data/lib/generators/barkest/install_generator.rb

@@ -0,0 +1,102 @@
+require 'rubygems'
+
+module Barkest
+
+  ##
+  # Installs Barkest modules into an application.
+  class InstallGenerator < Rails::Generators::Base
+
+    desc 'Installs the Barkest functionality into your application.'
+
+    argument :action_name, type: :string, default: '', desc: 'Specific action to run.'
+
+
+    def install_modules
+      meth = action_name.to_s == '' ? nil : action_name.to_sym
+
+      installers.each do |inst|
+        sep = '-' + ('=---' * 19) + '=-'
+        tell "#{sep}\nProcessing #{inst.class}\n#{sep}", :bold
+        if meth
+          inst.send(meth) if inst.respond_to?(meth)
+        else
+          inst.public_methods(false).each { |method| inst.send(method) }
+        end
+      end
+
+    end
+
+    private
+
+    # override this to process additional gems.
+    def gem_should_be_checked?(gem_name)
+      gem_name.index('barkest_') == 0
+    end
+
+    def installers
+      @installers ||= find_modules
+    end
+
+    def find_modules
+      ret = []
+      verbose_module_scan = (ENV['VERBOSE_MODULE_SCAN'].to_s.to_i != 0)
+
+      # generator is run from root of app directory
+      Gem::Specification.each do |gem|
+        if gem_should_be_checked?(gem.name)
+          puts "Checking for installer in '#{gem.name}' gem." if verbose_module_scan
+          installer =
+              begin
+                # ensure the gem has been loaded.
+                require gem.name
+                # then ensure the install_generator (if any) has been loaded.
+                inst_path = "generators/#{gem.name}/install_generator"
+                begin
+                  require inst_path
+                  # finally load the class and generate an instance.
+                  klass_name = "#{gem.name.camelcase}::InstallGenerator"
+                  begin
+                    klass = Object.const_get(klass_name)
+                    inst = klass.new
+                    puts "Generated instance of class '#{klass_name}'." if verbose_module_scan
+                    inst
+                  rescue NameError
+                    puts "Failed to load class '#{klass_name}'." if verbose_module_scan
+                    nil
+                  end
+                rescue LoadError
+                  puts "Failed to load file '#{inst_path}'." if verbose_module_scan
+                  nil
+                end
+              rescue LoadError
+                puts "Failed to load gem '#{gem.name}'." if verbose_module_scan
+                nil
+              end
+          ret << installer unless installer.nil?
+        end
+      end
+
+      ret.sort do |a,b|
+        ka = a.class.name
+        kb = b.class.name
+
+        # ensure Core installers run first.
+        kac = ka.index('BarkestCore::') == 0
+        kbc = kb.index('BarkestCore::') == 0
+
+        if kac && kbc
+          ka <=> kb
+        elsif kac
+          -1
+        elsif kbc
+          1
+        else
+          ka <=> kb
+        end
+      end
+
+      ret
+    end
+
+  end
+end

data/lib/generators/barkest_core/actions/01_patch_application_controller.rb

@@ -0,0 +1,55 @@
+BarkestCore::InstallGenerator.class_eval do
+  MissingApplicationController = Class.new(::Thor::Error)
+
+  ##
+  # Patches the ApplicationController class to inherit from BarkestCore::ApplicationController.
+  def patch_application_controller
+    app_file = 'app/controllers/application_controller.rb'
+    dest_source = '::BarkestCore::ApplicationControllerBase'
+
+    if File.exist?(app_file)
+      regex = /^(?<NAME>\s*class ApplicationController\s*<\s*)(?<ORIG>\S+)\s*(?<COMMENT>#.*)?$/
+
+      found = false
+      changed = false
+
+      lines = File.read(app_file).split("\n").map do |line|
+        match = regex.match(line)
+        found = true if match
+        if match && match['ORIG'] != dest_source
+          changed = true
+          "#{match['NAME']}#{dest_source} # #{match['ORIG']} #{match['COMMENT']}"
+        else
+          line
+        end
+      end
+
+      raise MissingApplicationController.new('ApplicationController class not found') unless found
+
+      if changed
+        if ask_for_bool("Your ApplicationController does not currently inherit from BarkestCore.\nWould you like to change this?", true)
+          perform "> updating '#{app_file}'..." do
+            File.write app_file, lines.join("\n")
+          end
+        else
+          tell "> '#{app_file}' is unchanged.", :bright_green
+        end
+      else
+        tell "> '#{app_file}' is good.", :bright_green
+      end
+
+    else
+
+      if ask_for_bool("Your application is missing an ApplicationController.\nWould you like to create one?", true)
+        perform "> creating '#{app_file}'..." do
+          File.write app_file, <<-APPCTRLR
+class ApplicationController < #{dest_source}
+  # This is your application controller, it inherits functionality from BarkestCore.
+end
+          APPCTRLR
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/barkest_core/actions/02_patch_application_mailer.rb

@@ -0,0 +1,56 @@
+BarkestCore::InstallGenerator.class_eval do
+
+  MissingApplicationMailer = Class.new(::Thor::Error)
+
+  ##
+  # Patches the ApplicationMailer class to inherit from BarkestCore::ApplicationMailer.
+  def patch_application_mailer
+    app_file = 'app/mailers/application_mailer.rb'
+    dest_source = '::BarkestCore::ApplicationMailerBase'
+
+    if File.exist?(app_file)
+      regex = /^(?<NAME>\s*class ApplicationMailer\s*<\s*)(?<ORIG>\S+)\s*(?<COMMENT>#.*)?$/
+
+      found = false
+      changed = false
+
+      lines = File.read(app_file).split("\n").map do |line|
+        match = regex.match(line)
+        found = true if match
+        if match && match['ORIG'] != dest_source
+          changed = true
+          "#{match['NAME']}#{dest_source} # #{match['ORIG']} #{match['COMMENT']}"
+        else
+          line
+        end
+      end
+
+      raise MissingApplicationMailer.new('ApplicationMailer class not found') unless found
+
+      if changed
+        if ask_for_bool("Your ApplicationMailer does not currently inherit from BarkestCore.\nWould you like to change this?", true)
+          perform "> updating '#{app_file}'..." do
+            File.write app_file, lines.join("\n")
+          end
+        else
+          tell "> '#{app_file}' is unchanged.", :bright_green
+        end
+      else
+        tell "> '#{app_file}' is good.", :bright_green
+      end
+
+    else
+
+      if ask_for_bool("Your application is missing an ApplicationMailer.\nWould you like to create one?", true)
+        perform "> creating '#{app_file}'..." do
+          File.write app_file, <<-APPMLR
+class ApplicationMailer < #{dest_source}
+  # This is your application mailer, it inherits functionality from BarkestCore.
+end
+          APPMLR
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/barkest_core/actions/03_patch_assets.rb

@@ -0,0 +1,62 @@
+BarkestCore::InstallGenerator.class_eval do
+  ##
+  # Patches application.js and application.css
+  def patch_assets
+    target = 'barkest_core/application'
+
+    [
+        [ 'app/assets/javascripts/application.js', '//=', "// Application.js\n//= require_tree .\n" ],
+        [ 'app/assets/stylesheets/application.css', '*=', "/*\n * Application.css\n *= require_tree .\n *= require_self\n */\n" ]
+    ].each do |(path, line_tag, def_contents)|
+
+      lines = if File.exist?(path)
+                   File.read(path)
+                 else
+                   def_contents
+                 end.split("\n")
+
+      first_tag = -1
+      first_pass = true
+      loop do
+        lines.each_with_index do |line, index|
+          if line.strip[0...line_tag.length] == line_tag
+            first_tag = index
+            break
+          end
+        end
+        if first_tag < 0
+          if first_pass
+            lines += def_contents.split("\n")
+          else
+            raise StandardError.new("Failed to locate line starting with '#{line_tag}' in '#{path}'.")
+          end
+        else
+          break
+        end
+        first_pass = false
+      end
+
+      regex = /^\s*#{line_tag.gsub('*',"\\*")}\s*require\s*['"]?#{target}['"]?\s*$/
+
+      tag_index = -1
+      lines.each_with_index do |line, index|
+        if regex.match(line)
+          tag_index = index
+          break
+        end
+      end
+      if tag_index < 0
+        if ask_for_bool("Would you like to add a reference to BarkestCore in '#{path}'?", true)
+          lines.insert first_tag, "#{line_tag} require #{target}"
+          perform "> updating '#{path}'..." do
+            File.write path, lines.join("\n")
+          end
+        else
+          tell "> '#{path}' is unchanged.", :bright_green
+        end
+      else
+        tell "> '#{path}' is good.", :bright_green
+      end
+    end
+  end
+end

data/lib/generators/barkest_core/actions/04_patch_layouts.rb

@@ -0,0 +1,36 @@
+BarkestCore::InstallGenerator.class_eval do
+  ##
+  # Patches the default layouts to inherit from the BarkestCore layouts.
+  def patch_layouts
+    {
+        'app/views/layouts/application.html.erb' => 'layouts/barkest_core/application',
+        'app/views/layouts/mailer.html.erb' => 'layouts/barkest_core/html_mailer',
+        'app/views/layouts/mailer.text.erb' => 'layouts/barkest_core/text_mailer'
+    }.each do |file,layout|
+
+      if File.exist?(file)
+        regex = /<%=\s+render[\s\(]+['"]#{layout}['"][\)\s]*%>/
+        if regex.match(File.read(file))
+          tell "> '#{file}' is good.", :bright_green
+        else
+          if ask_for_bool("Your '#{file}' layout does not reference the BarkestCore layout.\nWould you like to change it to use the BarkestCore layout?", true)
+            perform "> updating '#{file}'..." do
+              File.write file, "<%= render '#{layout}' %>\n"
+            end
+          else
+            tell "> '#{file}' is unchanged.", :bright_green
+          end
+        end
+      else
+        if ask_for_bool("Your application is missing '#{file}'.\nWould you like to add one?", true)
+          perform "> creating '#{file}'..." do
+            File.write file, "<%= render '#{layout}' %>\n"
+          end
+        else
+          tell "> '#{file}' is missing.", :yellow
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/barkest_core/actions/05_patch_routes.rb

@@ -0,0 +1,93 @@
+BarkestCore::InstallGenerator.class_eval do
+  ##
+  # Patches routes.rb to include BarkestCore::Engine and session management paths.
+  def patch_routes
+    route_file = 'config/routes.rb'
+
+    unless File.exist?(route_file)
+
+      if ask_for_bool("Your application is missing a 'routes.rb' configuration file.\nWould you like to create one?", true)
+        perform '> creating \'routes.rb\'...' do
+          File.write route_file, <<-DEFRTS
+Rails.application.routes.draw do
+  # Enter your routes in this file.
+end
+          DEFRTS
+        end
+      else
+        tell '> missing \'routes.rb\'.', :yellow
+        return
+      end
+
+    end
+
+    lines = File.exist?(route_file) ? File.read(route_file).split("\n") : ['Rails.application.routes.draw do','end']
+
+    insert_at = -1
+
+    regex = /.*\.routes\.draw\s+do\s*(#.*)?$/
+    lines.each_with_index do |line, index|
+      if regex.match(line)
+        insert_at = index + 1
+        break
+      end
+    end
+
+    raise MissingRoutes.new('routes not found') unless insert_at >= 0
+
+    changed = false
+
+    core_regex = /^\s*barkest_core([\s\(]+(?<OPTIONS>[^\s\)#][^\)#]+)\)?)?\s*(?<COMMENT>#.*)?$/
+    root_regex = /^\s*root([\s\(]+(?<OPTIONS>[^\s\)#][^\)#]+)\)?)?\s*(?<COMMENT>#.*)?$/
+    core = nil
+    root = nil
+
+    lines.each_with_index do |line, index|
+      line = line.strip
+      if (match = core_regex.match(line))
+        opts = match['OPTIONS'].to_s.strip
+        core = {
+            index: index,
+            path: if (path_offset = opts.index(':path'))
+                    opts[path_offset..-1].partition('=>')[2].partition(',')[0].strip[1...-1]
+                  elsif (path_offset = opts.index('path:'))
+                    opts[path_offset..-1].partition(':')[2].partition(',')[0].strip[1...-1]
+                  else
+                    opts[1...-1]  # strip '...' or "..." to ...
+                  end.to_s
+        }
+      elsif (match = root_regex.match(line))
+        opts = match['OPTIONS'].to_s.strip
+        root = {
+            index: index,
+            path: opts[1...-1].to_s # strip '...' or "..." to ...
+        }
+      end
+    end
+
+    unless core
+      if ask_for_bool('Would you like to add the \'barkest_core\' routes to your application?', true)
+        path = ask_for_string('What path prefix would you like?', '/')
+        lines.insert insert_at, "\n  barkest_core #{path.inspect}"
+        changed = true
+      end
+    end
+
+    unless root
+      if ask_for_bool("Your application is missing a root route.\nWould you like to add one?", true)
+        path = ask_for_string('What controller#action would you like for your root route?', 'test_access#allow_anon')
+        lines.insert insert_at, "\n  root #{path.inspect}"
+        changed = true
+      end
+    end
+
+    if changed
+      perform '> updating \'routes.rb\'...' do
+        File.write route_file, lines.join("\n")
+      end
+    else
+      tell '> \'routes.rb\' is good.', :bright_green
+    end
+
+  end
+end

data/lib/generators/barkest_core/actions/06_patch_seeds.rb

@@ -0,0 +1,60 @@
+BarkestCore::InstallGenerator.class_eval do
+  ##
+  # Patches the db/seeds to allow multiple seeding files and includes the seeds necessary for BarkestCore.
+  def patch_seeds
+    files = Dir.glob(File.expand_path('../../../../../db/{seeds.rb,seeds/*.rb}', __FILE__))
+
+    unless Dir.exists?('db/seeds')
+      if ask_for_bool("Your application does not currently have a 'db/seeds' directory.\nBarkestCore can alter your application to make use of multiple seeding files.\nDo you want to create the 'db/seeds' directory to enable this behavior?", true)
+        perform '> creating \'db/seeds\' directory.' do
+          Dir.mkdir 'db' unless Dir.exists?('db')
+          Dir.mkdir 'db/seeds'
+        end
+      else
+        tell "> 'db/seeds' directory is missing.", :yellow
+        return
+      end
+    end
+
+    source = files.find{|v| v[-11..-1] == 'db/seeds.rb'}
+    prefix_dir_len = source.length - 11
+    dest = source[prefix_dir_len..-1]
+
+    if File.exist?(dest)
+      current_contents = File.read(dest).strip
+
+      # if 'seeds.rb' defines a 'Seeds' class, then we assuming it to be a seeder.
+      is_seeder = false
+      current_contents.split("\n").each do |line|
+        is_seeder = true if /^\s*class\s+Seeds(\s.*)?$/.match(line)
+      end
+
+      unless is_seeder
+        if ask_for_bool('Would you like to move your \'db/seeds.rb\' file into the \'db/seeds\' directory?', true)
+          perform "> moving '#{dest}' into 'db/seeds' directory..." do
+            File.rename dest, 'db/seeds/' + File.basename(dest)
+          end
+        else
+          tell "> 'db/seeds.rb' is not being moved.", :yellow
+        end
+      end
+    end
+
+    files.each do |source|
+      dest = source[prefix_dir_len..-1]
+      contents = File.read(source)
+
+      if File.exist?(dest) && File.read(dest).strip == contents.strip
+        tell "> '#{dest}' is good.", :bright_green
+      else
+        if !File.exist?(dest) || ask_for_bool("Would you like to update '#{dest}'?", true)
+          perform "> #{File.exist?(dest) ? 'creating' : 'updating'} \'#{dest}\'..." do
+            File.write dest, contents
+          end
+        else
+          tell "> '#{dest}' is unchanged.", :bright_green
+        end
+      end
+    end
+  end
+end