csv_model 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 670a14423c708636825d5a2cebed117a0ac186e2
+  data.tar.gz: 7c39766c75b1b629c743036a5791da36c93032c9
+SHA512:
+  metadata.gz: 8fb5608b94c655f60c36c89b469f651ddd4a725a64fa5359b6534ec4cc37197cb80387e3bc213d40cb09b49569a0417ebfa63c60ccf4e81e54d2db41d71f46e4
+  data.tar.gz: 03c07a434abc2fec5416f62cff6453a4bffd2758f017e5c91cadb35daeca408adf26c03b1592e721ee6051c9be864f74f04e6d05c2c062a8a28bfffada80bc54

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 2.0.0
+  - 2.1.1
+
+install:
+  - "travis_retry bundle install"
+
+script: "bundle exec rake"
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    csv_model (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.3.1)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  csv_model!
+  rake
+  rspec (= 3.0.0)

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Scrimmage
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,6 @@
+csv_model
+=========
+
+[![Build Status](https://travis-ci.org/Scrimmage/csv_model.svg)](https://travis-ci.org/Scrimmage/csv_model)
+
+[![Code Climate](https://codeclimate.com/github/Scrimmage/csv_model.png)](https://codeclimate.com/github/Scrimmage/csv_model)

data/Rakefile

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'bundler'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+desc 'Default: run the specs.'
+task :default do
+  system("bundle exec rake -s spec:unit;")
+end
+
+namespace :spec do
+  desc "Run unit specs"
+  RSpec::Core::RakeTask.new('unit') do |t|
+    t.pattern = 'spec/**/*_spec.rb}'
+  end
+end
+
+desc "Run the unit and acceptance specs"
+task :spec => ['spec:unit']

data/csv_model.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'csv_model/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "csv_model"
+  spec.version       = CSVModel::VERSION
+  spec.authors       = ["Matthew Chadwick"]
+  spec.email         = ["matthew.chadwick@gmail.com"]
+  spec.summary       = %q{Utility library for importing CSV data.}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "3.0.0"
+end

data/lib/csv_model/column.rb

@@ -0,0 +1,27 @@
+using CSVModel::Extensions
+
+module CSVModel
+  class Column
+    include Utilities::Options
+
+    attr_reader :name
+
+    def initialize(name, options = {})
+      @name = name
+      @options = options
+    end
+
+    def is_primary_key?
+      option(:primary_key, false)
+    end
+
+    def key
+      name.to_column_key
+    end
+
+    def model_attribute
+      key.underscore.to_sym
+    end
+
+  end
+end

data/lib/csv_model/errors.rb

@@ -0,0 +1,5 @@
+module CSVModel
+
+  class ParseError < RuntimeError; end
+
+end

data/lib/csv_model/extensions.rb

@@ -0,0 +1,45 @@
+module CSVModel
+  module Extensions
+
+    refine Array do
+      def all_values_blank?
+        return true if empty?
+        each { |value| return false if !value.nil? && value.try(:strip) != "" }
+        true
+      end
+    end
+
+    refine NilClass do
+      def try(*args)
+        nil
+      end
+    end
+
+    refine Object do
+      def try(*a, &b)
+        if a.empty? && block_given?
+          yield self
+        else
+          public_send(*a, &b) if respond_to?(a.first)
+        end
+      end
+    end
+
+    refine String do
+      def to_column_key
+        downcase.strip
+      end
+
+      def underscore
+        tr(' ', '_').tr("-", "_")        
+      end
+    end
+
+    refine Symbol do
+      def to_column_key
+        to_s.downcase.strip
+      end
+    end
+
+  end
+end

data/lib/csv_model/header_row.rb

@@ -0,0 +1,133 @@
+using CSVModel::Extensions
+
+module CSVModel
+  class HeaderRow
+    include Utilities::Options
+
+    attr_reader :data
+
+    def initialize(data, options = {})
+      @data = data
+      @options = options
+    end
+
+    def columns
+      @columns ||= data.collect { |x| Column.new(x) }
+    end
+
+    def column_count
+      columns.count
+    end
+
+    def column_index(key)
+      column_keys.index(key.to_column_key)
+    end
+
+    def errors
+      duplicate_column_errors + illegal_column_errors + missing_column_errors
+    end
+
+    # TODO: Remove? Not currently used.
+    def has_column?(key)
+      !column_index(key).nil?
+    end
+
+    def primary_key_columns
+      @primary_key_columns ||= columns.select { |x| primary_key_column_keys.include?(x.key) }
+    end
+
+    def valid?
+      has_required_columns? && !has_duplicate_columns? && !has_illegal_columns?
+    end
+
+    protected
+
+    def column_keys
+      @column_keys ||= columns.collect { |x| x.key }
+    end
+
+    def column_map
+      @column_map ||= Hash[columns.collect { |x| [x.key, x] }]
+    end
+
+    def column_name(column_key)
+      data.find { |entry| entry.to_column_key == column_key }
+    end
+
+    def duplicate_column_errors
+      duplicate_column_names.collect { |name| "Multiple columns found for #{name}, column headings must be unique" }
+    end
+
+    def duplicate_column_names
+      data.collect { |x| x.to_column_key }
+        .inject(Hash.new(0)) { |counts, key| counts[key] += 1; counts }
+        .select { |key, count| count > 1 }
+        .collect { |key, count| column_name(key) }
+    end
+
+    def has_duplicate_columns?
+      data.count != column_map.keys.count
+    end
+
+    def has_illegal_columns?
+      illegal_column_keys.any?
+    end
+
+    def has_required_columns?
+      missing_column_keys.empty?
+    end
+
+    def illegal_column_errors
+      illegal_column_names.collect { |name| "Unknown column #{name}" }
+    end
+
+    def illegal_column_keys
+      legal_column_names.any? ? column_keys - legal_column_keys : []    
+    end
+
+    def illegal_column_names
+      illegal_column_keys.collect { |key| column_name(key) }
+    end
+
+    def legal_column_names
+      option(:legal_columns, [])
+    end
+
+    def legal_column_keys
+      legal_column_names.collect { |x| x.to_column_key }
+    end
+
+    def missing_column_errors
+      missing_column_names.collect { |name| "Missing column #{name}" }
+    end
+
+    def missing_column_keys
+      required_column_keys - column_keys
+    end
+
+    def missing_column_names
+      missing_column_keys.collect { |key| required_column_name(key) }
+    end
+
+    def primary_key_column_keys
+      primary_key_column_names.collect { |x| x.to_column_key }
+    end
+
+    def primary_key_column_names
+      option(:primary_key, [])
+    end
+
+    def required_column_keys
+      required_column_names.collect { |x| x.to_column_key }
+    end
+
+    def required_column_name(column_key)
+      required_column_names.find { |entry| entry.to_column_key == column_key }
+    end
+
+    def required_column_names
+      option(:required_columns, [])
+    end
+
+  end
+end

data/lib/csv_model/model.rb

@@ -0,0 +1,96 @@
+using CSVModel::Extensions
+
+module CSVModel
+  class Model
+    include Utilities::Options
+
+    attr_reader :data, :header, :keys, :parse_error, :rows
+
+    def initialize(data, options = {})
+      @data = data
+      @rows = []
+      @options = options
+      @keys = Set.new
+    end
+
+    def row_count
+      rows.count
+    end
+
+    def structure_errors
+      return [parse_error] if parse_error
+      return header.errors if !header.valid?
+      []
+    end
+
+    def structure_valid?
+      parse_error.nil? && header.valid?
+    end
+
+    instance_methods(false).each do |method_name|
+      method = instance_method(method_name)
+      define_method(method_name) do |*args, &block|
+        parse_data
+        method.bind(self).(*args, &block)
+      end
+    end
+
+    protected
+
+    def create_header_row(row)
+      header_class.new(row, options)
+    end
+
+    def create_row(row)
+      row = row_class.new(header, row, options)
+      row.mark_as_duplicate if is_duplicate_key?(row.key)
+      row
+    end
+
+    def header_class
+      option(:header_class, HeaderRow)
+    end
+
+    def is_duplicate_key?(value)
+      return false if value.nil? || value == "" || (value.is_a?(Array) && value.all_values_blank?)
+      !keys.add?(value)
+    end
+
+    def parse_data
+      return if @parsed
+      @parsed = true
+
+      begin
+        CSV.parse(data, { col_sep: "\t" }).each_with_index do |row, index|
+          if index == 0
+            @header = create_header_row(row)
+          end
+
+          if row.size != header.column_count
+            raise ParseError.new("Each row should have exactly #{header.column_count} columns. Error on row #{index + 1}.")
+          end
+
+          # TODO: Should we keep this?
+          # if index > (limit - 1)
+          #   raise ParseError.new("You can only import #{limit} records at a time. Please split your import into multiple parts.")
+          # end
+
+          if index > 0 
+            @rows << create_row(row)
+          end
+        end
+      rescue CSV::MalformedCSVError => e
+        @parse_error = "The data could not be parsed. Please check for formatting errors: #{e.message}"
+      rescue ParseError => e
+        @parse_error = e.message
+      rescue Exception => e
+        @parse_error = "An unexpected error occurred. Please try again or contact support if the issue persists: #{e.message}"
+      end
+    end
+
+    def row_class
+      option(:row_class, Row)
+    end
+
+  end
+end

data/lib/csv_model/object_with_status_snapshot.rb

@@ -0,0 +1,112 @@
+using CSVModel::Extensions
+
+module CSVModel
+  class ObjectWithStatusSnapshot < SimpleDelegator
+    include RecordStatus
+
+    def assign_attributes(attributes)
+      __getobj__.try(:assign_attributes, attributes)
+    end
+
+    def errors
+      if __getobj__.nil?
+        ["Record could not be created or updated"]
+      else
+        value = __getobj__.errors
+        value.try(:full_messages) || value
+      end
+    end
+
+    def mark_as_duplicate
+      @is_duplicate = true
+    end
+
+    def save(options = {})
+      capture_state(options[:dry_run])
+      @was_saved = was_editable? && was_valid? && (is_dry_run? || save_or_destroy)
+    end
+
+    def status
+      return ERROR_ON_READ if __getobj__.nil?
+      return DUPLICATE if is_dry_run? && is_duplicate?
+      return status_for_new_record if was_new?
+      return status_for_existing_record if was_existing?
+      UNKNOWN
+    end
+
+    def valid?
+      __getobj__.try(:valid?)
+    end
+
+    private
+
+    def capture_state(dry_run)
+      @is_dry_run = dry_run == true
+      if !__getobj__.nil?
+        @was_changed = changed?
+        @was_deleted = marked_for_destruction?
+        @was_editable = __getobj__.respond_to?(:editable?) ? __getobj__.editable? : true
+        @was_new = new_record?
+        @was_valid = valid?
+      end
+    end
+
+    def is_duplicate?
+      @is_duplicate
+    end
+
+    def is_dry_run?
+      @is_dry_run
+    end
+
+    def save_or_destroy
+      marked_for_destruction? ? __getobj__.destroy : __getobj__.save
+    end
+
+    def status_for_existing_record
+      return DELETE if was_deleted?
+      return NOT_CHANGED if !was_changed?
+      return UPDATE if was_valid? && was_saved?
+      ERROR_ON_UPDATE # if (!was_editable? || !was_valid? || !was_saved?)
+    end
+
+    def status_for_new_record
+      return ERROR_ON_DELETE if was_deleted?
+      return ERROR_ON_CREATE if was_not_valid?
+      CREATE # if valid?
+    end
+
+    def was_changed?
+      @was_changed
+    end
+
+    def was_deleted?
+      @was_deleted
+    end
+
+    def was_editable?
+      @was_editable
+    end
+
+    def was_existing?
+      !was_new?
+    end
+
+    def was_new?
+      @was_new
+    end
+
+    def was_saved?
+      @was_saved
+    end
+
+    def was_not_valid?
+      !was_valid?
+    end
+
+    def was_valid?
+      @was_valid
+    end
+
+  end
+end

data/lib/csv_model/record_status.rb

@@ -0,0 +1,16 @@
+module CSVModel
+  module RecordStatus
+
+    UNKNOWN          = 0
+    ERROR_ON_READ    = 1
+    NOT_CHANGED      = 2
+    DUPLICATE        = 3
+    CREATE           = 4
+    DELETE           = 5
+    UPDATE           = 6
+    ERROR_ON_CREATE  = 7
+    ERROR_ON_DELETE  = 8
+    ERROR_ON_UPDATE  = 9
+
+  end
+end