speaky_csv 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c9f27598188d01a1f54fc451cd37a7bf147030b8
+  data.tar.gz: b140a75185fbe65047c91b60dc041f11bcbe7f08
+SHA512:
+  metadata.gz: bd17153298a4ace51d67c96698fc5454c5e27f93652ac651cdb3241779bb4347e177fc5385e044d08d14ecab326568db5f9fc4235791343e03ea6fa7a28d348f
+  data.tar.gz: ad3848f06899fca0b59bb0adb3e5534c4ea18886fec66cfd10e2ac07241a299fa0dae6807f774b2826281437a68102cb80230c8e3efb09268206198e8661c309

data/.gitignore

@@ -0,0 +1 @@
+spec/active_record.log

data/.rubocop.yml

@@ -0,0 +1,27 @@
+# uncomment to ignore pre-existing warnings
+# inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+    - 'db/**/*'
+    - 'config/**/*'
+    - 'features/**/*'
+    - 'lib/**/*'
+    - 'script/**/*'
+    - 'spec/**/*'
+    - 'vendor/**/*'
+
+  RunRailsCops: true
+
+# Allow 120 character line lengths
+LineLength:
+  Max: 120
+
+# Allow tabbed alignment of method args
+SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+# Don't require top-level documenation
+Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in speaky_csv.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,119 @@
+PATH
+  remote: .
+  specs:
+    speaky_csv (0.0.1)
+      activemodel
+      activerecord
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.5)
+      activesupport (= 4.2.5)
+      builder (~> 3.1)
+    activerecord (4.2.5)
+      activemodel (= 4.2.5)
+      activesupport (= 4.2.5)
+      arel (~> 6.0)
+    activesupport (4.2.5)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    ast (2.1.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
+    builder (3.2.2)
+    coderay (1.1.0)
+    database_cleaner (1.5.1)
+    diff-lcs (1.2.5)
+    ffi (1.9.10)
+    formatador (0.2.5)
+    guard (2.13.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, <= 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.6.4)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    listen (3.0.4)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.9)
+    method_source (0.8.2)
+    minitest (5.8.2)
+    nenv (0.2.0)
+    notiffany (0.0.8)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parser (2.2.3.0)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    rb-fsevent (0.9.6)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    rubocop (0.35.0)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.3.0, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+    ruby-progressbar (1.7.5)
+    ruby_gntp (0.3.4)
+    shellany (0.0.1)
+    slop (3.6.0)
+    sqlite3 (1.3.11)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (> 1.5)
+  database_cleaner
+  guard-rspec
+  rake
+  rb-fsevent
+  rb-inotify
+  rspec (> 2.14.0)
+  rubocop
+  ruby_gntp
+  speaky_csv!
+  sqlite3
+
+BUNDLED WITH
+   1.10.3

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrew Hartford
+
+MIT License
+
+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,72 @@
+# Speaky CSV
+
+CSV exporting and importing for ActiveRecord and ActiveModel records.
+
+Speaky lets the format of csv files to be customized, but it does
+require certain conventions to be followed. At a high level, the csv
+ends up looking similar to the way active record data gets serialized
+into form parameters which will be familiar to many rails developers.
+The advantage of this approach is that associated records be imported
+and exported.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'speaky_csv'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install speaky_csv
+
+## Usage
+
+Subclass SpeakyCsv::Base and define a csv format for an active
+record class. For example:
+
+    # in app/csv/user_csv.rb
+    class UserCsv < SpeakyCsv::Base
+      define_csv_fields do |config|
+        config.field :id, :first_name, :last_name, :email
+
+        config.has_many :roles do |r|
+          r.field :role_name
+        end
+      end
+    end
+
+See the rdoc for more details on how to configure the format.
+
+Once the format is defined records can be exported like this:
+
+    $ exporter = UserCsv.new.exporter(User.all)
+    $ File.open('users.csv', 'w') { |io| exporter.each { |row| io.write row } }
+
+## Recommendations
+
+* Add `id` and `_destroy` fields for active record models
+* For associations, use `nested_attributes_for` and add `id` and
+  `_destroy` fields
+* Use optimistic locking and add `lock_version` to csv
+
+## TODO
+
+* [x] export only fields
+* [x] configurable id field (key off an `external_id` for example)
+* [x] export validations
+* [x] attr import validations
+* [x] active record import validations
+* [ ] `has_one` associations
+* [ ] required fields (make `lock_version` required for example)
+
+## Contributing
+
+1. Fork it ( http://github.com/ajh/speaky_csv/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/speaky_csv/active_record_import.rb

@@ -0,0 +1,97 @@
+require 'csv'
+require 'active_record'
+
+module SpeakyCsv
+  # Imports a csv file as unsaved active record instances
+  class ActiveRecordImport
+    include Enumerable
+
+    QUERY_BATCH_SIZE = 20
+    TRUE_VALUES = ActiveRecord::ConnectionAdapters::Column::TRUE_VALUES
+
+    attr_accessor :errors
+
+    def initialize(config, input_io, klass)
+      @config = config
+      @errors = ActiveModel::Errors.new(self)
+      @klass = klass
+
+      @attr_import = AttrImport.new @config, input_io
+      @attr_import.errors = @errors
+    end
+
+    def each
+      errors.clear
+      block_given? ? enumerator.each { |a| yield a } : enumerator
+    end
+
+    private
+
+    def enumerator
+      Enumerator.new do |yielder|
+        attr_enumerator = @attr_import.each
+        done = false
+
+        row_index = 1
+
+        while done == false
+          rows = []
+
+          QUERY_BATCH_SIZE.times do
+            begin
+              rows << attr_enumerator.next
+            rescue StopIteration
+              done = true
+            end
+          end
+
+          keys = rows.map { |attrs| attrs[@config.primary_key.to_s] }
+          records = @klass.includes(@config.has_manys.keys)
+            .where(@config.primary_key => keys)
+            .inject({}) { |a, e| a[e.send(@config.primary_key).to_s] = e; a }
+
+          rows.each do |attrs|
+            row_index += 1
+
+            record = if attrs[@config.primary_key.to_s].present?
+                       records[attrs[@config.primary_key.to_s]]
+                     else
+                       @klass.new
+                     end
+
+            unless record
+              errors.add "row_#{row_index}", "record not found with primary key #{attrs[@config.primary_key]}"
+              next
+            end
+
+            if @config.fields.include?(:_destroy)
+              if TRUE_VALUES.include?(attrs['_destroy'])
+                record.mark_for_destruction
+                yielder << record
+                next
+
+              else
+                attrs.delete '_destroy'
+              end
+            end
+
+            @config.has_manys.keys.each do |name|
+              if attrs.key?(name.to_s)
+                # assume nested attributes feature is used
+                attrs["#{name}_attributes"] = attrs.delete name.to_s
+              end
+            end
+
+            begin
+              record.attributes = attrs
+            rescue ActiveRecord::UnknownAttributeError
+              errors.add "row_#{row_index}", "record doesn't respond to some configured fields: #{$!.message}"
+            end
+
+            yielder << record
+          end
+        end
+      end
+    end
+  end
+end

data/lib/speaky_csv/attr_import.rb

@@ -0,0 +1,71 @@
+require 'csv'
+
+module SpeakyCsv
+  # Imports a csv file as attribute hashes.
+  class AttrImport
+    include Enumerable
+
+    attr_accessor :errors
+
+    def initialize(config, input_io)
+      @config = config
+      @input_io = input_io
+      @errors = ActiveModel::Errors.new(self)
+    end
+
+    # yields successive
+    def each
+      errors.clear
+      block_given? ? enumerator.each { |a| yield a } : enumerator
+    end
+
+    private
+
+    def enumerator
+      Enumerator.new do |yielder|
+        begin
+          csv = CSV.new @input_io, headers: true
+
+          csv.each do |row|
+            attrs = {}
+
+            row.headers.compact.each do |h|
+              next unless @config.fields.include?(h.to_sym)
+              next if @config.export_only_fields.include?(h.to_sym)
+              attrs[h] = row.field h
+            end
+
+            headers_length = row.headers.compact.length
+            pairs_start_on_evens = headers_length.even?
+            (headers_length..row.fields.length).each do |i|
+              i.send(pairs_start_on_evens ? :even? : :odd?) || next
+              row[i] || next
+
+              m = row[i].match(/^(\w+)_(\d+)_(\w+)$/)
+              m || next
+              has_many_name = m[1].pluralize
+              has_many_index = m[2].to_i
+              has_many_field = m[3]
+              has_many_value = row[i + 1]
+
+              has_many_config = @config.has_manys[has_many_name.to_sym]
+
+              next unless has_many_config
+              next unless has_many_config.fields.include?(has_many_field.to_sym)
+              next if has_many_config.export_only_fields.include?(has_many_field.to_sym)
+
+              attrs[has_many_name] ||= []
+              attrs[has_many_name][has_many_index] ||= {}
+              attrs[has_many_name][has_many_index][has_many_field] = has_many_value
+            end
+
+            yielder << attrs
+          end
+
+        rescue CSV::MalformedCSVError
+          errors.add :csv, "is malformed: #{$!.message}"
+        end
+      end
+    end
+  end
+end

data/lib/speaky_csv/base.rb

@@ -0,0 +1,95 @@
+module SpeakyCsv
+
+  # An instance of this class is yielded to the block passed to
+  # define_csv_fields. Used to configure speaky csv.
+  class Builder
+    attr_reader \
+      :export_only_fields,
+      :fields,
+      :has_manys,
+      :has_ones,
+      :primary_key
+
+    def initialize
+      @export_only_fields = []
+      @fields = []
+      @has_manys = {}
+      @has_ones = {}
+      @primary_key = :id
+    end
+
+    # Add one or many fields to the csv format.
+    #
+    # If options are passed, they apply to all given fields.
+    def field(*fields, export_only: false)
+      @fields += fields.map(&:to_sym)
+      @fields.uniq!
+
+      if export_only
+        @export_only_fields += fields.map(&:to_sym)
+        @export_only_fields.uniq!
+      end
+
+      nil
+    end
+
+    # Define a custom primary key. By default an `id` column as used.
+    #
+    # Accepts the same options as #field
+    def primary_key=(name, options={})
+      field name, options
+      @primary_key = name.to_sym
+    end
+
+    def has_one(name)
+      @has_ones[name.to_sym] ||= self.class.new
+      yield @has_ones[name.to_sym]
+
+      nil
+    end
+
+    def has_many(name)
+      @has_manys[name.to_sym] ||= self.class.new
+      yield @has_manys[name.to_sym]
+
+      nil
+    end
+
+    def dup
+      other = super
+      other.instance_variable_set '@has_manys', @has_manys.deep_dup
+      other.instance_variable_set '@has_ones', @has_ones.deep_dup
+
+      other
+    end
+  end
+
+  # Inherit from this class when using SpeakyCsv
+  class Base
+    class_attribute :csv_field_builder
+    self.csv_field_builder = Builder.new
+
+    def self.define_csv_fields
+      self.csv_field_builder = csv_field_builder.deep_dup
+      yield csv_field_builder
+    end
+
+    # Return a new exporter instance
+    def exporter(records_enumerator)
+      Export.new self.class.csv_field_builder,
+                 records_enumerator
+    end
+
+    def attr_importer(input_io)
+      AttrImport.new self.class.csv_field_builder,
+                     input_io
+    end
+
+    def active_record_importer(input_io, klass)
+      ActiveRecordImport.new \
+        self.class.csv_field_builder,
+        input_io,
+        klass
+    end
+  end
+end

data/lib/speaky_csv/export.rb

@@ -0,0 +1,64 @@
+require 'csv'
+require 'active_model'
+
+module SpeakyCsv
+  # Exports records as csv. Will write a csv to the given IO object
+  class Export
+    include Enumerable
+
+    def initialize(config, records_enumerator)
+      @config = config
+      @records_enumerator = records_enumerator
+    end
+
+    # Writes csv string to io
+    def each
+      errors.clear
+      block_given? ? enumerator.each { |a| yield a } : enumerator
+    end
+
+    def errors
+      @errors ||= ActiveModel::Errors.new(self)
+    end
+
+    private
+
+    def valid_field?(record, field, prefix: nil)
+      return true if record.respond_to? field
+
+      error_name = prefix ? "#{prefix}_#{field}" : field
+
+      if errors[error_name].blank?
+        errors.add error_name, "is not a method for class #{record.class}"
+      end
+
+      false
+    end
+
+    def enumerator
+      Enumerator.new do |yielder|
+        # header row
+        yielder << CSV::Row.new(@config.fields, @config.fields, true).to_csv
+
+        @records_enumerator.each do |record|
+          values = @config.fields
+                   .select { |f| valid_field? record, f }
+                   .map { |f| record.send f }
+
+          row = CSV::Row.new @config.fields, values
+
+          @config.has_manys.select { |a| valid_field? record, a }.each do |name, config|
+            record.send(name).each_with_index do |has_many_record, index|
+              config.fields.select { |f| valid_field? has_many_record, f, prefix: name }.each do |field|
+                row << "#{name.to_s.singularize}_#{index}_#{field}"
+                row << has_many_record.send(field)
+              end
+            end
+          end
+
+          yielder << row.to_csv
+        end
+      end
+    end
+  end
+end

data/lib/speaky_csv/version.rb

@@ -0,0 +1,3 @@
+module SpeakyCsv
+  VERSION = '0.0.1'
+end

data/lib/speaky_csv.rb

@@ -0,0 +1,11 @@
+require 'active_support/all'
+require 'csv'
+
+require 'speaky_csv/active_record_import'
+require 'speaky_csv/attr_import'
+require 'speaky_csv/base'
+require 'speaky_csv/export'
+require 'speaky_csv/version'
+
+module SpeakyCsv
+end

data/speaky_csv.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'speaky_csv/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'speaky_csv'
+  spec.version       = SpeakyCsv::VERSION
+  spec.authors       = ['Andy Hartford']
+  spec.email         = ['andy.hartford@cohealo.com']
+  spec.summary       = 'CSV importing and exporting for ActiveRecord and ActiveModel'
+  spec.description   = 'CSV importing and exporting for ActiveRecord and ActiveModel with a Enumerator flavor'
+  spec.homepage      = 'https://github.com/ajh/speaky_csv'
+  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_runtime_dependency 'activemodel',    '~> 4.2'
+  spec.add_runtime_dependency 'activerecord',   '~> 4.2'
+  spec.add_runtime_dependency 'activesupport',  '~> 4.2'
+
+  spec.add_development_dependency 'bundler',           '~> 1.10'
+  spec.add_development_dependency 'database_cleaner',  '~> 1.5'
+  spec.add_development_dependency 'rake',              '~> 10.0'
+  spec.add_development_dependency 'rspec',             '~> 3'
+  spec.add_development_dependency 'rspec-its',         '~> 1'
+  spec.add_development_dependency 'rubocop',           '~> 0.35'
+  spec.add_development_dependency 'sqlite3',           '~> 1.3'
+
+  # guard stuff
+  spec.add_development_dependency 'guard-rspec',  '~> 4.6'
+  spec.add_development_dependency 'rb-fsevent',   '~> 0.9'
+  spec.add_development_dependency 'rb-inotify',   '~> 0.9'
+  spec.add_development_dependency 'ruby_gntp',    '~> 0.3'
+end