data_exporter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 775197d18a4b733e422dfb52baff6f583d0bc35a
+  data.tar.gz: 56d7a98cca7cdbbfb573bf58d1fae339b9736a20
+SHA512:
+  metadata.gz: 9deaec6aaf9f2655eb7345bb5af2b868bb5219333cd287a5f662df700ee1eb646313ef69efecb8eacaf1cb49986b453a24d3c3c79f540a97325589e9844b6599
+  data.tar.gz: 567eadbc9b09b53391866a432489f8d44c7e0b57de6cc5aa24710cd96d8de70385db3120515a2ed5f1dea9646e09e635904ac03b91daee696e72eb432703d571

data/.gitignore

@@ -0,0 +1,28 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*
+!/log/.keep
+/tmp
+coverage/assets
+coverage/index.html
+coverage/.resultset.json
+coverage/.resultset.json.lock
+launch.json
+settings.json
+
+
+*.env*
+
+/public/system

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 klismannsm
+
+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,98 @@
+# DataExporter
+
+This gem exports model data into different formats, such as CSV. To achieve so, it uses an export model that handles how the data will be shown.
+<br>
+Example:
+
+```
+class ExampleExportModel
+  def initialize(example)
+    @example = example
+  end
+
+  def export_header
+    ['Code', 'Name', 'Random Number', 'Created At', 'Updated At']
+  end
+
+  def export
+    [code, name, random_number, created_at, updated_at]
+  end
+
+  private
+
+  def code
+    @example.code
+  end
+
+  def name
+    @example.name
+  end
+
+  def random_number
+    @example.random_number
+  end
+
+  def created_at
+    @example.created_at
+  end
+
+  def updated_at
+    @example.updated_at
+  end
+end
+```
+
+Exporting the data:
+
+```
+DataExporter::Exporter.new(example, 'csv').export
+```
+
+Exporting the data to a tempfile:
+
+```
+DataExporter::Exporter.new(example, 'csv').export_to_tempfile
+```
+
+<br>
+Version History:
+
+```
+0.1.0: Initial version, only CSV is supported
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'data_exporter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install data_exporter
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/data_exporter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/data_exporter/.gitignore

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

data/data_exporter/.rspec

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

data/data_exporter/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.14.6

data/data_exporter/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 klismannsm@gmail.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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/data_exporter/Gemfile

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

data/data_exporter/Rakefile

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

data/data_exporter/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "data_exporter"
+
+# 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/data_exporter/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/data_exporter/data_exporter.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'data_exporter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "data_exporter"
+  spec.version       = DataExporter::VERSION
+  spec.authors       = ["klismannsm"]
+  spec.email         = ["klismannsm@gmail.com"]
+
+  spec.summary       = 'Exports model data into various formats'
+  spec.description   = 'Given a compatible export model, this gem exports the data into the specified format'
+  spec.homepage      = 'https://github.com/klismannsm/rails_data_exporter'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/data_exporter/lib/data_exporter.rb

@@ -0,0 +1,47 @@
+require 'csv'
+
+module DataExporter
+  class Exporter
+    def initialize(objects, format)
+      @objects = objects
+      @format = format
+    end
+
+    def export
+      case @format
+        when 'csv'
+          export_to_csv
+      end
+    end
+
+    def export_to_tempfile
+      case @format
+        when 'csv'
+          export_to_csv_tempfile
+      end
+    end
+
+    private
+
+    def export_to_csv
+      CSV.generate(headers: true, col_sep: ';') do |csv|
+        write_data_to_csv(csv)
+      end
+    end
+
+    def export_to_csv_tempfile(filename_prefix)
+      Tempfile.open([filename_prefix, '.csv']) do |csv_tempfile|
+        csv_tempfile << export_to_csv
+      end
+    end
+
+    def write_data_to_csv(csv)
+      if @objects.first.respond_to? :export_header
+        csv << @objects.first.export_header
+      end
+      @objects.each do |object|
+        csv << object.export
+      end
+    end
+  end
+end

data/data_exporter/lib/data_exporter/example_export_model.rb

@@ -0,0 +1,37 @@
+module DataExporter
+  class ExampleExportModel
+    def initialize(example)
+      @example = example
+    end
+
+    def export_header
+      ['Code', 'Name', 'Random Number', 'Created At', 'Updated At']
+    end
+
+    def export
+      [code, name, random_number, created_at, updated_at]
+    end
+
+    private
+
+    def code
+      @example.code
+    end
+
+    def name
+      @example.name
+    end
+
+    def random_number
+      @example.random_number
+    end
+
+    def created_at
+      @example.created_at
+    end
+
+    def updated_at
+      @example.updated_at
+    end
+  end
+end

data/data_exporter/lib/data_exporter/version.rb

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

data/data_exporter/spec/data_exporter_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+RSpec.describe DataExporter do
+  it "has a version number" do
+    expect(DataExporter::VERSION).not_to be nil
+  end
+
+  it "does something useful" do
+    expect(false).to eq(true)
+  end
+end

data/data_exporter/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require "bundler/setup"
+require "data_exporter"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: data_exporter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- klismannsm
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Given a compatible export model, this gem exports the data into the specified
+  format
+email:
+- klismannsm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE.txt
+- README.md
+- data_exporter/.gitignore
+- data_exporter/.rspec
+- data_exporter/.travis.yml
+- data_exporter/CODE_OF_CONDUCT.md
+- data_exporter/Gemfile
+- data_exporter/Rakefile
+- data_exporter/bin/console
+- data_exporter/bin/setup
+- data_exporter/data_exporter.gemspec
+- data_exporter/lib/data_exporter.rb
+- data_exporter/lib/data_exporter/example_export_model.rb
+- data_exporter/lib/data_exporter/version.rb
+- data_exporter/spec/data_exporter_spec.rb
+- data_exporter/spec/spec_helper.rb
+homepage: https://github.com/klismannsm/rails_data_exporter
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Exports model data into various formats
+test_files: []