babaloa 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6dfa2ceb70c00495a1b6a702fe5d5ba5b69b37d41086f60230112603caf592bc
-  data.tar.gz: 59b2e1729b54655849b58f753c9de74bec202c90202d8a3a4d908b741f273301
+  metadata.gz: 504a9eb60037d436fe931f54f40ea31b90a321c7d1f8bcfc824699c1b42e6554
+  data.tar.gz: e8aa654cb29fdc99586bec36dc581817ba0215e0b7ed09f6803e21ac9cf76634
 SHA512:
-  metadata.gz: f02b2153b16e6d047cbdb4293d68c541a77f5efc0183e0ba7f11ee43d456539f230a216fd92ca57893779e362bcb09b5db799b221d1f2633beafe73111c6d9f5
-  data.tar.gz: b27e8beed3308fd5ca307ce5086c6906b5f45416bec87a1e26cafff120cb06fe181801389e17c28e969c40fb2e275ce4c55ea99b1901e905674514726d5c98a9
+  metadata.gz: aae6439a396cab2139730381e65e9071cf6af9828646191ec1ba6b9a9d193f2948a039ade8540088b0001175912c5c38b3ac3f12f4c3558bcee4112563886421
+  data.tar.gz: ffa8ef6242d3a8bae401f772e0e1524ef56ca95c80c83edf2f7632613176aae5f77cb02b084a50bf42330f0317bf2c28afe933a42fef8f4b108cdd2a23cab99a

data/.circleci/config.yml

@@ -0,0 +1,68 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      - image: circleci/ruby:2.6.3
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    branches:
+        only:
+          - master
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "Gemfile.lock" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            gem install bundler:2.0.1
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # Database setup
+      # - run: bundle exec rake db:create
+      # - run: bundle exec rake db:schema:load
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | \
+              circleci tests split --split-by=timings)"
+
+            bundle exec rspec \
+              --format progress \
+              --format RspecJunitFormatter \
+              --out /tmp/test-results/rspec.xml \
+              --format progress \
+              $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/Gemfile

@@ -3,4 +3,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in babaloa.gemspec
 gemspec
 
