reportabull 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b3a7d072a090b2651473932d3d332da2d1dd0daa
+  data.tar.gz: 8e605fd7556fd967feafb3ded12cbb55a58e7109
+SHA512:
+  metadata.gz: 2275b21500f267b7525613c20de5a16b25b9dace460dddf795a4d2877bf1d279dd13911c7e0d4387a869ba435c5c09d3f99cfba64b36bd8739449bdd85c0cf49
+  data.tar.gz: c65d18bacb5e8085fdbaab917a507d6956e042574fe1b7fdeaee44930ba0abb98df729ed41f7e1be0601c5bc74716095f579b48ed0c008aa19bcf9c586487e9b

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

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 ihatov08@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/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in reportabull.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    reportabull (0.1.0)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.0.5)
+    ffi (1.9.23)
+    i18n (1.0.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    mysql2 (0.5.0)
+    pg (0.21.0)
+    rake (10.5.0)
+    sqlite3 (0.1.1)
+      ffi (>= 0.6.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  mysql2 (~> 0)
+  pg (~> 0)
+  rake (~> 10.0)
+  reportabull!
+  sqlite3 (~> 0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 ihatov08
+
+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,66 @@
+# Reportabull
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/reportabull`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'reportabull'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install reportabull
+
+## Usage
+
+```ruby
+
+require 'reportabull'
+
+class Sample
+  include Reportabull
+
+  User = Struct.new(:name, :email)
+
+  def self.find_collection
+    (1..10).to_a.map.with_index{ |m, i| User.new("user_#{i}", "user_#{i}@example.com") }
+  end
+
+  columns do
+    column(:name)
+    column(:email)
+  end
+end
+
+Sample.to_csv
+=> "Name,Email\nuser_0,user_0@example.com\nuser_1,user_1@example.com\nuser_2,user_2@example.com\nuser_3,user_3@example.com\nuser_4,user_4@example.com\nuser_5,user_5@example.com\nuser_6,user_6@example.com\nuser_7,user_7@example.com\nuser_8,user_8@example.com\nuser_9,user_9@example.com\n"
+[
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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]/reportabull. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Reportabull project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/reportabull/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'reportabull'
+
+class Sample
+  include Reportabull
+
+  User = Struct.new(:name, :email)
+
+  def self.find_collection
+    (1..10).to_a.map.with_index{ |m, i| User.new("user_#{i}", "user_#{i}@example.com") }
+  end
+
+  columns do
+    column(:name)
+    column(:email)
+  end
+end

data/lib/reportabull/builder.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Reportabull
+  class Builder
+    attr_accessor :collection, :output, :columns, :options
+
+    def initialize(columns, options, collection, output)
+      @columns = columns
+      @options = options
+      @collection = collection
+      @output = [output]
+    end
+
+    def build
+      build_header
+      build_rows
+      output.join
+    end
+
+    def build_header
+      nil
+    end
+
+    def build_rows
+      collection.each do |resource|
+        output << build_row(resource)
+      end
+    end
+
+    def build_row(resource)
+      columns.each_with_object({}) do |column, result|
+        result[column.name] = encode(column.value(resource), options)
+      end
+    end
+
+    def encode(content, options)
+      if options[:encoding]
+        content.to_s.encode(options[:encoding], options[:encoding_options])
+      else
+        content
+      end
+    end
+  end
+end

data/lib/reportabull/column.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Reportabull
+  class Column
+    attr_reader :name, :data, :options
+
+    def initialize(name, options = {}, block = nil)
+      @options = options
+      options[:humanize_name] = true if options[:humanize_name].nil?
+      @name = humanize_name(name, options[:humanize_name])
+      @data = block || name.to_sym
+    end
+
+    def humanize_name(name, humanize_name_option)
+      if humanize_name_option
+        name.to_s.humanize
+      else
+        name.to_s
+      end
+    end
+
+    def value(resource)
+      case data
+      when Symbol, String
+        resource.send(data)
+      when Proc
+        resource.instance_exec(resource, &data)
+      end
+    end
+  end
+end

data/lib/reportabull/csv_builder.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "csv"
+
+module Reportabull
+  class CsvBuilder < Builder
+
+    def add_byte_order_mark
+      bom = options.fetch(:byte_order_mark, false)
+      output << bom if bom
+    end
+
+    def build_header
+      add_byte_order_mark
+      return unless options.fetch(:column_names, true)
+      headers = columns.map { |column| encode(column.name, options) }
+      output << CSV.generate_line(headers, options)
+    end
+
+    def build_rows
+      collection.each do |resource|
+        row = build_row(resource)
+        output << CSV.generate_line(row.values, options)
+      end
+    end
+  end
+end

data/lib/reportabull/report_builder.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'reportabull/csv_builder'
+require 'reportabull/builder'
+require 'active_support'
+require 'active_support/core_ext'
+
+module Reportabull
+  class ReportBuilder
+
+    attr_reader :columns, :options
+
+    attr_accessor :humanize_name
+
+    def initialize(options = {}, &block)
+      @columns = []
+      @options = options
+      @block = block
+      @humanize_names = options.delete(:humanize_name)
+    end
+
+    def csv_options
+      @csv_options ||= options.except(
+        :encoding_options,
+        :byte_order_mark,
+        :column_names
+      )
+    end
+
+    def column(name,  _options = {}, &block)
+      @columns << Column.new(name, { humanize_name: humanize_name }, block)
+    end
+
+    def build(collection = [], output: nil, format: nil)
+      exec_columns
+
+      builder =
+        case format
+        when :csv
+          CsvBuilder.new(columns, options, collection, output || '')
+         else
+           Builder.new(columns, options, collection, output || [])
+      end
+
+      builder.build
+    end
+
+    private
+
+    def exec_columns
+      @columns = []
+      instance_exec(&@block) if @block.present?
+      columns
+    end
+  end
+end

data/lib/reportabull/version.rb

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

data/lib/reportabull.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "reportabull/version"
+require "reportabull/builder"
+require "reportabull/column"
+require "reportabull/csv_builder"
+require "reportabull/report_builder"
+
+module Reportabull
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    attr_accessor :report_builder
+
+    def columns(options = {}, &block)
+      self.report_builder = ReportBuilder.new(options, &block)
+    end
+
+    def to_csv(collection: nil)
+      report_builder.build(collection || find_collection, output: '', format: :csv)
+    end
+
+    def to_csv_enumrator(collection: nil)
+      Enumerator.new do |y|
+        report_builder.build(collection || find_collection, output: y, format: :csv)
+      end
+    end
+  end
+end

data/reportabull.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "reportabull/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "reportabull"
+  spec.version       = Reportabull::VERSION
+  spec.authors       = ["ihatov08"]
+  spec.email         = ["ihatov08@gmail.com"]
+
+  spec.summary       = %q{Easily export data.}
+  spec.description   = %q{Easily export data your data objects.}
+  spec.homepage      = "https://github.com/ihatov08/reportabull"
+  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_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_development_dependency "pg", '~> 0'
+  spec.add_development_dependency "mysql2", '~> 0'
+  spec.add_development_dependency "sqlite3", '~> 0'
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: reportabull
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ihatov08
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: mysql2
+  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
+  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'
+description: Easily export data your data objects.
+email:
+- ihatov08@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/sample.rb
+- lib/reportabull.rb
+- lib/reportabull/builder.rb
+- lib/reportabull/column.rb
+- lib/reportabull/csv_builder.rb
+- lib/reportabull/report_builder.rb
+- lib/reportabull/version.rb
+- reportabull.gemspec
+homepage: https://github.com/ihatov08/reportabull
+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: Easily export data.
+test_files: []