simple_csv_creator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60445e0ac58bbfab4628252d0f1928e67e7a2f88
+  data.tar.gz: 3fe03b5378fa5ebbf0d817797b5a7254b8198579
+SHA512:
+  metadata.gz: 58f6d7ea42e715c228bd06fc41b1801fc257b04651adeeef46525af4a84e9596c0db8db2d237f2a6a47984d311d42d4d0fb2e39fbd52f80c0ce32103bfa2d708
+  data.tar.gz: 4c27c251386f9d5924f82fd4b7fdceb31c820f189b888b2ee1c483532043607fe4dcf1237606aee0de93f185990fe74b2ca6962efa11812b1f03dd4d45596483

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

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 wendykurniawan92@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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in csv_creator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 wendy0402
+
+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,82 @@
+# SimpleCsvCreator
+
+SimpleCsvCreator has DSL to build the csv. It's inspired by activeadmin csv
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_csv_creator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install csv_creator
+
+## Usage
+
+SimpleCsvCreator has DSL to build the csv
+it's inspired by activeadmin csv
+example:
+
+```ruby
+class User
+  attr_reader :name, :age, :gender
+  def initialize(name, age, gender)
+    @name = name
+    @age = age
+    @gender = gender
+  end
+end
+
+user1 = User.new('test', 20, 'female')
+user2 = User.new('mobile', 13, 'male')
+csv_creator = SimpleCsvCreator.schema do
+  column(:name) # if without block then it will run the name given(user.name), header name will be titleize of name
+  column(:age) { |r| r.age + ' years' } # if with block will run the block
+  column('User Gender') { |r| r.gender } # if want to use custom title need to give the block
+end
+result = SimpleCsvCreator.simple_generate([user1, user2])
+csv_parse = CSV.parse(result)
+csv_parse:
+[
+  ['Name', 'Age', 'User Gender'],
+  ['test', '20 years', 'female'],
+  ['mobile', '13 years', 'male']
+]
+```
+
+Sometimes you want to do lazy fetch e.g: `find_each` method in ActiveRecord.
+If you use simple_generate you won't be able to use this kind of method because simple_generate
+need the array with all of its elements. To handle it you can use `generate_using` method
+
+e.g:
+```ruby
+generator = Proc.new do |&block|
+  resources.each do |resource|
+    block.call(resource)
+  end
+end
+result = SimpleCsvCreator.generate_using(generator)
+end
+```
+
+## 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]/csv_creator. 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/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 "simple_csv_creator"
+
+# 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

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/lib/simple_csv_creator.rb

@@ -0,0 +1,50 @@
+require "simple_csv_creator/version"
+require "simple_csv_creator/column"
+require "simple_csv_creator/generator"
+require "csv"
+# SimpleCsvCreator has DSL to build the csv
+# it's inspired by activeadmin csv
+# example:
+# class User
+#   attr_reader :name, :age, :gender
+#   def initialize(name, age, gender)
+#     @name = name
+#     @age = age
+#     @gender = gender
+#   end
+# end
+#
+# user1 = User.new('test', 20, 'female')
+# user2 = User.new('mobile', 13, 'male')
+# csv_creator = SimpleCsvCreator.schema do
+#   column(:name) # if without block then it will run the name given(user.name), header name will be titleize of name
+#   column(:age) { |r| r.age + ' years' } # if with block will run the block
+#   column('User Gender') { |r| r.gender } # if want to use custom title need to give the block
+# end
+# result = SimpleCsvCreator.simple_generate([user1, user2])
+# csv_parse = CSV.parse(result)
+# csv_parse:
+# [
+#   ['Name', 'Age', 'User Gender'],
+#   ['test', '20 years', 'female'],
+#   ['mobile', '13 years', 'male']
+# ]
+#
+# Sometimes you want to do lazy fetch e.g: `find_each` method in ActiveRecord.
+# If you use simple_generate you won't be able to use this kind of method because simple_generate
+# need the array with all of its elements. To handle it you can use `generate_using` method
+# e.g:
+# generator = Proc.new do |&block|
+#   resources.each do |resource|
+#     block.call(resource)
+#   end
+# end
+# result = SimpleCsvCreator.generate_using(generator)
+# end
+module SimpleCsvCreator
+  def self.schema(&block)
+    csv_creator = SimpleCsvCreator::Generator.new
+    csv_creator.instance_eval(&block)
+    csv_creator
+  end
+end

data/lib/simple_csv_creator/column.rb

@@ -0,0 +1,26 @@
+module SimpleCsvCreator
+  class Column
+    attr_reader :column_name, :block
+    def initialize(column_name, &block)
+      @column_name = column_name
+      @block = block
+    end
+
+    def human_name
+      column_name.is_a?(Symbol) ? titleize(column_name.to_s) : column_name
+    end
+
+    def value(resource)
+      if block
+        block.call(resource)
+      else
+        resource.public_send(column_name)
+      end
+    end
+
+    private
+    def titleize(word)
+      word.split("_").map{ |chunk| chunk.capitalize}.join(" ")
+    end
+  end
+end

data/lib/simple_csv_creator/generator.rb

@@ -0,0 +1,43 @@
+module SimpleCsvCreator
+  class Generator
+    attr_reader :columns
+
+    def initialize
+      @columns = []
+    end
+
+    def column(column_name, &block)
+      column = ::SimpleCsvCreator::Column.new(column_name, &block)
+      @columns.push(column)
+    end
+
+    def simple_generate(resources)
+      generate do |csv, columns|
+        resources.each do |resource|
+          csv << columns.map { |column| column.value(resource) }
+        end
+      end
+    end
+
+    def generate_using(generator)
+      generate do |csv, columns|
+        generator.call do |resource|
+          csv << columns.map { |column| column.value(resource) }
+        end
+      end
+    end
+
+
+    private
+    def generate
+      CSV.generate do |csv|
+        csv << column_human_names
+        yield(csv, columns)
+      end
+    end
+
+    def column_human_names
+      @columns.map(&:human_name)
+    end
+  end
+end

data/lib/simple_csv_creator/version.rb

@@ -0,0 +1,3 @@
+module SimpleCsvCreator
+  VERSION = "1.0.0"
+end

data/simple_csv_creator.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_csv_creator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_csv_creator"
+  spec.version       = SimpleCsvCreator::VERSION
+  spec.authors       = ["wendy0402"]
+  spec.email         = ["wendykurniawan92@gmail.com"]
+
+  spec.summary       = "DSL for creating csv file"
+  spec.description   = "DSL for creating csv file inspired by activeadmin csv"
+  spec.homepage      = "https://github.com/wendy0402/csv_creator"
+  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.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: simple_csv_creator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- wendy0402
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: DSL for creating csv file inspired by activeadmin csv
+email:
+- wendykurniawan92@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_csv_creator.rb
+- lib/simple_csv_creator/column.rb
+- lib/simple_csv_creator/generator.rb
+- lib/simple_csv_creator/version.rb
+- simple_csv_creator.gemspec
+homepage: https://github.com/wendy0402/csv_creator
+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.6.8
+signing_key: 
+specification_version: 4
+summary: DSL for creating csv file
+test_files: []