-gem "byebug", platform: :mri, group: %i(development test)
+group :development, :test do
+  gem "byebug", platform: :mri
+  gem "rspec_junit_formatter"
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    babaloa (0.1.0)
+    babaloa (0.1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -22,6 +22,8 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
 
 PLATFORMS
   ruby
@@ -32,6 +34,7 @@ DEPENDENCIES
   byebug
   rake (~> 10.0)
   rspec (~> 3.0)
+  rspec_junit_formatter
 
 BUNDLED WITH
    2.0.1

data/README.md

@@ -1,8 +1,9 @@
-# Babaloa
+[![CircleCI](https://circleci.com/gh/belion-freee/babaloa/tree/master.svg?style=svg&circle-token=b9268fffd3d7fe1e2d7639b718a4c307c761c607)](https://circleci.com/gh/belion-freee/babaloa/tree/master)
 
-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/babaloa`. To experiment with that code, run `bin/console` for an interactive prompt.
+# Babaloa
 
-TODO: Delete this and the text above, and describe your gem
+This is a gem that will convert to CSV if you pass an array. In addition to conversion, sorting, column specification, and translation can be optionally specified.
+You can also register default settings in initializers.
 
 ## Installation
 
@@ -21,18 +22,105 @@ Or install it yourself as:
     $ gem install babaloa
 
 ## Usage
+It is very easy to use. Pass an array as an argument. CSV file is generated.
+
+```ruby
+arr = [["col1", "col2", "col3"],["row1-1", "row1-2", "row1-3"],["row2-1", "row2-2", "row2-3"]]
+Babaloa.to_csv(arr) # => "col1,col2,col3\nrow1-1,row1-2,row1-3\nrow2-1,row2-2,row2-3\n"
+```
+
+You can also use Hash for the contents of the array. Like this.
+
+```ruby
+arr = [{"col1" => "row1-1", "col2" => "row1-2", "col3" => "row1-3"},{ "col1" => "row2-1", "col2" => "row2-2", "col3" => "row2-3"}]
+Babaloa.to_csv(arr) # => "col1,col2,col3\nrow1-1,row1-2,row1-3\nrow2-1,row2-2,row2-3\n"
+```
+
+## Options
+Introduces the available options.
+
+### Sort options
+You can sort content for using sort options.
+You can use option value with Hash(only use desc) or String, Symbol.
+**Be sure to use the same hash key type as the header name** to be specified. It does not move if the type is different. In addition, in case of comparing with `2, 3, 100` note that the order will be `100, 2, 3` when comparing by character string.
+
+```ruby
+arr = [{ "col1" => "row2-1", "col2" => "row2-2", "col3" => "row2-3"},{"col1" => "row1-1", "col2" => "row1-2", "col3" => "row1-3"}]
+Babaloa.to_csv(arr, sort: "col1") # => "col1,col2,col3\nrow1-1,row1-2,row1-3\nrow2-1,row2-2,row2-3\n"
+```
+
+You can also use Hash for using desc. Like this.
+
+```ruby
+arr = [{ "col1" => "row2-1", "col2" => "row2-2", "col3" => "row2-3"},{"col1" => "row1-1", "col2" => "row1-2", "col3" => "row1-3"}]
+Babaloa.to_csv(arr, sort: "col1") # => col1,col2,col3\nrow2-1,row2-2,row2-3\nrow1-1,row1-2,row1-3\n"
+```
+
+### Only/Except options
+You can sort content for using sort options if you use Hash for the contents of the array.
+You can use option value with Array or Symbol.
 
-TODO: Write usage instructions here
+```ruby
+arr = [{ "col1" => "row2-1", "col2" => "row2-2", "col3" => "row2-3"},{"col1" => "row1-1", "col2" => "row1-2", "col3" => "row1-3"}]
+Babaloa.to_csv(arr, only: %i(col1, col2)) # => "col1,col2\nrow2-1,row2-2\nrow1-1,row1-2\n"
+Babaloa.to_csv(arr, except: :col3) # => "col1,col2\nrow2-1,row2-2\nrow1-1,row1-2\n"
+```
+
+### Transrate options
+You can transrate header for using t options.
+You can only use option value with Hash.
+
+```ruby
+arr = [{ "col1" => "row2-1", "col2" => "row2-2", "col3" => "row2-3"},{"col1" => "row1-1", "col2" => "row1-2", "col3" => "row1-3"}]
+Babaloa.to_csv(arr, t: {"col1" => "一番目", "col2" => "二番目", "col3" => "三番目"}) # => "一番目,二番目,三番目\nrow1-1,row1-2,row1-3\nrow2-1,row2-2,row2-3\n"
+```
+
+## Initializer
+You can set options by default in initializers.
+
+### default
+Describes the settings applied to all csv output. The usage of the options is the same.
+
+```ruby
+Babaloa.configure {|config|
+    config.default = {
+      except: %i(updated_at created_at),
+      sort: { id: :desc },
+      t: { id: "ID", name: "NAME", age: "AGE" }
+    }
+}
+```
+
+### definition
+Describe the settings that apply separately. The usage of the options is the same.
+
+```ruby
+Babaloa.configure {|config|
+    config.definition = {
+      test: {
+        except: %i(updated_at created_at),
+        sort: { id: :desc },
+        t: { id: "ID", name: "NAME", age: "AGE" }
+      }
+    }
+}
+```
+
+And use it like this.
+
+```ruby
+Babaloa.to_csv(arr, name: :test)
+```
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `./qs spec` to run the tests. You can also run `./qs run app 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).
+To install this gem onto your local machine, run `./qs rake install`. To release a new version, update the version number in `version.rb`, and then run `./qs 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]/babaloa.
+Bug reports and pull requests are welcome on GitHub at https://github.com/belion-freee/babaloa.
 
 ## License
 

data/lib/babaloa.rb

@@ -1,14 +1,14 @@
 require "babaloa/version"
 require "babaloa/config"
 require "csv"
-require "byebug" # TODO: debugger
+
 module Babaloa
   class BabaloaError < StandardError; end
 
   class << self
     def to_csv(data, h = true, **options)
-      raise ArgumentError, "data must be Array" unless data.is_a?(Array)
-      raise ArgumentError, "content must be Array or Hash" unless data.empty? || data.first.is_a?(Array) || data.first.is_a?(Hash)
+      raise BabaloaError, "data must be Array" unless data.is_a?(Array)
+      raise BabaloaError, "content must be Array or Hash" unless data.empty? || data.first.is_a?(Array) || data.first.is_a?(Hash)
 
       if h && !data.empty?
         if data.first.is_a?(Hash)
@@ -24,10 +24,10 @@ module Babaloa
       end
 
       CSV.generate do |csv|
-        csv << transrate_by(header, **options) if h && header
+        csv << transrate_by(header.dup, **options) if h && header
         data.each{|res|
           if res.is_a?(Hash)
-            raise ArgumentError, "Header required if content is Hash" unless h
+            raise BabaloaError, "Header required if content is Hash" unless h
             csv << header.map {|k| res[k] || res[k.to_s] }
           else
             csv << res
@@ -49,7 +49,7 @@ module Babaloa
         sort = header.index(sort.to_sym) if data.first.is_a?(Array)
         data.sort_by! {|col| col[sort] }
       else
-        raise ArgumentError, "sort option must be Hash, Symbol, String."
+        raise BabaloaError, "sort option must be Hash, Symbol, String."
       end
 
       data
@@ -64,7 +64,7 @@ module Babaloa
       elsif only.is_a?(Symbol)
         header.select! {|k| only == k }
       else
-        raise ArgumentError, "only option must be Array, Symbol"
+        raise BabaloaError, "only option must be Array, Symbol"
       end
 
       header
@@ -79,7 +79,7 @@ module Babaloa
       elsif except.is_a?(Symbol)
         header.reject! {|k| except == k }
       else
-        raise ArgumentError, "except option must be Array, Symbol"
+        raise BabaloaError, "except option must be Array, Symbol"
       end
 
       header
@@ -92,7 +92,7 @@ module Babaloa
       if t.is_a?(Hash)
         header.map! {|k| t[k] || t[k.to_s] }.compact!
       else
-        raise ArgumentError, "t option must be Hash"
+        raise BabaloaError, "t option must be Hash"
       end
 
       header

data/lib/babaloa/version.rb

@@ -1,3 +1,3 @@
 module Babaloa
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: babaloa
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - belion-freee
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-21 00:00:00.000000000 Z
+date: 2019-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,9 +59,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Dockerfile
 - Gemfile
 - Gemfile.lock

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.0
-before_install: gem install bundler -v 2.0.1