excelizer 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b390feb3d9c71d037f02d5281e16e4c2d8a1170
-  data.tar.gz: 514d9cb4db895a79dc5251bf6636cac2b2f5a505
+  metadata.gz: 20e271109d89c81cc1a53ee587aab79878088715
+  data.tar.gz: 2761d53f88cfb62e8f92bbfdca86496c772cf3db
 SHA512:
-  metadata.gz: 21ade4130753293027f9f7d71f1a5e9891b4f7ba257f253b6f71628a3a097cb65c83e8758e20897bca4d65d72127a1eaa1c9c68bf84eadabf63d126703e9aadb
-  data.tar.gz: b08af9f7a6f8f37425ac0022cf7adb005d9edb51ec1845295029656adae17f577f0491f55ccc60dd9c78c327f3d8a5297acb9e6cb898e3948e90731f510a9932
+  metadata.gz: 367d3ec30e8b1ca0a3f78fff0e9b33dfcdaa3c55f4af3daf681f7355f0ae8b4a021adfc04be9717ece013fc0036257451ea57b805c34c6389a65d405c89de30b
+  data.tar.gz: 7dea94a5908af21ab691d39b3ebb43cf6c1ede4bb38f29cff4a7a19b7191346317da47a853f82a69821a065aa0c31bb7a6138e07f80e995d3af699b31196ede8

data/.rspec

@@ -0,0 +1,5 @@
+--color
+--require spec_helper
+--require rspec/legacy_formatters
+--format=doc
+--format=Nc

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.("routing/#{m[1]}_routing"),
+      rspec.spec.("controllers/#{m[1]}_controller"),
+      rspec.spec.("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/README.md

@@ -34,50 +34,68 @@ You should create a `downloaders` folder inside the `app` folder. You can define
 
 ```ruby
 class UserDownloader < Excelizer::Base
-  attr_downloadable :name, :last_name, :email, :birth_date
+  attribute :name
+  attribute :last_name
+  attribute :email
+  attribute :token
 end
 ```
 
-It's possible to redefine attributes using the `@model` reference
+It's possible to redefine the attributes using the `object` reference
 
 ```ruby
 class UserDownloader < Excelizer::Base
-  attr_downloadable :name, :last_name, :email, :birth_date
+  attribute :token
 
-  def name
-    @model.name.titleize
+  def token
+    object.token + rand(100)
   end
-
 end
 ```
 
-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.
+Or even create new attributes by defining them as methods:
 
 ```ruby
 class UserDownloader < Excelizer::Base
-  attr_downloadable :name, :last_name, :email, :phone_number, :birth_date
+  attribute :full_name
 
-  def phone_number
-    '51' + @model.mobile_phone
+  def full_name
+    "#{object.name} #{object.last_name}"
   end
+end
+```
+
+And you can redefine the object variable by calling the `instance` method:
 
-  def favorite_color
-    @model.favorite_color || 'orange'
+```ruby
+class UserDownloader < Excelizer::Base
+  instance :user
+  attribute :full_name
+
+  def full_name
+    "#{user.name} #{user.last_name}"
   end
+end
+```
+
+You can redefine the column name by passing the `header` option:
 
+```ruby
+class UserDownloader < Excelizer::Base
+  attribute :full_name, header: "Nombre Completo"
 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 output, you can do this:
 
 ```ruby
-output = UserDownloader.new.build_xls
+output = UserDownloader.new(User.all).download
 ```
 
 You can optionally pass a collection as a parameter for scoped results:
 
 ```ruby
-output = UserDownloader.new.build_xls(User.where(name: 'James'))
+output = UserDownloader.new(User.where(name: "Jaime")).download
 ```
 
 ## ActiveAdmin
@@ -86,9 +104,8 @@ The recommended way to use this gem along ActiveAdmin is using an `action_item`
 
 ```ruby
 ActiveAdmin.register User do
-
   collection_action :download_xls do
-    send_data UserDownloader.new.build_xls,
+    send_data UserDownloader.new(User.all).download,
               type: 'application/vnd.ms-excel',
               filename: "user_report.xls"
   end
@@ -96,11 +113,9 @@ ActiveAdmin.register User do
   action_item only: [:index] do
     link_to "Download Excel", download_xls_admin_users_path
   end
-
 end
 ```
 
-
 ## Contributing
 
 1. Fork it
@@ -111,10 +126,12 @@ end
 
 ## 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.
+- 1.0.0 Introduces brand new API
+- 0.2.0 Fix custom header bug
+- 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
 
 ## License
 

data/excelizer.gemspec

@@ -20,6 +20,11 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "guard", "~> 2.13"
+  spec.add_development_dependency "guard-rspec", "~> 4.6"
+  spec.add_development_dependency "rspec-nc", "~> 0.2"
+  spec.add_development_dependency "rspec-legacy_formatters", "~> 1.0"
 
   spec.add_dependency "spreadsheet", "~> 1.0"
 end

data/lib/excelizer.rb

@@ -1,66 +1,4 @@
 require "excelizer/version"
 require "excelizer/writer"
-
-module Excelizer
-  class Base
-    def self.attr_downloadable(*attrs)
-      attrs.each do |attr|
-        define_method(attr) do
-          self.instance_variable_get("@#{attr}")
-        end
-      end
-    end
-
-    def self.attr_headers(*attrs)
-      @@headers = attrs.to_a
-    end
-
-    def build_xls(collection=model_class.all)
-      if defined?(@@headers)
-        headers = @@headers
-      else
-        headers = *methods.select { |m| self.method(m).owner == self.class }.map { |m| m.to_s.titleize }
-      end
-      records = get_collection_data(collection)
-
-      Excelizer::Writer.write headers, records
-    end
-
-    def get_collection_data(collection=model_class.all)
-      model_methods = model_clean_attributes model_class
-
-      # Gets the methods in the class definition and attr_downloadable
-      own_methods = methods.select { |m| self.method(m).owner == self.class }
-
-      # If the model class has the same method as the one defined in
-      # attr_downloadble, that method will be called.
-      collection.map do |model_instance|
-        @model = model_instance
-        own_methods.map do |attr|
-          # Checks if the model has a method with the same name and
-          # if the class definition overrides the model method
-          reciever = self
-          if model_methods.include?(attr.to_s) && reciever.send(attr).nil?
-            reciever = model_instance
-          end
-          reciever.send(attr)
-        end.compact
-      end
-    end
-
-    def model_class
-      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
-        explicit_attribute_keys
-      end
-    end
-
-  end
-end
+require "excelizer/attribute"
+require "excelizer/base"

data/lib/excelizer/attribute.rb

@@ -0,0 +1,23 @@
+module Excelizer
+  class Attribute
+
+    attr_reader :name
+
+    def initialize(name, options)
+      self.name = name
+      self.header = options[:header] unless options[:header].nil?
+    end
+
+    def header
+      (@header || default_header)
+    end
+
+    private
+
+    attr_writer :name, :header
+
+    def default_header
+      name.to_s.split("_").map(&:capitalize).join(" ")
+    end
+  end
+end

data/lib/excelizer/base.rb

@@ -0,0 +1,55 @@
+module Excelizer
+  class Base
+
+    attr_reader :collection
+
+    def initialize(collection = [])
+      self.collection = collection
+    end
+
+    def download
+      Excelizer::Writer.write self.class.headers, records
+    end
+
+    def records
+      collection.map do |item|
+        @record = item
+        self.class.attributes.map do |attribute|
+          method = attribute.name
+          (respond_to?(method) ? send(method) : item.send(method)).to_s
+        end
+      end
+    end
+
+    private
+
+    attr_writer :collection
+
+    class << self
+      def instance(instance_method)
+        self.instance_method = instance_method
+        define_method(instance_method) { @record }
+      end
+
+      def instance_method
+        @instance_method ||= :object
+      end
+
+      def attribute(name, options = {})
+        attributes << Attribute.new(name, options)
+      end
+
+      def attributes
+        @attributes ||= []
+      end
+
+      def headers
+        attributes.flat_map(&:header)
+      end
+
+      private
+
+      attr_writer :instance_method
+    end
+  end
+end

data/lib/excelizer/version.rb

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

data/lib/excelizer/writer.rb

@@ -1,16 +1,16 @@
 module Excelizer
   class Writer
-    require 'spreadsheet' unless defined?(Spreadsheet)
+    require "spreadsheet" unless defined?(Spreadsheet)
 
     def self.write(headers, records)
       book = Spreadsheet::Workbook.new
       sheet = book.create_worksheet
-      
+
       sheet.row(0).push *headers
       records.each_with_index do |record, index|
         sheet.row(index + 1).push *record
       end
-      
+
       self.persist book
     end
 

data/spec/excelizer/base_spec.rb

@@ -0,0 +1,94 @@
+require "spec_helper"
+
+describe Excelizer::Base do
+  let(:downloader_class) { Class.new(described_class) }
+  let(:collection) do
+    3.times.map do |i|
+      OpenStruct.new(id: i, name: "User #{i}", last_name: "Last Name #{i}")
+    end
+  end
+  let(:downloader) { downloader_class.new(collection) }
+
+  describe "#initialize" do
+    it "receives a collection" do
+      expect(downloader.collection).to eq(collection)
+    end
+  end
+
+  describe ".instance" do
+    context "without .instance call" do
+      it "sets instance to :object" do
+        expect(downloader_class.instance_method).to eq(:object)
+      end
+    end
+
+    it "sets the instance to the value passed" do
+      downloader_class.instance :user
+      expect(downloader_class.instance_method).to eq(:user)
+    end
+  end
+
+  describe "#instance" do
+    before do
+      downloader_class.attribute(:email)
+
+      downloader_class.instance :user
+      downloader_class.send(:define_method, :email) do
+        "#{user.id}@apple.com"
+      end
+    end
+
+    it "should include the user instance method in the email method" do
+      expect(downloader.records.first).to eq(["0@apple.com"])
+    end
+  end
+
+  describe ".attribute" do
+    it "pushes an attribute to a set of attributes" do
+      downloader_class.attribute :first_name
+      expect(downloader_class.attributes.size).to eq(1)
+      expect(downloader_class.attributes.first.name).to eq(:first_name)
+    end
+
+    context "when using a header option" do
+      it "pushes the attribute along with the header to the set of attributes" do
+        downloader_class.attribute :first_name, header: "Primer nombre"
+        expect(downloader_class.attributes.first.header).to eq("Primer nombre")
+      end
+    end
+  end
+
+  describe ".headers" do
+    before do
+      downloader_class.attribute(:id)
+      downloader_class.attribute(:last_name)
+    end
+
+    it "returns the attributes names" do
+      expect(downloader_class.headers).to eq(["Id", "Last Name"])
+    end
+
+    context "when using a custom header" do
+      before do
+        downloader_class.attribute(:username, header: "Usuario")
+      end
+
+      it "should assign the header to the attribute" do
+        expect(downloader_class.headers).to eq(["Id", "Last Name", "Usuario"])
+      end
+    end
+  end
+
+  describe "#build_records" do
+    before do
+      downloader_class.attribute(:id)
+      downloader_class.attribute(:name)
+      downloader_class.attribute(:last_name)
+    end
+
+    it "should generate a collection of writable records" do
+      expect(downloader.records.size).to eq(3)
+      expect(downloader.records.last).to eq(["2", "User 2", "Last Name 2"])
+    end
+  end
+end

data/spec/excelizer/writer_spec.rb

@@ -0,0 +1,9 @@
+require "spec_helper"
+
+describe Excelizer::Writer do
+
+  it "should work" do
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require "rubygems"
+
+require_relative "../lib/excelizer"
+
+RSpec.configure do |config|
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: excelizer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Arturo Puente
@@ -38,6 +38,76 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.6'
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-legacy_formatters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: spreadsheet
   requirement: !ruby/object:Gem::Requirement
@@ -61,14 +131,20 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - excelizer.gemspec
 - lib/excelizer.rb
+- lib/excelizer/attribute.rb
+- lib/excelizer/base.rb
 - lib/excelizer/version.rb
 - lib/excelizer/writer.rb
-- test/spec.rb
+- spec/excelizer/base_spec.rb
+- spec/excelizer/writer_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/arturopuente/excelizer
 licenses:
 - MIT
@@ -94,5 +170,7 @@ signing_key:
 specification_version: 4
 summary: An Excel helper for Rails project
 test_files:
-- test/spec.rb
+- spec/excelizer/base_spec.rb
+- spec/excelizer/writer_spec.rb
+- spec/spec_helper.rb
 has_rdoc: