save_me 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fea807550b555780fea5136d5711a2f3db45dd41
-  data.tar.gz: 9aafba1e224f9d1aec1e4cec766ef4e54d3901d4
+  metadata.gz: 94b459381452701de5d6cdc73fe022dc311df872
+  data.tar.gz: 08ef6b7db47d99214022b0c70eef5af97d31ff71
 SHA512:
-  metadata.gz: 346ade4f570eae26405a7991549a596a018e5c67fd04168cef87b6cdea7b7db6844f2ec6ca6e9b52d10d55a2c1a7b59c9ba80e4d176425c0a52edcb791fd1357
-  data.tar.gz: 4345802733dcae998af672530f21c4a640c558a3b55eaf1435ff42c4a3dc81b0c7402e4e3898ff293666b661105a206c5e4fa42296495fe1d70836ea9f2da6b2
+  metadata.gz: 73c5f35ff29686e9c632719dffe622eff58042e082ffcacc8f4d7acc01f3d28e3c32e948ff5804482eb49c9f0eaf499710e93445a804b16f127fb7ccf3bfa0a3
+  data.tar.gz: f82610098ba1d05c2440cac14761d35feed4658923b070144d7cfc654ce2f23d45316839ed08be7251addfc767a6b2f0b0bccf88d12cb53eac8a9076f3cc42f9

data/README.md

@@ -1,8 +1,6 @@
 # SaveMe
 
-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/save_me`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+SaveMe is a gem to store your data in an organized way. Let's say you have a script that saves the results in `results` file/folder and another run of this script (accidental or not) would overwrite your previous results. This is where SaveMe comes in. You put a one-liner in your code and your data is safe and organized.
 
 ## Installation
 
@@ -22,13 +20,54 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Put this line in your code before you run your script
+```ruby
+SaveMe.call("path_to_what_you_want_to_copy", results_path: "./results", ymd: 0b110, params: { whatever: "you need here" })
+```
+
+First argument is a path to the file/folder you want to save.
+
+Argument `results_path`(optional, default: "./") is a path to a folder where your results will be copied. If any directory in the path doesn't exist yet, it will be created by the gem.
+
+Argument `ymd`(optional, default: `0b111`) is the folder structure. Notice it's in binary format. Each 1 or 0 corresponds to a letter in the `ymd`.
+* `y` - year
+* `m` - month
+* `d` - day
+
+A `1` creates a folder for a year/month/day, a `0` will put a year/month/day in the final folder name.
+
+Examples:
+* `0b111`
+```ruby
+SaveMe.call("results", results_path: "archive", ymd: 0b111, params: { test: "test" })
+```
+```
+archive/
+└── 2017
+    └── 4
+        └── 3
+            └── 10:16:18
+                ├── params.json
+                └── results
+                    └── results.json
+```
 
-## Development
+* `0b110`
+```ruby
+SaveMe.call("results", results_path: "archive", ymd: 0b110, params: { test: "test" })
+```
+```
+archive/
+└── 2017
+    └── 4
+        └── 03_10:18:55
+            ├── params.json
+            └── results
+                └── results.json
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Argument `params`(optional, default: `nil`) will be saved as json file with your results so you don't need to remember what params were used to get those particular results.
 
-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
 

data/lib/save_me/version.rb

@@ -1,3 +1,3 @@
 class SaveMe
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: save_me
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Michał Januszkiewicz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-31 00:00:00.000000000 Z
+date: 2017-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler