spreadsheetable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a2d829d9bb04ab9e70a6478bc2ef70a3f27bfd68
+  data.tar.gz: ce21a8b7bb03d81c4e28bcfda7cb453f2f647ddf
+SHA512:
+  metadata.gz: ac97d21be0271c02fcb06d8580369c3883e81a8b1f3f122f4c0708c73a2fac9959226b30c9fbaa9eb27e1143aa22dc9e2e8e883c1563412ffb42d2a75789f8ac
+  data.tar.gz: a9996e42f3935e6adacc3df2fc14b36f60ee89cba596dd3ca6d89bb1c1d59b7b5c11e016736b03bd856e1970e92138b709439e2cdb341fa766ff9b5ece596c9b

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+*#*
+.DS_Store
+.rvmrc
+.ruby-version

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+script: COVERAGE=true bundle exec rspec spec
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Yasuhiko Maeda
+
+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,29 @@
+# Spreadsheetable[![Build Status](https://travis-ci.org/dongoon/spreadsheetable.svg?branch=master)](https://travis-ci.org/dongoon/spreadsheetable)
+
+A scope(ActiveRecord::Relation) and a array of active_record are able to be spreadsheet with this module.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'spreadsheetable'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+```ruby
+scope = SomeTable.all #scope or array
+scope.sheet_columns = %w(id name other)
+xls_file = scope.xls # or scope.to_spreadsheet
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/dongoon/spreadsheetable/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/spreadsheetable.rb

@@ -0,0 +1,59 @@
+require "spreadsheetable/version"
+require 'spreadsheet'
+
+module Spreadsheetable
+  attr_reader :sheet_columns
+
+  def self.extend_object(base)
+    raise TypeError.new unless base.is_a?(ActiveRecord::Relation) || (base.is_a?(Array) && base.first.is_a?(ActiveRecord::Base))
+    base.instance_variable_set(:@sheet_columns, [])
+    super
+  end
+
+  def sheet_columns= cols
+    raise TypeError unless cols.is_a?(Array)
+    @sheet_columns = cols
+  end
+
+  def to_spreadsheet
+    book = ::Spreadsheet::Workbook.new
+    sheet = book.create_worksheet()
+
+    rows = [_sheet_header]
+    rows += self.collect{|_row| _to_row(_row)}
+    rows.each_with_index do |_row, i|
+      sheet.row(i).concat _row
+    end
+
+    tmpfile = Tempfile.new ["excel_tmp", ".xls"]
+    book.write tmpfile
+
+    tmpfile
+  end
+
+  def xls
+    to_spreadsheet
+  end
+
+  def _sheet_header
+    default = self.is_a?(ActiveRecord::Relation) ? self.klass : self.first.class
+
+    self.sheet_columns.collect{|col|
+      names = col.to_s.split(".")
+      if names.count == 1
+        model = default
+      else
+        model = names[names.count - 2].classify.constantize
+      end
+      model.human_attribute_name names.last
+    }
+  end
+
+  def _to_row record
+    self.sheet_columns.collect{|c|
+      eval("record." + c) rescue nil
+    }
+  end
+
+  private :_sheet_header, :_to_row
+end

data/lib/spreadsheetable/version.rb

@@ -0,0 +1,3 @@
+module Spreadsheetable
+  VERSION = "1.0.0"
+end

data/spec/ja.yml

@@ -0,0 +1,11 @@
+ja:
+  activerecord:
+    models:
+      organization: 組織
+      user: ユーザ
+    attributes:
+      organization:
+        name: 組織名
+      user:
+        name: 氏名
+        email: メールアドレス

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+require 'factory_girl'
+require 'spreadsheetable'
+
+# load spec/support/**/*.rb
+Dir["#{File.dirname(__FILE__)}/support/*.rb"].each {|f| require f}
+

data/spec/spreadsheetable_spec.rb

@@ -0,0 +1,169 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+describe Spreadsheetable do
+  I18n.load_path += Dir[ File.join(File.dirname(__FILE__), '*.yml') ]
+  I18n.default_locale = :ja
+  I18n.enforce_available_locales = false
+
+  before{
+    3.times{ FactoryGirl.create :user }
+  }
+  let(:users){ User.all }
+  let(:sheet_users){ users.extend Spreadsheetable }
+
+  it 'should have a version number' do
+    Spreadsheetable::VERSION.should_not be_nil
+  end
+
+  describe "initialize" do
+
+    describe "#sheet_columns" do
+      example{ expect(sheet_users.sheet_columns).to be_an_instance_of(Array) }
+    end
+
+    describe "extendable object type" do
+      subject{ users.extend Spreadsheetable }
+
+      context "ActiveRecord::Relation" do
+        let(:users){ User.unscoped }
+
+        example{ expect{subject}.to_not raise_error }
+      end
+
+      context "Array of active_record" do
+        let(:users){ o = User.all.to_a }
+        before{ expect(sheet_users).to be_an_instance_of(Array) }
+
+        example{ expect{ subject }.to_not raise_error }
+      end
+
+      context "other" do
+        let(:users){ [ Object.new ] }
+
+        example{ expect{ subject }.to raise_error }
+      end
+    end
+  end
+
+  describe "#sheet_columns=" do
+    subject{ sheet_users.sheet_columns = set_columns }
+
+    context "set array instance" do
+      let(:set_columns){ %w(a b c) }
+
+      example{ expect{ subject }.to_not raise_error }
+      example "should over write sheet_columns" do
+        expect(sheet_users.sheet_columns).to eq([])
+        subject
+        expect(sheet_users.sheet_columns).to eq(set_columns)
+      end
+    end
+
+    context "set NOT array instance" do
+      let(:set_columns){ "a b c" }
+
+      example{ expect{ subject }.to raise_error }
+    end
+  end
+
+  describe "#to_spreadsheet" do
+    before{ sheet_users.sheet_columns += %w(id organization.name name email) }
+
+    shared_examples_for "to_spreadsheet" do
+      subject{ sheet_users.to_spreadsheet }
+
+      example{ expect(subject).to be_a(Tempfile) }
+
+      example "header row is created by #_sheet_header" do
+        expect(sheet_users).to receive(:_sheet_header).and_call_original.once
+        book = Spreadsheet.open(subject.path)
+        expect(book.worksheets.count).to eq(1)
+        sheet = book.worksheets.first
+        expect(sheet.rows.first.to_a).to eq(%w(Id 組織名 氏名 メールアドレス))
+      end
+
+      example "data row is created by #_to_row" do
+        expect(sheet_users).to receive(:_to_row).and_call_original.exactly(sheet_users.count).times
+        book = Spreadsheet.open(subject.path)
+        sheet = book.worksheets.first
+        expect(sheet.rows.count).to eq(sheet_users.count + 1)
+      end
+    end
+
+    context "ActiveRecord::Relation" do
+      before{ expect(sheet_users.is_a?(ActiveRecord::Relation)).to eq(true) }
+
+      it_should_behave_like "to_spreadsheet"
+    end
+
+    context "Array of active_record" do
+      let(:users){ o = User.all.to_a }
+      before{ expect(sheet_users).to be_an_instance_of(Array) }
+
+      it_should_behave_like "to_spreadsheet"
+    end
+
+    describe "#xls" do
+      subject{ sheet_users.xls }
+      example "#xls is alias of #to_spreadsheet" do
+        expect(sheet_users).to receive(:to_spreadsheet).once
+        subject
+      end
+    end
+
+    describe "#_sheet_header" do
+      subject{ sheet_users.send :_sheet_header }
+
+      shared_examples_for "_sheet_header" do
+        example "should be generated with sheet_columns config" do
+          expect(subject.length).to eq(sheet_users.sheet_columns.length)
+        end
+
+        example "column header is resolved by I18n" do
+          expect(subject).to eq(%w(Id 組織名 氏名 メールアドレス))
+        end
+      end
+
+      context "ActiveRecord::Relation" do
+        before{ expect(sheet_users.is_a?(ActiveRecord::Relation)).to eq(true) }
+
+        it_should_behave_like "_sheet_header"
+      end
+
+      context "Array of active_record" do
+        let(:users){ o = User.all.to_a }
+        before{ expect(sheet_users).to be_an_instance_of(Array) }
+
+        it_should_behave_like "_sheet_header"
+      end
+    end
+
+    describe "#_to_row" do
+      subject{ sheet_users.send(:_to_row, row) }
+      let(:row){ sheet_users.first }
+
+      context "sheet_columns is NOT set any column" do
+        before{ sheet_users.sheet_columns = [] }
+
+        example{expect(subject).to eq []}
+      end
+
+      context "sheet_columns is set some column" do
+        example "return a array of set column values" do
+          expect(subject).to match_array([row.id, row.organization.name, row.name, row.email])
+        end
+
+        context "sheet_culumns include invalid column" do
+          before{ sheet_users.sheet_columns << "hoge" }
+          example{ expect{subject}.to_not raise_error }
+
+          example "invalid column value is nil" do
+            expect(subject).to match_array([row.id, row.organization.name, row.name, row.email, nil])
+          end
+        end
+      end
+    end
+  end
+end

data/spec/support/database_cleaner.rb

@@ -0,0 +1,15 @@
+require 'database_cleaner'
+
+DatabaseCleaner[:active_record].strategy = :transaction if defined? ActiveRecord
+
+RSpec.configure do |config|
+  config.before :suite do
+    DatabaseCleaner.clean_with :truncation
+  end
+  config.before :each do
+    DatabaseCleaner.start
+  end
+  config.after :each do
+    DatabaseCleaner.clean
+  end
+end

data/spec/support/test_models.rb

@@ -0,0 +1,43 @@
+require 'active_record'
+ActiveRecord::Base.establish_connection( :adapter => 'sqlite3', :database => ':memory:')
+
+class CreateTestTables < ActiveRecord::Migration
+  def self.up
+    create_table :users do |t|
+      t.string :email
+      t.string :name
+      t.integer :rank
+      t.integer :organization_id
+      t.datetime :registered_at
+    end
+
+    create_table :organizations do |t|
+      t.string :name
+    end
+  end
+end
+
+ActiveRecord::Migration.verbose = false
+CreateTestTables.up
+
+
+class User < ActiveRecord::Base
+  belongs_to :organization
+end
+
+class Organization < ActiveRecord::Base
+  has_many :users
+end
+
+FactoryGirl.define do
+  factory :organization do
+    sequence(:name){ |n| "The group No.#{n}" }
+  end
+
+  factory :user do
+    sequence(:name){ |n| "No.#{n} user" }
+    sequence(:email){ |n| "user#{n}@example.com" }
+    registered_at Time.now
+    organization
+  end
+end

data/spreadsheetable.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spreadsheetable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spreadsheetable"
+  spec.version       = Spreadsheetable::VERSION
+  spec.authors       = ["Yasuhiko Maeda"]
+  spec.email         = ["y.maeda@dongoon.jp"]
+  spec.summary       = %q{ActiveRecord::Relation or array of active_records to SpreadSheet}
+  spec.description   = %q{This module implement [to_spreadsheet | xls] to ActiveRecord::Relation}
+  spec.homepage      = "https://github.com/dongoon/spreadsheetable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3-ruby"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "factory_girl_rails"
+
+  spec.add_runtime_dependency "activerecord", ">= 3.0.0"
+  spec.add_runtime_dependency "arel", ">= 3.0.0"
+  spec.add_runtime_dependency "spreadsheet", "~> 0.9.7"
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: spreadsheetable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yasuhiko Maeda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-22 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: 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: sqlite3-ruby
+  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: database_cleaner
+  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_rails
+  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: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: arel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: spreadsheet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.7
+description: This module implement [to_spreadsheet | xls] to ActiveRecord::Relation
+email:
+- y.maeda@dongoon.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/spreadsheetable.rb
+- lib/spreadsheetable/version.rb
+- spec/ja.yml
+- spec/spec_helper.rb
+- spec/spreadsheetable_spec.rb
+- spec/support/database_cleaner.rb
+- spec/support/test_models.rb
+- spreadsheetable.gemspec
+homepage: https://github.com/dongoon/spreadsheetable
+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: ActiveRecord::Relation or array of active_records to SpreadSheet
+test_files:
+- spec/ja.yml
+- spec/spec_helper.rb
+- spec/spreadsheetable_spec.rb
+- spec/support/database_cleaner.rb
+- spec/support/test_models.rb