excel_serializer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0ea8bac11e5e6a57e556ee0e7d25c61f6ca45d84780c03c89cfecca2f5c81a3b
+  data.tar.gz: 89ab8cfb455f2b493f74c56b3556471f9a9486e15614525909c97f5a5bc5f92b
+SHA512:
+  metadata.gz: a31f41444348e1961308b0758c834039ce38476383fb0faf366ec0973419d7515970ce95cea8b28310b019275bd09d45cc138bb13fc5591e5e4a060a97b952c5
+  data.tar.gz: ad4d6f94bef0842c2c93874231b093b336f8764937e881f036b9d6f62d39a31886839a7dcc3a9bd3d0ca2fecd5c8c63cba7ff89411e639a964ac775614322887

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at storresy@innventto.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in excel_serializer.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Sebastian Torres
+
+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,67 @@
+# ExcelSerializer
+
+This gem allows you to easily export ruby objects to excel files by defining a serializer for each object. ExcelSerializer can work with multiple excel writting gems and allows you to translate the document headers using I18n.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'excel_serializer'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install excel_serializer
+
+## Usage
+
+### Serializer definition
+
+```ruby
+class AttendeeExcelSerializer
+  include ExcelSerializer::ObjectSerializer
+
+  attributes :uuid, :first_name, :last_name, :created_at
+  belongs_to :event
+
+  excel_adapter :write_excel # optional
+  translation_adapter :i18n # optional 
+
+  def created_at
+    object.created_at&.strftime("%Y-%m-%d")
+  end
+end
+```
+
+### Excel file generation
+
+```ruby
+AttendeeExcelSerializer.new(attendees).excel_file
+```
+
+excel_file method receives an optional string parameter path, which will be used as the generated file path. If this param is not present the file will be generated in /tmp folder with a random string name.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/storresy/excel_serializer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/storresy/excel_serializer/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ExcelSerializer project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/storresy/excel_serializer/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "excel_serializer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/excel_serializer.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/excel_serializer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "excel_serializer"
+  spec.version       = ExcelSerializer::VERSION
+  spec.authors       = ["Sebastian Torres"]
+
+  spec.summary       = %q{An excel serializer for Ruby objects}
+  spec.description   = %q{This gem allows you to easily export ruby objects to excel files by defining a serializer for each object. ExcelSerializer can work with multiple excel writting gems and allows you to translate the document headers using I18n.}
+  spec.homepage      = "https://github.com/storresy/excel_serializer"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/storresy/excel_serializer"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/excel_serializer.rb

@@ -0,0 +1,28 @@
+require "excel_serializer/version"
+require "excel_serializer/object_serializer"
+
+module ExcelSerializer
+  class ExcelAdapterNotFoundError < StandardError
+    def initialize(class_name, gem_name)
+      msg = "#{class_name} could not be found. Please ensure you have '#{gem_name}' gem installed or setup a different excel adapter"
+      super(msg)
+    end
+  end
+  class Config
+    attr_accessor :excel_adapter, :translation_adapter
+
+    def initialize(excel_adapter: :write_excel,
+                    translation_adapter: :i18n)
+      self.excel_adapter = excel_adapter
+      self.translation_adapter = translation_adapter
+    end
+  end
+
+  def self.config
+    @@config ||= Config.new
+  end
+
+  def self.configure
+    yield(self.config)
+  end
+end

data/lib/excel_serializer/adapters/write_excel.rb

@@ -0,0 +1,37 @@
+module ExcelSerializer
+  module Adapters
+    class WriteExcel
+      # This is the adapter for WriteExcel gem
+      
+      def initialize(file_path)
+        @write_excel = ::WriteExcel.new(file_path)
+      rescue NameError => e
+        raise ExcelAdapterNotFoundError.new('WriteExcel', 'writeexcel')
+      end
+
+      def add_worksheet(sheet_name)
+        WorkSheet.new(@write_excel, sheet_name)
+      end
+
+      def save
+        @write_excel.close
+      end
+
+      def self.file_extension
+        '.xls'
+      end
+
+      class WorkSheet
+        def initialize(write_excel, sheet_name)
+          @write_excel = write_excel
+          @worksheet = @write_excel.add_worksheet(sheet_name)
+        end
+
+        def write(row, column, value)
+          @worksheet.write(row, column, value)
+        end
+      end
+
+    end
+  end
+end

