excelizer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3276787f642062455fbd78534c694e066d48ec90
-  data.tar.gz: 68315509d7e1b21f3b2fa3cf6525bf10f8d119ad
+  metadata.gz: 5b390feb3d9c71d037f02d5281e16e4c2d8a1170
+  data.tar.gz: 514d9cb4db895a79dc5251bf6636cac2b2f5a505
 SHA512:
-  metadata.gz: 5ab5a5925939314c1937b9ec050968de16b7711d51b4062d03d0c5b7d9017b2367fcd5acb8f19f11cb4f8b510a9b5313759fda0d52e41386d9894295d69b1d87
-  data.tar.gz: 0a2f2ade998315cc92c498a3f309d71170e86e2aa1c1baef9c90ecede018da4a875bb5bae9a9f9791ef4439f8a7f79ca1bb0229fdce74cdec7e4b0d5506c55a1
+  metadata.gz: 21ade4130753293027f9f7d71f1a5e9891b4f7ba257f253b6f71628a3a097cb65c83e8758e20897bca4d65d72127a1eaa1c9c68bf84eadabf63d126703e9aadb
+  data.tar.gz: b08af9f7a6f8f37425ac0022cf7adb005d9edb51ec1845295029656adae17f577f0491f55ccc60dd9c78c327f3d8a5297acb9e6cb898e3948e90731f510a9932

data/README.md

@@ -6,79 +6,99 @@ Excelizer handles Excel files generation for your Rails models with the [Spreads
 
 Add this line to your application's Gemfile:
 
-    gem 'excelizer'
+```ruby
+gem 'excelizer'
+```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install excelizer
+```bash
+$ gem install excelizer
+```
 
 You will need to add this line to the `config/initializers/mime_types.rb` file:
 
-    Mime::Type.register "application/vnd.ms-excel", :xls
+```ruby
+Mime::Type.register "application/vnd.ms-excel", :xls
+```
 
 ## Usage
 
 You should create a `downloaders` folder inside the `app` folder. You can define a downloader like this
 
-    class UserDownloader < Excelizer::Base
-      attr_downloadable :name, :last_name, :email, :birth_date
-    end
+```ruby
+class UserDownloader < Excelizer::Base
+  attr_downloadable :name, :last_name, :email, :birth_date
+end
+```
 
-It's possible to redefine attributes using the `@model` reference 
+It's possible to redefine attributes using the `@model` reference
 
-    class UserDownloader < Excelizer::Base
-      attr_downloadable :name, :last_name, :email, :birth_date
+```ruby
+class UserDownloader < Excelizer::Base
+  attr_downloadable :name, :last_name, :email, :birth_date
 
-      def name
-        @model.name.titleize
-      end
+  def name
+    @model.name.titleize
+  end
 
-    end
+end
+```
 
-Or even create new attributes. Keep in mind new attributes will be added at the end of the row, but you can explicitly define the position where they should be. In this example, `phone_number` will go before `birth_date` while `favorite_color` will go after it.
+Or even create new attributes by defining them as methods.  Keep in mind the declaration order of the attributes matters: `name` will be column `A` whereas `last_name` will be column `B`. In this example, `phone_number` will go before `birth_date` while `favorite_color` will go after it.
 
-    class UserDownloader < Excelizer::Base
-      attr_downloadable :name, :last_name, :email, :phone_number, :birth_date
+```ruby
+class UserDownloader < Excelizer::Base
+  attr_downloadable :name, :last_name, :email, :phone_number, :birth_date
 
-      def phone_number
-        '51' + @model.mobile_phone
-      end
+  def phone_number
+    '51' + @model.mobile_phone
+  end
 
-      def favorite_color
-        @model.favorite_color || 'orange'
-      end
+  def favorite_color
+    @model.favorite_color || 'orange'
+  end
 
-    end
+end
+```
 
-Now that we have a downloader, how do we actually use it? If you want to learn how to use it along ActiveAdmin, skip to the next section, if you just want to use the raw data, you can do this:
+Now that we have a downloader, how do we actually use it? If you want to learn how to use it along ActiveAdmin, skip to the next section, if you just want to use the raw output, you can do this:
 
-    raw_data = UserDownloader.new.build_xls
+```ruby
+output = UserDownloader.new.build_xls
+```
 
 You can optionally pass a collection as a parameter for scoped results:
-  
-    raw_data = UserDownloader.new.build_xls(User.where(name: 'James'))
+
+```ruby
+output = UserDownloader.new.build_xls(User.where(name: 'James'))
+```
 
 ## ActiveAdmin
 
 The recommended way to use this gem along ActiveAdmin is using an `action_item` and a `collection_action`. Future releases won't need this ;)
 
-    ActiveAdmin.register User do
+```ruby
+ActiveAdmin.register User do
 
-      collection_action :download_xls do
-        send_data UserDownloader.new.build_xls,
-                  type: 'application/vnd.ms-excel',
-                  filename: "user_report.xls"
-      end
+  collection_action :download_xls do
+    send_data UserDownloader.new.build_xls,
+              type: 'application/vnd.ms-excel',
+              filename: "user_report.xls"
+  end
 
-      action_item only: [:index] do
-        link_to "Download Excel", download_xls_admin_users_path
-      end
+  action_item only: [:index] do
+    link_to "Download Excel", download_xls_admin_users_path
+  end
 
-    end
+end
+```
 
 
 ## Contributing
@@ -89,18 +109,12 @@ The recommended way to use this gem along ActiveAdmin is using an `action_item`
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-## Acknowledgments
-
-Brought to you by Arturo Puente and the team at [Phantasia](http://www.phantasia.pe/).
-
-[![Phantasia](http://www.phantasia.pe/wp-content/themes/phantasia/images/logo-phantasia-header.png)](http://www.phantasia.pe/)
-
 ## Changelog
 
 0.1.0 Custom header support.  
 0.0.9 Adds support for Rails 4.  
 0.0.8 Safer attribute initialization.  
-0.0.7 First release. Codename: Bond
+0.0.7 First release.
 
 ## License
 

data/excelizer.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake", "~> 10.0"
 
-  spec.add_dependency "spreadsheet"
+  spec.add_dependency "spreadsheet", "~> 1.0"
 end

data/lib/excelizer/version.rb

@@ -1,3 +1,3 @@
 module Excelizer
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/excelizer.rb

@@ -12,12 +12,12 @@ module Excelizer
     end
 
     def self.attr_headers(*attrs)
-      @headers = attrs.to_a
+      @@headers = attrs.to_a
     end
 
     def build_xls(collection=model_class.all)
-      if @headers
-        headers = @headers
+      if defined?(@@headers)
+        headers = @@headers
       else
         headers = *methods.select { |m| self.method(m).owner == self.class }.map { |m| m.to_s.titleize }
       end
@@ -49,12 +49,12 @@ module Excelizer
     end
 
     def model_class
-      Object.const_get self.class.name.gsub "Downloader", ""
+      Object.const_get self.class.name.demodulize.gsub "Downloader", ""
     end
-    
+
     def model_clean_attributes(model_class_ref)
       explicit_attribute_keys = model_class_ref.new.attributes.keys
-    
+
       if model_class_ref.respond_to?(:protected_attributes)
         explicit_attribute_keys - model_class_ref.protected_attributes.to_a
       else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: excelizer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Arturo Puente
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-31 00:00:00.000000000 Z
+date: 2015-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,30 +28,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: spreadsheet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 description: An Excel helper for Rails project. It integrates with ActiveRecord models
   and other space magic.
 email:
@@ -89,9 +89,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
 summary: An Excel helper for Rails project
 test_files:
 - test/spec.rb
+has_rdoc: