barkest_core 1.5.3.0

data/lib/barkest_core/concerns/named_model.rb

@@ -0,0 +1,73 @@
+
+module BarkestCore
+
+  ##
+  # Defines a few extensions to models that have unique names.
+  #
+  # If the unique field is named :name then you don't have to do
+  # anything more than include this file.  For other unique fields
+  # simply define +UNIQUE_STRING_FIELD+ to the name of the unique
+  # field as either a symbol or a string.
+  module NamedModel
+    # :nodoc:
+    def self.included(base)
+
+      base.class_eval do
+
+        private
+
+        def self.unique_string_field
+          @unique_string_field ||= const_defined?(:UNIQUE_STRING_FIELD) ? const_get(:UNIQUE_STRING_FIELD).to_sym : :name
+        end
+
+        public
+
+        ##
+        # Locates the model from ID or name.
+        def self.get(value)
+          if value.is_a?(Numeric)
+            self.find_by(id: value)
+          elsif value.is_a?(String)
+            self.where("LOWER(\"#{table_name}\".\"#{unique_string_field}\")=?", value.downcase).first
+          elsif value.is_a?(Symbol)
+            self.where("LOWER(\"#{table_name}\".\"#{unique_string_field}\")=?", value.to_s.downcase).first ||
+                self.where("LOWER(\"#{table_name}\".\"#{unique_string_field}\")=?", value.to_s.humanize.downcase).first
+          elsif value.class == self
+            value
+          else
+            nil
+          end
+        end
+
+        ##
+        # Gets the name of this model.
+        def to_s
+          send( self.class.unique_string_field )
+        end
+
+        ##
+        # Tests for equality on ID or name.
+        def ==(other)
+          if other.is_a?(Numeric)
+            id == other
+          elsif other.is_a?(String)
+            send( self.class.unique_string_field ).to_s.downcase == other.downcase
+          elsif other.is_a?(Symbol)
+            [
+                other.to_s.downcase,
+                other.to_s.humanize.downcase
+            ].include?(send( self.class.unique_string_field ).to_s.downcase)
+          elsif other.is_a?(self.class)
+            id == other.id
+          else
+            other = self.class.get(other)
+            other && id == other.id
+          end
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/barkest_core/concerns/number_parser.rb

