acts_as_csv 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 03ca915b35100447d0baaae3bf8ee07383667522
+  data.tar.gz: 1284522dc83ba81e16fec2396001ad696890717c
+SHA512:
+  metadata.gz: 64c7490c1168dd24cfdc914a22e118daeb8acd58b753880947fc3fe99d409e9654ad1dffbae8630526d2b0854354626d6f3eebd0d847b6bdae8e8bb1bdd6cff8
+  data.tar.gz: dcc1701cf4a2007e9a6287cc85c16500163a6b545de332492d3f586264fba76cb90fe9c4e5f1bb57da2b0a655048c98b259c63cc1d35b7418212cf486aa13ece

data/lib/acts_as_csv.rb

@@ -0,0 +1,90 @@
+
+require 'active_record'
+##
+# Extend the ability to create csv from ActiveRecord models
+
+module ActiveRecordCsvExtension
+
+  extend ActiveSupport::Concern
+
+  # Take an instance and turn it into an array using the csv columns specified at the class level
+  def to_csv
+     self.class.csv_columns.collect {|method| try(method) || try_association_methods(method)  }
+  end
+
+  ##
+  # Attempt to run a has_many count associated method by seeing if there is a chained method in the string with a '.'
+  # We use this to support the has_one, belongs_to and has_many column names that we are generating while giving
+  # the developer the flexibility to override those methods
+  def try_association_methods(method)
+    base_method = method
+    chained_method = method.scan(/\.\w{1,}/).try(:first)
+    return nil unless chained_method
+    base_method.gsub!(chained_method,'')
+    chained_method.gsub!('.','')
+    try(base_method).try(chained_method)
+  end
+
+
+  # add your static(class) methods here
+  module ClassMethods
+    
+    ##
+    # Array of methods that we will export out of a model object.  Also used as the header row for the CSV file
+    def csv_columns
+      columns = column_names + belongs_to_associations + has_one_associations + has_many_associations + optional_csv_attributes - filter_names
+      columns.compact!
+      columns.uniq!
+      columns.flatten!
+      columns
+    end
+
+    ##
+    # Lets you filter out sensitive information
+    def filter_names
+      ['ssn', 'dob', 'password', 'cc', 'credit_card', 'cvv', 'drivers_license_number', 'drivers_license_state']
+    end
+
+    ##
+    # Lets us add additional csv_columns at the model level. Override in app/moderls/order.rb, etc
+    def optional_csv_attributes
+      []
+    end
+
+    ##
+    # Iterate over all the belongs_to associations and see if it has a name.  We don't worry about _id
+    # because that by default is on the database table that ActiveRecord is interpreting
+    def belongs_to_associations
+      self.reflect_on_all_associations(:belongs_to).collect do |assoc|
+        klass = assoc.options[:class_name].try(:constantize) || assoc.name.to_s.classify.constantize
+        if klass.column_names.include?('name')
+          "#{assoc.name}.name"
+        end
+      end
+    end
+
+    ##
+    # Iterate over all the has_one associations and see if the object has a name attribute else print out
+    # the id
+    def has_one_associations
+      self.reflect_on_all_associations(:has_one).collect do |assoc|
+        klass = assoc.options[:class_name].try(:constantize) || assoc.name.to_s.classify.constantize
+        if klass.column_names.include?('name')
+          "#{assoc.name}.name"
+        else
+          "#{assoc.name}.id"
+        end
+      end
+    end
+
+    ##
+    # count all the has_many associations methods
+    def has_many_associations
+      self.reflect_on_all_associations(:has_many).collect {|assoc| "#{assoc.name}.count"}
+    end
+
+  end
+end
+
+# include the extension 
+ActiveRecord::Base.send(:include, ActiveRecordCsvExtension)

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_csv
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jordan Graft
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Extends default CSV behavior to ActiveRecord models
+email: jordan@cratebind.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/acts_as_csv.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Extends default CSV behavior to ActiveRecord models
+test_files: []
+has_rdoc: