easy_export 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b4fc3404829b1479ae77339a3378a0b55b830c8
+  data.tar.gz: d058995fca33aedb12d97550afed718cab82d422
+SHA512:
+  metadata.gz: 67fb25822011bdf24225804711ea875a5a2aef276b74a1e63f53e9e03bca41031a4dfc6ea7cfb1798584c530b2e6f94e7137fbb505377a14a7464847d12fc056
+  data.tar.gz: 2d658989bc1d9e29a380069761060c64284beef526f778f7ff122a5949ba6b2116310d0fa532be1d7a9b01f41e6c3ee1e8fbbc2e1c470471605af2d01d2fb5f8

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Diego Salazar
+
+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,70 @@
+# EasyExport
+
+Export ActiveModels to CSV by declaring headers and fields in your model with the `exportable` class method and block.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'easy_export'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install easy_export
+
+## Usage
+
+In a model, add the `exportable` declaration:
+
+```ruby
+class User < ActiveRecord::Base
+  exportable do
+    scope -> { User.all }
+    fields [
+      ['Header 1', -> { value to return }],
+      ['Header 2', :method_name],
+      ['Header 3', 'static value'], ...
+    ]
+  end
+end
+```
+
+Now, use the `Exporter` to get the CSV data:
+
+```ruby
+exporter = Exportable::Exporter.new params[:export]
+
+exporter.data # The CSV data
+exporter.file_type # 'text/csv'
+exporter.file_name # 'users-<timestamp>.csv'
+```
+
+With those you can initiate a download from a controller: 
+
+```ruby
+send_data exporter.data, {
+  filetype: exporter.file_type,
+  filename: exporter.file_name,
+  disposition: 'attachment'
+}
+```
+
+## Todo
+
+1. Support more export types: XML, JSON, YML
+2. Add method to write the data to a file
+3. Clean up the way `fields` are declared. 
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/easy_export/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/easy_export.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'easy_export/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "easy_export"
+  spec.version       = EasyExport::VERSION
+  spec.authors       = ["Diego Salazar"]
+  spec.email         = ["diego@greyrobot.com"]
+  spec.summary       = %q{Export ActiveModels to CSV by declaring headers and fields in your model with the `exportable` class method and block.}
+  spec.description   = %q{Export ActiveModels to CSV by declaring headers and fields in your model with the `exportable` class method and block.}
+  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_dependency "active_support"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/easy_export.rb

@@ -0,0 +1,142 @@
+require "easy_export/version"
+require 'active_support'
+
+module EasyExport
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    # Declare this method in your model class to define the export configuration.
+    #
+    # The block will be executed in the context of the ExportConfig, e.g:
+    #
+    #   exportable do
+    #     scope -> { ['some records', ...] }
+    #     fields [
+    #       ['Header 1', -> { value to return }],
+    #       ['Header 2', :method_name],
+    #       ['Header 3', 'static value'], ...
+    #     ]
+    #   end
+    #
+    # scope: an object that responds to #call and returns a collection of instances
+    # fields: an array of tuples where the 1st element is the Header name
+    #         and the 2nd is a proc, symbol, or static value to be instance
+    #         exec'ed, called as a method on the instance, or just returned, respectively.
+    #
+    def exportable(&block)
+      @export_config ||= ExportConfig.new
+      @export_config.partial = name.demodulize.underscore.pluralize
+      @export_config.instance_exec &block
+    end
+
+    def export_partial; @export_config.partial end
+    def export_scope;   @export_config.scope end
+    def export_fields;  @export_config.fields end
+  end
+
+  class ExportConfig
+    attr_accessor :partial
+
+    def scope(val = nil)
+      val.nil? ? @scope : @scope = val
+    end
+
+    def fields(val = nil)
+      val.nil? ? @fields : @fields = build_fields(val)
+    end
+
+    private
+
+    # Providing fields as an array let's us maintain the ordering
+    def build_fields(fields)
+      raise ArgumentError, "fields must be an array" unless fields.is_a? Array
+
+      ActiveSupport::OrderedHash.new.tap do |hash|
+        fields.each do |header, value_proc|
+          hash[header] = value_proc
+        end
+      end
+    end
+  end
+
+  class Exporter
+    require 'csv'
+
+    # Instantiate an Exporter that will convert a collection of models into
+    # a CSV string. The model needs to be setup with `exportable` class method.
+    #
+    # @options:
+    #   model: string name of the model class used to fetch instances to convert.
+    #   filter: a string that can be used by the @scope to further filter models
+    #   ...any other args needed in the options passed to the @scope.
+    #
+    # @model: the model class.
+    # @scope: a proc or object that responds to #call and takes the @options hash
+    #         and returns a scoped collection of instances of @model.
+    # @fields: an array of 2 element arrays that represent the header and method
+    #          to call on the model to retrieve the value for that column.
+    # @header: the first element of every array in @fields
+    #
+    def initialize(options = {})
+      @options = options
+      @model   = options[:model].constantize
+      @scope   = @model.export_scope
+      @fields  = @model.export_fields
+      @header  = @fields.keys
+    end
+
+    def data
+      CSV.generate do |csv|
+        csv << @header
+
+        scoped_models.each do |model|
+          csv << generate_row(model)
+        end
+      end
+    end
+
+    def file_name
+      timestamp = I18n.l(Time.zone.now, format: :short_date_only).parameterize
+      model_name = @model.name.demodulize.pluralize
+      "#{model_name}-#{timestamp}.csv"
+    end
+
+    def file_type
+      'text/csv'
+    end
+
+    protected
+
+    def scoped_models
+      @scope.call @options
+    end
+
+    # Generate an array representing a CSV row by iterating over @fields
+    # and using the 2nd item in each array as a value getter. It can be
+    # either a proc that is called in the context of the model, a symbol
+    # representing a method to call on the model, or a static value.
+    def generate_row(model)
+      @fields.map do |_, value_proc|
+        if value_proc.is_a? Proc
+          begin
+            model.instance_exec &value_proc
+          rescue NameError => e
+            # This happens when the model is a GroupSession hash that was returned by the @scope
+            # when the user selects GroupSession in the calendar filters
+            # TODO: Have the AppointmentFilter convert those
+            # hashes into AR like objects that respond to all
+            # the same methods Appointments do.
+            # For now, just put an error in this field.
+            "Error getting field value"
+          end
+        elsif model.respond_to? value_proc
+          model.send value_proc
+        else
+          value_proc
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, EasyExport

data/lib/easy_export/version.rb

@@ -0,0 +1,3 @@
+module EasyExport
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: easy_export
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Diego Salazar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Export ActiveModels to CSV by declaring headers and fields in your model
+  with the `exportable` class method and block.
+email:
+- diego@greyrobot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- easy_export.gemspec
+- lib/easy_export.rb
+- lib/easy_export/version.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.4.3
+signing_key: 
+specification_version: 4
+summary: Export ActiveModels to CSV by declaring headers and fields in your model
+  with the `exportable` class method and block.
+test_files: []