datashift 0.40.3 → 0.40.4

data/lib/datashift/populators/populator.rb

@@ -23,13 +23,13 @@ module DataShift
     extend DataShift::Delimiters
 
     def self.insistent_method_list
-      @insistent_method_list ||= [:to_s, :downcase, :to_i, :to_f, :to_b]
+      @insistent_method_list ||= %i[to_s downcase to_i to_f to_b]
     end
 
     # When looking up an association, when no field provided, try each of these in turn till a match
     # i.e find_by_name, find_by_title, find_by_id
     def self.insistent_find_by_list
-      @insistent_find_by_list ||= [:name, :title, :id]
+      @insistent_find_by_list ||= %i[name title id]
     end
 
     attr_reader :value, :attribute_hash
@@ -99,7 +99,7 @@ module DataShift
           @value = data
 
         elsif(!DataShift::Guards.jruby? &&
-          (data.is_a?(Spreadsheet::Formula) || data.class.ancestors.include?(Spreadsheet::Formula)) )
+            (data.is_a?(Spreadsheet::Formula) || data.class.ancestors.include?(Spreadsheet::Formula)) )
 
           @value = data.value # TOFIX jruby/apache poi equivalent ?
 
@@ -129,8 +129,7 @@ module DataShift
         end
 
         run_transforms(method_binding)
-
-      rescue => e
+      rescue StandardError => e
         logger.error(e.message)
         logger.error("Populator stacktrace: #{e.backtrace.first}")
         raise DataProcessingError, "Populator failed to prepare data [#{value}] for #{method_binding.pp}"
@@ -156,11 +155,17 @@ module DataShift
 
       elsif model_method.operator_for(:has_one)
 
-        if value.is_a?(model_method.klass)
+        begin
           record.send(operator + '=', value)
-        else
-          logger.error("Cannot assign value [#{value.inspect}]")
-          logger.error("Value was Type (#{value.class}) - Required Type for has_one #{operator} is [#{klass}]")
+        rescue StandardError => x
+          logger.error("Cannot assign value [#{value.inspect}] for has_one [#{operator}]")
+          logger.error(x.inspect)
+
+          if value.is_a?(model_method.klass)
+            logger.error("Value was Correct Type (#{value.class}) - [#{model_method.klass}]")
+          else
+            logger.error("Value was Type (#{value.class}) - Required Type is [#{model_method.klass}]")
+          end
         end
 
       elsif model_method.operator_for(:assignment)
@@ -182,15 +187,17 @@ module DataShift
         begin
           params_num = record.method(operator.to_sym).arity
 
-          # think this should be == 0 but seen situations where -1 returned even though method accepts ZERO params
-          if(params_num < 1)
+          # There are situations where -1 returned, this is normally related to variable number of arguments,
+          # but maybe buggy - have seen -1 for what seems perfceatlly normal method e.g   def attach_audio_file_helper(file_name)
+          #
+          if(params_num == 0)
             logger.debug("Calling Custom Method (no value) [#{operator}]")
             record.send(operator)
           elsif(value)
             logger.debug("Custom Method assignment of value  #{value} => [#{operator}]")
             record.send(operator, value)
           end
-        rescue => e
+        rescue StandardError => e
           logger.error e.backtrace.first
           raise DataProcessingError, "Method [#{operator}] could not process #{value} - #{e.inspect}"
         end
@@ -223,7 +230,7 @@ module DataShift
             record.send( operator + '=', value)
           end
         end
-      rescue => e
+      rescue StandardError => e
         logger.error e.backtrace.first
         logger.error("Assignment failed #{e.inspect}")
         raise DataProcessingError, "Failed to set [#{value}] via [#{operator}] due to ERROR : #{e.message}"
@@ -251,7 +258,6 @@ module DataShift
         # TODO: - add find by operators from headers or configuration to  insistent_find_by_list
         Populator.insistent_find_by_list.each do |find_by|
           begin
-
             item = klass.where(find_by => value).first_or_create
 
             next unless item
@@ -259,8 +265,7 @@ module DataShift
             logger.info("Populator assigning #{item.inspect} to belongs_to association #{operator}")
             record.send(operator + '=', item)
             break
-
-          rescue => e
+          rescue StandardError => e
             logger.error(e.inspect)
             logger.error("Failed attempting to find belongs_to for #{method_binding.pp}")
             if find_by == Populator.insistent_method_list.last

data/lib/datashift/populators/populator_factory.rb

@@ -25,7 +25,7 @@ module DataShift
     #
     def self.configure(load_object_class, yaml_file)
 
-      @config = YAML.load( ERB.new( IO.read(yaml_file) ).result )
+      @config = Configuration.parse_yaml(yaml_file)
 
       if @config[:datashift_populators]
         @config[:datashift_populators].each do |_operator, type|
