copy_csv 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75e9f0db9f69da4f6a98d7a2095dab9b5d55f949
-  data.tar.gz: 89c4e6212fd7834442b1b39b6ea5a64f341c64ef
+  metadata.gz: 05c8fd7fec59eb36302453b825ded8c7f2d386e5
+  data.tar.gz: b1941e33bb62c4644cc3503a44fa0dfb266d119e
 SHA512:
-  metadata.gz: 209c2ab4f6d11ed8a163f7c8a8edd8357aaea9507dfed4d659b46b48a8257db3e302d1e8c879a1e0438fd761785864151750295b408a55f3c327403c3edbf58d
-  data.tar.gz: 0ff454ba286750cd667b279976b76b1ddb8be915c5aed48b0b9b0c424fdfb5ef0c170e4f8d083c481e01c5bc3170ab2484ab91d93f4e0c6e68ee04672e7335a7
+  metadata.gz: 8902421ed37191cd383bc24f2bfe7fdb732dcc2790ff726b566b9b6009e387122c722fd0c863649fd6ddc75c87429f31bf6139ab512c0deb59b38bdf3367ce0a
+  data.tar.gz: f8010477bdefc5d105f9f842e90cd964a04794c05cd1c292b8b2dfa084d3b8bbe18aea36c3ba30e31b0875a427bf415d3152a138175b6cb79ab894c35f7b347d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    copy_csv (0.1.0)
+    copy_csv (1.0.0)
       activesupport (>= 5.0)
 
 GEM
@@ -45,4 +45,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.2
+   1.16.3

data/README.md

@@ -1,8 +1,12 @@
-# CopyCsv
+# copy_csv
 
 A useful gem for converting an `ActiveRecord` Relation into a CSV formatted
 string.
 
+[![Gem Version](https://badge.fury.io/rb/copy_csv.svg)](https://badge.fury.io/rb/copy_csv)
+
+View it on [RubyGems](https://rubygems.org/gems/copy_csv)
+
 ## Basic Example
 
 There are a few users that have unsubscribed from your mailing list. You want
@@ -20,6 +24,9 @@ But someone else also wants to see the list, but in Excel. This is where
 File.open("unsubscribed_users.csv", "w") do |file|
   User.where(unsubscribed: true).copy_csv(file)
 end
+
+# Alternatively, you can use `write_to_csv` to not have to deal with opening a file
+User.where(unsubscribed: true).write_to_csv("unsubscribed_users.csv")
 ```
 
 `unsubscribed_users.csv` will now contain all of the Users that have
@@ -81,6 +88,10 @@ to use it in the rails console, your can just include it at will:
 
 And it can be used in that console session.
 
+## Documentation
+
+View the [docs](https://www.rubydoc.info/gems/copy_csv/0.1.0).
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run

data/lib/copy_csv.rb

@@ -11,8 +11,8 @@ module CopyCsv
     #
     # Example
     #
-    #     File.open("users.csv", "wb") do |file|
-    #       User.where(unsubscribed: false).copy_csv(io: file)
+    #     File.open("unsubscribed_users.csv", "w") do |file|
+    #       User.where(unsubscribed: false).copy_csv(file)
     #     end
     #
     # Returns nil
@@ -30,5 +30,18 @@ module CopyCsv
 
       nil
     end
+
+    # Opens the file provided and writes the relation to it as a CSV.
+    #
+    # Example
+    #
+    #     User.where(unsubscribed: false).write_to_csv("unsubscribed_users.csv")
+    #
+    # Returns nil
+    def write_to_csv(file_name, mode = "w")
+      File.open(file_name, mode) do |file|
+        all.copy_csv(file)
+      end
+    end
   end
 end

data/lib/copy_csv/version.rb

@@ -1,3 +1,3 @@
 module CopyCsv
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: copy_csv
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Jason Stumbaugh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-15 00:00:00.000000000 Z
+date: 2018-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler