exporter 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b8edc0551e8c2615785995f42f8b534ad188c63
-  data.tar.gz: aad26a14494806cdca3274e96e0dd93c9f2d26e2
+  metadata.gz: 884edf14fca8bc1375766805f2503837f25bed70
+  data.tar.gz: 5f16d07e1ea1aa2353f4d2ac087fd16645f3877d
 SHA512:
-  metadata.gz: d443e04b11b5c3d96fddb7457282a48f86dc0bb628f1b6a42d0af0a0d24bebb4b0a4c2ec15b552603f9c9e1192a59e5db72daa9d2faed6a7277db2caed9d354a
-  data.tar.gz: dde08124573c9c8dd5b281b5afd8cf17446c9c9c223ad7a8c50da8b7646284bdc5bb557626fa4d6c0e87087fac1042246b89809ab1ef2bff7958a69363ab21a4
+  metadata.gz: 0399f99d7aa32a2e83150961a3749923650fe6505ab3413c5e1de8d37625ae7f066dd36fc8c87d72f59752a39e270a22b543a8bd25b1bd0d494570673d10700c
+  data.tar.gz: 4368ff13565282a1122d4e3923a87b4e4e677ad108f1bdb0cb78a954ee24c00f191070138df9136eebd53143939b8eca762171314c216c8dd8e04207cead6b65

data/.rvmrc

@@ -6,10 +6,10 @@
 # First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
 # Only full ruby name is supported here, for short names use:
 #     echo "rvm use 2.0.0" > .rvmrc
-environment_id="ruby-2.0.0-p247@gembuilder"
+environment_id="ruby-2.0.0-p247@exporter"
 
 # Uncomment the following lines if you want to verify rvm version per project
-# rvmrc_rvm_version="1.22.3 (stable)" # 1.10.1 seems like a safe start
+# rvmrc_rvm_version="1.22.10 (stable)" # 1.10.1 seems like a safe start
 # eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | __rvm_awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
 #   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
 #   return 1
@@ -33,7 +33,7 @@ then
   if (( ${rvm_use_flag:=1} >= 2 )) # display only when forced
   then
     if [[ $- == *i* ]] # check for interactive shells
-    then printf "%b" "Using: \E[32m$GEM_HOME\E[0m
+    then printf "%b" "Using: $(tput setaf 2 2>/dev/null)$GEM_HOME$(tput sgr0 2>/dev/null)
 " # show the user the ruby and gemset they are using in green
     else printf "%b" "Using: $GEM_HOME
 " # don't use colors in non-interactive shells

data/Gemfile

@@ -2,8 +2,11 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in exporter.gemspec
 gemspec
-gem 'activerecord'
+
 group :test do
-  gem 'rspec'
   gem 'coveralls', require: false
 end
+
+group :development do
+  gem 'pry'
+end

data/README.md

@@ -4,9 +4,7 @@
 [![Code Climate](https://codeclimate.com/github/voanhduy1512/exporter.png)](https://codeclimate.com/github/voanhduy1512/exporter)
 [![Coverage Status](https://coveralls.io/repos/voanhduy1512/exporter/badge.png)](https://coveralls.io/r/voanhduy1512/exporter)
 [![Dependency Status](https://gemnasium.com/voanhduy1512/exporter.png)](https://gemnasium.com/voanhduy1512/exporter)
-
-
-
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/voanhduy1512/exporter/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
 
 ## Installation
 
@@ -18,10 +16,17 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Usage
+``` ruby
+# Here is the data which you want to export
+users = User.all
+
+# export it
+Exporter.export(users, :csv).to_file(path_to_file)
+```
+
+Only support export to csv now (more types are coming)
+
 
-    $ gem install exporter
 
-## Usage
 
-TODO: Write usage instructions here

data/exporter.gemspec

@@ -18,7 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'factory_girl'
+
+  spec.add_dependency 'activerecord'
+  spec.add_dependency 'spreadsheet'
 end

data/lib/exporter.rb

@@ -1,9 +1,13 @@
+require 'active_record'
+require "csv"
 require "exporter/version"
 require "exporter/configuration"
 require "exporter/document"
 require "exporter/exporter"
 require "exporter/documents/csv_document"
+require 'exporter/documents/excel_document'
 require "exporter/exporters/csv_exporter"
+require "exporter/exporters/excel_exporter"
 
 module Exporter
   def self.configuration
@@ -11,7 +15,7 @@ module Exporter
   end
 
   def self.export(data, export_type, options={})
-    exporter = @configuration.exporter(data.class, export_type)
+    exporter = @configuration.exporter(data, export_type)
     if exporter
       exporter.export(data, options)
     else
@@ -20,4 +24,8 @@ module Exporter
   end
 end
 
-Exporter.configuration.register(Array, :csv, Exporter::CsvExporter)
+Exporter.configuration.register(Array, :csv, Exporter::CsvExporter)
+Exporter.configuration.register(ActiveRecord::Relation, :csv, Exporter::CsvExporter)
+
+Exporter.configuration.register(Array, :excel, Exporter::ExcelExporter)
+Exporter.configuration.register(ActiveRecord::Relation, :excel, Exporter::ExcelExporter)

data/lib/exporter/configuration.rb

@@ -1,19 +1,34 @@
 module Exporter
   class Configuration
+
     def initialize
       @exporters = Hash.new
     end
 
     def register(data_type, export_type, exporter)
-      @exporters[data_type] = {export_type => exporter}
+      if @exporters[data_type].nil?
+        @exporters[data_type] = {export_type => exporter}
+      else
+        @exporters[data_type][export_type] = exporter
+      end
+    end
+
+    def index(data, default_value, method)
+      @exporters.keys.each do |key|
+        return method.call(key) if data.kind_of?(key)
+      end
+      default_value
     end
 
-    def can_export?(data_type, export_type)
-      @exporters[data_type] && @exporters[data_type][export_type]
+    def can_export?(data, export_type)
+      can_export_proc = Proc.new{|key| @exporters[key][export_type].present?}
+      index(data, false, can_export_proc)
     end
 
-    def exporter(data_type, export_type)
-      can_export?(data_type, export_type) ? @exporters[data_type][export_type] : nil
+    def exporter(data, export_type)
+      exporter_proc = Proc.new {|key| @exporters[key][export_type]}
+      index(data, nil, exporter_proc)
     end
+
   end
-end
+end

data/lib/exporter/document.rb

@@ -7,7 +7,7 @@ module Exporter
     end
 
     def to_file(path)
-      File.open(path, 'w') {|f| f.write(@data) }
+      raise 'must override this method in subclass'
     end
   end
 end

data/lib/exporter/documents/excel_document.rb

@@ -0,0 +1,7 @@
+module Exporter
+  class ExcelDocument < Document
+    def to_file(path)
+      @data.write path
+    end
+  end
+end

data/lib/exporter/exporter.rb

@@ -1,14 +1,22 @@
 module Exporter
   class Exporter
     def self.export(data, options)
-      document = process(data, options)
+      document = exporter.process(data, options)
       raise TypeError.new('process method must return an Document object') unless document.kind_of? Document
       document
     end
 
+    def self.exporter
+      @exporter ||= self.new
+    end
+
     protected
-    def self.process(data, options)
+    def process(data, options)
       raise NotImplementedError.new("You must implement this process method.")
     end
+
+    def is_active_record?(data, options)
+      (data.kind_of? ActiveRecord::Relation) || (data.kind_of?(Array) && data[0].kind_of?(ActiveRecord::Base))
+    end
   end
 end

data/lib/exporter/exporters/csv_exporter.rb

@@ -1,16 +1,11 @@
-require 'CSV'
 module Exporter
   class CsvExporter < Exporter
-    def self.process(data, options)
 
-      raise TypeError.new('data must be an array') unless data.class.eql? Array
-      raise TypeError.new('Data must be an ActiveRecord') unless data[0].kind_of? ActiveRecord::Base
+    def process(data, options)
 
-      if options[:columns]
-        columns = options[:columns]
-      else
-        columns = data[0].class.attribute_names
-      end
+      raise TypeError.new unless is_active_record?(data, options)
+
+      columns = options[:columns] || data[0].class.attribute_names
 
       data = CSV.generate do |csv|
         csv << columns
@@ -21,5 +16,6 @@ module Exporter
 
       CsvDocument.new(data)
     end
+
   end
-end
+end

data/lib/exporter/exporters/excel_exporter.rb

@@ -0,0 +1,24 @@
+require 'spreadsheet'
+
+module Exporter
+  class ExcelExporter < Exporter
+
+    def process(data, options)
+
+      raise TypeError.new unless is_active_record?(data, options)
+
+      columns = options[:columns] || data[0].class.attribute_names
+
+      book = Spreadsheet::Workbook.new
+      sheet = book.create_worksheet
+      sheet.name = options[:sheet_name] || 'sheet1'
+      sheet.row(0).concat columns
+      data.each_with_index do |row, index|
+        sheet.row(index+1).concat row.attributes.values_at(*columns)
+      end
+
+      ExcelDocument.new(book)
+    end
+
+  end
+end

data/lib/exporter/version.rb

@@ -1,3 +1,3 @@
 module Exporter
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/spec/factories/user.rb

@@ -0,0 +1,6 @@
+FactoryGirl.define do
+  factory :user do
+    sequence(:name) { |n| "name#{n}" }
+    sequence(:email) {|e| "email#{e}"}
+  end
+end

data/spec/features/exporter_spec.rb

@@ -0,0 +1,69 @@
+require "spec_helper"
+
+describe Exporter do
+
+  before(:all) {FactoryGirl.create(:user)}
+
+  let(:data){ User.all }
+
+  describe '.export' do
+    context 'ActiveRecord::Relation' do
+      it 'can export to csv' do
+        expect(Exporter.configuration.can_export?(data, :csv)).to eql(true)
+      end
+
+      it 'can export to excel' do
+        expect(Exporter.configuration.can_export?(data, :excel)).to eql(true)
+      end
+
+      it "can't export not register type" do
+        expect(Exporter.configuration.can_export?(data, :some_weird_type)).to eql(false)
+      end
+
+      context ':csv' do
+        it 'return an Exporter::Document subclass' do
+          document = Exporter.export(data, :csv)
+          expect(document).to be_kind_of(Exporter::Document)
+        end
+
+        it 'write to file correct' do
+          document = Exporter.export(data, :csv)
+          document.to_file('dummy.csv')
+          content = File.read('dummy.csv')
+          expect(content.length).to eql(document.data.length)
+          File.delete('dummy.csv')
+        end
+      end
+
+      context ':excel' do
+        it 'return an Exporter::Document subclass' do
+          document = Exporter.export(data, :excel)
+          expect(document).to be_kind_of(Exporter::Document)
+        end
+
+        it 'write to file correct' do
+          document = Exporter.export(data, :excel)
+          document.to_file('dummy.xls')
+          content = Spreadsheet.open('dummy.xls')
+          expect(content.worksheet(0).last_row_index).to eql(document.data.worksheet(0).last_row_index)
+          expect(content.worksheet(0).row(1)).to eql(document.data.worksheet(0).row(1))
+          File.delete('dummy.xls')
+        end
+      end
+    end
+
+    context 'Array of ActiveRecord::Base' do
+      it 'can export to csv' do
+        expect(Exporter.configuration.can_export?(data, :csv)).to eql(true)
+      end
+
+      it 'can export to excel' do
+        expect(Exporter.configuration.can_export?(data, :excel)).to eql(true)
+      end
+
+      it "can't export not register type" do
+        expect(Exporter.configuration.can_export?(data, :some_weird_type)).to eql(false)
+      end
+    end
+  end
+end

data/spec/models/user.rb

@@ -1,4 +1,2 @@
-module Exporter
-  class User < ActiveRecord::Base
-  end
-end
+class User < ActiveRecord::Base
+end

data/spec/spec_helper.rb

@@ -11,9 +11,9 @@ if ENV['TRAVIS']
 end
 
 require "exporter"
-require 'active_record'
+require 'factory_girl'
 require 'models/user'
-
+FactoryGirl.find_definitions
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
@@ -32,6 +32,7 @@ ActiveRecord::Base.establish_connection(
     :adapter => 'sqlite3',
     :database => ':memory:'
 )
+
 ActiveRecord::Schema.define do
   self.verbose = false
 
@@ -39,4 +40,4 @@ ActiveRecord::Schema.define do
     t.string :name
     t.string :email
   end
-end
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: exporter
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Võ Anh Duy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-29 00:00:00.000000000 Z
+date: 2013-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,62 @@ dependencies:
     - - '>='
       - !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: factory_girl
+  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: activerecord
+  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: spreadsheet
+  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'
 description: A simple gem for export data to other format
 email:
 - voanhduy1512@live.com
@@ -72,10 +128,13 @@ files:
 - lib/exporter/configuration.rb
 - lib/exporter/document.rb
 - lib/exporter/documents/csv_document.rb
+- lib/exporter/documents/excel_document.rb
 - lib/exporter/exporter.rb
 - lib/exporter/exporters/csv_exporter.rb
+- lib/exporter/exporters/excel_exporter.rb
 - lib/exporter/version.rb
-- spec/lib/exporter_spec.rb
+- spec/factories/user.rb
+- spec/features/exporter_spec.rb
 - spec/models/user.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -98,11 +157,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.1.8
 signing_key: 
 specification_version: 4
 summary: A simple data exporter
 test_files:
-- spec/lib/exporter_spec.rb
+- spec/factories/user.rb
+- spec/features/exporter_spec.rb
 - spec/models/user.rb
 - spec/spec_helper.rb

data/spec/lib/exporter_spec.rb

@@ -1,18 +0,0 @@
-require "spec_helper"
-
-describe Exporter do
-  let(:data){
-    [
-      Exporter::User.create(:name => 'aaa', :email => 'aaa@aaa.aaa'),
-      Exporter::User.create(:name => 'bbb', :email => 'bbb@bbb.bbb')
-    ]
-  }
-  describe '.export' do
-    it 'return an Exporter::Document' do
-      document = Exporter.export(data, :csv)
-      puts document.kind_of? Exporter::Document
-      puts document.class
-      expect(document).to be_kind_of(Exporter::Document)
-    end
-  end
-end