workspace 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1148c1880a945f55539467fe3a1eb6a15da253a
-  data.tar.gz: 93151cd507c31bf8b692cf79c20b477ccb52aadd
+  metadata.gz: 4e821d7eb0d6db9f7f7fbc53eccefc869d26ebc6
+  data.tar.gz: aaf8eac45192f79e60fb3c50f6e65f30aeb41fd7
 SHA512:
-  metadata.gz: 1b8b8b79ba5208a1e01e9dcacb817b29bccf2b7b24f4ad537dd144289e8ff965d3b7b8a5c5303afb894a3b2d6295dae809f82ab7a0e228d70f30fcd363e4b3ee
-  data.tar.gz: 834680ebf3c0787ebbbc5f66d85a5279acd3bf2dd465b18a8fb023f33d2d06c8808125e3f532b3dbf6a634d5a4d0016358a6b17b54ea467256bbcc6efa8704b9
+  metadata.gz: ba0c31d40e477f6efe004a5ecf37fb5ece8d663b75f0a87d7bcfe3eab79003ff78470028f5b8056bc2eace2f9f5eb8b9114004dd9450463b7e94277c68d28c2d
+  data.tar.gz: e2499ed7222e7a106a950ef11d5dca0d2ee55121ff79cf91bc157af1b1892fc7a24698fd7ed4742e467f02dd94dd7729c79c073ed918dadc4636d67531973b11

data/README.md

@@ -0,0 +1,50 @@
+# Workspace for Ruby
+
+> Simplified Files and Directories handling
+
+[![CircleCI](https://circleci.com/gh/MagLoft/workspace/tree/master.svg?style=svg)](https://circleci.com/gh/MagLoft/workspace/tree/master)
+
+## Description
+
+Workspace makes it a breeze to work with files and directories.
+
+## Synopsis
+
+Workspace::Dir and Workspace::File are abstractions of the ruby Dir and File classes (although not extending them).
+
+When working with files and folders, these abstractions can significantly help with keeping your code simple, consistent and easy to read.
+
+```ruby
+require "workspace"
+
+root = Workspace.dir                        # initializes a workspace in the current directory
+root = Workspace.tmpdir                     # initializes a new workspace in a temporary directory
+                    
+root.file("file.txt").write("hello world")  # creates the file "file.txt" with contents "hello world"
+root.dir("dir").file("file.txt").create     # both the file "file.txt" and its parent directory "dir"
+                    
+root.dir("dir").exists?                     # => true
+root.dir("dir").delete                      # deletes the physical file, but keeps the Workspace::Dir
+root.dir("dir").exists?                     # => false
+
+file = root.dir("dir1").file("file.txt")
+file.relative_path(root.dir("dir2"))        # => "../dir1/file.txt"
+
+root.dir("build").clean                     # delete and re-create directory
+
+root.files                                  # [file1, file2, file3...]
+root.directories                            # [dir1, dir2, dir3...]
+root.children("**/*.rb")                    # [...] recursive matched files with .rb extension
+```
+
+## Installation
+    
+    # install globally
+    gem install workspace
+    
+    # install using bundler / Gemfile
+    gem "workspace"
+
+## License
+
+workspace is available under an MIT-style license.

data/lib/workspace/file.rb

@@ -58,10 +58,6 @@ module Workspace
       @contents ||= ::File.open(to_s).read
     end
 
-    def read_json
-      JSON.parse(read)
-    end
-
     def set(data)
       @contents = data
       self

data/lib/workspace/version.rb

@@ -1,3 +1,3 @@
 module Workspace
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workspace
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Tobias Strebitzer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-10 00:00:00.000000000 Z
+date: 2017-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -121,6 +121,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/workspace.rb
 - lib/workspace/dir.rb
 - lib/workspace/file.rb