data/lib/excel_serializer/headers_translator.rb

@@ -0,0 +1,58 @@
+module ExcelSerializer
+  module HeadersTranslator
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def compute_headers
+        if computed_headers.blank?
+          self.computed_headers ||= []
+          self.attributes_to_serialize.each do |attribute|
+            self.computed_headers << translate_attribute(attribute)
+          end
+        end
+        computed_headers
+      end
+
+      def translation_key_base(translation_key_base)
+        @translation_key_base = translation_key_base
+      end
+
+      def translate_attribute(attribute)
+        case self.current_config.translation_adapter
+        when :i18n
+          i18n_translation(attribute)
+        when :humanize
+          humanize(attribute)
+        else
+          raise "Invalid translations adapter"
+        end
+      end
+
+      def i18n_translation(attribute)
+        I18n.t("#{translation_base}.#{attribute}")
+      end
+
+      def humanize(attribute)
+        attribute.to_s.humanize
+      end
+
+      def translation_base
+        return @translation_key_base if @translation_key_base.present?
+        obj_name = self.name.sub('ExcelSerializer','').underscore
+        @translation_key_base = "activerecord.attributes.#{obj_name}"
+      end
+    end
+
+    def headers
+      @headers ||= compute_headers
+    end
+
+    def compute_headers
+      @headers = self.class.compute_headers
+      self.class.included_relations.each do |key, hash|
+        @headers += hash[:serializer].constantize.compute_headers
+      end
+      @headers
+    end
+  end
+end

data/lib/excel_serializer/object_serializer.rb

@@ -0,0 +1,106 @@
+require "excel_serializer/writer"
+require "excel_serializer/headers_translator"
+
+module ExcelSerializer
+  module ObjectSerializer
+    extend ActiveSupport::Concern
+    include ::ExcelSerializer::Writer
+    include ::ExcelSerializer::HeadersTranslator
+
+    included do
+      attr_accessor :resources
+
+      class << self
+        attr_accessor :attributes_to_serialize
+        attr_accessor :included_relations
+        attr_accessor :computed_headers
+        attr_accessor :config
+      end
+    end
+
+    class_methods do
+      def attributes(*attributes_list)
+        self.attributes_to_serialize ||= []
+        self.attributes_to_serialize += attributes_list
+      end
+
+      def belongs_to(relation, serializer: nil)
+        self.included_relations ||= {}
+        self.included_relations[relation.to_s] = {
+          method: relation,
+          serializer: (serializer || relation_serializer(relation))
+        }
+      end
+
+      def excel_adapter(adapter)
+        current_config.excel_adapter = adapter
+      end
+
+      def translation_adapter(adapter)
+        current_config.translation_adapter = adapter
+      end
+
+      def current_config
+        self.config ||= ExcelSerializer.config.dup
+      end
+
+      private
+      
+      def relation_serializer(relation)
+        "#{relation.to_s.singularize.camelcase}ExcelSerializer"
+      end
+    end
+
+    def initialize(resources, file_path: nil)
+      self.file_path = file_path
+      if resources.is_a?(ActiveRecord::Relation) or resources.is_a?(Array)
+        self.resources = resources
+      else
+        self.resources = [resources]
+      end
+    end
+
+    def excel_file
+      add_headers('Main')
+      method_name = 'each'
+      if resources.is_a?(ActiveRecord::Relation)
+        method_name = 'find_each'
+      end
+      resources.send(method_name) do |resource|
+        write('Main', single_resource_all_info(resource))
+      end 
+      close_workbook
+    end
+
+    def object
+      @object
+    end
+
+    def single_resource_all_info(resource)
+      all_info = single_resource_info(resource)
+      self.class.included_relations.each do |key, hash|
+        all_info += hash[:serializer].constantize.new(nil).single_resource_info(
+          resource.send(hash[:method])
+        )
+      end
+      all_info
+    end
+
+    def single_resource_info(resource)
+      self.object= resource
+      self.class.attributes_to_serialize.map do |attribute|
+        if self.respond_to?(attribute)
+          self
+        else
+          resource
+        end.send(attribute)
+      end
+    end
+
+    private
+
+    def object=(object)
+      @object = object
+    end
+  end
+end

data/lib/excel_serializer/version.rb

@@ -0,0 +1,3 @@
+module ExcelSerializer
+  VERSION = "0.1.0"
+end

data/lib/excel_serializer/worksheet.rb

@@ -0,0 +1,23 @@
+module ExcelSerializer
+  class Worksheet
+    attr_accessor :sheet, :row_counter
+
+    def initialize(current_excel, sheet_name)
+      @sheet = current_excel.add_worksheet(sheet_name)
+      @row_counter = 0
+    end
+
+    def write_row(row)
+      row_index = @row_counter += 1
+      row.each_with_index do |value, current_column|
+        @sheet.write(row_index, current_column, value)
+      end
+    end
+
+    def write_headers(headers)
+      headers.each_with_index do |value, current_column|
+        @sheet.write(0, current_column, value)
+      end
+    end
+  end
+end

data/lib/excel_serializer/writer.rb

@@ -0,0 +1,59 @@
+require "excel_serializer/worksheet"
+require "excel_serializer/adapters/write_excel"
+
+module ExcelSerializer
+  module Writer
+    extend ActiveSupport::Concern
+
+    private
+
+    def add_headers(sheet_name)
+      sheet(sheet_name).write_headers(headers)
+    end
+
+    def current_excel
+      return @current_excel if @current_excel.present?
+      @current_excel = adapter.new(file_path)
+    end
+
+    def write(sheet_name, row)
+      sheet(sheet_name).write_row(row)
+    end
+
+    def sheet(sheet_name)
+      @sheets ||= {}
+      @sheets[sheet_name]= worksheet(sheet_name) if @sheets[sheet_name].blank? 
+      @sheets[sheet_name]
+    end
+
+    def worksheet(sheet_name)
+      ::ExcelSerializer::Worksheet.new(current_excel, sheet_name)
+    end
+
+    def file_path=(file_path)
+      if file_path.blank? 
+        @file_path = "/tmp/#{SecureRandom.uuid}#{adapter.file_extension}"
+      else
+        @file_path= file_path
+      end
+    end
+
+    def file_path
+      @file_path
+    end
+
+    def close_workbook
+      current_excel.save
+      return file_path
+    end
+
+    def adapter
+      case self.class.current_config.excel_adapter
+      when :write_excel
+        ::ExcelSerializer::Adapters::WriteExcel
+      else
+        raise "Invalid excel writer adapter"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: excel_serializer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sebastian Torres
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-27 00:00:00.000000000 Z
+dependencies: []
+description: This gem allows you to easily export ruby objects to excel files by defining
+  a serializer for each object. ExcelSerializer can work with multiple excel writting
+  gems and allows you to translate the document headers using I18n.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- excel_serializer.gemspec
+- lib/excel_serializer.rb
+- lib/excel_serializer/adapters/write_excel.rb
+- lib/excel_serializer/headers_translator.rb
+- lib/excel_serializer/object_serializer.rb
+- lib/excel_serializer/version.rb
+- lib/excel_serializer/worksheet.rb
+- lib/excel_serializer/writer.rb
+homepage: https://github.com/storresy/excel_serializer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/storresy/excel_serializer
+  source_code_uri: https://github.com/storresy/excel_serializer
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: An excel serializer for Ruby objects
+test_files: []