@@ -0,0 +1,145 @@
+module BarkestCore
+  ##
+  # This module will add number parsing methods to a class.
+  #
+  module NumberParser
+
+    ##
+    # This regular expression should match any non-exponential numeric value.
+    NUMBER_REGEX = /^[\-\+]?(?:[0-9]+,)*[0-9]+(?:\.[0-9]+)?$/
+
+    ##
+    # Parses a value for storage in a float column.
+    #
+    # Returns nil if the value is invalid.
+    # Otherwise it returns a float.
+    #
+    def self.parse_for_float_column(value)
+      value = value.to_s
+      return nil unless NUMBER_REGEX.match(value)
+      value.blank? ? nil : value.split(',').join.to_f
+    end
+
+    ##
+    # Parses a value for storage in an integer column.
+    #
+    # Returns nil if the value is invalid.
+    # Otherwise it returns an integer.
+    def self.parse_for_int_column(value)
+      value = value.to_s
+      return nil unless NUMBER_REGEX.match(value)
+      value.blank? ? nil : value.split(',').join.to_i
+    end
+
+    ##
+    # Parses a value for use as a SQL filter.
+    #
+    # Returns 'NULL' if the value parses to nil.
+    # Otherwise returns the value.
+    #
+    def self.parse_for_float_filter(value)
+      value = parse_for_float_column(value)
+      value.nil? ? 'NULL' : value.to_s
+    end
+
+    ##
+    # Parses a value for use as a SQL filter.
+    #
+    # Returns 'NULL' if the value parses to nil.
+    # Otherwise returns the value.
+    #
+    def self.parse_for_int_filter(value)
+      value = parse_for_int_column(value)
+      value.nil? ? 'NULL' : value.to_s
+    end
+
+
+    # :nodoc:
+    def self.included(base)
+      base.class_eval do
+
+        ##
+        # Parses a value for storage in a float column.
+        #
+        # Returns nil if the value is invalid.
+        # Otherwise it returns a float.
+        #
+        def self.parse_for_float_column(value)
+          BarkestCore::NumberParser.parse_for_float_column value
+        end
+
+        ##
+        # Parses a value for storage in an integer column.
+        #
+        # Returns nil if the value is invalid.
+        # Otherwise it returns an integer.
+        def self.parse_for_int_column(value)
+          BarkestCore::NumberParser.parse_for_int_column value
+        end
+
+        ##
+        # Parses a value for use as a SQL filter.
+        #
+        # Returns 'NULL' if the value parses to nil.
+        # Otherwise returns the value.
+        #
+        def self.parse_for_float_filter(value)
+          BarkestCore::NumberParser.parse_for_float_filter value
+        end
+
+        ##
+        # Parses a value for use as a SQL filter.
+        #
+        # Returns 'NULL' if the value parses to nil.
+        # Otherwise returns the value.
+        #
+        def self.parse_for_int_filter(value)
+          BarkestCore::NumberParser.parse_for_int_filter value
+        end
+
+      end
+    end
+
+    protected
+
+    ##
+    # Parses a value for storage in a float column.
+    #
+    # Returns nil if the value is invalid.
+    # Otherwise it returns a float.
+    #
+    def parse_for_float_column(value)
+      BarkestCore::NumberParser.parse_for_float_column value
+    end
+
+    ##
+    # Parses a value for storage in an integer column.
+    #
+    # Returns nil if the value is invalid.
+    # Otherwise it returns an integer.
+    def parse_for_int_column(value)
+      BarkestCore::NumberParser.parse_for_int_column value
+    end
+
+    ##
+    # Parses a value for use as a SQL filter.
+    #
+    # Returns 'NULL' if the value parses to nil.
+    # Otherwise returns the value.
+    #
+    def parse_for_float_filter(value)
+      BarkestCore::NumberParser.parse_for_float_filter value
+    end
+
+    ##
+    # Parses a value for use as a SQL filter.
+    #
+    # Returns 'NULL' if the value parses to nil.
+    # Otherwise returns the value.
+    #
+    def parse_for_int_filter(value)
+      BarkestCore::NumberParser.parse_for_int_filter value
+    end
+
+  end
+end

data/lib/barkest_core/concerns/utc_conversion.rb

@@ -0,0 +1,60 @@
+require 'active_record'
+
+module BarkestCore
+  module UtcConversion
+    class UtcConverter < DelegateClass(ActiveRecord::Type::Value)
+      include ActiveRecord::Type::Decorator
+
+      def type_cast_from_database(value)
+        convert_to_utc(value)
+      end
+
+      def type_cast_from_user(value)
+        convert_to_utc(value)
+      end
+
+      def convert_to_utc(value)
+        if value.is_a?(Array)
+          value.map { |v| convert_to_utc(v) }
+        else
+          Time.utc_parse(value) rescue nil
+        end
+      end
+
+    end
+
+    extend ActiveSupport::Concern
+
+    included do
+      self.time_zone_aware_attributes = false if self.respond_to?(:time_zone_aware_attributes=)
+    end
+
+    module ClassMethods
+      private
+
+      def inherited(subclass)
+        subclass.class_eval do
+          matcher = ->(name, type) { create_utc_conversion_attribute?(name, type) }
+          decorate_matching_attribute_types(matcher, :_utc_conversion) do |type|
+            UtcConverter.new(type)
+          end
+        end
+        super
+      end
+
+      # disable TimeZoneConversion
+      def create_time_zone_conversion_attribute?(name, cast_type)
+        false
+      end
+
+      # enable UtcConversion
+      def create_utc_conversion_attribute?(name, cast_type)
+        cast_type.type == :datetime
+      end
+    end
+
+  end
+end
+
+# add it to the base model.
+ActiveRecord::Base.include BarkestCore::UtcConversion

data/lib/barkest_core/engine.rb

@@ -0,0 +1,105 @@
+require 'jquery-rails'
+require 'bootstrap-sass'
+require 'ntlm/smtp'
+require 'exception_notification'
+
+module BarkestCore
+  class Engine < ::Rails::Engine
+
+    # Ensure the default logo gets compiled.
+    config.assets.precompile += %w( barkest_core/barcode-B.svg
+barkest_core/ArchivoNarrow-Bold.ttf
+barkest_core/ArchivoNarrow-BoldItalic.ttf
+barkest_core/ArchivoNarrow-Italic.ttf
+barkest_core/ArchivoNarrow-Regular.ttf  )
+
+
+    ##
+    # Update the databases as needed.
+    Rails::Application::Finisher.initializer 'barkest_core.finisher' do |app|
+      MsSqlDbDefinition.registered.each do |name,updater|
+        config = BarkestCore.db_config(name)
+        if config[:database] && config[:host]
+          Rails.logger.debug "Beginning updates for #{name} DB."
+          begin
+            updater.update_db config
+          rescue BarkestCore::MsSqlDbDefinition::NeedFullAccess => e
+            Rails.logger.error "The configuration for #{name} DB is missing a valid update user."
+          rescue StandardError => e
+            Rails.logger.error "The updater for #{name} DB was unable to complete.\n#{e}"
+          end
+        else
+          Rails.logger.warn "Skipping updates for #{name} DB since :database and/or :host is not set."
+        end
+      end
+    end
+
+
+    ##
+    # Initialize the library.
+    initializer 'barkest_core.initialize' do |app|
+
+      # cache the application root path.
+      BarkestCore.app_root = app.root
+
+      app.paths['app/helpers'] << 'app/helpers/barkest_core'
+
+      # get the email config.
+      cfg = BarkestCore.email_config
+      mode = cfg[:config_mode].to_s.downcase
+      [ config.action_mailer, ActionMailer::Base ].each do |obj|
+        # configure action_mailer accordingly.
+        if %w(smtp test).include?(mode) && !cfg[:default_hostname].blank?
+          obj.default_url_options = { host: cfg[:default_hostname] }
+        end
+        if mode == 'smtp'
+          obj.raise_delivery_errors = true
+          obj.perform_deliveries = true
+          obj.delivery_method = :smtp
+          obj.smtp_settings = cfg  # remove the non-smtp settings.
+                                                   .except(
+                                                       :config_mode,
+                                                       :default_recipient,
+                                                       :default_sender,
+                                                       :default_hostname
+                                                   )
+        else
+          obj.delivery_method = mode.to_sym
+        end
+
+        # in production mode, we want exceptions sent to the default recipient.
+        if Rails.env.production?
+          Rails.application.config.middleware.use(
+              ExceptionNotification::Rack,
+              email: {
+                  email_prefix: "[BarkerEST #{Rails.application.app_name} (#{Rails.application.app_version})] ",
+                  sender_address: cfg[:default_sender],
+                  exception_recipients: [ cfg[:default_recipient] ]
+              }
+          )
+        end
+      end
+
+
+      # configure prawn-rails
+      PrawnRails.config do |config|
+        config.page_layout = :portrait
+        config.page_size = 'LETTER'
+      end
+
+      ActionView::Template.register_template_handler :csvrb, BarkestCore::CsvHandler::Handler
+
+
+      # add date formats for American formatted dates.
+      Time::DATE_FORMATS[:date] = '%m/%d/%y'
+      Time::DATE_FORMATS[:date4] = '%m/%d/%Y'
+      Date::DATE_FORMATS[:date] = '%m/%d/%y'
+      Date::DATE_FORMATS[:date4] = '%m/%d/%Y'
+
+      # If a child gem extends this class, we still want to load the original.
+      require_relative '../../app/controllers/barkest_core/application_controller_base'
+
+    end
+
+  end
+end

data/lib/barkest_core/extensions/active_record_extensions.rb