@@ -66,9 +66,7 @@ module DataShift
     def self.get_populator(method_binding)
 
       unless method_binding.nil? || method_binding.invalid?
-        if(populators.key?(method_binding.operator))
-          return populators[method_binding.operator].new
-        end
+        return populators[method_binding.operator].new if populators.key?(method_binding.operator)
       end
 
       global_populator_class.new

data/lib/datashift/querying.rb

@@ -40,7 +40,7 @@ module DataShift
 
       heading_lookups = method_binding.inbound_column.lookup_list
 
-      if (part1.nil? || part1.empty?) && (part2.nil? || part2.empty?)
+      if part1.blank? && part2.blank?
 
         # Column completely empty - check for lookup supplied via the
         # inbound column headers/config
@@ -50,7 +50,7 @@ module DataShift
         part1 = heading_lookups.find_by_operator
         part2 = heading_lookups.collect(&:value)
 
-      elsif part2.nil? || part2.empty?
+      elsif part2.blank?
 
         # Only **value(s)** in column, so use field from header/config field
 
@@ -82,7 +82,7 @@ module DataShift
         return klazz.where("#{field} like ?", "#{search_term}%").first if options[:use_like]
 
         return klazz.where("lower(#{field}) = ?", search_term.downcase).first
-      rescue => e
+      rescue StandardError => e
         logger.error("Querying - Failed to find a record for [#{search_term}] on #{klazz}.#{field}")
         logger.error e.inspect
         logger.error e.backtrace.last
@@ -108,7 +108,6 @@ module DataShift
       logger.info("Scanning for record where #{klazz}.#{field} ~=  #{find_search_term}")
 
       begin
-
         record = search_for_record(klazz, field, find_search_term)
 
         unless record
@@ -134,7 +133,7 @@ module DataShift
         end
 
         return record
-      rescue => e
+      rescue StandardError => e
         logger.error("Exception attempting to find a record for [#{search_term}] on #{klazz}.#{field}")
         logger.error e.backtrace
         logger.error e.inspect

data/lib/datashift/transformation/factory.rb

@@ -43,7 +43,7 @@ module DataShift
 
   module Transformation
 
-    extend self
+    module_function
 
     # Yields a singleton instance of Transformations::Factory
     # so you can specify additional transforms in .rb config
@@ -62,7 +62,7 @@ module DataShift
 
     class Factory
 
-      TRANSFORMERS_HASH_INSTANCE_NAMES = [:default, :override, :substitution, :prefix, :postfix].freeze
+      TRANSFORMERS_HASH_INSTANCE_NAMES = %i[default override substitution prefix postfix].freeze
 
       include DataShift::Logging
 
@@ -99,7 +99,7 @@ module DataShift
       #
       def configure_from(load_object_class, yaml_file, locale_key = 'data_flow_schema')
 
-        data = YAML.load( ERB.new( IO.read(yaml_file) ).result )
+        data = Configuration.parse_yaml(yaml_file)
 
         class_name = load_object_class.name
 

data/lib/datashift/version.rb

@@ -1,3 +1,3 @@
 module DataShift
-    VERSION = '0.40.3'.freeze unless defined?(VERSION)
+    VERSION = '0.40.4'.freeze unless defined?(VERSION)
 end

data/lib/generators/datashift/install_generator.rb

@@ -3,13 +3,13 @@ require 'rails/generators/base'
 module Datashift
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      source_root File.expand_path("../../templates", __FILE__)
+      source_root File.expand_path('../templates', __dir__)
 
-      desc "Creates a DataShift initializer within your Rails application."
+      desc 'Creates a DataShift initializer within your Rails application.'
       class_option :orm
 
       def copy_initializer
-        template "datashift.rb", "config/initializers/datashift.rb"
+        template 'datashift.rb', 'config/initializers/datashift.rb'
       end
 
       def rails_4?

data/lib/generators/templates/datashift.rb

@@ -8,7 +8,6 @@ DataShift::Configuration.call do |config|
   #
   # config.with = [:assignment, :enum]
 
-
   # Configure what association types to ignore during export with associations.
   #
   # The default is to include ALL all association TYPES as defined by
@@ -18,17 +17,14 @@ DataShift::Configuration.call do |config|
   #
   # config.exclude = [:belongs_to]
 
-
   # Configure the Global list of of columns to remove/ignore from files
   #
   # config.remove_columns = [:id, :dont_want_this, :no]
 
-
   # List of headers/columns that are Mandatory i.e must be present in the inbound data
   #
   # config.mandatory = [:yes]
 
-
   # Remove standard Rails cols like :id, created_at, updated_at
   # Default is false
   #

data/lib/tasks/config.thor

@@ -14,30 +14,28 @@ module Datashift
 
     class Generate < Thor
 
-      DEFAULT_IMPORT_TEMPLTE ||= "import_mapping_template.yaml".freeze
+      DEFAULT_IMPORT_TEMPLTE ||= 'import_mapping_template.yaml'.freeze
 
       include DataShift::ThorBehavior
 
-      desc "import", "Generate an Import configuration template (YAML)"
+      desc 'import', 'Generate an Import configuration template (YAML)'
 
-      method_option :model, aliases: '-m', required: true, desc: "The active record model to use for mappings"
+      method_option :model, aliases: '-m', required: true, desc: 'The active record model to use for mappings'
 
       method_option :result, aliases: '-r', required: true,
-                    desc: "Path or file to create resulting YAML config\n\nIf a PATH supplied, filename will be [#{DEFAULT_IMPORT_TEMPLTE}]"
+                             desc: "Path or file to create resulting YAML config\n\nIf a PATH supplied, filename will be [#{DEFAULT_IMPORT_TEMPLTE}]"
 
       #   :remove_columns - List of columns to remove from files
       #
       #   :remove_rails - Remove standard Rails cols like :id, created_at etc
 
-      def import()
+      def import
 
         start_connections
 
         result = options[:result]
 
-        if(File.directory?(result))
-          result = File.join(result, DEFAULT_IMPORT_TEMPLTE)
-        end
+        result = File.join(result, DEFAULT_IMPORT_TEMPLTE) if File.directory?(result)
 
         logger.info "Datashift: Starting Import mapping template generation to [#{result}]"
 
@@ -46,7 +44,7 @@ module Datashift
         puts "Creating new configuration file : [#{result}]"
         begin
           mapper.write_import(result, options[:model], options)
-        rescue => x
+        rescue StandardError => x
           puts "ERROR - Failed to create config file #{result}"
           puts x.message
         end

data/lib/tasks/export.thor

@@ -17,37 +17,37 @@ module Datashift
     include DataShift::ThorBehavior
 
     class_option :associations, aliases: '-a',
-                 type: :boolean,
-                 desc: 'Include associations. Can be further refined by :with & :exclude'
+                                type: :boolean,
+                                desc: 'Include associations. Can be further refined by :with & :exclude'
 
     class_option :expand_associations, type: :boolean,
-                 desc: 'Expand association data to multiple columns i.e 1 column per attribute'
+                                       desc: 'Expand association data to multiple columns i.e 1 column per attribute'
 
     class_option :methods, type: :array,
-                 desc: 'List of additional methods to call on model, useful for situations like delegated methods'
+                           desc: 'List of additional methods to call on model, useful for situations like delegated methods'
 
     class_option :with, type: :array,
-                 desc: "Restrict association types. Choose from #{DataShift::ModelMethod.supported_types_enum.inspect}"
+                        desc: "Restrict association types. Choose from #{DataShift::ModelMethod.supported_types_enum.inspect}"
 
     class_option :exclude, type: :array,
-                 desc: "Exclude association types. Choose from #{DataShift::ModelMethod.supported_types_enum.inspect}"
+                           desc: "Exclude association types. Choose from #{DataShift::ModelMethod.supported_types_enum.inspect}"
 
     class_option :remove,  type: :array,
-                 desc: "Don't include this list of supplied fields"
+                           desc: "Don't include this list of supplied fields"
 
     class_option :remove_rails, type: :boolean,
-                 desc: "Remove standard Rails cols :  #{DataShift::Configuration.rails_columns.inspect}"
+                                desc: "Remove standard Rails cols :  #{DataShift::Configuration.rails_columns.inspect}"
 
     class_option :json, type: :boolean,
-                 desc: 'Export association data as json rather than hash'
+                        desc: 'Export association data as json rather than hash'
 
-    desc "excel", "export any active record model (with optional associations)"
+    desc 'excel', 'export any active record model (with optional associations)'
 
-    method_option :model, :aliases => '-m', :required => true, desc: "The active record model to export"
-    method_option :result, :aliases => '-r', :required => true, desc: "Create template of model in supplied file"
-    method_option :sheet_name, :type => :string, desc: "Name to use for Excel worksheet instead of model name"
+    method_option :model, aliases: '-m', required: true, desc: 'The active record model to export'
+    method_option :result, aliases: '-r', required: true, desc: 'Create template of model in supplied file'
+    method_option :sheet_name, type: :string, desc: 'Name to use for Excel worksheet instead of model name'
 
-    def excel()
+    def excel
       start_connections
 
       export(DataShift::ExcelExporter.new)
@@ -55,13 +55,12 @@ module Datashift
       puts "Datashift: Excel export COMPLETED to #{options[:result]}"
     end
 
+    desc 'csv', 'export any active record model (with optional associations)'
 
-    desc "csv", "export any active record model (with optional associations)"
+    method_option :model, aliases: '-m', required: true, desc: 'The active record model to export'
+    method_option :result, aliases: '-r', required: true, desc: 'Create template of model in supplied file'
 
-    method_option :model, :aliases => '-m', :required => true, desc: "The active record model to export"
-    method_option :result, :aliases => '-r', :required => true, desc: "Create template of model in supplied file"
-
-    def csv()
+    def csv
       start_connections
 
       export(DataShift::CsvExporter.new)
@@ -69,28 +68,27 @@ module Datashift
       puts "Datashift: CSV export COMPLETED to #{options[:result]}"
     end
 
+    desc 'db', 'Export every Active Record model'
 
-    desc "db", "Export every Active Record model"
-
-    method_option :path, :aliases => '-p', :required => true, desc: "Path in which to create export files"
-    method_option :csv, :aliases => '-c', desc: "Export to CSV instead - Excel is default."
+    method_option :path, aliases: '-p', required: true, desc: 'Path in which to create export files'
+    method_option :csv, aliases: '-c', desc: 'Export to CSV instead - Excel is default.'
 
-    method_option :prefix_map, :aliases => '-x', type: :hash, :default => {},
-                  desc: "For namespaced tables/models map table prefix to module name e.g spree_: Spree"
+    method_option :prefix_map, aliases: '-x', type: :hash, default: {},
+                               desc: 'For namespaced tables/models map table prefix to module name e.g spree_: Spree'
 
-    method_option :modules, :aliases => '-m', type: :array, :default => [],
-                  desc: "List of Modules to search for namespaced models"
+    method_option :modules, aliases: '-m', type: :array, default: [],
+                            desc: 'List of Modules to search for namespaced models'
 
-    def db()
+    def db
 
       start_connections
 
       unless File.directory?(options[:path])
         puts "WARNING : No such PATH found #{options[:path]} - trying mkdir"
-        FileUtils::mkdir_p(options[:path])
+        FileUtils.mkdir_p(options[:path])
       end
 
-      exporter = options[:csv] ?  DataShift::CsvExporter.new :  DataShift::ExcelExporter.new
+      exporter = options[:csv] ? DataShift::CsvExporter.new : DataShift::ExcelExporter.new
 
       DataShift::Exporters::Configuration.from_hash(options)
 
@@ -105,13 +103,15 @@ module Datashift
           break if(@klass)
         end
 
-        options[:prefix_map].each do |p, m|
-          @klass = DataShift::MapperUtils.table_to_arclass(table.gsub(p, ''), m)
-          break if(@klass)
-        end unless(@klass)
+        unless @klass
+          options[:prefix_map].each do |p, m|
+            @klass = DataShift::MapperUtils.table_to_arclass(table.gsub(p, ''), m)
+            break if(@klass)
+          end
+        end
 
         if(@klass.nil?)
-          puts  "ERROR: No Model found for Table [#{table}] - perhaps check modules/prefixes"
+          puts "ERROR: No Model found for Table [#{table}] - perhaps check modules/prefixes"
           next
         end
 
@@ -121,15 +121,15 @@ module Datashift
 
         begin
           if(options[:associations])
-            logger.info("Datashift: Exporting with associations")
+            logger.info('Datashift: Exporting with associations')
             exporter.export_with_associations(result, @klass, @klass.all)
           else
-            exporter.export(result, @klass.all, :sheet_name => @klass.name)
+            exporter.export(result, @klass.all, sheet_name: @klass.name)
           end
-        rescue => e
+        rescue StandardError => e
           puts e
           puts e.backtrace
-          puts "Warning: Error during export, data may be incomplete"
+          puts 'Warning: Error during export, data may be incomplete'
         end
       end
     end
@@ -144,27 +144,26 @@ module Datashift
 
         logger.info "Datashift: Starting export with #{exporter.class.name} to #{result}"
 
-        klass = DataShift::MapperUtils::class_from_string(model)  #Kernel.const_get(model)
+        klass = DataShift::MapperUtils.class_from_string(model) # Kernel.const_get(model)
 
         raise "ERROR: No such Model [#{model}] found - check valid model supplied via -model <Class>" if(klass.nil?)
 
         begin
-
           if(options[:associations])
-            logger.info("Datashift: Exporting with associations")
+            logger.info('Datashift: Exporting with associations')
             exporter.export_with_associations(result, klass, klass.all)
           else
             exporter.export(result, klass.all, options)
           end
-        rescue => e
+        rescue StandardError => e
           puts e
           puts e.backtrace
-          puts "Warning: Error during export, data may be incomplete"
+          puts 'Warning: Error during export, data may be incomplete'
         end
 
       end
 
-    end   # no_commands
+    end # no_commands
 
   end