@@ -0,0 +1,120 @@
+
+
+module BarkestCore
+
+  ##
+  # Adds some helper methods to connection adapters.
+  module ConnectionAdapterExtensions
+
+    ##
+    # Searches the database to determine if an object with the specified name exists.
+    def object_exists?(object_name)
+      safe_name = "'#{object_name.gsub('\'','\'\'')}'"
+      klass = self.class.name
+
+      sql =
+          if klass == 'ActiveRecord::ConnectionAdapters::SQLServerAdapter'
+            # use sysobjects table.
+            "SELECT COUNT(*) AS \"one\" FROM \"sysobjects\" WHERE \"name\"=#{safe_name}"
+          elsif klass == 'ActiveRecord::ConnectionAdapters::SQLite3Adapter'
+            # use sqlite_master table.
+            "SELECT COUNT(*) AS \"one\" FROM \"sqlite_master\" WHERE (\"type\"='table' OR \"type\"='view') AND (\"name\"=#{safe_name})"
+          else
+            # query the information_schema TABLES and ROUTINES views.
+            "SELECT SUM(Z.\"one\") AS \"one\" FROM (SELECT COUNT(*) AS \"one\" FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_NAME=#{safe_name} UNION SELECT COUNT(*) AS \"one\" FROM INFORMATION_SCHEMA.ROUTINES WHERE ROUTINE_NAME=#{safe_name}) AS Z"
+          end
+
+      result = exec_query(sql).first
+
+      result && result['one'] >= 1
+    end
+
+    ##
+    # Executes a stored procedure.
+    #
+    # For MS SQL Server, this will return the return value from the procedure.
+    # For other providers, this is the same as +execute+.
+    def exec_sp(stmt)
+      klass = self.class.name
+      if klass == 'ActiveRecord::ConnectionAdapters::SQLServerAdapter'
+        rex = /^exec(?:ute)?\s+[\["]?(?<PROC>[a-z][a-z0-9_]*)[\]"]?(?<ARGS>\s.*)?$/i
+        match = rex.match(stmt)
+        if match
+          exec_query("DECLARE @RET INTEGER; EXECUTE @RET=[#{match['PROC']}]#{match['ARGS']}; SELECT @RET AS [RET]").first['RET']
+        else
+          execute stmt
+        end
+      else
+        execute stmt
+      end
+    end
+
+  end
+end
+
+
+## Add a few extensions to models.
+ActiveRecord::Base.class_eval do
+
+  ##
+  # Tests for equality on ID.
+  def ==(other)
+    if respond_to?(:id)
+      if other.is_a?(Numeric)
+        id == other
+      elsif other.class == self.class
+        id == other.id
+      else
+        false
+      end
+    else
+      self.inspect == other.inspect
+    end
+  end
+
+  ##
+  # Loads the concerns for the current model.
+  def self.add_concerns(subdir = nil)
+    klass = self
+    subdir ||= klass.name.underscore
+
+    Dir.glob(File.expand_path("../../../app/models/concerns/#{subdir}/*.rb", __FILE__)).each do |item|
+      require item
+      mod_name = File.basename(item)[0...-3].camelcase
+      if const_defined? mod_name
+        mod_name = const_get mod_name
+        klass.include mod_name
+      else
+        raise StandardError.new("The #{mod_name} module does not appear to be defined.")
+      end
+    end
+  end
+
+  # patch 'connection'  so that we can insert our extensions to the returned adapters.
+  class << self
+    # :nodoc:
+    alias_method :barkest_core_original_connection, :connection
+  end
+
+  # :nodoc:
+  def self.connection(*args)
+    ret = barkest_core_original_connection(*args)
+    unless ret.class.include?(BarkestCore::ConnectionAdapterExtensions)
+      ret.class.include BarkestCore::ConnectionAdapterExtensions
+    end
+    yield ret if block_given?
+    ret
+  end
+
+  ##
+  # Searches the database to determine if an object with the specified name exists.
+  #
+  # This method is actually attached to the connection adapter, so anywhere you have the +connection+ you can use it
+  # to query if an object exists.
+  def self.object_exists?(object_name)
+    return connection.object_exists?(object_name)
+  end
+
+end
+
+